Demos/Device/ClassDriver/USBtoSerial/USBtoSerial.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 USB to Serial Converter Demo (via CDC-ACM class)
   8  *
   9  *  \section SSec_Compat Demo Compatibility:
  10  *
  11  *  This demo is known to be compatible with the following microcontrollers:
  12  *
  13  *  - AT90USB1287
  14  *  - AT90USB1286
  15  *  - AT90USB647
  16  *  - AT90USB646
  17  *  - ATMEGA32U6
  18  *  - ATMEGA32U4
  19  *  - ATMEGA16U4
  20  *  - AT90USB162
  21  *  - AT90USB82
  22  *
  23  *  \section SSec_Info USB Information:
  24  *
  25  *  The following table gives a rundown of the USB utilization of this demo.
  26  *
  27  *  <table>
  28  *   <tr>
  29  *    <td><b>USB Mode:</b></td>
  30  *    <td>Device</td>
  31  *   </tr>
  32  *   <tr>
  33  *    <td><b>USB Class:</b></td>
  34  *    <td>Communications Device Class (CDC)</td>
  35  *   </tr>
  36  *   <tr>
  37  *    <td><b>USB Subclass:</b></td>
  38  *    <td>Abstract Control Model (ACM)</td>
  39  *   </tr>
  40  *   <tr>
  41  *    <td><b>Relevant Standards:</b></td>
  42  *    <td>USBIF CDC Class Standard</td>
  43  *   </tr>
  44  *   <tr>
  45  *    <td><b>Usable Speeds:</b></td>
  46  *    <td>Full Speed Mode</td>
  47  *   </tr>
  48  *  </table>
  49  *
  50  *  \section SSec_Description Project Description:
  51  *
  52  *  Communications Device Class demonstration application.
  53  *  This gives a simple reference application for implementing
  54  *  a USB to Serial converter using the CDC class. Sent and
  55  *  received data on the serial port is communicated to the USB
  56  *  host.
  57  *
  58  *  After running this demo for the first time on a new computer,
  59  *  you will need to supply the .INF file located in this demo
  60  *  project's directory as the device's driver when running under
  61  *  Windows. This will enable Windows to use its inbuilt CDC drivers,
  62  *  negating the need for custom drivers for the device. Other
  63  *  Operating Systems should automatically use their own inbuilt
  64  *  CDC-ACM drivers.
  65  *
  66  *  \section SSec_Options Project Options
  67  *
  68  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  69  *
  70  *  <table>
  71  *   <tr>
  72  *    <td><b>Define Name:</b></td>
  73  *    <td><b>Location:</b></td>
  74  *    <td><b>Description:</b></td>
  75  *   </tr>
  76  *   <tr>
  77  *    <td>BUFF_STATICSIZE</td>
  78  *    <td>RingBuff.h</td>
  79  *    <td>Defines the maximum number of bytes which can be buffered in each Ring Buffer.</td>
  80  *   </tr>
  81  *  </table>
  82  */