1# SPDX-License-Identifier: GPL-2.0+
2# Copyright (c) 2016 Google, Inc
3# Written by Simon Glass <sjg@chromium.org>
4#
5# Entry-type module for tpl/u-boot-tpl.bin
6#
7
8import elf
9
10from entry import Entry
11from blob import Entry_blob
12
13class Entry_u_boot_tpl(Entry_blob):
14    """U-Boot TPL binary
15
16    Properties / Entry arguments:
17        - filename: Filename of u-boot-tpl.bin (default 'tpl/u-boot-tpl.bin')
18
19    This is the U-Boot TPL (Tertiary Program Loader) binary. This is a small
20    binary which loads before SPL, typically into on-chip SRAM. It is
21    responsible for locating, loading and jumping to SPL, the next-stage
22    loader. Note that SPL is not relocatable so must be loaded to the correct
23    address in SRAM, or written to run from the correct address if direct
24    flash execution is possible (e.g. on x86 devices).
25
26    SPL can access binman symbols at runtime. See:
27
28        'Access to binman entry offsets at run time (symbols)'
29
30    in the binman README for more information.
31
32    The ELF file 'tpl/u-boot-tpl' must also be available for this to work, since
33    binman uses that to look up symbols to write into the TPL binary.
34    """
35    def __init__(self, section, etype, node):
36        Entry_blob.__init__(self, section, etype, node)
37        self.elf_fname = 'tpl/u-boot-tpl'
38
39    def GetDefaultFilename(self):
40        return 'tpl/u-boot-tpl.bin'
41
42    def WriteSymbols(self, section):
43        elf.LookupAndWriteSymbols(self.elf_fname, self, section)
44