jcs.org
"Das U-Boot" Source Tree
doc: add bootelf command documentation
Signed-off-by: Maxim Moskalets <maximmosk4@gmail.com>
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
authored by
Maxim Moskalets
and committed by
Heinrich Schuchardt
da909648
bbac4aeb
+62
+61
doc/usage/cmd/bootelf.rst
+61
doc/usage/cmd/bootelf.rst
···
1
+
.. SPDX-License-Identifier: GPL-2.0-or-later
2
+
.. Copyright 2024, Maxim Moskalets <maximmosk4@gmail.com>
3
+
4
+
.. index::
5
+
single: bootelf (command)
6
+
7
+
bootelf command
8
+
===============
9
+
10
+
Synopsis
11
+
--------
12
+
13
+
::
14
+
15
+
bootelf [-p|-s] [-d <fdt_addr>] [<image_addr> [<arg>]...]
16
+
17
+
Description
18
+
-----------
19
+
20
+
The *bootelf* command is used to launch a ELF binary at *image_addr*. If
21
+
*image_addr* is not specified, the bootelf command will try to find image in
22
+
*image_load_addr* variable (*CONFIG\_SYS\_LOAD\_ADDR* by default).
23
+
24
+
Args after *image_addr* will be passed to application in common *argc*, *argv*
25
+
format.
26
+
27
+
A command sequence to run a ELF image using FDT might look like
28
+
29
+
::
30
+
31
+
load mmc 0:1 ${loadaddr} /kernel.elf
32
+
load mmc 0:1 ${fdt_addr_r} /soc-board.dtb
33
+
bootelf -d ${fdt_addr_r} ${loadaddr} ${loadaddr}
34
+
35
+
image_addr
36
+
Address of the ELF binary.
37
+
38
+
fdt_addr
39
+
Address of the device-tree. This argument in only needed if bootable
40
+
application uses FDT that requires additional setup (like /memory node).
41
+
42
+
arg
43
+
Any text arguments for bootable application. This is usually the address
44
+
of the device-tree.
45
+
46
+
Flags:
47
+
48
+
-p
49
+
Load ELF image via program headers.
50
+
51
+
-s
52
+
Load ELF image via section headers.
53
+
54
+
-d
55
+
Setup FDT by address.
56
+
57
+
Configuration
58
+
-------------
59
+
60
+
The bootelf command is only available if CONFIG_CMD_ELF=y. FDT setup by flag -d
61
+
need CONFIG_CMD_ELF_FDT_SETUP=y.