blob: 94028f19a513926962640eae08f2eeb9f9fc331b [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
3# Written by Simon Glass <sjg@chromium.org>
4#
Simon Glassbf7fd502016-11-25 20:15:51 -07005# Class for an image, the output of binman
6#
7
Simon Glass19790632017-11-13 18:55:01 -07008from __future__ import print_function
9
Simon Glassbf7fd502016-11-25 20:15:51 -070010from collections import OrderedDict
11from operator import attrgetter
Simon Glass19790632017-11-13 18:55:01 -070012import re
13import sys
Simon Glassbf7fd502016-11-25 20:15:51 -070014
Simon Glassbf7fd502016-11-25 20:15:51 -070015import fdt_util
Simon Glass8f1da502018-06-01 09:38:12 -060016import bsection
Simon Glassbf7fd502016-11-25 20:15:51 -070017import tools
18
19class Image:
20 """A Image, representing an output from binman
21
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.
24
25 This class implements the various operations needed for images.
26
27 Atrtributes:
28 _node: Node object that contains the image definition in device tree
29 _name: Image name
30 _size: Image size in bytes, or None if not known yet
Simon Glassbf7fd502016-11-25 20:15:51 -070031 _filename: Output filename for image
Simon Glass8f1da502018-06-01 09:38:12 -060032 _sections: Sections present in this image (may be one or more)
Simon Glass7ae5f312018-06-01 09:38:19 -060033
34 Args:
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.
Simon Glassbf7fd502016-11-25 20:15:51 -070038 """
Simon Glass19790632017-11-13 18:55:01 -070039 def __init__(self, name, node, test=False):
Simon Glassbf7fd502016-11-25 20:15:51 -070040 self._node = node
41 self._name = name
42 self._size = None
Simon Glassbf7fd502016-11-25 20:15:51 -070043 self._filename = '%s.bin' % self._name
Simon Glass8f1da502018-06-01 09:38:12 -060044 if test:
45 self._section = bsection.Section('main-section', self._node, True)
46 else:
Simon Glass19790632017-11-13 18:55:01 -070047 self._ReadNode()
Simon Glassbf7fd502016-11-25 20:15:51 -070048
49 def _ReadNode(self):
50 """Read properties from the image node"""
51 self._size = fdt_util.GetInt(self._node, 'size')
Simon Glassbf7fd502016-11-25 20:15:51 -070052 filename = fdt_util.GetString(self._node, 'filename')
53 if filename:
54 self._filename = filename
Simon Glass8f1da502018-06-01 09:38:12 -060055 self._section = bsection.Section('main-section', self._node)
Simon Glassbf7fd502016-11-25 20:15:51 -070056
Simon Glass078ab1a2018-07-06 10:27:41 -060057 def AddMissingProperties(self):
58 """Add properties that are not present in the device tree
59
60 When binman has completed packing the entries the position and size of
61 each entry are known. But before this the device tree may not specify
62 these. Add any missing properties, with a dummy value, so that the
63 size of the entry is correct. That way we can insert the correct values
64 later.
65 """
66 self._section.AddMissingProperties()
67
Simon Glassecab8972018-07-06 10:27:40 -060068 def ProcessFdt(self, fdt):
69 return self._section.ProcessFdt(fdt)
70
Simon Glassbf7fd502016-11-25 20:15:51 -070071 def GetEntryContents(self):
Simon Glass8f1da502018-06-01 09:38:12 -060072 """Call ObtainContents() for the section
Simon Glassbf7fd502016-11-25 20:15:51 -070073 """
Simon Glass8f1da502018-06-01 09:38:12 -060074 self._section.GetEntryContents()
Simon Glassbf7fd502016-11-25 20:15:51 -070075
76 def GetEntryPositions(self):
77 """Handle entries that want to set the position/size of other entries
78
79 This calls each entry's GetPositions() method. If it returns a list
80 of entries to update, it updates them.
81 """
Simon Glass8f1da502018-06-01 09:38:12 -060082 self._section.GetEntryPositions()
Simon Glassbf7fd502016-11-25 20:15:51 -070083
84 def PackEntries(self):
85 """Pack all entries into the image"""
Simon Glass8f1da502018-06-01 09:38:12 -060086 self._section.PackEntries()
Simon Glassbf7fd502016-11-25 20:15:51 -070087
Simon Glass8f1da502018-06-01 09:38:12 -060088 def CheckSize(self):
89 """Check that the image contents does not exceed its size, etc."""
90 self._size = self._section.CheckSize()
Simon Glassbf7fd502016-11-25 20:15:51 -070091
92 def CheckEntries(self):
93 """Check that entries do not overlap or extend outside the image"""
Simon Glass8f1da502018-06-01 09:38:12 -060094 self._section.CheckEntries()
Simon Glassbf7fd502016-11-25 20:15:51 -070095
Simon Glass078ab1a2018-07-06 10:27:41 -060096 def SetCalculatedProperties(self):
97 self._section.SetCalculatedProperties()
98
Simon Glassbf7fd502016-11-25 20:15:51 -070099 def ProcessEntryContents(self):
100 """Call the ProcessContents() method for each entry
101
102 This is intended to adjust the contents as needed by the entry type.
103 """
Simon Glass8f1da502018-06-01 09:38:12 -0600104 self._section.ProcessEntryContents()
Simon Glassbf7fd502016-11-25 20:15:51 -0700105
Simon Glass19790632017-11-13 18:55:01 -0700106 def WriteSymbols(self):
107 """Write symbol values into binary files for access at run time"""
Simon Glass8f1da502018-06-01 09:38:12 -0600108 self._section.WriteSymbols()
Simon Glass19790632017-11-13 18:55:01 -0700109
Simon Glassbf7fd502016-11-25 20:15:51 -0700110 def BuildImage(self):
111 """Write the image to a file"""
112 fname = tools.GetOutputFilename(self._filename)
113 with open(fname, 'wb') as fd:
Simon Glass8f1da502018-06-01 09:38:12 -0600114 self._section.BuildSection(fd, 0)
Simon Glassbf7fd502016-11-25 20:15:51 -0700115
Simon Glass8f1da502018-06-01 09:38:12 -0600116 def GetEntries(self):
117 return self._section.GetEntries()
Simon Glass3b0c3822018-06-01 09:38:20 -0600118
119 def WriteMap(self):
120 """Write a map of the image to a .map file"""
121 filename = '%s.map' % self._name
122 fname = tools.GetOutputFilename(filename)
123 with open(fname, 'w') as fd:
124 print('%8s %8s %s' % ('Position', 'Size', 'Name'), file=fd)
125 self._section.WriteMap(fd, 0)