Demos/Host/ClassDriver/CDCHost/CDCHost.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 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>Host</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  *  CDC host demonstration application. This gives a simple reference application
  39  *  for implementing a USB CDC host, for CDC devices using the standard ACM profile.
  40  *
  41  *  This demo prints out received CDC data through the serial port.
  42  *
  43  *  Not that this demo is only compatible with devices which report the correct CDC
  44  *  and ACM class, subclass and protocol values. Most USB-Serial cables have vendor
  45  *  specific features, thus use vendor-specific class/subclass/protocol codes to force
  46  *  the user to use specialized drivers. This demo is not compatible with such devices.
  47  *
  48  *  \section SSec_Options Project Options
  49  *
  50  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  51  *
  52  *  <table>
  53  *   <tr>
  54  *    <td>
  55  *     None
  56  *    </td>
  57  *   </tr>
  58  *  </table>
  59  */