Demos/Device/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_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>Communications Device Class (CDC)</td>
  21  *   </tr>
  22  *   <tr>
  23  *    <td><b>USB Subclass:</b></td>
  24  *    <td>Abstract Control Model (ACM)</td>
  25  *   </tr>
  26  *   <tr>
  27  *    <td><b>Relevant Standards:</b></td>
  28  *    <td>USBIF CDC Class Standard</td>
  29  *   </tr>
  30  *   <tr>
  31  *    <td><b>Usable Speeds:</b></td>
  32  *    <td>Full Speed Mode</td>
  33  *   </tr>
  34  *  </table>
  35  *
  36  *  \section SSec_Description Project Description:
  37  *
  38  *  Communications Device Class demonstration application.
  39  *  This gives a simple reference application for implementing
  40  *  a USB to Serial converter using the CDC class. Sent and
  41  *  received data on the serial port is communicated to the USB
  42  *  host.
  43  *
  44  *  After running this demo for the first time on a new computer,
  45  *  you will need to supply the .INF file located in this demo
  46  *  project's directory as the device's driver when running under
  47  *  Windows. This will enable Windows to use its inbuilt CDC drivers,
  48  *  negating the need for custom drivers for the device. Other
  49  *  Operating Systems should automatically use their own inbuilt
  50  *  CDC-ACM drivers.
  51  *
  52  *  \section SSec_Options Project Options
  53  *
  54  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  55  *
  56  *  <table>
  57  *   <tr>
  58  *    <td><b>Define Name:</b></td>
  59  *    <td><b>Location:</b></td>
  60  *    <td><b>Description:</b></td>
  61  *   </tr>
  62  *   <tr>
  63  *    <td>BUFF_STATICSIZE</td>
  64  *    <td>RingBuff.h</td>
  65  *    <td>Defines the maximum number of bytes which can be buffered in each Ring Buffer.</td>
  66  *   </tr>
  67  *  </table>
  68  */