nuttx-apps/system/composite/README.txt
Frank Benkert 7b9ec306db Squashed commit of the following:
commit 99b41a291b
Author: Gregory Nutt <gnutt@nuttx.org>
Date:   Sat Jul 15 11:04:13 2017 -0600

    apps/system/composite:  Remove configuration settings that are no longer used.

commit 668179495f
Author: Gregory Nutt <gnutt@nuttx.org>
Date:   Sat Jul 15 09:26:49 2017 -0600

    apps/system/composite:  Restore USB tracing; remove unused field in a structure.

commit 23f1dd5e48
Author: Gregory Nutt <gnutt@nuttx.org>
Date:   Sat Jul 15 08:58:14 2017 -0600

    system/composite:  Remove CDC/ACM and MSC configuration logic.  This belongs in the OS composite initialization.  Add and argument so that you can select the USB composite configuration to be attached.

commit f8711488f1
Merge: 00896040 234afcd8
Author: Gregory Nutt <gnutt@nuttx.org>
Date:   Fri Jul 14 16:25:48 2017 -0600

    Merge remote-tracking branch 'origin/master' into composite

commit 0089604044
Merge: f913ea01 ae1eeada
Author: Gregory Nutt <gnutt@nuttx.org>
Date:   Thu Jul 13 13:59:25 2017 -0600

    Merge remote-tracking branch 'origin/master' into composite

commit f913ea0179
Merge: bcbdd798 915b42f8
Author: Gregory Nutt <gnutt@nuttx.org>
Date:   Mon Jul 10 11:08:46 2017 -0600

    Merge remote-tracking branch 'origin/master' into composite

commit bcbdd798c6
Merge: 2219c02d 1657d1ff
Author: Gregory Nutt <gnutt@nuttx.org>
Date:   Fri Jul 7 20:28:30 2017 -0600

    Merge remote-tracking branch 'origin/master' into composite

commit 2219c02ddb
Merge: fe1e52a8 d81d9c41
Author: Gregory Nutt <gnutt@nuttx.org>
Date:   Wed Jul 5 11:12:09 2017 -0600

    Merge remote-tracking branch 'origin/master' into composite

commit fe1e52a83a
Merge: 94f82d47 75f29d9d
Author: Gregory Nutt <gnutt@nuttx.org>
Date:   Fri Jun 30 16:14:36 2017 -0600

    Merge remote-tracking branch 'origin/master' into composite

commit 94f82d473d
Merge: a11806ee ffe0640d
Author: Gregory Nutt <gnutt@nuttx.org>
Date:   Thu Jun 29 10:19:55 2017 -0600

    Merge remote-tracking branch 'origin/master' into composite

commit a11806ee5f
Merge: f29dc985 5f5f8878
Author: Gregory Nutt <gnutt@nuttx.org>
Date:   Mon Jun 26 11:57:00 2017 -0600

    Merge remote-tracking branch 'origin/master' into composite

commit f29dc98512
Merge: 70faf0d1 d8759ffe
Author: Gregory Nutt <gnutt@nuttx.org>
Date:   Mon Jun 19 17:26:00 2017 -0600

    Merge remote-tracking branch 'origin/master' into composite

commit 70faf0d170
Merge: 7d3b1581 a7770590
Author: Gregory Nutt <gnutt@nuttx.org>
Date:   Fri Jun 16 17:33:46 2017 -0600

    Merge remote-tracking branch 'origin/master' into composite

commit 7d3b158142
Merge: b2c392d4 c8ae5f16
Author: Gregory Nutt <gnutt@nuttx.org>
Date:   Fri Jun 16 17:30:39 2017 -0600

    Merge remote-tracking branch 'origin/master' into composite

commit b2c392d4fe
Merge: 95eb2034 f3dc5bea
Author: Gregory Nutt <gnutt@nuttx.org>
Date:   Mon Jun 5 17:41:02 2017 -0600

    Merge remote-tracking branch 'origin/master' into composite

commit 95eb20343b
Author: Gregory Nutt <gnutt@nuttx.org>
Date:   Fri Jun 2 07:09:44 2017 -0600

    apps/system/composite: Add a configuration option to the boardctl() calls to support multiple composite device configurations dynamically.

commit 7652b67882
Author: Frank Benkert <Frank.Benkert@avat.de>
Date:   Thu Jun 1 15:19:40 2017 -0600

    Update to apps/system/compsite assocated with big changes to the composite device logic
2017-07-16 08:45:26 -06:00

102 lines
4.3 KiB
Plaintext
Executable File

system/composite
^^^^^^^^^^^^^^^^^^
This logic adds a NSH command to control a USB composite device. The only
supported devices in the composite are CDC/ACM serial and a USB mass storage
device. Which devices are enclosed in a composite device is configured with
an array of configuration-structs, handed over to the function
composite_initialize().
Required overall configuration:
Enable the USB Support of your Hardware / Processor e.g. SAMV7_USBDEVHS=y
CONFIG_USBDEV=y - USB device support
CONFIG_USBDEV_COMPOSITE=y - USB composite device support
CONFIG_COMPOSITE_IAD=y - Interface associate descriptor needed
CONFIG_CDCACM=y - USB CDC/ACM serial device support
CONFIG_CDCACM_COMPOSITE=y - USB CDC/ACM serial composite device support
The interface-, string-descriptor- and endpoint-numbers are configured via the
configuration-structs as noted above. The CDC/ACM serial device needs three
endpoints; one interrupt-driven and two bulk endpoints.
CONFIG_USBMSC=y - USB mass storage device support
CONFIG_USBMSC_COMPOSITE=y - USB mass storage composite device support
Like the configuration for the CDC/ACM, the descriptor- and endpoint-numbers
are configured via the configuration struct.
Depending on the configuration struct you need to configure different vendor-
and product-IDs. Each VID/PID is unique to a device and thus to a dedicated
configuration.
Linux tries to detect the device types and installs default drivers if the
VID/PID pair is unknown.
Windows insists on a known and installed configuration. With an Atmel
hardware and Atmel-Studio or the Atmel-USB-drivers installed, you can test
your configuration with Atmel Example Vendor- and Product-IDs.
If you have a USBMSC and a CDC/ACM configured in your combo, then you can try
to use
- VID = 0x03EB (ATMEL)
- PID = 0x2424 (ASF Example with MSC and CDC)
If for example you try to test a configuration with up to seven CDCs, then
- VID = 0x03EB (ATMEL)
- PID = 0x2426 (ASF Example with up to seven CDCs)
CONFIG_NSH_BUILTIN_APPS
This add-on can be built as two NSH "built-in" commands if this option
is selected: 'conn' will connect the USB composite device; 'disconn'
will disconnect the USB composite device.
Configuration options unique to this add-on:
CONFIG_SYSTEM_COMPOSITE_DEBUGMM
Enables some debug tests to check for memory usage and memory leaks.
CONFIG_SYSTEM_COMPOSITE_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_SYSTEM_COMPOSITE_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_SYSTEM_COMPOSITE_DEVPATH1
The full path to the registered block driver. Default is "/dev/mmcsd0"
CONFIG_SYSTEM_COMPOSITE_DEVMINOR2 and CONFIG_SYSTEM_COMPOSITE_DEVPATH2
Similar parameters that would have to be provided if CONFIG_SYSTEM_COMPOSITE_NLUNS
is 2 or 3. No defaults.
CONFIG_SYSTEM_COMPOSITE_DEVMINOR3 and CONFIG_SYSTEM_COMPOSITE_DEVPATH2
Similar parameters that would have to be provided if CONFIG_SYSTEM_COMPOSITE_NLUNS
is 3. No defaults.
CONFIG_SYSTEM_COMPOSITE_TTYUSB - The minor number of the USB serial device.
Default is zero (corresponding to /dev/ttyUSB0 or /dev/ttyACM0). Default is zero.
CCONFIG_SYSTEM_COMPOSITE_SERDEV - The string corresponding to
CONFIG_SYSTEM_COMPOSITE_TTYUSB. The default is "/dev/ttyUSB0" (for the PL2303
emulation) or "/dev/ttyACM0" (for the CDC/ACM serial device).
CONFIG_SYSTEM_COMPOSITE_BUFSIZE - The size of the serial I/O buffer in
bytes. Default 256 bytes.
If CONFIG_USBDEV_TRACE is enabled (or CONFIG_DEBUG_FEATURES and CONFIG_DEBUG_USB), then
the add-on code will also manage the USB trace output. The amount of trace output
can be controlled using:
CONFIG_SYSTEM_COMPOSITE_TRACEINIT
Show initialization events
CONFIG_SYSTEM_COMPOSITE_TRACECLASS
Show class driver events
CONFIG_SYSTEM_COMPOSITE_TRACETRANSFERS
Show data transfer events
CONFIG_SYSTEM_COMPOSITE_TRACECONTROLLER
Show controller events
CONFIG_SYSTEM_COMPOSITE_TRACEINTERRUPTS
Show interrupt-related events.