opensbi.git/docs/firmware, branch release-1.3.x

docs: Correct FW_JUMP_FDT_ADDR calculation example

2023-04-07T05:46:05Z

When using `PLATFORM=generic` defaults, the kernel is loaded at `FW_JUMP_ADDR`, and the FDT is loaded at `FW_JUMP_FDT_ADDR. Therefore, the maximum kernel size before `FW_JUMP_FDT_ADDR` must be increased is `$(( FW_JUMP_FDT_ADDR - FW_JUMP_ADDR ))`. The example calculation assumes `rv64`, and is wrong to boot (off by 0x200000). Fix it and update it for the general case. Signed-off-by: Gabriel Somlo Reviewed-by: Andrew Jones Reviewed-by: Xiang W

docs: fix typo in fw.md

2023-02-27T05:24:42Z

In docs/firmware/fw.md, there's a configuration parameter called FW_TEXT_ADDR, which actually should be FW_TEXT_START, so fix it. Signed-off-by: Shengyu Qu Reviewed-by: Xiang W Reviewed-by: Anup Patel

docs: fix some typos

2022-11-14T16:51:31Z

Corrected the typos of some documents in the 'docs' folder. Signed-off-by: zhangdongdong Reviewed-by: Anup Patel

docs/firmware: update the document

2022-10-23T05:19:39Z

Since commit 9c07c513aa9b ("firmware:Remove FW_PAYLOAD_FDT_PATH compile-time option"), the section where FDT would be embedded in has changed from *.text* to *.rodata*, but some places in fw_payload.md and fw.md are still *.text*. This patch updates the document. Signed-off-by: Yangjie Zhang Reviewed-by: Bin Meng Reviewed-by: Anup Patel

docs/firmware: Update FW_JUMP documentation

2022-10-13T03:55:15Z

Add a tip for OpenSBI's FW_JUMP which helps users avoid overwriting the kernel. Signed-off-by: Nylon Chen Reviewed-by: Andrew Jones Reviewed-by: Anup Patel

docs: Update documentation for kconfig support

2022-08-08T04:04:31Z

We update all documentation files to: 1) Remove references to platform specific config.mk file since it is has been removed. 2) Add details about platform specific configs/defconfig and Kconfig files mandatory for each platform. 3) Add required packages in top-level README.md 4) Fix typo releated to object.mk in docs/platform/platform.md Signed-off-by: Anup Patel Reviewed-by: Andrew Jones Tested-by: Andrew Jones Acked-by: Atish Patra Tested-by: Atish Patra

docs: Document FW_PIC compile time option

2021-07-17T12:13:37Z

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 Reviewed-by: Anup Patel

docs: Document parameters passed to firmware and alignment requirement

2021-07-17T12:00:48Z

This updates documentation to describe parameters passed to firmware from previous booting stage, and corresponding address alignment requirement. This also fixes a typo in fw_dynamic.md (it's => its). Signed-off-by: Bin Meng Reviewed-by: Anup Patel

firmware: Remove FW_PAYLOAD_FDT_PATH compile-time option

2020-10-18T04:59:59Z

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 Reviewed-by: Atish Patra

firmware: Add common FW_FDT_PATH compile-time option

2020-10-18T04:58:26Z

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 Reviewed-by: Atish Patra