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.

118 lines
6.0 KiB

  1. # group `usb_hid_protocol` {#group__usb__hid__protocol}
  2. USB Human Interface Device (HID) protocol definitions.
  3. protocol definitions
  4. ## Summary
  5. Members | Descriptions
  6. --------------------------------|---------------------------------------------
  7. `enum `[`usb_reqid_hid`](#group__usb__hid__protocol_1gaa7c41bb1274630413fb8f1e9a8acb3e5) | Hid USB requests (bRequest)
  8. `enum `[`usb_descriptor_type_hid`](#group__usb__hid__protocol_1ga75d07fddd98e94eee499e34ce80eebc7) | HID USB descriptor types.
  9. `enum `[`usb_hid_item_report_type`](#group__usb__hid__protocol_1gab8c213eaa38f71a4aae0c2bb7341f170) | HID Type for report descriptor.
  10. `enum `[`usb_hid_report_type`](#group__usb__hid__protocol_1ga5832b449d0ccdae41b51ee5436e8df28) | HID report type.
  11. `enum `[`usb_hid_protocol`](#group__usb__hid__protocol_1gaf68d2167c72cb42e4788cbeba994c255) | HID protocol.
  12. `struct `[`usb_hid_descriptor_t`](#structusb__hid__descriptor__t) | HID Descriptor.
  13. ## Members
  14. #### `enum `[`usb_reqid_hid`](#group__usb__hid__protocol_1gaa7c41bb1274630413fb8f1e9a8acb3e5) {#group__usb__hid__protocol_1gaa7c41bb1274630413fb8f1e9a8acb3e5}
  15. Values | Descriptions
  16. --------------------------------|---------------------------------------------
  17. USB_REQ_HID_GET_REPORT |
  18. USB_REQ_HID_GET_IDLE |
  19. USB_REQ_HID_GET_PROTOCOL |
  20. USB_REQ_HID_SET_REPORT |
  21. USB_REQ_HID_SET_IDLE |
  22. USB_REQ_HID_SET_PROTOCOL |
  23. Hid USB requests (bRequest)
  24. #### `enum `[`usb_descriptor_type_hid`](#group__usb__hid__protocol_1ga75d07fddd98e94eee499e34ce80eebc7) {#group__usb__hid__protocol_1ga75d07fddd98e94eee499e34ce80eebc7}
  25. Values | Descriptions
  26. --------------------------------|---------------------------------------------
  27. USB_DT_HID |
  28. USB_DT_HID_REPORT |
  29. USB_DT_HID_PHYSICAL |
  30. HID USB descriptor types.
  31. #### `enum `[`usb_hid_item_report_type`](#group__usb__hid__protocol_1gab8c213eaa38f71a4aae0c2bb7341f170) {#group__usb__hid__protocol_1gab8c213eaa38f71a4aae0c2bb7341f170}
  32. Values | Descriptions
  33. --------------------------------|---------------------------------------------
  34. USB_HID_ITEM_REPORT_TYPE_MAIN |
  35. USB_HID_ITEM_REPORT_TYPE_GLOBAL |
  36. USB_HID_ITEM_REPORT_TYPE_LOCAL |
  37. USB_HID_ITEM_REPORT_TYPE_LONG |
  38. HID Type for report descriptor.
  39. #### `enum `[`usb_hid_report_type`](#group__usb__hid__protocol_1ga5832b449d0ccdae41b51ee5436e8df28) {#group__usb__hid__protocol_1ga5832b449d0ccdae41b51ee5436e8df28}
  40. Values | Descriptions
  41. --------------------------------|---------------------------------------------
  42. USB_HID_REPORT_TYPE_INPUT |
  43. USB_HID_REPORT_TYPE_OUTPUT |
  44. USB_HID_REPORT_TYPE_FEATURE |
  45. HID report type.
  46. #### `enum `[`usb_hid_protocol`](#group__usb__hid__protocol_1gaf68d2167c72cb42e4788cbeba994c255) {#group__usb__hid__protocol_1gaf68d2167c72cb42e4788cbeba994c255}
  47. Values | Descriptions
  48. --------------------------------|---------------------------------------------
  49. USB_HID_PROCOTOL_BOOT |
  50. USB_HID_PROCOTOL_REPORT |
  51. HID protocol.
  52. # struct `usb_hid_descriptor_t` {#structusb__hid__descriptor__t}
  53. HID Descriptor.
  54. ## Summary
  55. Members | Descriptions
  56. --------------------------------|---------------------------------------------
  57. `public uint8_t `[`bLength`](#structusb__hid__descriptor__t_1a1deca1f1d6e5815b290e6e1015bce5b8) | Size of this descriptor in bytes.
  58. `public uint8_t `[`bDescriptorType`](#structusb__hid__descriptor__t_1a67d7027b9eb9ed268d28e84fbc675707) | HID descriptor type.
  59. `public le16_t `[`bcdHID`](#structusb__hid__descriptor__t_1ab86c23448d45c6d68efec9f9af5d10de) | Binary Coded Decimal Spec. release.
  60. `public uint8_t `[`bCountryCode`](#structusb__hid__descriptor__t_1a969a604033b72573d59a740badf6920e) | Hardware target country.
  61. `public uint8_t `[`bNumDescriptors`](#structusb__hid__descriptor__t_1a86ff434026085d9c0c751185eb3700c5) | Number of HID class descriptors to follow.
  62. `public uint8_t `[`bRDescriptorType`](#structusb__hid__descriptor__t_1a6da89ed91bee6e0a4f2c8cf3b40a7ede) | Report descriptor type.
  63. `public le16_t `[`wDescriptorLength`](#structusb__hid__descriptor__t_1ab3d5c878a0abf618eecc7f860e9aeb62) | Total length of Report descriptor.
  64. ## Members
  65. #### `public uint8_t `[`bLength`](#structusb__hid__descriptor__t_1a1deca1f1d6e5815b290e6e1015bce5b8) {#structusb__hid__descriptor__t_1a1deca1f1d6e5815b290e6e1015bce5b8}
  66. Size of this descriptor in bytes.
  67. #### `public uint8_t `[`bDescriptorType`](#structusb__hid__descriptor__t_1a67d7027b9eb9ed268d28e84fbc675707) {#structusb__hid__descriptor__t_1a67d7027b9eb9ed268d28e84fbc675707}
  68. HID descriptor type.
  69. #### `public le16_t `[`bcdHID`](#structusb__hid__descriptor__t_1ab86c23448d45c6d68efec9f9af5d10de) {#structusb__hid__descriptor__t_1ab86c23448d45c6d68efec9f9af5d10de}
  70. Binary Coded Decimal Spec. release.
  71. #### `public uint8_t `[`bCountryCode`](#structusb__hid__descriptor__t_1a969a604033b72573d59a740badf6920e) {#structusb__hid__descriptor__t_1a969a604033b72573d59a740badf6920e}
  72. Hardware target country.
  73. #### `public uint8_t `[`bNumDescriptors`](#structusb__hid__descriptor__t_1a86ff434026085d9c0c751185eb3700c5) {#structusb__hid__descriptor__t_1a86ff434026085d9c0c751185eb3700c5}
  74. Number of HID class descriptors to follow.
  75. #### `public uint8_t `[`bRDescriptorType`](#structusb__hid__descriptor__t_1a6da89ed91bee6e0a4f2c8cf3b40a7ede) {#structusb__hid__descriptor__t_1a6da89ed91bee6e0a4f2c8cf3b40a7ede}
  76. Report descriptor type.
  77. #### `public le16_t `[`wDescriptorLength`](#structusb__hid__descriptor__t_1ab3d5c878a0abf618eecc7f860e9aeb62) {#structusb__hid__descriptor__t_1ab3d5c878a0abf618eecc7f860e9aeb62}
  78. Total length of Report descriptor.