Keyboard firmwares for Atmel AVR and Cortex-M
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

GenericHID.txt 2.5KB

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