HIDReportViewer.txt 2.0 KB

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