summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBin Meng <bmeng.cn@gmail.com>2021-07-12 03:48:02 +0300
committerAnup Patel <anup@brainfault.org>2021-07-17 15:13:37 +0300
commit2c74dc3c47f7e77b42735e383292de920273bf97 (patch)
tree648bf3bccfef4b7f2288a94d29e008d931913835 /docs
parenta4555e5698c1fbf5d89a849fbc8c01594401cf0a (diff)
downloadopensbi-2c74dc3c47f7e77b42735e383292de920273bf97.tar.xz
docs: Document FW_PIC compile time option
FW_PIC=y is on by default, but the doc is missing when this was introduced. Add some description for it. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Anup Patel <anup.patel@wdc.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/firmware/fw.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/firmware/fw.md b/docs/firmware/fw.md
index 913f939..5a67848 100644
--- a/docs/firmware/fw.md
+++ b/docs/firmware/fw.md
@@ -69,6 +69,12 @@ parameters:
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.
+* **FW_PIC** - "FW_PIC=y" generates position independent executable firmware
+ images. OpenSBI can run at arbitrary address with appropriate alignment.
+ Therefore, the original relocation mechanism ("FW_PIC=n") will be skipped.
+ In other words, OpenSBI will directly run at the load address without any
+ code movement. This option requires a toolchain with PIE support, and it
+ is on by default.
Additionally, each firmware type as a set of type specific configuration
parameters. Detailed information for each firmware type can be found in the