| Message ID | 20220328024351.629189-1-bmeng.cn@gmail.com |
|---|---|
| State | Accepted, archived |
| Delegated to: | Heinrich Schuchardt |
| Headers | show |
| Series | [1/3] doc: usage: Convert README.vxworks to reST | expand |
On 3/28/22 04:43, Bin Meng wrote: > This converts the existing README.vxworks to reST, and puts it under > the doc/usage/os directory. > > Signed-off-by: Bin Meng <bmeng.cn@gmail.com> > --- > > doc/usage/index.rst | 8 +++++++ > doc/{README.vxworks => usage/os/vxworks.rst} | 22 ++++++++++---------- > 2 files changed, 19 insertions(+), 11 deletions(-) > rename doc/{README.vxworks => usage/os/vxworks.rst} (93%) > > diff --git a/doc/usage/index.rst b/doc/usage/index.rst > index 0aacf531b2..b8916971bc 100644 > --- a/doc/usage/index.rst > +++ b/doc/usage/index.rst > @@ -52,3 +52,11 @@ Shell commands > size > true > ums > + > +Booting OS > +---------- > + > +.. toctree:: > + :maxdepth: 1 > + > + os/vxworks > diff --git a/doc/README.vxworks b/doc/usage/os/vxworks.rst > similarity index 93% > rename from doc/README.vxworks > rename to doc/usage/os/vxworks.rst > index 12a0d744d8..e696c639b2 100644 > --- a/doc/README.vxworks > +++ b/doc/usage/os/vxworks.rst > @@ -1,11 +1,10 @@ > -# SPDX-License-Identifier: GPL-2.0+ > -# > -# Copyright (C) 2013, Miao Yan <miao.yan@windriver.com> > -# Copyright (C) 2015-2018, Bin Meng <bmeng.cn@gmail.com> > -# Copyright (C) 2019, Lihua Zhao <lihua.zhao@windriver.com> > +.. SPDX-License-Identifier: GPL-2.0+ > +.. Copyright (C) 2013, Miao Yan <miao.yan@windriver.com> > +.. Copyright (C) 2015-2018, Bin Meng <bmeng.cn@gmail.com> > +.. Copyright (C) 2019, Lihua Zhao <lihua.zhao@windriver.com> > > -VxWorks Support > -=============== > +VxWorks > +======= > > This document describes the information about U-Boot loading VxWorks kernel. > > @@ -20,7 +19,7 @@ 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 > ---------------------------- > +---------------------------- > 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. > @@ -35,11 +34,11 @@ For legacy bootm flow, make sure the least significant bit of flags in bootargs > is cleared. The calling convention is described below: > > For PowerPC, the calling convention of the new VxWorks entry point conforms to > -the ePAPR standard, which is shown below (see ePAPR for more details): > +the ePAPR standard, which is shown below (see ePAPR for more details):: .. code-block:: c Nits: Syntaxhighlighting depends on specifying the language. > > void (*kernel_entry)(fdt_addr, 0, 0, EPAPR_MAGIC, boot_IMA, 0, 0) > > -For ARM, the calling convention is shown below: > +For ARM, the calling convention is shown below:: .. code-block:: c Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de> > > void (*kernel_entry)(void *fdt_addr) > > @@ -47,7 +46,7 @@ When using the Linux compatible standard DTB, the calling convention of VxWorks > entry point is exactly the same as the Linux kernel. > > When booting a VxWorks 7 kernel (uImage format), the parameters passed to bootm > -is like below: > +is like below:: > > bootm <kernel image address> - <device tree address> > > @@ -108,6 +107,7 @@ BIOS of the graphics card first. > CONFIG_FRAMEBUFFER_SET_VESA_MODE need remain set but care must be taken > at which VESA mode is to be set. The supported pixel format is 32-bit > RGBA, hence the available VESA mode can only be one of the following: > + > * FRAMEBUFFER_VESA_MODE_10F > * FRAMEBUFFER_VESA_MODE_112 > * FRAMEBUFFER_VESA_MODE_115
diff --git a/doc/usage/index.rst b/doc/usage/index.rst index 0aacf531b2..b8916971bc 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -52,3 +52,11 @@ Shell commands size true ums + +Booting OS +---------- + +.. toctree:: + :maxdepth: 1 + + os/vxworks diff --git a/doc/README.vxworks b/doc/usage/os/vxworks.rst similarity index 93% rename from doc/README.vxworks rename to doc/usage/os/vxworks.rst index 12a0d744d8..e696c639b2 100644 --- a/doc/README.vxworks +++ b/doc/usage/os/vxworks.rst @@ -1,11 +1,10 @@ -# SPDX-License-Identifier: GPL-2.0+ -# -# Copyright (C) 2013, Miao Yan <miao.yan@windriver.com> -# Copyright (C) 2015-2018, Bin Meng <bmeng.cn@gmail.com> -# Copyright (C) 2019, Lihua Zhao <lihua.zhao@windriver.com> +.. SPDX-License-Identifier: GPL-2.0+ +.. Copyright (C) 2013, Miao Yan <miao.yan@windriver.com> +.. Copyright (C) 2015-2018, Bin Meng <bmeng.cn@gmail.com> +.. Copyright (C) 2019, Lihua Zhao <lihua.zhao@windriver.com> -VxWorks Support -=============== +VxWorks +======= This document describes the information about U-Boot loading VxWorks kernel. @@ -20,7 +19,7 @@ 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 ---------------------------- +---------------------------- 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. @@ -35,11 +34,11 @@ For legacy bootm flow, make sure the least significant bit of flags in bootargs is cleared. The calling convention is described below: For PowerPC, the calling convention of the new VxWorks entry point conforms to -the ePAPR standard, which is shown below (see ePAPR for more details): +the ePAPR standard, which is shown below (see ePAPR for more details):: void (*kernel_entry)(fdt_addr, 0, 0, EPAPR_MAGIC, boot_IMA, 0, 0) -For ARM, the calling convention is shown below: +For ARM, the calling convention is shown below:: void (*kernel_entry)(void *fdt_addr) @@ -47,7 +46,7 @@ When using the Linux compatible standard DTB, the calling convention of VxWorks entry point is exactly the same as the Linux kernel. When booting a VxWorks 7 kernel (uImage format), the parameters passed to bootm -is like below: +is like below:: bootm <kernel image address> - <device tree address> @@ -108,6 +107,7 @@ BIOS of the graphics card first. CONFIG_FRAMEBUFFER_SET_VESA_MODE need remain set but care must be taken at which VESA mode is to be set. The supported pixel format is 32-bit RGBA, hence the available VESA mode can only be one of the following: + * FRAMEBUFFER_VESA_MODE_10F * FRAMEBUFFER_VESA_MODE_112 * FRAMEBUFFER_VESA_MODE_115
This converts the existing README.vxworks to reST, and puts it under the doc/usage/os directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> --- doc/usage/index.rst | 8 +++++++ doc/{README.vxworks => usage/os/vxworks.rst} | 22 ++++++++++---------- 2 files changed, 19 insertions(+), 11 deletions(-) rename doc/{README.vxworks => usage/os/vxworks.rst} (93%)