From 72aade744edb726f16a0f058e2f60f0898de1abf Mon Sep 17 00:00:00 2001 From: Hrushikesh Salunke Date: Wed, 1 Oct 2025 11:26:36 +0530 Subject: [PATCH] feat(linux): Add the documentation for UMS command Add the documentation for UMS(USB Mass Storage) command. Signed-off-by: Hrushikesh Salunke --- configs/AM62AX/AM62AX_linux_toc.txt | 1 + configs/AM62LX/AM62LX_linux_toc.txt | 1 + configs/AM62PX/AM62PX_linux_toc.txt | 1 + configs/AM62X/AM62X_linux_toc.txt | 1 + configs/J7200/J7200_linux_toc.txt | 1 + configs/J721E/J721E_linux_toc.txt | 1 + configs/J721S2/J721S2_linux_toc.txt | 1 + configs/J722S/J722S_linux_toc.txt | 1 + configs/J742S2/J742S2_linux_toc.txt | 1 + configs/J784S4/J784S4_linux_toc.txt | 1 + .../Foundational_Components/U-Boot/UG-UMS.rst | 69 +++++++++++++++++++ .../U-Boot/Users-Guide.rst | 1 + 12 files changed, 80 insertions(+) create mode 100644 source/linux/Foundational_Components/U-Boot/UG-UMS.rst diff --git a/configs/AM62AX/AM62AX_linux_toc.txt b/configs/AM62AX/AM62AX_linux_toc.txt index 8541d5ba4..3f046d774 100644 --- a/configs/AM62AX/AM62AX_linux_toc.txt +++ b/configs/AM62AX/AM62AX_linux_toc.txt @@ -37,6 +37,7 @@ linux/Foundational_Components/U-Boot/Users-Guide 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-QSPI linux/Foundational_Components/U-Boot/UG-UART linux/Foundational_Components/U-Boot/UG-DDRSS diff --git a/configs/AM62LX/AM62LX_linux_toc.txt b/configs/AM62LX/AM62LX_linux_toc.txt index a23242538..4ab5e31a4 100644 --- a/configs/AM62LX/AM62LX_linux_toc.txt +++ b/configs/AM62LX/AM62LX_linux_toc.txt @@ -33,6 +33,7 @@ linux/Foundational_Components/U-Boot/BG-Ram-Device-Trees-K3 linux/Foundational_Components/U-Boot/Users-Guide 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-QSPI linux/Foundational_Components/U-Boot/UG-UART linux/Foundational_Components/U-Boot/UG-Key-Writer-Lite diff --git a/configs/AM62PX/AM62PX_linux_toc.txt b/configs/AM62PX/AM62PX_linux_toc.txt index 7dafd7983..9a2523cb4 100644 --- a/configs/AM62PX/AM62PX_linux_toc.txt +++ b/configs/AM62PX/AM62PX_linux_toc.txt @@ -36,6 +36,7 @@ linux/Foundational_Components/U-Boot/Users-Guide 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-QSPI linux/Foundational_Components/U-Boot/UG-UART linux/Foundational_Components/U-Boot/UG-DDRSS diff --git a/configs/AM62X/AM62X_linux_toc.txt b/configs/AM62X/AM62X_linux_toc.txt index 8cf94e23b..5bc0860c9 100644 --- a/configs/AM62X/AM62X_linux_toc.txt +++ b/configs/AM62X/AM62X_linux_toc.txt @@ -35,6 +35,7 @@ linux/Foundational_Components/U-Boot/Users-Guide 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-QSPI linux/Foundational_Components/U-Boot/UG-UART linux/Foundational_Components/U-Boot/UG-DDRSS diff --git a/configs/J7200/J7200_linux_toc.txt b/configs/J7200/J7200_linux_toc.txt index a4aaf91b8..a4f35d174 100644 --- 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-QSPI linux/Foundational_Components/U-Boot/UG-NOR linux/Foundational_Components/U-Boot/UG-UART diff --git a/configs/J721E/J721E_linux_toc.txt b/configs/J721E/J721E_linux_toc.txt index e51be1b98..3d8e68854 100644 --- 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-QSPI linux/Foundational_Components/U-Boot/UG-NOR linux/Foundational_Components/U-Boot/UG-UART diff --git a/configs/J721S2/J721S2_linux_toc.txt b/configs/J721S2/J721S2_linux_toc.txt index 07ffba248..795520179 100644 --- 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-QSPI linux/Foundational_Components/U-Boot/UG-NOR linux/Foundational_Components/U-Boot/UG-UART diff --git a/configs/J722S/J722S_linux_toc.txt b/configs/J722S/J722S_linux_toc.txt index 89c19aa81..700e4207b 100644 --- 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-QSPI linux/Foundational_Components/U-Boot/UG-NOR linux/Foundational_Components/U-Boot/UG-UART diff --git a/configs/J742S2/J742S2_linux_toc.txt b/configs/J742S2/J742S2_linux_toc.txt index b5a2ecce6..d783fa466 100644 --- 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-QSPI linux/Foundational_Components/U-Boot/UG-NOR linux/Foundational_Components/U-Boot/UG-UART diff --git a/configs/J784S4/J784S4_linux_toc.txt b/configs/J784S4/J784S4_linux_toc.txt index 5fb4b85a0..092c82142 100644 --- 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-QSPI linux/Foundational_Components/U-Boot/UG-NOR linux/Foundational_Components/U-Boot/UG-UART diff --git a/source/linux/Foundational_Components/U-Boot/UG-UMS.rst b/source/linux/Foundational_Components/U-Boot/UG-UMS.rst new file mode 100644 index 000000000..b8a492eb2 --- /dev/null +++ b/source/linux/Foundational_Components/U-Boot/UG-UMS.rst @@ -0,0 +1,69 @@ +################ +USB Mass Storage +################ + +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 such as SD or MMC from a USB host such +as host PC. + +************************** +Configuration requirements +************************** + +Set the following configuration in the U-Boot config file to enable UMS +support: + +.. code-block:: kconfig + + CONFIG_CMD_USB_MASS_STORAGE=y + +***** +Usage +***** + +To use the UMS command: + +.. code-block:: console + + => ums [] + +.. rubric:: dev + +USB gadget device number. + +.. rubric:: interface + +Interface for accessing block device (MMC, SATA, ....), default is MMC. + +.. rubric:: devnum + +Device number for selected interface. + +.. rubric:: 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 reconfigure it 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 index 580435777..09bbc3ff0 100644 --- a/source/linux/Foundational_Components/U-Boot/Users-Guide.rst +++ b/source/linux/Foundational_Components/U-Boot/Users-Guide.rst @@ -14,6 +14,7 @@ User's Guide UG-PCIeBoot UG-NAND UG-Memory-K3 + UG-UMS UG-Memory-OMAP UG-SPI UG-QSPI