smallsolar/u-boot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

bootstd: Update documentation for new features

Browse Source 
Document the hunters and the new way that iteration works.

Signed-off-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Simon Glass
2023-01-17 10:48:19 -07:00
committed by Tom Rini
parent f738c73a2b
commit 1bdda5fd72
4 changed files with 216 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
doc/usage/cmd/bootdev.rst
View File

@@ -8,9 +8,10 @@ Synopis
::
bootdev list [-p] - list all available bootdevs (-p to probe)\n"
bootdev select <bm> - select a bootdev by name\n"
bootdev info [-p] - show information about a bootdev";
bootdev list [-p] - list all available bootdevs (-p to probe)
bootdev hunt [-l|<spec>] - use hunt drivers to find bootdevs
bootdev select <bm> - select a bootdev by name
bootdev info [-p] - show information about a bootdev
Description
-----------
@@ -63,6 +64,17 @@ Name:
with `.bootdev`
bootdev hunt
~~~~~~~~~~~~
This hunts for new bootdevs, or shows a list of hunters.
Use `-l` to list the available bootdev hunters.
To run hunters, specify the name of the hunter to run, e.g. "mmc". If no
name is provided, all hunters are run.
bootdev select
~~~~~~~~~~~~~~~~~
@@ -83,7 +95,7 @@ This shows information on the current bootdev, with the format looking like
this:
========= =======================
Name mmc@7e202000.bootdev
Name `mmc@7e202000.bootdev`
Sequence 0
Status Probed
Uclass mmc
@@ -128,6 +140,34 @@ one of them::
Uclass: mmc
Bootflows: 1 (1 valid)
This shows using one of the available hunters, then listing them::
=> bootdev hunt usb
Hunting with: usb
Bus usb@1: scanning bus usb@1 for devices...
3 USB Device(s) found
=> bootdev hunt -l
Prio Used Uclass Hunter
---- ---- --------------- ---------------
6 ethernet eth_bootdev
1 simple_bus (none)
5 ide ide_bootdev
2 mmc mmc_bootdev
4 nvme nvme_bootdev
4 scsi scsi_bootdev
4 spi_flash sf_bootdev
5 * usb usb_bootdev
4 virtio virtio_bootdev
(total hunters: 9)
=> usb stor
Device 0: Vendor: sandbox Rev: 1.0 Prod: flash
Type: Hard Disk
Capacity: 4.0 MB = 0.0 GB (8192 x 512)
Device 1: Vendor: sandbox Rev: 1.0 Prod: flash
Type: Hard Disk
Capacity: 0.0 MB = 0.0 GB (1 x 512)
=>
Return value
------------

17
doc/usage/cmd/bootflow.rst
View File

@@ -8,7 +8,7 @@ Synopis
::
bootflow scan [-abel] [bootdev]
bootflow scan [-abelGH] [bootdev]
bootflow list [-e]
bootflow select [<num|name>]
bootflow info [-d]
@@ -57,6 +57,16 @@ Flags are:
is happening during scanning. Use it with the `-b` flag to see which
bootdev and bootflows are being tried.
-G
Skip global bootmeths when scanning. By default these are tried first, but
this flag disables them.
-H
Don't use bootdev hunters. By default these are used before each boot
priority or label is tried, to see if more bootdevs can be discovered, but
this flag disables that process.
The optional argument specifies a particular bootdev to scan. This can either be
the name of a bootdev or its sequence number (both shown with `bootdev list`).
Alternatively a convenience label can be used, like `mmc0`, which is the type of
@@ -145,6 +155,7 @@ Subdir (none)
Filename /extlinux/extlinux.conf
Buffer 3db7ad48
Size 232 (562 bytes)
FDT: <NULL>
Error 0
========= ===============================
@@ -169,6 +180,10 @@ Buffer
Size
Size of the bootflow file
FDT:
Filename of the device tree, if supported. The EFI bootmeth uses this to
remember the filename to load. If `<NULL>` then there is none.
Error
Error number returned from scanning for the bootflow. This is 0 if the
bootflow is in the 'loaded' state, or a negative error value on error. You