Bootburn Options

Options	Description
-b <p3710-10-a01 \| p3710-10-a01-f1 \| p3663-a01 \| p3663-a01-f1 \| p4024-a00-a \| p4024-a00-a-f1 \| p4024-a00-b \| p4024-a00-b-f1> (lower-case b)	Provides the board name and revision. Possible board names include: p3710-10-a01 p3710-10-a01-f1 p3663-a01 p3663-a01-f1 p4024-a00-a p4024-a00-a-f1 p4024-a00-b p4024-a00-b-f1 Not all boards are supported in Safety and Standard. For more information, see the API Reference.
--board_config <board_name>.json	Can be used with `bootburn.py`, `create_bsp_images.py`, and `flash_bsp_images.py`board_name must include absolute path.
-d <partition_name> <dtb_file> (lower-case d)	Specifies the DTB file to flash and the target partition. The default file is defined in `BoardSetFilePathsAndDefaultValues`. `bpmp-fw-dtb` and `kernel-dtb` may be specified simultaneously. Note: This option is not intended to specify kernel-dtb in Hypervisor.
--encryption_key	Takes as parameter the full file path and name. Secure boot encryption key. Can be used with `bootburn.py` and `create_bsp_images.py`.
-f (lower case)	Failure analysis (FA) mode support.
--gpuvbios_fw	Specifies the firmware to flash to the dGPU.
-h (lower-case h)	Provides guidance on the actions and options of `bootburn`.
-i (lower case i)	File path to platform configuration file. If not provided for hypervisor configurations, then the tool expects the platform configuration file to be present in the hypervisor output directory
-k <configuration file> (lower-case k)	Specifies the configuration file for flashing.
-m (lower case)	Flashing Modular Diagnostic Software (MODS). This option enables mods-specific overrides.
-o (lower-case o)	Skips flashing of recovery partitions. Used by minicom. WARNING: If you are using minicom with -o option, minicom does not initialize the port and therefore does NOT check or acquire the lock files for the communication port. If minicom is running in the background and you run bootburn with the -x option, bootburn acquires the lock BEFORE accessing the communication port. So, when bootburn attempts to communicate with AURIX it fails.
-p <key_file_path> (lower-case p)	Signs the boot loader, secure OS (TOS), kernel and BCT binary, then flashes the device. `<key_file_path>` must be the full pathname of the key_file.
--hsm <key_string>	Can be used with `bootburn.py` and `create_bsp_images.py`. Tells Bootburn what keys will be used in HSM mode. Key String is Key + Encrypt Keys. Key is rsa. Encrypt Keys are sbk. Example: --hsm rsa
-q (lower-case q)	Flashes QNX images.
-s (lower-case s)	Skips flashing the file system. Use the `-s` flag only when the target file system is already flashed.
-t <output_directory> (lower-case t)	Specifies the output directory where images to be flashed onto the target are to be stored. The default directory is named `_temp_dump`, and is present in the flashing directory.
-x	Specifies the communication port for AURIX to put the SoC in recovery mode automatically. With this `-x` option, bootburn performs target validation for the user provided board name on the command line, with the `-b` option, before flashing the board. Bootburn generates a unique ID from the target Inforom data. The allowed target ID list for the user provided board is generated from BOM data file included in the package. Bootburn aborts flashing if the target unique ID is not found in the list of generated unique IDs for the provided board name. This feature is supported on e3550b01 and e3550b03 boards with Inforom system object version 3 or above. Note: On boards with inforom, the bct sku info is updated with the information in the inforom. If the `-x` option is used during the AURIX setup, at the end during the AURIX reset of the flashing procedure there may be output messages of the form: `"Killed sudo cat $l_Aurix > $p_FlashFiles/$l_AurixLogFile"`. These messages are not errors and can be safely ignored. Warning: If minicom is used with the `-o` option, minicom does not initialize the port and therefore does NOT check or acquire the lock files for the communication port. If minicom is running in the background and you run bootburn with the `-x` option, bootburn acquires the lock BEFORE accessing the communication port. So when bootburn attempts to communicate with AURIX it fails. If you quit minicom forcefully it may not fully stop the process and it will be lingering in the background. When bootburn attempts to connect in this state it will acquire the port but the output will still be directed to the minicom running in the background. Avoid using the `-o` option when using minicom.
-B <boot_device> (upper-case B)	Specifies the boot device, which must be either qspi or emmc. qspi is the default.
-C (upper-case C)	Specifies use of debug binaries for the boot loader.
-D (upper-case D)	Directs `bootburn` debug output to stdout along with the tool's regular output. If -D is not specified, debug output goes to a temporary file.
-E (upper-case E)	Enables DRAM ECC.
-I <bus_id> <device_id> (upper-case I)	Flashes a specific device when multiple devices are in recovery. To get the bus and device ID of each device in recovery, enter the lsusb command on the host. For example, if lsusb gives the following output: `Bus 003 Device 105: ID 0955:7018 NVidia Corp.` `Bus 003 Device 104: ID 0955:7018 NVidia Corp.` Then flash the second device with the –I option as in this example: `-I 003 104`
-L (upper-case L)	Enables low power modes. This option requires that the spe-fw and WB0 firmware packages be included in the bootburn configuration because low-power modes require them.
-M (upper-case M)	Specifies development version firmware.
-R (upper-case R)	Specifies RCM boot support, where the device boots without being flashed. When the target is in recovery mode, this option causes the flashing script to download all binaries, other than BCT, from the host. The target then reads the BCT from storage and other binaries from RAM. It boots the kernel directly on RAM. This option is much faster than when flashing also occurs. It is especially useful during debugging. Use the -R flag to initiate RCMBOOT with any of the commands mentioned in this table.
-T (upper-case T)	Enables tracing. Tracing logs are stored under the `bootburn` directory as log_trace*.txt.
--safety	Execute bootburn scripts in safety mode. Only a limited set of options are available for use in safety mode.
-U	Pass in the UFS provision configuration file.
-V (upper case V)	Specifies read-back verification, where the binary images are read back (after writing) from the target's storage and compared with the original binary images. The two sets of images are compared to detect discrepancies.
-X (upper case X)	Enable Golden Register Address:Value Dump into GR memory carveout.
--customer-data	Specified customer data such as skuinfo and others to be updated during flashing See flashing_customer_data.docx for information on how to use it.

-b

<p3710-10-a01 | p3710-10-a01-f1 | p3663-a01 | p3663-a01-f1 | p4024-a00-a | p4024-a00-a-f1 |

p4024-a00-b | p4024-a00-b-f1>

(lower-case b)

Provides the board name and revision. Possible board names include:

p3710-10-a01
p3710-10-a01-f1
p3663-a01
p3663-a01-f1
p4024-a00-a
p4024-a00-a-f1
p4024-a00-b
p4024-a00-b-f1

Not all boards are supported in Safety and Standard. For more information, see the API Reference.

--board_config <board_name>.json

Can be used with bootburn.py, create_bsp_images.py, and flash_bsp_images.pyboard_name must include absolute path.

-d <partition_name> <dtb_file>

(lower-case d)

Specifies the DTB file to flash and the target partition. The default file is defined in BoardSetFilePathsAndDefaultValues.

bpmp-fw-dtb and kernel-dtb may be specified simultaneously.

Note: This option is not intended to specify kernel-dtb in Hypervisor.

--encryption_key

Takes as parameter the full file path and name. Secure boot encryption key. Can be used with bootburn.py and create_bsp_images.py.

-f (lower case)

Failure analysis (FA) mode support.

--gpuvbios_fw

Specifies the firmware to flash to the dGPU.

-h

(lower-case h)

Provides guidance on the actions and options of bootburn.

-i (lower case i)

File path to platform configuration file. If not provided for hypervisor configurations, then the tool expects the platform configuration file to be present in the hypervisor output directory

-k <configuration file>

(lower-case k)

Specifies the configuration file for flashing.

-m (lower case)

Flashing Modular Diagnostic Software (MODS). This option enables mods-specific overrides.

-o

(lower-case o)

Skips flashing of recovery partitions. Used by minicom.

WARNING: If you are using minicom with -o option, minicom does not initialize the port and therefore does NOT check or acquire the lock files for the communication port. If minicom is running in the background and you run bootburn with the -x option, bootburn acquires the lock BEFORE accessing the communication port. So, when bootburn attempts to communicate with AURIX it fails.

-p <key_file_path>

(lower-case p)

Signs the boot loader, secure OS (TOS), kernel and BCT binary, then flashes the device. <key_file_path> must be the full pathname of the key_file.

--hsm <key_string>

Can be used with bootburn.py and create_bsp_images.py. Tells Bootburn what keys will be used in HSM mode. Key String is Key + Encrypt Keys. Key is rsa. Encrypt Keys are sbk. Example:

--hsm rsa

-q

(lower-case q)

Flashes QNX images.

-s

(lower-case s)

Skips flashing the file system.

Use the -s flag only when the target file system is already flashed.

-t <output_directory>

(lower-case t)

Specifies the output directory where images to be flashed onto the target are to be stored. The default directory is named _temp_dump, and is present in the flashing directory.

-x

Specifies the communication port for AURIX to put the SoC in recovery mode automatically.

With this -x option, bootburn performs target validation for the user provided board name on the command line, with the -b option, before flashing the board.

Bootburn generates a unique ID from the target Inforom data. The allowed target ID list for the user provided board is generated from BOM data file included in the package. Bootburn aborts flashing if the target unique ID is not found in the list of generated unique IDs for the provided board name. This feature is supported on e3550b01 and e3550b03 boards with Inforom system object version 3 or above.

Note:

On boards with inforom, the bct sku info is updated with the information in the inforom.

If the -x option is used during the AURIX setup, at the end during the AURIX reset of the flashing procedure there may be output messages of the form: "Killed sudo cat $l_Aurix > $p_FlashFiles/$l_AurixLogFile". These messages are not errors and can be safely ignored.

Warning:

If minicom is used with the -o option, minicom does not initialize the port and therefore does NOT check or acquire the lock files for the communication port.

If minicom is running in the background and you run bootburn with the -x option, bootburn acquires the lock BEFORE accessing the communication port. So when bootburn attempts to communicate with AURIX it fails.
If you quit minicom forcefully it may not fully stop the process and it will be lingering in the background.
When bootburn attempts to connect in this state it will acquire the port but the output will still be directed to the minicom running in the background.
Avoid using the -o option when using minicom.

-B <boot_device>

(upper-case B)

Specifies the boot device, which must be either qspi or emmc. qspi is the default.

-C

(upper-case C)

Specifies use of debug binaries for the boot loader.

-D

(upper-case D)

Directs bootburn debug output to stdout along with the tool's regular output. If -D is not specified, debug output goes to a temporary file.

-E

(upper-case E)

Enables DRAM ECC.

-I <bus_id> <device_id>

(upper-case I)

Flashes a specific device when multiple devices are in recovery.

To get the bus and device ID of each device in recovery, enter the lsusb command on the host. For example, if lsusb gives the following output:

Bus 003 Device 105: ID 0955:7018 NVidia Corp.

Bus 003 Device 104: ID 0955:7018 NVidia Corp.

Then flash the second device with the –I option as in this example:

-I 003 104

-L

(upper-case L)

Enables low power modes. This option requires that the spe-fw and WB0 firmware packages be included in the bootburn configuration because low-power modes require them.

-M

(upper-case M)

Specifies development version firmware.

-R

(upper-case R)

Specifies RCM boot support, where the device boots without being flashed. When the target is in recovery mode, this option causes the flashing script to download all binaries, other than BCT, from the host. The target then reads the BCT from storage and other binaries from RAM. It boots the kernel directly on RAM.

This option is much faster than when flashing also occurs. It is especially useful during debugging.

Use the -R flag to initiate RCMBOOT with any of the commands mentioned in this table.

-T

(upper-case T)

Enables tracing. Tracing logs are stored under the bootburn directory as log_trace*.txt.

--safety

Execute bootburn scripts in safety mode. Only a limited set of options are available for use in safety mode.

-U

Pass in the UFS provision configuration file.

-V

(upper case V)

Specifies read-back verification, where the binary images are read back (after writing) from the target's storage and compared with the original binary images. The two sets of images are compared to detect discrepancies.

-X

(upper case X)

Enable Golden Register Address:Value Dump into GR memory carveout.

--customer-data

Specified customer data such as skuinfo and others to be updated during flashing

See flashing_customer_data.docx for information on how to use it.