tools/firmware-utils/src/imagetag.ggo

   1 # Command line option parsing generator file for imagetag
   2 # Supplied-To: gengetopt
   3 #
   4 # Copyright 2010 Daniel Dickinson <openwrt@cshore.neomailbox.net>
   5 #
   6 # This file is subject to the terms and conditions of the GNU General Public
   7 # License.  See the file "COPYING" in the main directory of this archive
   8 # for more details.
   9 #
  10
  11 package "imagetag"
  12 version "2.0.0"
  13 purpose "Generate image with CFE imagetag for Broadcom 63xx routers."
  14 description "Copyright (C) 2008 Axel Gembe
  15 Copyright (C) 2009-2010 Daniel Dickinson
  16 Licensed unter the terms of the Gnu General Public License.
  17
  18 Given a root filesystem, a linux kernel, and an optional CFE, generates an image with an imagetag for a Broadcom 63xx-based router.  Additional parameters to be specified depend on the specfic brand and model of router."
  19 args "--file-name=imagetag_cmdline"
  20
  21 option "kernel" i "File with LZMA compressed kernel to include in the image." string typestr="filename"  required
  22 option "rootfs" f "File with RootFS to include in the image." string typestr="filename" required
  23 option "output" o "Name of output file." string typestr="filename" required
  24 option "cfe" - "File with CFE to include in the image." string typestr="filename" optional
  25 option "boardid" b "Board ID to set in the image (must match what router expects, e.g. \"96345GW2\")." string required
  26 option "chipid" c "Chip ID to set in the image (must match the actual hardware, e.g. \"6345\")." string required
  27 option "flash-start" s "Flash start address." string typestr="address" optional default="0xBFC00000"
  28 option "image-offset" n "Offset from start address for the first byte after the CFE (in memory)." string typestr="offset" default="0x10000" optional
  29 option "tag-version" v "Version number for imagetag format." string default="6" optional
  30 option "signature" a "Magic string (signature), for boards that need it." string default="Broadcom Corporatio" optional
  31 option "signature2" m "Second magic string (signature2)." string default="ver. 2.0" optional
  32 option "block-size" k "Flash erase block size." string optional default="0x10000"
  33 option "load-addr" l "Kernel load address." string typestr="address" required
  34 option "entry" e "Address where the kernel entry point will be for booting." string typestr="address" required
  35 option "layoutver" y "Flash layout version (version 2.2x of the Broadcom code requires this)." string optional
  36 option "info1" 1 "String for first vendor information section." string optional
  37 option "altinfo" - "String for vendor information section (alternate/pirelli)." string optional
  38 option "info2" 2 "String for second vendor information section." string optional
  39 option "root-first" - "Put the rootfs before the kernel (only for stock images, e.g. captured from the router's flash memory)." flag off
  40 option "rsa-signature" r "String for RSA Signature section." string optional
  41 option "second-image-flag" - "Dual Image Flag (2=not-specified)." values="0", "1", "2" default="2" typestr="flag-value" optional
  42 option "inactive" - "Inactive Flag (2=not-specified)." values="0", "1", "2" default="2" typestr="flag-value" optional
  43 option "reserved1" - "String for first reserved section." string optional
  44 option "reserved2" - "String for second reserved section." string optional
  45 option "kernel-file-has-header" - "Indicates that the kernel file includes the kernel header with correct load address and entry point, so no changes are needed" flag off