Loading...
Searching...
No Matches
HID - USB communications device class

Generic USB HID defines and helpers. More...

Detailed Description

Generic USB HID defines and helpers.

Modules

 USB HID descriptor helpers
 USB HID descriptor format helpers.
 
 USB HID usage tables
 USB HID usage tables.
 
 USBUS HID IO
 USBUS HID IO interface module.
 

Files

file  hid.h
 Definition for USB HID interfaces.
 

Data Structures

struct  usb_desc_hid_t
 USB HID descriptor struct. More...
 

Macros

#define USB_TYPE_DESCRIPTOR_HID   0x21
 USB HID type descriptor.
 
#define USB_HID_VERSION_BCD   0x0110
 USB HID version in BCD.
 
#define USB_HID_COUNTRY_CODE_NOTSUPPORTED   0x00
 USB HID country codes.
 
#define USBUS_HID_EP_IN_REQUIRED_NUMOF   1
 Number of IN EPs required for the HID interface.
 
#define USBUS_HID_EP_OUT_REQUIRED_NUMOF   1
 Number of Out EPs required for the HID interface.
 

USB HID subclass types

#define USB_HID_SUBCLASS_NONE   0x0
 
#define USB_HID_SUBCLASS_BOOT   0x1
 

USB HID protocol types

#define USB_HID_PROTOCOL_NONE   0x0
 
#define USB_HID_PROTOCOL_KEYBOARD   0x1
 
#define USB_HID_PROTOCOL_MOUSE   0x2
 

USB HID descriptor types

#define USB_HID_DESCR_HID   0x21
 
#define USB_HID_DESCR_REPORT   0x22
 
#define USB_HID_DESCR_PHYSICAL   0x23
 

USB HID class specific control requests

#define USB_HID_REQUEST_GET_REPORT   0x01
 
#define USB_HID_REQUEST_GET_IDLE   0x02
 
#define USB_HID_REQUEST_GET_PROTOCOL   0x03
 
#define USB_HID_REQUEST_SET_REPORT   0x09
 
#define USB_HID_REQUEST_SET_IDLE   0x0a
 
#define USB_HID_REQUEST_SET_PROTOCOL   0x0b
 

Macro Definition Documentation

◆ USB_HID_COUNTRY_CODE_NOTSUPPORTED

#define USB_HID_COUNTRY_CODE_NOTSUPPORTED   0x00

USB HID country codes.

Definition at line 72 of file hid.h.

◆ USB_HID_DESCR_HID

#define USB_HID_DESCR_HID   0x21

Definition at line 64 of file hid.h.

◆ USB_HID_DESCR_PHYSICAL

#define USB_HID_DESCR_PHYSICAL   0x23

Definition at line 66 of file hid.h.

◆ USB_HID_DESCR_REPORT

#define USB_HID_DESCR_REPORT   0x22

Definition at line 65 of file hid.h.

◆ USB_HID_PROTOCOL_KEYBOARD

#define USB_HID_PROTOCOL_KEYBOARD   0x1

Definition at line 56 of file hid.h.

◆ USB_HID_PROTOCOL_MOUSE

#define USB_HID_PROTOCOL_MOUSE   0x2

Definition at line 57 of file hid.h.

◆ USB_HID_PROTOCOL_NONE

#define USB_HID_PROTOCOL_NONE   0x0

Definition at line 55 of file hid.h.

◆ USB_HID_REQUEST_GET_IDLE

#define USB_HID_REQUEST_GET_IDLE   0x02

Definition at line 79 of file hid.h.

◆ USB_HID_REQUEST_GET_PROTOCOL

#define USB_HID_REQUEST_GET_PROTOCOL   0x03

Definition at line 80 of file hid.h.

◆ USB_HID_REQUEST_GET_REPORT

#define USB_HID_REQUEST_GET_REPORT   0x01

Definition at line 78 of file hid.h.

◆ USB_HID_REQUEST_SET_IDLE

#define USB_HID_REQUEST_SET_IDLE   0x0a

Definition at line 82 of file hid.h.

◆ USB_HID_REQUEST_SET_PROTOCOL

#define USB_HID_REQUEST_SET_PROTOCOL   0x0b

Definition at line 83 of file hid.h.

◆ USB_HID_REQUEST_SET_REPORT

#define USB_HID_REQUEST_SET_REPORT   0x09

Definition at line 81 of file hid.h.

◆ USB_HID_SUBCLASS_BOOT

#define USB_HID_SUBCLASS_BOOT   0x1

Definition at line 48 of file hid.h.

◆ USB_HID_SUBCLASS_NONE

#define USB_HID_SUBCLASS_NONE   0x0

Definition at line 47 of file hid.h.

◆ USB_HID_VERSION_BCD

#define USB_HID_VERSION_BCD   0x0110

USB HID version in BCD.

Definition at line 41 of file hid.h.

◆ USB_TYPE_DESCRIPTOR_HID

#define USB_TYPE_DESCRIPTOR_HID   0x21

USB HID type descriptor.

Definition at line 36 of file hid.h.

◆ USBUS_HID_EP_IN_REQUIRED_NUMOF

#define USBUS_HID_EP_IN_REQUIRED_NUMOF   1

Number of IN EPs required for the HID interface.

Definition at line 89 of file hid.h.

◆ USBUS_HID_EP_OUT_REQUIRED_NUMOF

#define USBUS_HID_EP_OUT_REQUIRED_NUMOF   1

Number of Out EPs required for the HID interface.

Definition at line 94 of file hid.h.