It is useful to be able to see a list of regions in each image produced by
binman. Add a -m option to output this information in a '.map' file
alongside the image file.
Signed-off-by: NSimon Glass <sjg@chromium.org>

Fix a few missing comments and tidy up some existing ones.
Signed-off-by: NSimon Glass <sjg@chromium.org>

Provide an easy way to execute a single binman test by specifying it on
the command line.
Signed-off-by: NSimon Glass <sjg@chromium.org>

This property is not documented. Add a note to the README.
Signed-off-by: NSimon Glass <sjg@chromium.org>

It is useful to be able to split an image into multiple sections,
each with its own size and position, for cases where a flash device has
read-only and read-write portions.

Add support for this.
Signed-off-by: NSimon Glass <sjg@chromium.org>

At present we set the Python path at the start of binman so we can read
modules in the 'etype' directory. This is a bit messy since it affects
'import' statements through binman.

Adjust the code to set the path locally, just where it is needed. Move
the 'entry' module in with the other base modules to help with this. It
makes more sense here anyway since it does not implement an entry type.
Signed-off-by: NSimon Glass <sjg@chromium.org>

Entries are now passed a Section object rather than an Image. Rename this
property to avoid confusion.
Signed-off-by: NSimon Glass <sjg@chromium.org>

We now pass a Section object to these functions rather than an Image.
Rename the parameters to avoid confusion.
Signed-off-by: NSimon Glass <sjg@chromium.org>

We want to support multiple sections within a single image. To do this,
move most of the Image class implementation into a new Section class. An
Image contains only a single Section, but at some point we will support
a new 'section' entry, thus allowing Sections within Sections.

Use the name 'bsection' for the module so we can use 'section' for the
etype module.
Signed-off-by: NSimon Glass <sjg@chromium.org>

Allow the same binary to appear multiple times in an image by using the
device-tree unit-address feature (u-boot@0, u-boot@1).
Signed-off-by: NSimon Glass <sjg@chromium.org>

When U-Boot started using SPDX tags we were among the early adopters and
there weren't a lot of other examples to borrow from.  So we picked the
area of the file that usually had a full license text and replaced it
with an appropriate SPDX-License-Identifier: entry.  Since then, the
Linux Kernel has adopted SPDX tags and they place it as the very first
line in a file (except where shebangs are used, then it's second line)
and with slightly different comment styles than us.

In part due to community overlap, in part due to better tag visibility
and in part for other minor reasons, switch over to that style.

This commit changes all instances where we have a single declared
license in the tag as both the before and after are identical in tag
contents.  There's also a few places where I found we did not have a tag
and have introduced one.
Signed-off-by: NTom Rini <trini@konsulko.com>

In some cases when "more" is told to page a given file it will prepend
the output with:
::::::::::::::
/PATH/TO/THE/FILE
::::::::::::::

And when this happens the output will not match the expected length.
Further, if we use a different pager we will instead fail the coverage
tests as we will not have 100% coverage.  Update the help test to remove
the string in question.
Reviewed-by: NSimon Glass <sjg@chromium.org>
Signed-off-by: NTom Rini <trini@konsulko.com>

The system device-tree compiler may not be new enough to run the tests we
use in U-Boot (e.g. with binman). Allow use of a DTC environment variable
to point to the correct dtc. If not defined, the dtc on the default PATH
is used.
Signed-off-by: NSimon Glass <sjg@chromium.org>

Add this feature to the README.
Signed-off-by: NSimon Glass <sjg@chromium.org>
Reviewed-by: NLukasz Majewski <lukma@denx.de>

Binman construct images consisting of multiple binary files. These files
sometimes need to know (at run timme) where their peers are located. For
example, SPL may want to know where U-Boot is located in the image, so
that it can jump to U-Boot correctly on boot.

In general the positions where the binaries end up after binman has
finished packing them cannot be known at compile time. One reason for
this is that binman does not know the size of the binaries until
everything is compiled, linked and converted to binaries with objcopy.

To make this work, we add a feature to binman which checks each binary
for symbol names starting with '_binman'. These are then decoded to figure
out which entry and property they refer to. Then binman writes the value
of this symbol into the appropriate binary. With this, the symbol will
have the correct value at run time.

Macros are used to make this easier to use. As an example, this declares
a symbol that will access the 'u-boot-spl' entry to find the 'pos' value
(i.e. the position of SPL in the image):

   binman_sym_declare(unsigned long, u_boot_spl, pos);

This converts to a symbol called '_binman_u_boot_spl_prop_pos' in any
binary that includes it. Binman then updates the value in that binary,
ensuring that it can be accessed at runtime with:

   ulong u_boot_pos = binman_sym(ulong, u_boot_spl, pos);

This assigns the variable u_boot_pos to the position of SPL in the image.
Signed-off-by: NSimon Glass <sjg@chromium.org>

The elf module can provide some debugging information to assist with
figuring out what is going wrong. This is also useful in tests. Update the
-D option so that it is passed through to tests as well.
Signed-off-by: NSimon Glass <sjg@chromium.org>

This is only 3 bytes long which is not enough to hold two symbol values,
needed to test the binman symbols feature. Increase it to 15 bytes.

Using very small regions is useful since we can easily compare them in
tests and errors are fairly easy to diagnose.
Signed-off-by: NSimon Glass <sjg@chromium.org>

For testing we need to build some ELF files containing binman symbols. Add
these to the Makefile and check in the binaries:

   u_boot_binman_syms - normal, valid ELF file
   u_boot_binman_syms_bad - missing the __image_copy_start symbol
   u_boot_binman_syms_size - has a binman symbol with an invalid size
Signed-off-by: NSimon Glass <sjg@chromium.org>

This feature is now supported. Drop the incorrect comment.
Signed-off-by: NSimon Glass <sjg@chromium.org>

This file contains SPL image without a device tree. Add support for
including this in images.
Signed-off-by: NSimon Glass <sjg@chromium.org>

This file contains the SPL device tree. Add support for including this by
itself in images.
Signed-off-by: NSimon Glass <sjg@chromium.org>

In some cases we need to read symbols from U-Boot. At present we have a
a few cases which does this via 'nm' and 'grep'.

It is better to use objdump since that tells us the size of the symbols
and also whether it is weak or not.

Add a new module which reads ELF information from files. Update existing
uses of 'nm' to use this module.
Signed-off-by: NSimon Glass <sjg@chromium.org>

Return exit code 1 when test fail so that callers can detect this.
Signed-off-by: NSimon Glass <sjg@chromium.org>

MRC (Memory Reference Code) is a binary blob used to set up the SDRAM
controller on some Intel boards. Add a test for this feature.

With this test coverage on binman is back up to 100%.
Signed-off-by: NSimon Glass <sjg@chromium.org>

Add a test for this feature. It allows SPL to hold a pointer to the
microcode block. This is used for 64-bit U-Boot on x86.
Signed-off-by: NSimon Glass <sjg@chromium.org>

This allows us to put the 16-bit x86 start-up code in SPL. Add a test for
it.
Signed-off-by: NSimon Glass <sjg@chromium.org>

Add a test that we can pad the BSS with zero bytes.
Signed-off-by: NSimon Glass <sjg@chromium.org>

Files that are never imported are not shown in the test-coverage report.
Detect these and show an error.
Signed-off-by: NSimon Glass <sjg@chromium.org>

Make a minor tweak to fix test coverage.
Signed-off-by: NSimon Glass <sjg@chromium.org>

Add a main program so that the tests can be executed directly, without
going through the main binman program.
Signed-off-by: NSimon Glass <sjg@chromium.org>

Add a test that the 'entry' module works with or without importlib.
The tests are numbered so that they are executed in the correct order.
Signed-off-by: NSimon Glass <sjg@chromium.org>

There is a little check at the top of entry.py which decides if importlib
is available. At present this has no test coverage. To add this we will
need to import the module twice, once with importlib and once without.
In preparation for allowing a test to control the importing of this
module, remove all global imports of the 'entry' module.
Signed-off-by: NSimon Glass <sjg@chromium.org>

Rather that overwrite this, append to it, in case the caller has already
set up the path correctly.
Signed-off-by: NSimon Glass <sjg@chromium.org>

At present these tests use the same filename as patman. This adds
confusion when running all tests, since error messages look very similar.
In fact binman tries to run the wrong tests at present.

Rename the tests.
Signed-off-by: NSimon Glass <sjg@chromium.org>

These test programs are includedd as binary files in U-Boot to avoid
having to build them (and associated toolchain differences). Instructions
on building are in the files themselves, but it seems better to provide
a Makefile which can be manually run when desired.

Add a Makefile, separate from the normal build system, to handle this.
Signed-off-by: NSimon Glass <sjg@chromium.org>

The process is not obvious. Add a little section to explain how to move a
board to use binman.
Signed-off-by: NSimon Glass <sjg@chromium.org>

There is a debugging option in the Makefile to allow people to figure out
which u-boot.dtsi files are used in the build. But is it not easy to use
since it only shows files it finds, not those it is looking for. Update it
and update the mention of it to the docs.
Signed-off-by: NSimon Glass <sjg@chromium.org>

The pylibfdt is used by dtoc (and, indirectly by binman), but there
is no reason why it must be generated in the tools/ directory.

Recently, U-Boot switched over to the bundled DTC, and the directory
structure under scripts/dtc/ now mirrors the upstream DTC project.
So, scripts/dtc/pylibfdt is the best location.

I also rewrote the Makefile in a cleaner Kbuild style.

The scripts from the upstream have been moved as follows:

  lib/libfdt/pylibfdt/setup.py -> scripts/dtc/pylibfdt/setup.py
  lib/libfdt/pylibfdt/libfdt.i -> scripts/dtc/pylibfdt/libfdt.i_shipped

The .i_shipped is coped to .i during building because the .i must be
located in the objtree when we build it out of tree.
Signed-off-by: NMasahiro Yamada <yamada.masahiro@socionext.com>

This adds a new entry type for Intel Video BIOS Table.
Signed-off-by: NBin Meng <bmeng.cn@gmail.com>
Reviewed-by: NSimon Glass <sjg@chromium.org>

If a system module is named the same as one of those used by binman we
currently pick the system module. Adjust the ordering so that our modules
are chosen instead.

The module conflict reported was 'tools' from jira-python. I cannot access
that package to test it.
Signed-off-by: NSimon Glass <sjg@chromium.org>
Reported-by: NKevin Hilman <khilman@baylibre.com>
Acked-by: NKevin Hilman <khilman@baylibre.com>