summaryrefslogtreecommitdiff
path: root/usb/common/hid/HIDKeypad.h
blob: 06ad747ca70554e383256f480aa1da4f518d6b9b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
/* ----------------------------------------------------------------------------
 *         ATMEL Microcontroller Software Support 
 * ----------------------------------------------------------------------------
 * Copyright (c) 2008, Atmel Corporation
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the disclaimer below.
 *
 * Atmel's name may not be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
 * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * ----------------------------------------------------------------------------
 */

/**
 \unit

!!!Purpose

 Definitions of constants and methods for the HID keypad usage page.

 !!!Usage

 -# Use the constants declared in this file when instanciating a
    Report descriptor instance.
 -# When implementing the functionality of an HID keyboard, use the
    key codes defined here to indicate keys that are being pressed and
    released.
*/

#ifndef HIDKEYPAD_H
#define HIDKEYPAD_H

//------------------------------------------------------------------------------
//         Constants
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
/// \page "HID Keypad Page ID"
/// This page lists HID Keypad page ID.
///
/// !ID
/// - HIDKeypad_PAGEID

/// Identifier for the HID keypad usage page
#define HIDKeypad_PAGEID                    0x07
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
/// \page "HID Alphabetic Keys"
/// ...
///
/// !Keys
/// - HIDKeypad_A
/// - HIDKeypad_B
/// - HIDKeypad_C
/// - HIDKeypad_D
/// - HIDKeypad_E
/// - HIDKeypad_F
/// - HIDKeypad_G
/// - HIDKeypad_H
/// - HIDKeypad_I
/// - HIDKeypad_J
/// - HIDKeypad_K
/// - HIDKeypad_L
/// - HIDKeypad_M
/// - HIDKeypad_N
/// - HIDKeypad_O
/// - HIDKeypad_P
/// - HIDKeypad_Q
/// - HIDKeypad_R
/// - HIDKeypad_S
/// - HIDKeypad_T
/// - HIDKeypad_U
/// - HIDKeypad_V
/// - HIDKeypad_W
/// - HIDKeypad_X
/// - HIDKeypad_Y
/// - HIDKeypad_Z

/// Key code for 'a' and 'A'.
#define HIDKeypad_A                     4
/// Key code for 'b' and 'B'.
#define HIDKeypad_B                     5
/// Key code for 'c' and 'C'.
#define HIDKeypad_C                     6
/// Key code for 'd' and 'D'.
#define HIDKeypad_D                     7
/// Key code for 'e' and 'E'.
#define HIDKeypad_E                     8
/// Key code for 'f' and 'F'.
#define HIDKeypad_F                     9
/// Key code for 'g' and 'G'.
#define HIDKeypad_G                     10
/// Key code for 'h' and 'H'.
#define HIDKeypad_H                     11
/// Key code for 'i' and 'I'.
#define HIDKeypad_I                     12
/// Key code for 'j' and 'J'.
#define HIDKeypad_J                     13
/// Key code for 'k' and 'K'.
#define HIDKeypad_K                     14
/// Key code for 'l' and 'L'.
#define HIDKeypad_L                     15
/// Key code for 'm' and 'M'.
#define HIDKeypad_M                     16
/// Key code for 'n' and 'N'.
#define HIDKeypad_N                     17
/// Key code for 'o' and 'O'.
#define HIDKeypad_O                     18
/// Key code for 'p' and 'P'.
#define HIDKeypad_P                     19
/// Key code for 'q' and 'Q'.
#define HIDKeypad_Q                     20
/// Key code for 'r' and 'R'.
#define HIDKeypad_R                     21
/// Key code for 's' and 'S'.
#define HIDKeypad_S                     22
/// Key code for 't' and 'T'.
#define HIDKeypad_T                     23
/// Key code for 'u' and 'U'.
#define HIDKeypad_U                     24
/// Key code for 'v' and 'V'.
#define HIDKeypad_V                     25
/// Key code for 'w' and 'W'.
#define HIDKeypad_W                     26
/// Key code for 'x' and 'X'.
#define HIDKeypad_X                     27
/// Key code for 'y' and 'Y'.
#define HIDKeypad_Y                     28
/// Key code for 'z' and 'Z'.
#define HIDKeypad_Z                     29
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
/// \page "HID Numeric Keys"
/// ...
///
/// !Keys
/// - HIDKeypad_1
/// - HIDKeypad_2
/// - HIDKeypad_3
/// - HIDKeypad_4
/// - HIDKeypad_5
/// - HIDKeypad_6
/// - HIDKeypad_7
/// - HIDKeypad_8
/// - HIDKeypad_9
/// - HIDKeypad_0

/// Key code for '1' and '!'.
#define HIDKeypad_1                     30
/// Key code for '2' and '@'.
#define HIDKeypad_2                     31
/// Key code for '3' and '#'.
#define HIDKeypad_3                     32
/// Key code for '4' and '$'.
#define HIDKeypad_4                     33
/// Key code for '5' and '%'.
#define HIDKeypad_5                     34
/// Key code for '6' and '^'.
#define HIDKeypad_6                     35
/// Key code for '7' and '&'.
#define HIDKeypad_7                     36
/// Key code for '8' and '*'.
#define HIDKeypad_8                     37
/// Key code for '9' and '('.
#define HIDKeypad_9                     38
/// Key code for '0' and ')'.
#define HIDKeypad_0                     39
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
/// \page "HID Special Keys"
/// ...
///
/// !Keys
/// - HIDKeypad_ENTER
/// - HIDKeypad_ESCAPE
/// - HIDKeypad_BACKSPACE
/// - HIDKeypad_TAB
/// - HIDKeypad_SPACEBAR
/// - HIDKeypad_PRINTSCREEN
/// - HIDKeypad_SCROLLLOCK
/// - HIDKeypad_NUMLOCK

/// Enter key code.
#define HIDKeypad_ENTER                 40
/// Escape key code.
#define HIDKeypad_ESCAPE                41
/// Backspace key code.
#define HIDKeypad_BACKSPACE             42
/// Tab key code.
#define HIDKeypad_TAB                   43
/// Spacebar key code.
#define HIDKeypad_SPACEBAR              44
/// Printscreen key code.
#define HIDKeypad_PRINTSCREEN           70
/// Scroll lock key code.
#define HIDKeypad_SCROLLLOCK            71
/// Num lock key code.
#define HIDKeypad_NUMLOCK               83
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
/// \page "HID Modified Keys"
/// ...
///
/// !Keys
/// - HIDKeypad_LEFTCONTROL
/// - HIDKeypad_LEFTSHIFT
/// - HIDKeypad_LEFTALT
/// - HIDKeypad_LEFTGUI
/// - HIDKeypad_RIGHTCONTROL
/// - HIDKeypad_RIGHTSHIFT
/// - HIDKeypad_RIGHTALT
/// - HIDKeypad_RIGHTGUI

/// Key code for the left 'Control' key.
#define HIDKeypad_LEFTCONTROL           224
/// Key code for the left 'Shift' key.
#define HIDKeypad_LEFTSHIFT             225
/// Key code for the left 'Alt' key.
#define HIDKeypad_LEFTALT               226
/// Key code for the left 'GUI' (e.g. Windows) key.
#define HIDKeypad_LEFTGUI               227
/// Key code for the right 'Control' key.
#define HIDKeypad_RIGHTCONTROL          228
/// Key code for the right 'Shift' key.
#define HIDKeypad_RIGHTSHIFT            229
/// Key code for the right 'Alt' key.
#define HIDKeypad_RIGHTALT              230
/// Key code for the right 'GUI' key.
#define HIDKeypad_RIGHTGUI              231
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
/// \page "HID Error Codes"
/// ...
///
/// !Codes
/// - HIDKeypad_ERRORROLLOVER
/// - HIDKeypad_POSTFAIL
/// - HIDKeypad_ERRORUNDEFINED

/// Indicates that too many keys have been pressed at the same time.
#define HIDKeypad_ERRORROLLOVER         1
/// ?
#define HIDKeypad_POSTFAIL              2
/// Indicates an undefined error.
#define HIDKeypad_ERRORUNDEFINED        3
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
//         Exported functions
//------------------------------------------------------------------------------

extern unsigned char HIDKeypad_IsModifierKey(unsigned char key);

#endif //#ifndef HIDKEYPAD_H

personal git repositories of Harald Welte. Your mileage may vary