Prepare v2023.10
[platform/kernel/u-boot.git] / tools / binman / etype / u_boot_spl_nodtb.py
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 'u-boot-spl-nodtb.bin'
6 #
7
8 from binman.entry import Entry
9 from binman.etype.blob import Entry_blob
10
11 class Entry_u_boot_spl_nodtb(Entry_blob):
12     """SPL binary without device tree appended
13
14     Properties / Entry arguments:
15         - filename: Filename to include (default 'spl/u-boot-spl-nodtb.bin')
16
17     This is the U-Boot SPL binary, It does not include a device tree blob at
18     the end of it so may not be able to work without it, assuming SPL needs
19     a device tree to operate on your platform. You can add a u-boot-spl-dtb
20     entry after this one, or use a u-boot-spl entry instead' which normally
21     expands to a section containing u-boot-spl-dtb, u-boot-spl-bss-pad and
22     u-boot-spl-dtb
23
24     SPL can access binman symbols at runtime. See :ref:`binman_fdt`.
25
26     in the binman README for more information.
27
28     The ELF file 'spl/u-boot-spl' must also be available for this to work, since
29     binman uses that to look up symbols to write into the SPL binary.
30     """
31     def __init__(self, section, etype, node):
32         super().__init__(section, etype, node, auto_write_symbols=True)
33         self.elf_fname = 'spl/u-boot-spl'
34
35     def GetDefaultFilename(self):
36         return 'spl/u-boot-spl-nodtb.bin'