blob: 2f4c7fec21e012a10e22a928056f4f950f434165 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001# SPDX-License-Identifier: GPL-2.0+
Simon Glassbf7fd502016-11-25 20:15:51 -07002# Copyright (c) 2016 Google, Inc
Simon Glassbf7fd502016-11-25 20:15:51 -07003
4Introduction
5------------
6
7Firmware often consists of several components which must be packaged together.
8For example, we may have SPL, U-Boot, a device tree and an environment area
9grouped together and placed in MMC flash. When the system starts, it must be
10able to find these pieces.
11
12So far U-Boot has not provided a way to handle creating such images in a
13general way. Each SoC does what it needs to build an image, often packing or
14concatenating images in the U-Boot build system.
15
16Binman aims to provide a mechanism for building images, from simple
17SPL + U-Boot combinations, to more complex arrangements with many parts.
18
19
20What it does
21------------
22
23Binman reads your board's device tree and finds a node which describes the
24required image layout. It uses this to work out what to place where. The
25output file normally contains the device tree, so it is in principle possible
26to read an image and extract its constituent parts.
27
28
29Features
30--------
31
32So far binman is pretty simple. It supports binary blobs, such as 'u-boot',
33'spl' and 'fdt'. It supports empty entries (such as setting to 0xff). It can
34place entries at a fixed location in the image, or fit them together with
35suitable padding and alignment. It provides a way to process binaries before
36they are included, by adding a Python plug-in. The device tree is available
37to U-Boot at run-time so that the images can be interpreted.
38
39Binman does not yet update the device tree with the final location of
40everything when it is done. A simple C structure could be generated for
41constrained environments like SPL (using dtoc) but this is also not
42implemented.
43
44Binman can also support incorporating filesystems in the image if required.
45For example x86 platforms may use CBFS in some cases.
46
47Binman is intended for use with U-Boot but is designed to be general enough
48to be useful in other image-packaging situations.
49
50
51Motivation
52----------
53
54Packaging of firmware is quite a different task from building the various
55parts. In many cases the various binaries which go into the image come from
56separate build systems. For example, ARM Trusted Firmware is used on ARMv8
57devices but is not built in the U-Boot tree. If a Linux kernel is included
58in the firmware image, it is built elsewhere.
59
60It is of course possible to add more and more build rules to the U-Boot
61build system to cover these cases. It can shell out to other Makefiles and
62build scripts. But it seems better to create a clear divide between building
63software and packaging it.
64
65At present this is handled by manual instructions, different for each board,
66on how to create images that will boot. By turning these instructions into a
67standard format, we can support making valid images for any board without
68manual effort, lots of READMEs, etc.
69
70Benefits:
71- Each binary can have its own build system and tool chain without creating
72any dependencies between them
73- Avoids the need for a single-shot build: individual parts can be updated
74and brought in as needed
75- Provides for a standard image description available in the build and at
76run-time
77- SoC-specific image-signing tools can be accomodated
78- Avoids cluttering the U-Boot build system with image-building code
79- The image description is automatically available at run-time in U-Boot,
80SPL. It can be made available to other software also
81- The image description is easily readable (it's a text file in device-tree
82format) and permits flexible packing of binaries
83
84
85Terminology
86-----------
87
88Binman uses the following terms:
89
90- image - an output file containing a firmware image
91- binary - an input binary that goes into the image
92
93
94Relationship to FIT
95-------------------
96
97FIT is U-Boot's official image format. It supports multiple binaries with
98load / execution addresses, compression. It also supports verification
99through hashing and RSA signatures.
100
101FIT was originally designed to support booting a Linux kernel (with an
102optional ramdisk) and device tree chosen from various options in the FIT.
103Now that U-Boot supports configuration via device tree, it is possible to
104load U-Boot from a FIT, with the device tree chosen by SPL.
105
106Binman considers FIT to be one of the binaries it can place in the image.
107
108Where possible it is best to put as much as possible in the FIT, with binman
109used to deal with cases not covered by FIT. Examples include initial
110execution (since FIT itself does not have an executable header) and dealing
111with device boundaries, such as the read-only/read-write separation in SPI
112flash.
113
114For U-Boot, binman should not be used to create ad-hoc images in place of
115FIT.
116
117
118Relationship to mkimage
119-----------------------
120
121The mkimage tool provides a means to create a FIT. Traditionally it has
122needed an image description file: a device tree, like binman, but in a
123different format. More recently it has started to support a '-f auto' mode
124which can generate that automatically.
125
126More relevant to binman, mkimage also permits creation of many SoC-specific
127image types. These can be listed by running 'mkimage -T list'. Examples
128include 'rksd', the Rockchip SD/MMC boot format. The mkimage tool is often
129called from the U-Boot build system for this reason.
130
131Binman considers the output files created by mkimage to be binary blobs
132which it can place in an image. Binman does not replace the mkimage tool or
Michael Heimpold383d2562018-08-22 22:01:24 +0200133this purpose. It would be possible in some situations to create a new entry
Simon Glassbf7fd502016-11-25 20:15:51 -0700134type for the images in mkimage, but this would not add functionality. It
Michael Heimpold383d2562018-08-22 22:01:24 +0200135seems better to use the mkimage tool to generate binaries and avoid blurring
Simon Glassbf7fd502016-11-25 20:15:51 -0700136the boundaries between building input files (mkimage) and packaging then
137into a final image (binman).
138
139
140Example use of binman in U-Boot
141-------------------------------
142
143Binman aims to replace some of the ad-hoc image creation in the U-Boot
144build system.
145
146Consider sunxi. It has the following steps:
147
1481. It uses a custom mksunxiboot tool to build an SPL image called
149sunxi-spl.bin. This should probably move into mkimage.
150
1512. It uses mkimage to package U-Boot into a legacy image file (so that it can
152hold the load and execution address) called u-boot.img.
153
1543. It builds a final output image called u-boot-sunxi-with-spl.bin which
155consists of sunxi-spl.bin, some padding and u-boot.img.
156
157Binman is intended to replace the last step. The U-Boot build system builds
158u-boot.bin and sunxi-spl.bin. Binman can then take over creation of
159sunxi-spl.bin (by calling mksunxiboot, or hopefully one day mkimage). In any
160case, it would then create the image from the component parts.
161
162This simplifies the U-Boot Makefile somewhat, since various pieces of logic
163can be replaced by a call to binman.
164
165
166Example use of binman for x86
167-----------------------------
168
169In most cases x86 images have a lot of binary blobs, 'black-box' code
170provided by Intel which must be run for the platform to work. Typically
171these blobs are not relocatable and must be placed at fixed areas in the
Michael Heimpold383d2562018-08-22 22:01:24 +0200172firmware image.
Simon Glassbf7fd502016-11-25 20:15:51 -0700173
174Currently this is handled by ifdtool, which places microcode, FSP, MRC, VGA
175BIOS, reference code and Intel ME binaries into a u-boot.rom file.
176
177Binman is intended to replace all of this, with ifdtool left to handle only
178the configuration of the Intel-format descriptor.
179
180
181Running binman
182--------------
183
Simon Glassd8d40742019-07-08 13:18:35 -0600184First install prerequisites, e.g.
185
Simon Glass07d9e702019-07-08 13:18:41 -0600186 sudo apt-get install python-pyelftools python3-pyelftools lzma-alone \
187 liblz4-tool
Simon Glassd8d40742019-07-08 13:18:35 -0600188
Simon Glassbf7fd502016-11-25 20:15:51 -0700189Type:
190
191 binman -b <board_name>
192
193to build an image for a board. The board name is the same name used when
194configuring U-Boot (e.g. for sandbox_defconfig the board name is 'sandbox').
195Binman assumes that the input files for the build are in ../b/<board_name>.
196
197Or you can specify this explicitly:
198
199 binman -I <build_path>
200
201where <build_path> is the build directory containing the output of the U-Boot
202build.
203
204(Future work will make this more configurable)
205
206In either case, binman picks up the device tree file (u-boot.dtb) and looks
207for its instructions in the 'binman' node.
208
209Binman has a few other options which you can see by running 'binman -h'.
210
211
Simon Glass9c0a8b12017-11-12 21:52:06 -0700212Enabling binman for a board
213---------------------------
214
215At present binman is invoked from a rule in the main Makefile. Typically you
216will have a rule like:
217
218ifneq ($(CONFIG_ARCH_<something>),)
219u-boot-<your_suffix>.bin: <input_file_1> <input_file_2> checkbinman FORCE
220 $(call if_changed,binman)
221endif
222
223This assumes that u-boot-<your_suffix>.bin is a target, and is the final file
224that you need to produce. You can make it a target by adding it to ALL-y
225either in the main Makefile or in a config.mk file in your arch subdirectory.
226
227Once binman is executed it will pick up its instructions from a device-tree
228file, typically <soc>-u-boot.dtsi, where <soc> is your CONFIG_SYS_SOC value.
229You can use other, more specific CONFIG options - see 'Automatic .dtsi
230inclusion' below.
231
232
Simon Glassbf7fd502016-11-25 20:15:51 -0700233Image description format
234------------------------
235
236The binman node is called 'binman'. An example image description is shown
237below:
238
239 binman {
240 filename = "u-boot-sunxi-with-spl.bin";
241 pad-byte = <0xff>;
242 blob {
243 filename = "spl/sunxi-spl.bin";
244 };
245 u-boot {
Simon Glass3ab95982018-08-01 15:22:37 -0600246 offset = <CONFIG_SPL_PAD_TO>;
Simon Glassbf7fd502016-11-25 20:15:51 -0700247 };
248 };
249
250
251This requests binman to create an image file called u-boot-sunxi-with-spl.bin
252consisting of a specially formatted SPL (spl/sunxi-spl.bin, built by the
253normal U-Boot Makefile), some 0xff padding, and a U-Boot legacy image. The
254padding comes from the fact that the second binary is placed at
255CONFIG_SPL_PAD_TO. If that line were omitted then the U-Boot binary would
256immediately follow the SPL binary.
257
258The binman node describes an image. The sub-nodes describe entries in the
259image. Each entry represents a region within the overall image. The name of
260the entry (blob, u-boot) tells binman what to put there. For 'blob' we must
261provide a filename. For 'u-boot', binman knows that this means 'u-boot.bin'.
262
263Entries are normally placed into the image sequentially, one after the other.
264The image size is the total size of all entries. As you can see, you can
Simon Glass3ab95982018-08-01 15:22:37 -0600265specify the start offset of an entry using the 'offset' property.
Simon Glassbf7fd502016-11-25 20:15:51 -0700266
267Note that due to a device tree requirement, all entries must have a unique
268name. If you want to put the same binary in the image multiple times, you can
269use any unique name, with the 'type' property providing the type.
270
271The attributes supported for entries are described below.
272
Simon Glass3ab95982018-08-01 15:22:37 -0600273offset:
274 This sets the offset of an entry within the image or section containing
275 it. The first byte of the image is normally at offset 0. If 'offset' is
276 not provided, binman sets it to the end of the previous region, or the
277 start of the image's entry area (normally 0) if there is no previous
278 region.
Simon Glassbf7fd502016-11-25 20:15:51 -0700279
280align:
Simon Glass3ab95982018-08-01 15:22:37 -0600281 This sets the alignment of the entry. The entry offset is adjusted
Simon Glassbf7fd502016-11-25 20:15:51 -0700282 so that the entry starts on an aligned boundary within the image. For
283 example 'align = <16>' means that the entry will start on a 16-byte
284 boundary. Alignment shold be a power of 2. If 'align' is not
285 provided, no alignment is performed.
286
287size:
288 This sets the size of the entry. The contents will be padded out to
289 this size. If this is not provided, it will be set to the size of the
290 contents.
291
292pad-before:
293 Padding before the contents of the entry. Normally this is 0, meaning
294 that the contents start at the beginning of the entry. This can be
295 offset the entry contents a little. Defaults to 0.
296
297pad-after:
298 Padding after the contents of the entry. Normally this is 0, meaning
299 that the entry ends at the last byte of content (unless adjusted by
300 other properties). This allows room to be created in the image for
301 this entry to expand later. Defaults to 0.
302
303align-size:
304 This sets the alignment of the entry size. For example, to ensure
305 that the size of an entry is a multiple of 64 bytes, set this to 64.
306 If 'align-size' is not provided, no alignment is performed.
307
308align-end:
309 This sets the alignment of the end of an entry. Some entries require
310 that they end on an alignment boundary, regardless of where they
Simon Glass844e5b22018-06-01 09:38:22 -0600311 start. This does not move the start of the entry, so the contents of
312 the entry will still start at the beginning. But there may be padding
313 at the end. If 'align-end' is not provided, no alignment is performed.
Simon Glassbf7fd502016-11-25 20:15:51 -0700314
315filename:
316 For 'blob' types this provides the filename containing the binary to
317 put into the entry. If binman knows about the entry type (like
318 u-boot-bin), then there is no need to specify this.
319
320type:
321 Sets the type of an entry. This defaults to the entry name, but it is
322 possible to use any name, and then add (for example) 'type = "u-boot"'
323 to specify the type.
324
Simon Glass3ab95982018-08-01 15:22:37 -0600325offset-unset:
326 Indicates that the offset of this entry should not be set by placing
Simon Glass258fb0e2018-06-01 09:38:17 -0600327 it immediately after the entry before. Instead, is set by another
328 entry which knows where this entry should go. When this boolean
329 property is present, binman will give an error if another entry does
Simon Glass3ab95982018-08-01 15:22:37 -0600330 not set the offset (with the GetOffsets() method).
Simon Glass258fb0e2018-06-01 09:38:17 -0600331
Simon Glassdbf6be92018-08-01 15:22:42 -0600332image-pos:
333 This cannot be set on entry (or at least it is ignored if it is), but
334 with the -u option, binman will set it to the absolute image position
335 for each entry. This makes it easy to find out exactly where the entry
336 ended up in the image, regardless of parent sections, etc.
337
Simon Glassba64a0b2018-09-14 04:57:29 -0600338expand-size:
339 Expand the size of this entry to fit available space. This space is only
340 limited by the size of the image/section and the position of the next
341 entry.
Simon Glassbf7fd502016-11-25 20:15:51 -0700342
Simon Glass9c888cc2018-09-14 04:57:30 -0600343The attributes supported for images and sections are described below. Several
344are similar to those for entries.
Simon Glassbf7fd502016-11-25 20:15:51 -0700345
346size:
347 Sets the image size in bytes, for example 'size = <0x100000>' for a
348 1MB image.
349
Simon Glass9481c802019-04-25 21:58:39 -0600350offset:
351 This is similar to 'offset' in entries, setting the offset of a section
352 within the image or section containing it. The first byte of the section
353 is normally at offset 0. If 'offset' is not provided, binman sets it to
354 the end of the previous region, or the start of the image's entry area
355 (normally 0) if there is no previous region.
356
Simon Glassbf7fd502016-11-25 20:15:51 -0700357align-size:
358 This sets the alignment of the image size. For example, to ensure
359 that the image ends on a 512-byte boundary, use 'align-size = <512>'.
360 If 'align-size' is not provided, no alignment is performed.
361
362pad-before:
363 This sets the padding before the image entries. The first entry will
Simon Glass3ab95982018-08-01 15:22:37 -0600364 be positioned after the padding. This defaults to 0.
Simon Glassbf7fd502016-11-25 20:15:51 -0700365
366pad-after:
367 This sets the padding after the image entries. The padding will be
368 placed after the last entry. This defaults to 0.
369
370pad-byte:
371 This specifies the pad byte to use when padding in the image. It
372 defaults to 0. To use 0xff, you would add 'pad-byte = <0xff>'.
373
374filename:
375 This specifies the image filename. It defaults to 'image.bin'.
376
Simon Glass3ab95982018-08-01 15:22:37 -0600377sort-by-offset:
Simon Glassbf7fd502016-11-25 20:15:51 -0700378 This causes binman to reorder the entries as needed to make sure they
379 are in increasing positional order. This can be used when your entry
380 order may not match the positional order. A common situation is where
Simon Glass3ab95982018-08-01 15:22:37 -0600381 the 'offset' properties are set by CONFIG options, so their ordering is
Simon Glassbf7fd502016-11-25 20:15:51 -0700382 not known a priori.
383
384 This is a boolean property so needs no value. To enable it, add a
Simon Glass3ab95982018-08-01 15:22:37 -0600385 line 'sort-by-offset;' to your description.
Simon Glassbf7fd502016-11-25 20:15:51 -0700386
387multiple-images:
388 Normally only a single image is generated. To create more than one
389 image, put this property in the binman node. For example, this will
390 create image1.bin containing u-boot.bin, and image2.bin containing
391 both spl/u-boot-spl.bin and u-boot.bin:
392
393 binman {
394 multiple-images;
395 image1 {
396 u-boot {
397 };
398 };
399
400 image2 {
401 spl {
402 };
403 u-boot {
404 };
405 };
406 };
407
408end-at-4gb:
Simon Glass3ab95982018-08-01 15:22:37 -0600409 For x86 machines the ROM offsets start just before 4GB and extend
Simon Glassbf7fd502016-11-25 20:15:51 -0700410 up so that the image finished at the 4GB boundary. This boolean
411 option can be enabled to support this. The image size must be
412 provided so that binman knows when the image should start. For an
Simon Glass3ab95982018-08-01 15:22:37 -0600413 8MB ROM, the offset of the first entry would be 0xfff80000 with
Simon Glassbf7fd502016-11-25 20:15:51 -0700414 this option, instead of 0 without this option.
415
Jagdish Gediya94b57db2018-09-03 21:35:07 +0530416skip-at-start:
417 This property specifies the entry offset of the first entry.
418
419 For PowerPC mpc85xx based CPU, CONFIG_SYS_TEXT_BASE is the entry
420 offset of the first entry. It can be 0xeff40000 or 0xfff40000 for
421 nor flash boot, 0x201000 for sd boot etc.
422
423 'end-at-4gb' property is not applicable where CONFIG_SYS_TEXT_BASE +
424 Image size != 4gb.
Simon Glassbf7fd502016-11-25 20:15:51 -0700425
426Examples of the above options can be found in the tests. See the
427tools/binman/test directory.
428
Simon Glassdd57c132018-06-01 09:38:11 -0600429It is possible to have the same binary appear multiple times in the image,
430either by using a unit number suffix (u-boot@0, u-boot@1) or by using a
431different name for each and specifying the type with the 'type' attribute.
432
Simon Glassbf7fd502016-11-25 20:15:51 -0700433
Michael Heimpold383d2562018-08-22 22:01:24 +0200434Sections and hierachical images
Simon Glass18546952018-06-01 09:38:16 -0600435-------------------------------
436
437Sometimes it is convenient to split an image into several pieces, each of which
438contains its own set of binaries. An example is a flash device where part of
439the image is read-only and part is read-write. We can set up sections for each
440of these, and place binaries in them independently. The image is still produced
441as a single output file.
442
443This feature provides a way of creating hierarchical images. For example here
Simon Glass7ae5f312018-06-01 09:38:19 -0600444is an example image with two copies of U-Boot. One is read-only (ro), intended
445to be written only in the factory. Another is read-write (rw), so that it can be
Simon Glass18546952018-06-01 09:38:16 -0600446upgraded in the field. The sizes are fixed so that the ro/rw boundary is known
447and can be programmed:
448
449 binman {
450 section@0 {
451 read-only;
Simon Glassc8d48ef2018-06-01 09:38:21 -0600452 name-prefix = "ro-";
Simon Glass18546952018-06-01 09:38:16 -0600453 size = <0x100000>;
454 u-boot {
455 };
456 };
457 section@1 {
Simon Glassc8d48ef2018-06-01 09:38:21 -0600458 name-prefix = "rw-";
Simon Glass18546952018-06-01 09:38:16 -0600459 size = <0x100000>;
460 u-boot {
461 };
462 };
463 };
464
465This image could be placed into a SPI flash chip, with the protection boundary
466set at 1MB.
467
468A few special properties are provided for sections:
469
470read-only:
471 Indicates that this section is read-only. This has no impact on binman's
472 operation, but his property can be read at run time.
473
Simon Glassc8d48ef2018-06-01 09:38:21 -0600474name-prefix:
475 This string is prepended to all the names of the binaries in the
476 section. In the example above, the 'u-boot' binaries which actually be
477 renamed to 'ro-u-boot' and 'rw-u-boot'. This can be useful to
478 distinguish binaries with otherwise identical names.
479
Simon Glass18546952018-06-01 09:38:16 -0600480
Simon Glass5a5da7c2018-07-17 13:25:37 -0600481Entry Documentation
482-------------------
483
484For details on the various entry types supported by binman and how to use them,
485see README.entries. This is generated from the source code using:
486
487 binman -E >tools/binman/README.entries
488
489
Simon Glasse0e5df92018-09-14 04:57:31 -0600490Hashing Entries
491---------------
Simon Glasse0ff8552016-11-25 20:15:53 -0700492
Simon Glasse0e5df92018-09-14 04:57:31 -0600493It is possible to ask binman to hash the contents of an entry and write that
494value back to the device-tree node. For example:
Simon Glasse0ff8552016-11-25 20:15:53 -0700495
Simon Glasse0e5df92018-09-14 04:57:31 -0600496 binman {
497 u-boot {
498 hash {
499 algo = "sha256";
500 };
501 };
502 };
503
504Here, a new 'value' property will be written to the 'hash' node containing
505the hash of the 'u-boot' entry. Only SHA256 is supported at present. Whole
506sections can be hased if desired, by adding the 'hash' node to the section.
507
508The has value can be chcked at runtime by hashing the data actually read and
509comparing this has to the value in the device tree.
Simon Glasse0ff8552016-11-25 20:15:53 -0700510
511
Simon Glassbf7fd502016-11-25 20:15:51 -0700512Order of image creation
513-----------------------
514
515Image creation proceeds in the following order, for each entry in the image.
516
Simon Glass078ab1a2018-07-06 10:27:41 -06005171. AddMissingProperties() - binman can add calculated values to the device
Simon Glass3ab95982018-08-01 15:22:37 -0600518tree as part of its processing, for example the offset and size of each
Simon Glass078ab1a2018-07-06 10:27:41 -0600519entry. This method adds any properties associated with this, expanding the
520device tree as needed. These properties can have placeholder values which are
521set later by SetCalculatedProperties(). By that stage the size of sections
522cannot be changed (since it would cause the images to need to be repacked),
523but the correct values can be inserted.
524
5252. ProcessFdt() - process the device tree information as required by the
Simon Glassecab8972018-07-06 10:27:40 -0600526particular entry. This may involve adding or deleting properties. If the
527processing is complete, this method should return True. If the processing
528cannot complete because it needs the ProcessFdt() method of another entry to
529run first, this method should return False, in which case it will be called
530again later.
531
Simon Glass078ab1a2018-07-06 10:27:41 -06005323. GetEntryContents() - the contents of each entry are obtained, normally by
Simon Glassbf7fd502016-11-25 20:15:51 -0700533reading from a file. This calls the Entry.ObtainContents() to read the
534contents. The default version of Entry.ObtainContents() calls
535Entry.GetDefaultFilename() and then reads that file. So a common mechanism
536to select a file to read is to override that function in the subclass. The
537functions must return True when they have read the contents. Binman will
538retry calling the functions a few times if False is returned, allowing
539dependencies between the contents of different entries.
540
Simon Glass3ab95982018-08-01 15:22:37 -06005414. GetEntryOffsets() - calls Entry.GetOffsets() for each entry. This can
Simon Glassbf7fd502016-11-25 20:15:51 -0700542return a dict containing entries that need updating. The key should be the
Simon Glass3ab95982018-08-01 15:22:37 -0600543entry name and the value is a tuple (offset, size). This allows an entry to
544provide the offset and size for other entries. The default implementation
545of GetEntryOffsets() returns {}.
Simon Glassbf7fd502016-11-25 20:15:51 -0700546
Simon Glass3ab95982018-08-01 15:22:37 -06005475. PackEntries() - calls Entry.Pack() which figures out the offset and
548size of an entry. The 'current' image offset is passed in, and the function
549returns the offset immediately after the entry being packed. The default
Simon Glassbf7fd502016-11-25 20:15:51 -0700550implementation of Pack() is usually sufficient.
551
Simon Glass078ab1a2018-07-06 10:27:41 -06005526. CheckSize() - checks that the contents of all the entries fits within
Simon Glassbf7fd502016-11-25 20:15:51 -0700553the image size. If the image does not have a defined size, the size is set
554large enough to hold all the entries.
555
Simon Glass078ab1a2018-07-06 10:27:41 -06005567. CheckEntries() - checks that the entries do not overlap, nor extend
Simon Glassbf7fd502016-11-25 20:15:51 -0700557outside the image.
558
Simon Glass078ab1a2018-07-06 10:27:41 -06005598. SetCalculatedProperties() - update any calculated properties in the device
Simon Glass3ab95982018-08-01 15:22:37 -0600560tree. This sets the correct 'offset' and 'size' vaues, for example.
Simon Glass078ab1a2018-07-06 10:27:41 -0600561
5629. ProcessEntryContents() - this calls Entry.ProcessContents() on each entry.
Simon Glassbf7fd502016-11-25 20:15:51 -0700563The default implementatoin does nothing. This can be overriden to adjust the
564contents of an entry in some way. For example, it would be possible to create
565an entry containing a hash of the contents of some other entries. At this
Simon Glass3ab95982018-08-01 15:22:37 -0600566stage the offset and size of entries should not be adjusted.
Simon Glassbf7fd502016-11-25 20:15:51 -0700567
Simon Glass078ab1a2018-07-06 10:27:41 -060056810. WriteSymbols() - write the value of symbols into the U-Boot SPL binary.
Simon Glass3ab95982018-08-01 15:22:37 -0600569See 'Access to binman entry offsets at run time' below for a description of
Simon Glass0a4357c2018-07-06 10:27:39 -0600570what happens in this stage.
Simon Glass39c15022017-11-13 18:55:05 -0700571
Simon Glass078ab1a2018-07-06 10:27:41 -060057211. BuildImage() - builds the image and writes it to a file. This is the final
Simon Glassbf7fd502016-11-25 20:15:51 -0700573step.
574
575
Simon Glass6d427c62016-11-25 20:15:59 -0700576Automatic .dtsi inclusion
577-------------------------
578
579It is sometimes inconvenient to add a 'binman' node to the .dts file for each
580board. This can be done by using #include to bring in a common file. Another
581approach supported by the U-Boot build system is to automatically include
582a common header. You can then put the binman node (and anything else that is
583specific to U-Boot, such as u-boot,dm-pre-reloc properies) in that header
584file.
585
586Binman will search for the following files in arch/<arch>/dts:
587
588 <dts>-u-boot.dtsi where <dts> is the base name of the .dts file
589 <CONFIG_SYS_SOC>-u-boot.dtsi
590 <CONFIG_SYS_CPU>-u-boot.dtsi
591 <CONFIG_SYS_VENDOR>-u-boot.dtsi
592 u-boot.dtsi
593
594U-Boot will only use the first one that it finds. If you need to include a
595more general file you can do that from the more specific file using #include.
596If you are having trouble figuring out what is going on, you can uncomment
597the 'warning' line in scripts/Makefile.lib to see what it has found:
598
599 # Uncomment for debugging
Simon Glass511fd0b2017-11-12 21:52:05 -0700600 # This shows all the files that were considered and the one that we chose.
601 # u_boot_dtsi_options_debug = $(u_boot_dtsi_options_raw)
Simon Glass6d427c62016-11-25 20:15:59 -0700602
603
Simon Glassdbf6be92018-08-01 15:22:42 -0600604Access to binman entry offsets at run time (symbols)
605----------------------------------------------------
Simon Glass39c15022017-11-13 18:55:05 -0700606
607Binman assembles images and determines where each entry is placed in the image.
608This information may be useful to U-Boot at run time. For example, in SPL it
609is useful to be able to find the location of U-Boot so that it can be executed
610when SPL is finished.
611
612Binman allows you to declare symbols in the SPL image which are filled in
613with their correct values during the build. For example:
614
Simon Glass3ab95982018-08-01 15:22:37 -0600615 binman_sym_declare(ulong, u_boot_any, offset);
Simon Glass39c15022017-11-13 18:55:05 -0700616
Simon Glass3ab95982018-08-01 15:22:37 -0600617declares a ulong value which will be assigned to the offset of any U-Boot
Simon Glass39c15022017-11-13 18:55:05 -0700618image (u-boot.bin, u-boot.img, u-boot-nodtb.bin) that is present in the image.
619You can access this value with something like:
620
Simon Glass3ab95982018-08-01 15:22:37 -0600621 ulong u_boot_offset = binman_sym(ulong, u_boot_any, offset);
Simon Glass39c15022017-11-13 18:55:05 -0700622
Simon Glass3ab95982018-08-01 15:22:37 -0600623Thus u_boot_offset will be set to the offset of U-Boot in memory, assuming that
Simon Glass39c15022017-11-13 18:55:05 -0700624the whole image has been loaded, or is available in flash. You can then jump to
625that address to start U-Boot.
626
627At present this feature is only supported in SPL. In principle it is possible
628to fill in such symbols in U-Boot proper, as well.
629
630
Simon Glassdbf6be92018-08-01 15:22:42 -0600631Access to binman entry offsets at run time (fdt)
632------------------------------------------------
633
634Binman can update the U-Boot FDT to include the final position and size of
635each entry in the images it processes. The option to enable this is -u and it
636causes binman to make sure that the 'offset', 'image-pos' and 'size' properties
637are set correctly for every entry. Since it is not necessary to specify these in
638the image definition, binman calculates the final values and writes these to
639the device tree. These can be used by U-Boot at run-time to find the location
640of each entry.
641
642
Simon Glass83d73c22018-09-14 04:57:26 -0600643Compression
644-----------
645
646Binman support compression for 'blob' entries (those of type 'blob' and
647derivatives). To enable this for an entry, add a 'compression' property:
648
649 blob {
650 filename = "datafile";
651 compression = "lz4";
652 };
653
654The entry will then contain the compressed data, using the 'lz4' compression
655algorithm. Currently this is the only one that is supported.
656
657
658
Simon Glass3b0c3822018-06-01 09:38:20 -0600659Map files
660---------
661
662The -m option causes binman to output a .map file for each image that it
Simon Glass3ab95982018-08-01 15:22:37 -0600663generates. This shows the offset and size of each entry. For example:
Simon Glass3b0c3822018-06-01 09:38:20 -0600664
Simon Glass3ab95982018-08-01 15:22:37 -0600665 Offset Size Name
Simon Glass8122f392018-07-17 13:25:28 -0600666 00000000 00000028 main-section
667 00000000 00000010 section@0
668 00000000 00000004 u-boot
669 00000010 00000010 section@1
670 00000000 00000004 u-boot
Simon Glass3b0c3822018-06-01 09:38:20 -0600671
672This shows a hierarchical image with two sections, each with a single entry. The
Simon Glass3ab95982018-08-01 15:22:37 -0600673offsets of the sections are absolute hex byte offsets within the image. The
674offsets of the entries are relative to their respective sections. The size of
Simon Glass3b0c3822018-06-01 09:38:20 -0600675each entry is also shown, in bytes (hex). The indentation shows the entries
676nested inside their sections.
677
678
Simon Glass53af22a2018-07-17 13:25:32 -0600679Passing command-line arguments to entries
680-----------------------------------------
681
682Sometimes it is useful to pass binman the value of an entry property from the
683command line. For example some entries need access to files and it is not
684always convenient to put these filenames in the image definition (device tree).
685
686The-a option supports this:
687
688 -a<prop>=<value>
689
690where
691
692 <prop> is the property to set
693 <value> is the value to set it to
694
695Not all properties can be provided this way. Only some entries support it,
696typically for filenames.
697
698
Simon Glassc7d80352019-07-08 13:18:28 -0600699External tools
700--------------
701
702Binman can make use of external command-line tools to handle processing of
703entry contents or to generate entry contents. These tools are executed using
704the 'tools' module's Run() method. The tools generally must exist on the PATH,
705but the --toolpath option can be used to specify additional search paths to
706use. This option can be specified multiple times to add more than one path.
707
708
Simon Glass6d427c62016-11-25 20:15:59 -0700709Code coverage
710-------------
711
712Binman is a critical tool and is designed to be very testable. Entry
713implementations target 100% test coverage. Run 'binman -T' to check this.
714
715To enable Python test coverage on Debian-type distributions (e.g. Ubuntu):
716
Simon Glass45f449b2019-07-08 13:18:26 -0600717 $ sudo apt-get install python-coverage python3-coverage python-pytest
Simon Glass6d427c62016-11-25 20:15:59 -0700718
719
Simon Glass55660d02019-05-17 22:00:52 -0600720Concurrent tests
721----------------
722
723Binman tries to run tests concurrently. This means that the tests make use of
724all available CPUs to run.
725
726 To enable this:
727
728 $ sudo apt-get install python-subunit python3-subunit
729
730Use '-P 1' to disable this. It is automatically disabled when code coverage is
731being used (-T) since they are incompatible.
732
733
Simon Glassd5164a72019-07-08 13:18:49 -0600734Debugging tests
735---------------
736
737Sometimes when debugging tests it is useful to keep the input and output
738directories so they can be examined later. Use -X or --test-preserve-dirs for
739this.
740
741
Simon Glassbf7fd502016-11-25 20:15:51 -0700742Advanced Features / Technical docs
743----------------------------------
744
745The behaviour of entries is defined by the Entry class. All other entries are
746a subclass of this. An important subclass is Entry_blob which takes binary
747data from a file and places it in the entry. In fact most entry types are
748subclasses of Entry_blob.
749
750Each entry type is a separate file in the tools/binman/etype directory. Each
751file contains a class called Entry_<type> where <type> is the entry type.
752New entry types can be supported by adding new files in that directory.
753These will automatically be detected by binman when needed.
754
755Entry properties are documented in entry.py. The entry subclasses are free
756to change the values of properties to support special behaviour. For example,
757when Entry_blob loads a file, it sets content_size to the size of the file.
758Entry classes can adjust other entries. For example, an entry that knows
Simon Glass3ab95982018-08-01 15:22:37 -0600759where other entries should be positioned can set up those entries' offsets
Simon Glassbf7fd502016-11-25 20:15:51 -0700760so they don't need to be set in the binman decription. It can also adjust
761entry contents.
762
763Most of the time such essoteric behaviour is not needed, but it can be
764essential for complex images.
765
Simon Glass3ed0de32017-12-24 12:12:07 -0700766If you need to specify a particular device-tree compiler to use, you can define
767the DTC environment variable. This can be useful when the system dtc is too
768old.
769
Simon Glassa3c00552018-11-06 15:21:31 -0700770To enable a full backtrace and other debugging features in binman, pass
771BINMAN_DEBUG=1 to your build:
772
773 make sandbox_defconfig
774 make BINMAN_DEBUG=1
775
Simon Glassbf7fd502016-11-25 20:15:51 -0700776
777History / Credits
778-----------------
779
780Binman takes a lot of inspiration from a Chrome OS tool called
781'cros_bundle_firmware', which I wrote some years ago. That tool was based on
782a reasonably simple and sound design but has expanded greatly over the
783years. In particular its handling of x86 images is convoluted.
784
Simon Glass7ae5f312018-06-01 09:38:19 -0600785Quite a few lessons have been learned which are hopefully applied here.
Simon Glassbf7fd502016-11-25 20:15:51 -0700786
787
788Design notes
789------------
790
791On the face of it, a tool to create firmware images should be fairly simple:
792just find all the input binaries and place them at the right place in the
793image. The difficulty comes from the wide variety of input types (simple
794flat binaries containing code, packaged data with various headers), packing
795requirments (alignment, spacing, device boundaries) and other required
796features such as hierarchical images.
797
798The design challenge is to make it easy to create simple images, while
799allowing the more complex cases to be supported. For example, for most
800images we don't much care exactly where each binary ends up, so we should
801not have to specify that unnecessarily.
802
803New entry types should aim to provide simple usage where possible. If new
804core features are needed, they can be added in the Entry base class.
805
806
807To do
808-----
809
810Some ideas:
Simon Glassbf7fd502016-11-25 20:15:51 -0700811- Use of-platdata to make the information available to code that is unable
812 to use device tree (such as a very small SPL image)
Simon Glassbf7fd502016-11-25 20:15:51 -0700813- Allow easy building of images by specifying just the board name
Simon Glass16b8d6b2018-07-06 10:27:42 -0600814- Produce a full Python binding for libfdt (for upstream). This is nearing
815 completion but some work remains
Simon Glassbf7fd502016-11-25 20:15:51 -0700816- Add an option to decode an image into the constituent binaries
Simon Glassbf7fd502016-11-25 20:15:51 -0700817- Support building an image for a board (-b) more completely, with a
818 configurable build directory
819- Consider making binman work with buildman, although if it is used in the
820 Makefile, this will be automatic
Simon Glassbf7fd502016-11-25 20:15:51 -0700821
822--
823Simon Glass <sjg@chromium.org>
8247/7/2016