mirror of
https://github.com/brain-hackers/u-boot-brain
synced 2024-07-15 15:46:16 +09:00
8beb11ea6e
When support for sections (and thus hierarchical images) was added to
binman, the decision was made to create a new Section class which could
be used by both Image and an Entry_section class. The decision between
using inheritance and composition was tricky to make, but in the end it
was decided that Image was different enough from Entry that it made sense
to put the implementation of sections in an entirely separate class. It
also has the advantage that core Image code does have to rely on an entry
class in the etype directory.
This work was mostly completed in commit:
8f1da50ccc "binman: Refactor much of the image code into 'section'
As a result of this, the Section class has its own version of things like
offset and size and these must be kept in sync with the parent
Entry_section class in some cases.
In the last year it has become apparent that the cost of keeping things in
sync is larger than expected, since more and more code wants to access
these properties.
An alternative approach, previously considered and rejected, now seems
better.
Adjust Image to be a subclass of Entry_section. Move the code from Section
(in bsection.py) to Entry_section and delete Section. Update all tests
accordingly.
This requires substantial changes to Image. Overall the changes reduce
code size by about 240 lines. While much of that is just boilerplate from
Section, there are quite a few functions in Entry_section which now do not
need to be overiden from Entry. This suggests the change is beneficial
even without further functionality being added.
A side benefit is that the properties of sections are now consistent with
other entries. This fixes a problem in testListCmd() where some properties
are missing for sections.
Unfortunately this is a very large commit since it is not feasible to do
the migration piecemeal. Given the substantial tests available and the
100% code coverage of binman, we should be able to do this safely.
Signed-off-by: Simon Glass <sjg@chromium.org>
66 lines
2.2 KiB
Python
66 lines
2.2 KiB
Python
# SPDX-License-Identifier: GPL-2.0+
|
|
# Copyright (c) 2018 Google, Inc
|
|
# Written by Simon Glass <sjg@chromium.org>
|
|
#
|
|
# Entry-type module for a Flash map, as used by the flashrom SPI flash tool
|
|
#
|
|
|
|
from entry import Entry
|
|
import fmap_util
|
|
import tools
|
|
|
|
|
|
class Entry_fmap(Entry):
|
|
"""An entry which contains an Fmap section
|
|
|
|
Properties / Entry arguments:
|
|
None
|
|
|
|
FMAP is a simple format used by flashrom, an open-source utility for
|
|
reading and writing the SPI flash, typically on x86 CPUs. The format
|
|
provides flashrom with a list of areas, so it knows what it in the flash.
|
|
It can then read or write just a single area, instead of the whole flash.
|
|
|
|
The format is defined by the flashrom project, in the file lib/fmap.h -
|
|
see www.flashrom.org/Flashrom for more information.
|
|
|
|
When used, this entry will be populated with an FMAP which reflects the
|
|
entries in the current image. Note that any hierarchy is squashed, since
|
|
FMAP does not support this.
|
|
"""
|
|
def __init__(self, section, etype, node):
|
|
Entry.__init__(self, section, etype, node)
|
|
|
|
def _GetFmap(self):
|
|
"""Build an FMAP from the entries in the current image
|
|
|
|
Returns:
|
|
FMAP binary data
|
|
"""
|
|
def _AddEntries(areas, entry):
|
|
entries = entry.GetEntries()
|
|
if entries:
|
|
for subentry in entries.values():
|
|
_AddEntries(areas, subentry)
|
|
else:
|
|
pos = entry.image_pos
|
|
if pos is not None:
|
|
pos -= entry.section.GetRootSkipAtStart()
|
|
areas.append(fmap_util.FmapArea(pos or 0, entry.size or 0,
|
|
tools.FromUnicode(entry.name), 0))
|
|
|
|
entries = self.section.image.GetEntries()
|
|
areas = []
|
|
for entry in entries.values():
|
|
_AddEntries(areas, entry)
|
|
return fmap_util.EncodeFmap(self.section.GetImageSize() or 0, self.name,
|
|
areas)
|
|
|
|
def ObtainContents(self):
|
|
"""Obtain a placeholder for the fmap contents"""
|
|
self.SetContents(self._GetFmap())
|
|
return True
|
|
|
|
def ProcessContents(self):
|
|
return self.ProcessContentsUpdate(self._GetFmap())
|