]> git.sur5r.net Git - u-boot/blob - tools/binman/image.py
binman: Add a ProcessFdt() method
[u-boot] / tools / binman / image.py
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
8 from __future__ import print_function
9
10 from collections import OrderedDict
11 from operator import attrgetter
12 import re
13 import sys
14
15 import fdt_util
16 import bsection
17 import tools
18
19 class 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 ProcessFdt(self, fdt):
58         return self._section.ProcessFdt(fdt)
59
60     def GetEntryContents(self):
61         """Call ObtainContents() for the section
62         """
63         self._section.GetEntryContents()
64
65     def GetEntryPositions(self):
66         """Handle entries that want to set the position/size of other entries
67
68         This calls each entry's GetPositions() method. If it returns a list
69         of entries to update, it updates them.
70         """
71         self._section.GetEntryPositions()
72
73     def PackEntries(self):
74         """Pack all entries into the image"""
75         self._section.PackEntries()
76
77     def CheckSize(self):
78         """Check that the image contents does not exceed its size, etc."""
79         self._size = self._section.CheckSize()
80
81     def CheckEntries(self):
82         """Check that entries do not overlap or extend outside the image"""
83         self._section.CheckEntries()
84
85     def ProcessEntryContents(self):
86         """Call the ProcessContents() method for each entry
87
88         This is intended to adjust the contents as needed by the entry type.
89         """
90         self._section.ProcessEntryContents()
91
92     def WriteSymbols(self):
93         """Write symbol values into binary files for access at run time"""
94         self._section.WriteSymbols()
95
96     def BuildImage(self):
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)
101
102     def GetEntries(self):
103         return self._section.GetEntries()
104
105     def WriteMap(self):
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)