Common Class Definitions
[HID Class Driver - LUFA/Drivers/Class/HID.h]

Data Structures

struct  USB_HID_Descriptor_t
 HID Class Specific HID Descriptor. More...
struct  USB_MouseReport_Data_t
 Standard HID Boot Protocol Mouse Report. More...
struct  USB_KeyboardReport_Data_t
 Standard HID Boot Protocol Keyboard Report. More...

Defines

#define REQ_GetReport   0x01
#define REQ_GetIdle   0x02
#define REQ_SetReport   0x09
#define REQ_SetIdle   0x0A
#define REQ_GetProtocol   0x03
#define REQ_SetProtocol   0x0B
#define DTYPE_HID   0x21
#define DTYPE_Report   0x22
#define HID_NON_BOOT_PROTOCOL   0x00
#define HID_BOOT_KEYBOARD_PROTOCOL   0x01
#define HID_BOOT_MOUSE_PROTOCOL   0x02
#define HID_KEYBOARD_MODIFER_LEFTCTRL   (1 << 0)
#define HID_KEYBOARD_MODIFER_LEFTSHIFT   (1 << 1)
#define HID_KEYBOARD_MODIFER_LEFTALT   (1 << 2)
#define HID_KEYBOARD_MODIFER_LEFTGUI   (1 << 3)
#define HID_KEYBOARD_MODIFER_RIGHTCTRL   (1 << 4)
#define HID_KEYBOARD_MODIFER_RIGHTSHIFT   (1 << 5)
#define HID_KEYBOARD_MODIFER_RIGHTALT   (1 << 6)
#define HID_KEYBOARD_MODIFER_RIGHTGUI   (1 << 7)
#define HID_KEYBOARD_LED_NUMLOCK   (1 << 0)
#define HID_KEYBOARD_LED_CAPSLOCK   (1 << 1)
#define HID_KEYBOARD_LED_SCROLLLOCK   (1 << 2)
#define HID_KEYBOARD_LED_KATANA   (1 << 3)

Typedefs

typedef uint8_t USB_Descriptor_HIDReport_Datatype_t

Enumerations

enum  HID_ReportItemTypes_t {
  REPORT_ITEM_TYPE_In = 0,
  REPORT_ITEM_TYPE_Out = 1,
  REPORT_ITEM_TYPE_Feature = 2
}

Detailed Description

Description

Constants, Types and Enum definitions that are common to both Device and Host modes for the USB HID Class.


Define Documentation

#define DTYPE_HID   0x21

Descriptor header type value, to indicate a HID class HID descriptor.

#define DTYPE_Report   0x22

Descriptor header type value, to indicate a HID class HID report descriptor.

#define HID_BOOT_KEYBOARD_PROTOCOL   0x01

Constant for the protocol value of a HID interface descriptor, indicating that the interface supports the HID class Keyboard boot protocol (see HID Class Specification).

#define HID_BOOT_MOUSE_PROTOCOL   0x02

Constant for the protocol value of a HID interface descriptor, indicating that the interface supports the HID class Mouse boot protocol (see HID Class Specification).

#define HID_KEYBOARD_LED_CAPSLOCK   (1 << 1)

Constant for a keyboard output report LED byte, indicating that the host's CAPS LOCK mode is currently set.

#define HID_KEYBOARD_LED_KATANA   (1 << 3)

Constant for a keyboard output report LED byte, indicating that the host's KATANA mode is currently set.

#define HID_KEYBOARD_LED_NUMLOCK   (1 << 0)

Constant for a keyboard output report LED byte, indicating that the host's NUM LOCK mode is currently set.

#define HID_KEYBOARD_LED_SCROLLLOCK   (1 << 2)

Constant for a keyboard output report LED byte, indicating that the host's SCROLL LOCK mode is currently set.

#define HID_KEYBOARD_MODIFER_LEFTALT   (1 << 2)

Constant for a keyboard report modifier byte, indicating that the keyboard's left alt key is currently pressed.

#define HID_KEYBOARD_MODIFER_LEFTCTRL   (1 << 0)

Constant for a keyboard report modifier byte, indicating that the keyboard's left control key is currently pressed.

#define HID_KEYBOARD_MODIFER_LEFTGUI   (1 << 3)

Constant for a keyboard report modifier byte, indicating that the keyboard's left GUI key is currently pressed.

#define HID_KEYBOARD_MODIFER_LEFTSHIFT   (1 << 1)

Constant for a keyboard report modifier byte, indicating that the keyboard's left shift key is currently pressed.

#define HID_KEYBOARD_MODIFER_RIGHTALT   (1 << 6)

Constant for a keyboard report modifier byte, indicating that the keyboard's right alt key is currently pressed.

#define HID_KEYBOARD_MODIFER_RIGHTCTRL   (1 << 4)

Constant for a keyboard report modifier byte, indicating that the keyboard's right control key is currently pressed.

#define HID_KEYBOARD_MODIFER_RIGHTGUI   (1 << 7)

Constant for a keyboard report modifier byte, indicating that the keyboard's right GUI key is currently pressed.

#define HID_KEYBOARD_MODIFER_RIGHTSHIFT   (1 << 5)

Constant for a keyboard report modifier byte, indicating that the keyboard's right shift key is currently pressed.

#define HID_NON_BOOT_PROTOCOL   0x00

Constant for the protocol value of a HID interface descriptor, indicating that the interface does not support any HID class boot protocol (see HID Class Specification).

#define REQ_GetIdle   0x02

HID Class Specific Request to get the current device idle count.

#define REQ_GetProtocol   0x03

HID Class Specific Request to get the current HID report protocol mode.

#define REQ_GetReport   0x01

HID Class Specific Request to get the current HID report from the device.

#define REQ_SetIdle   0x0A

HID Class Specific Request to set the device's idle count.

#define REQ_SetProtocol   0x0B

HID Class Specific Request to set the current HID report protocol mode.

#define REQ_SetReport   0x09

HID Class Specific Request to set the current HID report to the device.


Typedef Documentation

Type define for the data type used to store HID report descriptor elements.


Enumeration Type Documentation

Enum for the different types of HID reports.

Enumerator:
REPORT_ITEM_TYPE_In 

Indicates that the item is an IN report type.

REPORT_ITEM_TYPE_Out 

Indicates that the item is an OUT report type.

REPORT_ITEM_TYPE_Feature 

Indicates that the item is a FEATURE report type.

Generated by  doxygen 1.6.3