diff mbox series

[2/3] doc: usage: Update vxworks doc to mention RISC-V support

Message ID 20220328024351.629189-2-bmeng.cn@gmail.com
State Accepted, archived
Commit 7fc86c7ed8e3cbfbbf9a08169fd55997f4ee0f0c
Delegated to: Heinrich Schuchardt
Headers show
Series [1/3] doc: usage: Convert README.vxworks to reST | expand

Commit Message

Bin Meng March 28, 2022, 2:43 a.m. UTC
At present the doc only mentions Arm, PowerPC and x86. RISC-V support
has been added since VxWorks SR0650 support for a while, and U-Boot
supports loading a RISC-V VxWorks kernel too. Let's document it.

Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
---

 doc/usage/os/vxworks.rst | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

Comments

Heinrich Schuchardt March 29, 2022, 5 p.m. UTC | #1
On 3/28/22 04:43, Bin Meng wrote:
> At present the doc only mentions Arm, PowerPC and x86. RISC-V support
> has been added since VxWorks SR0650 support for a while, and U-Boot
> supports loading a RISC-V VxWorks kernel too. Let's document it.
> 
> Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
> ---
> 
>   doc/usage/os/vxworks.rst | 11 ++++++++---
>   1 file changed, 8 insertions(+), 3 deletions(-)
> 
> diff --git a/doc/usage/os/vxworks.rst b/doc/usage/os/vxworks.rst
> index e696c639b2..e732f711fb 100644
> --- a/doc/usage/os/vxworks.rst
> +++ b/doc/usage/os/vxworks.rst
> @@ -13,13 +13,13 @@ Status
>   U-Boot supports loading VxWorks kernels via 'bootvx' and 'bootm' commands.
>   For booting old kernels (6.9.x) on PowerPC and ARM, and all kernel versions
>   on other architectures, 'bootvx' shall be used. For booting VxWorks 7 kernels

A man-page for bootvx might be useful.

> -on PowerPC and ARM, 'bootm' shall be used.
> +on PowerPC/ARM/RISC-V, 'bootm' shall be used.
>   
>   With CONFIG_EFI_LOADER option, it's possible to chain load a VxWorks x86 kernel
>   via the UEFI boot loader application for VxWorks loaded by 'bootefi' command.
>   
> -VxWorks 7 on PowerPC and ARM
> -----------------------------
> +VxWorks 7 on PowerPC/ARM/RISC-V
> +-------------------------------
>   From VxWorks 7, VxWorks starts adopting device tree as its hardware description
>   mechanism (for PowerPC and ARM), thus requiring boot interface changes.
>   This section will describe the new interface.
> @@ -45,6 +45,11 @@ For ARM, the calling convention is shown below::
>   When using the Linux compatible standard DTB, the calling convention of VxWorks
>   entry point is exactly the same as the Linux kernel.
>   
> +For RISC-V, there is no legacy bootm flow as VxWorks always uses the same boot
> +interface as the Linux kernel, with the calling convention below::
> +

Nits: .. code-block:: C

Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

> +    void (*kernel_entry)(unsigned long hartid, void *fdt_addr)
> +
>   When booting a VxWorks 7 kernel (uImage format), the parameters passed to bootm
>   is like below::
>
diff mbox series

Patch

diff --git a/doc/usage/os/vxworks.rst b/doc/usage/os/vxworks.rst
index e696c639b2..e732f711fb 100644
--- a/doc/usage/os/vxworks.rst
+++ b/doc/usage/os/vxworks.rst
@@ -13,13 +13,13 @@  Status
 U-Boot supports loading VxWorks kernels via 'bootvx' and 'bootm' commands.
 For booting old kernels (6.9.x) on PowerPC and ARM, and all kernel versions
 on other architectures, 'bootvx' shall be used. For booting VxWorks 7 kernels
-on PowerPC and ARM, 'bootm' shall be used.
+on PowerPC/ARM/RISC-V, 'bootm' shall be used.
 
 With CONFIG_EFI_LOADER option, it's possible to chain load a VxWorks x86 kernel
 via the UEFI boot loader application for VxWorks loaded by 'bootefi' command.
 
-VxWorks 7 on PowerPC and ARM
-----------------------------
+VxWorks 7 on PowerPC/ARM/RISC-V
+-------------------------------
 From VxWorks 7, VxWorks starts adopting device tree as its hardware description
 mechanism (for PowerPC and ARM), thus requiring boot interface changes.
 This section will describe the new interface.
@@ -45,6 +45,11 @@  For ARM, the calling convention is shown below::
 When using the Linux compatible standard DTB, the calling convention of VxWorks
 entry point is exactly the same as the Linux kernel.
 
+For RISC-V, there is no legacy bootm flow as VxWorks always uses the same boot
+interface as the Linux kernel, with the calling convention below::
+
+    void (*kernel_entry)(unsigned long hartid, void *fdt_addr)
+
 When booting a VxWorks 7 kernel (uImage format), the parameters passed to bootm
 is like below::