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