Firmware/opensbi
8
0
Fork 0
forked from Mirrors/opensbi
Code Pull Requests Activity

docs/firmware: document new options for jump and payload firmwares

Browse Source 
Adding relocatable address brings new configuration options for jump
and payload firmwares. Describe these new options in documentation.

Signed-off-by: Inochi Amaoto <inochiama@outlook.com>
Reviewed-by: Anup Patel <anup@brainfault.org>
This commit is contained in:
Inochi Amaoto
2024-02-23 16:18:15 +08:00
committed by Anup Patel
parent 2cff7f350f
commit 96a35db63a
2 changed files with 19 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/firmware/fw_jump.md
View File

@@ -31,9 +31,14 @@ follows:
* **FW_JUMP_ADDR** - Address of the entry point of the booting stage to be * **FW_JUMP_ADDR** - Address of the entry point of the booting stage to be
executed following OpenSBI firmware. This address generally corresponds executed following OpenSBI firmware. This address generally corresponds
exactly to the address where this next booting stage was loaded. This is a exactly to the address where this next booting stage was loaded.
mandatory parameter. Compilation errors will result from not defining this At least one of *FW_JUMP_ADDR* and *FW_JUMP_OFFSET* (see below) should be
address. defined. Compilation errors will result from not defining one of them.
* **FW_JUMP_OFFSET** - Address offset from the *FW_TEXT_START* where the
entry point of the next booting stage is located. This offset is used as
relocatable address of the next booting stage entry point. If *FW_JUMP_ADDR*
is also defined, the firmware will prefer *FW_JUMP_ADDR*.
* **FW_JUMP_FDT_ADDR** - Address where the *flattened device tree (FDT file)* * **FW_JUMP_FDT_ADDR** - Address where the *flattened device tree (FDT file)*
passed by the prior booting stage will be placed in memory before executing passed by the prior booting stage will be placed in memory before executing
@@ -57,6 +62,12 @@ follows:
echo fdt overlaps kernel, increase FW_JUMP_FDT_ADDR echo fdt overlaps kernel, increase FW_JUMP_FDT_ADDR
``` ```
* **FW_JUMP_FDT_OFFSET** - Address offset from the *FW_TEXT_START* where
the FDT will be passed to the next booting stage. This offset is used
as relocatable address of the FDT passed to the next booting stage. If
*FW_JUMP_FDT_ADDR* is also defined, the firmware will prefer
*FW_JUMP_FDT_ADDR*.
*FW_JUMP* Example *FW_JUMP* Example
----------------- -----------------

5
docs/firmware/fw_payload.md
View File

@@ -62,6 +62,11 @@ file. The parameters currently defined are as follows:
firmware will pass the FDT address passed by the previous booting stage firmware will pass the FDT address passed by the previous booting stage
to the next booting stage. to the next booting stage.
* **FW_PAYLOAD_FDT_OFFSET** - Address offset from the *FW_TEXT_START* where
the FDT will be passed to the next booting stage. This offset is used as
relocatable address of the FDT passed to the next booting stage. If
*FW_PAYLOAD_FDT_ADDR* is also defined, the firmware will prefer *FW_PAYLOAD_FDT_ADDR*.
*FW_PAYLOAD* Example *FW_PAYLOAD* Example
-------------------- --------------------