2018-05-07 06:58:06 +09:00
|
|
|
# SPDX-License-Identifier: GPL-2.0+
|
2016-11-26 12:15:52 +09:00
|
|
|
# Copyright (c) 2016 Google, Inc
|
|
|
|
# Written by Simon Glass <sjg@chromium.org>
|
|
|
|
#
|
|
|
|
# Entry-type module for spl/u-boot-spl.bin
|
|
|
|
#
|
|
|
|
|
binman: Support accessing binman tables at run time
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: Simon Glass <sjg@chromium.org>
2017-11-14 10:55:01 +09:00
|
|
|
import elf
|
|
|
|
|
2016-11-26 12:15:52 +09:00
|
|
|
from entry import Entry
|
|
|
|
from blob import Entry_blob
|
|
|
|
|
|
|
|
class Entry_u_boot_spl(Entry_blob):
|
2018-07-18 04:25:35 +09:00
|
|
|
"""U-Boot SPL binary
|
|
|
|
|
|
|
|
Properties / Entry arguments:
|
|
|
|
- filename: Filename of u-boot-spl.bin (default 'spl/u-boot-spl.bin')
|
|
|
|
|
|
|
|
This is the U-Boot SPL (Secondary Program Loader) binary. This is a small
|
|
|
|
binary which loads before U-Boot proper, typically into on-chip SRAM. It is
|
|
|
|
responsible for locating, loading and jumping to U-Boot. Note that SPL is
|
|
|
|
not relocatable so must be loaded to the correct address in SRAM, or written
|
2018-07-18 04:25:48 +09:00
|
|
|
to run from the correct address if direct flash execution is possible (e.g.
|
2018-07-18 04:25:35 +09:00
|
|
|
on x86 devices).
|
|
|
|
|
|
|
|
SPL can access binman symbols at runtime. See:
|
|
|
|
|
|
|
|
'Access to binman entry offsets at run time (symbols)'
|
|
|
|
|
|
|
|
in the binman README for more information.
|
|
|
|
|
|
|
|
The ELF file 'spl/u-boot-spl' must also be available for this to work, since
|
|
|
|
binman uses that to look up symbols to write into the SPL binary.
|
|
|
|
"""
|
2018-06-02 00:38:14 +09:00
|
|
|
def __init__(self, section, etype, node):
|
|
|
|
Entry_blob.__init__(self, section, etype, node)
|
binman: Support accessing binman tables at run time
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: Simon Glass <sjg@chromium.org>
2017-11-14 10:55:01 +09:00
|
|
|
self.elf_fname = 'spl/u-boot-spl'
|
2016-11-26 12:15:52 +09:00
|
|
|
|
|
|
|
def GetDefaultFilename(self):
|
|
|
|
return 'spl/u-boot-spl.bin'
|
binman: Support accessing binman tables at run time
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: Simon Glass <sjg@chromium.org>
2017-11-14 10:55:01 +09:00
|
|
|
|
2018-06-02 00:38:13 +09:00
|
|
|
def WriteSymbols(self, section):
|
2019-08-24 22:23:00 +09:00
|
|
|
elf.LookupAndWriteSymbols(self.elf_fname, self, section.GetImage())
|