tmk_core/protocol/lufa/LUFA-git/Projects/HIDReportViewer/HIDReportViewer.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 HID Device Report Viewer Programmer Project
   8  *
   9  *  \section Sec_Compat Project Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this project.
  12  *
  13  *  \li Series 7 USB AVRs (AT90USBxxx7)
  14  *
  15  *  \section Sec_Info USB Information:
  16  *
  17  *  The following table gives a rundown of the USB utilization of this project.
  18  *
  19  * <table>
  20  *  <tr>
  21  *   <td><b>USB Mode:</b></td>
  22  *   <td>Host</td>
  23  *  </tr>
  24  *   <tr>
  25  *    <td><b>USB Class:</b></td>
  26  *    <td>Human Interface Device (HID)</td>
  27  *   </tr>
  28  *   <tr>
  29  *    <td><b>USB Subclass:</b></td>
  30  *    <td>N/A</td>
  31  *   </tr>
  32  *   <tr>
  33  *    <td><b>Relevant Standards:</b></td>
  34  *    <td>USBIF HID Specification \n
  35  *        USBIF HID Usage Tables</td>
  36  *   </tr>
  37  *   <tr>
  38  *    <td><b>Supported USB Speeds:</b></td>
  39  *    <td>Low Speed Mode \n
  40  *        Full Speed Mode</td>
  41  *   </tr>
  42  * </table>
  43  *
  44  *  \section Sec_Description Project Description:
  45  *
  46  *  Firmware for a HID Report viewer. This project is designed to aid in the debugging of USB HID Hosts, where the contents of an
  47  *  unknown HID device's HID Report need to be examined. Once a HID device has been plugged into this application, the HID report
  48  *  descriptor will be parsed using the internal LUFA HID report parser, and the results dumped to the serial port in a human
  49  *  readable format. This output will contain information on the sizes of the reports within the device's HID interface, as well as
  50  *  information on each report element (size, usage, minimum/maximum values, etc.).
  51  *
  52  *  \section Sec_Options Project Options
  53  *
  54  *  The following defines can be found in this project, which can control the project behaviour when defined, or changed in value.
  55  *
  56  *  <table>
  57  *   <tr>
  58  *    <td>
  59  *     None
  60  *    </td>
  61  *   </tr>
  62  *  </table>
  63  */
  64