1 # SPDX-License-Identifier: GPL-2.0+
2 # Copyright (c) 2016 Google, Inc
4 # Base class for all entries
7 from collections import namedtuple
12 from dtoc import fdt_util
13 from patman import tools
14 from patman.tools import ToHex, ToHexSize
15 from patman import tout
20 # An argument which can be passed to entries on the command line, in lieu of
21 # device-tree properties.
22 EntryArg = namedtuple('EntryArg', ['name', 'datatype'])
24 # Information about an entry for use when displaying summaries
25 EntryInfo = namedtuple('EntryInfo', ['indent', 'name', 'etype', 'size',
26 'image_pos', 'uncomp_size', 'offset',
30 """An Entry in the section
32 An entry corresponds to a single node in the device-tree description
33 of the section. Each entry ends up being a part of the final section.
34 Entries can be placed either right next to each other, or with padding
35 between them. The type of the entry determines the data that is in it.
37 This class is not used by itself. All entry objects are subclasses of
41 section: Section object containing this entry
42 node: The node that created this entry
43 offset: Offset of entry within the section, None if not known yet (in
44 which case it will be calculated by Pack())
45 size: Entry size in bytes, None if not known
46 pre_reset_size: size as it was before ResetForPack(). This allows us to
47 keep track of the size we started with and detect size changes
48 uncomp_size: Size of uncompressed data in bytes, if the entry is
50 contents_size: Size of contents in bytes, 0 by default
51 align: Entry start offset alignment relative to the start of the
52 containing section, or None
53 align_size: Entry size alignment, or None
54 align_end: Entry end offset alignment relative to the start of the
55 containing section, or None
56 pad_before: Number of pad bytes before the contents when it is placed
57 in the containing section, 0 if none. The pad bytes become part of
59 pad_after: Number of pad bytes after the contents when it is placed in
60 the containing section, 0 if none. The pad bytes become part of
62 data: Contents of entry (string of bytes). This does not include
63 padding created by pad_before or pad_after. If the entry is
64 compressed, this contains the compressed data.
65 uncomp_data: Original uncompressed data, if this entry is compressed,
67 compress: Compression algoithm used (e.g. 'lz4'), 'none' if none
68 orig_offset: Original offset value read from node
69 orig_size: Original size value read from node
70 missing: True if this entry is missing its contents
71 allow_missing: Allow children of this entry to be missing (used by
72 subclasses such as Entry_section)
73 external: True if this entry contains an external binary blob
75 def __init__(self, section, etype, node, name_prefix=''):
76 # Put this here to allow entry-docs and help to work without libfdt
78 from binman import state
80 self.section = section
83 self.name = node and (name_prefix + node.name) or 'none'
86 self.pre_reset_size = None
87 self.uncomp_size = None
89 self.uncomp_data = None
90 self.contents_size = 0
92 self.align_size = None
96 self.offset_unset = False
98 self._expand_size = False
99 self.compress = 'none'
101 self.external = False
102 self.allow_missing = False
105 def Lookup(node_path, etype, expanded):
106 """Look up the entry class for a node.
109 node_node: Path name of Node object containing information about
110 the entry to create (used for errors)
111 etype: Entry type to use
112 expanded: Use the expanded version of etype
115 The entry class object if found, else None if not found and expanded
119 ValueError if expanded is False and the class is not found
121 # Convert something like 'u-boot@0' to 'u_boot' since we are only
122 # interested in the type.
123 module_name = etype.replace('-', '_')
125 if '@' in module_name:
126 module_name = module_name.split('@')[0]
128 module_name += '_expanded'
129 module = modules.get(module_name)
131 # Also allow entry-type modules to be brought in from the etype directory.
133 # Import the module if we have not already done so.
136 module = importlib.import_module('binman.etype.' + module_name)
137 except ImportError as e:
140 raise ValueError("Unknown entry type '%s' in node '%s' (expected etype/%s.py, error '%s'" %
141 (etype, node_path, module_name, e))
142 modules[module_name] = module
144 # Look up the expected class name
145 return getattr(module, 'Entry_%s' % module_name)
148 def Create(section, node, etype=None, expanded=False):
149 """Create a new entry for a node.
152 section: Section object containing this node
153 node: Node object containing information about the entry to
155 etype: Entry type to use, or None to work it out (used for tests)
156 expanded: True to use expanded versions of entries, where available
159 A new Entry object of the correct type (a subclass of Entry)
162 etype = fdt_util.GetString(node, 'type', node.name)
163 obj = Entry.Lookup(node.path, etype, expanded)
165 # Check whether to use the expanded entry
166 new_etype = etype + '-expanded'
167 can_expand = not fdt_util.GetBool(node, 'no-expanded')
168 if can_expand and obj.UseExpanded(node, etype, new_etype):
173 obj = Entry.Lookup(node.path, etype, False)
175 # Call its constructor to get the object we want.
176 return obj(section, etype, node)
179 """Read entry information from the node
181 This must be called as the first thing after the Entry is created.
183 This reads all the fields we recognise from the node, ready for use.
185 if 'pos' in self._node.props:
186 self.Raise("Please use 'offset' instead of 'pos'")
187 self.offset = fdt_util.GetInt(self._node, 'offset')
188 self.size = fdt_util.GetInt(self._node, 'size')
189 self.orig_offset = fdt_util.GetInt(self._node, 'orig-offset')
190 self.orig_size = fdt_util.GetInt(self._node, 'orig-size')
191 if self.GetImage().copy_to_orig:
192 self.orig_offset = self.offset
193 self.orig_size = self.size
195 # These should not be set in input files, but are set in an FDT map,
196 # which is also read by this code.
197 self.image_pos = fdt_util.GetInt(self._node, 'image-pos')
198 self.uncomp_size = fdt_util.GetInt(self._node, 'uncomp-size')
200 self.align = fdt_util.GetInt(self._node, 'align')
201 if tools.NotPowerOfTwo(self.align):
202 raise ValueError("Node '%s': Alignment %s must be a power of two" %
203 (self._node.path, self.align))
204 self.pad_before = fdt_util.GetInt(self._node, 'pad-before', 0)
205 self.pad_after = fdt_util.GetInt(self._node, 'pad-after', 0)
206 self.align_size = fdt_util.GetInt(self._node, 'align-size')
207 if tools.NotPowerOfTwo(self.align_size):
208 self.Raise("Alignment size %s must be a power of two" %
210 self.align_end = fdt_util.GetInt(self._node, 'align-end')
211 self.offset_unset = fdt_util.GetBool(self._node, 'offset-unset')
212 self.expand_size = fdt_util.GetBool(self._node, 'expand-size')
213 self.missing_msg = fdt_util.GetString(self._node, 'missing-msg')
215 # This is only supported by blobs and sections at present
216 self.compress = fdt_util.GetString(self._node, 'compress', 'none')
218 def GetDefaultFilename(self):
222 """Get the device trees used by this entry
225 Empty dict, if this entry is not a .dtb, otherwise:
227 key: Filename from this entry (without the path)
229 Entry object for this dtb
230 Filename of file containing this dtb
234 def ExpandEntries(self):
235 """Expand out entries which produce other entries
237 Some entries generate subnodes automatically, from which sub-entries
238 are then created. This method allows those to be added to the binman
239 definition for the current image. An entry which implements this method
240 should call state.AddSubnode() to add a subnode and can add properties
241 with state.AddString(), etc.
243 An example is 'files', which produces a section containing a list of
248 def AddMissingProperties(self, have_image_pos):
249 """Add new properties to the device tree as needed for this entry
252 have_image_pos: True if this entry has an image position. This can
253 be False if its parent section is compressed, since compression
254 groups all entries together into a compressed block of data,
255 obscuring the start of each individual child entry
257 for prop in ['offset', 'size']:
258 if not prop in self._node.props:
259 state.AddZeroProp(self._node, prop)
260 if have_image_pos and 'image-pos' not in self._node.props:
261 state.AddZeroProp(self._node, 'image-pos')
262 if self.GetImage().allow_repack:
263 if self.orig_offset is not None:
264 state.AddZeroProp(self._node, 'orig-offset', True)
265 if self.orig_size is not None:
266 state.AddZeroProp(self._node, 'orig-size', True)
268 if self.compress != 'none':
269 state.AddZeroProp(self._node, 'uncomp-size')
270 err = state.CheckAddHashProp(self._node)
274 def SetCalculatedProperties(self):
275 """Set the value of device-tree properties calculated by binman"""
276 state.SetInt(self._node, 'offset', self.offset)
277 state.SetInt(self._node, 'size', self.size)
278 base = self.section.GetRootSkipAtStart() if self.section else 0
279 if self.image_pos is not None:
280 state.SetInt(self._node, 'image-pos', self.image_pos - base)
281 if self.GetImage().allow_repack:
282 if self.orig_offset is not None:
283 state.SetInt(self._node, 'orig-offset', self.orig_offset, True)
284 if self.orig_size is not None:
285 state.SetInt(self._node, 'orig-size', self.orig_size, True)
286 if self.uncomp_size is not None:
287 state.SetInt(self._node, 'uncomp-size', self.uncomp_size)
288 state.CheckSetHashValue(self._node, self.GetData)
290 def ProcessFdt(self, fdt):
291 """Allow entries to adjust the device tree
293 Some entries need to adjust the device tree for their purposes. This
294 may involve adding or deleting properties.
297 True if processing is complete
298 False if processing could not be completed due to a dependency.
299 This will cause the entry to be retried after others have been
304 def SetPrefix(self, prefix):
305 """Set the name prefix for a node
308 prefix: Prefix to set, or '' to not use a prefix
311 self.name = prefix + self.name
313 def SetContents(self, data):
314 """Set the contents of an entry
316 This sets both the data and content_size properties
319 data: Data to set to the contents (bytes)
322 self.contents_size = len(self.data)
324 def ProcessContentsUpdate(self, data):
325 """Update the contents of an entry, after the size is fixed
327 This checks that the new data is the same size as the old. If the size
328 has changed, this triggers a re-run of the packing algorithm.
331 data: Data to set to the contents (bytes)
334 ValueError if the new data size is not the same as the old
338 if state.AllowEntryExpansion() and new_size > self.contents_size:
339 # self.data will indicate the new size needed
341 elif state.AllowEntryContraction() and new_size < self.contents_size:
344 # If not allowed to change, try to deal with it or give up
346 if new_size > self.contents_size:
347 self.Raise('Cannot update entry size from %d to %d' %
348 (self.contents_size, new_size))
350 # Don't let the data shrink. Pad it if necessary
351 if size_ok and new_size < self.contents_size:
352 data += tools.GetBytes(0, self.contents_size - new_size)
355 tout.Debug("Entry '%s' size change from %s to %s" % (
356 self._node.path, ToHex(self.contents_size),
358 self.SetContents(data)
361 def ObtainContents(self):
362 """Figure out the contents of an entry.
365 True if the contents were found, False if another call is needed
366 after the other entries are processed.
368 # No contents by default: subclasses can implement this
371 def ResetForPack(self):
372 """Reset offset/size fields so that packing can be done again"""
373 self.Detail('ResetForPack: offset %s->%s, size %s->%s' %
374 (ToHex(self.offset), ToHex(self.orig_offset),
375 ToHex(self.size), ToHex(self.orig_size)))
376 self.pre_reset_size = self.size
377 self.offset = self.orig_offset
378 self.size = self.orig_size
380 def Pack(self, offset):
381 """Figure out how to pack the entry into the section
383 Most of the time the entries are not fully specified. There may be
384 an alignment but no size. In that case we take the size from the
385 contents of the entry.
387 If an entry has no hard-coded offset, it will be placed at @offset.
389 Once this function is complete, both the offset and size of the
393 Current section offset pointer
396 New section offset pointer (after this entry)
398 self.Detail('Packing: offset=%s, size=%s, content_size=%x' %
399 (ToHex(self.offset), ToHex(self.size),
401 if self.offset is None:
402 if self.offset_unset:
403 self.Raise('No offset set with offset-unset: should another '
404 'entry provide this correct offset?')
405 self.offset = tools.Align(offset, self.align)
406 needed = self.pad_before + self.contents_size + self.pad_after
407 needed = tools.Align(needed, self.align_size)
411 new_offset = self.offset + size
412 aligned_offset = tools.Align(new_offset, self.align_end)
413 if aligned_offset != new_offset:
414 size = aligned_offset - self.offset
415 new_offset = aligned_offset
420 if self.size < needed:
421 self.Raise("Entry contents size is %#x (%d) but entry size is "
422 "%#x (%d)" % (needed, needed, self.size, self.size))
423 # Check that the alignment is correct. It could be wrong if the
424 # and offset or size values were provided (i.e. not calculated), but
425 # conflict with the provided alignment values
426 if self.size != tools.Align(self.size, self.align_size):
427 self.Raise("Size %#x (%d) does not match align-size %#x (%d)" %
428 (self.size, self.size, self.align_size, self.align_size))
429 if self.offset != tools.Align(self.offset, self.align):
430 self.Raise("Offset %#x (%d) does not match align %#x (%d)" %
431 (self.offset, self.offset, self.align, self.align))
432 self.Detail(' - packed: offset=%#x, size=%#x, content_size=%#x, next_offset=%x' %
433 (self.offset, self.size, self.contents_size, new_offset))
437 def Raise(self, msg):
438 """Convenience function to raise an error referencing a node"""
439 raise ValueError("Node '%s': %s" % (self._node.path, msg))
442 """Convenience function to log info referencing a node"""
443 tag = "Info '%s'" % self._node.path
444 tout.Detail('%30s: %s' % (tag, msg))
446 def Detail(self, msg):
447 """Convenience function to log detail referencing a node"""
448 tag = "Node '%s'" % self._node.path
449 tout.Detail('%30s: %s' % (tag, msg))
451 def GetEntryArgsOrProps(self, props, required=False):
452 """Return the values of a set of properties
455 props: List of EntryArg objects
458 ValueError if a property is not found
463 python_prop = prop.name.replace('-', '_')
464 if hasattr(self, python_prop):
465 value = getattr(self, python_prop)
469 value = self.GetArg(prop.name, prop.datatype)
470 if value is None and required:
471 missing.append(prop.name)
474 self.GetImage().MissingArgs(self, missing)
478 """Get the path of a node
481 Full path of the node for this entry
483 return self._node.path
486 """Get the contents of an entry
489 bytes content of the entry, excluding any padding. If the entry is
490 compressed, the compressed data is returned
492 self.Detail('GetData: size %s' % ToHexSize(self.data))
495 def GetPaddedData(self, data=None):
496 """Get the data for an entry including any padding
498 Gets the entry data and uses its section's pad-byte value to add padding
499 before and after as defined by the pad-before and pad-after properties.
501 This does not consider alignment.
504 Contents of the entry along with any pad bytes before and
508 data = self.GetData()
509 return self.section.GetPaddedDataForEntry(self, data)
511 def GetOffsets(self):
512 """Get the offsets for siblings
514 Some entry types can contain information about the position or size of
515 other entries. An example of this is the Intel Flash Descriptor, which
516 knows where the Intel Management Engine section should go.
518 If this entry knows about the position of other entries, it can specify
519 this by returning values here
524 value: List containing position and size of the given entry
525 type. Either can be None if not known
529 def SetOffsetSize(self, offset, size):
530 """Set the offset and/or size of an entry
533 offset: New offset, or None to leave alone
534 size: New size, or None to leave alone
536 if offset is not None:
541 def SetImagePos(self, image_pos):
542 """Set the position in the image
545 image_pos: Position of this entry in the image
547 self.image_pos = image_pos + self.offset
549 def ProcessContents(self):
550 """Do any post-packing updates of entry contents
552 This function should call ProcessContentsUpdate() to update the entry
553 contents, if necessary, returning its return value here.
556 data: Data to set to the contents (bytes)
559 True if the new data size is OK, False if expansion is needed
562 ValueError if the new data size is not the same as the old and
563 state.AllowEntryExpansion() is False
567 def WriteSymbols(self, section):
568 """Write symbol values into binary files for access at run time
571 section: Section containing the entry
575 def CheckEntries(self):
576 """Check that the entry offsets are correct
578 This is used for entries which have extra offset requirements (other
579 than having to be fully inside their section). Sub-classes can implement
580 this function and raise if there is a problem.
588 return '%08x' % value
591 def WriteMapLine(fd, indent, name, offset, size, image_pos):
592 print('%s %s%s %s %s' % (Entry.GetStr(image_pos), ' ' * indent,
593 Entry.GetStr(offset), Entry.GetStr(size),
596 def WriteMap(self, fd, indent):
597 """Write a map of the entry to a .map file
600 fd: File to write the map to
601 indent: Curent indent level of map (0=none, 1=one level, etc.)
603 self.WriteMapLine(fd, indent, self.name, self.offset, self.size,
606 def GetEntries(self):
607 """Return a list of entries contained by this entry
610 List of entries, or None if none. A normal entry has no entries
611 within it so will return None
615 def GetArg(self, name, datatype=str):
616 """Get the value of an entry argument or device-tree-node property
618 Some node properties can be provided as arguments to binman. First check
619 the entry arguments, and fall back to the device tree if not found
623 datatype: Data type (str or int)
626 Value of argument as a string or int, or None if no value
629 ValueError if the argument cannot be converted to in
631 value = state.GetEntryArg(name)
632 if value is not None:
637 self.Raise("Cannot convert entry arg '%s' (value '%s') to integer" %
639 elif datatype == str:
642 raise ValueError("GetArg() internal error: Unknown data type '%s'" %
645 value = fdt_util.GetDatatype(self._node, name, datatype)
649 def WriteDocs(modules, test_missing=None):
650 """Write out documentation about the various entry types to stdout
653 modules: List of modules to include
654 test_missing: Used for testing. This is a module to report
657 print('''Binman Entry Documentation
658 ===========================
660 This file describes the entry types supported by binman. These entry types can
661 be placed in an image one by one to build up a final firmware image. It is
662 fairly easy to create new entry types. Just add a new file to the 'etype'
663 directory. You can use the existing entries as examples.
665 Note that some entries are subclasses of others, using and extending their
666 features to produce new behaviours.
670 modules = sorted(modules)
672 # Don't show the test entry
673 if '_testing' in modules:
674 modules.remove('_testing')
677 module = Entry.Lookup('WriteDocs', name, False)
678 docs = getattr(module, '__doc__')
679 if test_missing == name:
682 lines = docs.splitlines()
683 first_line = lines[0]
684 rest = [line[4:] for line in lines[1:]]
685 hdr = 'Entry: %s: %s' % (name.replace('_', '-'), first_line)
687 print('-' * len(hdr))
688 print('\n'.join(rest))
695 raise ValueError('Documentation is missing for modules: %s' %
698 def GetUniqueName(self):
699 """Get a unique name for a node
702 String containing a unique name for a node, consisting of the name
703 of all ancestors (starting from within the 'binman' node) separated
704 by a dot ('.'). This can be useful for generating unique filesnames
705 in the output directory.
711 if node.name == 'binman':
713 name = '%s.%s' % (node.name, name)
716 def ExpandToLimit(self, limit):
717 """Expand an entry so that it ends at the given offset limit"""
718 if self.offset + self.size < limit:
719 self.size = limit - self.offset
720 # Request the contents again, since changing the size requires that
721 # the data grows. This should not fail, but check it to be sure.
722 if not self.ObtainContents():
723 self.Raise('Cannot obtain contents when expanding entry')
725 def HasSibling(self, name):
726 """Check if there is a sibling of a given name
729 True if there is an entry with this name in the the same section,
732 return name in self.section.GetEntries()
734 def GetSiblingImagePos(self, name):
735 """Return the image position of the given sibling
738 Image position of sibling, or None if the sibling has no position,
739 or False if there is no such sibling
741 if not self.HasSibling(name):
743 return self.section.GetEntries()[name].image_pos
746 def AddEntryInfo(entries, indent, name, etype, size, image_pos,
747 uncomp_size, offset, entry):
748 """Add a new entry to the entries list
751 entries: List (of EntryInfo objects) to add to
752 indent: Current indent level to add to list
753 name: Entry name (string)
754 etype: Entry type (string)
755 size: Entry size in bytes (int)
756 image_pos: Position within image in bytes (int)
757 uncomp_size: Uncompressed size if the entry uses compression, else
759 offset: Entry offset within parent in bytes (int)
762 entries.append(EntryInfo(indent, name, etype, size, image_pos,
763 uncomp_size, offset, entry))
765 def ListEntries(self, entries, indent):
766 """Add files in this entry to the list of entries
768 This can be overridden by subclasses which need different behaviour.
771 entries: List (of EntryInfo objects) to add to
772 indent: Current indent level to add to list
774 self.AddEntryInfo(entries, indent, self.name, self.etype, self.size,
775 self.image_pos, self.uncomp_size, self.offset, self)
777 def ReadData(self, decomp=True):
778 """Read the data for an entry from the image
780 This is used when the image has been read in and we want to extract the
781 data for a particular entry from that image.
784 decomp: True to decompress any compressed data before returning it;
785 False to return the raw, uncompressed data
790 # Use True here so that we get an uncompressed section to work from,
791 # although compressed sections are currently not supported
792 tout.Debug("ReadChildData section '%s', entry '%s'" %
793 (self.section.GetPath(), self.GetPath()))
794 data = self.section.ReadChildData(self, decomp)
797 def ReadChildData(self, child, decomp=True):
798 """Read the data for a particular child entry
800 This reads data from the parent and extracts the piece that relates to
804 child: Child entry to read data for (must be valid)
805 decomp: True to decompress any compressed data before returning it;
806 False to return the raw, uncompressed data
809 Data for the child (bytes)
813 def LoadData(self, decomp=True):
814 data = self.ReadData(decomp)
815 self.contents_size = len(data)
816 self.ProcessContentsUpdate(data)
817 self.Detail('Loaded data size %x' % len(data))
820 """Get the image containing this entry
823 Image object containing this entry
825 return self.section.GetImage()
827 def WriteData(self, data, decomp=True):
828 """Write the data to an entry in the image
830 This is used when the image has been read in and we want to replace the
831 data for a particular entry in that image.
833 The image must be re-packed and written out afterwards.
836 data: Data to replace it with
837 decomp: True to compress the data if needed, False if data is
838 already compressed so should be used as is
841 True if the data did not result in a resize of this entry, False if
842 the entry must be resized
844 if self.size is not None:
845 self.contents_size = self.size
847 self.contents_size = self.pre_reset_size
848 ok = self.ProcessContentsUpdate(data)
849 self.Detail('WriteData: size=%x, ok=%s' % (len(data), ok))
850 section_ok = self.section.WriteChildData(self)
851 return ok and section_ok
853 def WriteChildData(self, child):
854 """Handle writing the data in a child entry
856 This should be called on the child's parent section after the child's
857 data has been updated. It
859 This base-class implementation does nothing, since the base Entry object
860 does not have any children.
863 child: Child Entry that was written
866 True if the section could be updated successfully, False if the
867 data is such that the section could not updat
871 def GetSiblingOrder(self):
872 """Get the relative order of an entry amoung its siblings
875 'start' if this entry is first among siblings, 'end' if last,
878 entries = list(self.section.GetEntries().values())
880 if self == entries[0]:
882 elif self == entries[-1]:
886 def SetAllowMissing(self, allow_missing):
887 """Set whether a section allows missing external blobs
890 allow_missing: True if allowed, False if not allowed
892 # This is meaningless for anything other than sections
895 def CheckMissing(self, missing_list):
896 """Check if any entries in this section have missing external blobs
898 If there are missing blobs, the entries are added to the list
901 missing_list: List of Entry objects to be added to
904 missing_list.append(self)
906 def GetAllowMissing(self):
907 """Get whether a section allows missing external blobs
910 True if allowed, False if not allowed
912 return self.allow_missing
914 def GetHelpTags(self):
915 """Get the tags use for missing-blob help
918 list of possible tags, most desirable first
920 return list(filter(None, [self.missing_msg, self.name, self.etype]))
922 def CompressData(self, indata):
923 """Compress data according to the entry's compression method
926 indata: Data to compress
929 Compressed data (first word is the compressed size)
931 self.uncomp_data = indata
932 if self.compress != 'none':
933 self.uncomp_size = len(indata)
934 data = tools.Compress(indata, self.compress)
938 def UseExpanded(cls, node, etype, new_etype):
939 """Check whether to use an expanded entry type
941 This is called by Entry.Create() when it finds an expanded version of
942 an entry type (e.g. 'u-boot-expanded'). If this method returns True then
943 it will be used (e.g. in place of 'u-boot'). If it returns False, it is
947 node: Node object containing information about the entry to
949 etype: Original entry type being used
950 new_etype: New entry type proposed
953 True to use this entry type, False to use the original one
955 tout.Info("Node '%s': etype '%s': %s selected" %
956 (node.path, etype, new_etype))