projects / pub / USBasp.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Add missing SVN eol-style properties to source files to prevent mixed end-of-line...
[pub/USBasp.git] / LUFA / Drivers / USB / Class / Common / HID.h
1 /*
2 LUFA Library
3 Copyright (C) Dean Camera, 2011.
4
5 dean [at] fourwalledcubicle [dot] com
6 www.lufa-lib.org
7 */
8
9 /*
10 Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com)
11
12 Permission to use, copy, modify, distribute, and sell this
13 software and its documentation for any purpose is hereby granted
14 without fee, provided that the above copyright notice appear in
15 all copies and that both that the copyright notice and this
16 permission notice and warranty disclaimer appear in supporting
17 documentation, and that the name of the author not be used in
18 advertising or publicity pertaining to distribution of the
19 software without specific, written prior permission.
20
21 The author disclaim all warranties with regard to this
22 software, including all implied warranties of merchantability
23 and fitness. In no event shall the author be liable for any
24 special, indirect or consequential damages or any damages
25 whatsoever resulting from loss of use, data or profits, whether
26 in an action of contract, negligence or other tortious action,
27 arising out of or in connection with the use or performance of
28 this software.
29 */
30
31 /** \file
32 * \brief Common definitions and declarations for the library USB HID Class driver.
33 *
34 * Common definitions and declarations for the library USB HID Class driver.
35 *
36 * \note This file should not be included directly. It is automatically included as needed by the USB module driver
37 * dispatch header located in LUFA/Drivers/USB.h.
38 */
39
40 /** \ingroup Group_USBClassHID
41 * \defgroup Group_USBClassHIDCommon Common Class Definitions
42 *
43 * \section Sec_ModDescription Module Description
44 * Constants, Types and Enum definitions that are common to both Device and Host modes for the USB
45 * HID Class.
46 *
47 * @{
48 */
49
50 #ifndef _HID_CLASS_COMMON_H_
51 #define _HID_CLASS_COMMON_H_
52
53 /* Includes: */
54 #include "../../Core/StdDescriptors.h"
55 #include "HIDParser.h"
56
57 /* Preprocessor Checks: */
58 #if !defined(__INCLUDE_FROM_HID_DRIVER)
59 #error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
60 #endif
61
62 /* Macros: */
63 /** \name Keyboard Standard Report Modifier Masks */
64 //@{
65 /** Constant for a keyboard report modifier byte, indicating that the keyboard's left control key is currently pressed. */
66 #define HID_KEYBOARD_MODIFER_LEFTCTRL (1 << 0)
67
68 /** Constant for a keyboard report modifier byte, indicating that the keyboard's left shift key is currently pressed. */
69 #define HID_KEYBOARD_MODIFER_LEFTSHIFT (1 << 1)
70
71 /** Constant for a keyboard report modifier byte, indicating that the keyboard's left alt key is currently pressed. */
72 #define HID_KEYBOARD_MODIFER_LEFTALT (1 << 2)
73
74 /** Constant for a keyboard report modifier byte, indicating that the keyboard's left GUI key is currently pressed. */
75 #define HID_KEYBOARD_MODIFER_LEFTGUI (1 << 3)
76
77 /** Constant for a keyboard report modifier byte, indicating that the keyboard's right control key is currently pressed. */
78 #define HID_KEYBOARD_MODIFER_RIGHTCTRL (1 << 4)
79
80 /** Constant for a keyboard report modifier byte, indicating that the keyboard's right shift key is currently pressed. */
81 #define HID_KEYBOARD_MODIFER_RIGHTSHIFT (1 << 5)
82
83 /** Constant for a keyboard report modifier byte, indicating that the keyboard's right alt key is currently pressed. */
84 #define HID_KEYBOARD_MODIFER_RIGHTALT (1 << 6)
85
86 /** Constant for a keyboard report modifier byte, indicating that the keyboard's right GUI key is currently pressed. */
87 #define HID_KEYBOARD_MODIFER_RIGHTGUI (1 << 7)
88 //@}
89
90 /** \name Keyboard Standard Report LED Masks */
91 //@{
92 /** Constant for a keyboard output report LED byte, indicating that the host's NUM LOCK mode is currently set. */
93 #define HID_KEYBOARD_LED_NUMLOCK (1 << 0)
94
95 /** Constant for a keyboard output report LED byte, indicating that the host's CAPS LOCK mode is currently set. */
96 #define HID_KEYBOARD_LED_CAPSLOCK (1 << 1)
97
98 /** Constant for a keyboard output report LED byte, indicating that the host's SCROLL LOCK mode is currently set. */
99 #define HID_KEYBOARD_LED_SCROLLLOCK (1 << 2)
100
101 /** Constant for a keyboard output report LED byte, indicating that the host's KATANA mode is currently set. */
102 #define HID_KEYBOARD_LED_KATANA (1 << 3)
103 //@}
104
105 /** \name Keyboard Standard Report Key Scan-codes */
106 //@{
107 #define HID_KEYBOARD_SC_ERROR_ROLLOVER 0x01
108 #define HID_KEYBOARD_SC_POST_FAIL 0x02
109 #define HID_KEYBOARD_SC_ERROR_UNDEFINED 0x03
110 #define HID_KEYBOARD_SC_A 0x04
111 #define HID_KEYBOARD_SC_B 0x05
112 #define HID_KEYBOARD_SC_C 0x06
113 #define HID_KEYBOARD_SC_D 0x07
114 #define HID_KEYBOARD_SC_E 0x08
115 #define HID_KEYBOARD_SC_F 0x09
116 #define HID_KEYBOARD_SC_G 0x0A
117 #define HID_KEYBOARD_SC_H 0x0B
118 #define HID_KEYBOARD_SC_I 0x0C
119 #define HID_KEYBOARD_SC_J 0x0D
120 #define HID_KEYBOARD_SC_K 0x0E
121 #define HID_KEYBOARD_SC_L 0x0F
122 #define HID_KEYBOARD_SC_M 0x10
123 #define HID_KEYBOARD_SC_N 0x11
124 #define HID_KEYBOARD_SC_O 0x12
125 #define HID_KEYBOARD_SC_P 0x13
126 #define HID_KEYBOARD_SC_Q 0x14
127 #define HID_KEYBOARD_SC_R 0x15
128 #define HID_KEYBOARD_SC_S 0x16
129 #define HID_KEYBOARD_SC_T 0x17
130 #define HID_KEYBOARD_SC_U 0x18
131 #define HID_KEYBOARD_SC_V 0x19
132 #define HID_KEYBOARD_SC_W 0x1A
133 #define HID_KEYBOARD_SC_X 0x1B
134 #define HID_KEYBOARD_SC_Y 0x1C
135 #define HID_KEYBOARD_SC_Z 0x1D
136 #define HID_KEYBOARD_SC_1_AND_EXCLAMATION 0x1E
137 #define HID_KEYBOARD_SC_2_AND_AT 0x1F
138 #define HID_KEYBOARD_SC_3_AND_HASHMARK 0x20
139 #define HID_KEYBOARD_SC_4_AND_DOLLAR 0x21
140 #define HID_KEYBOARD_SC_5_AND_PERCENTAGE 0x22
141 #define HID_KEYBOARD_SC_6_AND_CARET 0x23
142 #define HID_KEYBOARD_SC_7_AND_AND_AMPERSAND 0x24
143 #define HID_KEYBOARD_SC_8_AND_ASTERISK 0x25
144 #define HID_KEYBOARD_SC_9_AND_OPENING_PARENTHESIS 0x26
145 #define HID_KEYBOARD_SC_0_AND_CLOSING_PARENTHESIS 0x27
146 #define HID_KEYBOARD_SC_ENTER 0x28
147 #define HID_KEYBOARD_SC_ESCAPE 0x29
148 #define HID_KEYBOARD_SC_BACKSPACE 0x2A
149 #define HID_KEYBOARD_SC_TAB 0x2B
150 #define HID_KEYBOARD_SC_SPACE 0x2C
151 #define HID_KEYBOARD_SC_MINUS_AND_UNDERSCORE 0x2D
152 #define HID_KEYBOARD_SC_EQUAL_AND_PLUS 0x2E
153 #define HID_KEYBOARD_SC_OPENING_BRACKET_AND_OPENING_BRACE 0x2F
154 #define HID_KEYBOARD_SC_CLOSING_BRACKET_AND_CLOSING_BRACE 0x30
155 #define HID_KEYBOARD_SC_BACKSLASH_AND_PIPE 0x31
156 #define HID_KEYBOARD_SC_NON_US_HASHMARK_AND_TILDE 0x32
157 #define HID_KEYBOARD_SC_SEMICOLON_AND_COLON 0x33
158 #define HID_KEYBOARD_SC_APOSTROPHE_AND_QUOTE 0x34
159 #define HID_KEYBOARD_SC_GRAVE_ACCENT_AND_TILDE 0x35
160 #define HID_KEYBOARD_SC_COMMA_AND_LESS_THAN_SIGN 0x36
161 #define HID_KEYBOARD_SC_DOT_AND_GREATER_THAN_SIGN 0x37
162 #define HID_KEYBOARD_SC_SLASH_AND_QUESTION_MARK 0x38
163 #define HID_KEYBOARD_SC_CAPS_LOCK 0x39
164 #define HID_KEYBOARD_SC_F1 0x3A
165 #define HID_KEYBOARD_SC_F2 0x3B
166 #define HID_KEYBOARD_SC_F3 0x3C
167 #define HID_KEYBOARD_SC_F4 0x3D
168 #define HID_KEYBOARD_SC_F5 0x3E
169 #define HID_KEYBOARD_SC_F6 0x3F
170 #define HID_KEYBOARD_SC_F7 0x40
171 #define HID_KEYBOARD_SC_F8 0x41
172 #define HID_KEYBOARD_SC_F9 0x42
173 #define HID_KEYBOARD_SC_F10 0x43
174 #define HID_KEYBOARD_SC_F11 0x44
175 #define HID_KEYBOARD_SC_F12 0x45
176 #define HID_KEYBOARD_SC_PRINT_SCREEN 0x46
177 #define HID_KEYBOARD_SC_SCROLL_LOCK 0x47
178 #define HID_KEYBOARD_SC_PAUSE 0x48
179 #define HID_KEYBOARD_SC_INSERT 0x49
180 #define HID_KEYBOARD_SC_HOME 0x4A
181 #define HID_KEYBOARD_SC_PAGE_UP 0x4B
182 #define HID_KEYBOARD_SC_DELETE 0x4C
183 #define HID_KEYBOARD_SC_END 0x4D
184 #define HID_KEYBOARD_SC_PAGE_DOWN 0x4E
185 #define HID_KEYBOARD_SC_RIGHT_ARROW 0x4F
186 #define HID_KEYBOARD_SC_LEFT_ARROW 0x50
187 #define HID_KEYBOARD_SC_DOWN_ARROW 0x51
188 #define HID_KEYBOARD_SC_UP_ARROW 0x52
189 #define HID_KEYBOARD_SC_NUM_LOCK 0x53
190 #define HID_KEYBOARD_SC_KEYPAD_SLASH 0x54
191 #define HID_KEYBOARD_SC_KEYPAD_ASTERISK 0x55
192 #define HID_KEYBOARD_SC_KEYPAD_MINUS 0x56
193 #define HID_KEYBOARD_SC_KEYPAD_PLUS 0x57
194 #define HID_KEYBOARD_SC_KEYPAD_ENTER 0x58
195 #define HID_KEYBOARD_SC_KEYPAD_1_AND_END 0x59
196 #define HID_KEYBOARD_SC_KEYPAD_2_AND_DOWN_ARROW 0x5A
197 #define HID_KEYBOARD_SC_KEYPAD_3_AND_PAGE_DOWN 0x5B
198 #define HID_KEYBOARD_SC_KEYPAD_4_AND_LEFT_ARROW 0x5C
199 #define HID_KEYBOARD_SC_KEYPAD_5 0x5D
200 #define HID_KEYBOARD_SC_KEYPAD_6_AND_RIGHT_ARROW 0x5E
201 #define HID_KEYBOARD_SC_KEYPAD_7_AND_HOME 0x5F
202 #define HID_KEYBOARD_SC_KEYPAD_8_AND_UP_ARROW 0x60
203 #define HID_KEYBOARD_SC_KEYPAD_9_AND_PAGE_UP 0x61
204 #define HID_KEYBOARD_SC_KEYPAD_0_AND_INSERT 0x62
205 #define HID_KEYBOARD_SC_KEYPAD_DOT_AND_DELETE 0x63
206 #define HID_KEYBOARD_SC_NON_US_BACKSLASH_AND_PIPE 0x64
207 #define HID_KEYBOARD_SC_POWER 0x66
208 #define HID_KEYBOARD_SC_EQUAL_SIGN 0x67
209 #define HID_KEYBOARD_SC_F13 0x68
210 #define HID_KEYBOARD_SC_F14 0x69
211 #define HID_KEYBOARD_SC_F15 0x6A
212 #define HID_KEYBOARD_SC_F16 0x6B
213 #define HID_KEYBOARD_SC_F17 0x6C
214 #define HID_KEYBOARD_SC_F18 0x6D
215 #define HID_KEYBOARD_SC_F19 0x6E
216 #define HID_KEYBOARD_SC_F20 0x6F
217 #define HID_KEYBOARD_SC_F21 0x70
218 #define HID_KEYBOARD_SC_F22 0x71
219 #define HID_KEYBOARD_SC_F23 0x72
220 #define HID_KEYBOARD_SC_F24 0x73
221 #define HID_KEYBOARD_SC_EXECUTE 0x74
222 #define HID_KEYBOARD_SC_HELP 0x75
223 #define HID_KEYBOARD_SC_MANU 0x76
224 #define HID_KEYBOARD_SC_SELECT 0x77
225 #define HID_KEYBOARD_SC_STOP 0x78
226 #define HID_KEYBOARD_SC_AGAIN 0x79
227 #define HID_KEYBOARD_SC_UNDO 0x7A
228 #define HID_KEYBOARD_SC_CUT 0x7B
229 #define HID_KEYBOARD_SC_COPY 0x7C
230 #define HID_KEYBOARD_SC_PASTE 0x7D
231 #define HID_KEYBOARD_SC_FIND 0x7E
232 #define HID_KEYBOARD_SC_MUTE 0x7F
233 #define HID_KEYBOARD_SC_VOLUME_UP 0x80
234 #define HID_KEYBOARD_SC_VOLUME_DOWN 0x81
235 #define HID_KEYBOARD_SC_LOCKING_CAPS_LOCK 0x82
236 #define HID_KEYBOARD_SC_LOCKING_NUM_LOCK 0x83
237 #define HID_KEYBOARD_SC_LOCKING_SCROLL_LOCK 0x84
238 #define HID_KEYBOARD_SC_KEYPAD_COMMA 0x85
239 #define HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN 0x86
240 #define HID_KEYBOARD_SC_INTERNATIONAL1 0x87
241 #define HID_KEYBOARD_SC_INTERNATIONAL2 0x88
242 #define HID_KEYBOARD_SC_INTERNATIONAL3 0x89
243 #define HID_KEYBOARD_SC_INTERNATIONAL4 0x8A
244 #define HID_KEYBOARD_SC_INTERNATIONAL5 0x8B
245 #define HID_KEYBOARD_SC_INTERNATIONAL6 0x8C
246 #define HID_KEYBOARD_SC_INTERNATIONAL7 0x8D
247 #define HID_KEYBOARD_SC_INTERNATIONAL8 0x8E
248 #define HID_KEYBOARD_SC_INTERNATIONAL9 0x8F
249 #define HID_KEYBOARD_SC_LANG1 0x90
250 #define HID_KEYBOARD_SC_LANG2 0x91
251 #define HID_KEYBOARD_SC_LANG3 0x92
252 #define HID_KEYBOARD_SC_LANG4 0x93
253 #define HID_KEYBOARD_SC_LANG5 0x94
254 #define HID_KEYBOARD_SC_LANG6 0x95
255 #define HID_KEYBOARD_SC_LANG7 0x96
256 #define HID_KEYBOARD_SC_LANG8 0x97
257 #define HID_KEYBOARD_SC_LANG9 0x98
258 #define HID_KEYBOARD_SC_ALTERNATE_ERASE 0x99
259 #define HID_KEYBOARD_SC_SISREQ 0x9A
260 #define HID_KEYBOARD_SC_CANCEL 0x9B
261 #define HID_KEYBOARD_SC_CLEAR 0x9C
262 #define HID_KEYBOARD_SC_PRIOR 0x9D
263 #define HID_KEYBOARD_SC_RETURN 0x9E
264 #define HID_KEYBOARD_SC_SEPARATOR 0x9F
265 #define HID_KEYBOARD_SC_OUT 0xA0
266 #define HID_KEYBOARD_SC_OPER 0xA1
267 #define HID_KEYBOARD_SC_CLEAR_AND_AGAIN 0xA2
268 #define HID_KEYBOARD_SC_CRSEL_ANDPROPS 0xA3
269 #define HID_KEYBOARD_SC_EXSEL 0xA4
270 #define HID_KEYBOARD_SC_KEYPAD_00 0xB0
271 #define HID_KEYBOARD_SC_KEYPAD_000 0xB1
272 #define HID_KEYBOARD_SC_THOUSANDS_SEPARATOR 0xB2
273 #define HID_KEYBOARD_SC_DECIMAL_SEPARATOR 0xB3
274 #define HID_KEYBOARD_SC_CURRENCY_UNIT 0xB4
275 #define HID_KEYBOARD_SC_CURRENCY_SUB_UNIT 0xB5
276 #define HID_KEYBOARD_SC_KEYPAD_OPENING_PARENTHESIS 0xB6
277 #define HID_KEYBOARD_SC_KEYPAD_CLOSING_PARENTHESIS 0xB7
278 #define HID_KEYBOARD_SC_KEYPAD_OPENING_BRACE 0xB8
279 #define HID_KEYBOARD_SC_KEYPAD_CLOSING_BRACE 0xB9
280 #define HID_KEYBOARD_SC_KEYPAD_TAB 0xBA
281 #define HID_KEYBOARD_SC_KEYPAD_BACKSPACE 0xBB
282 #define HID_KEYBOARD_SC_KEYPAD_A 0xBC
283 #define HID_KEYBOARD_SC_KEYPAD_B 0xBD
284 #define HID_KEYBOARD_SC_KEYPAD_C 0xBE
285 #define HID_KEYBOARD_SC_KEYPAD_D 0xBF
286 #define HID_KEYBOARD_SC_KEYPAD_E 0xC0
287 #define HID_KEYBOARD_SC_KEYPAD_F 0xC1
288 #define HID_KEYBOARD_SC_KEYPAD_XOR 0xC2
289 #define HID_KEYBOARD_SC_KEYPAD_CARET 0xC3
290 #define HID_KEYBOARD_SC_KEYPAD_PERCENTAGE 0xC4
291 #define HID_KEYBOARD_SC_KEYPAD_LESS_THAN_SIGN 0xC5
292 #define HID_KEYBOARD_SC_KEYPAD_GREATER_THAN_SIGN 0xC6
293 #define HID_KEYBOARD_SC_KEYPAD_AMP 0xC7
294 #define HID_KEYBOARD_SC_KEYPAD_AMP_AMP 0xC8
295 #define HID_KEYBOARD_SC_KEYPAD_PIPE 0xC9
296 #define HID_KEYBOARD_SC_KEYPAD_PIPE_PIPE 0xCA
297 #define HID_KEYBOARD_SC_KEYPAD_COLON 0xCB
298 #define HID_KEYBOARD_SC_KEYPAD_HASHMARK 0xCC
299 #define HID_KEYBOARD_SC_KEYPAD_SPACE 0xCD
300 #define HID_KEYBOARD_SC_KEYPAD_AT 0xCE
301 #define HID_KEYBOARD_SC_KEYPAD_EXCLAMATION_SIGN 0xCF
302 #define HID_KEYBOARD_SC_KEYPAD_MEMORY_STORE 0xD0
303 #define HID_KEYBOARD_SC_KEYPAD_MEMORY_RECALL 0xD1
304 #define HID_KEYBOARD_SC_KEYPAD_MEMORY_CLEAR 0xD2
305 #define HID_KEYBOARD_SC_KEYPAD_MEMORY_ADD 0xD3
306 #define HID_KEYBOARD_SC_KEYPAD_MEMORY_SUBTRACT 0xD4
307 #define HID_KEYBOARD_SC_KEYPAD_MEMORY_MULTIPLY 0xD5
308 #define HID_KEYBOARD_SC_KEYPAD_MEMORY_DIVIDE 0xD6
309 #define HID_KEYBOARD_SC_KEYPAD_PLUS_AND_MINUS 0xD7
310 #define HID_KEYBOARD_SC_KEYPAD_CLEAR 0xD8
311 #define HID_KEYBOARD_SC_KEYPAD_CLEAR_ENTRY 0xD9
312 #define HID_KEYBOARD_SC_KEYPAD_BINARY 0xDA
313 #define HID_KEYBOARD_SC_KEYPAD_OCTAL 0xDB
314 #define HID_KEYBOARD_SC_KEYPAD_DECIMAL 0xDC
315 #define HID_KEYBOARD_SC_KEYPAD_HEXADECIMAL 0xDD
316 #define HID_KEYBOARD_SC_LEFT_CONTROL 0xE0
317 #define HID_KEYBOARD_SC_LEFT_SHIFT 0xE1
318 #define HID_KEYBOARD_SC_LEFT_ALT 0xE2
319 #define HID_KEYBOARD_SC_LEFT_GUI 0xE3
320 #define HID_KEYBOARD_SC_RIGHT_CONTROL 0xE4
321 #define HID_KEYBOARD_SC_RIGHT_SHIFT 0xE5
322 #define HID_KEYBOARD_SC_RIGHT_ALT 0xE6
323 #define HID_KEYBOARD_SC_RIGHT_GUI 0xE7
324 //@}
325
326 /** \name Standard HID Device Report Descriptors */
327 //@{
328 /** \hideinitializer
329 * A list of HID report item array elements that describe a typical HID USB Joystick. The resulting report descriptor
330 * is structured according to the following layout:
331 *
332 * \code
333 * struct
334 * {
335 * uintA_t Buttons; // Pressed buttons bitmask
336 * intB_t X; // Signed X axis value
337 * intB_t Y; // Signed Y axis value
338 * } Joystick_Report;
339 * \endcode
340 *
341 * Where \c uintA_t is a type large enough to hold one bit per button, and \c intB_t is a type large enough to hold the
342 * ranges of the signed \c MinAxisVal and \c MaxAxisVal values.
343 *
344 * \param[in] MinAxisVal Minimum X/Y logical axis value.
345 * \param[in] MaxAxisVal Maximum X/Y logical axis value.
346 * \param[in] MinPhysicalVal Minimum X/Y physical axis value, for movement resolution calculations.
347 * \param[in] MaxPhysicalVal Maximum X/Y physical axis value, for movement resolution calculations.
348 * \param[in] Buttons Total number of buttons in the device.
349 */
350 #define HID_DESCRIPTOR_JOYSTICK(MinAxisVal, MaxAxisVal, MinPhysicalVal, MaxPhysicalVal, Buttons) \
351 HID_RI_USAGE_PAGE(8, 0x01), \
352 HID_RI_USAGE(8, 0x04), \
353 HID_RI_COLLECTION(8, 0x01), \
354 HID_RI_USAGE(8, 0x01), \
355 HID_RI_COLLECTION(8, 0x00), \
356 HID_RI_USAGE(8, 0x30), \
357 HID_RI_USAGE(8, 0x31), \
358 HID_RI_LOGICAL_MINIMUM(16, MinAxisVal), \
359 HID_RI_LOGICAL_MAXIMUM(16, MaxAxisVal), \
360 HID_RI_PHYSICAL_MINIMUM(16, MinPhysicalVal), \
361 HID_RI_PHYSICAL_MAXIMUM(16, MaxPhysicalVal), \
362 HID_RI_REPORT_COUNT(8, 0x02), \
363 HID_RI_REPORT_SIZE(8, ((((MinAxisVal >= -0xFF) && (MaxAxisVal <= 0xFF)) ? 8 : 16))), \
364 HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE), \
365 HID_RI_END_COLLECTION(0), \
366 HID_RI_USAGE_PAGE(8, 0x09), \
367 HID_RI_USAGE_MINIMUM(8, 0x01), \
368 HID_RI_USAGE_MAXIMUM(8, Buttons), \
369 HID_RI_LOGICAL_MINIMUM(8, 0x00), \
370 HID_RI_LOGICAL_MAXIMUM(8, 0x01), \
371 HID_RI_REPORT_SIZE(8, 0x01), \
372 HID_RI_REPORT_COUNT(8, Buttons), \
373 HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE), \
374 HID_RI_REPORT_SIZE(8, (8 - (Buttons % 8))), \
375 HID_RI_REPORT_COUNT(8, 0x01), \
376 HID_RI_INPUT(8, HID_IOF_CONSTANT), \
377 HID_RI_END_COLLECTION(0)
378
379 /** \hideinitializer
380 * A list of HID report item array elements that describe a typical HID USB keyboard. The resulting report descriptor
381 * is compatible with \ref USB_KeyboardReport_Data_t when \c MaxKeys is equal to 6. For other values, the report will
382 * be structured according to the following layout:
383 *
384 * \code
385 * struct
386 * {
387 * uint8_t Modifier; // Keyboard modifier byte indicating pressed modifier keys (HID_KEYBOARD_MODIFER_* masks)
388 * uint8_t Reserved; // Reserved for OEM use, always set to 0.
389 * uint8_t KeyCode[MaxKeys]; // Length determined by the number of keys that can be reported
390 * } Keyboard_Report;
391 * \endcode
392 *
393 * \param[in] MaxKeys Number of simultaneous keys that can be reported at the one time (a value between 1 and
394 * (ENDPOINT_SIZE - 2) ).
395 */
396 #define HID_DESCRIPTOR_KEYBOARD(MaxKeys) \
397 HID_RI_USAGE_PAGE(8, 0x01), \
398 HID_RI_USAGE(8, 0x06), \
399 HID_RI_COLLECTION(8, 0x01), \
400 HID_RI_USAGE_PAGE(8, 0x07), \
401 HID_RI_USAGE_MINIMUM(8, 0xE0), \
402 HID_RI_USAGE_MAXIMUM(8, 0xE7), \
403 HID_RI_LOGICAL_MINIMUM(8, 0x00), \
404 HID_RI_LOGICAL_MAXIMUM(8, 0x01), \
405 HID_RI_REPORT_SIZE(8, 0x01), \
406 HID_RI_REPORT_COUNT(8, 0x08), \
407 HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE), \
408 HID_RI_REPORT_COUNT(8, 0x01), \
409 HID_RI_REPORT_SIZE(8, 0x08), \
410 HID_RI_INPUT(8, HID_IOF_CONSTANT), \
411 HID_RI_USAGE_PAGE(8, 0x08), \
412 HID_RI_USAGE_MINIMUM(8, 0x01), \
413 HID_RI_USAGE_MAXIMUM(8, 0x05), \
414 HID_RI_REPORT_COUNT(8, 0x05), \
415 HID_RI_REPORT_SIZE(8, 0x01), \
416 HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE), \
417 HID_RI_REPORT_COUNT(8, 0x01), \
418 HID_RI_REPORT_SIZE(8, 0x03), \
419 HID_RI_OUTPUT(8, HID_IOF_CONSTANT), \
420 HID_RI_LOGICAL_MINIMUM(8, 0x00), \
421 HID_RI_LOGICAL_MAXIMUM(8, 0x65), \
422 HID_RI_USAGE_PAGE(8, 0x07), \
423 HID_RI_USAGE_MINIMUM(8, 0x00), \
424 HID_RI_USAGE_MAXIMUM(8, 0x65), \
425 HID_RI_REPORT_COUNT(8, MaxKeys), \
426 HID_RI_REPORT_SIZE(8, 0x08), \
427 HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_ARRAY | HID_IOF_ABSOLUTE), \
428 HID_RI_END_COLLECTION(0)
429
430 /** \hideinitializer
431 * A list of HID report item array elements that describe a typical HID USB mouse. The resulting report descriptor
432 * is compatible with \ref USB_MouseReport_Data_t if the \c MinAxisVal and \c MaxAxisVal values fit within a \c int8_t range
433 * and the number of Buttons is less than 8. For other values, the report is structured according to the following layout:
434 *
435 * \code
436 * struct
437 * {
438 * uintA_t Buttons; // Pressed buttons bitmask
439 * intB_t X; // X axis value
440 * intB_t Y; // Y axis value
441 * } Mouse_Report;
442 * \endcode
443 *
444 * Where \c intA_t is a type large enough to hold one bit per button, and \c intB_t is a type large enough to hold the
445 * ranges of the signed \c MinAxisVal and \c MaxAxisVal values.
446 *
447 * \param[in] MinAxisVal Minimum X/Y logical axis value.
448 * \param[in] MaxAxisVal Maximum X/Y logical axis value.
449 * \param[in] MinPhysicalVal Minimum X/Y physical axis value, for movement resolution calculations.
450 * \param[in] MaxPhysicalVal Maximum X/Y physical axis value, for movement resolution calculations.
451 * \param[in] Buttons Total number of buttons in the device.
452 * \param[in] AbsoluteCoords Boolean true to use absolute X/Y coordinates (e.g. touchscreen).
453 */
454 #define HID_DESCRIPTOR_MOUSE(MinAxisVal, MaxAxisVal, MinPhysicalVal, MaxPhysicalVal, Buttons, AbsoluteCoords) \
455 HID_RI_USAGE_PAGE(8, 0x01), \
456 HID_RI_USAGE(8, 0x02), \
457 HID_RI_COLLECTION(8, 0x01), \
458 HID_RI_USAGE(8, 0x01), \
459 HID_RI_COLLECTION(8, 0x00), \
460 HID_RI_USAGE_PAGE(8, 0x09), \
461 HID_RI_USAGE_MINIMUM(8, 0x01), \
462 HID_RI_USAGE_MAXIMUM(8, Buttons), \
463 HID_RI_LOGICAL_MINIMUM(8, 0x00), \
464 HID_RI_LOGICAL_MAXIMUM(8, 0x01), \
465 HID_RI_REPORT_COUNT(8, Buttons), \
466 HID_RI_REPORT_SIZE(8, 0x01), \
467 HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE), \
468 HID_RI_REPORT_COUNT(8, 0x01), \
469 HID_RI_REPORT_SIZE(8, (8 - (Buttons % 8))), \
470 HID_RI_INPUT(8, HID_IOF_CONSTANT), \
471 HID_RI_USAGE_PAGE(8, 0x01), \
472 HID_RI_USAGE(8, 0x30), \
473 HID_RI_USAGE(8, 0x31), \
474 HID_RI_LOGICAL_MINIMUM(16, MinAxisVal), \
475 HID_RI_LOGICAL_MAXIMUM(16, MaxAxisVal), \
476 HID_RI_PHYSICAL_MINIMUM(16, MinPhysicalVal), \
477 HID_RI_PHYSICAL_MAXIMUM(16, MaxPhysicalVal), \
478 HID_RI_REPORT_COUNT(8, 0x02), \
479 HID_RI_REPORT_SIZE(8, ((((MinAxisVal >= -0xFF) && (MaxAxisVal <= 0xFF)) ? 8 : 16))), \
480 HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | (AbsoluteCoords ? HID_IOF_ABSOLUTE : HID_IOF_RELATIVE)), \
481 HID_RI_END_COLLECTION(0), \
482 HID_RI_END_COLLECTION(0)
483
484 /** \hideinitializer
485 * A list of HID report item array elements that describe a typical Vendor Defined byte array HID report descriptor,
486 * used for transporting arbitrary data between the USB host and device via HID reports. The resulting report should be
487 * a uint8_t byte array of the specified length in both Device to Host (IN) and Host to Device (OUT) directions.
488 *
489 * \param[in] VendorPageNum Vendor Defined HID Usage Page index, ranging from 0x00 to 0xFF.
490 * \param[in] CollectionUsage Vendor Usage for the encompassing report IN and OUT collection, ranging from 0x00 to 0xFF.
491 * \param[in] DataINUsage Vendor Usage for the IN report data, ranging from 0x00 to 0xFF.
492 * \param[in] DataOUTUsage Vendor Usage for the OUT report data, ranging from 0x00 to 0xFF.
493 * \param[in] NumBytes Length of the data IN and OUT reports.
494 */
495 #define HID_DESCRIPTOR_VENDOR(VendorPageNum, CollectionUsage, DataINUsage, DataOUTUsage, NumBytes) \
496 HID_RI_USAGE_PAGE(16, (0xFF00 | VendorPageNum)), \
497 HID_RI_USAGE(8, CollectionUsage), \
498 HID_RI_COLLECTION(8, 0x01), \
499 HID_RI_USAGE(8, DataINUsage), \
500 HID_RI_LOGICAL_MINIMUM(8, 0x00), \
501 HID_RI_LOGICAL_MAXIMUM(8, 0xFF), \
502 HID_RI_REPORT_SIZE(8, 0x08), \
503 HID_RI_REPORT_COUNT(8, NumBytes), \
504 HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE), \
505 HID_RI_USAGE(8, DataOUTUsage), \
506 HID_RI_LOGICAL_MINIMUM(8, 0x00), \
507 HID_RI_LOGICAL_MAXIMUM(8, 0xFF), \
508 HID_RI_REPORT_SIZE(8, 0x08), \
509 HID_RI_REPORT_COUNT(8, NumBytes), \
510 HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE), \
511 HID_RI_END_COLLECTION(0)
512 //@}
513
514 /* Type Defines: */
515 /** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the HID
516 * device class.
517 */
518 enum HID_Descriptor_ClassSubclassProtocol_t
519 {
520 HID_CSCP_HIDClass = 0x03, /**< Descriptor Class value indicating that the device or interface
521 * belongs to the HID class.
522 */
523 HID_CSCP_NonBootSubclass = 0x00, /**< Descriptor Subclass value indicating that the device or interface
524 * does not implement a HID boot protocol.
525 */
526 HID_CSCP_BootSubclass = 0x01, /**< Descriptor Subclass value indicating that the device or interface
527 * implements a HID boot protocol.
528 */
529 HID_CSCP_NonBootProtocol = 0x00, /**< Descriptor Protocol value indicating that the device or interface
530 * does not belong to a HID boot protocol.
531 */
532 HID_CSCP_KeyboardBootProtocol = 0x01, /**< Descriptor Protocol value indicating that the device or interface
533 * belongs to the Keyboard HID boot protocol.
534 */
535 HID_CSCP_MouseBootProtocol = 0x02, /**< Descriptor Protocol value indicating that the device or interface
536 * belongs to the Mouse HID boot protocol.
537 */
538 };
539
540 /** Enum for the HID class specific control requests that can be issued by the USB bus host. */
541 enum HID_ClassRequests_t
542 {
543 HID_REQ_GetReport = 0x01, /**< HID class-specific Request to get the current HID report from the device. */
544 HID_REQ_GetIdle = 0x02, /**< HID class-specific Request to get the current device idle count. */
545 HID_REQ_GetProtocol = 0x03, /**< HID class-specific Request to get the current HID report protocol mode. */
546 HID_REQ_SetReport = 0x09, /**< HID class-specific Request to set the current HID report to the device. */
547 HID_REQ_SetIdle = 0x0A, /**< HID class-specific Request to set the device's idle count. */
548 HID_REQ_SetProtocol = 0x0B, /**< HID class-specific Request to set the current HID report protocol mode. */
549 };
550
551 /** Enum for the HID class specific descriptor types. */
552 enum HID_DescriptorTypes_t
553 {
554 HID_DTYPE_HID = 0x21, /**< Descriptor header type value, to indicate a HID class HID descriptor. */
555 HID_DTYPE_Report = 0x22, /**< Descriptor header type value, to indicate a HID class HID report descriptor. */
556 };
557
558 /** Enum for the different types of HID reports. */
559 enum HID_ReportItemTypes_t
560 {
561 HID_REPORT_ITEM_In = 0, /**< Indicates that the item is an IN report type. */
562 HID_REPORT_ITEM_Out = 1, /**< Indicates that the item is an OUT report type. */
563 HID_REPORT_ITEM_Feature = 2, /**< Indicates that the item is a FEATURE report type. */
564 };
565
566 /** \brief HID class-specific HID Descriptor (LUFA naming conventions).
567 *
568 * Type define for the HID class-specific HID descriptor, to describe the HID device's specifications. Refer to the HID
569 * specification for details on the structure elements.
570 *
571 * \see \ref USB_HID_StdDescriptor_HID_t for the version of this type with standard element names.
572 */
573 typedef struct
574 {
575 USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length. */
576
577 uint16_t HIDSpec; /**< BCD encoded version that the HID descriptor and device complies to. */
578 uint8_t CountryCode; /**< Country code of the localized device, or zero if universal. */
579
580 uint8_t TotalReportDescriptors; /**< Total number of HID report descriptors for the interface. */
581
582 uint8_t HIDReportType; /**< Type of HID report, set to \ref HID_DTYPE_Report. */
583 uint16_t HIDReportLength; /**< Length of the associated HID report descriptor, in bytes. */
584 } ATTR_PACKED USB_HID_Descriptor_HID_t;
585
586 /** \brief HID class-specific HID Descriptor (USB-IF naming conventions).
587 *
588 * Type define for the HID class-specific HID descriptor, to describe the HID device's specifications. Refer to the HID
589 * specification for details on the structure elements.
590 *
591 * \see \ref USB_HID_Descriptor_HID_t for the version of this type with non-standard LUFA specific
592 * element names.
593 */
594 typedef struct
595 {
596 uint8_t bLength; /**< Size of the descriptor, in bytes. */
597 uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
598 * given by the specific class.
599 */
600
601 uint16_t bcdHID; /**< BCD encoded version that the HID descriptor and device complies to. */
602 uint8_t bCountryCode; /**< Country code of the localized device, or zero if universal. */
603
604 uint8_t bNumDescriptors; /**< Total number of HID report descriptors for the interface. */
605
606 uint8_t bDescriptorType2; /**< Type of HID report, set to \ref HID_DTYPE_Report. */
607 uint16_t wDescriptorLength; /**< Length of the associated HID report descriptor, in bytes. */
608 } ATTR_PACKED USB_HID_StdDescriptor_HID_t;
609
610 /** \brief Standard HID Boot Protocol Mouse Report.
611 *
612 * Type define for a standard Boot Protocol Mouse report
613 */
614 typedef struct
615 {
616 uint8_t Button; /**< Button mask for currently pressed buttons in the mouse. */
617 int8_t X; /**< Current delta X movement of the mouse. */
618 int8_t Y; /**< Current delta Y movement on the mouse. */
619 } ATTR_PACKED USB_MouseReport_Data_t;
620
621 /** \brief Standard HID Boot Protocol Keyboard Report.
622 *
623 * Type define for a standard Boot Protocol Keyboard report
624 */
625 typedef struct
626 {
627 uint8_t Modifier; /**< Keyboard modifier byte, indicating pressed modifier keys (a combination of
628 * \c HID_KEYBOARD_MODIFER_* masks).
629 */
630 uint8_t Reserved; /**< Reserved for OEM use, always set to 0. */
631 uint8_t KeyCode[6]; /**< Key codes of the currently pressed keys. */
632 } ATTR_PACKED USB_KeyboardReport_Data_t;
633
634 /** Type define for the data type used to store HID report descriptor elements. */
635 typedef uint8_t USB_Descriptor_HIDReport_Datatype_t;
636
637 #endif
638
639 /** @} */
640
USB isp AVR programmer