summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAnup Patel <anup.patel@wdc.com>2020-10-14 13:33:35 +0300
committerAnup Patel <anup@brainfault.org>2020-10-18 07:58:26 +0300
commit6ca096977d723f3ac50291d668719bd938a85544 (patch)
tree080b13bd140acc05ef08066dcb35586553bd90b9 /docs
parentaf4b50f896684040dd3f56f2fdcad702f527c633 (diff)
downloadopensbi-6ca096977d723f3ac50291d668719bd938a85544.tar.xz
firmware: Add common FW_FDT_PATH compile-time option
Currently, only FW_PAYLOAD has mechanism to embed external FDT using FW_PAYLOAD_FDT_PATH compile-time option. This patch adds a common FW_FDT_PATH compile-time option to embed external FDT for all OpenSBI firmwares (i.e FW_JUMP, FW_PAYLOAD, and FW_DYNAMIC). 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.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/docs/firmware/fw.md b/docs/firmware/fw.md
index 4133c23..cc0cc9e 100644
--- a/docs/firmware/fw.md
+++ b/docs/firmware/fw.md
@@ -51,11 +51,17 @@ case, a *FW_PAYLOAD* firmware allows embedding a flattened device tree in the
Firmware Configuration and Compilation
--------------------------------------
-All firmware types mandate the definition of the following compile time
-configuration parameter.
-
-* **FW_TEXT_ADDR** - Defines the address at which the previous booting stage
- loads OpenSBI firmware.
+All firmware types support the following common compile time configuration
+parameters:
+
+* **FW_TEXT_ADDR** - Defines the execution address of the OpenSBI firmware.
+ This configuration parameter is mandatory.
+* **FW_FDT_PATH** - Path to an external flattened device tree binary file to
+ be embedded in the *.rodata* 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_FDT_PADDING** - Optional zero bytes padding to the embedded flattened
+ device tree binary file specified by **FW_FDT_PATH** option.
Additionally, each firmware type as a set of type specific configuration
parameters. Detailed information for each firmware type can be found in the