summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--nuttx/examples/README.txt20
1 files changed, 20 insertions, 0 deletions
diff --git a/nuttx/examples/README.txt b/nuttx/examples/README.txt
index ba13f16ef..8625bceb0 100644
--- a/nuttx/examples/README.txt
+++ b/nuttx/examples/README.txt
@@ -140,4 +140,24 @@ examples/usbserial
CONFIG_EXAMPLES_USBSERIAL_ONLYBIG
Send only large, multi-packet messages. Default: Send large and small.
+examples/usbstorage
+^^^^^^^^^^^^^^^^^^
+ This example registers a block device driver, then exports the block
+ the device using the USB storage class driver. Configuration options:
+
+ CONFIG_EXAMPLES_USBSTRG_NLUNS
+ Defines the number of logical units (LUNs) exported by the USB storage
+ driver. Each LUN corresponds to one exported block driver (or partition
+ of a block driver). May be 1, 2, or 3.
+ CONFIG_EXAMPLES_USBSTRG_DEVMINOR1
+ The minor device number of the block driver for the first LUN. For
+ example, N in /dev/mmcsdN. Used for registering the block driver.
+ CONFIG_EXAMPLES_USBSTRG_DEVPATH1
+ The full path to the registered block driver. Example, "/dev/mmcsd0"
+ CONFIG_EXAMPLES_USBSTRG_DEVMINOR2 and CONFIG_EXAMPLES_USBSTRG_DEVPATH2
+ Similar parameters that would have to be provided if CONFIG_EXAMPLES_USBSTRG_NLUNS
+ is 2 or 3.
+ CONFIG_EXAMPLES_USBSTRG_DEVMINOR3 and CONFIG_EXAMPLES_USBSTRG_DEVPATH3
+ Similar parameters that would have to be provided if CONFIG_EXAMPLES_USBSTRG_NLUNS
+ is 3.