Skip to content
charmOS docs

USB HID

include/drivers/usb/hid.h View source View on GitHub

USB Human Interface Device (HID) class definitions Spec: USB HID 1.11

Macros

Section titled “Macros”

HID subclasses

USB_HID_SUBCLASS_NONE

Section titled “USB_HID_SUBCLASS_NONE”
#define USB_HID_SUBCLASS_NONE 0x00
source

USB_HID_SUBCLASS_BOOT

Section titled “USB_HID_SUBCLASS_BOOT”
#define USB_HID_SUBCLASS_BOOT 0x01
source

USB_HID_PROTOCOL_NONE

Section titled “USB_HID_PROTOCOL_NONE”
#define USB_HID_PROTOCOL_NONE 0x00
source

HID protocols (only meaningful for BOOT subclass)

USB_HID_PROTOCOL_KEYBOARD

Section titled “USB_HID_PROTOCOL_KEYBOARD”
#define USB_HID_PROTOCOL_KEYBOARD 0x01
source

USB_HID_PROTOCOL_MOUSE

Section titled “USB_HID_PROTOCOL_MOUSE”
#define USB_HID_PROTOCOL_MOUSE 0x02
source

USB_HID_DESC_TYPE_HID

Section titled “USB_HID_DESC_TYPE_HID”
#define USB_HID_DESC_TYPE_HID 0x21
source

================================ Descriptor types ================================

USB_HID_DESC_TYPE_REPORT

Section titled “USB_HID_DESC_TYPE_REPORT”
#define USB_HID_DESC_TYPE_REPORT 0x22
source

USB_HID_DESC_TYPE_PHYSICAL

Section titled “USB_HID_DESC_TYPE_PHYSICAL”
#define USB_HID_DESC_TYPE_PHYSICAL 0x23
source

USB_HID_REQ_GET_REPORT

Section titled “USB_HID_REQ_GET_REPORT”
#define USB_HID_REQ_GET_REPORT 0x01
source

================================ HID class-specific requests ================================

USB_HID_REQ_GET_IDLE

Section titled “USB_HID_REQ_GET_IDLE”
#define USB_HID_REQ_GET_IDLE 0x02
source

USB_HID_REQ_GET_PROTOCOL

Section titled “USB_HID_REQ_GET_PROTOCOL”
#define USB_HID_REQ_GET_PROTOCOL 0x03
source

USB_HID_REQ_SET_REPORT

Section titled “USB_HID_REQ_SET_REPORT”
#define USB_HID_REQ_SET_REPORT 0x09
source

USB_HID_REQ_SET_IDLE

Section titled “USB_HID_REQ_SET_IDLE”
#define USB_HID_REQ_SET_IDLE 0x0A
source

USB_HID_REQ_SET_PROTOCOL

Section titled “USB_HID_REQ_SET_PROTOCOL”
#define USB_HID_REQ_SET_PROTOCOL 0x0B
source

USB_HID_REPORT_INPUT

Section titled “USB_HID_REPORT_INPUT”
#define USB_HID_REPORT_INPUT 0x01
source

================================ Report types (wValue high byte) ================================

USB_HID_REPORT_OUTPUT

Section titled “USB_HID_REPORT_OUTPUT”
#define USB_HID_REPORT_OUTPUT 0x02
source

USB_HID_REPORT_FEATURE

Section titled “USB_HID_REPORT_FEATURE”
#define USB_HID_REPORT_FEATURE 0x03
source

USB_HID_PROTOCOL_BOOT

Section titled “USB_HID_PROTOCOL_BOOT”
#define USB_HID_PROTOCOL_BOOT 0x00
source

================================ Protocol values (SET_PROTOCOL) ================================

USB_HID_PROTOCOL_REPORT

Section titled “USB_HID_PROTOCOL_REPORT”
#define USB_HID_PROTOCOL_REPORT 0x01
source

USB_HID_COUNTRY_NONE

Section titled “USB_HID_COUNTRY_NONE”
#define USB_HID_COUNTRY_NONE 0x00
source

================================ Country codes (HID descriptor) ================================

USB_HID_COUNTRY_ARABIC

Section titled “USB_HID_COUNTRY_ARABIC”
#define USB_HID_COUNTRY_ARABIC 0x01
source

USB_HID_COUNTRY_BELGIAN

Section titled “USB_HID_COUNTRY_BELGIAN”
#define USB_HID_COUNTRY_BELGIAN 0x02
source

USB_HID_COUNTRY_CANADIAN_BI

Section titled “USB_HID_COUNTRY_CANADIAN_BI”
#define USB_HID_COUNTRY_CANADIAN_BI 0x03
source

USB_HID_COUNTRY_CANADIAN_FR

Section titled “USB_HID_COUNTRY_CANADIAN_FR”
#define USB_HID_COUNTRY_CANADIAN_FR 0x04
source

USB_HID_COUNTRY_CZECH

Section titled “USB_HID_COUNTRY_CZECH”
#define USB_HID_COUNTRY_CZECH 0x05
source

USB_HID_COUNTRY_DANISH

Section titled “USB_HID_COUNTRY_DANISH”
#define USB_HID_COUNTRY_DANISH 0x06
source

USB_HID_COUNTRY_FINNISH

Section titled “USB_HID_COUNTRY_FINNISH”
#define USB_HID_COUNTRY_FINNISH 0x07
source

USB_HID_COUNTRY_FRENCH

Section titled “USB_HID_COUNTRY_FRENCH”
#define USB_HID_COUNTRY_FRENCH 0x08
source

USB_HID_COUNTRY_GERMAN

Section titled “USB_HID_COUNTRY_GERMAN”
#define USB_HID_COUNTRY_GERMAN 0x09
source

USB_HID_COUNTRY_GREEK

Section titled “USB_HID_COUNTRY_GREEK”
#define USB_HID_COUNTRY_GREEK 0x0A
source

USB_HID_COUNTRY_HEBREW

Section titled “USB_HID_COUNTRY_HEBREW”
#define USB_HID_COUNTRY_HEBREW 0x0B
source

USB_HID_COUNTRY_HUNGARY

Section titled “USB_HID_COUNTRY_HUNGARY”
#define USB_HID_COUNTRY_HUNGARY 0x0C
source

USB_HID_COUNTRY_INTL_ISO

Section titled “USB_HID_COUNTRY_INTL_ISO”
#define USB_HID_COUNTRY_INTL_ISO 0x0D
source

USB_HID_COUNTRY_ITALIAN

Section titled “USB_HID_COUNTRY_ITALIAN”
#define USB_HID_COUNTRY_ITALIAN 0x0E
source

USB_HID_COUNTRY_JAPAN_KATA

Section titled “USB_HID_COUNTRY_JAPAN_KATA”
#define USB_HID_COUNTRY_JAPAN_KATA 0x0F
source

USB_HID_COUNTRY_KOREAN

Section titled “USB_HID_COUNTRY_KOREAN”
#define USB_HID_COUNTRY_KOREAN 0x10
source

USB_HID_COUNTRY_LATIN_AMER

Section titled “USB_HID_COUNTRY_LATIN_AMER”
#define USB_HID_COUNTRY_LATIN_AMER 0x11
source

USB_HID_COUNTRY_NETHERLANDS

Section titled “USB_HID_COUNTRY_NETHERLANDS”
#define USB_HID_COUNTRY_NETHERLANDS 0x12
source

USB_HID_COUNTRY_NORWEGIAN

Section titled “USB_HID_COUNTRY_NORWEGIAN”
#define USB_HID_COUNTRY_NORWEGIAN 0x13
source

USB_HID_COUNTRY_PERSIAN

Section titled “USB_HID_COUNTRY_PERSIAN”
#define USB_HID_COUNTRY_PERSIAN 0x14
source

USB_HID_COUNTRY_POLAND

Section titled “USB_HID_COUNTRY_POLAND”
#define USB_HID_COUNTRY_POLAND 0x15
source

USB_HID_COUNTRY_PORTUGUESE

Section titled “USB_HID_COUNTRY_PORTUGUESE”
#define USB_HID_COUNTRY_PORTUGUESE 0x16
source

USB_HID_COUNTRY_RUSSIA

Section titled “USB_HID_COUNTRY_RUSSIA”
#define USB_HID_COUNTRY_RUSSIA 0x17
source

USB_HID_COUNTRY_SLOVAKIA

Section titled “USB_HID_COUNTRY_SLOVAKIA”
#define USB_HID_COUNTRY_SLOVAKIA 0x18
source

USB_HID_COUNTRY_SPANISH

Section titled “USB_HID_COUNTRY_SPANISH”
#define USB_HID_COUNTRY_SPANISH 0x19
source

USB_HID_COUNTRY_SWEDISH

Section titled “USB_HID_COUNTRY_SWEDISH”
#define USB_HID_COUNTRY_SWEDISH 0x1A
source

USB_HID_COUNTRY_SWISS_FR

Section titled “USB_HID_COUNTRY_SWISS_FR”
#define USB_HID_COUNTRY_SWISS_FR 0x1B
source

USB_HID_COUNTRY_SWISS_DE

Section titled “USB_HID_COUNTRY_SWISS_DE”
#define USB_HID_COUNTRY_SWISS_DE 0x1C
source

USB_HID_COUNTRY_SWITZ_FR

Section titled “USB_HID_COUNTRY_SWITZ_FR”
#define USB_HID_COUNTRY_SWITZ_FR 0x1D
source

USB_HID_COUNTRY_TAIWAN

Section titled “USB_HID_COUNTRY_TAIWAN”
#define USB_HID_COUNTRY_TAIWAN 0x1E
source

USB_HID_COUNTRY_TURKISH_Q

Section titled “USB_HID_COUNTRY_TURKISH_Q”
#define USB_HID_COUNTRY_TURKISH_Q 0x1F
source

USB_HID_COUNTRY_UK

Section titled “USB_HID_COUNTRY_UK”
#define USB_HID_COUNTRY_UK 0x20
source

USB_HID_COUNTRY_US

Section titled “USB_HID_COUNTRY_US”
#define USB_HID_COUNTRY_US 0x21
source

USB_HID_COUNTRY_YUGOSLAVIA

Section titled “USB_HID_COUNTRY_YUGOSLAVIA”
#define USB_HID_COUNTRY_YUGOSLAVIA 0x22
source

USB_HID_COUNTRY_TURKISH_F

Section titled “USB_HID_COUNTRY_TURKISH_F”
#define USB_HID_COUNTRY_TURKISH_F 0x23
source

Modifier byte bits

USB_HID_MODIFIER_BASE

Section titled “USB_HID_MODIFIER_BASE”
#define USB_HID_MODIFIER_BASE 0xE0
source

USB_HID_MOD_LCTRL

Section titled “USB_HID_MOD_LCTRL”
#define USB_HID_MOD_LCTRL 0x01
source

USB_HID_MOD_LSHIFT

Section titled “USB_HID_MOD_LSHIFT”
#define USB_HID_MOD_LSHIFT 0x02
source

USB_HID_MOD_LALT

Section titled “USB_HID_MOD_LALT”
#define USB_HID_MOD_LALT 0x04
source

USB_HID_MOD_LGUI

Section titled “USB_HID_MOD_LGUI”
#define USB_HID_MOD_LGUI 0x08
source

USB_HID_MOD_RCTRL

Section titled “USB_HID_MOD_RCTRL”
#define USB_HID_MOD_RCTRL 0x10
source

USB_HID_MOD_RSHIFT

Section titled “USB_HID_MOD_RSHIFT”
#define USB_HID_MOD_RSHIFT 0x20
source

USB_HID_MOD_RALT

Section titled “USB_HID_MOD_RALT”
#define USB_HID_MOD_RALT 0x40
source

USB_HID_MOD_RGUI

Section titled “USB_HID_MOD_RGUI”
#define USB_HID_MOD_RGUI 0x80
source

LED output report bits

USB_HID_LED_NUM_LOCK

Section titled “USB_HID_LED_NUM_LOCK”
#define USB_HID_LED_NUM_LOCK 0x01
source

USB_HID_LED_CAPS_LOCK

Section titled “USB_HID_LED_CAPS_LOCK”
#define USB_HID_LED_CAPS_LOCK 0x02
source

USB_HID_LED_SCROLL_LOCK

Section titled “USB_HID_LED_SCROLL_LOCK”
#define USB_HID_LED_SCROLL_LOCK 0x04
source

USB_HID_LED_COMPOSE

Section titled “USB_HID_LED_COMPOSE”
#define USB_HID_LED_COMPOSE 0x08
source

USB_HID_LED_KANA

Section titled “USB_HID_LED_KANA”
#define USB_HID_LED_KANA 0x10
source

USB_HID_MOUSE_BTN_LEFT

Section titled “USB_HID_MOUSE_BTN_LEFT”
#define USB_HID_MOUSE_BTN_LEFT 0x01
source

USB_HID_MOUSE_BTN_RIGHT

Section titled “USB_HID_MOUSE_BTN_RIGHT”
#define USB_HID_MOUSE_BTN_RIGHT 0x02
source

USB_HID_MOUSE_BTN_MIDDLE

Section titled “USB_HID_MOUSE_BTN_MIDDLE”
#define USB_HID_MOUSE_BTN_MIDDLE 0x04
source

USB_HID_MOUSE_BTN_BACK

Section titled “USB_HID_MOUSE_BTN_BACK”
#define USB_HID_MOUSE_BTN_BACK 0x08
source

USB_HID_MOUSE_BTN_FORWARD

Section titled “USB_HID_MOUSE_BTN_FORWARD”
#define USB_HID_MOUSE_BTN_FORWARD 0x10
source

USB_HID_REQTYPE_IN

Section titled “USB_HID_REQTYPE_IN”
#define USB_HID_REQTYPE_IN 0xA1
source

Class | Interface | IN

USB_HID_REQTYPE_OUT

Section titled “USB_HID_REQTYPE_OUT”
#define USB_HID_REQTYPE_OUT 0x21
source

Class | Interface | OUT