Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1 | Binman Entry Documentation |
| 2 | =========================== |
| 3 | |
| 4 | This file describes the entry types supported by binman. These entry types can |
| 5 | be placed in an image one by one to build up a final firmware image. It is |
| 6 | fairly easy to create new entry types. Just add a new file to the 'etype' |
| 7 | directory. You can use the existing entries as examples. |
| 8 | |
| 9 | Note that some entries are subclasses of others, using and extending their |
| 10 | features to produce new behaviours. |
| 11 | |
| 12 | |
| 13 | |
Simon Glass | 96d340e | 2021-03-18 20:25:16 +1300 | [diff] [blame] | 14 | Entry: atf-bl31: ARM Trusted Firmware (ATF) BL31 blob |
| 15 | ----------------------------------------------------- |
Simon Glass | dc2f81a | 2020-09-01 05:13:58 -0600 | [diff] [blame] | 16 | |
| 17 | Properties / Entry arguments: |
| 18 | - atf-bl31-path: Filename of file to read into entry. This is typically |
| 19 | called bl31.bin or bl31.elf |
| 20 | |
| 21 | This entry holds the run-time firmware, typically started by U-Boot SPL. |
| 22 | See the U-Boot README for your architecture or board for how to use it. See |
| 23 | https://github.com/ARM-software/arm-trusted-firmware for more information |
| 24 | about ATF. |
| 25 | |
| 26 | |
| 27 | |
Simon Glass | 96d340e | 2021-03-18 20:25:16 +1300 | [diff] [blame] | 28 | Entry: blob: Arbitrary binary blob |
| 29 | ---------------------------------- |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 30 | |
| 31 | Note: This should not be used by itself. It is normally used as a parent |
| 32 | class by other entry types. |
| 33 | |
| 34 | Properties / Entry arguments: |
| 35 | - filename: Filename of file to read into entry |
Simon Glass | 83d73c2 | 2018-09-14 04:57:26 -0600 | [diff] [blame] | 36 | - compress: Compression algorithm to use: |
| 37 | none: No compression |
| 38 | lz4: Use lz4 compression (via 'lz4' command-line utility) |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 39 | |
| 40 | This entry reads data from a file and places it in the entry. The |
| 41 | default filename is often specified specified by the subclass. See for |
Simon Glass | adc59ea | 2021-03-18 20:24:54 +1300 | [diff] [blame] | 42 | example the 'u-boot' entry which provides the filename 'u-boot.bin'. |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 43 | |
Simon Glass | 83d73c2 | 2018-09-14 04:57:26 -0600 | [diff] [blame] | 44 | If compression is enabled, an extra 'uncomp-size' property is written to |
| 45 | the node (if enabled with -u) which provides the uncompressed size of the |
| 46 | data. |
| 47 | |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 48 | |
| 49 | |
Simon Glass | 6ed45ba | 2018-09-14 04:57:24 -0600 | [diff] [blame] | 50 | Entry: blob-dtb: A blob that holds a device tree |
| 51 | ------------------------------------------------ |
| 52 | |
| 53 | This is a blob containing a device tree. The contents of the blob are |
| 54 | obtained from the list of available device-tree files, managed by the |
| 55 | 'state' module. |
| 56 | |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 57 | |
| 58 | |
Simon Glass | 96d340e | 2021-03-18 20:25:16 +1300 | [diff] [blame] | 59 | Entry: blob-ext: Externally built binary blob |
| 60 | --------------------------------------------- |
Simon Glass | ce867ad | 2020-07-09 18:39:36 -0600 | [diff] [blame] | 61 | |
| 62 | Note: This should not be used by itself. It is normally used as a parent |
| 63 | class by other entry types. |
| 64 | |
Simon Glass | 4f9f105 | 2020-07-09 18:39:38 -0600 | [diff] [blame] | 65 | If the file providing this blob is missing, binman can optionally ignore it |
| 66 | and produce a broken image with a warning. |
| 67 | |
Simon Glass | ce867ad | 2020-07-09 18:39:36 -0600 | [diff] [blame] | 68 | See 'blob' for Properties / Entry arguments. |
| 69 | |
| 70 | |
| 71 | |
Simon Glass | cc2c500 | 2021-11-23 21:09:52 -0700 | [diff] [blame^] | 72 | Entry: blob-ext-list: List of externally built binary blobs |
| 73 | ----------------------------------------------------------- |
| 74 | |
| 75 | This is like blob-ext except that a number of blobs can be provided, |
| 76 | typically with some sort of relationship, e.g. all are DDC parameters. |
| 77 | |
| 78 | If any of the external files needed by this llist is missing, binman can |
| 79 | optionally ignore it and produce a broken image with a warning. |
| 80 | |
| 81 | Args: |
| 82 | filenames: List of filenames to read and include |
| 83 | |
| 84 | |
| 85 | |
Simon Glass | ec127af | 2018-07-17 13:25:39 -0600 | [diff] [blame] | 86 | Entry: blob-named-by-arg: A blob entry which gets its filename property from its subclass |
| 87 | ----------------------------------------------------------------------------------------- |
| 88 | |
| 89 | Properties / Entry arguments: |
| 90 | - <xxx>-path: Filename containing the contents of this entry (optional, |
Simon Glass | 3decfa3 | 2020-09-01 05:13:54 -0600 | [diff] [blame] | 91 | defaults to None) |
Simon Glass | ec127af | 2018-07-17 13:25:39 -0600 | [diff] [blame] | 92 | |
| 93 | where <xxx> is the blob_fname argument to the constructor. |
| 94 | |
| 95 | This entry cannot be used directly. Instead, it is used as a parent class |
| 96 | for another entry, which defined blob_fname. This parameter is used to |
| 97 | set the entry-arg or property containing the filename. The entry-arg or |
| 98 | property is in turn used to set the actual filename. |
| 99 | |
| 100 | See cros_ec_rw for an example of this. |
| 101 | |
| 102 | |
| 103 | |
Simon Glass | 0668492 | 2021-03-18 20:25:07 +1300 | [diff] [blame] | 104 | Entry: blob-phase: Section that holds a phase binary |
| 105 | ---------------------------------------------------- |
| 106 | |
| 107 | This is a base class that should not normally be used directly. It is used |
| 108 | when converting a 'u-boot' entry automatically into a 'u-boot-expanded' |
| 109 | entry; similarly for SPL. |
| 110 | |
| 111 | |
| 112 | |
Simon Glass | 96d340e | 2021-03-18 20:25:16 +1300 | [diff] [blame] | 113 | Entry: cbfs: Coreboot Filesystem (CBFS) |
| 114 | --------------------------------------- |
Simon Glass | ac62fba | 2019-07-08 13:18:53 -0600 | [diff] [blame] | 115 | |
| 116 | A CBFS provides a way to group files into a group. It has a simple directory |
| 117 | structure and allows the position of individual files to be set, since it is |
| 118 | designed to support execute-in-place in an x86 SPI-flash device. Where XIP |
| 119 | is not used, it supports compression and storing ELF files. |
| 120 | |
| 121 | CBFS is used by coreboot as its way of orgnanising SPI-flash contents. |
| 122 | |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 123 | The contents of the CBFS are defined by subnodes of the cbfs entry, e.g.:: |
Simon Glass | ac62fba | 2019-07-08 13:18:53 -0600 | [diff] [blame] | 124 | |
| 125 | cbfs { |
| 126 | size = <0x100000>; |
| 127 | u-boot { |
| 128 | cbfs-type = "raw"; |
| 129 | }; |
| 130 | u-boot-dtb { |
| 131 | cbfs-type = "raw"; |
| 132 | }; |
| 133 | }; |
| 134 | |
| 135 | This creates a CBFS 1MB in size two files in it: u-boot.bin and u-boot.dtb. |
| 136 | Note that the size is required since binman does not support calculating it. |
| 137 | The contents of each entry is just what binman would normally provide if it |
| 138 | were not a CBFS node. A blob type can be used to import arbitrary files as |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 139 | with the second subnode below:: |
Simon Glass | ac62fba | 2019-07-08 13:18:53 -0600 | [diff] [blame] | 140 | |
| 141 | cbfs { |
| 142 | size = <0x100000>; |
| 143 | u-boot { |
| 144 | cbfs-name = "BOOT"; |
| 145 | cbfs-type = "raw"; |
| 146 | }; |
| 147 | |
| 148 | dtb { |
| 149 | type = "blob"; |
| 150 | filename = "u-boot.dtb"; |
| 151 | cbfs-type = "raw"; |
| 152 | cbfs-compress = "lz4"; |
Simon Glass | e073d4e | 2019-07-08 13:18:56 -0600 | [diff] [blame] | 153 | cbfs-offset = <0x100000>; |
Simon Glass | ac62fba | 2019-07-08 13:18:53 -0600 | [diff] [blame] | 154 | }; |
| 155 | }; |
| 156 | |
| 157 | This creates a CBFS 1MB in size with u-boot.bin (named "BOOT") and |
| 158 | u-boot.dtb (named "dtb") and compressed with the lz4 algorithm. |
| 159 | |
| 160 | |
| 161 | Properties supported in the top-level CBFS node: |
| 162 | |
| 163 | cbfs-arch: |
| 164 | Defaults to "x86", but you can specify the architecture if needed. |
| 165 | |
| 166 | |
| 167 | Properties supported in the CBFS entry subnodes: |
| 168 | |
| 169 | cbfs-name: |
| 170 | This is the name of the file created in CBFS. It defaults to the entry |
| 171 | name (which is the node name), but you can override it with this |
| 172 | property. |
| 173 | |
| 174 | cbfs-type: |
| 175 | This is the CBFS file type. The following are supported: |
| 176 | |
| 177 | raw: |
| 178 | This is a 'raw' file, although compression is supported. It can be |
| 179 | used to store any file in CBFS. |
| 180 | |
| 181 | stage: |
| 182 | This is an ELF file that has been loaded (i.e. mapped to memory), so |
| 183 | appears in the CBFS as a flat binary. The input file must be an ELF |
| 184 | image, for example this puts "u-boot" (the ELF image) into a 'stage' |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 185 | entry:: |
Simon Glass | ac62fba | 2019-07-08 13:18:53 -0600 | [diff] [blame] | 186 | |
| 187 | cbfs { |
| 188 | size = <0x100000>; |
| 189 | u-boot-elf { |
| 190 | cbfs-name = "BOOT"; |
| 191 | cbfs-type = "stage"; |
| 192 | }; |
| 193 | }; |
| 194 | |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 195 | You can use your own ELF file with something like:: |
Simon Glass | ac62fba | 2019-07-08 13:18:53 -0600 | [diff] [blame] | 196 | |
| 197 | cbfs { |
| 198 | size = <0x100000>; |
| 199 | something { |
| 200 | type = "blob"; |
| 201 | filename = "cbfs-stage.elf"; |
| 202 | cbfs-type = "stage"; |
| 203 | }; |
| 204 | }; |
| 205 | |
| 206 | As mentioned, the file is converted to a flat binary, so it is |
| 207 | equivalent to adding "u-boot.bin", for example, but with the load and |
| 208 | start addresses specified by the ELF. At present there is no option |
| 209 | to add a flat binary with a load/start address, similar to the |
| 210 | 'add-flat-binary' option in cbfstool. |
| 211 | |
Simon Glass | e073d4e | 2019-07-08 13:18:56 -0600 | [diff] [blame] | 212 | cbfs-offset: |
| 213 | This is the offset of the file's data within the CBFS. It is used to |
| 214 | specify where the file should be placed in cases where a fixed position |
| 215 | is needed. Typical uses are for code which is not relocatable and must |
| 216 | execute in-place from a particular address. This works because SPI flash |
| 217 | is generally mapped into memory on x86 devices. The file header is |
| 218 | placed before this offset so that the data start lines up exactly with |
| 219 | the chosen offset. If this property is not provided, then the file is |
| 220 | placed in the next available spot. |
Simon Glass | ac62fba | 2019-07-08 13:18:53 -0600 | [diff] [blame] | 221 | |
| 222 | The current implementation supports only a subset of CBFS features. It does |
| 223 | not support other file types (e.g. payload), adding multiple files (like the |
| 224 | 'files' entry with a pattern supported by binman), putting files at a |
| 225 | particular offset in the CBFS and a few other things. |
| 226 | |
| 227 | Of course binman can create images containing multiple CBFSs, simply by |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 228 | defining these in the binman config:: |
Simon Glass | ac62fba | 2019-07-08 13:18:53 -0600 | [diff] [blame] | 229 | |
| 230 | |
| 231 | binman { |
| 232 | size = <0x800000>; |
| 233 | cbfs { |
| 234 | offset = <0x100000>; |
| 235 | size = <0x100000>; |
| 236 | u-boot { |
| 237 | cbfs-type = "raw"; |
| 238 | }; |
| 239 | u-boot-dtb { |
| 240 | cbfs-type = "raw"; |
| 241 | }; |
| 242 | }; |
| 243 | |
| 244 | cbfs2 { |
| 245 | offset = <0x700000>; |
| 246 | size = <0x100000>; |
| 247 | u-boot { |
| 248 | cbfs-type = "raw"; |
| 249 | }; |
| 250 | u-boot-dtb { |
| 251 | cbfs-type = "raw"; |
| 252 | }; |
| 253 | image { |
| 254 | type = "blob"; |
| 255 | filename = "image.jpg"; |
| 256 | }; |
| 257 | }; |
| 258 | }; |
| 259 | |
| 260 | This creates an 8MB image with two CBFSs, one at offset 1MB, one at 7MB, |
| 261 | both of size 1MB. |
| 262 | |
| 263 | |
| 264 | |
Simon Glass | 189f291 | 2021-03-21 18:24:31 +1300 | [diff] [blame] | 265 | Entry: collection: An entry which contains a collection of other entries |
| 266 | ------------------------------------------------------------------------ |
| 267 | |
| 268 | Properties / Entry arguments: |
| 269 | - content: List of phandles to entries to include |
| 270 | |
| 271 | This allows reusing the contents of other entries. The contents of the |
| 272 | listed entries are combined to form this entry. This serves as a useful |
| 273 | base class for entry types which need to process data from elsewhere in |
| 274 | the image, not necessarily child entries. |
| 275 | |
| 276 | |
| 277 | |
Simon Glass | ec127af | 2018-07-17 13:25:39 -0600 | [diff] [blame] | 278 | Entry: cros-ec-rw: A blob entry which contains a Chromium OS read-write EC image |
| 279 | -------------------------------------------------------------------------------- |
| 280 | |
| 281 | Properties / Entry arguments: |
| 282 | - cros-ec-rw-path: Filename containing the EC image |
| 283 | |
| 284 | This entry holds a Chromium OS EC (embedded controller) image, for use in |
| 285 | updating the EC on startup via software sync. |
| 286 | |
| 287 | |
| 288 | |
Simon Glass | 086cec9 | 2019-07-08 14:25:27 -0600 | [diff] [blame] | 289 | Entry: fdtmap: An entry which contains an FDT map |
| 290 | ------------------------------------------------- |
| 291 | |
| 292 | Properties / Entry arguments: |
| 293 | None |
| 294 | |
| 295 | An FDT map is just a header followed by an FDT containing a list of all the |
Simon Glass | 12bb1a9 | 2019-07-20 12:23:51 -0600 | [diff] [blame] | 296 | entries in the image. The root node corresponds to the image node in the |
| 297 | original FDT, and an image-name property indicates the image name in that |
| 298 | original tree. |
Simon Glass | 086cec9 | 2019-07-08 14:25:27 -0600 | [diff] [blame] | 299 | |
| 300 | The header is the string _FDTMAP_ followed by 8 unused bytes. |
| 301 | |
| 302 | When used, this entry will be populated with an FDT map which reflects the |
| 303 | entries in the current image. Hierarchy is preserved, and all offsets and |
| 304 | sizes are included. |
| 305 | |
| 306 | Note that the -u option must be provided to ensure that binman updates the |
| 307 | FDT with the position of each entry. |
| 308 | |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 309 | Example output for a simple image with U-Boot and an FDT map:: |
Simon Glass | 086cec9 | 2019-07-08 14:25:27 -0600 | [diff] [blame] | 310 | |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 311 | / { |
| 312 | image-name = "binman"; |
| 313 | size = <0x00000112>; |
Simon Glass | 086cec9 | 2019-07-08 14:25:27 -0600 | [diff] [blame] | 314 | image-pos = <0x00000000>; |
| 315 | offset = <0x00000000>; |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 316 | u-boot { |
| 317 | size = <0x00000004>; |
| 318 | image-pos = <0x00000000>; |
| 319 | offset = <0x00000000>; |
| 320 | }; |
| 321 | fdtmap { |
| 322 | size = <0x0000010e>; |
| 323 | image-pos = <0x00000004>; |
| 324 | offset = <0x00000004>; |
| 325 | }; |
Simon Glass | 086cec9 | 2019-07-08 14:25:27 -0600 | [diff] [blame] | 326 | }; |
Simon Glass | 086cec9 | 2019-07-08 14:25:27 -0600 | [diff] [blame] | 327 | |
Simon Glass | 12bb1a9 | 2019-07-20 12:23:51 -0600 | [diff] [blame] | 328 | If allow-repack is used then 'orig-offset' and 'orig-size' properties are |
| 329 | added as necessary. See the binman README. |
| 330 | |
Simon Glass | 943bf78 | 2021-11-23 21:09:50 -0700 | [diff] [blame] | 331 | When extracting files, an alternative 'fdt' format is available for fdtmaps. |
| 332 | Use `binman extract -F fdt ...` to use this. It will export a devicetree, |
| 333 | without the fdtmap header, so it can be viewed with `fdtdump`. |
| 334 | |
Simon Glass | 086cec9 | 2019-07-08 14:25:27 -0600 | [diff] [blame] | 335 | |
| 336 | |
Simon Glass | 96d340e | 2021-03-18 20:25:16 +1300 | [diff] [blame] | 337 | Entry: files: A set of files arranged in a section |
| 338 | -------------------------------------------------- |
Simon Glass | 0a98b28 | 2018-09-14 04:57:28 -0600 | [diff] [blame] | 339 | |
| 340 | Properties / Entry arguments: |
| 341 | - pattern: Filename pattern to match the files to include |
Simon Glass | 9248c8d | 2020-10-26 17:40:07 -0600 | [diff] [blame] | 342 | - files-compress: Compression algorithm to use: |
Simon Glass | 0a98b28 | 2018-09-14 04:57:28 -0600 | [diff] [blame] | 343 | none: No compression |
| 344 | lz4: Use lz4 compression (via 'lz4' command-line utility) |
Simon Glass | 4ce4077 | 2021-03-18 20:24:53 +1300 | [diff] [blame] | 345 | - files-align: Align each file to the given alignment |
Simon Glass | 0a98b28 | 2018-09-14 04:57:28 -0600 | [diff] [blame] | 346 | |
| 347 | This entry reads a number of files and places each in a separate sub-entry |
| 348 | within this entry. To access these you need to enable device-tree updates |
| 349 | at run-time so you can obtain the file positions. |
| 350 | |
| 351 | |
| 352 | |
Simon Glass | 3af8e49 | 2018-07-17 13:25:40 -0600 | [diff] [blame] | 353 | Entry: fill: An entry which is filled to a particular byte value |
| 354 | ---------------------------------------------------------------- |
| 355 | |
| 356 | Properties / Entry arguments: |
| 357 | - fill-byte: Byte to use to fill the entry |
| 358 | |
| 359 | Note that the size property must be set since otherwise this entry does not |
| 360 | know how large it should be. |
| 361 | |
| 362 | You can often achieve the same effect using the pad-byte property of the |
| 363 | overall image, in that the space between entries will then be padded with |
| 364 | that byte. But this entry is sometimes useful for explicitly setting the |
| 365 | byte value of a region. |
| 366 | |
| 367 | |
| 368 | |
Simon Glass | 96d340e | 2021-03-18 20:25:16 +1300 | [diff] [blame] | 369 | Entry: fit: Flat Image Tree (FIT) |
| 370 | --------------------------------- |
Simon Glass | fdc3436 | 2020-07-09 18:39:45 -0600 | [diff] [blame] | 371 | |
| 372 | This calls mkimage to create a FIT (U-Boot Flat Image Tree) based on the |
| 373 | input provided. |
| 374 | |
| 375 | Nodes for the FIT should be written out in the binman configuration just as |
| 376 | they would be in a file passed to mkimage. |
| 377 | |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 378 | For example, this creates an image containing a FIT with U-Boot SPL:: |
Simon Glass | fdc3436 | 2020-07-09 18:39:45 -0600 | [diff] [blame] | 379 | |
| 380 | binman { |
| 381 | fit { |
| 382 | description = "Test FIT"; |
Simon Glass | 6cf9953 | 2020-09-01 05:13:59 -0600 | [diff] [blame] | 383 | fit,fdt-list = "of-list"; |
Simon Glass | fdc3436 | 2020-07-09 18:39:45 -0600 | [diff] [blame] | 384 | |
| 385 | images { |
| 386 | kernel@1 { |
| 387 | description = "SPL"; |
| 388 | os = "u-boot"; |
| 389 | type = "rkspi"; |
| 390 | arch = "arm"; |
| 391 | compression = "none"; |
| 392 | load = <0>; |
| 393 | entry = <0>; |
| 394 | |
| 395 | u-boot-spl { |
| 396 | }; |
| 397 | }; |
| 398 | }; |
| 399 | }; |
| 400 | }; |
| 401 | |
Simon Glass | 6cf9953 | 2020-09-01 05:13:59 -0600 | [diff] [blame] | 402 | U-Boot supports creating fdt and config nodes automatically. To do this, |
| 403 | pass an of-list property (e.g. -a of-list=file1 file2). This tells binman |
| 404 | that you want to generates nodes for two files: file1.dtb and file2.dtb |
| 405 | The fit,fdt-list property (see above) indicates that of-list should be used. |
| 406 | If the property is missing you will get an error. |
| 407 | |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 408 | Then add a 'generator node', a node with a name starting with '@':: |
Simon Glass | 6cf9953 | 2020-09-01 05:13:59 -0600 | [diff] [blame] | 409 | |
| 410 | images { |
| 411 | @fdt-SEQ { |
| 412 | description = "fdt-NAME"; |
| 413 | type = "flat_dt"; |
| 414 | compression = "none"; |
| 415 | }; |
| 416 | }; |
| 417 | |
| 418 | This tells binman to create nodes fdt-1 and fdt-2 for each of your two |
| 419 | files. All the properties you specify will be included in the node. This |
| 420 | node acts like a template to generate the nodes. The generator node itself |
| 421 | does not appear in the output - it is replaced with what binman generates. |
| 422 | |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 423 | You can create config nodes in a similar way:: |
Simon Glass | 6cf9953 | 2020-09-01 05:13:59 -0600 | [diff] [blame] | 424 | |
| 425 | configurations { |
| 426 | default = "@config-DEFAULT-SEQ"; |
| 427 | @config-SEQ { |
| 428 | description = "NAME"; |
Samuel Holland | 68158d5 | 2020-10-21 21:12:14 -0500 | [diff] [blame] | 429 | firmware = "atf"; |
| 430 | loadables = "uboot"; |
Simon Glass | 6cf9953 | 2020-09-01 05:13:59 -0600 | [diff] [blame] | 431 | fdt = "fdt-SEQ"; |
| 432 | }; |
| 433 | }; |
| 434 | |
| 435 | This tells binman to create nodes config-1 and config-2, i.e. a config for |
| 436 | each of your two files. |
| 437 | |
| 438 | Available substitutions for '@' nodes are: |
| 439 | |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 440 | SEQ: |
| 441 | Sequence number of the generated fdt (1, 2, ...) |
| 442 | NAME |
| 443 | Name of the dtb as provided (i.e. without adding '.dtb') |
Simon Glass | 6cf9953 | 2020-09-01 05:13:59 -0600 | [diff] [blame] | 444 | |
| 445 | Note that if no devicetree files are provided (with '-a of-list' as above) |
| 446 | then no nodes will be generated. |
| 447 | |
Simon Glass | c0f1ebe | 2020-09-06 10:39:08 -0600 | [diff] [blame] | 448 | The 'default' property, if present, will be automatically set to the name |
| 449 | if of configuration whose devicetree matches the 'default-dt' entry |
| 450 | argument, e.g. with '-a default-dt=sun50i-a64-pine64-lts'. |
| 451 | |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 452 | Available substitutions for '@' property values are |
Simon Glass | f324330 | 2020-10-26 17:39:59 -0600 | [diff] [blame] | 453 | |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 454 | DEFAULT-SEQ: |
| 455 | Sequence number of the default fdt,as provided by the 'default-dt' entry |
| 456 | argument |
Simon Glass | 6cf9953 | 2020-09-01 05:13:59 -0600 | [diff] [blame] | 457 | |
| 458 | Properties (in the 'fit' node itself): |
Simon Glass | fdc3436 | 2020-07-09 18:39:45 -0600 | [diff] [blame] | 459 | fit,external-offset: Indicates that the contents of the FIT are external |
| 460 | and provides the external offset. This is passsed to mkimage via |
| 461 | the -E and -p flags. |
| 462 | |
| 463 | |
| 464 | |
| 465 | |
Simon Glass | 11e36cc | 2018-07-17 13:25:38 -0600 | [diff] [blame] | 466 | Entry: fmap: An entry which contains an Fmap section |
| 467 | ---------------------------------------------------- |
| 468 | |
| 469 | Properties / Entry arguments: |
| 470 | None |
| 471 | |
| 472 | FMAP is a simple format used by flashrom, an open-source utility for |
| 473 | reading and writing the SPI flash, typically on x86 CPUs. The format |
| 474 | provides flashrom with a list of areas, so it knows what it in the flash. |
| 475 | It can then read or write just a single area, instead of the whole flash. |
| 476 | |
| 477 | The format is defined by the flashrom project, in the file lib/fmap.h - |
| 478 | see www.flashrom.org/Flashrom for more information. |
| 479 | |
| 480 | When used, this entry will be populated with an FMAP which reflects the |
| 481 | entries in the current image. Note that any hierarchy is squashed, since |
Simon Glass | 1736575 | 2021-04-03 11:05:10 +1300 | [diff] [blame] | 482 | FMAP does not support this. Sections are represented as an area appearing |
| 483 | before its contents, so that it is possible to reconstruct the hierarchy |
| 484 | from the FMAP by using the offset information. This convention does not |
| 485 | seem to be documented, but is used in Chromium OS. |
| 486 | |
| 487 | CBFS entries appear as a single entry, i.e. the sub-entries are ignored. |
Simon Glass | 11e36cc | 2018-07-17 13:25:38 -0600 | [diff] [blame] | 488 | |
| 489 | |
| 490 | |
Simon Glass | 0ef87aa | 2018-07-17 13:25:44 -0600 | [diff] [blame] | 491 | Entry: gbb: An entry which contains a Chromium OS Google Binary Block |
| 492 | --------------------------------------------------------------------- |
| 493 | |
| 494 | Properties / Entry arguments: |
| 495 | - hardware-id: Hardware ID to use for this build (a string) |
| 496 | - keydir: Directory containing the public keys to use |
| 497 | - bmpblk: Filename containing images used by recovery |
| 498 | |
| 499 | Chromium OS uses a GBB to store various pieces of information, in particular |
| 500 | the root and recovery keys that are used to verify the boot process. Some |
| 501 | more details are here: |
| 502 | |
| 503 | https://www.chromium.org/chromium-os/firmware-porting-guide/2-concepts |
| 504 | |
| 505 | but note that the page dates from 2013 so is quite out of date. See |
| 506 | README.chromium for how to obtain the required keys and tools. |
| 507 | |
| 508 | |
| 509 | |
Simon Glass | cf22894 | 2019-07-08 14:25:28 -0600 | [diff] [blame] | 510 | Entry: image-header: An entry which contains a pointer to the FDT map |
| 511 | --------------------------------------------------------------------- |
| 512 | |
| 513 | Properties / Entry arguments: |
| 514 | location: Location of header ("start" or "end" of image). This is |
| 515 | optional. If omitted then the entry must have an offset property. |
| 516 | |
| 517 | This adds an 8-byte entry to the start or end of the image, pointing to the |
| 518 | location of the FDT map. The format is a magic number followed by an offset |
| 519 | from the start or end of the image, in twos-compliment format. |
| 520 | |
| 521 | This entry must be in the top-level part of the image. |
| 522 | |
| 523 | NOTE: If the location is at the start/end, you will probably need to specify |
| 524 | sort-by-offset for the image, unless you actually put the image header |
| 525 | first/last in the entry list. |
| 526 | |
| 527 | |
| 528 | |
Simon Glass | 96d340e | 2021-03-18 20:25:16 +1300 | [diff] [blame] | 529 | Entry: intel-cmc: Intel Chipset Micro Code (CMC) file |
| 530 | ----------------------------------------------------- |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 531 | |
| 532 | Properties / Entry arguments: |
| 533 | - filename: Filename of file to read into entry |
| 534 | |
| 535 | This file contains microcode for some devices in a special format. An |
| 536 | example filename is 'Microcode/C0_22211.BIN'. |
| 537 | |
| 538 | See README.x86 for information about x86 binary blobs. |
| 539 | |
| 540 | |
| 541 | |
| 542 | Entry: intel-descriptor: Intel flash descriptor block (4KB) |
| 543 | ----------------------------------------------------------- |
| 544 | |
| 545 | Properties / Entry arguments: |
| 546 | filename: Filename of file containing the descriptor. This is typically |
| 547 | a 4KB binary file, sometimes called 'descriptor.bin' |
| 548 | |
| 549 | This entry is placed at the start of flash and provides information about |
| 550 | the SPI flash regions. In particular it provides the base address and |
| 551 | size of the ME (Management Engine) region, allowing us to place the ME |
| 552 | binary in the right place. |
| 553 | |
| 554 | With this entry in your image, the position of the 'intel-me' entry will be |
| 555 | fixed in the image, which avoids you needed to specify an offset for that |
| 556 | region. This is useful, because it is not possible to change the position |
| 557 | of the ME region without updating the descriptor. |
| 558 | |
| 559 | See README.x86 for information about x86 binary blobs. |
| 560 | |
| 561 | |
| 562 | |
Simon Glass | 5af1207 | 2019-08-24 07:22:50 -0600 | [diff] [blame] | 563 | Entry: intel-fit: Intel Firmware Image Table (FIT) |
| 564 | -------------------------------------------------- |
| 565 | |
| 566 | This entry contains a dummy FIT as required by recent Intel CPUs. The FIT |
| 567 | contains information about the firmware and microcode available in the |
| 568 | image. |
| 569 | |
| 570 | At present binman only supports a basic FIT with no microcode. |
| 571 | |
| 572 | |
| 573 | |
| 574 | Entry: intel-fit-ptr: Intel Firmware Image Table (FIT) pointer |
| 575 | -------------------------------------------------------------- |
| 576 | |
| 577 | This entry contains a pointer to the FIT. It is required to be at address |
| 578 | 0xffffffc0 in the image. |
| 579 | |
| 580 | |
| 581 | |
Simon Glass | 96d340e | 2021-03-18 20:25:16 +1300 | [diff] [blame] | 582 | Entry: intel-fsp: Intel Firmware Support Package (FSP) file |
| 583 | ----------------------------------------------------------- |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 584 | |
| 585 | Properties / Entry arguments: |
| 586 | - filename: Filename of file to read into entry |
| 587 | |
| 588 | This file contains binary blobs which are used on some devices to make the |
| 589 | platform work. U-Boot executes this code since it is not possible to set up |
| 590 | the hardware using U-Boot open-source code. Documentation is typically not |
| 591 | available in sufficient detail to allow this. |
| 592 | |
| 593 | An example filename is 'FSP/QUEENSBAY_FSP_GOLD_001_20-DECEMBER-2013.fd' |
| 594 | |
| 595 | See README.x86 for information about x86 binary blobs. |
| 596 | |
| 597 | |
| 598 | |
Simon Glass | 96d340e | 2021-03-18 20:25:16 +1300 | [diff] [blame] | 599 | Entry: intel-fsp-m: Intel Firmware Support Package (FSP) memory init |
| 600 | -------------------------------------------------------------------- |
Simon Glass | ea0fff9 | 2019-08-24 07:23:07 -0600 | [diff] [blame] | 601 | |
| 602 | Properties / Entry arguments: |
| 603 | - filename: Filename of file to read into entry |
| 604 | |
| 605 | This file contains a binary blob which is used on some devices to set up |
| 606 | SDRAM. U-Boot executes this code in SPL so that it can make full use of |
| 607 | memory. Documentation is typically not available in sufficient detail to |
| 608 | allow U-Boot do this this itself.. |
| 609 | |
| 610 | An example filename is 'fsp_m.bin' |
| 611 | |
| 612 | See README.x86 for information about x86 binary blobs. |
| 613 | |
| 614 | |
| 615 | |
Simon Glass | 96d340e | 2021-03-18 20:25:16 +1300 | [diff] [blame] | 616 | Entry: intel-fsp-s: Intel Firmware Support Package (FSP) silicon init |
| 617 | --------------------------------------------------------------------- |
Simon Glass | bc6a88f | 2019-10-20 21:31:35 -0600 | [diff] [blame] | 618 | |
| 619 | Properties / Entry arguments: |
| 620 | - filename: Filename of file to read into entry |
| 621 | |
| 622 | This file contains a binary blob which is used on some devices to set up |
| 623 | the silicon. U-Boot executes this code in U-Boot proper after SDRAM is |
| 624 | running, so that it can make full use of memory. Documentation is typically |
| 625 | not available in sufficient detail to allow U-Boot do this this itself. |
| 626 | |
| 627 | An example filename is 'fsp_s.bin' |
| 628 | |
| 629 | See README.x86 for information about x86 binary blobs. |
| 630 | |
| 631 | |
| 632 | |
Simon Glass | 96d340e | 2021-03-18 20:25:16 +1300 | [diff] [blame] | 633 | Entry: intel-fsp-t: Intel Firmware Support Package (FSP) temp ram init |
| 634 | ---------------------------------------------------------------------- |
Simon Glass | 998d148 | 2019-10-20 21:31:36 -0600 | [diff] [blame] | 635 | |
| 636 | Properties / Entry arguments: |
| 637 | - filename: Filename of file to read into entry |
| 638 | |
| 639 | This file contains a binary blob which is used on some devices to set up |
| 640 | temporary memory (Cache-as-RAM or CAR). U-Boot executes this code in TPL so |
| 641 | that it has access to memory for its stack and initial storage. |
| 642 | |
| 643 | An example filename is 'fsp_t.bin' |
| 644 | |
| 645 | See README.x86 for information about x86 binary blobs. |
| 646 | |
| 647 | |
| 648 | |
Simon Glass | 96d340e | 2021-03-18 20:25:16 +1300 | [diff] [blame] | 649 | Entry: intel-ifwi: Intel Integrated Firmware Image (IFWI) file |
| 650 | -------------------------------------------------------------- |
Simon Glass | e073d4e | 2019-07-08 13:18:56 -0600 | [diff] [blame] | 651 | |
| 652 | Properties / Entry arguments: |
| 653 | - filename: Filename of file to read into entry. This is either the |
| 654 | IFWI file itself, or a file that can be converted into one using a |
| 655 | tool |
| 656 | - convert-fit: If present this indicates that the ifwitool should be |
| 657 | used to convert the provided file into a IFWI. |
| 658 | |
| 659 | This file contains code and data used by the SoC that is required to make |
| 660 | it work. It includes U-Boot TPL, microcode, things related to the CSE |
| 661 | (Converged Security Engine, the microcontroller that loads all the firmware) |
| 662 | and other items beyond the wit of man. |
| 663 | |
| 664 | A typical filename is 'ifwi.bin' for an IFWI file, or 'fitimage.bin' for a |
| 665 | file that will be converted to an IFWI. |
| 666 | |
| 667 | The position of this entry is generally set by the intel-descriptor entry. |
| 668 | |
| 669 | The contents of the IFWI are specified by the subnodes of the IFWI node. |
| 670 | Each subnode describes an entry which is placed into the IFWFI with a given |
| 671 | sub-partition (and optional entry name). |
| 672 | |
Simon Glass | 3da9ce8 | 2019-08-24 07:22:47 -0600 | [diff] [blame] | 673 | Properties for subnodes: |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 674 | - ifwi-subpart: sub-parition to put this entry into, e.g. "IBBP" |
| 675 | - ifwi-entry: entry name t use, e.g. "IBBL" |
| 676 | - ifwi-replace: if present, indicates that the item should be replaced |
| 677 | in the IFWI. Otherwise it is added. |
Simon Glass | 3da9ce8 | 2019-08-24 07:22:47 -0600 | [diff] [blame] | 678 | |
Simon Glass | e073d4e | 2019-07-08 13:18:56 -0600 | [diff] [blame] | 679 | See README.x86 for information about x86 binary blobs. |
| 680 | |
| 681 | |
| 682 | |
Simon Glass | 96d340e | 2021-03-18 20:25:16 +1300 | [diff] [blame] | 683 | Entry: intel-me: Intel Management Engine (ME) file |
| 684 | -------------------------------------------------- |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 685 | |
| 686 | Properties / Entry arguments: |
| 687 | - filename: Filename of file to read into entry |
| 688 | |
| 689 | This file contains code used by the SoC that is required to make it work. |
| 690 | The Management Engine is like a background task that runs things that are |
Thomas Hebb | 32f2ca2 | 2019-11-13 18:18:03 -0800 | [diff] [blame] | 691 | not clearly documented, but may include keyboard, display and network |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 692 | access. For platform that use ME it is not possible to disable it. U-Boot |
| 693 | does not directly execute code in the ME binary. |
| 694 | |
| 695 | A typical filename is 'me.bin'. |
| 696 | |
Simon Glass | fa1c937 | 2019-07-08 13:18:38 -0600 | [diff] [blame] | 697 | The position of this entry is generally set by the intel-descriptor entry. |
| 698 | |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 699 | See README.x86 for information about x86 binary blobs. |
| 700 | |
| 701 | |
| 702 | |
Simon Glass | 96d340e | 2021-03-18 20:25:16 +1300 | [diff] [blame] | 703 | Entry: intel-mrc: Intel Memory Reference Code (MRC) file |
| 704 | -------------------------------------------------------- |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 705 | |
| 706 | Properties / Entry arguments: |
| 707 | - filename: Filename of file to read into entry |
| 708 | |
| 709 | This file contains code for setting up the SDRAM on some Intel systems. This |
| 710 | is executed by U-Boot when needed early during startup. A typical filename |
| 711 | is 'mrc.bin'. |
| 712 | |
| 713 | See README.x86 for information about x86 binary blobs. |
| 714 | |
| 715 | |
| 716 | |
Simon Glass | 96d340e | 2021-03-18 20:25:16 +1300 | [diff] [blame] | 717 | Entry: intel-refcode: Intel Reference Code file |
| 718 | ----------------------------------------------- |
Simon Glass | 5385f5a | 2019-05-17 22:00:53 -0600 | [diff] [blame] | 719 | |
| 720 | Properties / Entry arguments: |
| 721 | - filename: Filename of file to read into entry |
| 722 | |
| 723 | This file contains code for setting up the platform on some Intel systems. |
| 724 | This is executed by U-Boot when needed early during startup. A typical |
| 725 | filename is 'refcode.bin'. |
| 726 | |
| 727 | See README.x86 for information about x86 binary blobs. |
| 728 | |
| 729 | |
| 730 | |
Simon Glass | 96d340e | 2021-03-18 20:25:16 +1300 | [diff] [blame] | 731 | Entry: intel-vbt: Intel Video BIOS Table (VBT) file |
| 732 | --------------------------------------------------- |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 733 | |
| 734 | Properties / Entry arguments: |
| 735 | - filename: Filename of file to read into entry |
| 736 | |
| 737 | This file contains code that sets up the integrated graphics subsystem on |
| 738 | some Intel SoCs. U-Boot executes this when the display is started up. |
| 739 | |
| 740 | See README.x86 for information about Intel binary blobs. |
| 741 | |
| 742 | |
| 743 | |
Simon Glass | 96d340e | 2021-03-18 20:25:16 +1300 | [diff] [blame] | 744 | Entry: intel-vga: Intel Video Graphics Adaptor (VGA) file |
| 745 | --------------------------------------------------------- |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 746 | |
| 747 | Properties / Entry arguments: |
| 748 | - filename: Filename of file to read into entry |
| 749 | |
| 750 | This file contains code that sets up the integrated graphics subsystem on |
| 751 | some Intel SoCs. U-Boot executes this when the display is started up. |
| 752 | |
| 753 | This is similar to the VBT file but in a different format. |
| 754 | |
| 755 | See README.x86 for information about Intel binary blobs. |
| 756 | |
| 757 | |
| 758 | |
Simon Glass | 96d340e | 2021-03-18 20:25:16 +1300 | [diff] [blame] | 759 | Entry: mkimage: Binary produced by mkimage |
| 760 | ------------------------------------------ |
Simon Glass | 0dc706f | 2020-07-09 18:39:31 -0600 | [diff] [blame] | 761 | |
| 762 | Properties / Entry arguments: |
| 763 | - datafile: Filename for -d argument |
| 764 | - args: Other arguments to pass |
| 765 | |
| 766 | The data passed to mkimage is collected from subnodes of the mkimage node, |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 767 | e.g.:: |
Simon Glass | 0dc706f | 2020-07-09 18:39:31 -0600 | [diff] [blame] | 768 | |
| 769 | mkimage { |
| 770 | args = "-n test -T imximage"; |
| 771 | |
| 772 | u-boot-spl { |
| 773 | }; |
| 774 | }; |
| 775 | |
| 776 | This calls mkimage to create an imximage with u-boot-spl.bin as the input |
| 777 | file. The output from mkimage then becomes part of the image produced by |
| 778 | binman. |
| 779 | |
| 780 | |
| 781 | |
Bin Meng | 4c4d607 | 2021-05-10 20:23:33 +0800 | [diff] [blame] | 782 | Entry: opensbi: RISC-V OpenSBI fw_dynamic blob |
| 783 | ---------------------------------------------- |
| 784 | |
| 785 | Properties / Entry arguments: |
| 786 | - opensbi-path: Filename of file to read into entry. This is typically |
| 787 | called fw_dynamic.bin |
| 788 | |
| 789 | This entry holds the run-time firmware, typically started by U-Boot SPL. |
| 790 | See the U-Boot README for your architecture or board for how to use it. See |
| 791 | https://github.com/riscv/opensbi for more information about OpenSBI. |
| 792 | |
| 793 | |
| 794 | |
Jagdish Gediya | 9d368f3 | 2018-09-03 21:35:08 +0530 | [diff] [blame] | 795 | Entry: powerpc-mpc85xx-bootpg-resetvec: PowerPC mpc85xx bootpg + resetvec code for U-Boot |
| 796 | ----------------------------------------------------------------------------------------- |
| 797 | |
| 798 | Properties / Entry arguments: |
| 799 | - filename: Filename of u-boot-br.bin (default 'u-boot-br.bin') |
| 800 | |
Thomas Hebb | 32f2ca2 | 2019-11-13 18:18:03 -0800 | [diff] [blame] | 801 | This entry is valid for PowerPC mpc85xx cpus. This entry holds |
Jagdish Gediya | 9d368f3 | 2018-09-03 21:35:08 +0530 | [diff] [blame] | 802 | 'bootpg + resetvec' code for PowerPC mpc85xx CPUs which needs to be |
| 803 | placed at offset 'RESET_VECTOR_ADDRESS - 0xffc'. |
| 804 | |
| 805 | |
| 806 | |
Simon Glass | 96d340e | 2021-03-18 20:25:16 +1300 | [diff] [blame] | 807 | Entry: scp: System Control Processor (SCP) firmware blob |
| 808 | -------------------------------------------------------- |
Simon Glass | f324330 | 2020-10-26 17:39:59 -0600 | [diff] [blame] | 809 | |
| 810 | Properties / Entry arguments: |
| 811 | - scp-path: Filename of file to read into the entry, typically scp.bin |
| 812 | |
| 813 | This entry holds firmware for an external platform-specific coprocessor. |
| 814 | |
| 815 | |
| 816 | |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 817 | Entry: section: Entry that contains other entries |
| 818 | ------------------------------------------------- |
| 819 | |
Simon Glass | 3f495f1 | 2021-11-23 11:03:49 -0700 | [diff] [blame] | 820 | A section is an entry which can contain other entries, thus allowing |
| 821 | hierarchical images to be created. See 'Sections and hierarchical images' |
| 822 | in the binman README for more information. |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 823 | |
Simon Glass | 3f495f1 | 2021-11-23 11:03:49 -0700 | [diff] [blame] | 824 | The base implementation simply joins the various entries together, using |
| 825 | various rules about alignment, etc. |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 826 | |
Simon Glass | 3f495f1 | 2021-11-23 11:03:49 -0700 | [diff] [blame] | 827 | Subclassing |
| 828 | ~~~~~~~~~~~ |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 829 | |
Simon Glass | 3f495f1 | 2021-11-23 11:03:49 -0700 | [diff] [blame] | 830 | This class can be subclassed to support other file formats which hold |
| 831 | multiple entries, such as CBFS. To do this, override the following |
| 832 | functions. The documentation here describes what your function should do. |
| 833 | For example code, see etypes which subclass `Entry_section`, or `cbfs.py` |
| 834 | for a more involved example:: |
Simon Glass | 3decfa3 | 2020-09-01 05:13:54 -0600 | [diff] [blame] | 835 | |
Simon Glass | 3f495f1 | 2021-11-23 11:03:49 -0700 | [diff] [blame] | 836 | $ grep -l \(Entry_section tools/binman/etype/*.py |
| 837 | |
| 838 | ReadNode() |
| 839 | Call `super().ReadNode()`, then read any special properties for the |
| 840 | section. Then call `self.ReadEntries()` to read the entries. |
| 841 | |
| 842 | Binman calls this at the start when reading the image description. |
| 843 | |
| 844 | ReadEntries() |
| 845 | Read in the subnodes of the section. This may involve creating entries |
| 846 | of a particular etype automatically, as well as reading any special |
| 847 | properties in the entries. For each entry, entry.ReadNode() should be |
| 848 | called, to read the basic entry properties. The properties should be |
| 849 | added to `self._entries[]`, in the correct order, with a suitable name. |
| 850 | |
| 851 | Binman calls this at the start when reading the image description. |
| 852 | |
| 853 | BuildSectionData(required) |
| 854 | Create the custom file format that you want and return it as bytes. |
| 855 | This likely sets up a file header, then loops through the entries, |
| 856 | adding them to the file. For each entry, call `entry.GetData()` to |
| 857 | obtain the data. If that returns None, and `required` is False, then |
| 858 | this method must give up and return None. But if `required` is True then |
| 859 | it should assume that all data is valid. |
| 860 | |
| 861 | Binman calls this when packing the image, to find out the size of |
| 862 | everything. It is called again at the end when building the final image. |
| 863 | |
| 864 | SetImagePos(image_pos): |
| 865 | Call `super().SetImagePos(image_pos)`, then set the `image_pos` values |
| 866 | for each of the entries. This should use the custom file format to find |
| 867 | the `start offset` (and `image_pos`) of each entry. If the file format |
| 868 | uses compression in such a way that there is no offset available (other |
| 869 | than reading the whole file and decompressing it), then the offsets for |
| 870 | affected entries can remain unset (`None`). The size should also be set |
| 871 | if possible. |
| 872 | |
| 873 | Binman calls this after the image has been packed, to update the |
| 874 | location that all the entries ended up at. |
| 875 | |
Simon Glass | 943bf78 | 2021-11-23 21:09:50 -0700 | [diff] [blame] | 876 | ReadChildData(child, decomp, alt_format): |
Simon Glass | 3f495f1 | 2021-11-23 11:03:49 -0700 | [diff] [blame] | 877 | The default version of this may be good enough, if you are able to |
| 878 | implement SetImagePos() correctly. But that is a bit of a bypass, so |
| 879 | you can override this method to read from your custom file format. It |
| 880 | should read the entire entry containing the custom file using |
| 881 | `super().ReadData(True)`, then parse the file to get the data for the |
| 882 | given child, then return that data. |
| 883 | |
| 884 | If your file format supports compression, the `decomp` argument tells |
| 885 | you whether to return the compressed data (`decomp` is False) or to |
| 886 | uncompress it first, then return the uncompressed data (`decomp` is |
| 887 | True). This is used by the `binman extract -U` option. |
| 888 | |
Simon Glass | 943bf78 | 2021-11-23 21:09:50 -0700 | [diff] [blame] | 889 | If your entry supports alternative formats, the alt_format provides the |
| 890 | alternative format that the user has selected. Your function should |
| 891 | return data in that format. This is used by the 'binman extract -l' |
| 892 | option. |
| 893 | |
Simon Glass | 3f495f1 | 2021-11-23 11:03:49 -0700 | [diff] [blame] | 894 | Binman calls this when reading in an image, in order to populate all the |
| 895 | entries with the data from that image (`binman ls`). |
| 896 | |
| 897 | WriteChildData(child): |
| 898 | Binman calls this after `child.data` is updated, to inform the custom |
| 899 | file format about this, in case it needs to do updates. |
| 900 | |
| 901 | The default version of this does nothing and probably needs to be |
| 902 | overridden for the 'binman replace' command to work. Your version should |
| 903 | use `child.data` to update the data for that child in the custom file |
| 904 | format. |
| 905 | |
| 906 | Binman calls this when updating an image that has been read in and in |
| 907 | particular to update the data for a particular entry (`binman replace`) |
| 908 | |
| 909 | Properties / Entry arguments |
| 910 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 911 | |
| 912 | See :ref:`develop/package/binman:Image description format` for more |
| 913 | information. |
| 914 | |
| 915 | align-default |
| 916 | Default alignment for this section, if no alignment is given in the |
| 917 | entry |
| 918 | |
| 919 | pad-byte |
| 920 | Pad byte to use when padding |
| 921 | |
| 922 | sort-by-offset |
| 923 | True if entries should be sorted by offset, False if they must be |
| 924 | in-order in the device tree description |
| 925 | |
| 926 | end-at-4gb |
| 927 | Used to build an x86 ROM which ends at 4GB (2^32) |
| 928 | |
| 929 | name-prefix |
| 930 | Adds a prefix to the name of every entry in the section when writing out |
| 931 | the map |
| 932 | |
| 933 | skip-at-start |
| 934 | Number of bytes before the first entry starts. These effectively adjust |
| 935 | the starting offset of entries. For example, if this is 16, then the |
| 936 | first entry would start at 16. An entry with offset = 20 would in fact |
| 937 | be written at offset 4 in the image file, since the first 16 bytes are |
| 938 | skipped when writing. |
Simon Glass | 1736575 | 2021-04-03 11:05:10 +1300 | [diff] [blame] | 939 | |
Simon Glass | 8beb11e | 2019-07-08 14:25:47 -0600 | [diff] [blame] | 940 | Since a section is also an entry, it inherits all the properies of entries |
| 941 | too. |
| 942 | |
Simon Glass | 3f495f1 | 2021-11-23 11:03:49 -0700 | [diff] [blame] | 943 | Note that the `allow_missing` member controls whether this section permits |
| 944 | external blobs to be missing their contents. The option will produce an |
| 945 | image but of course it will not work. It is useful to make sure that |
| 946 | Continuous Integration systems can build without the binaries being |
| 947 | available. This is set by the `SetAllowMissing()` method, if |
| 948 | `--allow-missing` is passed to binman. |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 949 | |
| 950 | |
| 951 | |
| 952 | Entry: text: An entry which contains text |
| 953 | ----------------------------------------- |
| 954 | |
| 955 | The text can be provided either in the node itself or by a command-line |
| 956 | argument. There is a level of indirection to allow multiple text strings |
| 957 | and sharing of text. |
| 958 | |
| 959 | Properties / Entry arguments: |
| 960 | text-label: The value of this string indicates the property / entry-arg |
| 961 | that contains the string to place in the entry |
| 962 | <xxx> (actual name is the value of text-label): contains the string to |
| 963 | place in the entry. |
Simon Glass | aa88b50 | 2019-07-08 13:18:40 -0600 | [diff] [blame] | 964 | <text>: The text to place in the entry (overrides the above mechanism). |
| 965 | This is useful when the text is constant. |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 966 | |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 967 | Example node:: |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 968 | |
| 969 | text { |
| 970 | size = <50>; |
| 971 | text-label = "message"; |
| 972 | }; |
| 973 | |
| 974 | You can then use: |
| 975 | |
| 976 | binman -amessage="this is my message" |
| 977 | |
| 978 | and binman will insert that string into the entry. |
| 979 | |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 980 | It is also possible to put the string directly in the node:: |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 981 | |
| 982 | text { |
| 983 | size = <8>; |
| 984 | text-label = "message"; |
| 985 | message = "a message directly in the node" |
| 986 | }; |
| 987 | |
Simon Glass | 6bc4309 | 2021-03-18 20:25:15 +1300 | [diff] [blame] | 988 | or just:: |
Simon Glass | aa88b50 | 2019-07-08 13:18:40 -0600 | [diff] [blame] | 989 | |
| 990 | text { |
| 991 | size = <8>; |
| 992 | text = "some text directly in the node" |
| 993 | }; |
| 994 | |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 995 | The text is not itself nul-terminated. This can be achieved, if required, |
| 996 | by setting the size of the entry to something larger than the text. |
| 997 | |
| 998 | |
| 999 | |
| 1000 | Entry: u-boot: U-Boot flat binary |
| 1001 | --------------------------------- |
| 1002 | |
| 1003 | Properties / Entry arguments: |
| 1004 | - filename: Filename of u-boot.bin (default 'u-boot.bin') |
| 1005 | |
| 1006 | This is the U-Boot binary, containing relocation information to allow it |
| 1007 | to relocate itself at runtime. The binary typically includes a device tree |
Simon Glass | 0668492 | 2021-03-18 20:25:07 +1300 | [diff] [blame] | 1008 | blob at the end of it. |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1009 | |
| 1010 | U-Boot can access binman symbols at runtime. See: |
| 1011 | |
| 1012 | 'Access to binman entry offsets at run time (fdt)' |
| 1013 | |
| 1014 | in the binman README for more information. |
| 1015 | |
Simon Glass | 0668492 | 2021-03-18 20:25:07 +1300 | [diff] [blame] | 1016 | Note that this entry is automatically replaced with u-boot-expanded unless |
Simon Glass | 3d43338 | 2021-03-21 18:24:30 +1300 | [diff] [blame] | 1017 | --no-expanded is used or the node has a 'no-expanded' property. |
Simon Glass | 0668492 | 2021-03-18 20:25:07 +1300 | [diff] [blame] | 1018 | |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1019 | |
| 1020 | |
| 1021 | Entry: u-boot-dtb: U-Boot device tree |
| 1022 | ------------------------------------- |
| 1023 | |
| 1024 | Properties / Entry arguments: |
| 1025 | - filename: Filename of u-boot.dtb (default 'u-boot.dtb') |
| 1026 | |
| 1027 | This is the U-Boot device tree, containing configuration information for |
| 1028 | U-Boot. U-Boot needs this to know what devices are present and which drivers |
| 1029 | to activate. |
| 1030 | |
Simon Glass | 6ed45ba | 2018-09-14 04:57:24 -0600 | [diff] [blame] | 1031 | Note: This is mostly an internal entry type, used by others. This allows |
| 1032 | binman to know which entries contain a device tree. |
| 1033 | |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1034 | |
| 1035 | |
| 1036 | Entry: u-boot-dtb-with-ucode: A U-Boot device tree file, with the microcode removed |
| 1037 | ----------------------------------------------------------------------------------- |
| 1038 | |
| 1039 | Properties / Entry arguments: |
| 1040 | - filename: Filename of u-boot.dtb (default 'u-boot.dtb') |
| 1041 | |
| 1042 | See Entry_u_boot_ucode for full details of the three entries involved in |
| 1043 | this process. This entry provides the U-Boot device-tree file, which |
| 1044 | contains the microcode. If the microcode is not being collated into one |
| 1045 | place then the offset and size of the microcode is recorded by this entry, |
Simon Glass | adc59ea | 2021-03-18 20:24:54 +1300 | [diff] [blame] | 1046 | for use by u-boot-with-ucode_ptr. If it is being collated, then this |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1047 | entry deletes the microcode from the device tree (to save space) and makes |
Simon Glass | adc59ea | 2021-03-18 20:24:54 +1300 | [diff] [blame] | 1048 | it available to u-boot-ucode. |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1049 | |
| 1050 | |
| 1051 | |
Simon Glass | fe1ae3e | 2018-09-14 04:57:35 -0600 | [diff] [blame] | 1052 | Entry: u-boot-elf: U-Boot ELF image |
| 1053 | ----------------------------------- |
| 1054 | |
| 1055 | Properties / Entry arguments: |
| 1056 | - filename: Filename of u-boot (default 'u-boot') |
| 1057 | |
| 1058 | This is the U-Boot ELF image. It does not include a device tree but can be |
| 1059 | relocated to any address for execution. |
| 1060 | |
| 1061 | |
| 1062 | |
Simon Glass | f324330 | 2020-10-26 17:39:59 -0600 | [diff] [blame] | 1063 | Entry: u-boot-env: An entry which contains a U-Boot environment |
| 1064 | --------------------------------------------------------------- |
| 1065 | |
| 1066 | Properties / Entry arguments: |
| 1067 | - filename: File containing the environment text, with each line in the |
| 1068 | form var=value |
| 1069 | |
| 1070 | |
| 1071 | |
Simon Glass | 0668492 | 2021-03-18 20:25:07 +1300 | [diff] [blame] | 1072 | Entry: u-boot-expanded: U-Boot flat binary broken out into its component parts |
| 1073 | ------------------------------------------------------------------------------ |
| 1074 | |
| 1075 | This is a section containing the U-Boot binary and a devicetree. Using this |
| 1076 | entry type automatically creates this section, with the following entries |
| 1077 | in it: |
| 1078 | |
| 1079 | u-boot-nodtb |
| 1080 | u-boot-dtb |
| 1081 | |
| 1082 | Having the devicetree separate allows binman to update it in the final |
| 1083 | image, so that the entries positions are provided to the running U-Boot. |
| 1084 | |
| 1085 | |
| 1086 | |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1087 | Entry: u-boot-img: U-Boot legacy image |
| 1088 | -------------------------------------- |
| 1089 | |
| 1090 | Properties / Entry arguments: |
| 1091 | - filename: Filename of u-boot.img (default 'u-boot.img') |
| 1092 | |
| 1093 | This is the U-Boot binary as a packaged image, in legacy format. It has a |
| 1094 | header which allows it to be loaded at the correct address for execution. |
| 1095 | |
| 1096 | You should use FIT (Flat Image Tree) instead of the legacy image for new |
| 1097 | applications. |
| 1098 | |
| 1099 | |
| 1100 | |
| 1101 | Entry: u-boot-nodtb: U-Boot flat binary without device tree appended |
| 1102 | -------------------------------------------------------------------- |
| 1103 | |
| 1104 | Properties / Entry arguments: |
Simon Glass | adc59ea | 2021-03-18 20:24:54 +1300 | [diff] [blame] | 1105 | - filename: Filename to include (default 'u-boot-nodtb.bin') |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1106 | |
| 1107 | This is the U-Boot binary, containing relocation information to allow it |
| 1108 | to relocate itself at runtime. It does not include a device tree blob at |
Simon Glass | adc59ea | 2021-03-18 20:24:54 +1300 | [diff] [blame] | 1109 | the end of it so normally cannot work without it. You can add a u-boot-dtb |
Simon Glass | 0668492 | 2021-03-18 20:25:07 +1300 | [diff] [blame] | 1110 | entry after this one, or use a u-boot entry instead, normally expands to a |
| 1111 | section containing u-boot and u-boot-dtb |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1112 | |
| 1113 | |
| 1114 | |
| 1115 | Entry: u-boot-spl: U-Boot SPL binary |
| 1116 | ------------------------------------ |
| 1117 | |
| 1118 | Properties / Entry arguments: |
| 1119 | - filename: Filename of u-boot-spl.bin (default 'spl/u-boot-spl.bin') |
| 1120 | |
| 1121 | This is the U-Boot SPL (Secondary Program Loader) binary. This is a small |
| 1122 | binary which loads before U-Boot proper, typically into on-chip SRAM. It is |
| 1123 | responsible for locating, loading and jumping to U-Boot. Note that SPL is |
| 1124 | not relocatable so must be loaded to the correct address in SRAM, or written |
Simon Glass | b8ef5b6 | 2018-07-17 13:25:48 -0600 | [diff] [blame] | 1125 | to run from the correct address if direct flash execution is possible (e.g. |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1126 | on x86 devices). |
| 1127 | |
| 1128 | SPL can access binman symbols at runtime. See: |
| 1129 | |
| 1130 | 'Access to binman entry offsets at run time (symbols)' |
| 1131 | |
| 1132 | in the binman README for more information. |
| 1133 | |
| 1134 | The ELF file 'spl/u-boot-spl' must also be available for this to work, since |
| 1135 | binman uses that to look up symbols to write into the SPL binary. |
| 1136 | |
Simon Glass | 0668492 | 2021-03-18 20:25:07 +1300 | [diff] [blame] | 1137 | Note that this entry is automatically replaced with u-boot-spl-expanded |
Simon Glass | 3d43338 | 2021-03-21 18:24:30 +1300 | [diff] [blame] | 1138 | unless --no-expanded is used or the node has a 'no-expanded' property. |
Simon Glass | 0668492 | 2021-03-18 20:25:07 +1300 | [diff] [blame] | 1139 | |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1140 | |
| 1141 | |
| 1142 | Entry: u-boot-spl-bss-pad: U-Boot SPL binary padded with a BSS region |
| 1143 | --------------------------------------------------------------------- |
| 1144 | |
| 1145 | Properties / Entry arguments: |
| 1146 | None |
| 1147 | |
Simon Glass | dccdc38 | 2021-03-18 20:24:55 +1300 | [diff] [blame] | 1148 | This holds the padding added after the SPL binary to cover the BSS (Block |
| 1149 | Started by Symbol) region. This region holds the various variables used by |
| 1150 | SPL. It is set to 0 by SPL when it starts up. If you want to append data to |
| 1151 | the SPL image (such as a device tree file), you must pad out the BSS region |
| 1152 | to avoid the data overlapping with U-Boot variables. This entry is useful in |
| 1153 | that case. It automatically pads out the entry size to cover both the code, |
| 1154 | data and BSS. |
| 1155 | |
| 1156 | The contents of this entry will a certain number of zero bytes, determined |
| 1157 | by __bss_size |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1158 | |
| 1159 | The ELF file 'spl/u-boot-spl' must also be available for this to work, since |
| 1160 | binman uses that to look up the BSS address. |
| 1161 | |
| 1162 | |
| 1163 | |
| 1164 | Entry: u-boot-spl-dtb: U-Boot SPL device tree |
| 1165 | --------------------------------------------- |
| 1166 | |
| 1167 | Properties / Entry arguments: |
| 1168 | - filename: Filename of u-boot.dtb (default 'spl/u-boot-spl.dtb') |
| 1169 | |
| 1170 | This is the SPL device tree, containing configuration information for |
| 1171 | SPL. SPL needs this to know what devices are present and which drivers |
| 1172 | to activate. |
| 1173 | |
| 1174 | |
| 1175 | |
Simon Glass | fe1ae3e | 2018-09-14 04:57:35 -0600 | [diff] [blame] | 1176 | Entry: u-boot-spl-elf: U-Boot SPL ELF image |
| 1177 | ------------------------------------------- |
| 1178 | |
| 1179 | Properties / Entry arguments: |
Simon Glass | a6a520e | 2019-07-08 13:18:45 -0600 | [diff] [blame] | 1180 | - filename: Filename of SPL u-boot (default 'spl/u-boot-spl') |
Simon Glass | fe1ae3e | 2018-09-14 04:57:35 -0600 | [diff] [blame] | 1181 | |
| 1182 | This is the U-Boot SPL ELF image. It does not include a device tree but can |
| 1183 | be relocated to any address for execution. |
| 1184 | |
| 1185 | |
| 1186 | |
Simon Glass | 0668492 | 2021-03-18 20:25:07 +1300 | [diff] [blame] | 1187 | Entry: u-boot-spl-expanded: U-Boot SPL flat binary broken out into its component parts |
| 1188 | -------------------------------------------------------------------------------------- |
| 1189 | |
| 1190 | Properties / Entry arguments: |
| 1191 | - spl-dtb: Controls whether this entry is selected (set to 'y' or '1' to |
| 1192 | select) |
| 1193 | |
| 1194 | This is a section containing the U-Boot binary, BSS padding if needed and a |
| 1195 | devicetree. Using this entry type automatically creates this section, with |
| 1196 | the following entries in it: |
| 1197 | |
| 1198 | u-boot-spl-nodtb |
| 1199 | u-boot-spl-bss-pad |
| 1200 | u-boot-dtb |
| 1201 | |
| 1202 | Having the devicetree separate allows binman to update it in the final |
| 1203 | image, so that the entries positions are provided to the running U-Boot. |
| 1204 | |
| 1205 | This entry is selected based on the value of the 'spl-dtb' entryarg. If |
| 1206 | this is non-empty (and not 'n' or '0') then this expanded entry is selected. |
| 1207 | |
| 1208 | |
| 1209 | |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1210 | Entry: u-boot-spl-nodtb: SPL binary without device tree appended |
| 1211 | ---------------------------------------------------------------- |
| 1212 | |
| 1213 | Properties / Entry arguments: |
Simon Glass | adc59ea | 2021-03-18 20:24:54 +1300 | [diff] [blame] | 1214 | - filename: Filename to include (default 'spl/u-boot-spl-nodtb.bin') |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1215 | |
| 1216 | This is the U-Boot SPL binary, It does not include a device tree blob at |
| 1217 | the end of it so may not be able to work without it, assuming SPL needs |
Simon Glass | adc59ea | 2021-03-18 20:24:54 +1300 | [diff] [blame] | 1218 | a device tree to operate on your platform. You can add a u-boot-spl-dtb |
Simon Glass | 0668492 | 2021-03-18 20:25:07 +1300 | [diff] [blame] | 1219 | entry after this one, or use a u-boot-spl entry instead' which normally |
| 1220 | expands to a section containing u-boot-spl-dtb, u-boot-spl-bss-pad and |
| 1221 | u-boot-spl-dtb |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1222 | |
Simon Glass | f589882 | 2021-03-18 20:24:56 +1300 | [diff] [blame] | 1223 | SPL can access binman symbols at runtime. See: |
| 1224 | |
| 1225 | 'Access to binman entry offsets at run time (symbols)' |
| 1226 | |
| 1227 | in the binman README for more information. |
| 1228 | |
| 1229 | The ELF file 'spl/u-boot-spl' must also be available for this to work, since |
| 1230 | binman uses that to look up symbols to write into the SPL binary. |
| 1231 | |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1232 | |
| 1233 | |
| 1234 | Entry: u-boot-spl-with-ucode-ptr: U-Boot SPL with embedded microcode pointer |
| 1235 | ---------------------------------------------------------------------------- |
| 1236 | |
Simon Glass | f025363 | 2018-09-14 04:57:32 -0600 | [diff] [blame] | 1237 | This is used when SPL must set up the microcode for U-Boot. |
| 1238 | |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1239 | See Entry_u_boot_ucode for full details of the entries involved in this |
| 1240 | process. |
| 1241 | |
| 1242 | |
| 1243 | |
Simon Glass | b8ef5b6 | 2018-07-17 13:25:48 -0600 | [diff] [blame] | 1244 | Entry: u-boot-tpl: U-Boot TPL binary |
| 1245 | ------------------------------------ |
| 1246 | |
| 1247 | Properties / Entry arguments: |
| 1248 | - filename: Filename of u-boot-tpl.bin (default 'tpl/u-boot-tpl.bin') |
| 1249 | |
| 1250 | This is the U-Boot TPL (Tertiary Program Loader) binary. This is a small |
| 1251 | binary which loads before SPL, typically into on-chip SRAM. It is |
| 1252 | responsible for locating, loading and jumping to SPL, the next-stage |
| 1253 | loader. Note that SPL is not relocatable so must be loaded to the correct |
| 1254 | address in SRAM, or written to run from the correct address if direct |
| 1255 | flash execution is possible (e.g. on x86 devices). |
| 1256 | |
| 1257 | SPL can access binman symbols at runtime. See: |
| 1258 | |
| 1259 | 'Access to binman entry offsets at run time (symbols)' |
| 1260 | |
| 1261 | in the binman README for more information. |
| 1262 | |
| 1263 | The ELF file 'tpl/u-boot-tpl' must also be available for this to work, since |
| 1264 | binman uses that to look up symbols to write into the TPL binary. |
| 1265 | |
Simon Glass | 0668492 | 2021-03-18 20:25:07 +1300 | [diff] [blame] | 1266 | Note that this entry is automatically replaced with u-boot-tpl-expanded |
Simon Glass | 3d43338 | 2021-03-21 18:24:30 +1300 | [diff] [blame] | 1267 | unless --no-expanded is used or the node has a 'no-expanded' property. |
Simon Glass | 0668492 | 2021-03-18 20:25:07 +1300 | [diff] [blame] | 1268 | |
Simon Glass | b8ef5b6 | 2018-07-17 13:25:48 -0600 | [diff] [blame] | 1269 | |
| 1270 | |
Simon Glass | d26efc8 | 2021-03-18 20:24:58 +1300 | [diff] [blame] | 1271 | Entry: u-boot-tpl-bss-pad: U-Boot TPL binary padded with a BSS region |
| 1272 | --------------------------------------------------------------------- |
| 1273 | |
| 1274 | Properties / Entry arguments: |
| 1275 | None |
| 1276 | |
| 1277 | This holds the padding added after the TPL binary to cover the BSS (Block |
| 1278 | Started by Symbol) region. This region holds the various variables used by |
| 1279 | TPL. It is set to 0 by TPL when it starts up. If you want to append data to |
| 1280 | the TPL image (such as a device tree file), you must pad out the BSS region |
| 1281 | to avoid the data overlapping with U-Boot variables. This entry is useful in |
| 1282 | that case. It automatically pads out the entry size to cover both the code, |
| 1283 | data and BSS. |
| 1284 | |
| 1285 | The contents of this entry will a certain number of zero bytes, determined |
| 1286 | by __bss_size |
| 1287 | |
| 1288 | The ELF file 'tpl/u-boot-tpl' must also be available for this to work, since |
| 1289 | binman uses that to look up the BSS address. |
| 1290 | |
| 1291 | |
| 1292 | |
Simon Glass | b8ef5b6 | 2018-07-17 13:25:48 -0600 | [diff] [blame] | 1293 | Entry: u-boot-tpl-dtb: U-Boot TPL device tree |
| 1294 | --------------------------------------------- |
| 1295 | |
| 1296 | Properties / Entry arguments: |
| 1297 | - filename: Filename of u-boot.dtb (default 'tpl/u-boot-tpl.dtb') |
| 1298 | |
| 1299 | This is the TPL device tree, containing configuration information for |
| 1300 | TPL. TPL needs this to know what devices are present and which drivers |
| 1301 | to activate. |
| 1302 | |
| 1303 | |
| 1304 | |
Simon Glass | f025363 | 2018-09-14 04:57:32 -0600 | [diff] [blame] | 1305 | Entry: u-boot-tpl-dtb-with-ucode: U-Boot TPL with embedded microcode pointer |
| 1306 | ---------------------------------------------------------------------------- |
| 1307 | |
| 1308 | This is used when TPL must set up the microcode for U-Boot. |
| 1309 | |
| 1310 | See Entry_u_boot_ucode for full details of the entries involved in this |
| 1311 | process. |
| 1312 | |
| 1313 | |
| 1314 | |
Simon Glass | 4c65025 | 2019-07-08 13:18:46 -0600 | [diff] [blame] | 1315 | Entry: u-boot-tpl-elf: U-Boot TPL ELF image |
| 1316 | ------------------------------------------- |
| 1317 | |
| 1318 | Properties / Entry arguments: |
| 1319 | - filename: Filename of TPL u-boot (default 'tpl/u-boot-tpl') |
| 1320 | |
| 1321 | This is the U-Boot TPL ELF image. It does not include a device tree but can |
| 1322 | be relocated to any address for execution. |
| 1323 | |
| 1324 | |
| 1325 | |
Simon Glass | 0668492 | 2021-03-18 20:25:07 +1300 | [diff] [blame] | 1326 | Entry: u-boot-tpl-expanded: U-Boot TPL flat binary broken out into its component parts |
| 1327 | -------------------------------------------------------------------------------------- |
| 1328 | |
| 1329 | Properties / Entry arguments: |
| 1330 | - tpl-dtb: Controls whether this entry is selected (set to 'y' or '1' to |
| 1331 | select) |
| 1332 | |
| 1333 | This is a section containing the U-Boot binary, BSS padding if needed and a |
| 1334 | devicetree. Using this entry type automatically creates this section, with |
| 1335 | the following entries in it: |
| 1336 | |
| 1337 | u-boot-tpl-nodtb |
| 1338 | u-boot-tpl-bss-pad |
| 1339 | u-boot-dtb |
| 1340 | |
| 1341 | Having the devicetree separate allows binman to update it in the final |
| 1342 | image, so that the entries positions are provided to the running U-Boot. |
| 1343 | |
| 1344 | This entry is selected based on the value of the 'tpl-dtb' entryarg. If |
| 1345 | this is non-empty (and not 'n' or '0') then this expanded entry is selected. |
| 1346 | |
| 1347 | |
| 1348 | |
Simon Glass | 77a64e0 | 2021-03-18 20:24:57 +1300 | [diff] [blame] | 1349 | Entry: u-boot-tpl-nodtb: TPL binary without device tree appended |
| 1350 | ---------------------------------------------------------------- |
| 1351 | |
| 1352 | Properties / Entry arguments: |
| 1353 | - filename: Filename to include (default 'tpl/u-boot-tpl-nodtb.bin') |
| 1354 | |
| 1355 | This is the U-Boot TPL binary, It does not include a device tree blob at |
| 1356 | the end of it so may not be able to work without it, assuming TPL needs |
| 1357 | a device tree to operate on your platform. You can add a u-boot-tpl-dtb |
Simon Glass | 0668492 | 2021-03-18 20:25:07 +1300 | [diff] [blame] | 1358 | entry after this one, or use a u-boot-tpl entry instead, which normally |
| 1359 | expands to a section containing u-boot-tpl-dtb, u-boot-tpl-bss-pad and |
| 1360 | u-boot-tpl-dtb |
Simon Glass | 77a64e0 | 2021-03-18 20:24:57 +1300 | [diff] [blame] | 1361 | |
| 1362 | TPL can access binman symbols at runtime. See: |
| 1363 | |
| 1364 | 'Access to binman entry offsets at run time (symbols)' |
| 1365 | |
| 1366 | in the binman README for more information. |
| 1367 | |
| 1368 | The ELF file 'tpl/u-boot-tpl' must also be available for this to work, since |
| 1369 | binman uses that to look up symbols to write into the TPL binary. |
| 1370 | |
| 1371 | |
| 1372 | |
Simon Glass | f025363 | 2018-09-14 04:57:32 -0600 | [diff] [blame] | 1373 | Entry: u-boot-tpl-with-ucode-ptr: U-Boot TPL with embedded microcode pointer |
| 1374 | ---------------------------------------------------------------------------- |
| 1375 | |
| 1376 | See Entry_u_boot_ucode for full details of the entries involved in this |
| 1377 | process. |
| 1378 | |
| 1379 | |
| 1380 | |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1381 | Entry: u-boot-ucode: U-Boot microcode block |
| 1382 | ------------------------------------------- |
| 1383 | |
| 1384 | Properties / Entry arguments: |
| 1385 | None |
| 1386 | |
| 1387 | The contents of this entry are filled in automatically by other entries |
| 1388 | which must also be in the image. |
| 1389 | |
| 1390 | U-Boot on x86 needs a single block of microcode. This is collected from |
| 1391 | the various microcode update nodes in the device tree. It is also unable |
| 1392 | to read the microcode from the device tree on platforms that use FSP |
| 1393 | (Firmware Support Package) binaries, because the API requires that the |
| 1394 | microcode is supplied before there is any SRAM available to use (i.e. |
| 1395 | the FSP sets up the SRAM / cache-as-RAM but does so in the call that |
| 1396 | requires the microcode!). To keep things simple, all x86 platforms handle |
| 1397 | microcode the same way in U-Boot (even non-FSP platforms). This is that |
| 1398 | a table is placed at _dt_ucode_base_size containing the base address and |
| 1399 | size of the microcode. This is either passed to the FSP (for FSP |
| 1400 | platforms), or used to set up the microcode (for non-FSP platforms). |
| 1401 | This all happens in the build system since it is the only way to get |
| 1402 | the microcode into a single blob and accessible without SRAM. |
| 1403 | |
| 1404 | There are two cases to handle. If there is only one microcode blob in |
| 1405 | the device tree, then the ucode pointer it set to point to that. This |
| 1406 | entry (u-boot-ucode) is empty. If there is more than one update, then |
| 1407 | this entry holds the concatenation of all updates, and the device tree |
| 1408 | entry (u-boot-dtb-with-ucode) is updated to remove the microcode. This |
| 1409 | last step ensures that that the microcode appears in one contiguous |
| 1410 | block in the image and is not unnecessarily duplicated in the device |
| 1411 | tree. It is referred to as 'collation' here. |
| 1412 | |
| 1413 | Entry types that have a part to play in handling microcode: |
| 1414 | |
| 1415 | Entry_u_boot_with_ucode_ptr: |
| 1416 | Contains u-boot-nodtb.bin (i.e. U-Boot without the device tree). |
| 1417 | It updates it with the address and size of the microcode so that |
| 1418 | U-Boot can find it early on start-up. |
| 1419 | Entry_u_boot_dtb_with_ucode: |
| 1420 | Contains u-boot.dtb. It stores the microcode in a |
| 1421 | 'self.ucode_data' property, which is then read by this class to |
| 1422 | obtain the microcode if needed. If collation is performed, it |
| 1423 | removes the microcode from the device tree. |
| 1424 | Entry_u_boot_ucode: |
| 1425 | This class. If collation is enabled it reads the microcode from |
| 1426 | the Entry_u_boot_dtb_with_ucode entry, and uses it as the |
| 1427 | contents of this entry. |
| 1428 | |
| 1429 | |
| 1430 | |
| 1431 | Entry: u-boot-with-ucode-ptr: U-Boot with embedded microcode pointer |
| 1432 | -------------------------------------------------------------------- |
| 1433 | |
| 1434 | Properties / Entry arguments: |
Masahiro Yamada | f6a8c0f | 2019-12-14 13:47:26 +0900 | [diff] [blame] | 1435 | - filename: Filename of u-boot-nodtb.bin (default 'u-boot-nodtb.bin') |
Simon Glass | f069303 | 2018-09-14 04:57:07 -0600 | [diff] [blame] | 1436 | - optional-ucode: boolean property to make microcode optional. If the |
| 1437 | u-boot.bin image does not include microcode, no error will |
| 1438 | be generated. |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1439 | |
| 1440 | See Entry_u_boot_ucode for full details of the three entries involved in |
| 1441 | this process. This entry updates U-Boot with the offset and size of the |
| 1442 | microcode, to allow early x86 boot code to find it without doing anything |
Simon Glass | adc59ea | 2021-03-18 20:24:54 +1300 | [diff] [blame] | 1443 | complicated. Otherwise it is the same as the u-boot entry. |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1444 | |
| 1445 | |
| 1446 | |
Simon Glass | 24d0d3c | 2018-07-17 13:25:47 -0600 | [diff] [blame] | 1447 | Entry: vblock: An entry which contains a Chromium OS verified boot block |
| 1448 | ------------------------------------------------------------------------ |
| 1449 | |
| 1450 | Properties / Entry arguments: |
Simon Glass | 5385f5a | 2019-05-17 22:00:53 -0600 | [diff] [blame] | 1451 | - content: List of phandles to entries to sign |
Simon Glass | 24d0d3c | 2018-07-17 13:25:47 -0600 | [diff] [blame] | 1452 | - keydir: Directory containing the public keys to use |
| 1453 | - keyblock: Name of the key file to use (inside keydir) |
| 1454 | - signprivate: Name of provide key file to use (inside keydir) |
| 1455 | - version: Version number of the vblock (typically 1) |
| 1456 | - kernelkey: Name of the kernel key to use (inside keydir) |
| 1457 | - preamble-flags: Value of the vboot preamble flags (typically 0) |
| 1458 | |
Simon Glass | a326b49 | 2018-09-14 04:57:11 -0600 | [diff] [blame] | 1459 | Output files: |
| 1460 | - input.<unique_name> - input file passed to futility |
| 1461 | - vblock.<unique_name> - output file generated by futility (which is |
| 1462 | used as the entry contents) |
| 1463 | |
Jagdish Gediya | 9d368f3 | 2018-09-03 21:35:08 +0530 | [diff] [blame] | 1464 | Chromium OS signs the read-write firmware and kernel, writing the signature |
Simon Glass | 24d0d3c | 2018-07-17 13:25:47 -0600 | [diff] [blame] | 1465 | in this block. This allows U-Boot to verify that the next firmware stage |
| 1466 | and kernel are genuine. |
| 1467 | |
| 1468 | |
| 1469 | |
Simon Glass | 2250ee6 | 2019-08-24 07:22:48 -0600 | [diff] [blame] | 1470 | Entry: x86-reset16: x86 16-bit reset code for U-Boot |
| 1471 | ---------------------------------------------------- |
| 1472 | |
| 1473 | Properties / Entry arguments: |
| 1474 | - filename: Filename of u-boot-x86-reset16.bin (default |
| 1475 | 'u-boot-x86-reset16.bin') |
| 1476 | |
| 1477 | x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code |
| 1478 | must be placed at a particular address. This entry holds that code. It is |
| 1479 | typically placed at offset CONFIG_RESET_VEC_LOC. The code is responsible |
| 1480 | for jumping to the x86-start16 code, which continues execution. |
| 1481 | |
| 1482 | For 64-bit U-Boot, the 'x86_reset16_spl' entry type is used instead. |
| 1483 | |
| 1484 | |
| 1485 | |
| 1486 | Entry: x86-reset16-spl: x86 16-bit reset code for U-Boot |
| 1487 | -------------------------------------------------------- |
| 1488 | |
| 1489 | Properties / Entry arguments: |
| 1490 | - filename: Filename of u-boot-x86-reset16.bin (default |
| 1491 | 'u-boot-x86-reset16.bin') |
| 1492 | |
| 1493 | x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code |
| 1494 | must be placed at a particular address. This entry holds that code. It is |
| 1495 | typically placed at offset CONFIG_RESET_VEC_LOC. The code is responsible |
| 1496 | for jumping to the x86-start16 code, which continues execution. |
| 1497 | |
| 1498 | For 32-bit U-Boot, the 'x86_reset_spl' entry type is used instead. |
| 1499 | |
| 1500 | |
| 1501 | |
| 1502 | Entry: x86-reset16-tpl: x86 16-bit reset code for U-Boot |
| 1503 | -------------------------------------------------------- |
| 1504 | |
| 1505 | Properties / Entry arguments: |
| 1506 | - filename: Filename of u-boot-x86-reset16.bin (default |
| 1507 | 'u-boot-x86-reset16.bin') |
| 1508 | |
| 1509 | x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code |
| 1510 | must be placed at a particular address. This entry holds that code. It is |
| 1511 | typically placed at offset CONFIG_RESET_VEC_LOC. The code is responsible |
| 1512 | for jumping to the x86-start16 code, which continues execution. |
| 1513 | |
| 1514 | For 32-bit U-Boot, the 'x86_reset_tpl' entry type is used instead. |
| 1515 | |
| 1516 | |
| 1517 | |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1518 | Entry: x86-start16: x86 16-bit start-up code for U-Boot |
| 1519 | ------------------------------------------------------- |
| 1520 | |
| 1521 | Properties / Entry arguments: |
Simon Glass | 5e23918 | 2019-08-24 07:22:49 -0600 | [diff] [blame] | 1522 | - filename: Filename of u-boot-x86-start16.bin (default |
| 1523 | 'u-boot-x86-start16.bin') |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1524 | |
| 1525 | x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code |
Simon Glass | 5e23918 | 2019-08-24 07:22:49 -0600 | [diff] [blame] | 1526 | must be placed in the top 64KB of the ROM. The reset code jumps to it. This |
| 1527 | entry holds that code. It is typically placed at offset |
| 1528 | CONFIG_SYS_X86_START16. The code is responsible for changing to 32-bit mode |
| 1529 | and jumping to U-Boot's entry point, which requires 32-bit mode (for 32-bit |
| 1530 | U-Boot). |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1531 | |
| 1532 | For 64-bit U-Boot, the 'x86_start16_spl' entry type is used instead. |
| 1533 | |
| 1534 | |
| 1535 | |
| 1536 | Entry: x86-start16-spl: x86 16-bit start-up code for SPL |
| 1537 | -------------------------------------------------------- |
| 1538 | |
| 1539 | Properties / Entry arguments: |
Simon Glass | 5e23918 | 2019-08-24 07:22:49 -0600 | [diff] [blame] | 1540 | - filename: Filename of spl/u-boot-x86-start16-spl.bin (default |
| 1541 | 'spl/u-boot-x86-start16-spl.bin') |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1542 | |
Simon Glass | 5e23918 | 2019-08-24 07:22:49 -0600 | [diff] [blame] | 1543 | x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code |
| 1544 | must be placed in the top 64KB of the ROM. The reset code jumps to it. This |
| 1545 | entry holds that code. It is typically placed at offset |
| 1546 | CONFIG_SYS_X86_START16. The code is responsible for changing to 32-bit mode |
| 1547 | and jumping to U-Boot's entry point, which requires 32-bit mode (for 32-bit |
| 1548 | U-Boot). |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1549 | |
Simon Glass | 5e23918 | 2019-08-24 07:22:49 -0600 | [diff] [blame] | 1550 | For 32-bit U-Boot, the 'x86-start16' entry type is used instead. |
Simon Glass | 5a5da7c | 2018-07-17 13:25:37 -0600 | [diff] [blame] | 1551 | |
| 1552 | |
| 1553 | |
Simon Glass | 35b384c | 2018-09-14 04:57:10 -0600 | [diff] [blame] | 1554 | Entry: x86-start16-tpl: x86 16-bit start-up code for TPL |
| 1555 | -------------------------------------------------------- |
| 1556 | |
| 1557 | Properties / Entry arguments: |
Simon Glass | 5e23918 | 2019-08-24 07:22:49 -0600 | [diff] [blame] | 1558 | - filename: Filename of tpl/u-boot-x86-start16-tpl.bin (default |
| 1559 | 'tpl/u-boot-x86-start16-tpl.bin') |
Simon Glass | 35b384c | 2018-09-14 04:57:10 -0600 | [diff] [blame] | 1560 | |
Simon Glass | 5e23918 | 2019-08-24 07:22:49 -0600 | [diff] [blame] | 1561 | x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code |
| 1562 | must be placed in the top 64KB of the ROM. The reset code jumps to it. This |
| 1563 | entry holds that code. It is typically placed at offset |
| 1564 | CONFIG_SYS_X86_START16. The code is responsible for changing to 32-bit mode |
| 1565 | and jumping to U-Boot's entry point, which requires 32-bit mode (for 32-bit |
| 1566 | U-Boot). |
Simon Glass | 35b384c | 2018-09-14 04:57:10 -0600 | [diff] [blame] | 1567 | |
Simon Glass | 5e23918 | 2019-08-24 07:22:49 -0600 | [diff] [blame] | 1568 | If TPL is not being used, the 'x86-start16-spl or 'x86-start16' entry types |
Simon Glass | 35b384c | 2018-09-14 04:57:10 -0600 | [diff] [blame] | 1569 | may be used instead. |
| 1570 | |
| 1571 | |
| 1572 | |