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