Skip to contentSkip to conversation

doc: usage: man-page for ums command

PATCH In review Patrick Delaunay 2 participants 5 messages Jun 4, 2021 – Jun 8, 2021

lore
Share & tools
lore
#0 lore raw

v2 cover doc: usage: man-page for ums command

V2 for [1], after Heinrich remarks.

[1] doc: usage: man-page for ums command
http://patchwork.ozlabs.org/project/uboot/list/?series=246862&archive=both&state=*

Changes in v2:
- NEW: Add dependency for ums command
- clarify description
- add reference to <partitions> and align parameter name
- correct information for partition = 0 (expose all partitions)
- update dependency

Patrick Delaunay (2):
cmd: Add dependency for ums command
doc: usage: man-page for ums command

 cmd/Kconfig         |  5 +++-
 doc/usage/index.rst |  1 +
 doc/usage/ums.rst   | 57 +++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 62 insertions(+), 1 deletion(-)
 create mode 100644 doc/usage/ums.rst
Signature · 1 line
2.17.1
#1 lore raw

PATCH v2 1/2 cmd: Add dependency for ums command

Add the missing dependency for the command ums:
- CONFIG_BLK: call of blk_* functions in usb_mass_storage.c
- CONFIG_USB_GADGET: required to select CONFIG_USB_FUNCTION_MASS_STORAGE

---

Changes in v2:
- NEW: Add dependency for ums command

 cmd/Kconfig | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
cmd/Kconfig +4 -1
index f962bb7141..a9fb4eead2 100644
@@ -1346,8 +1346,11 @@ config CMD_ROCKUSB
 config CMD_USB_MASS_STORAGE
 	bool "UMS usb mass storage"
 	select USB_FUNCTION_MASS_STORAGE
+	depends on BLK && USB_GADGET
 	help
-	  USB mass storage support
+	  Enables the command "ums" and the USB mass storage support to the
+	  export a block device: U-Boot, the USB device, acts as a simple
+	  external hard drive plugged on the host USB port.
 
 config CMD_PVBLOCK
 	bool "Xen para-virtualized block device"
Signature · 1 line
2.17.1
Reviewed-by on v2 1/2
#2 lore raw

Re: [PATCH v2 1/2] cmd: Add dependency for ums command

Quoted 5 lines · Patrick Delaunay

Add the missing dependency for the command ums:
- CONFIG_BLK: call of blk_* functions in usb_mass_storage.c
- CONFIG_USB_GADGET: required to select CONFIG_USB_FUNCTION_MASS_STORAGE

Quoted 26 lines

---

Changes in v2:
- NEW: Add dependency for ums command

  cmd/Kconfig | 5 ++++-
  1 file changed, 4 insertions(+), 1 deletion(-)
cmd/Kconfig +4 -1
index f962bb7141..a9fb4eead2 100644
@@ -1346,8 +1346,11 @@ config CMD_ROCKUSB
  config CMD_USB_MASS_STORAGE
  	bool "UMS usb mass storage"
  	select USB_FUNCTION_MASS_STORAGE
+	depends on BLK && USB_GADGET
  	help
-	  USB mass storage support
+	  Enables the command "ums" and the USB mass storage support to the
+	  export a block device: U-Boot, the USB device, acts as a simple
+	  external hard drive plugged on the host USB port.
 
  config CMD_PVBLOCK
  	bool "Xen para-virtualized block device"
#3 lore raw

PATCH v2 2/2 doc: usage: man-page for ums command

In reply to Patrick Delaunay

Provide a man-page for the ums command - USB Mass Storage.

---

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
doc/usage/index.rst +1 -0
index 41b247bc62..1bab6ae3e9 100644
@@ -43,3 +43,4 @@ Shell commands
    scp03
    size
    true
+   ums
doc/usage/ums.rst new file +57 -0

57 lines not on this page · raw message

Signature · 1 line
2.17.1
Reviewed-by on v2 2/2
#4 lore raw
Quoted 32 lines · Patrick Delaunay

Provide a man-page for the ums command - USB Mass Storage.

---

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

doc/usage/index.rst +1 -0
index 41b247bc62..1bab6ae3e9 100644
@@ -43,3 +43,4 @@ Shell commands
     scp03
     size
     true
+   ums
doc/usage/ums.rst new file +1 -0
new file mode 100644
index 0000000000..19d2ebb4a6
@@ -0,0 +1,57 @@
+.. SPDX-License-Identifier: GPL-2.0+

doc/usage/ums.rst line 11

Quoted 10 lines
doc/usage/ums.rst new file +10 -0
+
+ums command
+===========
+
+Synopsis
+--------
+
+::
+
+    <dev> [<interface>] <devnum[:partnum]>

ums missing. I can add it when merging.

Otherwise

Quoted 47 lines
doc/usage/ums.rst new file +46 -0
+
+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).