1 # SPDX-License-Identifier: GPL-2.0+
2 # Copyright (c) 2016 Google, Inc
3 # Written by Simon Glass <sjg@chromium.org>
5 # Class for an image, the output of binman
8 from __future__ import print_function
10 from collections import OrderedDict
11 from operator import attrgetter
20 """A Image, representing an output from binman
22 An image is comprised of a collection of entries each containing binary
23 data. The image size must be large enough to hold all of this data.
25 This class implements the various operations needed for images.
28 _node: Node object that contains the image definition in device tree
30 _size: Image size in bytes, or None if not known yet
31 _filename: Output filename for image
32 _sections: Sections present in this image (may be one or more)
35 test: True if this is being called from a test of Images. This this case
36 there is no device tree defining the structure of the section, so
37 we create a section manually.
39 def __init__(self, name, node, test=False):
43 self._filename = '%s.bin' % self._name
45 self._section = bsection.Section('main-section', self._node, True)
50 """Read properties from the image node"""
51 self._size = fdt_util.GetInt(self._node, 'size')
52 filename = fdt_util.GetString(self._node, 'filename')
54 self._filename = filename
55 self._section = bsection.Section('main-section', self._node)
57 def ProcessFdt(self, fdt):
58 return self._section.ProcessFdt(fdt)
60 def GetEntryContents(self):
61 """Call ObtainContents() for the section
63 self._section.GetEntryContents()
65 def GetEntryPositions(self):
66 """Handle entries that want to set the position/size of other entries
68 This calls each entry's GetPositions() method. If it returns a list
69 of entries to update, it updates them.
71 self._section.GetEntryPositions()
73 def PackEntries(self):
74 """Pack all entries into the image"""
75 self._section.PackEntries()
78 """Check that the image contents does not exceed its size, etc."""
79 self._size = self._section.CheckSize()
81 def CheckEntries(self):
82 """Check that entries do not overlap or extend outside the image"""
83 self._section.CheckEntries()
85 def ProcessEntryContents(self):
86 """Call the ProcessContents() method for each entry
88 This is intended to adjust the contents as needed by the entry type.
90 self._section.ProcessEntryContents()
92 def WriteSymbols(self):
93 """Write symbol values into binary files for access at run time"""
94 self._section.WriteSymbols()
97 """Write the image to a file"""
98 fname = tools.GetOutputFilename(self._filename)
99 with open(fname, 'wb') as fd:
100 self._section.BuildSection(fd, 0)
102 def GetEntries(self):
103 return self._section.GetEntries()
106 """Write a map of the image to a .map file"""
107 filename = '%s.map' % self._name
108 fname = tools.GetOutputFilename(filename)
109 with open(fname, 'w') as fd:
110 print('%8s %8s %s' % ('Position', 'Size', 'Name'), file=fd)
111 self._section.WriteMap(fd, 0)