Demos/Host/GenericHIDHost/GenericHIDHost.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 Generic HID 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>Human Interface Device (HID)</td>
  21  *   </tr>
  22  *   <tr>
  23  *    <td><b>USB Subclass:</b></td>
  24  *    <td>N/A</td>
  25  *   </tr>
  26  *   <tr>
  27  *    <td><b>Relevant Standards:</b></td>
  28  *    <td>USBIF HID Specification, USBIF HID Usage Tables</td>
  29  *   </tr>
  30  *   <tr>
  31  *    <td><b>Usable Speeds:</b></td>
  32  *    <td>Low Speed Mode, Full Speed Mode</td>
  33  *   </tr>
  34  *  </table>
  35  *
  36  *  \section SSec_Description Project Description:
  37  *
  38  *  Generic HID host demonstration application. This gives a simple reference
  39  *  application for implementing a Generic HID USB host, for any device implementing
  40  *  the HID profile.
  41  *
  42  *  Received reports from the attached device are printed to the serial port.
  43  *
  44  *  \section SSec_Options Project Options
  45  *
  46  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  47  *
  48  *  <table>
  49  *   <tr>
  50  *    <td><b>Define Name:</b></td>
  51  *    <td><b>Location:</b></td>
  52  *    <td><b>Description:</b></td>
  53  *   </tr>
  54  *   <tr>
  55  *    <td>INTERRUPT_DATA_ENDPOINT</td>
  56  *    <td>Makefile CDEFS</td>
  57  *    <td>When defined, this causes the demo to enable interrupts for the data IN pipe,
  58  *        which services reports from the device. If not defined, the data pipe is
  59  *        serviced via polling using the task scheduler.</td>
  60  *   </tr>
  61  *  </table>
  62  */