summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTom Rini <[email protected]>2022-03-31 22:35:34 -0400
committerTom Rini <[email protected]>2022-03-31 22:35:34 -0400
commit5aa5a9b0d249923d966ea08c58354f86a23a882a (patch)
tree707274d1402e53f85c302cca7b7654efe72cbcc2 /doc
parentf432eb6d8a9d8a9382f6e7f0096fb4ee4672b8e8 (diff)
parentb6370aca3709ef23a9e8fe556beaa2e4b4e089c3 (diff)
Merge tag 'efi-2022-04-rc6' of https://source.denx.de/u-boot/custodians/u-boot-efi
Pull request for efi-2022-04-rc6 Documentation: * Move VxWorks and Plan 9 to HTML documentation * Move all command man-pages to a separate directory Test: * Fix pylint errors UEFI * Fix build flags for initrddump.efi QEMU * Remove unused function to get RNG device
Diffstat (limited to 'doc')
-rw-r--r--doc/usage/cmd/acpi.rst (renamed from doc/usage/acpi.rst)0
-rw-r--r--doc/usage/cmd/addrmap.rst (renamed from doc/usage/addrmap.rst)0
-rw-r--r--doc/usage/cmd/askenv.rst (renamed from doc/usage/askenv.rst)0
-rw-r--r--doc/usage/cmd/base.rst (renamed from doc/usage/base.rst)0
-rw-r--r--doc/usage/cmd/bootefi.rst (renamed from doc/usage/bootefi.rst)0
-rw-r--r--doc/usage/cmd/booti.rst (renamed from doc/usage/booti.rst)0
-rw-r--r--doc/usage/cmd/bootmenu.rst (renamed from doc/usage/bootmenu.rst)0
-rw-r--r--doc/usage/cmd/button.rst (renamed from doc/usage/button.rst)0
-rw-r--r--doc/usage/cmd/cbsysinfo.rst (renamed from doc/usage/x86/cbsysinfo.rst)0
-rw-r--r--doc/usage/cmd/conitrace.rst (renamed from doc/usage/conitrace.rst)0
-rw-r--r--doc/usage/cmd/echo.rst (renamed from doc/usage/echo.rst)0
-rw-r--r--doc/usage/cmd/exception.rst (renamed from doc/usage/exception.rst)0
-rw-r--r--doc/usage/cmd/exit.rst (renamed from doc/usage/exit.rst)0
-rw-r--r--doc/usage/cmd/extension.rst (renamed from doc/usage/extension.rst)4
-rw-r--r--doc/usage/cmd/false.rst (renamed from doc/usage/false.rst)0
-rw-r--r--doc/usage/cmd/fatinfo.rst (renamed from doc/usage/fatinfo.rst)0
-rw-r--r--doc/usage/cmd/fatload.rst (renamed from doc/usage/fatload.rst)0
-rw-r--r--doc/usage/cmd/for.rst (renamed from doc/usage/for.rst)0
-rw-r--r--doc/usage/cmd/load.rst (renamed from doc/usage/load.rst)0
-rw-r--r--doc/usage/cmd/loady.rst (renamed from doc/usage/loady.rst)0
-rw-r--r--doc/usage/cmd/mbr.rst (renamed from doc/usage/mbr.rst)0
-rw-r--r--doc/usage/cmd/md.rst (renamed from doc/usage/md.rst)2
-rw-r--r--doc/usage/cmd/mmc.rst (renamed from doc/usage/mmc.rst)34
-rw-r--r--doc/usage/cmd/pinmux.rst (renamed from doc/usage/pinmux.rst)0
-rw-r--r--doc/usage/cmd/pstore.rst (renamed from doc/usage/pstore.rst)0
-rw-r--r--doc/usage/cmd/qfw.rst (renamed from doc/usage/qfw.rst)0
-rw-r--r--doc/usage/cmd/reset.rst (renamed from doc/usage/reset.rst)0
-rw-r--r--doc/usage/cmd/sbi.rst (renamed from doc/usage/sbi.rst)0
-rw-r--r--doc/usage/cmd/scp03.rst (renamed from doc/usage/scp03.rst)0
-rw-r--r--doc/usage/cmd/setexpr.rst (renamed from doc/usage/setexpr.rst)0
-rw-r--r--doc/usage/cmd/sf.rst (renamed from doc/usage/sf.rst)0
-rw-r--r--doc/usage/cmd/size.rst (renamed from doc/usage/size.rst)0
-rw-r--r--doc/usage/cmd/true.rst (renamed from doc/usage/true.rst)0
-rw-r--r--doc/usage/cmd/ums.rst (renamed from doc/usage/ums.rst)0
-rw-r--r--doc/usage/cmd/wdt.rst (renamed from doc/usage/wdt.rst)0
-rw-r--r--doc/usage/index.rst79
-rw-r--r--doc/usage/os/plan9.rst (renamed from doc/README.plan9)12
-rw-r--r--doc/usage/os/vxworks.rst (renamed from doc/README.vxworks)31
38 files changed, 93 insertions, 69 deletions
diff --git a/doc/usage/acpi.rst b/doc/usage/cmd/acpi.rst
index 14bafc8e352..14bafc8e352 100644
--- a/doc/usage/acpi.rst
+++ b/doc/usage/cmd/acpi.rst
diff --git a/doc/usage/addrmap.rst b/doc/usage/cmd/addrmap.rst
index 472fd547f32..472fd547f32 100644
--- a/doc/usage/addrmap.rst
+++ b/doc/usage/cmd/addrmap.rst
diff --git a/doc/usage/askenv.rst b/doc/usage/cmd/askenv.rst
index 5c4ca35d4cd..5c4ca35d4cd 100644
--- a/doc/usage/askenv.rst
+++ b/doc/usage/cmd/askenv.rst
diff --git a/doc/usage/base.rst b/doc/usage/cmd/base.rst
index db9cd4d9783..db9cd4d9783 100644
--- a/doc/usage/base.rst
+++ b/doc/usage/cmd/base.rst
diff --git a/doc/usage/bootefi.rst b/doc/usage/cmd/bootefi.rst
index 282f22aac96..282f22aac96 100644
--- a/doc/usage/bootefi.rst
+++ b/doc/usage/cmd/bootefi.rst
diff --git a/doc/usage/booti.rst b/doc/usage/cmd/booti.rst
index d631fb571de..d631fb571de 100644
--- a/doc/usage/booti.rst
+++ b/doc/usage/cmd/booti.rst
diff --git a/doc/usage/bootmenu.rst b/doc/usage/cmd/bootmenu.rst
index 1f094ad6ed2..1f094ad6ed2 100644
--- a/doc/usage/bootmenu.rst
+++ b/doc/usage/cmd/bootmenu.rst
diff --git a/doc/usage/button.rst b/doc/usage/cmd/button.rst
index ea417627577..ea417627577 100644
--- a/doc/usage/button.rst
+++ b/doc/usage/cmd/button.rst
diff --git a/doc/usage/x86/cbsysinfo.rst b/doc/usage/cmd/cbsysinfo.rst
index 8c03a85169d..8c03a85169d 100644
--- a/doc/usage/x86/cbsysinfo.rst
+++ b/doc/usage/cmd/cbsysinfo.rst
diff --git a/doc/usage/conitrace.rst b/doc/usage/cmd/conitrace.rst
index d9916c865ee..d9916c865ee 100644
--- a/doc/usage/conitrace.rst
+++ b/doc/usage/cmd/conitrace.rst
diff --git a/doc/usage/echo.rst b/doc/usage/cmd/echo.rst
index 861abdfd1eb..861abdfd1eb 100644
--- a/doc/usage/echo.rst
+++ b/doc/usage/cmd/echo.rst
diff --git a/doc/usage/exception.rst b/doc/usage/cmd/exception.rst
index 27df88bd5c9..27df88bd5c9 100644
--- a/doc/usage/exception.rst
+++ b/doc/usage/cmd/exception.rst
diff --git a/doc/usage/exit.rst b/doc/usage/cmd/exit.rst
index 769223c4775..769223c4775 100644
--- a/doc/usage/exit.rst
+++ b/doc/usage/cmd/exit.rst
diff --git a/doc/usage/extension.rst b/doc/usage/cmd/extension.rst
index 2b88398b18b..6366cf56e72 100644
--- a/doc/usage/extension.rst
+++ b/doc/usage/cmd/extension.rst
@@ -1,8 +1,8 @@
.. SPDX-License-Identifier: GPL-2.0+
.. Copyright 2021, Kory Maincent <[email protected]>
-U-Boot extension board usage (CONFIG_EXTENSION)
-===============================================
+extension command
+=================
Synopsis
--------
diff --git a/doc/usage/false.rst b/doc/usage/cmd/false.rst
index a17fe860217..a17fe860217 100644
--- a/doc/usage/false.rst
+++ b/doc/usage/cmd/false.rst
diff --git a/doc/usage/fatinfo.rst b/doc/usage/cmd/fatinfo.rst
index af2eba43447..af2eba43447 100644
--- a/doc/usage/fatinfo.rst
+++ b/doc/usage/cmd/fatinfo.rst
diff --git a/doc/usage/fatload.rst b/doc/usage/cmd/fatload.rst
index 93acb27a536..93acb27a536 100644
--- a/doc/usage/fatload.rst
+++ b/doc/usage/cmd/fatload.rst
diff --git a/doc/usage/for.rst b/doc/usage/cmd/for.rst
index f9e504979c3..f9e504979c3 100644
--- a/doc/usage/for.rst
+++ b/doc/usage/cmd/for.rst
diff --git a/doc/usage/load.rst b/doc/usage/cmd/load.rst
index 1efee773179..1efee773179 100644
--- a/doc/usage/load.rst
+++ b/doc/usage/cmd/load.rst
diff --git a/doc/usage/loady.rst b/doc/usage/cmd/loady.rst
index 2819cc72aef..2819cc72aef 100644
--- a/doc/usage/loady.rst
+++ b/doc/usage/cmd/loady.rst
diff --git a/doc/usage/mbr.rst b/doc/usage/cmd/mbr.rst
index bddf2f612aa..bddf2f612aa 100644
--- a/doc/usage/mbr.rst
+++ b/doc/usage/cmd/mbr.rst
diff --git a/doc/usage/md.rst b/doc/usage/cmd/md.rst
index 4c1073ea354..7e9944e0dc3 100644
--- a/doc/usage/md.rst
+++ b/doc/usage/cmd/md.rst
@@ -102,5 +102,3 @@ Return value
------------
The return value $? is always 0 (true).
-
-
diff --git a/doc/usage/mmc.rst b/doc/usage/cmd/mmc.rst
index 02b5d7b1c77..55e3f9cf98c 100644
--- a/doc/usage/mmc.rst
+++ b/doc/usage/cmd/mmc.rst
@@ -85,22 +85,26 @@ The 'mmc dev' command shows or set current mmc device.
mode
speed mode to set.
- CONFIG_MMC_SPEED_MODE_SET should be enabled. The required speed mode is
- passed as the index from the following list.
+ CONFIG_MMC_SPEED_MODE_SET should be enabled. The requested speed mode is
+ passed as a decimal number according to the following table:
- 0 - MMC_LEGACY
- 1 - MMC_HS
- 2 - SD_HS
- 3 - MMC_HS_52
- 4 - MMC_DDR_52
- 5 - UHS_SDR12
- 6 - UHS_SDR25
- 7 - UHS_SDR50
- 8 - UHS_DDR50
- 9 - UHS_SDR104
- 10 - MMC_HS_200
- 11 - MMC_HS_400
- 12 - MMC_HS_400_ES
+ ========== ==========================
+ Speed mode Description
+ ========== ==========================
+ 0 MMC legacy
+ 1 MMC High Speed (26MHz)
+ 2 SD High Speed (50MHz)
+ 3 MMC High Speed (52MHz)
+ 4 MMC DDR52 (52MHz)
+ 5 UHS SDR12 (25MHz)
+ 6 UHS SDR25 (50MHz)
+ 7 UHS SDR50 (100MHz)
+ 8 UHS DDR50 (50MHz)
+ 9 UHS SDR104 (208MHz)
+ 10 HS200 (200MHz)
+ 11 HS400 (200MHz)
+ 12 HS400ES (200MHz)
+ ========== ==========================
A speed mode can be set only if it has already been enabled in the device tree
diff --git a/doc/usage/pinmux.rst b/doc/usage/cmd/pinmux.rst
index 9f4392cd0db..9f4392cd0db 100644
--- a/doc/usage/pinmux.rst
+++ b/doc/usage/cmd/pinmux.rst
diff --git a/doc/usage/pstore.rst b/doc/usage/cmd/pstore.rst
index 1c8374513aa..1c8374513aa 100644
--- a/doc/usage/pstore.rst
+++ b/doc/usage/cmd/pstore.rst
diff --git a/doc/usage/qfw.rst b/doc/usage/cmd/qfw.rst
index b3704b92d6d..b3704b92d6d 100644
--- a/doc/usage/qfw.rst
+++ b/doc/usage/cmd/qfw.rst
diff --git a/doc/usage/reset.rst b/doc/usage/cmd/reset.rst
index 384d5d60f81..384d5d60f81 100644
--- a/doc/usage/reset.rst
+++ b/doc/usage/cmd/reset.rst
diff --git a/doc/usage/sbi.rst b/doc/usage/cmd/sbi.rst
index 96d8861057f..96d8861057f 100644
--- a/doc/usage/sbi.rst
+++ b/doc/usage/cmd/sbi.rst
diff --git a/doc/usage/scp03.rst b/doc/usage/cmd/scp03.rst
index 7ff87ed85ac..7ff87ed85ac 100644
--- a/doc/usage/scp03.rst
+++ b/doc/usage/cmd/scp03.rst
diff --git a/doc/usage/setexpr.rst b/doc/usage/cmd/setexpr.rst
index 2e511b12905..2e511b12905 100644
--- a/doc/usage/setexpr.rst
+++ b/doc/usage/cmd/setexpr.rst
diff --git a/doc/usage/sf.rst b/doc/usage/cmd/sf.rst
index 71bd1be5175..71bd1be5175 100644
--- a/doc/usage/sf.rst
+++ b/doc/usage/cmd/sf.rst
diff --git a/doc/usage/size.rst b/doc/usage/cmd/size.rst
index f0c35e48265..f0c35e48265 100644
--- a/doc/usage/size.rst
+++ b/doc/usage/cmd/size.rst
diff --git a/doc/usage/true.rst b/doc/usage/cmd/true.rst
index f9ef71b2d1b..f9ef71b2d1b 100644
--- a/doc/usage/true.rst
+++ b/doc/usage/cmd/true.rst
diff --git a/doc/usage/ums.rst b/doc/usage/cmd/ums.rst
index 3cde5fa1f2a..3cde5fa1f2a 100644
--- a/doc/usage/ums.rst
+++ b/doc/usage/cmd/ums.rst
diff --git a/doc/usage/wdt.rst b/doc/usage/cmd/wdt.rst
index 8d80433c1fa..8d80433c1fa 100644
--- a/doc/usage/wdt.rst
+++ b/doc/usage/cmd/wdt.rst
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index 630a6cb28ab..8a54d9cb030 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -18,38 +18,47 @@ Shell commands
.. toctree::
:maxdepth: 1
- acpi
- addrmap
- askenv
- base
- bootefi
- booti
- bootmenu
- button
- x86/cbsysinfo
- conitrace
- echo
- exception
- extension
- exit
- false
- fatinfo
- fatload
- for
- load
- loady
- mbr
- md
- mmc
- pinmux
- pstore
- qfw
- reset
- sbi
- sf
- scp03
- setexpr
- size
- true
- ums
- wdt
+ cmd/acpi
+ cmd/addrmap
+ cmd/askenv
+ cmd/base
+ cmd/bootefi
+ cmd/booti
+ cmd/bootmenu
+ cmd/button
+ cmd/cbsysinfo
+ cmd/conitrace
+ cmd/echo
+ cmd/exception
+ cmd/extension
+ cmd/exit
+ cmd/false
+ cmd/fatinfo
+ cmd/fatload
+ cmd/for
+ cmd/load
+ cmd/loady
+ cmd/mbr
+ cmd/md
+ cmd/mmc
+ cmd/pinmux
+ cmd/pstore
+ cmd/qfw
+ cmd/reset
+ cmd/sbi
+ cmd/sf
+ cmd/scp03
+ cmd/setexpr
+ cmd/size
+ cmd/true
+ cmd/ums
+ cmd/wdt
+
+Booting OS
+----------
+
+.. toctree::
+ :maxdepth: 1
+
+ os/plan9
+ os/vxworks
diff --git a/doc/README.plan9 b/doc/usage/os/plan9.rst
index 2d3d0e0cf62..f91712c0094 100644
--- a/doc/README.plan9
+++ b/doc/usage/os/plan9.rst
@@ -1,3 +1,10 @@
+.. SPDX-License-Identifier: GPL-2.0+
+.. Steven Stallion
+.. June 2013
+
+Plan 9
+======
+
Plan 9 from Bell Labs kernel images require additional setup to pass
configuration information to the kernel. An environment variable named
confaddr must be defined with the same value as CONFADDR (see mem.h).
@@ -10,9 +17,6 @@ bootargs environment variable will be copied.
If no command line arguments or bootargs are defined, CONFADDR is left
uninitialized to permit manual configuration. For example, PC-style
-configuration could be simulated by issuing a fatload in bootcmd:
+configuration could be simulated by issuing a fatload in bootcmd::
# setenv bootcmd fatload mmc 0 $confaddr plan9.ini; ...; bootm
-
-Steven Stallion
-June 2013
diff --git a/doc/README.vxworks b/doc/usage/os/vxworks.rst
index 12a0d744d8a..0fe33d2d34c 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 <[email protected]>
-# Copyright (C) 2015-2018, Bin Meng <[email protected]>
-# Copyright (C) 2019, Lihua Zhao <[email protected]>
+.. SPDX-License-Identifier: GPL-2.0+
+.. Copyright (C) 2013, Miao Yan <[email protected]>
+.. Copyright (C) 2015-2018, Bin Meng <[email protected]>
+.. Copyright (C) 2019, Lihua Zhao <[email protected]>
-VxWorks Support
-===============
+VxWorks
+=======
This document describes the information about U-Boot loading VxWorks kernel.
@@ -14,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.
@@ -37,17 +36,26 @@ 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):
+.. code-block:: c
+
void (*kernel_entry)(fdt_addr, 0, 0, EPAPR_MAGIC, boot_IMA, 0, 0)
For ARM, the calling convention is shown below:
+.. code-block:: c
+
void (*kernel_entry)(void *fdt_addr)
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:
+is like below::
bootm <kernel image address> - <device tree address>
@@ -108,6 +116,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