bootstd: Update documentation for new features

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

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
------------