X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/7f9f97c792dee6875fbca9806422bdd7d6c5a657..797130bddc25d519cd765ca8d82d1e729e3d8ae0:/LUFA/Drivers/USB/Class/Common/HID.h diff --git a/LUFA/Drivers/USB/Class/Common/HID.h b/LUFA/Drivers/USB/Class/Common/HID.h index b6af8af30..0c908c5b5 100644 --- a/LUFA/Drivers/USB/Class/Common/HID.h +++ b/LUFA/Drivers/USB/Class/Common/HID.h @@ -28,6 +28,15 @@ this software. */ +/** \file + * \brief Common definitions and declarations for the library USB HID Class driver. + * + * Common definitions and declarations for the library USB HID Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/HID.h. + */ + /** \ingroup Group_USBClassHID * @defgroup Group_USBClassHIDCommon Common Class Definitions * @@ -46,45 +55,86 @@ #include + /* Preprocessor Checks: */ + #if !defined(__INCLUDE_FROM_HID_DRIVER) + #error Do not include this file directly. Include LUFA/Drivers/Class/HID.h instead. + #endif + /* Macros: */ /** HID Class Specific Request to get the current HID report from the device. */ - #define REQ_GetReport 0x01 + #define REQ_GetReport 0x01 /** HID Class Specific Request to get the current device idle count. */ - #define REQ_GetIdle 0x02 + #define REQ_GetIdle 0x02 /** HID Class Specific Request to set the current HID report to the device. */ - #define REQ_SetReport 0x09 + #define REQ_SetReport 0x09 /** HID Class Specific Request to set the device's idle count. */ - #define REQ_SetIdle 0x0A + #define REQ_SetIdle 0x0A /** HID Class Specific Request to get the current HID report protocol mode. */ - #define REQ_GetProtocol 0x03 + #define REQ_GetProtocol 0x03 /** HID Class Specific Request to set the current HID report protocol mode. */ - #define REQ_SetProtocol 0x0B + #define REQ_SetProtocol 0x0B /** Descriptor header type value, to indicate a HID class HID descriptor. */ - #define DTYPE_HID 0x21 + #define DTYPE_HID 0x21 /** Descriptor header type value, to indicate a HID class HID report descriptor. */ - #define DTYPE_Report 0x22 + #define DTYPE_Report 0x22 /** 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 HID_NON_BOOT_PROTOCOL 0x00 + #define HID_NON_BOOT_PROTOCOL 0x00 /** 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_KEYBOARD_PROTOCOL 0x01 + #define HID_BOOT_KEYBOARD_PROTOCOL 0x01 /** 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_BOOT_MOUSE_PROTOCOL 0x02 + #define HID_BOOT_MOUSE_PROTOCOL 0x02 + + /** Constant for a keyboard report modifier byte, indicating that the keyboard's left control key is currently pressed. */ + #define HID_KEYBOARD_MODIFER_LEFTCTRL (1 << 0) + + /** Constant for a keyboard report modifier byte, indicating that the keyboard's left shift key is currently pressed. */ + #define HID_KEYBOARD_MODIFER_LEFTSHIFT (1 << 1) + + /** Constant for a keyboard report modifier byte, indicating that the keyboard's left alt key is currently pressed. */ + #define HID_KEYBOARD_MODIFER_LEFTALT (1 << 2) + + /** Constant for a keyboard report modifier byte, indicating that the keyboard's left GUI key is currently pressed. */ + #define HID_KEYBOARD_MODIFER_LEFTGUI (1 << 3) + + /** Constant for a keyboard report modifier byte, indicating that the keyboard's right control key is currently pressed. */ + #define HID_KEYBOARD_MODIFER_RIGHTCTRL (1 << 4) + + /** Constant for a keyboard report modifier byte, indicating that the keyboard's right shift key is currently pressed. */ + #define HID_KEYBOARD_MODIFER_RIGHTSHIFT (1 << 5) + + /** Constant for a keyboard report modifier byte, indicating that the keyboard's right alt key is currently pressed. */ + #define HID_KEYBOARD_MODIFER_RIGHTALT (1 << 6) + + /** Constant for a keyboard report modifier byte, indicating that the keyboard's right GUI key is currently pressed. */ + #define HID_KEYBOARD_MODIFER_RIGHTGUI (1 << 7) + + /** Constant for a keyboard output report LED byte, indicating that the host's NUM LOCK mode is currently set. */ + #define HID_KEYBOARD_LED_NUMLOCK (1 << 0) + + /** Constant for a keyboard output report LED byte, indicating that the host's CAPS LOCK mode is currently set. */ + #define HID_KEYBOARD_LED_CAPSLOCK (1 << 1) + + /** Constant for a keyboard output report LED byte, indicating that the host's SCROLL 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 KATANA mode is currently set. */ + #define HID_KEYBOARD_LED_KATANA (1 << 3) /* Type Defines: */ /** Enum for the different types of HID reports. */ @@ -95,7 +145,9 @@ REPORT_ITEM_TYPE_Feature = 2, /**< Indicates that the item is a FEATURE report type. */ }; - /** Type define for the HID class specific HID descriptor, to describe the HID device's specifications. Refer to the HID + /** \brief HID Class Specific HID Descriptor. + * + * Type define for the HID class specific HID descriptor, to describe the HID device's specifications. Refer to the HID * specification for details on the structure elements. */ typedef struct @@ -111,7 +163,10 @@ uint16_t HIDReportLength; } USB_HID_Descriptor_t; - /** Type define for a standard Boot Protocol Mouse report */ + /** \brief Standard HID Boot Protocol Mouse Report. + * + * Type define for a standard Boot Protocol Mouse report + */ typedef struct { uint8_t Button; /**< Button mask for currently pressed buttons in the mouse */ @@ -119,10 +174,15 @@ int8_t Y; /**< Current delta Y movement on the mouse */ } USB_MouseReport_Data_t; - /** Type define for a standard Boot Protocol Keyboard report */ + /** \brief Standard HID Boot Protocol Keyboard Report. + * + * Type define for a standard Boot Protocol Keyboard report + */ typedef struct { - uint8_t Modifier; /**< Keyboard modifier byte, indicating pressed modifier keys (such as Shift, Control, etc.) */ + uint8_t Modifier; /**< Keyboard modifier byte, indicating pressed modifier keys (a combination of + * HID_KEYBOARD_MODIFER_* masks) + */ uint8_t Reserved; /**< Reserved for OEM use, always set to 0 */ uint8_t KeyCode[6]; /**< Key codes of the currently pressed keys */ } USB_KeyboardReport_Data_t;