xref: /openbmc/u-boot/tools/binman/image.py (revision eba6589f) 
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 GetEntryContents(self):
58        """Call ObtainContents() for the section
59        """
60        self._section.GetEntryContents()
61
62    def GetEntryPositions(self):
63        """Handle entries that want to set the position/size of other entries
64
65        This calls each entry's GetPositions() method. If it returns a list
66        of entries to update, it updates them.
67        """
68        self._section.GetEntryPositions()
69
70    def PackEntries(self):
71        """Pack all entries into the image"""
72        self._section.PackEntries()
73
74    def CheckSize(self):
75        """Check that the image contents does not exceed its size, etc."""
76        self._size = self._section.CheckSize()
77
78    def CheckEntries(self):
79        """Check that entries do not overlap or extend outside the image"""
80        self._section.CheckEntries()
81
82    def ProcessEntryContents(self):
83        """Call the ProcessContents() method for each entry
84
85        This is intended to adjust the contents as needed by the entry type.
86        """
87        self._section.ProcessEntryContents()
88
89    def WriteSymbols(self):
90        """Write symbol values into binary files for access at run time"""
91        self._section.WriteSymbols()
92
93    def BuildImage(self):
94        """Write the image to a file"""
95        fname = tools.GetOutputFilename(self._filename)
96        with open(fname, 'wb') as fd:
97            self._section.BuildSection(fd, 0)
98
99    def GetEntries(self):
100        return self._section.GetEntries()
101
102    def WriteMap(self):
103        """Write a map of the image to a .map file"""
104        filename = '%s.map' % self._name
105        fname = tools.GetOutputFilename(filename)
106        with open(fname, 'w') as fd:
107            print('%8s  %8s  %s' % ('Position', 'Size', 'Name'), file=fd)
108            self._section.WriteMap(fd, 0)
109