summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAnup Patel <anup.patel@wdc.com>2020-10-14 14:13:34 +0300
committerAnup Patel <anup@brainfault.org>2020-10-18 07:59:59 +0300
commit9c07c513aa9b2df64a971432e8dae3338a8e22ab (patch)
tree1b3aedf8cfd58fc6cd5f9f41ea2530b4fdee76b0 /docs
parent6ca096977d723f3ac50291d668719bd938a85544 (diff)
downloadopensbi-9c07c513aa9b2df64a971432e8dae3338a8e22ab.tar.xz
firmware: Remove FW_PAYLOAD_FDT_PATH compile-time option
The FW_PAYLOAD_FDT_PATH compile-time option is replaced by FW_FDT_PATH compile-time option which is more flexible and common across all OpenSBI firmwares. This patch removes FW_PAYLOAD_FDT_PATH and updates related documentation to use FW_FDT_PATH. Signed-off-by: Anup Patel <anup.patel@wdc.com> Reviewed-by: Atish Patra <atish.patra@wdc.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/firmware/fw_payload.md9
-rw-r--r--docs/platform/andes-ae350.md4
-rw-r--r--docs/platform/shakti_cclass.md4
-rw-r--r--docs/platform/sifive_fu540.md6
4 files changed, 9 insertions, 14 deletions
diff --git a/docs/firmware/fw_payload.md b/docs/firmware/fw_payload.md
index bc712d2..0947448 100644
--- a/docs/firmware/fw_payload.md
+++ b/docs/firmware/fw_payload.md
@@ -55,14 +55,9 @@ file. The parameters currently defined are as follows:
automatically generated and used as a payload. This test payload executes
an infinite `while (1)` loop after printing a message on the platform console.
-* **FW_PAYLOAD_FDT_PATH** - Path to an external flattened device tree binary
- file to be embedded in the *.text* section of the final firmware. If this
- option is not provided then the firmware will expect the FDT to be passed
- as an argument by the prior booting stage.
-
* **FW_PAYLOAD_FDT_ADDR** - Address where the FDT passed by the prior booting
- stage or specified by the *FW_PAYLOAD_FDT_PATH* parameter and embedded in
- the *.text* section will be placed before executing the next booting stage,
+ stage or specified by the *FW_FDT_PATH* parameter and embedded in the
+ *.rodata* section will be placed before executing the next booting stage,
that is, the payload firmware. If this option is not provided, then the
firmware will pass the FDT address passed by the previous booting stage
to the next booting stage.
diff --git a/docs/platform/andes-ae350.md b/docs/platform/andes-ae350.md
index 5a98707..46889a1 100644
--- a/docs/platform/andes-ae350.md
+++ b/docs/platform/andes-ae350.md
@@ -19,12 +19,12 @@ Building Andes AE350 Platform
-----------------------------
To use Linux v5.2 should be used to build Andes AE350 OpenSBI binaries by using
-the compile time option FW_PAYLOAD_FDT_PATH.
+the compile time option FW_FDT_PATH.
AE350's dts is included in https://github.com/andestech/linux/tree/ast-v3_2_0-release-public
**Linux Kernel Payload**
```
-make PLATFORM=andes/ae350 FW_PAYLOAD_PATH=<linux_build_directory>/arch/riscv/boot/Image FW_PAYLOAD_FDT_PATH=<ae350.dtb path>
+make PLATFORM=andes/ae350 FW_PAYLOAD_PATH=<linux_build_directory>/arch/riscv/boot/Image FW_FDT_PATH=<ae350.dtb path>
```
diff --git a/docs/platform/shakti_cclass.md b/docs/platform/shakti_cclass.md
index 2f4a699..05c9b3a 100644
--- a/docs/platform/shakti_cclass.md
+++ b/docs/platform/shakti_cclass.md
@@ -23,11 +23,11 @@ Building Shakti C-class Platform
**Linux Kernel Payload**
```
-make PLATFORM=generic FW_PAYLOAD_PATH=<linux_build_directory>/arch/riscv/boot/Image FW_PAYLOAD_FDT_PATH=<shakti.dtb path>
+make PLATFORM=generic FW_PAYLOAD_PATH=<linux_build_directory>/arch/riscv/boot/Image FW_FDT_PATH=<shakti.dtb path>
```
**Test Payload**
```
-make PLATFORM=generic FW_PAYLOAD_FDT_PATH=<shakti.dtb path>
+make PLATFORM=generic FW_FDT_PATH=<shakti.dtb path>
```
diff --git a/docs/platform/sifive_fu540.md b/docs/platform/sifive_fu540.md
index 1008432..c9513eb 100644
--- a/docs/platform/sifive_fu540.md
+++ b/docs/platform/sifive_fu540.md
@@ -29,13 +29,13 @@ DT (device tree) is not backward compatible with the DT passed from FSBL.
To use Linux v5.2 (or higher, the pre-built DTB (DT binary) from Linux v5.2
(or higher) should be used to build SiFive FU540 OpenSBI binaries by using
-the compile time option *FW_PAYLOAD_FDT_PATH*.
+the compile time option *FW_FDT_PATH*.
```
make PLATFORM=sifive/fu540 FW_PAYLOAD_PATH=<linux_build_directory>/arch/riscv/boot/Image
or
(For Linux v5.2 or higher)
-make PLATFORM=sifive/fu540 FW_PAYLOAD_PATH=<linux_build_directory>/arch/riscv/boot/Image FW_PAYLOAD_FDT_PATH=<hifive-unleashed-a00.dtb path from Linux kernel>
+make PLATFORM=sifive/fu540 FW_PAYLOAD_PATH=<linux_build_directory>/arch/riscv/boot/Image FW_FDT_PATH=<hifive-unleashed-a00.dtb path from Linux kernel>
```
**U-Boot Payload**
@@ -147,7 +147,7 @@ booti ${kernel_addr_r} - ${fdt_addr_r}
QEMU Specific Instructions
--------------------------
If you want to test OpenSBI with QEMU 'sifive_u' machine, please follow the
-same instructions above, with the exception of not passing FW_PAYLOAD_FDT_PATH.
+same instructions above, with the exception of not passing FW_FDT_PATH.
This is because QEMU generates a device tree blob on the fly based on the
command line parameters and it's compatible with the one used in the upstream