ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Deploying to gh-pages from master @ f061ca4974 🚀

Browse source
This commit is contained in:
tzarc 2021-08-28 22:38:06 +00:00
parent ff51171c4d
commit 80b580d6b4
67 changed files with 2451 additions and 635 deletions
Download patch file Download diff file Expand all files Collapse all files

30
internals_usb_hid_protocol.md
View file

@ -1,6 +1,6 @@
# group `usb_hid_protocol` {#group__usb__hid__protocol}
USB Human Interface Device ([HID](.build/docs/internals_undefined.md#class_h_i_d)) protocol definitions.
USB Human Interface Device (HID) protocol definitions.
protocol definitions
@ -9,11 +9,11 @@ protocol definitions
Members | Descriptions
--------------------------------|---------------------------------------------
`enum `[`usb_reqid_hid`](#group__usb__hid__protocol_1gaa7c41bb1274630413fb8f1e9a8acb3e5) | Hid USB requests (bRequest)
`enum `[`usb_descriptor_type_hid`](#group__usb__hid__protocol_1ga75d07fddd98e94eee499e34ce80eebc7) | [HID](.build/docs/internals_undefined.md#class_h_i_d) USB descriptor types.
`enum `[`usb_hid_item_report_type`](#group__usb__hid__protocol_1gab8c213eaa38f71a4aae0c2bb7341f170) | [HID](.build/docs/internals_undefined.md#class_h_i_d) Type for report descriptor.
`enum `[`usb_hid_report_type`](#group__usb__hid__protocol_1ga5832b449d0ccdae41b51ee5436e8df28) | [HID](.build/docs/internals_undefined.md#class_h_i_d) report type.
`enum `[`usb_hid_protocol`](#group__usb__hid__protocol_1gaf68d2167c72cb42e4788cbeba994c255) | [HID](.build/docs/internals_undefined.md#class_h_i_d) protocol.
`struct `[`usb_hid_descriptor_t`](#structusb__hid__descriptor__t) | [HID](.build/docs/internals_undefined.md#class_h_i_d) Descriptor.
`enum `[`usb_descriptor_type_hid`](#group__usb__hid__protocol_1ga75d07fddd98e94eee499e34ce80eebc7) | HID USB descriptor types.
`enum `[`usb_hid_item_report_type`](#group__usb__hid__protocol_1gab8c213eaa38f71a4aae0c2bb7341f170) | HID Type for report descriptor.
`enum `[`usb_hid_report_type`](#group__usb__hid__protocol_1ga5832b449d0ccdae41b51ee5436e8df28) | HID report type.
`enum `[`usb_hid_protocol`](#group__usb__hid__protocol_1gaf68d2167c72cb42e4788cbeba994c255) | HID protocol.
`struct `[`usb_hid_descriptor_t`](#structusb__hid__descriptor__t) | HID Descriptor.
## Members
@ -38,7 +38,7 @@ USB_DT_HID |
USB_DT_HID_REPORT |
USB_DT_HID_PHYSICAL |
[HID](.build/docs/internals_undefined.md#class_h_i_d) USB descriptor types.
HID USB descriptor types.
#### `enum `[`usb_hid_item_report_type`](#group__usb__hid__protocol_1gab8c213eaa38f71a4aae0c2bb7341f170) {#group__usb__hid__protocol_1gab8c213eaa38f71a4aae0c2bb7341f170}
@ -49,7 +49,7 @@ USB_HID_ITEM_REPORT_TYPE_GLOBAL |
USB_HID_ITEM_REPORT_TYPE_LOCAL |
USB_HID_ITEM_REPORT_TYPE_LONG |
[HID](.build/docs/internals_undefined.md#class_h_i_d) Type for report descriptor.
HID Type for report descriptor.
#### `enum `[`usb_hid_report_type`](#group__usb__hid__protocol_1ga5832b449d0ccdae41b51ee5436e8df28) {#group__usb__hid__protocol_1ga5832b449d0ccdae41b51ee5436e8df28}
@ -59,7 +59,7 @@ USB_HID_REPORT_TYPE_INPUT |
USB_HID_REPORT_TYPE_OUTPUT |
USB_HID_REPORT_TYPE_FEATURE |
[HID](.build/docs/internals_undefined.md#class_h_i_d) report type.
HID report type.
#### `enum `[`usb_hid_protocol`](#group__usb__hid__protocol_1gaf68d2167c72cb42e4788cbeba994c255) {#group__usb__hid__protocol_1gaf68d2167c72cb42e4788cbeba994c255}
@ -68,21 +68,21 @@ USB_HID_REPORT_TYPE_FEATURE |
USB_HID_PROCOTOL_BOOT |
USB_HID_PROCOTOL_REPORT |
[HID](.build/docs/internals_undefined.md#class_h_i_d) protocol.
HID protocol.
# struct `usb_hid_descriptor_t` {#structusb__hid__descriptor__t}
[HID](.build/docs/internals_undefined.md#class_h_i_d) Descriptor.
HID Descriptor.
## Summary
Members | Descriptions
--------------------------------|---------------------------------------------
`public uint8_t `[`bLength`](#structusb__hid__descriptor__t_1a1deca1f1d6e5815b290e6e1015bce5b8) | Size of this descriptor in bytes.
`public uint8_t `[`bDescriptorType`](#structusb__hid__descriptor__t_1a67d7027b9eb9ed268d28e84fbc675707) | [HID](.build/docs/internals_undefined.md#class_h_i_d) descriptor type.
`public uint8_t `[`bDescriptorType`](#structusb__hid__descriptor__t_1a67d7027b9eb9ed268d28e84fbc675707) | HID descriptor type.
`public le16_t `[`bcdHID`](#structusb__hid__descriptor__t_1ab86c23448d45c6d68efec9f9af5d10de) | Binary Coded Decimal Spec. release.
`public uint8_t `[`bCountryCode`](#structusb__hid__descriptor__t_1a969a604033b72573d59a740badf6920e) | Hardware target country.
`public uint8_t `[`bNumDescriptors`](#structusb__hid__descriptor__t_1a86ff434026085d9c0c751185eb3700c5) | Number of [HID](.build/docs/internals_undefined.md#class_h_i_d) class descriptors to follow.
`public uint8_t `[`bNumDescriptors`](#structusb__hid__descriptor__t_1a86ff434026085d9c0c751185eb3700c5) | Number of HID class descriptors to follow.
`public uint8_t `[`bRDescriptorType`](#structusb__hid__descriptor__t_1a6da89ed91bee6e0a4f2c8cf3b40a7ede) | Report descriptor type.
`public le16_t `[`wDescriptorLength`](#structusb__hid__descriptor__t_1ab3d5c878a0abf618eecc7f860e9aeb62) | Total length of Report descriptor.
@ -94,7 +94,7 @@ Size of this descriptor in bytes.
#### `public uint8_t `[`bDescriptorType`](#structusb__hid__descriptor__t_1a67d7027b9eb9ed268d28e84fbc675707) {#structusb__hid__descriptor__t_1a67d7027b9eb9ed268d28e84fbc675707}
[HID](.build/docs/internals_undefined.md#class_h_i_d) descriptor type.
HID descriptor type.
#### `public le16_t `[`bcdHID`](#structusb__hid__descriptor__t_1ab86c23448d45c6d68efec9f9af5d10de) {#structusb__hid__descriptor__t_1ab86c23448d45c6d68efec9f9af5d10de}
@ -106,7 +106,7 @@ Hardware target country.
#### `public uint8_t `[`bNumDescriptors`](#structusb__hid__descriptor__t_1a86ff434026085d9c0c751185eb3700c5) {#structusb__hid__descriptor__t_1a86ff434026085d9c0c751185eb3700c5}
Number of [HID](.build/docs/internals_undefined.md#class_h_i_d) class descriptors to follow.
Number of HID class descriptors to follow.
#### `public uint8_t `[`bRDescriptorType`](#structusb__hid__descriptor__t_1a6da89ed91bee6e0a4f2c8cf3b40a7ede) {#structusb__hid__descriptor__t_1a6da89ed91bee6e0a4f2c8cf3b40a7ede}