qmk_firmware/internals_usb_hid_protocol.md

group usb_hid_protocol

USB Human Interface Device (HID) protocol definitions.

protocol definitions

Summary

Members	Descriptions
enum usb_reqid_hid	Hid USB requests (bRequest)
enum usb_descriptor_type_hid	HID USB descriptor types.
enum usb_hid_item_report_type	HID Type for report descriptor.
enum usb_hid_report_type	HID report type.
enum usb_hid_protocol	HID protocol.
struct usb_hid_descriptor_t	HID Descriptor.

Members

enum usb_reqid_hid

Values	Descriptions
USB_REQ_HID_GET_REPORT
USB_REQ_HID_GET_IDLE
USB_REQ_HID_GET_PROTOCOL
USB_REQ_HID_SET_REPORT
USB_REQ_HID_SET_IDLE
USB_REQ_HID_SET_PROTOCOL

Hid USB requests (bRequest)

enum usb_descriptor_type_hid

Values	Descriptions
USB_DT_HID
USB_DT_HID_REPORT
USB_DT_HID_PHYSICAL

HID USB descriptor types.

enum usb_hid_item_report_type

Values	Descriptions
USB_HID_ITEM_REPORT_TYPE_MAIN
USB_HID_ITEM_REPORT_TYPE_GLOBAL
USB_HID_ITEM_REPORT_TYPE_LOCAL
USB_HID_ITEM_REPORT_TYPE_LONG

HID Type for report descriptor.

enum usb_hid_report_type

Values	Descriptions
USB_HID_REPORT_TYPE_INPUT
USB_HID_REPORT_TYPE_OUTPUT
USB_HID_REPORT_TYPE_FEATURE

HID report type.

enum usb_hid_protocol

Values	Descriptions
USB_HID_PROCOTOL_BOOT
USB_HID_PROCOTOL_REPORT

HID protocol.

struct usb_hid_descriptor_t

HID Descriptor.

Summary

Members	Descriptions
public uint8_t bLength	Size of this descriptor in bytes.
public uint8_t bDescriptorType	HID descriptor type.
public le16_t bcdHID	Binary Coded Decimal Spec. release.
public uint8_t bCountryCode	Hardware target country.
public uint8_t bNumDescriptors	Number of HID class descriptors to follow.
public uint8_t bRDescriptorType	Report descriptor type.
public le16_t wDescriptorLength	Total length of Report descriptor.

Members

public uint8_t bLength

Size of this descriptor in bytes.

public uint8_t bDescriptorType

HID descriptor type.

public le16_t bcdHID

Binary Coded Decimal Spec. release.

public uint8_t bCountryCode

Hardware target country.

public uint8_t bNumDescriptors

Number of HID class descriptors to follow.

public uint8_t bRDescriptorType

Report descriptor type.

public le16_t wDescriptorLength

Total length of Report descriptor.