Demos/Device/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  *  \section SSec_Info USB Information:
  10  *
  11  *  The following table gives a rundown of the USB utilization of this demo.
  12  *
  13  *  <table>
  14  *   <tr>
  15  *    <td><b>USB Mode:</b></td>
  16  *    <td>Device</td>
  17  *   </tr>
  18  *   <tr>
  19  *    <td><b>USB Class:</b></td>
  20  *    <td>Miscellaneous Device Class</td>
  21  *    <td>( Sub-Interface: Communications Device Class (CDC) )</td>
  22  *   </tr>
  23  *   <tr>
  24  *    <td><b>USB Subclass:</b></td>
  25  *    <td>Common Class</td>
  26  *    <td>( Sub-Interface: Abstract Control Model (ACM) )</td>
  27  *   </tr>
  28  *   <tr>
  29  *    <td><b>Relevant Standards:</b></td>
  30  *    <td>USBIF Interface Association Descriptor ECN</td>
  31  *    <td>USBIF CDC Class Standard</td>
  32  *   </tr>
  33  *   <tr>
  34  *    <td><b>Usable Speeds:</b></td>
  35  *    <td>Full Speed Mode</td>
  36  *   </tr>
  37  *  </table>
  38  *
  39  *  \section SSec_Description Project Description:
  40  *
  41  *  Dual Communications Device Class demonstration application.
  42  *  This gives a simple reference application for implementing
  43  *  a compound device with dual CDC functions acting as a pair
  44  *  of virtual serial ports. This demo uses Interface Association
  45  *  Descriptors to link together the pair of related CDC
  46  *  descriptors for each virtual serial port, which may not be
  47  *  supported in all OSes - Windows Vista is supported, as is
  48  *  XP (although the latter may need a hotfix to function).
  49  *
  50  *  Joystick actions are transmitted to the host as strings
  51  *  through the first serial port. The device does not respond to
  52  *  serial data sent from the host in the first serial port.
  53  *
  54  *  The second serial port echoes back data sent from the host.
  55  *
  56  *  After running this demo for the first time on a new computer,
  57  *  you will need to supply the .INF file located in this demo
  58  *  project's directory as the device's driver when running under
  59  *  Windows. This will enable Windows to use its inbuilt CDC drivers,
  60  *  negating the need for custom drivers for the device. Other
  61  *  Operating Systems should automatically use their own inbuilt
  62  *  CDC-ACM drivers.
  63  *
  64  *  \section SSec_Options Project Options
  65  *
  66  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  67  *
  68  *  <table>
  69  *   <tr>
  70  *    <td>
  71  *     None
  72  *    </td>
  73  *   </tr>
  74  *  </table>
  75  */