LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
HID Report Descriptor Item Constants

HID Input, Output and Feature Report Descriptor Item Flags

#define HID_IOF_CONSTANT   (1 << 0)
 
#define HID_IOF_DATA   (0 << 0)
 
#define HID_IOF_VARIABLE   (1 << 1)
 
#define HID_IOF_ARRAY   (0 << 1)
 
#define HID_IOF_RELATIVE   (1 << 2)
 
#define HID_IOF_ABSOLUTE   (0 << 2)
 
#define HID_IOF_WRAP   (1 << 3)
 
#define HID_IOF_NO_WRAP   (0 << 3)
 
#define HID_IOF_NON_LINEAR   (1 << 4)
 
#define HID_IOF_LINEAR   (0 << 4)
 
#define HID_IOF_NO_PREFERRED_STATE   (1 << 5)
 
#define HID_IOF_PREFERRED_STATE   (0 << 5)
 
#define HID_IOF_NULLSTATE   (1 << 6)
 
#define HID_IOF_NO_NULL_POSITION   (0 << 6)
 
#define HID_IOF_VOLATILE   (1 << 7)
 
#define HID_IOF_NON_VOLATILE   (0 << 7)
 
#define HID_IOF_BUFFERED_BYTES   (1 << 8)
 
#define HID_IOF_BITFIELD   (0 << 8)
 

HID Report Descriptor Item Macros

#define HID_RI_INPUT(DataBits,...)   _HID_RI_ENTRY(HID_RI_TYPE_MAIN , 0x80, DataBits, __VA_ARGS__)
 
#define HID_RI_OUTPUT(DataBits,...)   _HID_RI_ENTRY(HID_RI_TYPE_MAIN , 0x90, DataBits, __VA_ARGS__)
 
#define HID_RI_COLLECTION(DataBits,...)   _HID_RI_ENTRY(HID_RI_TYPE_MAIN , 0xA0, DataBits, __VA_ARGS__)
 
#define HID_RI_FEATURE(DataBits,...)   _HID_RI_ENTRY(HID_RI_TYPE_MAIN , 0xB0, DataBits, __VA_ARGS__)
 
#define HID_RI_END_COLLECTION(DataBits,...)   _HID_RI_ENTRY(HID_RI_TYPE_MAIN , 0xC0, DataBits, __VA_ARGS__)
 
#define HID_RI_USAGE_PAGE(DataBits,...)   _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x00, DataBits, __VA_ARGS__)
 
#define HID_RI_LOGICAL_MINIMUM(DataBits,...)   _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x10, DataBits, __VA_ARGS__)
 
#define HID_RI_LOGICAL_MAXIMUM(DataBits,...)   _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x20, DataBits, __VA_ARGS__)
 
#define HID_RI_PHYSICAL_MINIMUM(DataBits,...)   _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x30, DataBits, __VA_ARGS__)
 
#define HID_RI_PHYSICAL_MAXIMUM(DataBits,...)   _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x40, DataBits, __VA_ARGS__)
 
#define HID_RI_UNIT_EXPONENT(DataBits,...)   _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x50, DataBits, __VA_ARGS__)
 
#define HID_RI_UNIT(DataBits,...)   _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x60, DataBits, __VA_ARGS__)
 
#define HID_RI_REPORT_SIZE(DataBits,...)   _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x70, DataBits, __VA_ARGS__)
 
#define HID_RI_REPORT_ID(DataBits,...)   _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x80, DataBits, __VA_ARGS__)
 
#define HID_RI_REPORT_COUNT(DataBits,...)   _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x90, DataBits, __VA_ARGS__)
 
#define HID_RI_PUSH(DataBits,...)   _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0xA0, DataBits, __VA_ARGS__)
 
#define HID_RI_POP(DataBits,...)   _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0xB0, DataBits, __VA_ARGS__)
 
#define HID_RI_USAGE(DataBits,...)   _HID_RI_ENTRY(HID_RI_TYPE_LOCAL , 0x00, DataBits, __VA_ARGS__)
 
#define HID_RI_USAGE_MINIMUM(DataBits,...)   _HID_RI_ENTRY(HID_RI_TYPE_LOCAL , 0x10, DataBits, __VA_ARGS__)
 
#define HID_RI_USAGE_MAXIMUM(DataBits,...)   _HID_RI_ENTRY(HID_RI_TYPE_LOCAL , 0x20, DataBits, __VA_ARGS__)
 

Detailed Description

General HID constant definitions for HID Report Descriptor elements.

Macro Definition Documentation

#define HID_IOF_ABSOLUTE   (0 << 2)

Definition at line 80 of file HIDReportData.h.

#define HID_IOF_ARRAY   (0 << 1)

Definition at line 78 of file HIDReportData.h.

#define HID_IOF_BITFIELD   (0 << 8)

Definition at line 92 of file HIDReportData.h.

#define HID_IOF_BUFFERED_BYTES   (1 << 8)

Definition at line 91 of file HIDReportData.h.

#define HID_IOF_CONSTANT   (1 << 0)

Definition at line 75 of file HIDReportData.h.

#define HID_IOF_DATA   (0 << 0)

Definition at line 76 of file HIDReportData.h.

#define HID_IOF_LINEAR   (0 << 4)

Definition at line 84 of file HIDReportData.h.

#define HID_IOF_NO_NULL_POSITION   (0 << 6)

Definition at line 88 of file HIDReportData.h.

#define HID_IOF_NO_PREFERRED_STATE   (1 << 5)

Definition at line 85 of file HIDReportData.h.

#define HID_IOF_NO_WRAP   (0 << 3)

Definition at line 82 of file HIDReportData.h.

#define HID_IOF_NON_LINEAR   (1 << 4)

Definition at line 83 of file HIDReportData.h.

#define HID_IOF_NON_VOLATILE   (0 << 7)

Definition at line 90 of file HIDReportData.h.

#define HID_IOF_NULLSTATE   (1 << 6)

Definition at line 87 of file HIDReportData.h.

#define HID_IOF_PREFERRED_STATE   (0 << 5)

Definition at line 86 of file HIDReportData.h.

#define HID_IOF_RELATIVE   (1 << 2)

Definition at line 79 of file HIDReportData.h.

#define HID_IOF_VARIABLE   (1 << 1)

Definition at line 77 of file HIDReportData.h.

#define HID_IOF_VOLATILE   (1 << 7)

Definition at line 89 of file HIDReportData.h.

#define HID_IOF_WRAP   (1 << 3)

Definition at line 81 of file HIDReportData.h.

#define HID_RI_COLLECTION (   DataBits,
  ... 
)    _HID_RI_ENTRY(HID_RI_TYPE_MAIN , 0xA0, DataBits, __VA_ARGS__)

Definition at line 99 of file HIDReportData.h.

#define HID_RI_END_COLLECTION (   DataBits,
  ... 
)    _HID_RI_ENTRY(HID_RI_TYPE_MAIN , 0xC0, DataBits, __VA_ARGS__)

Definition at line 101 of file HIDReportData.h.

#define HID_RI_FEATURE (   DataBits,
  ... 
)    _HID_RI_ENTRY(HID_RI_TYPE_MAIN , 0xB0, DataBits, __VA_ARGS__)

Definition at line 100 of file HIDReportData.h.

#define HID_RI_INPUT (   DataBits,
  ... 
)    _HID_RI_ENTRY(HID_RI_TYPE_MAIN , 0x80, DataBits, __VA_ARGS__)

Definition at line 97 of file HIDReportData.h.

#define HID_RI_LOGICAL_MAXIMUM (   DataBits,
  ... 
)    _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x20, DataBits, __VA_ARGS__)

Definition at line 104 of file HIDReportData.h.

#define HID_RI_LOGICAL_MINIMUM (   DataBits,
  ... 
)    _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x10, DataBits, __VA_ARGS__)

Definition at line 103 of file HIDReportData.h.

#define HID_RI_OUTPUT (   DataBits,
  ... 
)    _HID_RI_ENTRY(HID_RI_TYPE_MAIN , 0x90, DataBits, __VA_ARGS__)

Definition at line 98 of file HIDReportData.h.

#define HID_RI_PHYSICAL_MAXIMUM (   DataBits,
  ... 
)    _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x40, DataBits, __VA_ARGS__)

Definition at line 106 of file HIDReportData.h.

#define HID_RI_PHYSICAL_MINIMUM (   DataBits,
  ... 
)    _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x30, DataBits, __VA_ARGS__)

Definition at line 105 of file HIDReportData.h.

#define HID_RI_POP (   DataBits,
  ... 
)    _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0xB0, DataBits, __VA_ARGS__)

Definition at line 113 of file HIDReportData.h.

#define HID_RI_PUSH (   DataBits,
  ... 
)    _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0xA0, DataBits, __VA_ARGS__)

Definition at line 112 of file HIDReportData.h.

#define HID_RI_REPORT_COUNT (   DataBits,
  ... 
)    _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x90, DataBits, __VA_ARGS__)

Definition at line 111 of file HIDReportData.h.

#define HID_RI_REPORT_ID (   DataBits,
  ... 
)    _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x80, DataBits, __VA_ARGS__)

Definition at line 110 of file HIDReportData.h.

#define HID_RI_REPORT_SIZE (   DataBits,
  ... 
)    _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x70, DataBits, __VA_ARGS__)

Definition at line 109 of file HIDReportData.h.

#define HID_RI_UNIT (   DataBits,
  ... 
)    _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x60, DataBits, __VA_ARGS__)

Definition at line 108 of file HIDReportData.h.

#define HID_RI_UNIT_EXPONENT (   DataBits,
  ... 
)    _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x50, DataBits, __VA_ARGS__)

Definition at line 107 of file HIDReportData.h.

#define HID_RI_USAGE (   DataBits,
  ... 
)    _HID_RI_ENTRY(HID_RI_TYPE_LOCAL , 0x00, DataBits, __VA_ARGS__)

Definition at line 114 of file HIDReportData.h.

#define HID_RI_USAGE_MAXIMUM (   DataBits,
  ... 
)    _HID_RI_ENTRY(HID_RI_TYPE_LOCAL , 0x20, DataBits, __VA_ARGS__)

Definition at line 116 of file HIDReportData.h.

#define HID_RI_USAGE_MINIMUM (   DataBits,
  ... 
)    _HID_RI_ENTRY(HID_RI_TYPE_LOCAL , 0x10, DataBits, __VA_ARGS__)

Definition at line 115 of file HIDReportData.h.

#define HID_RI_USAGE_PAGE (   DataBits,
  ... 
)    _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x00, DataBits, __VA_ARGS__)

Definition at line 102 of file HIDReportData.h.