generichid.txt

LUFA (Lightweight USB Framework for AVRs) is my first foray into the world of USB. Originally based

/** \file
 *
 *  This file contains special DoxyGen information for the generation of the main page and other special
 *  documentation pages. It is not a project source file.
 */
 
/** \mainpage Generic HID Device
 *
 *  \section SSec_Info USB Information:
 *
 *  The following table gives a rundown of the USB utilization of this demo.
 *
 *  <table>
 *   <tr>
 *    <td><b>USB Mode:</b></td>
 *    <td>Device</td>
 *   </tr>
 *   <tr>
 *    <td><b>USB Class:</b></td>
 *    <td>Human Interface Device (HID)</td>
 *   </tr>
 *   <tr> 
 *    <td><b>USB Subclass:</b></td>
 *    <td>N/A</td>
 *   </tr>
 *   <tr>
 *    <td><b>Relevant Standards:</b></td>
 *    <td>USBIF HID Specification, USBIF HID Usage Tables</td>
 *   </tr>
 *   <tr>
 *    <td><b>Usable Speeds:</b></td>
 *    <td>Low Speed Mode, Full Speed Mode</td>
 *   </tr>
 *  </table>
 *
 *  \section SSec_Description Project Description: 
 *
 *  Generic HID device demonstration application. This gives a simple reference application
 *  for implementing a generic HID device, using the basic USB HID drivers in all modern
 *  OSes (i.e. no special drivers required). It accepts and sends up to 255 byte reports to
 *  and from a USB Host, and by default transmits the last sent report back to the host.
 *  
 *  On start-up the system will automatically enumerate and function as a vendor HID device.
 *  When controlled by a custom HID class application, reports can be sent and received by
 *  both the standard data endpoint and control request methods defined in the HID specification.
 *
 *  \section SSec_Options Project Options
 *  
 *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
 *
 *  <table>
 *   <tr>
 *    <td><b>Define Name:</b></td>
 *    <td><b>Location:</b></td>
 *    <td><b>Description:</b></td>
 *   </tr>
 *   <tr>
 *    <td>GENERIC_REPORT_SIZE</td>
 *    <td>Descriptors.h</td>
 *    <td>This token defines the size of the device reports, both sent and received. The value must be an
 *        integer ranging from 1 to 255.</td>
 *   </tr>
 *   <tr>
 *    <td>INTERRUPT_CONTROL_ENDPOINT</td>
 *    <td>Makefile CDEFS</td>
 *    <td>When defined, this causes the demo to enable interrupts for the control endpoint,
 *        which services control requests from the host. If not defined, the control endpoint
 *        is serviced via polling using the task scheduler.</td>
 *   </tr>
 *   <tr>
 *    <td>INTERRUPT_DATA_ENDPOINT</td>
 *    <td>Makefile CDEFS</td>
 *    <td>When defined, this causes the demo to enable interrupts for the data endpoints,
 *        which services incoming LED reports and outgoing key status reports to and from the host.
 *        If not defined, the data endpoints are serviced via polling using the task scheduler.</td>
 *   </tr>
 *  </table>
 */