• Quick Start
  • Booting
  • Platform
  • Portals
  • References
    • API Reference TOI3
    • IIP Reference
  • Resources
ARRIS Enterprises, Inc. Confidential Information

build_boot_image command

Boot images are built using the build_boot_image command included in the development kit.

Usage

  
Usage: ./build_boot_image [options]
Options:
[--help]                  Display this help and exit.
--boot_image <file>       Save boot image in file.
--debug_boot_image <file> Save debug boot image in file.
--rootdisk <file>         Save rootdisk in file.
[--debug_symbols <file>]  Save debug symbols in file. This option can only
                           be used in a KreaTV code tree.
[--non_secure_flash_boot_image <file>]
                          Save non secure boot image in file.
--kernel <file>           Save NFS kernel in file.
[--dry-run]               Verify configuration without building anything.
--config <file>           Boot image configuration file listing IIPs.
--source <path>           Path to directory containing IIPs.
--toolchain_path <path>   Path to toolchain.
[--info <name> <value>]   Set variable name=value in boot image build info.
[--iip <iip>]             Include IIP in boot image.
[--architecture <arch>]   Architecture to build boot image for in format
                           <toolchain>_<device> (e.g. bcm15_vip43x2).
[--toolchain <toolchain>] Name of toolchain to build boot image for
                           (e.g. bcm15). Or specify --architecture.
[--device <device>]       STB model to build boot image for (e.g. vip43x2).
                           Or specify --architecture.
[--goldenimage]           Build a golden image.
[--diagnosticimage]       Build a diagnostic image.
[--tblimage]              Build a TBL image.

Various
Parameter Description
--architecture Name of target architecture, for instance st40_vip28x3, which is used for the ARRIS VIP28X3 series. If this parameter is not set, the parameters 'processor' and 'hw_comp' must be specified.
--toolchain Name of toolchain. Valid values are st40 which is used for an ARRIS IP-STB with an ST chipset, and bcm45 which is used for an ARRIS IP-STB with a Broadcom chipset.
--device Name of STB model.
--toolchain_path Path to the KreaTV toolchain.
--goldenimage Build a golden image.
--diagnosticimage Build a diagnostic image.
Boot image input files/directories
Parameter Description
--source Directories in which build_boot_image can find IIPs. Subdirectories will also be searched. It is possible to specify multiple sources.
--iip IP-STB Installation Package. A more convenient way to specify packages is to use a configuration file instead.
--config Configuration file containing IIP names and parameters. Blank lines and lines with '#' in the beginning (comments) are ignored. It is also possible to pass information values (see the --info parameter) through the configuration file. A comment line containing $<name>:<value> would be the equivalent of passing "--info <name> <value>" to build_boot_image.
Boot image targets - at least one is mandatory
Parameter Description
--boot_image Boot image name.
--debug_boot_image Debug boot image name. A debug boot image prints information to the screen while the IP-STB is booting.
--rootdisk Rootdisk name. A rootdisk is usually only used together with a NFS kernel to NFS boot the IP-STB.
--kernel NFS kernel name. An NFS kernel is usually only used together with a rootdisk to NFS boot the IP-STB.
Boot image information
Parameter Description
--info Information about the boot image. All items are added to the Information Service using the names const.sw.<name>.

It is also possible to pass information values using a configuration file, see the --config parameter.

The following items are quaranteed to have a value (set by build_boot_image, but possible to override):

  • branch (empty string as default)
  • date
  • host
  • time
  • user
  • version (empty string as default)

The following items are recommended to set:

  • company (name of the company building the boot image)
  • configuration (filename of the configuration file used)

5.1.p5

Copyright (c) 2017 ARRIS Enterprises, LLC. All Rights Reserved. ARRIS Enterprises, LLC. Confidential Information.