Additional file renames and modifications to change CDC demos to VirtualSerial.

[pub/lufa.git] / Demos / Device / ClassDriver / DualVirtualSerial / DualVirtualSerial.txt

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