[PATCH v3 2/2] firmware: remove fixed address
Anup Patel
anup at brainfault.org
Fri Apr 5 02:58:11 PDT 2024
On Tue, Mar 12, 2024 at 1:56 PM Xiang W <wxjstz at 126.com> wrote:
>
> Now opensbi can run at any address via dynamic relocation. We can
> remove fixed addresses:FW_TEXT_START, FW_JUMP_ADDR, FW_JUMP_FDT_ADDR
> and FW_PAYLOAD_FDT_ADDR
There are platforms using FW_JUMP_ADDR, FW_JUMP_FDT_ADDR, and
FW_PAYLOAD_FDT_ADDR.
This patch should only remove FW_TEXT_START and keep other parameters.
Regards,
Anup
>
> Signed-off-by: Xiang W <wxjstz at 126.com>
> ---
> docs/firmware/fw.md | 2 --
> docs/firmware/fw_jump.md | 39 +++---------------------------
> docs/firmware/fw_payload.md | 20 +++++----------
> docs/platform/generic.md | 11 +++------
> firmware/fw_base.S | 4 +--
> firmware/fw_base.ldS | 3 +--
> firmware/fw_jump.S | 20 +++------------
> firmware/fw_payload.S | 4 +--
> firmware/fw_payload.elf.ldS | 2 +-
> firmware/objects.mk | 13 ----------
> firmware/payloads/test.elf.ldS | 2 +-
> platform/fpga/ariane/objects.mk | 9 +++----
> platform/fpga/openpiton/objects.mk | 9 +++----
> platform/generic/objects.mk | 3 +--
> platform/kendryte/k210/objects.mk | 1 -
> platform/nuclei/ux600/objects.mk | 7 +++---
> platform/template/objects.mk | 19 +--------------
> 17 files changed, 35 insertions(+), 133 deletions(-)
>
> diff --git a/docs/firmware/fw.md b/docs/firmware/fw.md
> index 2f4deb5..3cc0262 100644
> --- a/docs/firmware/fw.md
> +++ b/docs/firmware/fw.md
> @@ -61,8 +61,6 @@ Firmware Configuration and Compilation
> All firmware types support the following common compile time configuration
> parameters:
>
> -* **FW_TEXT_START** - 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
> diff --git a/docs/firmware/fw_jump.md b/docs/firmware/fw_jump.md
> index 2ee6b29..c6a14fc 100644
> --- a/docs/firmware/fw_jump.md
> +++ b/docs/firmware/fw_jump.md
> @@ -29,44 +29,13 @@ parameters to be defined using either the top level `make` command line or the
> target platform *objects.mk* configuration file. The possible parameters are as
> follows:
>
> -* **FW_JUMP_ADDR** - Address of the entry point of the booting stage to be
> - executed following OpenSBI firmware. This address generally corresponds
> - exactly to the address where this next booting stage was loaded.
> - At least one of *FW_JUMP_ADDR* and *FW_JUMP_OFFSET* (see below) should be
> - defined. Compilation errors will result from not defining one of them.
> -
> -* **FW_JUMP_OFFSET** - Address offset from the *FW_TEXT_START* where the
> +* **FW_JUMP_OFFSET** - Address offset from opensbi's load address where the
> entry point of the next booting stage is located. This offset is used as
> - relocatable address of the next booting stage entry point. If *FW_JUMP_ADDR*
> - is also defined, the firmware will prefer *FW_JUMP_ADDR*.
> -
> -* **FW_JUMP_FDT_ADDR** - Address where the *flattened device tree (FDT file)*
> - passed by the prior booting stage will be placed in memory before executing
> - the booting stage following the OpenSBI firmware. If this option is not
> - provided, then the OpenSBI firmware will pass the FDT address passed by the
> - previous booting stage to the next booting stage.
> -
> - When using the default *FW_JUMP_FDT_ADDR* with *PLATFORM=generic*, you must
> - ensure *FW_JUMP_FDT_ADDR* is set high enough to avoid overwriting the kernel.
> - You can use the following method (e.g., using bash or zsh):
> -
> - ```
> - ${CROSS_COMPILE}objdump -h $KERNEL_ELF | sort -k 5,5 | awk -n '
> - /^ +[0-9]+ / {addr="0x"$3; size="0x"$5; printf "0x""%x\n",addr+size}' |
> - (( `tail -1` > (FW_JUMP_FDT_ADDR - FW_JUMP_ADDR) )) &&
> - echo fdt overlaps kernel, increase FW_JUMP_FDT_ADDR
> -
> - ${LLVM}objdump -h --show-lma $KERNEL_ELF | sort -k 5,5 | awk -n '
> - /^ +[0-9]+ / {addr="0x"$3; size="0x"$5; printf "0x""%x\n",addr+size}' |
> - (( `tail -1` > (FW_JUMP_FDT_ADDR - FW_JUMP_ADDR) )) &&
> - echo fdt overlaps kernel, increase FW_JUMP_FDT_ADDR
> - ```
> + relocatable address of the next booting stage entry point.
>
> -* **FW_JUMP_FDT_OFFSET** - Address offset from the *FW_TEXT_START* where
> +* **FW_JUMP_FDT_OFFSET** - Address offset from opensbi's load address where
> the FDT will be passed to the next booting stage. This offset is used
> - as relocatable address of the FDT passed to the next booting stage. If
> - *FW_JUMP_FDT_ADDR* is also defined, the firmware will prefer
> - *FW_JUMP_FDT_ADDR*.
> + as relocatable address of the FDT passed to the next booting stage.
>
> *FW_JUMP* Example
> -----------------
> diff --git a/docs/firmware/fw_payload.md b/docs/firmware/fw_payload.md
> index a67fc50..da69d1b 100644
> --- a/docs/firmware/fw_payload.md
> +++ b/docs/firmware/fw_payload.md
> @@ -36,10 +36,10 @@ options. These configuration parameters can be defined using either the top
> level `make` command line or the target platform *objects.mk* configuration
> file. The parameters currently defined are as follows:
>
> -* **FW_PAYLOAD_OFFSET** - Offset from *FW_TEXT_START* where the payload binary
> - will be linked in the final *FW_PAYLOAD* firmware binary image. This
> - configuration parameter is mandatory if *FW_PAYLOAD_ALIGN* is not defined.
> - Compilation errors will result from an incorrect definition of
> +* **FW_PAYLOAD_OFFSET** - Address offset from opensbi's load address where
> + the payload binary will be linked in the final *FW_PAYLOAD* firmware binary
> + image. This configuration parameter is mandatory if *FW_PAYLOAD_ALIGN* is not
> + defined. Compilation errors will result from an incorrect definition of
> *FW_PAYLOAD_OFFSET* or of *FW_PAYLOAD_ALIGN*, or if neither of these
> parameters are defined.
>
> @@ -55,17 +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_ADDR** - Address where the FDT passed by the prior booting
> - 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.
> -
> -* **FW_PAYLOAD_FDT_OFFSET** - Address offset from the *FW_TEXT_START* where
> +* **FW_PAYLOAD_FDT_OFFSET** - Address offset from opensbi's load address where
> the FDT will be passed to the next booting stage. This offset is used as
> - relocatable address of the FDT passed to the next booting stage. If
> - *FW_PAYLOAD_FDT_ADDR* is also defined, the firmware will prefer *FW_PAYLOAD_FDT_ADDR*.
> + relocatable address of the FDT passed to the next booting stage.
>
> *FW_PAYLOAD* Example
> --------------------
> diff --git a/docs/platform/generic.md b/docs/platform/generic.md
> index c29eb04..709b436 100644
> --- a/docs/platform/generic.md
> +++ b/docs/platform/generic.md
> @@ -9,10 +9,9 @@ boards.
>
> By default, the generic FDT platform makes following assumptions:
>
> -1. platform FW_TEXT_START is 0x80000000
> -2. platform features are default
> -3. platform stack size is default
> -4. platform has no quirks or work-arounds
> +1. platform features are default
> +2. platform stack size is default
> +3. platform has no quirks or work-arounds
>
> The above assumptions (except 1) can be overridden by adding special platform
> callbacks which will be called based on FDT root node compatible string.
> @@ -33,10 +32,6 @@ Users of the generic FDT platform will have to ensure that:
> To build the platform-specific library and firmware images, provide the
> *PLATFORM=generic* parameter to the top level `make` command.
>
> -For custom FW_TEXT_START, we can build the platform-specific library and
> -firmware images by passing *PLATFORM=generic FW_TEXT_START=<custom_text_start>*
> -parameter to the top level `make` command.
> -
> Platform Options
> ----------------
>
> diff --git a/firmware/fw_base.S b/firmware/fw_base.S
> index 6013db3..16047ff 100644
> --- a/firmware/fw_base.S
> +++ b/firmware/fw_base.S
> @@ -53,9 +53,7 @@ _try_lottery:
> bnez a6, _wait_for_boot_hart
>
> /* relocate the global table content */
> - li t0, FW_TEXT_START /* link start */
> - lla t1, _fw_start /* load start */
> - sub t2, t1, t0 /* load offset */
> + lla t2, _fw_start
> lla t0, __rel_dyn_start
> lla t1, __rel_dyn_end
> beq t0, t1, _relocate_done
> diff --git a/firmware/fw_base.ldS b/firmware/fw_base.ldS
> index fb47984..0abddd7 100644
> --- a/firmware/fw_base.ldS
> +++ b/firmware/fw_base.ldS
> @@ -7,8 +7,7 @@
> * Anup Patel <anup.patel at wdc.com>
> */
>
> - . = FW_TEXT_START;
> - /* Don't add any section between FW_TEXT_START and _fw_start */
> + /* Don't add any section between before _fw_start */
> PROVIDE(_fw_start = .);
>
> . = ALIGN(0x1000); /* Need this to create proper sections */
> diff --git a/firmware/fw_jump.S b/firmware/fw_jump.S
> index ebf297f..873105f 100644
> --- a/firmware/fw_jump.S
> +++ b/firmware/fw_jump.S
> @@ -44,9 +44,7 @@ fw_save_info:
> * The next arg1 should be returned in 'a0'.
> */
> fw_next_arg1:
> -#ifdef FW_JUMP_FDT_ADDR
> - li a0, FW_JUMP_FDT_ADDR
> -#elif defined(FW_JUMP_FDT_OFFSET)
> +#if defined(FW_JUMP_FDT_OFFSET)
> lla a0, _fw_start
> li a1, FW_JUMP_FDT_OFFSET
> add a0, a0, a1
> @@ -63,16 +61,12 @@ fw_next_arg1:
> * The next address should be returned in 'a0'.
> */
> fw_next_addr:
> -#ifdef FW_JUMP_ADDR
> - lla a0, _jump_addr
> - REG_L a0, (a0)
> -#elif defined(FW_JUMP_OFFSET)
> +#if !defined(FW_JUMP_OFFSET)
> +#error "FW_JUMP_OFFSET must be defined"
> +#endif
> lla a0, _fw_start
> li a1, FW_JUMP_OFFSET
> add a0, a0, a1
> -#else
> -#error "Must define at least FW_JUMP_ADDR or FW_JUMP_OFFSET"
> -#endif
> ret
>
> .section .entry, "ax", %progbits
> @@ -98,9 +92,3 @@ fw_options:
> add a0, zero, zero
> ret
>
> -#ifdef FW_JUMP_ADDR
> - .section .rodata
> - .align 3
> -_jump_addr:
> - RISCV_PTR FW_JUMP_ADDR
> -#endif
> diff --git a/firmware/fw_payload.S b/firmware/fw_payload.S
> index 3c8433e..5a149e6 100644
> --- a/firmware/fw_payload.S
> +++ b/firmware/fw_payload.S
> @@ -44,9 +44,7 @@ fw_save_info:
> * The next arg1 should be returned in 'a0'.
> */
> fw_next_arg1:
> -#ifdef FW_PAYLOAD_FDT_ADDR
> - li a0, FW_PAYLOAD_FDT_ADDR
> -#elif defined(FW_PAYLOAD_FDT_OFFSET)
> +#if defined(FW_PAYLOAD_FDT_OFFSET)
> lla a0, _fw_start
> li a1, FW_PAYLOAD_FDT_OFFSET
> add a0, a0, a1
> diff --git a/firmware/fw_payload.elf.ldS b/firmware/fw_payload.elf.ldS
> index f1a544b..94e1ac6 100644
> --- a/firmware/fw_payload.elf.ldS
> +++ b/firmware/fw_payload.elf.ldS
> @@ -15,7 +15,7 @@ SECTIONS
> #include "fw_base.ldS"
>
> #ifdef FW_PAYLOAD_OFFSET
> - . = FW_TEXT_START + FW_PAYLOAD_OFFSET;
> + . = FW_PAYLOAD_OFFSET;
> #else
> . = ALIGN(FW_PAYLOAD_ALIGN);
> #endif
> diff --git a/firmware/objects.mk b/firmware/objects.mk
> index e6b364b..121b754 100644
> --- a/firmware/objects.mk
> +++ b/firmware/objects.mk
> @@ -13,10 +13,6 @@ firmware-cflags-y +=
> firmware-asflags-y +=
> firmware-ldflags-y +=
>
> -ifdef FW_TEXT_START
> -firmware-genflags-y += -DFW_TEXT_START=$(FW_TEXT_START)
> -endif
> -
> ifdef FW_FDT_PATH
> firmware-genflags-y += -DFW_FDT_PATH=\"$(FW_FDT_PATH)\"
> ifdef FW_FDT_PADDING
> @@ -30,15 +26,9 @@ firmware-bins-$(FW_JUMP) += fw_jump.bin
> ifdef FW_JUMP_OFFSET
> firmware-genflags-$(FW_JUMP) += -DFW_JUMP_OFFSET=$(FW_JUMP_OFFSET)
> endif
> -ifdef FW_JUMP_ADDR
> -firmware-genflags-$(FW_JUMP) += -DFW_JUMP_ADDR=$(FW_JUMP_ADDR)
> -endif
> ifdef FW_JUMP_FDT_OFFSET
> firmware-genflags-$(FW_JUMP) += -DFW_JUMP_FDT_OFFSET=$(FW_JUMP_FDT_OFFSET)
> endif
> -ifdef FW_JUMP_FDT_ADDR
> -firmware-genflags-$(FW_JUMP) += -DFW_JUMP_FDT_ADDR=$(FW_JUMP_FDT_ADDR)
> -endif
>
> firmware-bins-$(FW_PAYLOAD) += fw_payload.bin
> ifdef FW_PAYLOAD_PATH
> @@ -57,9 +47,6 @@ endif
> ifdef FW_PAYLOAD_FDT_OFFSET
> firmware-genflags-$(FW_PAYLOAD) += -DFW_PAYLOAD_FDT_OFFSET=$(FW_PAYLOAD_FDT_OFFSET)
> endif
> -ifdef FW_PAYLOAD_FDT_ADDR
> -firmware-genflags-$(FW_PAYLOAD) += -DFW_PAYLOAD_FDT_ADDR=$(FW_PAYLOAD_FDT_ADDR)
> -endif
>
> ifdef FW_OPTIONS
> firmware-genflags-y += -DFW_OPTIONS=$(FW_OPTIONS)
> diff --git a/firmware/payloads/test.elf.ldS b/firmware/payloads/test.elf.ldS
> index 2328a1b..08e008f 100644
> --- a/firmware/payloads/test.elf.ldS
> +++ b/firmware/payloads/test.elf.ldS
> @@ -13,7 +13,7 @@ ENTRY(_start)
> SECTIONS
> {
> #ifdef FW_PAYLOAD_OFFSET
> - . = FW_TEXT_START + FW_PAYLOAD_OFFSET;
> + . = FW_PAYLOAD_OFFSET;
> #else
> . = ALIGN(FW_PAYLOAD_ALIGN);
> #endif
> diff --git a/platform/fpga/ariane/objects.mk b/platform/fpga/ariane/objects.mk
> index 83581ac..38fdd00 100644
> --- a/platform/fpga/ariane/objects.mk
> +++ b/platform/fpga/ariane/objects.mk
> @@ -17,17 +17,16 @@ platform-objs-y += platform.o
> PLATFORM_RISCV_XLEN = 64
>
> # Blobs to build
> -FW_TEXT_START=0x80000000
> FW_JUMP=n
>
> ifeq ($(PLATFORM_RISCV_XLEN), 32)
> # This needs to be 4MB aligned for 32-bit support
> - FW_JUMP_ADDR=0x80400000
> + FW_JUMP_OFFSET=0x400000
> else
> # This needs to be 2MB aligned for 64-bit support
> - FW_JUMP_ADDR=0x80200000
> + FW_JUMP_OFFSET=0x200000
> endif
> -FW_JUMP_FDT_ADDR=0x82200000
> +FW_JUMP_FDT_OFFSET=0x2200000
>
> # Firmware with payload configuration.
> FW_PAYLOAD=y
> @@ -39,5 +38,5 @@ else
> # This needs to be 2MB aligned for 64-bit support
> FW_PAYLOAD_OFFSET=0x200000
> endif
> -FW_PAYLOAD_FDT_ADDR=0x82200000
> +FW_PAYLOAD_FDT_OFFSET=0x2200000
> FW_PAYLOAD_ALIGN=0x1000
> diff --git a/platform/fpga/openpiton/objects.mk b/platform/fpga/openpiton/objects.mk
> index c8c345a..b7833c3 100644
> --- a/platform/fpga/openpiton/objects.mk
> +++ b/platform/fpga/openpiton/objects.mk
> @@ -16,17 +16,16 @@ platform-objs-y += platform.o
> PLATFORM_RISCV_XLEN = 64
>
> # Blobs to build
> -FW_TEXT_START=0x80000000
> FW_JUMP=n
>
> ifeq ($(PLATFORM_RISCV_XLEN), 32)
> # This needs to be 4MB aligned for 32-bit support
> - FW_JUMP_ADDR=0x80400000
> + FW_JUMP_OFFSET=0x400000
> else
> # This needs to be 2MB aligned for 64-bit support
> - FW_JUMP_ADDR=0x80200000
> + FW_JUMP_OFFSET=0x200000
> endif
> -FW_JUMP_FDT_ADDR=0x82200000
> +FW_JUMP_FDT_OFFSET=0x2200000
>
> # Firmware with payload configuration.
> FW_PAYLOAD=y
> @@ -38,5 +37,5 @@ else
> # This needs to be 2MB aligned for 64-bit support
> FW_PAYLOAD_OFFSET=0x200000
> endif
> -FW_PAYLOAD_FDT_ADDR=0x82200000
> +FW_PAYLOAD_FDT_OFFSET=0x2200000
> FW_PAYLOAD_ALIGN=0x1000
> diff --git a/platform/generic/objects.mk b/platform/generic/objects.mk
> index 85aa723..c215935 100644
> --- a/platform/generic/objects.mk
> +++ b/platform/generic/objects.mk
> @@ -15,14 +15,13 @@ platform-ldflags-y =
>
> # Command for platform specific "make run"
> platform-runcmd = qemu-system-riscv$(PLATFORM_RISCV_XLEN) -M virt -m 256M \
> - -nographic -bios $(build_dir)/platform/generic/firmware/fw_payload.elf
> + -nographic -bios $(build_dir)/platform/generic/firmware/fw_payload.bin
>
> # Objects to build
> platform-objs-y += platform.o
> platform-objs-y += platform_override_modules.o
>
> # Blobs to build
> -FW_TEXT_START=0x80000000
> FW_DYNAMIC=y
> FW_JUMP=y
> ifeq ($(PLATFORM_RISCV_XLEN), 32)
> diff --git a/platform/kendryte/k210/objects.mk b/platform/kendryte/k210/objects.mk
> index 1bfb898..efac3d2 100644
> --- a/platform/kendryte/k210/objects.mk
> +++ b/platform/kendryte/k210/objects.mk
> @@ -21,6 +21,5 @@ platform-varprefix-k210.o = dt_k210
> platform-padding-k210.o = 2048
>
> # Blobs to build
> -FW_TEXT_START=0x80000000
> FW_PAYLOAD=y
> FW_PAYLOAD_ALIGN=0x1000
> diff --git a/platform/nuclei/ux600/objects.mk b/platform/nuclei/ux600/objects.mk
> index 7c429e0..5ce94e7 100644
> --- a/platform/nuclei/ux600/objects.mk
> +++ b/platform/nuclei/ux600/objects.mk
> @@ -22,12 +22,11 @@ platform-runcmd = xl_spike \
> platform-objs-y += platform.o
>
> # Blobs to build
> -FW_TEXT_START=0xA0000000
> FW_DYNAMIC=y
> FW_JUMP=y
>
> -FW_JUMP_ADDR=0xA0200000
> -FW_JUMP_FDT_ADDR=0xA8000000
> +FW_JUMP_OFFSET=0x200000
> +FW_JUMP_FDT_OFFSET=0x8000000
> FW_PAYLOAD=y
> FW_PAYLOAD_OFFSET=0x200000
> -FW_PAYLOAD_FDT_ADDR=0xA8000000
> +FW_PAYLOAD_FDT_OFFSET=0x8000000
> diff --git a/platform/template/objects.mk b/platform/template/objects.mk
> index b143cbc..526e6f5 100644
> --- a/platform/template/objects.mk
> +++ b/platform/template/objects.mk
> @@ -41,9 +41,6 @@ platform-objs-y += platform.o
> #
> # platform-objs-y += <dt file name>.o
>
> -# Firmware load address configuration. This is mandatory.
> -FW_TEXT_START=0x80000000
> -
> # Optional parameter for path to external FDT
> # FW_FDT_PATH="path to platform flattened device tree file"
>
> @@ -69,16 +66,6 @@ FW_JUMP=<y|n>
> # endif
> # FW_JUMP_FDT_OFFSET=0x2200000
> #
> -# You can use fixed address for jump firmware as an alternative option,
> -# but this may fail when setting wrong FW_TEXT_START. Use with caution.
> -# SBI will prefer "<X>_ADDR" if both "<X>_ADDR" and "<X>_OFFSET" are
> -# defined
> -# ifeq ($(PLATFORM_RISCV_XLEN), 32)
> -# FW_JUMP_ADDR=0x80400000
> -# else
> -# FW_JUMP_ADDR=0x80200000
> -# endif
> -# FW_JUMP_FDT_ADDR=0x82200000
>
> #
> # Firmware with payload configuration.
> @@ -97,8 +84,4 @@ endif
> # FW_PAYLOAD_PATH="path to next boot stage binary image file"
> # FW_PAYLOAD_FDT_OFFSET=0x2200000
> #
> -# You can use fixed address for payload firmware as an alternative option,
> -# but this may fail when setting wrong FW_TEXT_START. Use with caution.
> -# SBI will prefer "FW_PAYLOAD_FDT_ADDR" if both "FW_PAYLOAD_FDT_OFFSET"
> -# and "FW_PAYLOAD_FDT_ADDR" are defined.
> -# FW_PAYLOAD_FDT_ADDR=0x82200000
> +
> --
> 2.43.0
>
>
> --
> opensbi mailing list
> opensbi at lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/opensbi
More information about the opensbi
mailing list