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.

MouseHost.txt 2.1KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  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 Mouse Host Demo
  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. *
  14. * \section Sec_Info USB Information:
  15. *
  16. * The following table gives a rundown of the USB utilization of this demo.
  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. * Mouse host demonstration application. This gives a simple reference
  46. * application for implementing a USB Mouse host, for USB mice using
  47. * the standard mouse HID profile.
  48. *
  49. * Mouse movement and button presses are displayed on the board LEDs,
  50. * as well as printed out the serial terminal as formatted dY, dY and
  51. * button status information.
  52. *
  53. * This uses a naive method where the mouse is set to Boot Protocol mode, so
  54. * that the report structure is fixed and known. A better implementation
  55. * uses the HID report parser for correct report data processing across
  56. * all compatible mice with advanced characteristics, as shown in the
  57. * MouseHostWithParser demo application.
  58. *
  59. * Currently only single interface mice are supported.
  60. *
  61. * \section Sec_Options Project Options
  62. *
  63. * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  64. *
  65. * <table>
  66. * <tr>
  67. * <td>
  68. * None
  69. * </td>
  70. * </tr>
  71. * </table>
  72. */