Commands and Descriptions - 2021.2 English

Vitis Unified Software Platform Documentation: Embedded Software Development (UG1400)

Document ID
UG1400
ft:locale
English (United States)
Release Date
2021-12-15
Version
2021.2 English

The following table lists the Bootgen command options. Each option is linked to a longer description in the left column with a short description in the right column. The architecture name indicates what Xilinx® device uses that command:

  • zynq: Zynq®-7000 SoC device
  • zynqmp: Zynq® UltraScale+™ MPSoC device
  • fpga: Any 7 series and above devices
  • versal: Versal® ACAP

For more information, see Command Reference.

Table 1. Bootgen Command and Descriptions
Commands Description and Options Used by
arch <type> Xilinx® device architecture. Options:
  • zynq (default)
  • zynqmp
  • fpga
  • versal
  • All
bif_help Prints out the BIF help summary.
  • All
dual_qspi_mode <configuration> Generates two output files for dual QSPI configurations:
  • parallel
  • stacked <size>
  • zynq
  • zynqmp
  • versal
dual_ospi_mode stacked <size> Generates two output files for stacked configuration.
  • versal
dump <options> Dumps the partition or boot header as per options specified.
  • empty: Dumps the partitions as binary files.
  • bh: Dumps boot header as a binary file.
  • plm: Dumps PLM as a binary file.
  • pmc_cdo: Dumps PMC CDO as a binary file.
  • boot_files: Dumps boot header, PLM and PMC CDO as three separate binary files.
  • versal
dump_dir Dumps components in specified directory.
  • versal
efuseppkbits <PPK_filename> Generates a PPK hash for eFUSE.
  • zynq
  • zynqmp
  • versal
encrypt <options> AES Key storage in device. Options are:
  • bbram (default)
  • efuse
  • zynq
  • fpga
encryption_dump Generates encryption log file, aes_log.txt.
  • zynqmp
  • versal
fill <hex_byte> Specifies the fill byte to use for padding.
  • zynq
  • zynqmp
  • versal
generate_hashes Generates file containing padded hash:
  • Zynq devices: SHA-2 with PKCS#1v1.5 padding scheme
  • Zynq UltraScale+ MPSoC: SHA-3 with PKCS#1v1.5 padding scheme
  • Versal ACAP: SHA-3 with PSS padding scheme
  • zynq
  • zynqmp
  • versal
generate_keys <key_type> Generate the authentication keys. Options are:
  • pem
  • rsa
  • obfuscatedkey
  • zynq
  • zynqmp
h, help Prints out help summary.
  • All
image <filename(.bif)> Provides a boot image format (.bif) file name.
  • All
log<level_type> Generates a log file at the current working directory with following message types:
  • error
  • warning (default)
  • info
  • debug
  • trace
  • All
nonbooting Create an intermediate boot image.
  • zynq
  • zynqmp
  • versal
o <filename> Specifies the output file. The format of the file is determined by the file name extension. Valid extensions are:
  • .bin (default)
  • .mcs
  • .pdi
  • All
p <partname> Specify the part name used in generating the encryption key.
  • All
padimageheader <option> Pads the image headers to force alignment of following partitions. Options are:
  • 0
  • 1 (default)
  • zynq
  • zynqmp
process_bitstream <option> Specifies that the bitstream is processed and outputs as .bin or .mcs.
  • For example, if encryption is selected for bitstream in BIF file, the output is an encrypted bitstream.
  • zynq
  • zynqmp
read <options> Used to read boot headers, image headers, and partition headers based on the options.
  • bh: To read boot header from bootimage in human readable form
  • iht: To read image header table from bootimage
  • ih: To read image headers from bootimage.
  • pht: To read partition headers from bootimage
  • ac: To read authentication certificates from bootimage
  • zynq
  • zynqmp
  • versal
authenticatedjtag <options> Used to enable JTAG during secure boot. The arguments are:
  • rsa
  • ecdsa
  • versal
split <options> Splits the boot image into partitions and outputs the files as .bin or .mcs.
  • Bootheader + Image Headers + Partition Headers + Fsbl.elf
  • Partition1.bit
  • Partition2.elf
  • zynq
  • zynqmp
  • versal
spksignature <filename> Generates an SPK signature file.
  • zynq
  • zynqmp
verify <filename> This option is used for verifying authentication of a boot image. All the authentication certificates in a boot image will be verified against the available partitions.
  • zynq
  • zynqmp
verify_kdf This option is used to validate the Counter Mode KDF used in bootgen for generation AES keys.
  • zynqmp
  • versal
w <option> Specifies whether to overwrite the output files:
  • on (default)
  • off
Note: The -w without an option is interpreted as –w on.
  • All
zynqmpes1 Generates a boot image for ES1 (1.0). The default padding scheme is ES2 (2.0).
  • zynqmp