LPCOpen Platform
LPCOpen Platform for NXP LPC Microcontrollers
Main Page
Related Pages
Modules
Data Structures
Files
File List
Globals
All
Data Structures
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Macros
Groups
Pages
HIDReportData.h
Go to the documentation of this file.
1
/*
2
* @brief Constants for HID report item attributes
3
*
4
* @note
5
* Copyright(C) NXP Semiconductors, 2012
6
* Copyright(C) Dean Camera, 2011, 2012
7
* All rights reserved.
8
*
9
* @par
10
* Software that is described herein is for illustrative purposes only
11
* which provides customers with programming information regarding the
12
* LPC products. This software is supplied "AS IS" without any warranties of
13
* any kind, and NXP Semiconductors and its licensor disclaim any and
14
* all warranties, express or implied, including all implied warranties of
15
* merchantability, fitness for a particular purpose and non-infringement of
16
* intellectual property rights. NXP Semiconductors assumes no responsibility
17
* or liability for the use of the software, conveys no license or rights under any
18
* patent, copyright, mask work right, or any other intellectual property rights in
19
* or to any products. NXP Semiconductors reserves the right to make changes
20
* in the software without notification. NXP Semiconductors also makes no
21
* representation or warranty that such application will be suitable for the
22
* specified use without further testing or modification.
23
*
24
* @par
25
* Permission to use, copy, modify, and distribute this software and its
26
* documentation is hereby granted, under NXP Semiconductors' and its
27
* licensor's relevant copyrights in the software, without fee, provided that it
28
* is used in conjunction with NXP Semiconductors microcontrollers. This
29
* copyright, permission, and disclaimer notice must appear in all copies of
30
* this code.
31
*/
32
41
#ifndef __HIDREPORTDATA_H__
42
#define __HIDREPORTDATA_H__
43
44
/* Private Interface - For use in library only: */
45
#if !defined(__DOXYGEN__)
46
/* Macros: */
47
#define HID_RI_DATA_SIZE_MASK 0x03
48
#define HID_RI_TYPE_MASK 0x0C
49
#define HID_RI_TAG_MASK 0xF0
50
51
#define HID_RI_TYPE_MAIN 0x00
52
#define HID_RI_TYPE_GLOBAL 0x04
53
#define HID_RI_TYPE_LOCAL 0x08
54
55
#define HID_RI_DATA_BITS_0 0x00
56
#define HID_RI_DATA_BITS_8 0x01
57
#define HID_RI_DATA_BITS_16 0x02
58
#define HID_RI_DATA_BITS_32 0x03
59
#define HID_RI_DATA_BITS(DataBits) HID_RI_DATA_BITS_ ## DataBits
60
61
#define _HID_RI_ENCODE_0(Data)
62
#define _HID_RI_ENCODE_8(Data) , (Data & 0xFF)
63
#define _HID_RI_ENCODE_16(Data) _HID_RI_ENCODE_8(Data) _HID_RI_ENCODE_8(Data >> 8)
64
#define _HID_RI_ENCODE_32(Data) _HID_RI_ENCODE_16(Data) _HID_RI_ENCODE_16(Data >> 16)
65
#define _HID_RI_ENCODE(DataBits, ...) _HID_RI_ENCODE_ ## DataBits(__VA_ARGS__)
66
67
#define _HID_RI_ENTRY(Type, Tag, DataBits, ...) \
68
(Type | Tag | HID_RI_DATA_BITS(DataBits)) _HID_RI_ENCODE(DataBits, (__VA_ARGS__))
69
#endif
70
71
/* Public Interface - May be used in end-application: */
72
/* Macros: */
75
#define HID_IOF_CONSTANT (1 << 0)
76
#define HID_IOF_DATA (0 << 0)
77
#define HID_IOF_VARIABLE (1 << 1)
78
#define HID_IOF_ARRAY (0 << 1)
79
#define HID_IOF_RELATIVE (1 << 2)
80
#define HID_IOF_ABSOLUTE (0 << 2)
81
#define HID_IOF_WRAP (1 << 3)
82
#define HID_IOF_NO_WRAP (0 << 3)
83
#define HID_IOF_NON_LINEAR (1 << 4)
84
#define HID_IOF_LINEAR (0 << 4)
85
#define HID_IOF_NO_PREFERRED_STATE (1 << 5)
86
#define HID_IOF_PREFERRED_STATE (0 << 5)
87
#define HID_IOF_NULLSTATE (1 << 6)
88
#define HID_IOF_NO_NULL_POSITION (0 << 6)
89
#define HID_IOF_VOLATILE (1 << 7)
90
#define HID_IOF_NON_VOLATILE (0 << 7)
91
#define HID_IOF_BUFFERED_BYTES (1 << 8)
92
#define HID_IOF_BITFIELD (0 << 8)
93
94
97
#define HID_RI_INPUT(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_MAIN , 0x80, DataBits, __VA_ARGS__)
98
#define HID_RI_OUTPUT(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_MAIN , 0x90, DataBits, __VA_ARGS__)
99
#define HID_RI_COLLECTION(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_MAIN , 0xA0, DataBits, __VA_ARGS__)
100
#define HID_RI_FEATURE(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_MAIN , 0xB0, DataBits, __VA_ARGS__)
101
#define HID_RI_END_COLLECTION(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_MAIN , 0xC0, DataBits, __VA_ARGS__)
102
#define HID_RI_USAGE_PAGE(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x00, DataBits, __VA_ARGS__)
103
#define HID_RI_LOGICAL_MINIMUM(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x10, DataBits, __VA_ARGS__)
104
#define HID_RI_LOGICAL_MAXIMUM(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x20, DataBits, __VA_ARGS__)
105
#define HID_RI_PHYSICAL_MINIMUM(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x30, DataBits, __VA_ARGS__)
106
#define HID_RI_PHYSICAL_MAXIMUM(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x40, DataBits, __VA_ARGS__)
107
#define HID_RI_UNIT_EXPONENT(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x50, DataBits, __VA_ARGS__)
108
#define HID_RI_UNIT(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x60, DataBits, __VA_ARGS__)
109
#define HID_RI_REPORT_SIZE(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x70, DataBits, __VA_ARGS__)
110
#define HID_RI_REPORT_ID(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x80, DataBits, __VA_ARGS__)
111
#define HID_RI_REPORT_COUNT(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0x90, DataBits, __VA_ARGS__)
112
#define HID_RI_PUSH(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0xA0, DataBits, __VA_ARGS__)
113
#define HID_RI_POP(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_GLOBAL, 0xB0, DataBits, __VA_ARGS__)
114
#define HID_RI_USAGE(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_LOCAL , 0x00, DataBits, __VA_ARGS__)
115
#define HID_RI_USAGE_MINIMUM(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_LOCAL , 0x10, DataBits, __VA_ARGS__)
116
#define HID_RI_USAGE_MAXIMUM(DataBits, ...) _HID_RI_ENTRY(HID_RI_TYPE_LOCAL , 0x20, DataBits, __VA_ARGS__)
117
118
121
#endif
122
software
LPCUSBLib
Drivers
USB
Class
Common
HIDReportData.h
Generated on Fri Nov 16 2012 13:36:44 for LPCOpen Platform by
1.8.2