Demos/Device/ClassDriver/VirtualSerial/VirtualSerial.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 Communications Device Class (Virtual Serial Port) Demo
   8  *
   9  *  \section Sec_Compat Demo Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  \li Series 7 USB AVRs (AT90USBxxx7)
  14  *  \li Series 6 USB AVRs (AT90USBxxx6)
  15  *  \li Series 4 USB AVRs (ATMEGAxxU4)
  16  *  \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
  17  *  \li Series AU XMEGA AVRs (ATXMEGAxxxAxU)
  18  *  \li Series B XMEGA AVRs (ATXMEGAxxxBx)
  19  *  \li Series C XMEGA AVRs (ATXMEGAxxxCx)
  20  *
  21  *  \section Sec_Info USB Information:
  22  *
  23  *  The following table gives a rundown of the USB utilization of this demo.
  24  *
  25  *  <table>
  26  *   <tr>
  27  *    <td><b>USB Mode:</b></td>
  28  *    <td>Device</td>
  29  *   </tr>
  30  *   <tr>
  31  *    <td><b>USB Class:</b></td>
  32  *    <td>Communications Device Class (CDC)</td>
  33  *   </tr>
  34  *   <tr>
  35  *    <td><b>USB Subclass:</b></td>
  36  *    <td>Abstract Control Model (ACM)</td>
  37  *   </tr>
  38  *   <tr>
  39  *    <td><b>Relevant Standards:</b></td>
  40  *    <td>USBIF CDC Class Standard</td>
  41  *   </tr>
  42  *   <tr>
  43  *    <td><b>Supported USB Speeds:</b></td>
  44  *    <td>Full Speed Mode</td>
  45  *   </tr>
  46  *  </table>
  47  *
  48  *  \section Sec_Description Project Description:
  49  *
  50  *  Communications Device Class demonstration application.
  51  *  This gives a simple reference application for implementing
  52  *  a CDC device acting as a virtual serial port. Joystick
  53  *  actions are transmitted to the host as strings. The device
  54  *  does not respond to serial 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 Sec_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  */
  76