xref: /openbmc/u-boot/tools/binman/image.py (revision 725e09b8) 
1# SPDX-License-Identifier: GPL-2.0+
2# Copyright (c) 2016 Google, Inc
3# Written by Simon Glass <sjg@chromium.org>
4#
5# Class for an image, the output of binman
6#
7
8from __future__ import print_function
9
10from collections import OrderedDict
11from operator import attrgetter
12import re
13import sys
14
15import fdt_util
16import bsection
17import 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
31        _filename: Output filename for image
32        _sections: Sections present in this image (may be one or more)
33
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.
38    """
39    def __init__(self, name, node, test=False):
40        self._node = node
41        self._name = name
42        self._size = None
43        self._filename = '%s.bin' % self._name
44        if test:
45            self._section = bsection.Section('main-section', self._node, True)
46        else:
47            self._ReadNode()
48
49    def _ReadNode(self):
50        """Read properties from the image node"""
51        self._size = fdt_util.GetInt(self._node, 'size')
52        filename = fdt_util.GetString(self._node, 'filename')
53        if filename:
54            self._filename = filename
55        self._section = bsection.Section('main-section', self._node)
56
57    def AddMissingProperties(self):
58        """Add properties that are not present in the device tree
59
60        When binman has completed packing the entries the offset 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
68    def ProcessFdt(self, fdt):
69        return self._section.ProcessFdt(fdt)
70
71    def GetEntryContents(self):
72        """Call ObtainContents() for the section
73        """
74        self._section.GetEntryContents()
75
76    def GetEntryOffsets(self):
77        """Handle entries that want to set the offset/size of other entries
78
79        This calls each entry's GetOffsets() method. If it returns a list
80        of entries to update, it updates them.
81        """
82        self._section.GetEntryOffsets()
83
84    def PackEntries(self):
85        """Pack all entries into the image"""
86        self._section.PackEntries()
87
88    def CheckSize(self):
89        """Check that the image contents does not exceed its size, etc."""
90        self._size = self._section.CheckSize()
91
92    def CheckEntries(self):
93        """Check that entries do not overlap or extend outside the image"""
94        self._section.CheckEntries()
95
96    def SetCalculatedProperties(self):
97        self._section.SetCalculatedProperties()
98
99    def SetImagePos(self):
100        self._section.SetImagePos(0)
101
102    def ProcessEntryContents(self):
103        """Call the ProcessContents() method for each entry
104
105        This is intended to adjust the contents as needed by the entry type.
106        """
107        self._section.ProcessEntryContents()
108
109    def WriteSymbols(self):
110        """Write symbol values into binary files for access at run time"""
111        self._section.WriteSymbols()
112
113    def BuildImage(self):
114        """Write the image to a file"""
115        fname = tools.GetOutputFilename(self._filename)
116        with open(fname, 'wb') as fd:
117            self._section.BuildSection(fd, 0)
118
119    def GetEntries(self):
120        return self._section.GetEntries()
121
122    def WriteMap(self):
123        """Write a map of the image to a .map file"""
124        filename = '%s.map' % self._name
125        fname = tools.GetOutputFilename(filename)
126        with open(fname, 'w') as fd:
127            print('%8s  %8s  %8s  %s' % ('ImagePos', 'Offset', 'Size', 'Name'),
128                  file=fd)
129            self._section.WriteMap(fd, 0)
130