1 # SPDX-License-Identifier: GPL-2.0+
2 # Copyright (c) 2016 Google, Inc
3 # Written by Simon Glass <sjg@chromium.org>
5 # Creates binary images from input files controlled by a description
8 from __future__ import print_function
10 from collections import OrderedDict
17 from image import Image
21 # List of images we plan to create
22 # Make this global so that it can be referenced from tests
23 images = OrderedDict()
25 def _ReadImageDesc(binman_node):
26 """Read the image descriptions from the /binman node
28 This normally produces a single Image object called 'image'. But if
29 multiple images are present, they will all be returned.
32 binman_node: Node object of the /binman node
34 OrderedDict of Image objects, each of which describes an image
36 images = OrderedDict()
37 if 'multiple-images' in binman_node.props:
38 for node in binman_node.subnodes:
39 images[node.name] = Image(node.name, node)
41 images['image'] = Image('image', binman_node)
44 def _FindBinmanNode(dtb):
45 """Find the 'binman' node in the device tree
48 dtb: Fdt object to scan
50 Node object of /binman node, or None if not found
52 for node in dtb.GetRoot().subnodes:
53 if node.name == 'binman':
57 def WriteEntryDocs(modules, test_missing=None):
58 """Write out documentation for all entries
61 modules: List of Module objects to get docs for
62 test_missing: Used for testing only, to force an entry's documeentation
63 to show as missing even if it is present. Should be set to None in
66 from entry import Entry
67 Entry.WriteDocs(modules, test_missing)
69 def Binman(options, args):
70 """The main control code for binman
72 This assumes that help and test options have already been dealt with. It
73 deals with the core task of building images.
76 options: Command line options object
77 args: Command line arguments (list of strings)
82 pager = os.getenv('PAGER')
85 fname = os.path.join(os.path.dirname(os.path.realpath(sys.argv[0])),
87 command.Run(pager, fname)
90 # Try to figure out which device tree contains our image description
92 dtb_fname = options.dt
96 raise ValueError('Must provide a board to process (use -b <board>)')
97 board_pathname = os.path.join(options.build_dir, board)
98 dtb_fname = os.path.join(board_pathname, 'u-boot.dtb')
100 options.indir = ['.']
101 options.indir.append(board_pathname)
104 # Import these here in case libfdt.py is not available, in which case
105 # the above help option still works.
109 tout.Init(options.verbosity)
110 elf.debug = options.debug
111 state.use_fake_dtb = options.fake_dtb
113 tools.SetInputDirs(options.indir)
114 tools.PrepareOutputDir(options.outdir, options.preserve)
115 state.SetEntryArgs(options.entry_arg)
117 # Get the device tree ready by compiling it and copying the compiled
118 # output into a file in our output directly. Then scan it for use
120 dtb_fname = fdt_util.EnsureCompiled(dtb_fname)
121 fname = tools.GetOutputFilename('u-boot.dtb.out')
122 tools.WriteFile(fname, tools.ReadFile(dtb_fname))
123 dtb = fdt.FdtScan(fname)
125 node = _FindBinmanNode(dtb)
127 raise ValueError("Device tree '%s' does not have a 'binman' "
130 images = _ReadImageDesc(node)
134 new_images = OrderedDict()
135 for name, image in images.items():
136 if name in options.image:
137 new_images[name] = image
141 if skip and options.verbosity >= 2:
142 print('Skipping images: %s' % ', '.join(skip))
144 state.Prepare(images, dtb)
146 # Prepare the device tree by making sure that any missing
147 # properties are added (e.g. 'pos' and 'size'). The values of these
148 # may not be correct yet, but we add placeholders so that the
149 # size of the device tree is correct. Later, in
150 # SetCalculatedProperties() we will insert the correct values
151 # without changing the device-tree size, thus ensuring that our
152 # entry offsets remain the same.
153 for image in images.values():
154 image.ExpandEntries()
155 if options.update_fdt:
156 image.AddMissingProperties()
157 image.ProcessFdt(dtb)
159 for dtb_item in state.GetFdts():
160 dtb_item.Sync(auto_resize=True)
164 for image in images.values():
165 # Perform all steps for this image, including checking and
166 # writing it. This means that errors found with a later
167 # image will be reported after earlier images are already
168 # completed and written, but that does not seem important.
169 image.GetEntryContents()
170 image.GetEntryOffsets()
175 except Exception as e:
177 fname = image.WriteMap()
178 print("Wrote map file '%s' to show errors" % fname)
181 if options.update_fdt:
182 image.SetCalculatedProperties()
183 for dtb_item in state.GetFdts():
185 image.ProcessEntryContents()
191 # Write the updated FDTs to our output files
192 for dtb_item in state.GetFdts():
193 tools.WriteFile(dtb_item._fname, dtb_item.GetContents())
196 tools.FinaliseOutputDir()