Simon Glass | 4142486 | 2022-01-09 20:14:12 -0700 | [diff] [blame] | 1 | .. SPDX-License-Identifier: GPL-2.0+ |
| 2 | |
| 3 | Binman bintool Documentation |
| 4 | ============================ |
| 5 | |
| 6 | This file describes the bintools (binary tools) supported by binman. Bintools |
| 7 | are binman's name for external executables that it runs to generate or process |
| 8 | binaries. It is fairly easy to create new bintools. Just add a new file to the |
| 9 | 'btool' directory. You can use existing bintools as examples. |
| 10 | |
| 11 | |
| 12 | |
Simon Glass | b20a112 | 2024-07-20 11:49:33 +0100 | [diff] [blame] | 13 | Bintool: bootgen: Generate bootable fsbl image for zynq/zynqmp |
| 14 | -------------------------------------------------------------- |
| 15 | |
| 16 | This bintools supports running Xilinx "bootgen" in order |
| 17 | to generate a bootable, authenticated image form an SPL. |
| 18 | |
| 19 | |
| 20 | |
| 21 | |
Simon Glass | 1285322 | 2023-02-22 12:14:46 -0700 | [diff] [blame] | 22 | Bintool: bzip2: Compression/decompression using the bzip2 algorithm |
| 23 | ------------------------------------------------------------------- |
| 24 | |
| 25 | This bintool supports running `bzip2` to compress and decompress data, as |
| 26 | used by binman. |
| 27 | |
| 28 | It is also possible to fetch the tool, which uses `apt` to install it. |
| 29 | |
| 30 | Documentation is available via:: |
| 31 | |
| 32 | man bzip2 |
| 33 | |
| 34 | |
| 35 | |
Simon Glass | 4142486 | 2022-01-09 20:14:12 -0700 | [diff] [blame] | 36 | Bintool: cbfstool: Coreboot filesystem (CBFS) tool |
| 37 | -------------------------------------------------- |
| 38 | |
| 39 | This bintool supports creating new CBFS images and adding files to an |
| 40 | existing image, i.e. the features needed by binman. |
| 41 | |
| 42 | It also supports fetching a binary cbfstool, since building it from source |
| 43 | is fairly slow. |
| 44 | |
| 45 | Documentation about CBFS is at https://www.coreboot.org/CBFS |
| 46 | |
| 47 | |
| 48 | |
Simon Glass | b20a112 | 2024-07-20 11:49:33 +0100 | [diff] [blame] | 49 | Bintool: cst: Image generation for U-Boot |
| 50 | ----------------------------------------- |
| 51 | |
| 52 | This bintool supports running `cst` with some basic parameters as |
| 53 | needed by binman. |
| 54 | |
Leonard Anderweit | 302e021 | 2025-02-26 22:05:01 +0100 | [diff] [blame^] | 55 | cst (imx code signing tool) is used for sigining bootloader binaries for |
| 56 | various i.MX SoCs. |
| 57 | |
| 58 | See `Code Signing Tool Users Guide`_ for more information. |
| 59 | |
| 60 | .. _`Code Signing Tool Users Guide`: |
| 61 | https://community.nxp.com/pwmxy87654/attachments/pwmxy87654/imx-processors/202591/1/CST_UG.pdf |
| 62 | |
Simon Glass | b20a112 | 2024-07-20 11:49:33 +0100 | [diff] [blame] | 63 | |
| 64 | |
| 65 | Bintool: fdt_add_pubkey: Add public key to control dtb (spl or u-boot proper) |
| 66 | ----------------------------------------------------------------------------- |
| 67 | |
| 68 | This bintool supports running `fdt_add_pubkey`. |
| 69 | |
| 70 | Normally mkimage adds signature information to the control dtb. However |
| 71 | binman images are built independent from each other. Thus it is required |
| 72 | to add the public key separately from mkimage. |
| 73 | |
| 74 | |
| 75 | |
Simon Glass | ffe8138 | 2024-07-20 11:49:42 +0100 | [diff] [blame] | 76 | Bintool: fdtgrep: Handles the 'fdtgrep' tool |
| 77 | -------------------------------------------- |
| 78 | |
| 79 | This bintool supports running `fdtgrep` with parameters suitable for |
| 80 | producing SPL devicetrees from the main one. |
| 81 | |
| 82 | |
| 83 | |
Simon Glass | 4142486 | 2022-01-09 20:14:12 -0700 | [diff] [blame] | 84 | Bintool: fiptool: Image generation for ARM Trusted Firmware |
| 85 | ----------------------------------------------------------- |
| 86 | |
| 87 | This bintool supports running `fiptool` with some basic parameters as |
| 88 | neeed by binman. |
| 89 | |
| 90 | It also supports build fiptool from source. |
| 91 | |
| 92 | fiptool provides a way to package firmware in an ARM Trusted Firmware |
| 93 | Firmware Image Package (ATF FIP) format. It is used with Trusted Firmware A, |
| 94 | for example. |
| 95 | |
| 96 | See `TF-A FIP tool documentation`_ for more information. |
| 97 | |
| 98 | .. _`TF-A FIP tool documentation`: |
| 99 | https://trustedfirmware-a.readthedocs.io/en/latest/getting_started/tools-build.html?highlight=fiptool#building-and-using-the-fip-tool |
| 100 | |
| 101 | |
| 102 | |
| 103 | Bintool: futility: Handles the 'futility' tool |
| 104 | ---------------------------------------------- |
| 105 | |
| 106 | futility (flash utility) is a tool for working with Chromium OS flash |
| 107 | images. This Bintool implements just the features used by Binman, related to |
| 108 | GBB creation and firmware signing. |
| 109 | |
| 110 | A binary version of the tool can be fetched. |
| 111 | |
| 112 | See `Chromium OS vboot documentation`_ for more information. |
| 113 | |
| 114 | .. _`Chromium OS vboot documentation`: |
| 115 | https://chromium.googlesource.com/chromiumos/platform/vboot/+/refs/heads/main/_vboot_reference/README |
| 116 | |
| 117 | |
| 118 | |
Simon Glass | 1285322 | 2023-02-22 12:14:46 -0700 | [diff] [blame] | 119 | Bintool: gzip: Compression/decompression using the gzip algorithm |
| 120 | ----------------------------------------------------------------- |
| 121 | |
| 122 | This bintool supports running `gzip` to compress and decompress data, as |
| 123 | used by binman. |
| 124 | |
| 125 | It is also possible to fetch the tool, which uses `apt` to install it. |
| 126 | |
| 127 | Documentation is available via:: |
| 128 | |
| 129 | man gzip |
| 130 | |
| 131 | |
| 132 | |
Simon Glass | 4142486 | 2022-01-09 20:14:12 -0700 | [diff] [blame] | 133 | Bintool: ifwitool: Handles the 'ifwitool' tool |
| 134 | ---------------------------------------------- |
| 135 | |
| 136 | This bintool supports running `ifwitool` with some basic parameters as |
| 137 | neeed by binman. It includes creating a file from a FIT as well as adding, |
| 138 | replacing, deleting and extracting subparts. |
| 139 | |
| 140 | The tool is built as part of U-Boot, but a binary version can be fetched if |
| 141 | required. |
| 142 | |
| 143 | ifwitool provides a way to package firmware in an Intel Firmware Image |
| 144 | (IFWI) file on some Intel SoCs, e.g. Apolo Lake. |
| 145 | |
| 146 | |
| 147 | |
| 148 | Bintool: lz4: Compression/decompression using the LZ4 algorithm |
| 149 | --------------------------------------------------------------- |
| 150 | |
| 151 | This bintool supports running `lz4` to compress and decompress data, as |
| 152 | used by binman. |
| 153 | |
| 154 | It is also possible to fetch the tool, which uses `apt` to install it. |
| 155 | |
| 156 | Documentation is available via:: |
| 157 | |
| 158 | man lz4 |
| 159 | |
| 160 | |
| 161 | |
| 162 | Bintool: lzma_alone: Compression/decompression using the LZMA algorithm |
| 163 | ----------------------------------------------------------------------- |
| 164 | |
| 165 | This bintool supports running `lzma_alone` to compress and decompress data, |
| 166 | as used by binman. |
| 167 | |
| 168 | It is also possible to fetch the tool, which uses `apt` to install it. |
| 169 | |
| 170 | Documentation is available via:: |
| 171 | |
| 172 | man lzma_alone |
| 173 | |
Simon Glass | 1285322 | 2023-02-22 12:14:46 -0700 | [diff] [blame] | 174 | |
| 175 | |
| 176 | Bintool: lzop: Compression/decompression using the lzop algorithm |
| 177 | ----------------------------------------------------------------- |
| 178 | |
| 179 | This bintool supports running `lzop` to compress and decompress data, as |
| 180 | used by binman. |
| 181 | |
| 182 | It is also possible to fetch the tool, which uses `apt` to install it. |
| 183 | |
| 184 | Documentation is available via:: |
| 185 | |
| 186 | man lzop |
Simon Glass | 4142486 | 2022-01-09 20:14:12 -0700 | [diff] [blame] | 187 | |
| 188 | |
Simon Glass | 1285322 | 2023-02-22 12:14:46 -0700 | [diff] [blame] | 189 | |
Simon Glass | b20a112 | 2024-07-20 11:49:33 +0100 | [diff] [blame] | 190 | Bintool: mkeficapsule: Handles the 'mkeficapsule' tool |
| 191 | ------------------------------------------------------ |
| 192 | |
| 193 | This bintool is used for generating the EFI capsules. The |
| 194 | capsule generation parameters can either be specified through |
| 195 | commandline, or through a config file. |
| 196 | |
| 197 | |
| 198 | |
Simon Glass | 4142486 | 2022-01-09 20:14:12 -0700 | [diff] [blame] | 199 | Bintool: mkimage: Image generation for U-Boot |
| 200 | --------------------------------------------- |
| 201 | |
| 202 | This bintool supports running `mkimage` with some basic parameters as |
Simon Glass | b20a112 | 2024-07-20 11:49:33 +0100 | [diff] [blame] | 203 | needed by binman. |
Simon Glass | 4142486 | 2022-01-09 20:14:12 -0700 | [diff] [blame] | 204 | |
| 205 | Normally binman uses the mkimage built by U-Boot. But when run outside the |
| 206 | U-Boot build system, binman can use the version installed in your system. |
| 207 | Support is provided for fetching this on Debian-like systems, using apt. |
| 208 | |
| 209 | |
| 210 | |
Simon Glass | d96804b | 2023-07-24 09:20:00 -0600 | [diff] [blame] | 211 | Bintool: openssl: openssl tool |
| 212 | ------------------------------ |
| 213 | |
| 214 | This bintool supports creating new openssl certificates. |
| 215 | |
| 216 | It also supports fetching a binary openssl |
| 217 | |
| 218 | Documentation about openssl is at https://www.openssl.org/ |
| 219 | |
| 220 | |
| 221 | |
Simon Glass | 1285322 | 2023-02-22 12:14:46 -0700 | [diff] [blame] | 222 | Bintool: xz: Compression/decompression using the xz algorithm |
| 223 | ------------------------------------------------------------- |
| 224 | |
| 225 | This bintool supports running `xz` to compress and decompress data, as |
| 226 | used by binman. |
| 227 | |
| 228 | It is also possible to fetch the tool, which uses `apt` to install it. |
| 229 | |
| 230 | Documentation is available via:: |
| 231 | |
| 232 | man xz |
| 233 | |
| 234 | |
| 235 | |
| 236 | Bintool: zstd: Compression/decompression using the zstd algorithm |
| 237 | ----------------------------------------------------------------- |
| 238 | |
| 239 | This bintool supports running `zstd` to compress and decompress data, as |
| 240 | used by binman. |
| 241 | |
| 242 | It is also possible to fetch the tool, which uses `apt` to install it. |
| 243 | |
| 244 | Documentation is available via:: |
| 245 | |
| 246 | man zstd |
| 247 | |
| 248 | |
Lukas Funke | 6c2c9e1 | 2023-07-18 13:53:16 +0200 | [diff] [blame] | 249 | |