feat(linux): Add the documentation for UMS command

hrushikesh221 · hrushikesh221 · commit d3b8fac678c5 · 2025-08-06T10:39:16.000+05:30
Add the documentation for UMS(USB Mass Storage) command.

Signed-off-by: Hrushikesh Salunke &lt;h-salunke@ti.com&gt;
diff --git a/configs/AM62AX/AM62AX_linux_toc.txt b/configs/AM62AX/AM62AX_linux_toc.txt
@@ -31,6 +31,7 @@ linux/Foundational_Components/U-Boot/UG-General-Info
 linux/Foundational_Components/U-Boot/UG-DFU
 linux/Foundational_Components/U-Boot/UG-Network
 linux/Foundational_Components/U-Boot/UG-Memory-K3
+linux/Foundational_Components/U-Boot/UG-UMS
 linux/Foundational_Components/U-Boot/UG-SPI
 linux/Foundational_Components/U-Boot/UG-QSPI
 linux/Foundational_Components/U-Boot/UG-UART
diff --git a/configs/AM62LX/AM62LX_linux_toc.txt b/configs/AM62LX/AM62LX_linux_toc.txt
@@ -27,6 +27,7 @@ linux/Foundational_Components/U-Boot/Users-Guide
 linux/Foundational_Components/U-Boot/UG-General-Info
 linux/Foundational_Components/U-Boot/UG-DFU
 linux/Foundational_Components/U-Boot/UG-Memory-K3
+linux/Foundational_Components/U-Boot/UG-UMS
 linux/Foundational_Components/U-Boot/UG-SPI
 linux/Foundational_Components/U-Boot/UG-QSPI
 linux/Foundational_Components/U-Boot/UG-UART
diff --git a/configs/AM62PX/AM62PX_linux_toc.txt b/configs/AM62PX/AM62PX_linux_toc.txt
@@ -30,6 +30,7 @@ linux/Foundational_Components/U-Boot/UG-General-Info
 linux/Foundational_Components/U-Boot/UG-DFU
 #linux/Foundational_Components/U-Boot/UG-Network
 linux/Foundational_Components/U-Boot/UG-Memory-K3
+linux/Foundational_Components/U-Boot/UG-UMS
 linux/Foundational_Components/U-Boot/UG-SPI
 linux/Foundational_Components/U-Boot/UG-QSPI
 linux/Foundational_Components/U-Boot/UG-UART
diff --git a/configs/AM62X/AM62X_linux_toc.txt b/configs/AM62X/AM62X_linux_toc.txt
@@ -29,6 +29,7 @@ linux/Foundational_Components/U-Boot/UG-General-Info
 linux/Foundational_Components/U-Boot/UG-DFU
 #linux/Foundational_Components/U-Boot/UG-Network
 linux/Foundational_Components/U-Boot/UG-Memory-K3
+linux/Foundational_Components/U-Boot/UG-UMS
 linux/Foundational_Components/U-Boot/UG-SPI
 linux/Foundational_Components/U-Boot/UG-QSPI
 linux/Foundational_Components/U-Boot/UG-UART
diff --git a/configs/J7200/J7200_linux_toc.txt b/configs/J7200/J7200_linux_toc.txt
@@ -25,6 +25,7 @@ linux/Foundational_Components/U-Boot/UG-DFU
 linux/Foundational_Components/U-Boot/UG-Network
 linux/Foundational_Components/U-Boot/UG-NAND
 linux/Foundational_Components/U-Boot/UG-Memory-K3
+linux/Foundational_Components/U-Boot/UG-UMS
 linux/Foundational_Components/U-Boot/UG-SPI
 linux/Foundational_Components/U-Boot/UG-QSPI
 linux/Foundational_Components/U-Boot/UG-NOR
diff --git a/configs/J721E/J721E_linux_toc.txt b/configs/J721E/J721E_linux_toc.txt
@@ -25,6 +25,7 @@ linux/Foundational_Components/U-Boot/UG-DFU
 linux/Foundational_Components/U-Boot/UG-Network
 linux/Foundational_Components/U-Boot/UG-NAND
 linux/Foundational_Components/U-Boot/UG-Memory-K3
+linux/Foundational_Components/U-Boot/UG-UMS
 linux/Foundational_Components/U-Boot/UG-SPI
 linux/Foundational_Components/U-Boot/UG-QSPI
 linux/Foundational_Components/U-Boot/UG-NOR
diff --git a/configs/J721S2/J721S2_linux_toc.txt b/configs/J721S2/J721S2_linux_toc.txt
@@ -25,6 +25,7 @@ linux/Foundational_Components/U-Boot/UG-DFU
 linux/Foundational_Components/U-Boot/UG-Network
 linux/Foundational_Components/U-Boot/UG-NAND
 linux/Foundational_Components/U-Boot/UG-Memory-K3
+linux/Foundational_Components/U-Boot/UG-UMS
 linux/Foundational_Components/U-Boot/UG-SPI
 linux/Foundational_Components/U-Boot/UG-QSPI
 linux/Foundational_Components/U-Boot/UG-NOR
diff --git a/configs/J722S/J722S_linux_toc.txt b/configs/J722S/J722S_linux_toc.txt
@@ -25,6 +25,7 @@ linux/Foundational_Components/U-Boot/UG-DFU
 linux/Foundational_Components/U-Boot/UG-Network
 linux/Foundational_Components/U-Boot/UG-NAND
 linux/Foundational_Components/U-Boot/UG-Memory-K3
+linux/Foundational_Components/U-Boot/UG-UMS
 linux/Foundational_Components/U-Boot/UG-SPI
 linux/Foundational_Components/U-Boot/UG-QSPI
 linux/Foundational_Components/U-Boot/UG-NOR
diff --git a/configs/J742S2/J742S2_linux_toc.txt b/configs/J742S2/J742S2_linux_toc.txt
@@ -25,6 +25,7 @@ linux/Foundational_Components/U-Boot/UG-DFU
 linux/Foundational_Components/U-Boot/UG-Network
 linux/Foundational_Components/U-Boot/UG-NAND
 linux/Foundational_Components/U-Boot/UG-Memory-K3
+linux/Foundational_Components/U-Boot/UG-UMS
 linux/Foundational_Components/U-Boot/UG-SPI
 linux/Foundational_Components/U-Boot/UG-QSPI
 linux/Foundational_Components/U-Boot/UG-NOR
diff --git a/configs/J784S4/J784S4_linux_toc.txt b/configs/J784S4/J784S4_linux_toc.txt
@@ -25,6 +25,7 @@ linux/Foundational_Components/U-Boot/UG-DFU
 linux/Foundational_Components/U-Boot/UG-Network
 linux/Foundational_Components/U-Boot/UG-NAND
 linux/Foundational_Components/U-Boot/UG-Memory-K3
+linux/Foundational_Components/U-Boot/UG-UMS
 linux/Foundational_Components/U-Boot/UG-SPI
 linux/Foundational_Components/U-Boot/UG-QSPI
 linux/Foundational_Components/U-Boot/UG-NOR
diff --git a/source/linux/Foundational_Components/U-Boot/UG-UMS.rst b/source/linux/Foundational_Components/U-Boot/UG-UMS.rst
@@ -0,0 +1,66 @@
+UMS
+###
+
+USB Mass Storage (UMS) functionality, allows a connected USB host to
+access U-Boot block devices and enable file transfer. This is useful
+for accessing storage devices like SD/MMC from a USB host such as host
+PC.
+
+Configuration Requirements
+==========================
+
+To enable UMS support, following configuration needs to be set in
+the U-Boot config file:
+
+.. code-block:: kconfig
+
+   CONFIG_CMD_USB_MASS_STORAGE=y
+
+Usage
+=====
+
+To use the UMS command:
+
+.. code-block:: console
+
+   => ums <dev> [<interface>] <devnum[:partnum]>
+
+**dev**
+
+USB gadget device number.
+
+**interface**
+
+Interface for accessing block device (MMC, SATA, ....), default is MMC.
+
+**devnum**
+
+Device number for selected interface.
+
+**partnum**
+
+Partition number for selected device, default is 0. 0 to expose all
+partitions.
+
+Example usage:
+
+.. code-block:: console
+
+   => mmc list
+   mmc@fa10000: 0 (eMMC)
+   mmc@fa00000: 1 (SD)
+   => ums 0 mmc 1
+   UMS: LUN 0, dev mmc 1, hwpart 0, sector 0x0, count 0x3b72400
+
+This example exposes the SD card (mmc 1) as a USB mass storage device
+to the connected host PC. The host PC can then mount and access the
+storage device for file transfer. Press Ctrl+C to exit UMS command and
+return to the U-boot prompt.
+
+.. note::
+
+   The USB controller must be in peripheral mode for UMS to work. If
+   the controller is in host mode, then it needs to be reconfigured to
+   peripheral mode before using the UMS command. The USB controller can
+   be configured to operate in peripheral mode by changing the value of
+   ``dr_mode`` property of USB controller node in device tree to ``peripheral``.
diff --git a/source/linux/Foundational_Components/U-Boot/Users-Guide.rst b/source/linux/Foundational_Components/U-Boot/Users-Guide.rst
@@ -15,6 +15,7 @@ User's Guide
     UG-PCIeBoot
     UG-NAND
     UG-Memory-K3
+    UG-UMS
     UG-Memory-OMAP
     UG-SPI
     UG-QSPI
