Demos/Device/ClassDriver/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_Compat Demo Compatibility:
  10  *
  11  *  The following table indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  - AT90USB1287
  14  *  - AT90USB1286
  15  *  - AT90USB647
  16  *  - AT90USB646
  17  *  - ATMEGA32U6
  18  *  - ATMEGA32U4
  19  *  - ATMEGA16U4
  20  *  - AT90USB162
  21  *  - AT90USB82
  22  *
  23  *  \section SSec_Info USB Information:
  24  *
  25  *  The following table gives a rundown of the USB utilization of this demo.
  26  *
  27  *  <table>
  28  *   <tr>
  29  *    <td><b>USB Mode:</b></td>
  30  *    <td>Device</td>
  31  *   </tr>
  32  *   <tr>
  33  *    <td><b>USB Class:</b></td>
  34  *    <td>Human Interface Device (HID)</td>
  35  *   </tr>
  36  *   <tr>
  37  *    <td><b>USB Subclass:</b></td>
  38  *    <td>N/A</td>
  39  *   </tr>
  40  *   <tr>
  41  *    <td><b>Relevant Standards:</b></td>
  42  *    <td>USBIF HID Specification, USBIF HID Usage Tables</td>
  43  *   </tr>
  44  *   <tr>
  45  *    <td><b>Usable Speeds:</b></td>
  46  *    <td>Low Speed Mode, Full Speed Mode</td>
  47  *   </tr>
  48  *  </table>
  49  *
  50  *  \section SSec_Description Project Description:
  51  *
  52  *  Generic HID device demonstration application. This gives a simple reference application
  53  *  for implementing a generic HID device, using the basic USB HID drivers in all modern
  54  *  OSes (i.e. no special drivers required). By default it accepts and sends up to 8 byte reports
  55  *  to and from a USB Host, and transmits the last sent report back to the host.
  56  *
  57  *  On start-up the system will automatically enumerate and function as a vendor HID device.
  58  *  When controlled by a custom HID class application, reports can be sent and received by
  59  *  both the standard data endpoint and control request methods defined in the HID specification.
  60  *
  61  *  \section SSec_Options Project Options
  62  *
  63  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  64  *
  65  *  <table>
  66  *   <tr>
  67  *    <td><b>Define Name:</b></td>
  68  *    <td><b>Location:</b></td>
  69  *    <td><b>Description:</b></td>
  70  *   </tr>
  71  *   <tr>
  72  *    <td>GENERIC_REPORT_SIZE</td>
  73  *    <td>Descriptors.h</td>
  74  *    <td>This token defines the size of the device reports, both sent and received. The value must be an
  75  *        integer ranging from 1 to 255.</td>
  76  *   </tr>
  77  *  </table>
  78  */