Skip to content

Commit 96a35db

Browse files
inochisaavpatel
authored andcommitted
docs/firmware: document new options for jump and payload firmwares
Adding relocatable address brings new configuration options for jump and payload firmwares. Describe these new options in documentation. Signed-off-by: Inochi Amaoto <[email protected]> Reviewed-by: Anup Patel <[email protected]>
1 parent 2cff7f3 commit 96a35db

File tree

2 files changed

+19
-3
lines changed

2 files changed

+19
-3
lines changed

docs/firmware/fw_jump.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,14 @@ follows:
3131

3232
* **FW_JUMP_ADDR** - Address of the entry point of the booting stage to be
3333
executed following OpenSBI firmware. This address generally corresponds
34-
exactly to the address where this next booting stage was loaded. This is a
35-
mandatory parameter. Compilation errors will result from not defining this
36-
address.
34+
exactly to the address where this next booting stage was loaded.
35+
At least one of *FW_JUMP_ADDR* and *FW_JUMP_OFFSET* (see below) should be
36+
defined. Compilation errors will result from not defining one of them.
37+
38+
* **FW_JUMP_OFFSET** - Address offset from the *FW_TEXT_START* where the
39+
entry point of the next booting stage is located. This offset is used as
40+
relocatable address of the next booting stage entry point. If *FW_JUMP_ADDR*
41+
is also defined, the firmware will prefer *FW_JUMP_ADDR*.
3742

3843
* **FW_JUMP_FDT_ADDR** - Address where the *flattened device tree (FDT file)*
3944
passed by the prior booting stage will be placed in memory before executing
@@ -57,6 +62,12 @@ follows:
5762
echo fdt overlaps kernel, increase FW_JUMP_FDT_ADDR
5863
```
5964

65+
* **FW_JUMP_FDT_OFFSET** - Address offset from the *FW_TEXT_START* where
66+
the FDT will be passed to the next booting stage. This offset is used
67+
as relocatable address of the FDT passed to the next booting stage. If
68+
*FW_JUMP_FDT_ADDR* is also defined, the firmware will prefer
69+
*FW_JUMP_FDT_ADDR*.
70+
6071
*FW_JUMP* Example
6172
-----------------
6273

docs/firmware/fw_payload.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,11 @@ file. The parameters currently defined are as follows:
6262
firmware will pass the FDT address passed by the previous booting stage
6363
to the next booting stage.
6464

65+
* **FW_PAYLOAD_FDT_OFFSET** - Address offset from the *FW_TEXT_START* where
66+
the FDT will be passed to the next booting stage. This offset is used as
67+
relocatable address of the FDT passed to the next booting stage. If
68+
*FW_PAYLOAD_FDT_ADDR* is also defined, the firmware will prefer *FW_PAYLOAD_FDT_ADDR*.
69+
6570
*FW_PAYLOAD* Example
6671
--------------------
6772

0 commit comments

Comments
 (0)