entries.rst 50 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458
  1. Binman Entry Documentation
  2. ===========================
  3. This file describes the entry types supported by binman. These entry types can
  4. be placed in an image one by one to build up a final firmware image. It is
  5. fairly easy to create new entry types. Just add a new file to the 'etype'
  6. directory. You can use the existing entries as examples.
  7. Note that some entries are subclasses of others, using and extending their
  8. features to produce new behaviours.
  9. Entry: atf-bl31: ARM Trusted Firmware (ATF) BL31 blob
  10. -----------------------------------------------------
  11. Properties / Entry arguments:
  12. - atf-bl31-path: Filename of file to read into entry. This is typically
  13. called bl31.bin or bl31.elf
  14. This entry holds the run-time firmware, typically started by U-Boot SPL.
  15. See the U-Boot README for your architecture or board for how to use it. See
  16. https://github.com/ARM-software/arm-trusted-firmware for more information
  17. about ATF.
  18. Entry: blob: Arbitrary binary blob
  19. ----------------------------------
  20. Note: This should not be used by itself. It is normally used as a parent
  21. class by other entry types.
  22. Properties / Entry arguments:
  23. - filename: Filename of file to read into entry
  24. - compress: Compression algorithm to use:
  25. none: No compression
  26. lz4: Use lz4 compression (via 'lz4' command-line utility)
  27. This entry reads data from a file and places it in the entry. The
  28. default filename is often specified specified by the subclass. See for
  29. example the 'u-boot' entry which provides the filename 'u-boot.bin'.
  30. If compression is enabled, an extra 'uncomp-size' property is written to
  31. the node (if enabled with -u) which provides the uncompressed size of the
  32. data.
  33. Entry: blob-dtb: A blob that holds a device tree
  34. ------------------------------------------------
  35. This is a blob containing a device tree. The contents of the blob are
  36. obtained from the list of available device-tree files, managed by the
  37. 'state' module.
  38. Entry: blob-ext: Externally built binary blob
  39. ---------------------------------------------
  40. Note: This should not be used by itself. It is normally used as a parent
  41. class by other entry types.
  42. If the file providing this blob is missing, binman can optionally ignore it
  43. and produce a broken image with a warning.
  44. See 'blob' for Properties / Entry arguments.
  45. Entry: blob-named-by-arg: A blob entry which gets its filename property from its subclass
  46. -----------------------------------------------------------------------------------------
  47. Properties / Entry arguments:
  48. - <xxx>-path: Filename containing the contents of this entry (optional,
  49. defaults to None)
  50. where <xxx> is the blob_fname argument to the constructor.
  51. This entry cannot be used directly. Instead, it is used as a parent class
  52. for another entry, which defined blob_fname. This parameter is used to
  53. set the entry-arg or property containing the filename. The entry-arg or
  54. property is in turn used to set the actual filename.
  55. See cros_ec_rw for an example of this.
  56. Entry: blob-phase: Section that holds a phase binary
  57. ----------------------------------------------------
  58. This is a base class that should not normally be used directly. It is used
  59. when converting a 'u-boot' entry automatically into a 'u-boot-expanded'
  60. entry; similarly for SPL.
  61. Entry: cbfs: Coreboot Filesystem (CBFS)
  62. ---------------------------------------
  63. A CBFS provides a way to group files into a group. It has a simple directory
  64. structure and allows the position of individual files to be set, since it is
  65. designed to support execute-in-place in an x86 SPI-flash device. Where XIP
  66. is not used, it supports compression and storing ELF files.
  67. CBFS is used by coreboot as its way of orgnanising SPI-flash contents.
  68. The contents of the CBFS are defined by subnodes of the cbfs entry, e.g.::
  69. cbfs {
  70. size = <0x100000>;
  71. u-boot {
  72. cbfs-type = "raw";
  73. };
  74. u-boot-dtb {
  75. cbfs-type = "raw";
  76. };
  77. };
  78. This creates a CBFS 1MB in size two files in it: u-boot.bin and u-boot.dtb.
  79. Note that the size is required since binman does not support calculating it.
  80. The contents of each entry is just what binman would normally provide if it
  81. were not a CBFS node. A blob type can be used to import arbitrary files as
  82. with the second subnode below::
  83. cbfs {
  84. size = <0x100000>;
  85. u-boot {
  86. cbfs-name = "BOOT";
  87. cbfs-type = "raw";
  88. };
  89. dtb {
  90. type = "blob";
  91. filename = "u-boot.dtb";
  92. cbfs-type = "raw";
  93. cbfs-compress = "lz4";
  94. cbfs-offset = <0x100000>;
  95. };
  96. };
  97. This creates a CBFS 1MB in size with u-boot.bin (named "BOOT") and
  98. u-boot.dtb (named "dtb") and compressed with the lz4 algorithm.
  99. Properties supported in the top-level CBFS node:
  100. cbfs-arch:
  101. Defaults to "x86", but you can specify the architecture if needed.
  102. Properties supported in the CBFS entry subnodes:
  103. cbfs-name:
  104. This is the name of the file created in CBFS. It defaults to the entry
  105. name (which is the node name), but you can override it with this
  106. property.
  107. cbfs-type:
  108. This is the CBFS file type. The following are supported:
  109. raw:
  110. This is a 'raw' file, although compression is supported. It can be
  111. used to store any file in CBFS.
  112. stage:
  113. This is an ELF file that has been loaded (i.e. mapped to memory), so
  114. appears in the CBFS as a flat binary. The input file must be an ELF
  115. image, for example this puts "u-boot" (the ELF image) into a 'stage'
  116. entry::
  117. cbfs {
  118. size = <0x100000>;
  119. u-boot-elf {
  120. cbfs-name = "BOOT";
  121. cbfs-type = "stage";
  122. };
  123. };
  124. You can use your own ELF file with something like::
  125. cbfs {
  126. size = <0x100000>;
  127. something {
  128. type = "blob";
  129. filename = "cbfs-stage.elf";
  130. cbfs-type = "stage";
  131. };
  132. };
  133. As mentioned, the file is converted to a flat binary, so it is
  134. equivalent to adding "u-boot.bin", for example, but with the load and
  135. start addresses specified by the ELF. At present there is no option
  136. to add a flat binary with a load/start address, similar to the
  137. 'add-flat-binary' option in cbfstool.
  138. cbfs-offset:
  139. This is the offset of the file's data within the CBFS. It is used to
  140. specify where the file should be placed in cases where a fixed position
  141. is needed. Typical uses are for code which is not relocatable and must
  142. execute in-place from a particular address. This works because SPI flash
  143. is generally mapped into memory on x86 devices. The file header is
  144. placed before this offset so that the data start lines up exactly with
  145. the chosen offset. If this property is not provided, then the file is
  146. placed in the next available spot.
  147. The current implementation supports only a subset of CBFS features. It does
  148. not support other file types (e.g. payload), adding multiple files (like the
  149. 'files' entry with a pattern supported by binman), putting files at a
  150. particular offset in the CBFS and a few other things.
  151. Of course binman can create images containing multiple CBFSs, simply by
  152. defining these in the binman config::
  153. binman {
  154. size = <0x800000>;
  155. cbfs {
  156. offset = <0x100000>;
  157. size = <0x100000>;
  158. u-boot {
  159. cbfs-type = "raw";
  160. };
  161. u-boot-dtb {
  162. cbfs-type = "raw";
  163. };
  164. };
  165. cbfs2 {
  166. offset = <0x700000>;
  167. size = <0x100000>;
  168. u-boot {
  169. cbfs-type = "raw";
  170. };
  171. u-boot-dtb {
  172. cbfs-type = "raw";
  173. };
  174. image {
  175. type = "blob";
  176. filename = "image.jpg";
  177. };
  178. };
  179. };
  180. This creates an 8MB image with two CBFSs, one at offset 1MB, one at 7MB,
  181. both of size 1MB.
  182. Entry: collection: An entry which contains a collection of other entries
  183. ------------------------------------------------------------------------
  184. Properties / Entry arguments:
  185. - content: List of phandles to entries to include
  186. This allows reusing the contents of other entries. The contents of the
  187. listed entries are combined to form this entry. This serves as a useful
  188. base class for entry types which need to process data from elsewhere in
  189. the image, not necessarily child entries.
  190. Entry: cros-ec-rw: A blob entry which contains a Chromium OS read-write EC image
  191. --------------------------------------------------------------------------------
  192. Properties / Entry arguments:
  193. - cros-ec-rw-path: Filename containing the EC image
  194. This entry holds a Chromium OS EC (embedded controller) image, for use in
  195. updating the EC on startup via software sync.
  196. Entry: fdtmap: An entry which contains an FDT map
  197. -------------------------------------------------
  198. Properties / Entry arguments:
  199. None
  200. An FDT map is just a header followed by an FDT containing a list of all the
  201. entries in the image. The root node corresponds to the image node in the
  202. original FDT, and an image-name property indicates the image name in that
  203. original tree.
  204. The header is the string _FDTMAP_ followed by 8 unused bytes.
  205. When used, this entry will be populated with an FDT map which reflects the
  206. entries in the current image. Hierarchy is preserved, and all offsets and
  207. sizes are included.
  208. Note that the -u option must be provided to ensure that binman updates the
  209. FDT with the position of each entry.
  210. Example output for a simple image with U-Boot and an FDT map::
  211. / {
  212. image-name = "binman";
  213. size = <0x00000112>;
  214. image-pos = <0x00000000>;
  215. offset = <0x00000000>;
  216. u-boot {
  217. size = <0x00000004>;
  218. image-pos = <0x00000000>;
  219. offset = <0x00000000>;
  220. };
  221. fdtmap {
  222. size = <0x0000010e>;
  223. image-pos = <0x00000004>;
  224. offset = <0x00000004>;
  225. };
  226. };
  227. If allow-repack is used then 'orig-offset' and 'orig-size' properties are
  228. added as necessary. See the binman README.
  229. Entry: files: A set of files arranged in a section
  230. --------------------------------------------------
  231. Properties / Entry arguments:
  232. - pattern: Filename pattern to match the files to include
  233. - files-compress: Compression algorithm to use:
  234. none: No compression
  235. lz4: Use lz4 compression (via 'lz4' command-line utility)
  236. - files-align: Align each file to the given alignment
  237. This entry reads a number of files and places each in a separate sub-entry
  238. within this entry. To access these you need to enable device-tree updates
  239. at run-time so you can obtain the file positions.
  240. Entry: fill: An entry which is filled to a particular byte value
  241. ----------------------------------------------------------------
  242. Properties / Entry arguments:
  243. - fill-byte: Byte to use to fill the entry
  244. Note that the size property must be set since otherwise this entry does not
  245. know how large it should be.
  246. You can often achieve the same effect using the pad-byte property of the
  247. overall image, in that the space between entries will then be padded with
  248. that byte. But this entry is sometimes useful for explicitly setting the
  249. byte value of a region.
  250. Entry: fit: Flat Image Tree (FIT)
  251. ---------------------------------
  252. This calls mkimage to create a FIT (U-Boot Flat Image Tree) based on the
  253. input provided.
  254. Nodes for the FIT should be written out in the binman configuration just as
  255. they would be in a file passed to mkimage.
  256. For example, this creates an image containing a FIT with U-Boot SPL::
  257. binman {
  258. fit {
  259. description = "Test FIT";
  260. fit,fdt-list = "of-list";
  261. images {
  262. kernel@1 {
  263. description = "SPL";
  264. os = "u-boot";
  265. type = "rkspi";
  266. arch = "arm";
  267. compression = "none";
  268. load = <0>;
  269. entry = <0>;
  270. u-boot-spl {
  271. };
  272. };
  273. };
  274. };
  275. };
  276. U-Boot supports creating fdt and config nodes automatically. To do this,
  277. pass an of-list property (e.g. -a of-list=file1 file2). This tells binman
  278. that you want to generates nodes for two files: file1.dtb and file2.dtb
  279. The fit,fdt-list property (see above) indicates that of-list should be used.
  280. If the property is missing you will get an error.
  281. Then add a 'generator node', a node with a name starting with '@'::
  282. images {
  283. @fdt-SEQ {
  284. description = "fdt-NAME";
  285. type = "flat_dt";
  286. compression = "none";
  287. };
  288. };
  289. This tells binman to create nodes fdt-1 and fdt-2 for each of your two
  290. files. All the properties you specify will be included in the node. This
  291. node acts like a template to generate the nodes. The generator node itself
  292. does not appear in the output - it is replaced with what binman generates.
  293. You can create config nodes in a similar way::
  294. configurations {
  295. default = "@config-DEFAULT-SEQ";
  296. @config-SEQ {
  297. description = "NAME";
  298. firmware = "atf";
  299. loadables = "uboot";
  300. fdt = "fdt-SEQ";
  301. };
  302. };
  303. This tells binman to create nodes config-1 and config-2, i.e. a config for
  304. each of your two files.
  305. Available substitutions for '@' nodes are:
  306. SEQ:
  307. Sequence number of the generated fdt (1, 2, ...)
  308. NAME
  309. Name of the dtb as provided (i.e. without adding '.dtb')
  310. Note that if no devicetree files are provided (with '-a of-list' as above)
  311. then no nodes will be generated.
  312. The 'default' property, if present, will be automatically set to the name
  313. if of configuration whose devicetree matches the 'default-dt' entry
  314. argument, e.g. with '-a default-dt=sun50i-a64-pine64-lts'.
  315. Available substitutions for '@' property values are
  316. DEFAULT-SEQ:
  317. Sequence number of the default fdt,as provided by the 'default-dt' entry
  318. argument
  319. Properties (in the 'fit' node itself):
  320. fit,external-offset: Indicates that the contents of the FIT are external
  321. and provides the external offset. This is passsed to mkimage via
  322. the -E and -p flags.
  323. Entry: fmap: An entry which contains an Fmap section
  324. ----------------------------------------------------
  325. Properties / Entry arguments:
  326. None
  327. FMAP is a simple format used by flashrom, an open-source utility for
  328. reading and writing the SPI flash, typically on x86 CPUs. The format
  329. provides flashrom with a list of areas, so it knows what it in the flash.
  330. It can then read or write just a single area, instead of the whole flash.
  331. The format is defined by the flashrom project, in the file lib/fmap.h -
  332. see www.flashrom.org/Flashrom for more information.
  333. When used, this entry will be populated with an FMAP which reflects the
  334. entries in the current image. Note that any hierarchy is squashed, since
  335. FMAP does not support this. Sections are represented as an area appearing
  336. before its contents, so that it is possible to reconstruct the hierarchy
  337. from the FMAP by using the offset information. This convention does not
  338. seem to be documented, but is used in Chromium OS.
  339. CBFS entries appear as a single entry, i.e. the sub-entries are ignored.
  340. Entry: gbb: An entry which contains a Chromium OS Google Binary Block
  341. ---------------------------------------------------------------------
  342. Properties / Entry arguments:
  343. - hardware-id: Hardware ID to use for this build (a string)
  344. - keydir: Directory containing the public keys to use
  345. - bmpblk: Filename containing images used by recovery
  346. Chromium OS uses a GBB to store various pieces of information, in particular
  347. the root and recovery keys that are used to verify the boot process. Some
  348. more details are here:
  349. https://www.chromium.org/chromium-os/firmware-porting-guide/2-concepts
  350. but note that the page dates from 2013 so is quite out of date. See
  351. README.chromium for how to obtain the required keys and tools.
  352. Entry: image-header: An entry which contains a pointer to the FDT map
  353. ---------------------------------------------------------------------
  354. Properties / Entry arguments:
  355. location: Location of header ("start" or "end" of image). This is
  356. optional. If omitted then the entry must have an offset property.
  357. This adds an 8-byte entry to the start or end of the image, pointing to the
  358. location of the FDT map. The format is a magic number followed by an offset
  359. from the start or end of the image, in twos-compliment format.
  360. This entry must be in the top-level part of the image.
  361. NOTE: If the location is at the start/end, you will probably need to specify
  362. sort-by-offset for the image, unless you actually put the image header
  363. first/last in the entry list.
  364. Entry: intel-cmc: Intel Chipset Micro Code (CMC) file
  365. -----------------------------------------------------
  366. Properties / Entry arguments:
  367. - filename: Filename of file to read into entry
  368. This file contains microcode for some devices in a special format. An
  369. example filename is 'Microcode/C0_22211.BIN'.
  370. See README.x86 for information about x86 binary blobs.
  371. Entry: intel-descriptor: Intel flash descriptor block (4KB)
  372. -----------------------------------------------------------
  373. Properties / Entry arguments:
  374. filename: Filename of file containing the descriptor. This is typically
  375. a 4KB binary file, sometimes called 'descriptor.bin'
  376. This entry is placed at the start of flash and provides information about
  377. the SPI flash regions. In particular it provides the base address and
  378. size of the ME (Management Engine) region, allowing us to place the ME
  379. binary in the right place.
  380. With this entry in your image, the position of the 'intel-me' entry will be
  381. fixed in the image, which avoids you needed to specify an offset for that
  382. region. This is useful, because it is not possible to change the position
  383. of the ME region without updating the descriptor.
  384. See README.x86 for information about x86 binary blobs.
  385. Entry: intel-fit: Intel Firmware Image Table (FIT)
  386. --------------------------------------------------
  387. This entry contains a dummy FIT as required by recent Intel CPUs. The FIT
  388. contains information about the firmware and microcode available in the
  389. image.
  390. At present binman only supports a basic FIT with no microcode.
  391. Entry: intel-fit-ptr: Intel Firmware Image Table (FIT) pointer
  392. --------------------------------------------------------------
  393. This entry contains a pointer to the FIT. It is required to be at address
  394. 0xffffffc0 in the image.
  395. Entry: intel-fsp: Intel Firmware Support Package (FSP) file
  396. -----------------------------------------------------------
  397. Properties / Entry arguments:
  398. - filename: Filename of file to read into entry
  399. This file contains binary blobs which are used on some devices to make the
  400. platform work. U-Boot executes this code since it is not possible to set up
  401. the hardware using U-Boot open-source code. Documentation is typically not
  402. available in sufficient detail to allow this.
  403. An example filename is 'FSP/QUEENSBAY_FSP_GOLD_001_20-DECEMBER-2013.fd'
  404. See README.x86 for information about x86 binary blobs.
  405. Entry: intel-fsp-m: Intel Firmware Support Package (FSP) memory init
  406. --------------------------------------------------------------------
  407. Properties / Entry arguments:
  408. - filename: Filename of file to read into entry
  409. This file contains a binary blob which is used on some devices to set up
  410. SDRAM. U-Boot executes this code in SPL so that it can make full use of
  411. memory. Documentation is typically not available in sufficient detail to
  412. allow U-Boot do this this itself..
  413. An example filename is 'fsp_m.bin'
  414. See README.x86 for information about x86 binary blobs.
  415. Entry: intel-fsp-s: Intel Firmware Support Package (FSP) silicon init
  416. ---------------------------------------------------------------------
  417. Properties / Entry arguments:
  418. - filename: Filename of file to read into entry
  419. This file contains a binary blob which is used on some devices to set up
  420. the silicon. U-Boot executes this code in U-Boot proper after SDRAM is
  421. running, so that it can make full use of memory. Documentation is typically
  422. not available in sufficient detail to allow U-Boot do this this itself.
  423. An example filename is 'fsp_s.bin'
  424. See README.x86 for information about x86 binary blobs.
  425. Entry: intel-fsp-t: Intel Firmware Support Package (FSP) temp ram init
  426. ----------------------------------------------------------------------
  427. Properties / Entry arguments:
  428. - filename: Filename of file to read into entry
  429. This file contains a binary blob which is used on some devices to set up
  430. temporary memory (Cache-as-RAM or CAR). U-Boot executes this code in TPL so
  431. that it has access to memory for its stack and initial storage.
  432. An example filename is 'fsp_t.bin'
  433. See README.x86 for information about x86 binary blobs.
  434. Entry: intel-ifwi: Intel Integrated Firmware Image (IFWI) file
  435. --------------------------------------------------------------
  436. Properties / Entry arguments:
  437. - filename: Filename of file to read into entry. This is either the
  438. IFWI file itself, or a file that can be converted into one using a
  439. tool
  440. - convert-fit: If present this indicates that the ifwitool should be
  441. used to convert the provided file into a IFWI.
  442. This file contains code and data used by the SoC that is required to make
  443. it work. It includes U-Boot TPL, microcode, things related to the CSE
  444. (Converged Security Engine, the microcontroller that loads all the firmware)
  445. and other items beyond the wit of man.
  446. A typical filename is 'ifwi.bin' for an IFWI file, or 'fitimage.bin' for a
  447. file that will be converted to an IFWI.
  448. The position of this entry is generally set by the intel-descriptor entry.
  449. The contents of the IFWI are specified by the subnodes of the IFWI node.
  450. Each subnode describes an entry which is placed into the IFWFI with a given
  451. sub-partition (and optional entry name).
  452. Properties for subnodes:
  453. - ifwi-subpart: sub-parition to put this entry into, e.g. "IBBP"
  454. - ifwi-entry: entry name t use, e.g. "IBBL"
  455. - ifwi-replace: if present, indicates that the item should be replaced
  456. in the IFWI. Otherwise it is added.
  457. See README.x86 for information about x86 binary blobs.
  458. Entry: intel-me: Intel Management Engine (ME) file
  459. --------------------------------------------------
  460. Properties / Entry arguments:
  461. - filename: Filename of file to read into entry
  462. This file contains code used by the SoC that is required to make it work.
  463. The Management Engine is like a background task that runs things that are
  464. not clearly documented, but may include keyboard, display and network
  465. access. For platform that use ME it is not possible to disable it. U-Boot
  466. does not directly execute code in the ME binary.
  467. A typical filename is 'me.bin'.
  468. The position of this entry is generally set by the intel-descriptor entry.
  469. See README.x86 for information about x86 binary blobs.
  470. Entry: intel-mrc: Intel Memory Reference Code (MRC) file
  471. --------------------------------------------------------
  472. Properties / Entry arguments:
  473. - filename: Filename of file to read into entry
  474. This file contains code for setting up the SDRAM on some Intel systems. This
  475. is executed by U-Boot when needed early during startup. A typical filename
  476. is 'mrc.bin'.
  477. See README.x86 for information about x86 binary blobs.
  478. Entry: intel-refcode: Intel Reference Code file
  479. -----------------------------------------------
  480. Properties / Entry arguments:
  481. - filename: Filename of file to read into entry
  482. This file contains code for setting up the platform on some Intel systems.
  483. This is executed by U-Boot when needed early during startup. A typical
  484. filename is 'refcode.bin'.
  485. See README.x86 for information about x86 binary blobs.
  486. Entry: intel-vbt: Intel Video BIOS Table (VBT) file
  487. ---------------------------------------------------
  488. Properties / Entry arguments:
  489. - filename: Filename of file to read into entry
  490. This file contains code that sets up the integrated graphics subsystem on
  491. some Intel SoCs. U-Boot executes this when the display is started up.
  492. See README.x86 for information about Intel binary blobs.
  493. Entry: intel-vga: Intel Video Graphics Adaptor (VGA) file
  494. ---------------------------------------------------------
  495. Properties / Entry arguments:
  496. - filename: Filename of file to read into entry
  497. This file contains code that sets up the integrated graphics subsystem on
  498. some Intel SoCs. U-Boot executes this when the display is started up.
  499. This is similar to the VBT file but in a different format.
  500. See README.x86 for information about Intel binary blobs.
  501. Entry: mkimage: Binary produced by mkimage
  502. ------------------------------------------
  503. Properties / Entry arguments:
  504. - datafile: Filename for -d argument
  505. - args: Other arguments to pass
  506. The data passed to mkimage is collected from subnodes of the mkimage node,
  507. e.g.::
  508. mkimage {
  509. args = "-n test -T imximage";
  510. u-boot-spl {
  511. };
  512. };
  513. This calls mkimage to create an imximage with u-boot-spl.bin as the input
  514. file. The output from mkimage then becomes part of the image produced by
  515. binman.
  516. Entry: opensbi: RISC-V OpenSBI fw_dynamic blob
  517. ----------------------------------------------
  518. Properties / Entry arguments:
  519. - opensbi-path: Filename of file to read into entry. This is typically
  520. called fw_dynamic.bin
  521. This entry holds the run-time firmware, typically started by U-Boot SPL.
  522. See the U-Boot README for your architecture or board for how to use it. See
  523. https://github.com/riscv/opensbi for more information about OpenSBI.
  524. Entry: powerpc-mpc85xx-bootpg-resetvec: PowerPC mpc85xx bootpg + resetvec code for U-Boot
  525. -----------------------------------------------------------------------------------------
  526. Properties / Entry arguments:
  527. - filename: Filename of u-boot-br.bin (default 'u-boot-br.bin')
  528. This entry is valid for PowerPC mpc85xx cpus. This entry holds
  529. 'bootpg + resetvec' code for PowerPC mpc85xx CPUs which needs to be
  530. placed at offset 'RESET_VECTOR_ADDRESS - 0xffc'.
  531. Entry: scp: System Control Processor (SCP) firmware blob
  532. --------------------------------------------------------
  533. Properties / Entry arguments:
  534. - scp-path: Filename of file to read into the entry, typically scp.bin
  535. This entry holds firmware for an external platform-specific coprocessor.
  536. Entry: section: Entry that contains other entries
  537. -------------------------------------------------
  538. Properties / Entry arguments: (see binman README for more information):
  539. pad-byte: Pad byte to use when padding
  540. sort-by-offset: True if entries should be sorted by offset, False if
  541. they must be in-order in the device tree description
  542. end-at-4gb: Used to build an x86 ROM which ends at 4GB (2^32)
  543. skip-at-start: Number of bytes before the first entry starts. These
  544. effectively adjust the starting offset of entries. For example,
  545. if this is 16, then the first entry would start at 16. An entry
  546. with offset = 20 would in fact be written at offset 4 in the image
  547. file, since the first 16 bytes are skipped when writing.
  548. name-prefix: Adds a prefix to the name of every entry in the section
  549. when writing out the map
  550. align_default: Default alignment for this section, if no alignment is
  551. given in the entry
  552. Properties:
  553. allow_missing: True if this section permits external blobs to be
  554. missing their contents. The second will produce an image but of
  555. course it will not work.
  556. Properties:
  557. _allow_missing: True if this section permits external blobs to be
  558. missing their contents. The second will produce an image but of
  559. course it will not work.
  560. Since a section is also an entry, it inherits all the properies of entries
  561. too.
  562. A section is an entry which can contain other entries, thus allowing
  563. hierarchical images to be created. See 'Sections and hierarchical images'
  564. in the binman README for more information.
  565. Entry: text: An entry which contains text
  566. -----------------------------------------
  567. The text can be provided either in the node itself or by a command-line
  568. argument. There is a level of indirection to allow multiple text strings
  569. and sharing of text.
  570. Properties / Entry arguments:
  571. text-label: The value of this string indicates the property / entry-arg
  572. that contains the string to place in the entry
  573. <xxx> (actual name is the value of text-label): contains the string to
  574. place in the entry.
  575. <text>: The text to place in the entry (overrides the above mechanism).
  576. This is useful when the text is constant.
  577. Example node::
  578. text {
  579. size = <50>;
  580. text-label = "message";
  581. };
  582. You can then use:
  583. binman -amessage="this is my message"
  584. and binman will insert that string into the entry.
  585. It is also possible to put the string directly in the node::
  586. text {
  587. size = <8>;
  588. text-label = "message";
  589. message = "a message directly in the node"
  590. };
  591. or just::
  592. text {
  593. size = <8>;
  594. text = "some text directly in the node"
  595. };
  596. The text is not itself nul-terminated. This can be achieved, if required,
  597. by setting the size of the entry to something larger than the text.
  598. Entry: u-boot: U-Boot flat binary
  599. ---------------------------------
  600. Properties / Entry arguments:
  601. - filename: Filename of u-boot.bin (default 'u-boot.bin')
  602. This is the U-Boot binary, containing relocation information to allow it
  603. to relocate itself at runtime. The binary typically includes a device tree
  604. blob at the end of it.
  605. U-Boot can access binman symbols at runtime. See:
  606. 'Access to binman entry offsets at run time (fdt)'
  607. in the binman README for more information.
  608. Note that this entry is automatically replaced with u-boot-expanded unless
  609. --no-expanded is used or the node has a 'no-expanded' property.
  610. Entry: u-boot-dtb: U-Boot device tree
  611. -------------------------------------
  612. Properties / Entry arguments:
  613. - filename: Filename of u-boot.dtb (default 'u-boot.dtb')
  614. This is the U-Boot device tree, containing configuration information for
  615. U-Boot. U-Boot needs this to know what devices are present and which drivers
  616. to activate.
  617. Note: This is mostly an internal entry type, used by others. This allows
  618. binman to know which entries contain a device tree.
  619. Entry: u-boot-dtb-with-ucode: A U-Boot device tree file, with the microcode removed
  620. -----------------------------------------------------------------------------------
  621. Properties / Entry arguments:
  622. - filename: Filename of u-boot.dtb (default 'u-boot.dtb')
  623. See Entry_u_boot_ucode for full details of the three entries involved in
  624. this process. This entry provides the U-Boot device-tree file, which
  625. contains the microcode. If the microcode is not being collated into one
  626. place then the offset and size of the microcode is recorded by this entry,
  627. for use by u-boot-with-ucode_ptr. If it is being collated, then this
  628. entry deletes the microcode from the device tree (to save space) and makes
  629. it available to u-boot-ucode.
  630. Entry: u-boot-elf: U-Boot ELF image
  631. -----------------------------------
  632. Properties / Entry arguments:
  633. - filename: Filename of u-boot (default 'u-boot')
  634. This is the U-Boot ELF image. It does not include a device tree but can be
  635. relocated to any address for execution.
  636. Entry: u-boot-env: An entry which contains a U-Boot environment
  637. ---------------------------------------------------------------
  638. Properties / Entry arguments:
  639. - filename: File containing the environment text, with each line in the
  640. form var=value
  641. Entry: u-boot-expanded: U-Boot flat binary broken out into its component parts
  642. ------------------------------------------------------------------------------
  643. This is a section containing the U-Boot binary and a devicetree. Using this
  644. entry type automatically creates this section, with the following entries
  645. in it:
  646. u-boot-nodtb
  647. u-boot-dtb
  648. Having the devicetree separate allows binman to update it in the final
  649. image, so that the entries positions are provided to the running U-Boot.
  650. Entry: u-boot-img: U-Boot legacy image
  651. --------------------------------------
  652. Properties / Entry arguments:
  653. - filename: Filename of u-boot.img (default 'u-boot.img')
  654. This is the U-Boot binary as a packaged image, in legacy format. It has a
  655. header which allows it to be loaded at the correct address for execution.
  656. You should use FIT (Flat Image Tree) instead of the legacy image for new
  657. applications.
  658. Entry: u-boot-nodtb: U-Boot flat binary without device tree appended
  659. --------------------------------------------------------------------
  660. Properties / Entry arguments:
  661. - filename: Filename to include (default 'u-boot-nodtb.bin')
  662. This is the U-Boot binary, containing relocation information to allow it
  663. to relocate itself at runtime. It does not include a device tree blob at
  664. the end of it so normally cannot work without it. You can add a u-boot-dtb
  665. entry after this one, or use a u-boot entry instead, normally expands to a
  666. section containing u-boot and u-boot-dtb
  667. Entry: u-boot-spl: U-Boot SPL binary
  668. ------------------------------------
  669. Properties / Entry arguments:
  670. - filename: Filename of u-boot-spl.bin (default 'spl/u-boot-spl.bin')
  671. This is the U-Boot SPL (Secondary Program Loader) binary. This is a small
  672. binary which loads before U-Boot proper, typically into on-chip SRAM. It is
  673. responsible for locating, loading and jumping to U-Boot. Note that SPL is
  674. not relocatable so must be loaded to the correct address in SRAM, or written
  675. to run from the correct address if direct flash execution is possible (e.g.
  676. on x86 devices).
  677. SPL can access binman symbols at runtime. See:
  678. 'Access to binman entry offsets at run time (symbols)'
  679. in the binman README for more information.
  680. The ELF file 'spl/u-boot-spl' must also be available for this to work, since
  681. binman uses that to look up symbols to write into the SPL binary.
  682. Note that this entry is automatically replaced with u-boot-spl-expanded
  683. unless --no-expanded is used or the node has a 'no-expanded' property.
  684. Entry: u-boot-spl-bss-pad: U-Boot SPL binary padded with a BSS region
  685. ---------------------------------------------------------------------
  686. Properties / Entry arguments:
  687. None
  688. This holds the padding added after the SPL binary to cover the BSS (Block
  689. Started by Symbol) region. This region holds the various variables used by
  690. SPL. It is set to 0 by SPL when it starts up. If you want to append data to
  691. the SPL image (such as a device tree file), you must pad out the BSS region
  692. to avoid the data overlapping with U-Boot variables. This entry is useful in
  693. that case. It automatically pads out the entry size to cover both the code,
  694. data and BSS.
  695. The contents of this entry will a certain number of zero bytes, determined
  696. by __bss_size
  697. The ELF file 'spl/u-boot-spl' must also be available for this to work, since
  698. binman uses that to look up the BSS address.
  699. Entry: u-boot-spl-dtb: U-Boot SPL device tree
  700. ---------------------------------------------
  701. Properties / Entry arguments:
  702. - filename: Filename of u-boot.dtb (default 'spl/u-boot-spl.dtb')
  703. This is the SPL device tree, containing configuration information for
  704. SPL. SPL needs this to know what devices are present and which drivers
  705. to activate.
  706. Entry: u-boot-spl-elf: U-Boot SPL ELF image
  707. -------------------------------------------
  708. Properties / Entry arguments:
  709. - filename: Filename of SPL u-boot (default 'spl/u-boot-spl')
  710. This is the U-Boot SPL ELF image. It does not include a device tree but can
  711. be relocated to any address for execution.
  712. Entry: u-boot-spl-expanded: U-Boot SPL flat binary broken out into its component parts
  713. --------------------------------------------------------------------------------------
  714. Properties / Entry arguments:
  715. - spl-dtb: Controls whether this entry is selected (set to 'y' or '1' to
  716. select)
  717. This is a section containing the U-Boot binary, BSS padding if needed and a
  718. devicetree. Using this entry type automatically creates this section, with
  719. the following entries in it:
  720. u-boot-spl-nodtb
  721. u-boot-spl-bss-pad
  722. u-boot-dtb
  723. Having the devicetree separate allows binman to update it in the final
  724. image, so that the entries positions are provided to the running U-Boot.
  725. This entry is selected based on the value of the 'spl-dtb' entryarg. If
  726. this is non-empty (and not 'n' or '0') then this expanded entry is selected.
  727. Entry: u-boot-spl-nodtb: SPL binary without device tree appended
  728. ----------------------------------------------------------------
  729. Properties / Entry arguments:
  730. - filename: Filename to include (default 'spl/u-boot-spl-nodtb.bin')
  731. This is the U-Boot SPL binary, It does not include a device tree blob at
  732. the end of it so may not be able to work without it, assuming SPL needs
  733. a device tree to operate on your platform. You can add a u-boot-spl-dtb
  734. entry after this one, or use a u-boot-spl entry instead' which normally
  735. expands to a section containing u-boot-spl-dtb, u-boot-spl-bss-pad and
  736. u-boot-spl-dtb
  737. SPL can access binman symbols at runtime. See:
  738. 'Access to binman entry offsets at run time (symbols)'
  739. in the binman README for more information.
  740. The ELF file 'spl/u-boot-spl' must also be available for this to work, since
  741. binman uses that to look up symbols to write into the SPL binary.
  742. Entry: u-boot-spl-with-ucode-ptr: U-Boot SPL with embedded microcode pointer
  743. ----------------------------------------------------------------------------
  744. This is used when SPL must set up the microcode for U-Boot.
  745. See Entry_u_boot_ucode for full details of the entries involved in this
  746. process.
  747. Entry: u-boot-tpl: U-Boot TPL binary
  748. ------------------------------------
  749. Properties / Entry arguments:
  750. - filename: Filename of u-boot-tpl.bin (default 'tpl/u-boot-tpl.bin')
  751. This is the U-Boot TPL (Tertiary Program Loader) binary. This is a small
  752. binary which loads before SPL, typically into on-chip SRAM. It is
  753. responsible for locating, loading and jumping to SPL, the next-stage
  754. loader. Note that SPL is not relocatable so must be loaded to the correct
  755. address in SRAM, or written to run from the correct address if direct
  756. flash execution is possible (e.g. on x86 devices).
  757. SPL can access binman symbols at runtime. See:
  758. 'Access to binman entry offsets at run time (symbols)'
  759. in the binman README for more information.
  760. The ELF file 'tpl/u-boot-tpl' must also be available for this to work, since
  761. binman uses that to look up symbols to write into the TPL binary.
  762. Note that this entry is automatically replaced with u-boot-tpl-expanded
  763. unless --no-expanded is used or the node has a 'no-expanded' property.
  764. Entry: u-boot-tpl-bss-pad: U-Boot TPL binary padded with a BSS region
  765. ---------------------------------------------------------------------
  766. Properties / Entry arguments:
  767. None
  768. This holds the padding added after the TPL binary to cover the BSS (Block
  769. Started by Symbol) region. This region holds the various variables used by
  770. TPL. It is set to 0 by TPL when it starts up. If you want to append data to
  771. the TPL image (such as a device tree file), you must pad out the BSS region
  772. to avoid the data overlapping with U-Boot variables. This entry is useful in
  773. that case. It automatically pads out the entry size to cover both the code,
  774. data and BSS.
  775. The contents of this entry will a certain number of zero bytes, determined
  776. by __bss_size
  777. The ELF file 'tpl/u-boot-tpl' must also be available for this to work, since
  778. binman uses that to look up the BSS address.
  779. Entry: u-boot-tpl-dtb: U-Boot TPL device tree
  780. ---------------------------------------------
  781. Properties / Entry arguments:
  782. - filename: Filename of u-boot.dtb (default 'tpl/u-boot-tpl.dtb')
  783. This is the TPL device tree, containing configuration information for
  784. TPL. TPL needs this to know what devices are present and which drivers
  785. to activate.
  786. Entry: u-boot-tpl-dtb-with-ucode: U-Boot TPL with embedded microcode pointer
  787. ----------------------------------------------------------------------------
  788. This is used when TPL must set up the microcode for U-Boot.
  789. See Entry_u_boot_ucode for full details of the entries involved in this
  790. process.
  791. Entry: u-boot-tpl-elf: U-Boot TPL ELF image
  792. -------------------------------------------
  793. Properties / Entry arguments:
  794. - filename: Filename of TPL u-boot (default 'tpl/u-boot-tpl')
  795. This is the U-Boot TPL ELF image. It does not include a device tree but can
  796. be relocated to any address for execution.
  797. Entry: u-boot-tpl-expanded: U-Boot TPL flat binary broken out into its component parts
  798. --------------------------------------------------------------------------------------
  799. Properties / Entry arguments:
  800. - tpl-dtb: Controls whether this entry is selected (set to 'y' or '1' to
  801. select)
  802. This is a section containing the U-Boot binary, BSS padding if needed and a
  803. devicetree. Using this entry type automatically creates this section, with
  804. the following entries in it:
  805. u-boot-tpl-nodtb
  806. u-boot-tpl-bss-pad
  807. u-boot-dtb
  808. Having the devicetree separate allows binman to update it in the final
  809. image, so that the entries positions are provided to the running U-Boot.
  810. This entry is selected based on the value of the 'tpl-dtb' entryarg. If
  811. this is non-empty (and not 'n' or '0') then this expanded entry is selected.
  812. Entry: u-boot-tpl-nodtb: TPL binary without device tree appended
  813. ----------------------------------------------------------------
  814. Properties / Entry arguments:
  815. - filename: Filename to include (default 'tpl/u-boot-tpl-nodtb.bin')
  816. This is the U-Boot TPL binary, It does not include a device tree blob at
  817. the end of it so may not be able to work without it, assuming TPL needs
  818. a device tree to operate on your platform. You can add a u-boot-tpl-dtb
  819. entry after this one, or use a u-boot-tpl entry instead, which normally
  820. expands to a section containing u-boot-tpl-dtb, u-boot-tpl-bss-pad and
  821. u-boot-tpl-dtb
  822. TPL can access binman symbols at runtime. See:
  823. 'Access to binman entry offsets at run time (symbols)'
  824. in the binman README for more information.
  825. The ELF file 'tpl/u-boot-tpl' must also be available for this to work, since
  826. binman uses that to look up symbols to write into the TPL binary.
  827. Entry: u-boot-tpl-with-ucode-ptr: U-Boot TPL with embedded microcode pointer
  828. ----------------------------------------------------------------------------
  829. See Entry_u_boot_ucode for full details of the entries involved in this
  830. process.
  831. Entry: u-boot-ucode: U-Boot microcode block
  832. -------------------------------------------
  833. Properties / Entry arguments:
  834. None
  835. The contents of this entry are filled in automatically by other entries
  836. which must also be in the image.
  837. U-Boot on x86 needs a single block of microcode. This is collected from
  838. the various microcode update nodes in the device tree. It is also unable
  839. to read the microcode from the device tree on platforms that use FSP
  840. (Firmware Support Package) binaries, because the API requires that the
  841. microcode is supplied before there is any SRAM available to use (i.e.
  842. the FSP sets up the SRAM / cache-as-RAM but does so in the call that
  843. requires the microcode!). To keep things simple, all x86 platforms handle
  844. microcode the same way in U-Boot (even non-FSP platforms). This is that
  845. a table is placed at _dt_ucode_base_size containing the base address and
  846. size of the microcode. This is either passed to the FSP (for FSP
  847. platforms), or used to set up the microcode (for non-FSP platforms).
  848. This all happens in the build system since it is the only way to get
  849. the microcode into a single blob and accessible without SRAM.
  850. There are two cases to handle. If there is only one microcode blob in
  851. the device tree, then the ucode pointer it set to point to that. This
  852. entry (u-boot-ucode) is empty. If there is more than one update, then
  853. this entry holds the concatenation of all updates, and the device tree
  854. entry (u-boot-dtb-with-ucode) is updated to remove the microcode. This
  855. last step ensures that that the microcode appears in one contiguous
  856. block in the image and is not unnecessarily duplicated in the device
  857. tree. It is referred to as 'collation' here.
  858. Entry types that have a part to play in handling microcode:
  859. Entry_u_boot_with_ucode_ptr:
  860. Contains u-boot-nodtb.bin (i.e. U-Boot without the device tree).
  861. It updates it with the address and size of the microcode so that
  862. U-Boot can find it early on start-up.
  863. Entry_u_boot_dtb_with_ucode:
  864. Contains u-boot.dtb. It stores the microcode in a
  865. 'self.ucode_data' property, which is then read by this class to
  866. obtain the microcode if needed. If collation is performed, it
  867. removes the microcode from the device tree.
  868. Entry_u_boot_ucode:
  869. This class. If collation is enabled it reads the microcode from
  870. the Entry_u_boot_dtb_with_ucode entry, and uses it as the
  871. contents of this entry.
  872. Entry: u-boot-with-ucode-ptr: U-Boot with embedded microcode pointer
  873. --------------------------------------------------------------------
  874. Properties / Entry arguments:
  875. - filename: Filename of u-boot-nodtb.bin (default 'u-boot-nodtb.bin')
  876. - optional-ucode: boolean property to make microcode optional. If the
  877. u-boot.bin image does not include microcode, no error will
  878. be generated.
  879. See Entry_u_boot_ucode for full details of the three entries involved in
  880. this process. This entry updates U-Boot with the offset and size of the
  881. microcode, to allow early x86 boot code to find it without doing anything
  882. complicated. Otherwise it is the same as the u-boot entry.
  883. Entry: vblock: An entry which contains a Chromium OS verified boot block
  884. ------------------------------------------------------------------------
  885. Properties / Entry arguments:
  886. - content: List of phandles to entries to sign
  887. - keydir: Directory containing the public keys to use
  888. - keyblock: Name of the key file to use (inside keydir)
  889. - signprivate: Name of provide key file to use (inside keydir)
  890. - version: Version number of the vblock (typically 1)
  891. - kernelkey: Name of the kernel key to use (inside keydir)
  892. - preamble-flags: Value of the vboot preamble flags (typically 0)
  893. Output files:
  894. - input.<unique_name> - input file passed to futility
  895. - vblock.<unique_name> - output file generated by futility (which is
  896. used as the entry contents)
  897. Chromium OS signs the read-write firmware and kernel, writing the signature
  898. in this block. This allows U-Boot to verify that the next firmware stage
  899. and kernel are genuine.
  900. Entry: x86-reset16: x86 16-bit reset code for U-Boot
  901. ----------------------------------------------------
  902. Properties / Entry arguments:
  903. - filename: Filename of u-boot-x86-reset16.bin (default
  904. 'u-boot-x86-reset16.bin')
  905. x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
  906. must be placed at a particular address. This entry holds that code. It is
  907. typically placed at offset CONFIG_RESET_VEC_LOC. The code is responsible
  908. for jumping to the x86-start16 code, which continues execution.
  909. For 64-bit U-Boot, the 'x86_reset16_spl' entry type is used instead.
  910. Entry: x86-reset16-spl: x86 16-bit reset code for U-Boot
  911. --------------------------------------------------------
  912. Properties / Entry arguments:
  913. - filename: Filename of u-boot-x86-reset16.bin (default
  914. 'u-boot-x86-reset16.bin')
  915. x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
  916. must be placed at a particular address. This entry holds that code. It is
  917. typically placed at offset CONFIG_RESET_VEC_LOC. The code is responsible
  918. for jumping to the x86-start16 code, which continues execution.
  919. For 32-bit U-Boot, the 'x86_reset_spl' entry type is used instead.
  920. Entry: x86-reset16-tpl: x86 16-bit reset code for U-Boot
  921. --------------------------------------------------------
  922. Properties / Entry arguments:
  923. - filename: Filename of u-boot-x86-reset16.bin (default
  924. 'u-boot-x86-reset16.bin')
  925. x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
  926. must be placed at a particular address. This entry holds that code. It is
  927. typically placed at offset CONFIG_RESET_VEC_LOC. The code is responsible
  928. for jumping to the x86-start16 code, which continues execution.
  929. For 32-bit U-Boot, the 'x86_reset_tpl' entry type is used instead.
  930. Entry: x86-start16: x86 16-bit start-up code for U-Boot
  931. -------------------------------------------------------
  932. Properties / Entry arguments:
  933. - filename: Filename of u-boot-x86-start16.bin (default
  934. 'u-boot-x86-start16.bin')
  935. x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
  936. must be placed in the top 64KB of the ROM. The reset code jumps to it. This
  937. entry holds that code. It is typically placed at offset
  938. CONFIG_SYS_X86_START16. The code is responsible for changing to 32-bit mode
  939. and jumping to U-Boot's entry point, which requires 32-bit mode (for 32-bit
  940. U-Boot).
  941. For 64-bit U-Boot, the 'x86_start16_spl' entry type is used instead.
  942. Entry: x86-start16-spl: x86 16-bit start-up code for SPL
  943. --------------------------------------------------------
  944. Properties / Entry arguments:
  945. - filename: Filename of spl/u-boot-x86-start16-spl.bin (default
  946. 'spl/u-boot-x86-start16-spl.bin')
  947. x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
  948. must be placed in the top 64KB of the ROM. The reset code jumps to it. This
  949. entry holds that code. It is typically placed at offset
  950. CONFIG_SYS_X86_START16. The code is responsible for changing to 32-bit mode
  951. and jumping to U-Boot's entry point, which requires 32-bit mode (for 32-bit
  952. U-Boot).
  953. For 32-bit U-Boot, the 'x86-start16' entry type is used instead.
  954. Entry: x86-start16-tpl: x86 16-bit start-up code for TPL
  955. --------------------------------------------------------
  956. Properties / Entry arguments:
  957. - filename: Filename of tpl/u-boot-x86-start16-tpl.bin (default
  958. 'tpl/u-boot-x86-start16-tpl.bin')
  959. x86 CPUs start up in 16-bit mode, even if they are 32-bit CPUs. This code
  960. must be placed in the top 64KB of the ROM. The reset code jumps to it. This
  961. entry holds that code. It is typically placed at offset
  962. CONFIG_SYS_X86_START16. The code is responsible for changing to 32-bit mode
  963. and jumping to U-Boot's entry point, which requires 32-bit mode (for 32-bit
  964. U-Boot).
  965. If TPL is not being used, the 'x86-start16-spl or 'x86-start16' entry types
  966. may be used instead.