tools/firmware-utils/src/imagetag_cmdline.h

   1 /** @file imagetag_cmdline.h
   2  *  @brief The header file for the command line option parser
   3  *  generated by GNU Gengetopt version 2.22.5
   4  *  http://www.gnu.org/software/gengetopt.
   5  *  DO NOT modify this file, since it can be overwritten
   6  *  @author GNU Gengetopt by Lorenzo Bettini */
   7
   8 #ifndef IMAGETAG_CMDLINE_H
   9 #define IMAGETAG_CMDLINE_H
  10
  11 /* If we use autoconf.  */
  12 #ifdef HAVE_CONFIG_H
  13 #include "config.h"
  14 #endif
  15
  16 #include <stdio.h> /* for FILE */
  17
  18 #ifdef __cplusplus
  19 extern "C" {
  20 #endif /* __cplusplus */
  21
  22 #ifndef IMAGETAG_CMDLINE_PACKAGE
  23 /** @brief the program name (used for printing errors) */
  24 #define IMAGETAG_CMDLINE_PACKAGE "imagetag"
  25 #endif
  26
  27 #ifndef IMAGETAG_CMDLINE_PACKAGE_NAME
  28 /** @brief the complete program name (used for help and version) */
  29 #define IMAGETAG_CMDLINE_PACKAGE_NAME "imagetag"
  30 #endif
  31
  32 #ifndef IMAGETAG_CMDLINE_VERSION
  33 /** @brief the program version */
  34 #define IMAGETAG_CMDLINE_VERSION "2.0.0"
  35 #endif
  36
  37 /** @brief Where the command line options are stored */
  38 struct gengetopt_args_info
  39 {
  40   const char *help_help; /**< @brief Print help and exit help description.  */
  41   const char *version_help; /**< @brief Print version and exit help description.  */
  42   char * kernel_arg;    /**< @brief File with LZMA compressed kernel to include in the image..  */
  43   char * kernel_orig;   /**< @brief File with LZMA compressed kernel to include in the image. original value given at command line.  */
  44   const char *kernel_help; /**< @brief File with LZMA compressed kernel to include in the image. help description.  */
  45   char * rootfs_arg;    /**< @brief File with RootFS to include in the image..  */
  46   char * rootfs_orig;   /**< @brief File with RootFS to include in the image. original value given at command line.  */
  47   const char *rootfs_help; /**< @brief File with RootFS to include in the image. help description.  */
  48   char * output_arg;    /**< @brief Name of output file..  */
  49   char * output_orig;   /**< @brief Name of output file. original value given at command line.  */
  50   const char *output_help; /**< @brief Name of output file. help description.  */
  51   char * cfe_arg;       /**< @brief File with CFE to include in the image..  */
  52   char * cfe_orig;      /**< @brief File with CFE to include in the image. original value given at command line.  */
  53   const char *cfe_help; /**< @brief File with CFE to include in the image. help description.  */
  54   char * boardid_arg;   /**< @brief Board ID to set in the image (must match what router expects, e.g. \"96345GW2\")..  */
  55   char * boardid_orig;  /**< @brief Board ID to set in the image (must match what router expects, e.g. \"96345GW2\"). original value given at command line.  */
  56   const char *boardid_help; /**< @brief Board ID to set in the image (must match what router expects, e.g. \"96345GW2\"). help description.  */
  57   char * chipid_arg;    /**< @brief Chip ID to set in the image (must match the actual hardware, e.g. \"6345\")..  */
  58   char * chipid_orig;   /**< @brief Chip ID to set in the image (must match the actual hardware, e.g. \"6345\"). original value given at command line.  */
  59   const char *chipid_help; /**< @brief Chip ID to set in the image (must match the actual hardware, e.g. \"6345\"). help description.  */
  60   char * flash_start_arg;       /**< @brief Flash start address. (default='0xBFC00000').  */
  61   char * flash_start_orig;      /**< @brief Flash start address. original value given at command line.  */
  62   const char *flash_start_help; /**< @brief Flash start address. help description.  */
  63   char * image_offset_arg;      /**< @brief Offset from start address for the first byte after the CFE (in memory). (default='0x10000').  */
  64   char * image_offset_orig;     /**< @brief Offset from start address for the first byte after the CFE (in memory). original value given at command line.  */
  65   const char *image_offset_help; /**< @brief Offset from start address for the first byte after the CFE (in memory). help description.  */
  66   char * tag_version_arg;       /**< @brief Version number for imagetag format. (default='6').  */
  67   char * tag_version_orig;      /**< @brief Version number for imagetag format. original value given at command line.  */
  68   const char *tag_version_help; /**< @brief Version number for imagetag format. help description.  */
  69   char * signature_arg; /**< @brief Magic string (signature), for boards that need it. (default='Broadcom Corporatio').  */
  70   char * signature_orig;        /**< @brief Magic string (signature), for boards that need it. original value given at command line.  */
  71   const char *signature_help; /**< @brief Magic string (signature), for boards that need it. help description.  */
  72   char * signature2_arg;        /**< @brief Second magic string (signature2). (default='ver. 2.0').  */
  73   char * signature2_orig;       /**< @brief Second magic string (signature2). original value given at command line.  */
  74   const char *signature2_help; /**< @brief Second magic string (signature2). help description.  */
  75   char * block_size_arg;        /**< @brief Flash erase block size. (default='0x10000').  */
  76   char * block_size_orig;       /**< @brief Flash erase block size. original value given at command line.  */
  77   const char *block_size_help; /**< @brief Flash erase block size. help description.  */
  78   char * load_addr_arg; /**< @brief Kernel load address..  */
  79   char * load_addr_orig;        /**< @brief Kernel load address. original value given at command line.  */
  80   const char *load_addr_help; /**< @brief Kernel load address. help description.  */
  81   char * entry_arg;     /**< @brief Address where the kernel entry point will be for booting..  */
  82   char * entry_orig;    /**< @brief Address where the kernel entry point will be for booting. original value given at command line.  */
  83   const char *entry_help; /**< @brief Address where the kernel entry point will be for booting. help description.  */
  84   char * layoutver_arg; /**< @brief Flash layout version (version 2.2x of the Broadcom code requires this)..  */
  85   char * layoutver_orig;        /**< @brief Flash layout version (version 2.2x of the Broadcom code requires this). original value given at command line.  */
  86   const char *layoutver_help; /**< @brief Flash layout version (version 2.2x of the Broadcom code requires this). help description.  */
  87   char * info1_arg;     /**< @brief String for first vendor information section..  */
  88   char * info1_orig;    /**< @brief String for first vendor information section. original value given at command line.  */
  89   const char *info1_help; /**< @brief String for first vendor information section. help description.  */
  90   char * altinfo_arg;   /**< @brief String for vendor information section (alternate/pirelli)..  */
  91   char * altinfo_orig;  /**< @brief String for vendor information section (alternate/pirelli). original value given at command line.  */
  92   const char *altinfo_help; /**< @brief String for vendor information section (alternate/pirelli). help description.  */
  93   char * info2_arg;     /**< @brief String for second vendor information section..  */
  94   char * info2_orig;    /**< @brief String for second vendor information section. original value given at command line.  */
  95   const char *info2_help; /**< @brief String for second vendor information section. help description.  */
  96   int root_first_flag;  /**< @brief Put the rootfs before the kernel (only for stock images, e.g. captured from the router's flash memory). (default=off).  */
  97   const char *root_first_help; /**< @brief Put the rootfs before the kernel (only for stock images, e.g. captured from the router's flash memory). help description.  */
  98   char * rsa_signature_arg;     /**< @brief String for RSA Signature section..  */
  99   char * rsa_signature_orig;    /**< @brief String for RSA Signature section. original value given at command line.  */
 100   const char *rsa_signature_help; /**< @brief String for RSA Signature section. help description.  */
 101   char * second_image_flag_arg; /**< @brief Dual Image Flag (2=not-specified). (default='2').  */
 102   char * second_image_flag_orig;        /**< @brief Dual Image Flag (2=not-specified). original value given at command line.  */
 103   const char *second_image_flag_help; /**< @brief Dual Image Flag (2=not-specified). help description.  */
 104   char * inactive_arg;  /**< @brief Inactive Flag (2=not-specified). (default='2').  */
 105   char * inactive_orig; /**< @brief Inactive Flag (2=not-specified). original value given at command line.  */
 106   const char *inactive_help; /**< @brief Inactive Flag (2=not-specified). help description.  */
 107   char * reserved2_arg; /**< @brief String for second reserved section..  */
 108   char * reserved2_orig;        /**< @brief String for second reserved section. original value given at command line.  */
 109   const char *reserved2_help; /**< @brief String for second reserved section. help description.  */
 110   int kernel_file_has_header_flag;      /**< @brief Indicates that the kernel file includes the kernel header with correct load address and entry point, so no changes are needed (default=off).  */
 111   const char *kernel_file_has_header_help; /**< @brief Indicates that the kernel file includes the kernel header with correct load address and entry point, so no changes are needed help description.  */
 112   int pad_arg;  /**< @brief Pad the image to this size if smaller (in MiB).  */
 113   char * pad_orig;      /**< @brief Pad the image to this size if smaller (in MiB) original value given at command line.  */
 114   const char *pad_help; /**< @brief Pad the image to this size if smaller (in MiB) help description.  */
 115   int align_rootfs_flag;        /**< @brief Align the rootfs start to erase block size (default=off).  */
 116   const char *align_rootfs_help; /**< @brief Align the rootfs start to erase block size help description.  */
 117
 118   unsigned int help_given ;     /**< @brief Whether help was given.  */
 119   unsigned int version_given ;  /**< @brief Whether version was given.  */
 120   unsigned int kernel_given ;   /**< @brief Whether kernel was given.  */
 121   unsigned int rootfs_given ;   /**< @brief Whether rootfs was given.  */
 122   unsigned int output_given ;   /**< @brief Whether output was given.  */
 123   unsigned int cfe_given ;      /**< @brief Whether cfe was given.  */
 124   unsigned int boardid_given ;  /**< @brief Whether boardid was given.  */
 125   unsigned int chipid_given ;   /**< @brief Whether chipid was given.  */
 126   unsigned int flash_start_given ;      /**< @brief Whether flash-start was given.  */
 127   unsigned int image_offset_given ;     /**< @brief Whether image-offset was given.  */
 128   unsigned int tag_version_given ;      /**< @brief Whether tag-version was given.  */
 129   unsigned int signature_given ;        /**< @brief Whether signature was given.  */
 130   unsigned int signature2_given ;       /**< @brief Whether signature2 was given.  */
 131   unsigned int block_size_given ;       /**< @brief Whether block-size was given.  */
 132   unsigned int load_addr_given ;        /**< @brief Whether load-addr was given.  */
 133   unsigned int entry_given ;    /**< @brief Whether entry was given.  */
 134   unsigned int layoutver_given ;        /**< @brief Whether layoutver was given.  */
 135   unsigned int info1_given ;    /**< @brief Whether info1 was given.  */
 136   unsigned int altinfo_given ;  /**< @brief Whether altinfo was given.  */
 137   unsigned int info2_given ;    /**< @brief Whether info2 was given.  */
 138   unsigned int root_first_given ;       /**< @brief Whether root-first was given.  */
 139   unsigned int rsa_signature_given ;    /**< @brief Whether rsa-signature was given.  */
 140   unsigned int second_image_flag_given ;        /**< @brief Whether second-image-flag was given.  */
 141   unsigned int inactive_given ; /**< @brief Whether inactive was given.  */
 142   unsigned int reserved2_given ;        /**< @brief Whether reserved2 was given.  */
 143   unsigned int kernel_file_has_header_given ;   /**< @brief Whether kernel-file-has-header was given.  */
 144   unsigned int pad_given ;      /**< @brief Whether pad was given.  */
 145   unsigned int align_rootfs_given ;     /**< @brief Whether align-rootfs was given.  */
 146
 147 } ;
 148
 149 /** @brief The additional parameters to pass to parser functions */
 150 struct imagetag_cmdline_params
 151 {
 152   int override; /**< @brief whether to override possibly already present options (default 0) */
 153   int initialize; /**< @brief whether to initialize the option structure gengetopt_args_info (default 1) */
 154   int check_required; /**< @brief whether to check that all required options were provided (default 1) */
 155   int check_ambiguity; /**< @brief whether to check for options already specified in the option structure gengetopt_args_info (default 0) */
 156   int print_errors; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */
 157 } ;
 158
 159 /** @brief the purpose string of the program */
 160 extern const char *gengetopt_args_info_purpose;
 161 /** @brief the usage string of the program */
 162 extern const char *gengetopt_args_info_usage;
 163 /** @brief all the lines making the help output */
 164 extern const char *gengetopt_args_info_help[];
 165
 166 /**
 167  * The command line parser
 168  * @param argc the number of command line options
 169  * @param argv the command line options
 170  * @param args_info the structure where option information will be stored
 171  * @return 0 if everything went fine, NON 0 if an error took place
 172  */
 173 int imagetag_cmdline (int argc, char **argv,
 174   struct gengetopt_args_info *args_info);
 175
 176 /**
 177  * The command line parser (version with additional parameters - deprecated)
 178  * @param argc the number of command line options
 179  * @param argv the command line options
 180  * @param args_info the structure where option information will be stored
 181  * @param override whether to override possibly already present options
 182  * @param initialize whether to initialize the option structure my_args_info
 183  * @param check_required whether to check that all required options were provided
 184  * @return 0 if everything went fine, NON 0 if an error took place
 185  * @deprecated use imagetag_cmdline_ext() instead
 186  */
 187 int imagetag_cmdline2 (int argc, char **argv,
 188   struct gengetopt_args_info *args_info,
 189   int override, int initialize, int check_required);
 190
 191 /**
 192  * The command line parser (version with additional parameters)
 193  * @param argc the number of command line options
 194  * @param argv the command line options
 195  * @param args_info the structure where option information will be stored
 196  * @param params additional parameters for the parser
 197  * @return 0 if everything went fine, NON 0 if an error took place
 198  */
 199 int imagetag_cmdline_ext (int argc, char **argv,
 200   struct gengetopt_args_info *args_info,
 201   struct imagetag_cmdline_params *params);
 202
 203 /**
 204  * Save the contents of the option struct into an already open FILE stream.
 205  * @param outfile the stream where to dump options
 206  * @param args_info the option struct to dump
 207  * @return 0 if everything went fine, NON 0 if an error took place
 208  */
 209 int imagetag_cmdline_dump(FILE *outfile,
 210   struct gengetopt_args_info *args_info);
 211
 212 /**
 213  * Save the contents of the option struct into a (text) file.
 214  * This file can be read by the config file parser (if generated by gengetopt)
 215  * @param filename the file where to save
 216  * @param args_info the option struct to save
 217  * @return 0 if everything went fine, NON 0 if an error took place
 218  */
 219 int imagetag_cmdline_file_save(const char *filename,
 220   struct gengetopt_args_info *args_info);
 221
 222 /**
 223  * Print the help
 224  */
 225 void imagetag_cmdline_print_help(void);
 226 /**
 227  * Print the version
 228  */
 229 void imagetag_cmdline_print_version(void);
 230
 231 /**
 232  * Initializes all the fields a imagetag_cmdline_params structure
 233  * to their default values
 234  * @param params the structure to initialize
 235  */
 236 void imagetag_cmdline_params_init(struct imagetag_cmdline_params *params);
 237
 238 /**
 239  * Allocates dynamically a imagetag_cmdline_params structure and initializes
 240  * all its fields to their default values
 241  * @return the created and initialized imagetag_cmdline_params structure
 242  */
 243 struct imagetag_cmdline_params *imagetag_cmdline_params_create(void);
 244
 245 /**
 246  * Initializes the passed gengetopt_args_info structure's fields
 247  * (also set default values for options that have a default)
 248  * @param args_info the structure to initialize
 249  */
 250 void imagetag_cmdline_init (struct gengetopt_args_info *args_info);
 251 /**
 252  * Deallocates the string fields of the gengetopt_args_info structure
 253  * (but does not deallocate the structure itself)
 254  * @param args_info the structure to deallocate
 255  */
 256 void imagetag_cmdline_free (struct gengetopt_args_info *args_info);
 257
 258 /**
 259  * Checks that all the required options were specified
 260  * @param args_info the structure to check
 261  * @param prog_name the name of the program that will be used to print
 262  *   possible errors
 263  * @return
 264  */
 265 int imagetag_cmdline_required (struct gengetopt_args_info *args_info,
 266   const char *prog_name);
 267
 268 extern const char *imagetag_cmdline_second_image_flag_values[];  /**< @brief Possible values for second-image-flag. */
 269 extern const char *imagetag_cmdline_inactive_values[];  /**< @brief Possible values for inactive. */
 270
 271
 272 #ifdef __cplusplus
 273 }
 274 #endif /* __cplusplus */
 275 #endif /* IMAGETAG_CMDLINE_H */