Demos/DualCDC/DualCDC.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /** \mainpage Dual Communications Device Class Device (Dual Virtual Serial Port)
   8  *
   9  *  Dual Communications Device Class demonstration application.
  10  *  This gives a simple reference application for implementing
  11  *  a compound device with dual CDC functions acting as a pair
  12  *  of virtual serial ports. This demo uses Interface Association
  13  *  Descriptors to link together the pair of related CDC
  14  *  descriptors for each virtual serial port, which may not be
  15  *  supported in all OSes - Windows Vista is supported, as is
  16  *  XP (although the latter may need a hotfix to function).
  17  *
  18  *  Joystick actions are transmitted to the host as strings
  19  *  through the first serial port. The device does not respond to
  20  *  serial data sent from the host in the first serial port.
  21  *
  22  *  The second serial port echoes back data sent from the host.
  23  *
  24  *  After running this demo for the first time on a new computer,
  25  *  you will need to supply the .INF file located in this demo
  26  *  project's directory as the device's driver when running under
  27  *  Windows. This will enable Windows to use its inbuilt CDC drivers,
  28  *  negating the need for custom drivers for the device. Other
  29  *  Operating Systems should automatically use their own inbuilt
  30  *  CDC-ACM drivers.
  31  *
  32  *  <table>
  33  *   <tr>
  34  *    <td><b>USB Mode:</b></td>
  35  *    <td>Device</td>
  36  *   </tr>
  37  *   <tr>
  38  *    <td><b>USB Class:</b></td>
  39  *    <td>Miscellaneous Device Class</td>
  40  *    <td>( Sub-Interface: Communications Device Class (CDC) )</td>
  41  *   </tr>
  42  *   <tr>
  43  *    <td><b>USB Subclass:</b></td>
  44  *    <td>Common Class</td>
  45  *    <td>( Sub-Interface: Abstract Control Model (ACM) )</td>
  46  *   </tr>
  47  *   <tr>
  48  *    <td><b>Relevant Standards:</b></td>
  49  *    <td>USBIF Interface Association Descriptor ECN</td>
  50  *    <td>USBIF CDC Class Standard</td>
  51  *   </tr>
  52  *   <tr>
  53  *    <td><b>Usable Speeds:</b></td>
  54  *    <td>Full Speed Mode</td>
  55  *   </tr>
  56  *  </table>
  57  */