Demos/CDC/CDC.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 Device (Virtual Serial Port)
   8  *
   9  *  Communications Device Class demonstration application.
  10  *  This gives a simple reference application for implementing
  11  *  a CDC device acting as a virtual serial port. Joystick
  12  *  actions are transmitted to the host as strings. The device
  13  *  does not respond to serial data sent from the host.
  14  *
  15  *  After running this demo for the first time on a new computer,
  16  *  you will need to supply the .INF file located in this demo
  17  *  project's directory as the device's driver when running under
  18  *  Windows. This will enable Windows to use its inbuilt CDC drivers,
  19  *  negating the need for custom drivers for the device. Other
  20  *  Operating Systems should automatically use their own inbuilt
  21  *  CDC-ACM drivers.
  22  *
  23  *  <table>
  24  *   <tr>
  25  *    <td><b>USB Mode:</b></td>
  26  *    <td>Device</td>
  27  *   </tr>
  28  *   <tr>
  29  *    <td><b>USB Class:</b></td>
  30  *    <td>Communications Device Class (CDC)</td>
  31  *   </tr>
  32  *   <tr>
  33  *    <td><b>USB Subclass:</b></td>
  34  *    <td>Abstract Control Model (ACM)</td>
  35  *   </tr>
  36  *   <tr>
  37  *    <td><b>Relevant Standards:</b></td>
  38  *    <td>USBIF CDC Class Standard</td>
  39  *   </tr>
  40  *   <tr>
  41  *    <td><b>Usable Speeds:</b></td>
  42  *    <td>Full Speed Mode</td>
  43  *   </tr>
  44  *  </table>
  45  */