tmk_core/protocol/lufa/LUFA-git/Demos/Host/LowLevel/VirtualSerialHost/VirtualSerialHost.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 CDC Host 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  *
  15  *  \section Sec_Info USB Information:
  16  *
  17  *  The following table gives a rundown of the USB utilization of this demo.
  18  *
  19  *  <table>
  20  *   <tr>
  21  *    <td><b>USB Mode:</b></td>
  22  *    <td>Host</td>
  23  *   </tr>
  24  *   <tr>
  25  *    <td><b>USB Class:</b></td>
  26  *    <td>Communications Device Class (CDC)</td>
  27  *   </tr>
  28  *   <tr>
  29  *    <td><b>USB Subclass:</b></td>
  30  *    <td>Abstract Control Model (ACM)</td>
  31  *   </tr>
  32  *   <tr>
  33  *    <td><b>Relevant Standards:</b></td>
  34  *    <td>USBIF CDC Class Standard</td>
  35  *   </tr>
  36  *   <tr>
  37  *    <td><b>Supported USB Speeds:</b></td>
  38  *    <td>Full Speed Mode</td>
  39  *   </tr>
  40  *  </table>
  41  *
  42  *  \section Sec_Description Project Description:
  43  *
  44  *  CDC host demonstration application. This gives a simple reference application
  45  *  for implementing a USB CDC host, for CDC devices using the standard ACM profile.
  46  *
  47  *  This demo prints out received CDC data through the serial port.
  48  *
  49  *  Note that this demo is only compatible with devices which report the correct CDC
  50  *  and ACM class, subclass and protocol values. Most USB-Serial cables have vendor
  51  *  specific features, thus use vendor-specific class/subclass/protocol codes to force
  52  *  the user to use specialized drivers. This demo is not compatible with such devices.
  53  *
  54  *  \section Sec_Options Project Options
  55  *
  56  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  57  *
  58  *  <table>
  59  *   <tr>
  60  *    <td>
  61  *     None
  62  *    </td>
  63  *   </tr>
  64  *  </table>
  65  */
  66