Skip to content

feat(linux): Add the documentation for UMS command #409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeevantelukula merged 1 commit into from
Oct 7, 2025
Merged

feat(linux): Add the documentation for UMS command #409

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions configs/AM62AX/AM62AX_linux_toc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions configs/AM62LX/AM62LX_linux_toc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions configs/AM62PX/AM62PX_linux_toc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions configs/AM62X/AM62X_linux_toc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions configs/J7200/J7200_linux_toc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions configs/J721E/J721E_linux_toc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions configs/J721S2/J721S2_linux_toc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions configs/J722S/J722S_linux_toc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions configs/J742S2/J742S2_linux_toc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions configs/J784S4/J784S4_linux_toc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
69 changes: 69 additions & 0 deletions source/linux/Foundational_Components/U-Boot/UG-UMS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
################
USB Mass Storage

Check warning on line 2 in source/linux/Foundational_Components/U-Boot/UG-UMS.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Headings] Use sentence-style capitalization in 'USB Mass Storage'.

Raw Output:
{"message": "[RedHat.Headings] Use sentence-style capitalization in 'USB Mass Storage'.", "location": {"path": "source/linux/Foundational_Components/U-Boot/UG-UMS.rst", "range": {"start": {"line": 2, "column": 1}}}, "severity": "INFO"}
################

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

Check warning on line 7 in source/linux/Foundational_Components/U-Boot/UG-UMS.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'MMC') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'MMC') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "source/linux/Foundational_Components/U-Boot/UG-UMS.rst", "range": {"start": {"line": 7, "column": 45}}}, "severity": "INFO"}
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 <dev> [<interface>] <devnum[:partnum]>

.. rubric:: dev

USB gadget device number.

.. rubric:: interface

Interface for accessing block device (MMC, SATA, ....), default is MMC.

Check warning on line 37 in source/linux/Foundational_Components/U-Boot/UG-UMS.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'MMC') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'MMC') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "source/linux/Foundational_Components/U-Boot/UG-UMS.rst", "range": {"start": {"line": 37, "column": 68}}}, "severity": "INFO"}

Check warning on line 37 in source/linux/Foundational_Components/U-Boot/UG-UMS.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Ellipses] Avoid the ellipsis (...) except to indicate omitted words.

Raw Output:
{"message": "[RedHat.Ellipses] Avoid the ellipsis (...) except to indicate omitted words.", "location": {"path": "source/linux/Foundational_Components/U-Boot/UG-UMS.rst", "range": {"start": {"line": 37, "column": 50}}}, "severity": "INFO"}

Check warning on line 37 in source/linux/Foundational_Components/U-Boot/UG-UMS.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'SATA') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'SATA') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "source/linux/Foundational_Components/U-Boot/UG-UMS.rst", "range": {"start": {"line": 37, "column": 44}}}, "severity": "INFO"}

Check warning on line 37 in source/linux/Foundational_Components/U-Boot/UG-UMS.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'MMC') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message": "[RedHat.Definitions] Define acronyms and abbreviations (such as 'MMC') on first occurrence if they're likely to be unfamiliar.", "location": {"path": "source/linux/Foundational_Components/U-Boot/UG-UMS.rst", "range": {"start": {"line": 37, "column": 39}}}, "severity": "INFO"}

.. rubric:: devnum

Check warning on line 39 in source/linux/Foundational_Components/U-Boot/UG-UMS.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'devnum'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'devnum'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "source/linux/Foundational_Components/U-Boot/UG-UMS.rst", "range": {"start": {"line": 39, "column": 13}}}, "severity": "WARNING"}

Device number for selected interface.

.. rubric:: partnum

Check warning on line 43 in source/linux/Foundational_Components/U-Boot/UG-UMS.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'partnum'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'partnum'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "source/linux/Foundational_Components/U-Boot/UG-UMS.rst", "range": {"start": {"line": 43, "column": 13}}}, "severity": "WARNING"}

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

Check warning on line 58 in source/linux/Foundational_Components/U-Boot/UG-UMS.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'mmc'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'mmc'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "source/linux/Foundational_Components/U-Boot/UG-UMS.rst", "range": {"start": {"line": 58, "column": 35}}}, "severity": "WARNING"}
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

Check warning on line 68 in source/linux/Foundational_Components/U-Boot/UG-UMS.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.PassiveVoice] 'be configured' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.

Raw Output:
{"message": "[RedHat.PassiveVoice] 'be configured' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.", "location": {"path": "source/linux/Foundational_Components/U-Boot/UG-UMS.rst", "range": {"start": {"line": 68, "column": 4}}}, "severity": "INFO"}
``dr_mode`` property of USB controller node in device tree to ``peripheral``.
1 change: 1 addition & 0 deletions source/linux/Foundational_Components/U-Boot/Users-Guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ User's Guide
UG-PCIeBoot
UG-NAND
UG-Memory-K3
UG-UMS
UG-Memory-OMAP
UG-SPI
UG-QSPI
Expand Down
Loading