Demos/Device/GenericHID/GenericHID.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 Device
   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>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 device demonstration application. This gives a simple reference application
  39  *  for implementing a generic HID device, using the basic USB HID drivers in all modern
  40  *  OSes (i.e. no special drivers required). It accepts and sends up to 255 byte reports to
  41  *  and from a USB Host, and by default transmits the last sent report back to the host.
  42  *
  43  *  On start-up the system will automatically enumerate and function as a vendor HID device.
  44  *  When controlled by a custom HID class application, reports can be sent and received by
  45  *  both the standard data endpoint and control request methods defined in the HID specification.
  46  *
  47  *  \section SSec_Options Project Options
  48  *
  49  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  50  *
  51  *  <table>
  52  *   <tr>
  53  *    <td><b>Define Name:</b></td>
  54  *    <td><b>Location:</b></td>
  55  *    <td><b>Description:</b></td>
  56  *   </tr>
  57  *   <tr>
  58  *    <td>GENERIC_REPORT_SIZE</td>
  59  *    <td>Descriptors.h</td>
  60  *    <td>This token defines the size of the device reports, both sent and received. The value must be an
  61  *        integer ranging from 1 to 255.</td>
  62  *   </tr>
  63  *   <tr>
  64  *    <td>INTERRUPT_CONTROL_ENDPOINT</td>
  65  *    <td>Makefile CDEFS</td>
  66  *    <td>When defined, this causes the demo to enable interrupts for the control endpoint,
  67  *        which services control requests from the host. If not defined, the control endpoint
  68  *        is serviced via polling using the task scheduler.</td>
  69  *   </tr>
  70  *   <tr>
  71  *    <td>INTERRUPT_DATA_ENDPOINT</td>
  72  *    <td>Makefile CDEFS</td>
  73  *    <td>When defined, this causes the demo to enable interrupts for the data endpoints,
  74  *        which services incoming LED reports and outgoing key status reports to and from the host.
  75  *        If not defined, the data endpoints are serviced via polling using the task scheduler.</td>
  76  *   </tr>
  77  *  </table>
  78  */