summaryrefslogtreecommitdiff
path: root/apps/examples/README.txt
diff options
context:
space:
mode:
authorGregory Nutt <gnutt@nuttx.org>2013-09-25 16:54:39 -0600
committerGregory Nutt <gnutt@nuttx.org>2013-09-25 16:54:39 -0600
commit55a34548ccc4fc7aa55ad585b007c7d77d8cf937 (patch)
treee1e5eb48cbf91118a54ba58744275e945753afbf /apps/examples/README.txt
parent3302f2a96c91ee259e7aa5e2661154363eb9a4f4 (diff)
downloadnuttx-55a34548ccc4fc7aa55ad585b007c7d77d8cf937.tar.gz
nuttx-55a34548ccc4fc7aa55ad585b007c7d77d8cf937.tar.bz2
nuttx-55a34548ccc4fc7aa55ad585b007c7d77d8cf937.zip
Move apps/examples/usbmsc to apps/system/usbmsc
Diffstat (limited to 'apps/examples/README.txt')
-rw-r--r--apps/examples/README.txt77
1 files changed, 0 insertions, 77 deletions
diff --git a/apps/examples/README.txt b/apps/examples/README.txt
index bb0c9fc49..02e38061c 100644
--- a/apps/examples/README.txt
+++ b/apps/examples/README.txt
@@ -1825,83 +1825,6 @@ examples/usbserial
The host and target will exchange are variety of very small and very large
serial messages.
-examples/usbmsc
-^^^^^^^^^^^^^^^
-
- This example registers a block device driver, then exports the block
- the device using the USB storage class driver. In order to use this
- example, your board-specific logic must provide the function:
-
- void usbmsc_archinitialize(void);
-
- This function will be called by the example/usbmsc in order to
- do the actual registration of the block device drivers. For examples
- of the implementation of usbmsc_archinitialize() see
- configs/mcu123-lpc124x/src/up_usbmsc.c or
- configs/stm3210e-eval/src/usbmsc.c
-
- Configuration options:
-
- CONFIG_NSH_BUILTIN_APPS
- This example can be built as two NSH "built-in" commands if this option
- is selected: 'msconn' will connect the USB mass storage device; 'msdis'
- will disconnect the USB storage device.
- CONFIG_EXAMPLES_USBMSC_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. Default is 1.
- CONFIG_EXAMPLES_USBMSC_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. Default
- is zero.
- CONFIG_EXAMPLES_USBMSC_DEVPATH1
- The full path to the registered block driver. Default is "/dev/mmcsd0"
- CONFIG_EXAMPLES_USBMSC_DEVMINOR2 and CONFIG_EXAMPLES_USBMSC_DEVPATH2
- Similar parameters that would have to be provided if CONFIG_EXAMPLES_USBMSC_NLUNS
- is 2 or 3. No defaults.
- CONFIG_EXAMPLES_USBMSC_DEVMINOR3 and CONFIG_EXAMPLES_USBMSC_DEVPATH3
- Similar parameters that would have to be provided if CONFIG_EXAMPLES_USBMSC_NLUNS
- is 3. No defaults.
- CONFIG_EXAMPLES_USBMSC_DEBUGMM
- Enables some debug tests to check for memory usage and memory leaks.
-
- If CONFIG_USBDEV_TRACE is enabled (or CONFIG_DEBUG and CONFIG_DEBUG_USB), then
- the example code will also manage the USB trace output. The amount of trace output
- can be controlled using:
-
- CONFIG_EXAMPLES_USBMSC_TRACEINIT
- Show initialization events
- CONFIG_EXAMPLES_USBMSC_TRACECLASS
- Show class driver events
- CONFIG_EXAMPLES_USBMSC_TRACETRANSFERS
- Show data transfer events
- CONFIG_EXAMPLES_USBMSC_TRACECONTROLLER
- Show controller events
- CONFIG_EXAMPLES_USBMSC_TRACEINTERRUPTS
- Show interrupt-related events.
-
- Error results are always shown in the trace output
-
- NOTE 1: When built as an NSH add-on command (CONFIG_NSH_BUILTIN_APPS=y),
- Caution should be used to assure that the SD drive (or other storage device) is
- not in use when the USB storage device is configured. Specifically, the SD
- driver should be unmounted like:
-
- nsh> mount -t vfat /dev/mmcsd0 /mnt/sdcard # Card is mounted in NSH
- ...
- nsh> umount /mnd/sdcard # Unmount before connecting USB!!!
- nsh> msconn # Connect the USB storage device
- ...
- nsh> msdis # Disconnect USB storate device
- nsh> mount -t vfat /dev/mmcsd0 /mnt/sdcard # Restore the mount
-
- Failure to do this could result in corruption of the SD card format.
-
- NOTE 2: This test exercises internal USB device driver interfaces. As such,
- it relies on internal OS interfaces that are not normally available to a
- user-space program. As a result, this example cannot be used if a
- NuttX is built as a protected, supervisor kernel (CONFIG_NUTTX_KERNEL).
-
examples/usbterm
^^^^^^^^^^^^^^^^