diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-12-07 04:18:07 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-12-07 04:18:07 +0000 |
| commit | 7a9b3d3641e1bc97d2826b4865b3cedb11099e62 (patch) | |
| tree | 4a51ef80dfea5921150b308d3fe4e7f8e69c908c /Demos/Device/ClassDriver/DualVirtualSerial/DualCDC.txt | |
| parent | c1fa2306181924ebd8b36b0e3910b7904143beb8 (diff) | |
| download | lufa-7a9b3d3641e1bc97d2826b4865b3cedb11099e62.tar.gz lufa-7a9b3d3641e1bc97d2826b4865b3cedb11099e62.tar.bz2 lufa-7a9b3d3641e1bc97d2826b4865b3cedb11099e62.zip | |
Rename CDC demos to VirtualSerial.
Diffstat (limited to 'Demos/Device/ClassDriver/DualVirtualSerial/DualCDC.txt')
| -rw-r--r-- | Demos/Device/ClassDriver/DualVirtualSerial/DualCDC.txt | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/Demos/Device/ClassDriver/DualVirtualSerial/DualCDC.txt b/Demos/Device/ClassDriver/DualVirtualSerial/DualCDC.txt new file mode 100644 index 000000000..761769e3c --- /dev/null +++ b/Demos/Device/ClassDriver/DualVirtualSerial/DualCDC.txt @@ -0,0 +1,84 @@ +/** \file
+ *
+ * This file contains special DoxyGen information for the generation of the main page and other special
+ * documentation pages. It is not a project source file.
+ */
+
+/** \mainpage Dual Communications Device Class (Dual Virtual Serial Port) Device
+ *
+ * \section SSec_Compat Demo Compatibility:
+ *
+ * The following list indicates what microcontrollers are compatible with this demo.
+ *
+ * - Series 7 USB AVRs
+ * - Series 6 USB AVRs
+ * - Series 4 USB AVRs
+ * - Series 2 USB AVRs
+ *
+ * \section SSec_Info USB Information:
+ *
+ * The following table gives a rundown of the USB utilization of this demo.
+ *
+ * <table>
+ * <tr>
+ * <td><b>USB Mode:</b></td>
+ * <td>Device</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Class:</b></td>
+ * <td>Miscellaneous Device Class</td>
+ * <td>( Sub-Interface: Communications Device Class (CDC) )</td>
+ * </tr>
+ * <tr>
+ * <td><b>USB Subclass:</b></td>
+ * <td>Common Class</td>
+ * <td>( Sub-Interface: Abstract Control Model (ACM) )</td>
+ * </tr>
+ * <tr>
+ * <td><b>Relevant Standards:</b></td>
+ * <td>USBIF Interface Association Descriptor ECN</td>
+ * <td>USBIF CDC Class Standard</td>
+ * </tr>
+ * <tr>
+ * <td><b>Usable Speeds:</b></td>
+ * <td>Full Speed Mode</td>
+ * </tr>
+ * </table>
+ *
+ * \section SSec_Description Project Description:
+ *
+ * Dual Communications Device Class demonstration application.
+ * This gives a simple reference application for implementing
+ * a compound device with dual CDC functions acting as a pair
+ * of virtual serial ports. This demo uses Interface Association
+ * Descriptors to link together the pair of related CDC
+ * descriptors for each virtual serial port, which may not be
+ * supported in all OSes - Windows Vista is supported, as is
+ * XP (although the latter may need a hotfix to function).
+ *
+ * Joystick actions are transmitted to the host as strings
+ * through the first serial port. The device does not respond to
+ * serial data sent from the host in the first serial port.
+ *
+ * The second serial port echoes back data sent from the host.
+ *
+ * After running this demo for the first time on a new computer,
+ * you will need to supply the .INF file located in this demo
+ * project's directory as the device's driver when running under
+ * Windows. This will enable Windows to use its inbuilt CDC drivers,
+ * negating the need for custom drivers for the device. Other
+ * Operating Systems should automatically use their own inbuilt
+ * CDC-ACM drivers.
+ *
+ * \section SSec_Options Project Options
+ *
+ * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
+ *
+ * <table>
+ * <tr>
+ * <td>
+ * None
+ * </td>
+ * </tr>
+ * </table>
+ */
\ No newline at end of file |