USBMOUSE

Dependents:   ESD_Project_USBMouse

Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers USBHID_Types.h Source File

USBHID_Types.h

00001 
00002 
00003 #ifndef USBCLASS_HID_TYPES
00004 #define USBCLASS_HID_TYPES
00005 
00006 #include <stdint.h>
00007 
00008 /* */
00009 #define HID_VERSION_1_11    (0x0111)
00010 
00011 /* HID Class */
00012 #define HID_CLASS           (3)
00013 #define HID_SUBCLASS_NONE   (0)
00014 #define HID_PROTOCOL_NONE   (0)
00015 
00016 /* Descriptors */
00017 #define HID_DESCRIPTOR          (33)
00018 #define HID_DESCRIPTOR_LENGTH   (0x09)
00019 #define REPORT_DESCRIPTOR       (34)
00020 
00021 /* Class requests */
00022 #define GET_REPORT (0x1)
00023 #define GET_IDLE   (0x2)
00024 #define SET_REPORT (0x9)
00025 #define SET_IDLE   (0xa)
00026 
00027 /* HID Class Report Descriptor */
00028 /* Short items: size is 0, 1, 2 or 3 specifying 0, 1, 2 or 4 (four) bytes */
00029 /* of data as per HID Class standard */
00030 
00031 /* Main items */
00032 #define INPUT(size)             (0x80 | size)
00033 #define OUTPUT(size)            (0x90 | size)
00034 #define FEATURE(size)           (0xb0 | size)
00035 #define COLLECTION(size)        (0xa0 | size)
00036 #define END_COLLECTION(size)    (0xc0 | size)
00037 
00038 /* Global items */
00039 #define USAGE_PAGE(size)        (0x04 | size)
00040 #define LOGICAL_MINIMUM(size)   (0x14 | size)
00041 #define LOGICAL_MAXIMUM(size)   (0x24 | size)
00042 #define PHYSICAL_MINIMUM(size)  (0x34 | size)
00043 #define PHYSICAL_MAXIMUM(size)  (0x44 | size)
00044 #define UNIT_EXPONENT(size)     (0x54 | size)
00045 #define UNIT(size)              (0x64 | size)
00046 #define REPORT_SIZE(size)       (0x74 | size)
00047 #define REPORT_ID(size)         (0x84 | size)
00048 #define REPORT_COUNT(size)      (0x94 | size)
00049 #define PUSH(size)              (0xa4 | size)
00050 #define POP(size)               (0xb4 | size)
00051 
00052 /* Local items */
00053 #define USAGE(size)                 (0x08 | size)
00054 #define USAGE_MINIMUM(size)         (0x18 | size)
00055 #define USAGE_MAXIMUM(size)         (0x28 | size)
00056 #define DESIGNATOR_INDEX(size)      (0x38 | size)
00057 #define DESIGNATOR_MINIMUM(size)    (0x48 | size)
00058 #define DESIGNATOR_MAXIMUM(size)    (0x58 | size)
00059 #define STRING_INDEX(size)          (0x78 | size)
00060 #define STRING_MINIMUM(size)        (0x88 | size)
00061 #define STRING_MAXIMUM(size)        (0x98 | size)
00062 #define DELIMITER(size)             (0xa8 | size)
00063 
00064 /* HID Report */
00065 /* Where report IDs are used the first byte of 'data' will be the */
00066 /* report ID and 'length' will include this report ID byte. */
00067 
00068 #define MAX_HID_REPORT_SIZE (64)
00069 
00070 typedef struct {
00071     uint32_t length;
00072     uint8_t data[MAX_HID_REPORT_SIZE];
00073 } HID_REPORT;
00074 
00075 #endif