Add info from HID and HuT specs

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3247 42af7a65-404d-4744-a932-0658087f49c3

1 files changed, 362 insertions, 12 deletions

diff --git a/nuttx/include/nuttx/usb/hid.h b/nuttx/include/nuttx/usb/hid.h
index 9fcf2b3ee..dedd13fc8 100755
--- a/nuttx/include/nuttx/usb/hid.h
+++ b/nuttx/include/nuttx/usb/hid.h
@@ -5,8 +5,12 @@
  *   Author: Gregory Nutt <spudmonkey@racsa.co.cr>
  *
  * References:
- *   Universal Serial Bus (USB), Device Class Definition for Human Interface
- *   Devices (HID), Firmware Specification—6/27/01, Version 1.11.
+ *   HID Universal Serial Bus (USB), Device Class Definition for Human
+ *       Interface Devices (HID), Firmware Specification—6/27/01, Version
+ *       1.11.
+ *
+ *   HuT Universal Serial Bus (USB), HID Usage Tables, 10/28/2004, Version
+ *       1.12
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
@@ -45,26 +49,83 @@
  ****************************************************************************/
 
 #include <nuttx/config.h>
+#include <nuttx/usb/usb.h>
 
 /****************************************************************************
  * Preprocessor definitions
  ****************************************************************************/
 
 /* Subclass and Protocol ****************************************************/
-/* Subclass codes (4.2) */
+/* Subclass codes (HID 4.2) */
 
 #define USBHID_SUBCLASS_NONE       0 /* No subclass */
 #define USBHID_SUBCLASS_BOOTIF     1 /* Boot Interface Subclass */
 
 /* A variety of protocols are supported HID devices. The protocol member of
  * an Interface descriptor only has meaning if the subclass member declares
- * that the device supports a boot interface, otherwise it is 0. (4.3)
+ * that the device supports a boot interface, otherwise it is 0. (HID 4.3)
  */
 
 #define USBHID_PROTOCOL_NONE       0
 #define USBHID_PROTOCOL_KEYBOARD   1
 #define USBHID_PROTOCOL_MOUSE      2
 
+/* Descriptor Requests ******************************************************/
+/* "When a Get_Descriptor(Configuration) request is issued, it returns the
+ *  Configuration descriptor, all Interface descriptors, all Endpoint
+ * descriptors, and the HID descriptor for each interface."
+ */
+
+/* Standard Requests (HID 7.1)
+ * GET_DESCRIPTOR (HID 7.1.1):
+ *
+ *   bmRequestType (USB_REQ_DIR_IN | USB_REQ_TYPE_STANDARD | USB_REQ_RECIPIENT_INTERFACE)
+ *   bRequest      (USB_REQ_GETDESCRIPTOR)
+ *   wValue        Descriptor Type (MS) and Descriptor Index (LS)
+ *   wIndex        Interface Number
+ *   wLength       Descriptor Length
+ *   Data          Descriptor
+ *
+ * SET_DESCRIPTOR (HID 7.1.2):
+ *
+ *   bmRequestType (USB_REQ_TYPE_STANDARD | USB_REQ_RECIPIENT_INTERFACE)
+ *   bRequest      (USB_REQ_SETDESCRIPTOR)
+ *   wValue        Descriptor Type (MS) and Descriptor Index (LS)
+ *   wIndex        Interface Number
+ *   wLength       Descriptor Length
+ *   Data          Descriptor
+ */
+
+/* Class Descriptor Types (HID 7.1) */
+
+#define USBHID_DESCTYPE_HID       0x21 /* HID */
+#define USBHID_DESCTYPE_REPORT    0x22 /* Report */
+#define USBHID_DESCTYPE_PHYSICAL  0x23 /* Physical descriptor */
+
+/* Class-specific requests (HID 7.2)
+ *
+ *   bmRequestType (                 USB_REQ_TYPE_CLASS | USB_REQ_RECIPIENT_INTERFACE) -or- 
+ *                 (USB_REQ_DIR_IN | USB_REQ_TYPE_CLASS | USB_REQ_RECIPIENT_INTERFACE)
+ *   bRequest      Class-specific request
+ *   wValue        Varies according to request
+ *   wIndex        Varies according to request
+ *   wLength       Number of bytes to transfer in the data phase
+ *   Data          Data
+ */
+ 
+#define USBHID_REQUEST_GETREPORT    0x01
+#define USBHID_REQUEST_GETIDLE      0x02
+#define USBHID_REQUEST_GET_PROTOCOL 0x03
+#define USBHID_REQUEST_SET_REPORT   0x09
+#define USBHID_REQUEST_SET_IDLE     0x0a
+#define USBHID_REQUEST_SET_PROTOCOL 0x0b
+
+/* Report Type (MS byte of wValue for GET_REPORT) (HID 7.2.1) */
+
+#define USBHID_REPORTTYPE_INPUT     0x01 
+#define USBHID_REPORTTYPE_OUTPUT    0x02 
+#define USBHID_REPORTTYPE_FEATURE   0x03 
+
 /* HID Descriptor ***********************************************************/
 
 #define USBHID_COUNTRY_NONE        0x00 /* Not Supported */
@@ -104,7 +165,7 @@
 #define USBHID_COUNTRY_YUGOSLAVIA  0x34 /* Yugoslavia */
 #define USBHID_COUNTRY_TURKISHF    0x35 /* Turkish-F */
 
-/* Main Items (6.2.2.4) */
+/* Main Items (HID 6.2.2.4) */
 
 #define USBHID_MAIN_SIZE(pfx)             ((pfx) & 3)
 #define USBHID_MAIN_INPUT_PREFIX          0x80
@@ -150,26 +211,315 @@
 
 #define USBHID_MAIN_ENDCOLLECTION_PREFIX  0xc0
 
-/* Global Items (6.2.2.7) */
+/* Global Items (HID 6.2.2.7) */
 
 #define USBHID_GLOBAL_SIZE(pfx)           ((pfx) & 3)
 #define USBHID_GLOBAL_USAGEPAGE_PREFIX    0x04 /* Usage Page */
-#define USBHID_GLOBAL_LOGMINIMUM_PREFIX   0x14 /* Logical Minimum */
-#define USBHID_GLOBAL_LOGMAXIMUM_PREFIX   0x24 /* Logical Maximum */
-#define USBHID_GLOBAL_PHYSMINIMUM_PREFIX  0x34 /* Physical Minimum */
-#define USBHID_GLOBAL_PHYSMAXIMUM_PREFIX  0x44 /* Physical Maximum */
+#define USBHID_GLOBAL_LOGICALMIN_PREFIX   0x14 /* Logical Minimum */
+#define USBHID_GLOBAL_LOGICALMAX_PREFIX   0x24 /* Logical Maximum */
+#define USBHID_GLOBAL_PHYSICALMIN_PREFIX  0x34 /* Physical Minimum */
+#define USBHID_GLOBAL_PHYSMICALAX_PREFIX  0x44 /* Physical Maximum */
 #define USBHID_GLOBAL_UNITEXP_PREFIX      0x54 /* Unit Exponent */
 #define USBHID_GLOBAL_UNIT_PREFIX         0x64 /* Unit */
 #define USBHID_GLOBAL_REPORTSIZE_PREFIX   0x74 /* Report Size */
-#define USBHID_GLOBAL_REPORTID_PREFIX     0x84 /*Report ID */
+#define USBHID_GLOBAL_REPORTID_PREFIX     0x84 /* Report ID */
 #define USBHID_GLOBAL_REPORTCOUNT_PREFIX  0x94 /* Report Count */
 #define USBHID_GLOBAL_PUSH_PREFIX         0xa4 /* Push */
-#define USBHID_GLOBAL_Pop_PREFIX          0xb4 /* Pop */
+#define USBHID_GLOBAL_POP_PREFIX          0xb4 /* Pop */
+
+/* Local Items (HID 6.2.2.8) */
+
+#define USBHID_LOCAL_SIZE(pfx)            ((pfx) & 3)
+#define USBHID_LOCAL_USAGE                0x08 /* Usage */
+#define USBHID_LOCAL_USAGEMIN             0x18 /* Usage Minimum */
+#define USBHID_LOCAL_USAGEMAX             0x28 /* Usage Maximum */
+#define USBHID_LOCAL_DESIGNATORIDX        0x38 /* Designator Index  */
+#define USBHID_LOCAL_DESIGNATORMIN        0x48 /* Designator Minimum */
+#define USBHID_LOCAL_DESIGNATORMAX        0x58 /* Designator Maximum */
+#define USBHID_LOCAL_STRINGIDX            0x78 /* String Index */
+#define USBHID_LOCAL_STRINGMIN            0x88 /* String Minimum */
+#define USBHID_LOCAL_STRINGMAX            0x98 /* xx */
+#define USBHID_LOCAL_DELIMITER            0xa8 /*Delimiter */
+
+/* Modifier Keys (HID 8.3) */
+
+#define USBHID_MODIFER_LCTRL              (1 << 0) /* Left Ctrl */
+#define USBHID_MODIFER_LSHIFT             (1 << 1) /* Left Shift */
+#define USBHID_MODIFER_LALT               (1 << 2) /* Left Alt */
+#define USBHID_MODIFER_LGUI               (1 << 3) /* Left GUI */
+#define USBHID_MODIFER_RCTRL              (1 << 4) /* Right Ctrl */
+#define USBHID_MODIFER_RSHIFT             (1 << 5) /* Right Shift */
+#define USBHID_MODIFER_RALT               (1 << 6) /* Right Alt */
+#define USBHID_MODIFER_RGUI               (1 << 7) /* Right GUI */
+
+/* Keyboard output report (1 byte) (HID B.1) */
+
+#define USBHID_KBDOUT_NUMLOCK             (1 << 0)
+#define USBHID_KBDOUT_CAPSLOCK            (1 << 1)
+#define USBHID_KBDOUT_SCROLLLOCK          (1 << 2)
+#define USBHID_KBDOUT_COMPOSE             (1 << 3)
+#define USBHID_KBDOUT_KANA                (1 << 4)
+
+/* Keyboard usage IDs (HuT 10) */
+
+#define USBHID_KBDUSE_NONE                0x00 /* Reserved (no event indicated) */
+#define USBHID_KBDUSE_ERRORROLLOVER       0x01 /* Keyboard ErrorRollOver */
+#define USBHID_KBDUSE_POSTFAIL            0x02 /* Keyboard POSTFail */
+#define USBHID_KBDUSE_ERRUNDEF            0x03 /* Keyboard ErrorUndefined */
+#define USBHID_KBDUSE_A                   0x04 /* Keyboard a or A (B-Z follow) */
+#define USBHID_KBDUSE_1                   0x1e /* Keyboard 1 (2-9 follow) */
+#define USBHID_KBDUSE_EXCLAM              0x1e /* Keyboard 1 and ! */
+#define USBHID_KBDUSE_AT                  0x1f /* Keyboard 2 and @ */
+#define USBHID_KBDUSE_POUND               0x20 /* Keyboard 3 and # */
+#define USBHID_KBDUSE_DOLLAR              0x21 /* Keyboard 4 and $ */
+#define USBHID_KBDUSE_PERCENT             0x22 /* Keyboard 5 and % */
+#define USBHID_KBDUSE_CARAT               0x23 /* Keyboard 6 and ^ */
+#define USBHID_KBDUSE_AMPERSAND           0x24 /* Keyboard 7 and & */
+#define USBHID_KBDUSE_ASTERISK            0x25 /* Keyboard 8 and * */
+#define USBHID_KBDUSE_LPAREN              0x26 /* Keyboard 9 and ( */
+#define USBHID_KBDUSE_0                   0x27 /* Keyboard 0 and ) */
+#define USBHID_KBDUSE_RPAREN              0x27 /* Keyboard 0 and ) */
+#define USBHID_KBDUSE_ENTER               0x28 /* Keyboard Return (ENTER) */
+#define USBHID_KBDUSE_ESCAPE              0x29 /* Keyboard ESCAPE */
+#define USBHID_KBDUSE_DELETE              0x2a /* Keyboard DELETE (Backspace) */
+#define USBHID_KBDUSE_TAB                 0x2b /* Keyboard Tab */
+#define USBHID_KBDUSE_SPACE               0x2c /* Keyboard Spacebar */
+#define USBHID_KBDUSE_HYPHEN              0x2d /* Keyboard - and (underscore) */
+#define USBHID_KBDUSE_UNDERSCORE          0x2d /* Keyboard - and (underscore) */
+#define USBHID_KBDUSE_EQUAL               0x2e /* Keyboard = and + */
+#define USBHID_KBDUSE_PLUS                0x2e /* Keyboard = and + */
+#define USBHID_KBDUSE_LBRACKET            0x2f /* Keyboard [ and { */
+#define USBHID_KBDUSE_LBRACE              0x2f /* Keyboard [ and { */
+#define USBHID_KBDUSE_RBRACKET            0x30 /* Keyboard ] and } */
+#define USBHID_KBDUSE_RBRACE              0x30 /* Keyboard ] and } */
+#define USBHID_KBDUSE_BSLASH              0x31 /* Keyboard \ and | */
+#define USBHID_KBDUSE_VERTBAR             0x31 /* Keyboard \ and | */
+#define USBHID_KBDUSE_NONUSPOUND          0x32 /* Keyboard Non-US # and ~ */
+#define USBHID_KBDUSE_TILDE               0x32 /* Keyboard Non-US # and ~ */
+#define USBHID_KBDUSE_SEMICOLON           0x33 /* Keyboard ; and : */
+#define USBHID_KBDUSE_COLON               0x33 /* Keyboard ; and : */
+#define USBHID_KBDUSE_SQUOTE              0x34 /* Keyboard ‘ and “ */
+#define USBHID_KBDUSE_DQUOUTE             0x34 /* Keyboard ‘ and “ */
+#define USBHID_KBDUSE_GACCENT             0x35 /* Keyboard Grave Accent and Tilde */
+#define USBHID_KBDUSE_GTILDE              0x35 /* Keyboard Grave Accent and Tilde */
+#define USBHID_KBDUSE_COMMON              0x36 /* Keyboard , and < */
+#define USBHID_KBDUSE_LT                  0x36 /* Keyboard , and < */
+#define USBHID_KBDUSE_PERIOD              0x37 /* Keyboard . and > */
+#define USBHID_KBDUSE_GT                  0x37 /* Keyboard . and > */
+#define USBHID_KBDUSE_DIV                 0x38 /* Keyboard / and ? */
+#define USBHID_KBDUSE_QUESTION            0x38 /* Keyboard / and ? */
+#define USBHID_KBDUSE_CAPSLOCK            0x39 /* Keyboard Caps Lock */
+#define USBHID_KBDUSE_F1                  0x3a /* Keyboard F1 */
+#define USBHID_KBDUSE_F2                  0x3b /* Keyboard F2 */
+#define USBHID_KBDUSE_F3                  0x3c /* Keyboard F3 */
+#define USBHID_KBDUSE_F4                  0x3d /* Keyboard F4 */
+#define USBHID_KBDUSE_F5                  0x3e /* Keyboard F5 */
+#define USBHID_KBDUSE_F6                  0x3f /* Keyboard F6 */
+#define USBHID_KBDUSE_F7                  0x40 /* Keyboard F7 */
+#define USBHID_KBDUSE_F8                  0x41 /* Keyboard F8 */
+#define USBHID_KBDUSE_F9                  0x42 /* Keyboard F9 */
+#define USBHID_KBDUSE_F10                 0x43 /* Keyboard F10 */
+#define USBHID_KBDUSE_F11                 0x44 /* Keyboard F11 */
+#define USBHID_KBDUSE_F12                 0x45 /* Keyboard F12 */
+#define USBHID_KBDUSE_PRINTSCN            0x46 /* Keyboard PrintScreen */
+#define USBHID_KBDUSE_SCROLLLOCK          0x47 /* Keyboard Scroll Lock */
+#define USBHID_KBDUSE_PAUSE               0x48 /* Keyboard Pause */
+#define USBHID_KBDUSE_INSERT              0x49 /* Keyboard Insert */
+#define USBHID_KBDUSE_HOME                0x4a /* Keyboard Home */
+#define USBHID_KBDUSE_PAGEUP              0x4b /* Keyboard PageUp */
+#define USBHID_KBDUSE_DELFWD              0x4c /* Keyboard Delete Forward */
+#define USBHID_KBDUSE_END                 0x4d /* Keyboard End */
+#define USBHID_KBDUSE_PAGEDOWN            0x4e /* Keyboard PageDown */
+#define USBHID_KBDUSE_RIGHT               0x4f /* eyboard RightArrow */
+#define USBHID_KBDUSE_LEFT                0x50 /* Keyboard LeftArrow */
+#define USBHID_KBDUSE_DOWN                0x5a /* Keyboard DownArrow */
+#define USBHID_KBDUSE_UP                  0x52 /* Keyboard UpArrow */
+#define USBHID_KBDUSE_KPDNUMLOCK          0x53 /* Keypad Num Lock and Clear */
+#define USBHID_KBDUSE_KPDCLEAR            0x53 /* Keypad Num Lock and Clear */
+#define USBHID_KBDUSE_KPDDIV              0x54 /* Keypad / */
+#define USBHID_KBDUSE_KPDMUL              0x55 /* Keypad * */
+#define USBHID_KBDUSE_KPDHMINUS           0x56 /* Keypad - */
+#define USBHID_KBDUSE_KPDPLUS             0x57 /* Keypad + */
+#define USBHID_KBDUSE_KPDEMTER            0x58 /* Keypad ENTER */
+#define USBHID_KBDUSE_KPD1                0x59 /* Keypad 1 (2-9 follow) */
+#define USBHID_KBDUSE_KPDEND              0x59 /* Keypad 1 and End */
+#define USBHID_KBDUSE_KPDDOWN             0x5a /* Keypad 2 and Down Arrow */
+#define USBHID_KBDUSE_KPDPAGEDN           0x5b /* Keypad 3 and PageDn */
+#define USBHID_KBDUSE_KPDLEFT             0x5c /* Keypad 4 and Left Arrow */
+#define USBHID_KBDUSE_KPDRIGHT            0x5e /* Keypad 6 and Right Arrow */
+#define USBHID_KBDUSE_KPDHOME             0x5f /* Keypad 7 and Home */
+#define USBHID_KBDUSE_KPDUP               0x60 /* Keypad 8 and Up Arrow */
+#define USBHID_KBDUSE_KPDPAGEUP           0x61 /* Keypad 9 and PageUp */
+#define USBHID_KBDUSE_KPD0                0x62 /* Keypad 0 and Insert */
+#define USBHID_KBDUSE_KPDINSERT           0x62 /* Keypad 0 and Insert */
+#define USBHID_KBDUSE_KPDDECIMALPT        0x63 /* Keypad . and Delete */
+#define USBHID_KBDUSE_KPDDELETE           0x63 /* Keypad . and Delete */
+#define USBHID_KBDUSE_NONUSBSLASH         0x64 /* Keyboard Non-US \ and | */
+#define USBHID_KBDUSE_NONUSVERT           0x64 /* Keyboard Non-US \ and | */
+#define USBHID_KBDUSE_APPLICATION         0x65 /* Keyboard Application */
+#define USBHID_KBDUSE_POWER               0x66 /* Keyboard Power */
+#define USBHID_KBDUSE_KPDEQUAL            0x67 /* Keypad = */
+#define USBHID_KBDUSE_F13                 0x68 /* Keyboard F13 */
+#define USBHID_KBDUSE_F14                 0x69 /* Keyboard F14 */
+#define USBHID_KBDUSE_F15                 0x6a /* Keyboard F15 */
+#define USBHID_KBDUSE_F16                 0x6b /* Keyboard F16 */
+#define USBHID_KBDUSE_F17                 0x6c /* Keyboard F17 */
+#define USBHID_KBDUSE_F18                 0x6d /* Keyboard F18 */
+#define USBHID_KBDUSE_F19                 0x6e /* Keyboard F19 */
+#define USBHID_KBDUSE_F20                 0x6f /* Keyboard F20 */
+#define USBHID_KBDUSE_F21                 0x70 /* Keyboard F21 */
+#define USBHID_KBDUSE_F22                 0x71 /* Keyboard F22 */
+#define USBHID_KBDUSE_F23                 0x72 /* Keyboard F23 */
+#define USBHID_KBDUSE_F24                 0x73 /* Keyboard F24 */
+#define USBHID_KBDUSE_EXECUTE             0x74 /* Keyboard Execute */
+#define USBHID_KBDUSE_HELP                0x75 /* Keyboard Help */
+#define USBHID_KBDUSE_MENU                0x76 /* Keyboard Menu */
+#define USBHID_KBDUSE_SELECT              0x77 /* Keyboard Select */
+#define USBHID_KBDUSE_STOP                0x78 /* Keyboard Stop */
+#define USBHID_KBDUSE_AGAIN               0x79 /* Keyboard Again */
+#define USBHID_KBDUSE_UNDO                0x7a /* Keyboard Undo */
+#define USBHID_KBDUSE_CUT                 0x7b /* Keyboard Cut */
+#define USBHID_KBDUSE_COPY                0x7c /* Keyboard Copy */
+#define USBHID_KBDUSE_PASTE               0x7d /* Keyboard Paste */
+#define USBHID_KBDUSE_FIND                0x7e /* Keyboard Find */
+#define USBHID_KBDUSE_MUTE                0x7f /* Keyboard Mute */
+#define USBHID_KBDUSE_VOLUP               0x80 /* Keyboard Volume Up */
+#define USBHID_KBDUSE_VOLDOWN             0x81 /* Keyboard Volume Down */
+#define USBHID_KBDUSE_LCAPSLOCK           0x82 /* Keyboard Locking Caps Lock */
+#define USBHID_KBDUSE_LNUMLOCK            0x83 /* Keyboard Locking Num Lock */
+#define USBHID_KBDUSE_LSCROLLLOCK         0x84 /* Keyboard Locking Scroll Lock */
+#define USBHID_KBDUSE_KPDCOMMA            0x85 /* Keypad Comma */
+#define USBHID_KBDUSE_KPDEQUALSIGN        0x86 /* Keypad Equal Sign */
+#define USBHID_KBDUSE_INTERNATIONAL1      0x87 /* Keyboard International 1 */
+#define USBHID_KBDUSE_INTERNATIONAL2      0x88 /* Keyboard International 2 */
+#define USBHID_KBDUSE_INTERNATIONAL3      0x89 /* Keyboard International 3 */
+#define USBHID_KBDUSE_INTERNATIONAL4      0x8a /* Keyboard International 4 */
+#define USBHID_KBDUSE_INTERNATIONAL5      0x8b /* Keyboard International 5 */
+#define USBHID_KBDUSE_INTERNATIONAL6      0x8c /* Keyboard International 6 */
+#define USBHID_KBDUSE_INTERNATIONAL7      0x8d /* Keyboard International 7 */
+#define USBHID_KBDUSE_INTERNATIONAL8      0x8e /* Keyboard International 8 */
+#define USBHID_KBDUSE_INTERNATIONAL9      0x8f /* Keyboard International 9 */
+#define USBHID_KBDUSE_LANG1               0x90 /* Keyboard LANG1 */
+#define USBHID_KBDUSE_LANG2               0x91 /* Keyboard LANG2 */
+#define USBHID_KBDUSE_LANG3               0x92 /* Keyboard LANG3 */
+#define USBHID_KBDUSE_LANG4               0x93 /* Keyboard LANG4 */
+#define USBHID_KBDUSE_LANG5               0x94 /* Keyboard LANG5 */
+#define USBHID_KBDUSE_LANG6               0x95 /* Keyboard LANG6 */
+#define USBHID_KBDUSE_LANG7               0x96 /* Keyboard LANG7 */
+#define USBHID_KBDUSE_LANG8               0x97 /* Keyboard LANG8 */
+#define USBHID_KBDUSE_LANG9               0x98 /* Keyboard LANG9 */
+#define USBHID_KBDUSE_ALTERASE            0x99 /* Keyboard Alternate Erase */
+#define USBHID_KBDUSE_SYSREQ              0x9a /* Keyboard SysReq/Attention */
+#define USBHID_KBDUSE_CANCEL              0x9b /* Keyboard Cancel */
+#define USBHID_KBDUSE_CLEAR               0x9c /* Keyboard Clear */
+#define USBHID_KBDUSE_PRIOR               0x9d /* Keyboard Prior */
+#define USBHID_KBDUSE_RETURN              0x9e /* Keyboard Return */
+#define USBHID_KBDUSE_SEPARATRO           0x9f /* Keyboard Separator */
+#define USBHID_KBDUSE_OUT                 0xa0 /* Keyboard Out */
+#define USBHID_KBDUSE_OPER                0xa1 /* Keyboard Oper */
+#define USBHID_KBDUSE_CLEARAGAIN          0xa2 /* Keyboard Clear/Again */
+#define USBHID_KBDUSE_CLRSEL              0xa3 /* Keyboard CrSel/Props */
+#define USBHID_KBDUSE_EXSEL               0xa4 /* Keyboard ExSel */
+#define USBHID_KBDUSE_KPD00               0xb0 /* Keypad 00 */
+#define USBHID_KBDUSE_KPD000              0xb1 /* Keypad 000 */
+#define USBHID_KBDUSE_THOUSEPARATOR       0xb2 /* Thousands Separator */
+#define USBHID_KBDUSE_DECSEPARATOR        0xb3 /* Decimal Separator */
+#define USBHID_KBDUSE_CURRUNIT            0xb4 /* Currency Unit */
+#define USBHID_KBDUSE_CURRSUBUNIT         0xb5 /* Currency Sub-unit */
+#define USBHID_KBDUSE_KPDLPAREN           0xb6 /* Keypad ( */
+#define USBHID_KBDUSE_KPDRPAREN           0xb7 /* Keypad ) */
+#define USBHID_KBDUSE_KPDLBRACE           0xb8 /* Keypad { */
+#define USBHID_KBDUSE_KPDRBRACE           0xb9 /* Keypad } */
+#define USBHID_KBDUSE_KPDTAB              0xba /* Keypad Tab */
+#define USBHID_KBDUSE_KPDBACKSPACE        0xbb /* Keypad Backspace */
+#define USBHID_KBDUSE_KPDA                0xbc /* Keypad A (B-F follow) */
+#define USBHID_KBDUSE_KPDXOR              0xc2 /* Keypad XOR */
+#define USBHID_KBDUSE_KPDEXP              0xc3 /* Keypad ^ */
+#define USBHID_KBDUSE_KPDPERCENT          0xc4 /* Keypad % */
+#define USBHID_KBDUSE_KPDLT               0xc5 /* Keypad < */
+#define USBHID_KBDUSE_KPDGT               0xc6 /* Keypad > */
+#define USBHID_KBDUSE_KPDAMPERSAND        0xc7 /* Keypad & */
+#define USBHID_KBDUSE_KPDAND              0xc8 /* Keypad && */
+#define USBHID_KBDUSE_KPDVERT             0xc9 /* Keypad | */
+#define USBHID_KBDUSE_KPDOR               0xca /* Keypad || */
+#define USBHID_KBDUSE_KPDCOLON            0xcb /* Keypad : */
+#define USBHID_KBDUSE_KPDPOUND            0xcc /* Keypad # */
+#define USBHID_KBDUSE_KPDSPACE            0xcd /* Keypad Space */
+#define USBHID_KBDUSE_KPDAT               0xce /* Keypad @ */
+#define USBHID_KBDUSE_KPDEXCLAM           0xcf /* Keypad ! */
+#define USBHID_KBDUSE_KPDMEMSTORE         0xd0 /* Keypad Memory Store */
+#define USBHID_KBDUSE_KPDMEMRECALL        0xd1 /* Keypad Memory Recall */
+#define USBHID_KBDUSE_KPDMEMCLEAR         0xd2 /* Keypad Memory Clear */
+#define USBHID_KBDUSE_KPDMEMADD           0xd3 /* Keypad Memory Add */
+#define USBHID_KBDUSE_KPDMEMSUB           0xd4 /* Keypad Memory Subtract */
+#define USBHID_KBDUSE_KPDMEMADD           0xd5 /* Keypad Memory Multiply */
+#define USBHID_KBDUSE_KPDMEMDIV           0xd6 /* Keypad Memory Divide */
+#define USBHID_KBDUSE_KPDPLUSMINUS        0xd7 /* Keypad +/- */
+#define USBHID_KBDUSE_KPDCLEAR            0xd8 /* Keypad Clear */
+#define USBHID_KBDUSE_KPDCLEARENTRY       0xd9 /* Keypad Clear Entry */
+#define USBHID_KBDUSE_KPDBINARY           0xda /* Keypad Binary */
+#define USBHID_KBDUSE_KPDOCTAL            0xdb /* Keypad Octal */
+#define USBHID_KBDUSE_KPDDECIMAL          0xdc /* Keypad Decimal */
+#define USBHID_KBDUSE_KPDHEXADECIMAL      0xdd /* Keypad Hexadecimal */
+#define USBHID_KBDUSE_LCTRL               0xe0 /* Keyboard LeftControl */
+#define USBHID_KBDUSE_LSHIFT              0xe1 /* Keyboard LeftShift */
+#define USBHID_KBDUSE_LALT                0xe2 /* Keyboard LeftAlt */
+#define USBHID_KBDUSE_LGUI                0xe3 /* Keyboard Left GUI */
+#define USBHID_KBDUSE_RCTRL               0xe4 /* Keyboard RightControl */
+#define USBHID_KBDUSE_RSHIFT              0xe5 /* Keyboard RightShift */
+#define USBHID_KBDUSE_RALT                0xe6 /* Keyboard RightAlt */
+#define USBHID_KBDUSE_RGUI                0xe7 /* Keyboard Right GUI*/
+
+/* Mouse input report (HID B.2) */
+
+#define USBHID_MOUSEIN_BUTTON1            (1 << 0)
+#define USBHID_MOUSEIN_BUTTON2            (1 << 1)
+#define USBHID_MOUSEIN_BUTTON3            (1 << 2)
+
+/* Joystick input report (4 bytes) (HID D.1) */
+
+#define USBHID_JSIN_HATSWITCH_SHIFT       (0)
+#define USBHID_JSIN_HATSWITCH_MASK        (15 << USBHID_JSIN_HATSWITCH_SHIFT)
+#define USBHID_JSIN_BUTTON1               (1 << 4)
+#define USBHID_JSIN_BUTTON2               (1 << 5)
+#define USBHID_JSIN_BUTTON3               (1 << 6)
+#define USBHID_JSIN_BUTTON4               (1 << 7)
 
 /****************************************************************************
  * Public Types
  ****************************************************************************/
 
+/* Keyboard input report (8 bytes) (HID B.1) */
+
+struct usbhid_kbdreport_s
+{
+  uint8_t modifier;  /* Modifier keys. See USBHID_MODIFIER_* definitions */
+  uint8_t reserved;
+  uint8_t key[6];    /* Keycode 1-6 */
+};
+
+/* Keyboard output report (1 byte) (HID B.1), see USBHID_KBDOUT_* definitions */
+
+/* Mouse input report (HID B.2) */
+
+struct usbhid_mousereport_s
+{
+  uint8_t buttons;   /* See USBHID_MOUSEIN_* definitions */
+  uint8_t xdisp;     /* X displacement */
+  uint8_t ydisp;     /* y displacement */
+                     /* Device specific additional bytes may follow */
+};
+
+/* Joystick input report (1 bytes) (HID D.1) */
+
+struct usbhid_jsreport_s
+{
+  uint8_t xpos;      /* X position */
+  uint8_t ypos;      /* X position */
+  uint8_t buttons;   /* See USBHID_JSIN_* definitions */
+  uint8_t throttle;  /* Throttle */
+};
+
 /****************************************************************************
  * Public Function Prototypes
  ****************************************************************************/