On 6/4/21 6:51 PM, Patrick Delaunay wrote:
Provide a man-page for the ums command - USB Mass Storage.
Signed-off-by: Patrick Delaunay patrick.delaunay@foss.st.com
Changes in v2:
clarify description
add reference to <partitions> and align parameter name
correct information for partition = 0 (expose all partitions)
update dependency
doc/usage/index.rst | 1 + doc/usage/ums.rst | 57 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 doc/usage/ums.rst
diff --git a/doc/usage/index.rst b/doc/usage/index.rst index 41b247bc62..1bab6ae3e9 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -43,3 +43,4 @@ Shell commands scp03 size true
- ums
diff --git a/doc/usage/ums.rst b/doc/usage/ums.rst new file mode 100644 index 0000000000..19d2ebb4a6 --- /dev/null +++ b/doc/usage/ums.rst @@ -0,0 +1,57 @@ +.. SPDX-License-Identifier: GPL-2.0+
+ums command +===========
+Synopsis +--------
+::
- <dev> [<interface>] <devnum[:partnum]>
ums missing. I can add it when merging.
Otherwise
Reviewed-by: Heinrich Schuchardt xypron.glpk@gmx.de
+Description +-----------
+Use the USB Mass Storage class (also known as UMS) to make accessible an U-Boot +block device (fully or with :ref:`U-Boot's partition syntax <partitions>`) +to a USB host and to enable file transfers. U-Boot, the USB device, acts as a +simple external hard drive plugged on the host USB port.
+This command "ums" stays in the USB's treatment loop until user enters Ctrl-C.
+dev
- USB gadget device number
+interface
- interface for accessing the block device (mmc, sata, scsi, usb, ....)
- defaults is "mmc"
+devnum
- device number for selected interface
+partnum
- partition number or 0 to expose all partitions, defaults to 0
+Example +-------
+::
- => ums 0 mmc 0
- => ums 0 usb 1:2
+Configuration +-------------
+The ums command is only available if CONFIG_CMD_USB_MASS_STORAGE=y +and depends on CONFIG_USB_USB_GADGET and CONFIG_BLK.
+Return value +------------
+The return value $? is set to 0 (true) when the USB stack was successfully +started and interrupted, with Ctrl-C or after USB cable issue (detection +timeout or cable removal).
+If an error occurs, the return value $? is set to 1 (false).