Open FFBoard
Open source force feedback firmware
hid_device.h
Go to the documentation of this file.
1/*
2 * The MIT License (MIT)
3 *
4 * Copyright (c) 2019 Ha Thach (tinyusb.org)
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 * THE SOFTWARE.
23 *
24 * This file is part of the TinyUSB stack.
25 */
26
27#ifndef TUSB_HID_DEVICE_H_
28#define TUSB_HID_DEVICE_H_
29
30#include "hid.h"
31
32#ifdef __cplusplus
33 extern "C" {
34#endif
35
36//--------------------------------------------------------------------+
37// Class Driver Default Configure & Validation
38//--------------------------------------------------------------------+
39
40#if !defined(CFG_TUD_HID_EP_BUFSIZE) & defined(CFG_TUD_HID_BUFSIZE)
41 // TODO warn user to use new name later on
42 // #warning CFG_TUD_HID_BUFSIZE is renamed to CFG_TUD_HID_EP_BUFSIZE, please update to use the new name
43 #define CFG_TUD_HID_EP_BUFSIZE CFG_TUD_HID_BUFSIZE
44#endif
45
46#ifndef CFG_TUD_HID_EP_BUFSIZE
47 #define CFG_TUD_HID_EP_BUFSIZE 64
48#endif
49
50//--------------------------------------------------------------------+
51// Application API (Multiple Instances) i.e. CFG_TUD_HID > 1
52//--------------------------------------------------------------------+
53
54// Check if the interface is ready to use
55bool tud_hid_n_ready(uint8_t instance);
56
57// Get interface supported protocol (bInterfaceProtocol) check out hid_interface_protocol_enum_t for possible values
58uint8_t tud_hid_n_interface_protocol(uint8_t instance);
59
60// Get current active protocol: HID_PROTOCOL_BOOT (0) or HID_PROTOCOL_REPORT (1)
61uint8_t tud_hid_n_get_protocol(uint8_t instance);
62
63// Send report to host
64bool tud_hid_n_report(uint8_t instance, uint8_t report_id, void const* report, uint16_t len);
65
66// KEYBOARD: convenient helper to send keyboard report if application
67// use template layout report as defined by hid_keyboard_report_t
68bool tud_hid_n_keyboard_report(uint8_t instance, uint8_t report_id, uint8_t modifier, const uint8_t keycode[6]);
69
70// MOUSE: convenient helper to send mouse report if application
71// use template layout report as defined by hid_mouse_report_t
72bool tud_hid_n_mouse_report(uint8_t instance, uint8_t report_id, uint8_t buttons, int8_t x, int8_t y, int8_t vertical, int8_t horizontal);
73
74// ABSOLUTE MOUSE: convenient helper to send absolute mouse report if application
75// use template layout report as defined by hid_abs_mouse_report_t
76bool tud_hid_n_abs_mouse_report(uint8_t instance, uint8_t report_id, uint8_t buttons, int16_t x, int16_t y, int8_t vertical, int8_t horizontal);
77
78// Gamepad: convenient helper to send gamepad report if application
79// use template layout report TUD_HID_REPORT_DESC_GAMEPAD
80bool tud_hid_n_gamepad_report(uint8_t instance, uint8_t report_id, int8_t x, int8_t y, int8_t z, int8_t rz, int8_t rx, int8_t ry, uint8_t hat, uint32_t buttons);
81
82//--------------------------------------------------------------------+
83// Application API (Single Port)
84//--------------------------------------------------------------------+
85TU_ATTR_ALWAYS_INLINE static inline bool tud_hid_ready(void) {
86 return tud_hid_n_ready(0);
87}
88
89TU_ATTR_ALWAYS_INLINE static inline uint8_t tud_hid_interface_protocol(void) {
90 return tud_hid_n_interface_protocol(0);
91}
92
93TU_ATTR_ALWAYS_INLINE static inline uint8_t tud_hid_get_protocol(void) {
94 return tud_hid_n_get_protocol(0);
95}
96
97TU_ATTR_ALWAYS_INLINE static inline bool tud_hid_report(uint8_t report_id, void const* report, uint16_t len) {
98 return tud_hid_n_report(0, report_id, report, len);
99}
100
101TU_ATTR_ALWAYS_INLINE static inline bool tud_hid_keyboard_report(uint8_t report_id, uint8_t modifier, const uint8_t keycode[6]) {
102 return tud_hid_n_keyboard_report(0, report_id, modifier, keycode);
103}
104
105TU_ATTR_ALWAYS_INLINE static inline bool tud_hid_mouse_report(uint8_t report_id, uint8_t buttons, int8_t x, int8_t y, int8_t vertical, int8_t horizontal) {
106 return tud_hid_n_mouse_report(0, report_id, buttons, x, y, vertical, horizontal);
107}
108
109TU_ATTR_ALWAYS_INLINE static inline bool tud_hid_abs_mouse_report(uint8_t report_id, uint8_t buttons, int16_t x, int16_t y, int8_t vertical, int8_t horizontal) {
110 return tud_hid_n_abs_mouse_report(0, report_id, buttons, x, y, vertical, horizontal);
111}
112
113TU_ATTR_ALWAYS_INLINE static inline bool tud_hid_gamepad_report(uint8_t report_id, int8_t x, int8_t y, int8_t z, int8_t rz, int8_t rx, int8_t ry, uint8_t hat, uint32_t buttons) {
114 return tud_hid_n_gamepad_report(0, report_id, x, y, z, rz, rx, ry, hat, buttons);
115}
116
117//--------------------------------------------------------------------+
118// Application Callbacks
119//--------------------------------------------------------------------+
120
121// Invoked when received GET HID REPORT DESCRIPTOR request
122// Application return pointer to descriptor, whose contents must exist long enough for transfer to complete
123uint8_t const * tud_hid_descriptor_report_cb(uint8_t instance);
124
125// Invoked when received GET_REPORT control request
126// Application must fill buffer report's content and return its length.
127// Return zero will cause the stack to STALL request
128uint16_t tud_hid_get_report_cb(uint8_t instance, uint8_t report_id, hid_report_type_t report_type, uint8_t* buffer, uint16_t reqlen);
129
130// Invoked when received SET_REPORT control request or
131// received data on OUT endpoint (Report ID = 0, Type = OUTPUT)
132void tud_hid_set_report_cb(uint8_t instance, uint8_t report_id, hid_report_type_t report_type, uint8_t const* buffer, uint16_t bufsize);
133
134// Invoked when received SET_PROTOCOL request
135// protocol is either HID_PROTOCOL_BOOT (0) or HID_PROTOCOL_REPORT (1)
136void tud_hid_set_protocol_cb(uint8_t instance, uint8_t protocol);
137
138// Invoked when received SET_IDLE request. return false will stall the request
139// - Idle Rate = 0 : only send report if there is changes, i.e. skip duplication
140// - Idle Rate > 0 : skip duplication, but send at least 1 report every idle rate (in unit of 4 ms).
141bool tud_hid_set_idle_cb(uint8_t instance, uint8_t idle_rate);
142
143// Invoked when sent REPORT successfully to host
144// Application can use this to send the next report
145// Note: For composite reports, report[0] is report ID
146void tud_hid_report_complete_cb(uint8_t instance, uint8_t const* report, uint16_t len);
147
148// Invoked when a transfer wasn't successful
149void tud_hid_report_failed_cb(uint8_t instance, hid_report_type_t report_type, uint8_t const* report, uint16_t xferred_bytes);
150
151/* --------------------------------------------------------------------+
152 * HID Report Descriptor Template
153 *
154 * Convenient for declaring popular HID device (keyboard, mouse, consumer,
155 * gamepad etc...). Templates take "HID_REPORT_ID(n)" as input, leave
156 * empty if multiple reports is not used
157 *
158 * - Only 1 report: no parameter
159 * uint8_t const report_desc[] = { TUD_HID_REPORT_DESC_KEYBOARD() };
160 *
161 * - Multiple Reports: "HID_REPORT_ID(ID)" must be passed to template
162 * uint8_t const report_desc[] =
163 * {
164 * TUD_HID_REPORT_DESC_KEYBOARD( HID_REPORT_ID(1) ) ,
165 * TUD_HID_REPORT_DESC_MOUSE ( HID_REPORT_ID(2) )
166 * };
167 *--------------------------------------------------------------------*/
168
169// Keyboard Report Descriptor Template
170#define TUD_HID_REPORT_DESC_KEYBOARD(...) \
171 HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP ) ,\
172 HID_USAGE ( HID_USAGE_DESKTOP_KEYBOARD ) ,\
173 HID_COLLECTION ( HID_COLLECTION_APPLICATION ) ,\
174 /* Report ID if any */\
175 __VA_ARGS__ \
176 /* 8 bits Modifier Keys (Shift, Control, Alt) */ \
177 HID_USAGE_PAGE ( HID_USAGE_PAGE_KEYBOARD ) ,\
178 HID_USAGE_MIN ( 224 ) ,\
179 HID_USAGE_MAX ( 231 ) ,\
180 HID_LOGICAL_MIN ( 0 ) ,\
181 HID_LOGICAL_MAX ( 1 ) ,\
182 HID_REPORT_COUNT ( 8 ) ,\
183 HID_REPORT_SIZE ( 1 ) ,\
184 HID_INPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\
185 /* 8 bit reserved */ \
186 HID_REPORT_COUNT ( 1 ) ,\
187 HID_REPORT_SIZE ( 8 ) ,\
188 HID_INPUT ( HID_CONSTANT ) ,\
189 /* Output 5-bit LED Indicator Kana | Compose | ScrollLock | CapsLock | NumLock */ \
190 HID_USAGE_PAGE ( HID_USAGE_PAGE_LED ) ,\
191 HID_USAGE_MIN ( 1 ) ,\
192 HID_USAGE_MAX ( 5 ) ,\
193 HID_REPORT_COUNT ( 5 ) ,\
194 HID_REPORT_SIZE ( 1 ) ,\
195 HID_OUTPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\
196 /* led padding */ \
197 HID_REPORT_COUNT ( 1 ) ,\
198 HID_REPORT_SIZE ( 3 ) ,\
199 HID_OUTPUT ( HID_CONSTANT ) ,\
200 /* 6-byte Keycodes */ \
201 HID_USAGE_PAGE ( HID_USAGE_PAGE_KEYBOARD ) ,\
202 HID_USAGE_MIN ( 0 ) ,\
203 HID_USAGE_MAX_N ( 255, 2 ) ,\
204 HID_LOGICAL_MIN ( 0 ) ,\
205 HID_LOGICAL_MAX_N( 255, 2 ) ,\
206 HID_REPORT_COUNT ( 6 ) ,\
207 HID_REPORT_SIZE ( 8 ) ,\
208 HID_INPUT ( HID_DATA | HID_ARRAY | HID_ABSOLUTE ) ,\
209 HID_COLLECTION_END \
210
211// Mouse Report Descriptor Template
212#define TUD_HID_REPORT_DESC_MOUSE(...) \
213 HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP ) ,\
214 HID_USAGE ( HID_USAGE_DESKTOP_MOUSE ) ,\
215 HID_COLLECTION ( HID_COLLECTION_APPLICATION ) ,\
216 /* Report ID if any */\
217 __VA_ARGS__ \
218 HID_USAGE ( HID_USAGE_DESKTOP_POINTER ) ,\
219 HID_COLLECTION ( HID_COLLECTION_PHYSICAL ) ,\
220 HID_USAGE_PAGE ( HID_USAGE_PAGE_BUTTON ) ,\
221 HID_USAGE_MIN ( 1 ) ,\
222 HID_USAGE_MAX ( 5 ) ,\
223 HID_LOGICAL_MIN ( 0 ) ,\
224 HID_LOGICAL_MAX ( 1 ) ,\
225 /* Left, Right, Middle, Backward, Forward buttons */ \
226 HID_REPORT_COUNT( 5 ) ,\
227 HID_REPORT_SIZE ( 1 ) ,\
228 HID_INPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\
229 /* 3 bit padding */ \
230 HID_REPORT_COUNT( 1 ) ,\
231 HID_REPORT_SIZE ( 3 ) ,\
232 HID_INPUT ( HID_CONSTANT ) ,\
233 HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP ) ,\
234 /* X, Y position [-127, 127] */ \
235 HID_USAGE ( HID_USAGE_DESKTOP_X ) ,\
236 HID_USAGE ( HID_USAGE_DESKTOP_Y ) ,\
237 HID_LOGICAL_MIN ( 0x81 ) ,\
238 HID_LOGICAL_MAX ( 0x7f ) ,\
239 HID_REPORT_COUNT( 2 ) ,\
240 HID_REPORT_SIZE ( 8 ) ,\
241 HID_INPUT ( HID_DATA | HID_VARIABLE | HID_RELATIVE ) ,\
242 /* Verital wheel scroll [-127, 127] */ \
243 HID_USAGE ( HID_USAGE_DESKTOP_WHEEL ) ,\
244 HID_LOGICAL_MIN ( 0x81 ) ,\
245 HID_LOGICAL_MAX ( 0x7f ) ,\
246 HID_REPORT_COUNT( 1 ) ,\
247 HID_REPORT_SIZE ( 8 ) ,\
248 HID_INPUT ( HID_DATA | HID_VARIABLE | HID_RELATIVE ) ,\
249 HID_USAGE_PAGE ( HID_USAGE_PAGE_CONSUMER ), \
250 /* Horizontal wheel scroll [-127, 127] */ \
251 HID_USAGE_N ( HID_USAGE_CONSUMER_AC_PAN, 2 ), \
252 HID_LOGICAL_MIN ( 0x81 ), \
253 HID_LOGICAL_MAX ( 0x7f ), \
254 HID_REPORT_COUNT( 1 ), \
255 HID_REPORT_SIZE ( 8 ), \
256 HID_INPUT ( HID_DATA | HID_VARIABLE | HID_RELATIVE ), \
257 HID_COLLECTION_END , \
258 HID_COLLECTION_END \
259
260// Absolute Mouse Report Descriptor Template
261#define TUD_HID_REPORT_DESC_ABSMOUSE(...) \
262 HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP ) ,\
263 HID_USAGE ( HID_USAGE_DESKTOP_MOUSE ) ,\
264 HID_COLLECTION ( HID_COLLECTION_APPLICATION ) ,\
265 /* Report ID if any */\
266 __VA_ARGS__ \
267 HID_USAGE ( HID_USAGE_DESKTOP_POINTER ) ,\
268 HID_COLLECTION ( HID_COLLECTION_PHYSICAL ) ,\
269 HID_USAGE_PAGE ( HID_USAGE_PAGE_BUTTON ) ,\
270 HID_USAGE_MIN ( 1 ) ,\
271 HID_USAGE_MAX ( 5 ) ,\
272 HID_LOGICAL_MIN ( 0 ) ,\
273 HID_LOGICAL_MAX ( 1 ) ,\
274 /* Left, Right, Middle, Backward, Forward buttons */ \
275 HID_REPORT_COUNT( 5 ) ,\
276 HID_REPORT_SIZE ( 1 ) ,\
277 HID_INPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\
278 /* 3 bit padding */ \
279 HID_REPORT_COUNT( 1 ) ,\
280 HID_REPORT_SIZE ( 3 ) ,\
281 HID_INPUT ( HID_CONSTANT ) ,\
282 HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP ) ,\
283 /* X, Y absolute position [0, 32767] */ \
284 HID_USAGE ( HID_USAGE_DESKTOP_X ) ,\
285 HID_USAGE ( HID_USAGE_DESKTOP_Y ) ,\
286 HID_LOGICAL_MIN ( 0x00 ) ,\
287 HID_LOGICAL_MAX_N( 0x7FFF, 2 ) ,\
288 HID_REPORT_SIZE ( 16 ) ,\
289 HID_REPORT_COUNT ( 2 ) ,\
290 HID_INPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\
291 /* Vertical wheel scroll [-127, 127] */ \
292 HID_USAGE ( HID_USAGE_DESKTOP_WHEEL ) ,\
293 HID_LOGICAL_MIN ( 0x81 ) ,\
294 HID_LOGICAL_MAX ( 0x7f ) ,\
295 HID_REPORT_COUNT( 1 ) ,\
296 HID_REPORT_SIZE ( 8 ) ,\
297 HID_INPUT ( HID_DATA | HID_VARIABLE | HID_RELATIVE ) ,\
298 HID_USAGE_PAGE ( HID_USAGE_PAGE_CONSUMER ), \
299 /* Horizontal wheel scroll [-127, 127] */ \
300 HID_USAGE_N ( HID_USAGE_CONSUMER_AC_PAN, 2 ), \
301 HID_LOGICAL_MIN ( 0x81 ), \
302 HID_LOGICAL_MAX ( 0x7f ), \
303 HID_REPORT_COUNT( 1 ), \
304 HID_REPORT_SIZE ( 8 ), \
305 HID_INPUT ( HID_DATA | HID_VARIABLE | HID_RELATIVE ), \
306 HID_COLLECTION_END , \
307 HID_COLLECTION_END \
308
309// Consumer Control Report Descriptor Template
310#define TUD_HID_REPORT_DESC_CONSUMER(...) \
311 HID_USAGE_PAGE ( HID_USAGE_PAGE_CONSUMER ) ,\
312 HID_USAGE ( HID_USAGE_CONSUMER_CONTROL ) ,\
313 HID_COLLECTION ( HID_COLLECTION_APPLICATION ) ,\
314 /* Report ID if any */\
315 __VA_ARGS__ \
316 HID_LOGICAL_MIN ( 0x00 ) ,\
317 HID_LOGICAL_MAX_N( 0x03FF, 2 ) ,\
318 HID_USAGE_MIN ( 0x00 ) ,\
319 HID_USAGE_MAX_N ( 0x03FF, 2 ) ,\
320 HID_REPORT_COUNT ( 1 ) ,\
321 HID_REPORT_SIZE ( 16 ) ,\
322 HID_INPUT ( HID_DATA | HID_ARRAY | HID_ABSOLUTE ) ,\
323 HID_COLLECTION_END \
324
325/* System Control Report Descriptor Template
326 * 0x00 - do nothing
327 * 0x01 - Power Off
328 * 0x02 - Standby
329 * 0x03 - Wake Host
330 */
331#define TUD_HID_REPORT_DESC_SYSTEM_CONTROL(...) \
332 HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP ) ,\
333 HID_USAGE ( HID_USAGE_DESKTOP_SYSTEM_CONTROL ) ,\
334 HID_COLLECTION ( HID_COLLECTION_APPLICATION ) ,\
335 /* Report ID if any */\
336 __VA_ARGS__ \
337 /* 2 bit system power control */ \
338 HID_LOGICAL_MIN ( 1 ) ,\
339 HID_LOGICAL_MAX ( 3 ) ,\
340 HID_REPORT_COUNT ( 1 ) ,\
341 HID_REPORT_SIZE ( 2 ) ,\
342 HID_USAGE ( HID_USAGE_DESKTOP_SYSTEM_POWER_DOWN ) ,\
343 HID_USAGE ( HID_USAGE_DESKTOP_SYSTEM_SLEEP ) ,\
344 HID_USAGE ( HID_USAGE_DESKTOP_SYSTEM_WAKE_UP ) ,\
345 HID_INPUT ( HID_DATA | HID_ARRAY | HID_ABSOLUTE ) ,\
346 /* 6 bit padding */ \
347 HID_REPORT_COUNT ( 1 ) ,\
348 HID_REPORT_SIZE ( 6 ) ,\
349 HID_INPUT ( HID_CONSTANT ) ,\
350 HID_COLLECTION_END \
351
352// Gamepad Report Descriptor Template
353// with 32 buttons, 2 joysticks and 1 hat/dpad with following layout
354// | X | Y | Z | Rz | Rx | Ry (1 byte each) | hat/DPAD (1 byte) | Button Map (4 bytes) |
355#define TUD_HID_REPORT_DESC_GAMEPAD(...) \
356 HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP ) ,\
357 HID_USAGE ( HID_USAGE_DESKTOP_GAMEPAD ) ,\
358 HID_COLLECTION ( HID_COLLECTION_APPLICATION ) ,\
359 /* Report ID if any */\
360 __VA_ARGS__ \
361 /* 8 bit X, Y, Z, Rz, Rx, Ry (min -127, max 127 ) */ \
362 HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP ) ,\
363 HID_USAGE ( HID_USAGE_DESKTOP_X ) ,\
364 HID_USAGE ( HID_USAGE_DESKTOP_Y ) ,\
365 HID_USAGE ( HID_USAGE_DESKTOP_Z ) ,\
366 HID_USAGE ( HID_USAGE_DESKTOP_RZ ) ,\
367 HID_USAGE ( HID_USAGE_DESKTOP_RX ) ,\
368 HID_USAGE ( HID_USAGE_DESKTOP_RY ) ,\
369 HID_LOGICAL_MIN ( 0x81 ) ,\
370 HID_LOGICAL_MAX ( 0x7f ) ,\
371 HID_REPORT_COUNT ( 6 ) ,\
372 HID_REPORT_SIZE ( 8 ) ,\
373 HID_INPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\
374 /* 8 bit DPad/Hat Button Map */ \
375 HID_USAGE_PAGE ( HID_USAGE_PAGE_DESKTOP ) ,\
376 HID_USAGE ( HID_USAGE_DESKTOP_HAT_SWITCH ) ,\
377 HID_LOGICAL_MIN ( 1 ) ,\
378 HID_LOGICAL_MAX ( 8 ) ,\
379 HID_PHYSICAL_MIN ( 0 ) ,\
380 HID_PHYSICAL_MAX_N ( 315, 2 ) ,\
381 HID_REPORT_COUNT ( 1 ) ,\
382 HID_REPORT_SIZE ( 8 ) ,\
383 HID_INPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\
384 /* 32 bit Button Map */ \
385 HID_USAGE_PAGE ( HID_USAGE_PAGE_BUTTON ) ,\
386 HID_USAGE_MIN ( 1 ) ,\
387 HID_USAGE_MAX ( 32 ) ,\
388 HID_LOGICAL_MIN ( 0 ) ,\
389 HID_LOGICAL_MAX ( 1 ) ,\
390 HID_REPORT_COUNT ( 32 ) ,\
391 HID_REPORT_SIZE ( 1 ) ,\
392 HID_INPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\
393 HID_COLLECTION_END \
394
395// FIDO U2F Authenticator Descriptor Template
396// - 1st parameter is report size, which is 64 bytes maximum in U2F
397// - 2nd parameter is HID_REPORT_ID(n) (optional)
398#define TUD_HID_REPORT_DESC_FIDO_U2F(report_size, ...) \
399 HID_USAGE_PAGE_N ( HID_USAGE_PAGE_FIDO, 2 ) ,\
400 HID_USAGE ( HID_USAGE_FIDO_U2FHID ) ,\
401 HID_COLLECTION ( HID_COLLECTION_APPLICATION ) ,\
402 /* Report ID if any */ \
403 __VA_ARGS__ \
404 /* Usage Data In */ \
405 HID_USAGE ( HID_USAGE_FIDO_DATA_IN ) ,\
406 HID_LOGICAL_MIN ( 0 ) ,\
407 HID_LOGICAL_MAX_N ( 0xff, 2 ) ,\
408 HID_REPORT_SIZE ( 8 ) ,\
409 HID_REPORT_COUNT ( report_size ) ,\
410 HID_INPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\
411 /* Usage Data Out */ \
412 HID_USAGE ( HID_USAGE_FIDO_DATA_OUT ) ,\
413 HID_LOGICAL_MIN ( 0 ) ,\
414 HID_LOGICAL_MAX_N ( 0xff, 2 ) ,\
415 HID_REPORT_SIZE ( 8 ) ,\
416 HID_REPORT_COUNT ( report_size ) ,\
417 HID_OUTPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\
418 HID_COLLECTION_END \
419
420// HID Generic Input & Output
421// - 1st parameter is report size (mandatory)
422// - 2nd parameter is report id HID_REPORT_ID(n) (optional)
423#define TUD_HID_REPORT_DESC_GENERIC_INOUT(report_size, ...) \
424 HID_USAGE_PAGE_N ( HID_USAGE_PAGE_VENDOR, 2 ),\
425 HID_USAGE ( 0x01 ),\
426 HID_COLLECTION ( HID_COLLECTION_APPLICATION ),\
427 /* Report ID if any */\
428 __VA_ARGS__ \
429 /* Input */ \
430 HID_USAGE ( 0x02 ),\
431 HID_LOGICAL_MIN ( 0x00 ),\
432 HID_LOGICAL_MAX_N ( 0xff, 2 ),\
433 HID_REPORT_SIZE ( 8 ),\
434 HID_REPORT_COUNT( report_size ),\
435 HID_INPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\
436 /* Output */ \
437 HID_USAGE ( 0x03 ),\
438 HID_LOGICAL_MIN ( 0x00 ),\
439 HID_LOGICAL_MAX_N ( 0xff, 2 ),\
440 HID_REPORT_SIZE ( 8 ),\
441 HID_REPORT_COUNT( report_size ),\
442 HID_OUTPUT ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\
443 HID_COLLECTION_END \
444
445// HID Lighting and Illumination Report Descriptor Template
446// - 1st parameter is report id (required)
447// Creates 6 report ids for lighting HID usages in the following order:
448// report_id+0: HID_USAGE_LIGHTING_LAMP_ARRAY_ATTRIBUTES_REPORT
449// report_id+1: HID_USAGE_LIGHTING_LAMP_ATTRIBUTES_REQUEST_REPORT
450// report_id+2: HID_USAGE_LIGHTING_LAMP_ATTRIBUTES_RESPONSE_REPORT
451// report_id+3: HID_USAGE_LIGHTING_LAMP_MULTI_UPDATE_REPORT
452// report_id+4: HID_USAGE_LIGHTING_LAMP_RANGE_UPDATE_REPORT
453// report_id+5: HID_USAGE_LIGHTING_LAMP_ARRAY_CONTROL_REPORT
454#define TUD_HID_REPORT_DESC_LIGHTING(report_id) \
455 HID_USAGE_PAGE ( HID_USAGE_PAGE_LIGHTING_AND_ILLUMINATION ),\
456 HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ARRAY ),\
457 HID_COLLECTION ( HID_COLLECTION_APPLICATION ),\
458 /* Lamp Array Attributes Report */ \
459 HID_REPORT_ID (report_id ) \
460 HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ARRAY_ATTRIBUTES_REPORT ),\
461 HID_COLLECTION ( HID_COLLECTION_LOGICAL ),\
462 HID_USAGE ( HID_USAGE_LIGHTING_LAMP_COUNT ),\
463 HID_LOGICAL_MIN ( 0 ),\
464 HID_LOGICAL_MAX_N ( 65535, 3 ),\
465 HID_REPORT_SIZE ( 16 ),\
466 HID_REPORT_COUNT ( 1 ),\
467 HID_FEATURE ( HID_CONSTANT | HID_VARIABLE | HID_ABSOLUTE ),\
468 HID_USAGE ( HID_USAGE_LIGHTING_BOUNDING_BOX_WIDTH_IN_MICROMETERS ),\
469 HID_USAGE ( HID_USAGE_LIGHTING_BOUNDING_BOX_HEIGHT_IN_MICROMETERS ),\
470 HID_USAGE ( HID_USAGE_LIGHTING_BOUNDING_BOX_DEPTH_IN_MICROMETERS ),\
471 HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ARRAY_KIND ),\
472 HID_USAGE ( HID_USAGE_LIGHTING_MIN_UPDATE_INTERVAL_IN_MICROSECONDS ),\
473 HID_LOGICAL_MIN ( 0 ),\
474 HID_LOGICAL_MAX_N ( 2147483647, 3 ),\
475 HID_REPORT_SIZE ( 32 ),\
476 HID_REPORT_COUNT ( 5 ),\
477 HID_FEATURE ( HID_CONSTANT | HID_VARIABLE | HID_ABSOLUTE ),\
478 HID_COLLECTION_END ,\
479 /* Lamp Attributes Request Report */ \
480 HID_REPORT_ID ( report_id + 1 ) \
481 HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ATTRIBUTES_REQUEST_REPORT ),\
482 HID_COLLECTION ( HID_COLLECTION_LOGICAL ),\
483 HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ID ),\
484 HID_LOGICAL_MIN ( 0 ),\
485 HID_LOGICAL_MAX_N ( 65535, 3 ),\
486 HID_REPORT_SIZE ( 16 ),\
487 HID_REPORT_COUNT ( 1 ),\
488 HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\
489 HID_COLLECTION_END ,\
490 /* Lamp Attributes Response Report */ \
491 HID_REPORT_ID ( report_id + 2 ) \
492 HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ATTRIBUTES_RESPONSE_REPORT ),\
493 HID_COLLECTION ( HID_COLLECTION_LOGICAL ),\
494 HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ID ),\
495 HID_LOGICAL_MIN ( 0 ),\
496 HID_LOGICAL_MAX_N ( 65535, 3 ),\
497 HID_REPORT_SIZE ( 16 ),\
498 HID_REPORT_COUNT ( 1 ),\
499 HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\
500 HID_USAGE ( HID_USAGE_LIGHTING_POSITION_X_IN_MICROMETERS ),\
501 HID_USAGE ( HID_USAGE_LIGHTING_POSITION_Y_IN_MICROMETERS ),\
502 HID_USAGE ( HID_USAGE_LIGHTING_POSITION_Z_IN_MICROMETERS ),\
503 HID_USAGE ( HID_USAGE_LIGHTING_UPDATE_LATENCY_IN_MICROSECONDS ),\
504 HID_USAGE ( HID_USAGE_LIGHTING_LAMP_PURPOSES ),\
505 HID_LOGICAL_MIN ( 0 ),\
506 HID_LOGICAL_MAX_N ( 2147483647, 3 ),\
507 HID_REPORT_SIZE ( 32 ),\
508 HID_REPORT_COUNT ( 5 ),\
509 HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\
510 HID_USAGE ( HID_USAGE_LIGHTING_RED_LEVEL_COUNT ),\
511 HID_USAGE ( HID_USAGE_LIGHTING_GREEN_LEVEL_COUNT ),\
512 HID_USAGE ( HID_USAGE_LIGHTING_BLUE_LEVEL_COUNT ),\
513 HID_USAGE ( HID_USAGE_LIGHTING_INTENSITY_LEVEL_COUNT ),\
514 HID_USAGE ( HID_USAGE_LIGHTING_IS_PROGRAMMABLE ),\
515 HID_USAGE ( HID_USAGE_LIGHTING_INPUT_BINDING ),\
516 HID_LOGICAL_MIN ( 0 ),\
517 HID_LOGICAL_MAX_N ( 255, 2 ),\
518 HID_REPORT_SIZE ( 8 ),\
519 HID_REPORT_COUNT ( 6 ),\
520 HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\
521 HID_COLLECTION_END ,\
522 /* Lamp Multi-Update Report */ \
523 HID_REPORT_ID ( report_id + 3 ) \
524 HID_USAGE ( HID_USAGE_LIGHTING_LAMP_MULTI_UPDATE_REPORT ),\
525 HID_COLLECTION ( HID_COLLECTION_LOGICAL ),\
526 HID_USAGE ( HID_USAGE_LIGHTING_LAMP_COUNT ),\
527 HID_USAGE ( HID_USAGE_LIGHTING_LAMP_UPDATE_FLAGS ),\
528 HID_LOGICAL_MIN ( 0 ),\
529 HID_LOGICAL_MAX ( 8 ),\
530 HID_REPORT_SIZE ( 8 ),\
531 HID_REPORT_COUNT ( 2 ),\
532 HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\
533 HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ID ),\
534 HID_LOGICAL_MIN ( 0 ),\
535 HID_LOGICAL_MAX_N ( 65535, 3 ),\
536 HID_REPORT_SIZE ( 16 ),\
537 HID_REPORT_COUNT ( 8 ),\
538 HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\
539 HID_USAGE ( HID_USAGE_LIGHTING_RED_UPDATE_CHANNEL ),\
540 HID_USAGE ( HID_USAGE_LIGHTING_GREEN_UPDATE_CHANNEL ),\
541 HID_USAGE ( HID_USAGE_LIGHTING_BLUE_UPDATE_CHANNEL ),\
542 HID_USAGE ( HID_USAGE_LIGHTING_INTENSITY_UPDATE_CHANNEL ),\
543 HID_USAGE ( HID_USAGE_LIGHTING_RED_UPDATE_CHANNEL ),\
544 HID_USAGE ( HID_USAGE_LIGHTING_GREEN_UPDATE_CHANNEL ),\
545 HID_USAGE ( HID_USAGE_LIGHTING_BLUE_UPDATE_CHANNEL ),\
546 HID_USAGE ( HID_USAGE_LIGHTING_INTENSITY_UPDATE_CHANNEL ),\
547 HID_USAGE ( HID_USAGE_LIGHTING_RED_UPDATE_CHANNEL ),\
548 HID_USAGE ( HID_USAGE_LIGHTING_GREEN_UPDATE_CHANNEL ),\
549 HID_USAGE ( HID_USAGE_LIGHTING_BLUE_UPDATE_CHANNEL ),\
550 HID_USAGE ( HID_USAGE_LIGHTING_INTENSITY_UPDATE_CHANNEL ),\
551 HID_USAGE ( HID_USAGE_LIGHTING_RED_UPDATE_CHANNEL ),\
552 HID_USAGE ( HID_USAGE_LIGHTING_GREEN_UPDATE_CHANNEL ),\
553 HID_USAGE ( HID_USAGE_LIGHTING_BLUE_UPDATE_CHANNEL ),\
554 HID_USAGE ( HID_USAGE_LIGHTING_INTENSITY_UPDATE_CHANNEL ),\
555 HID_USAGE ( HID_USAGE_LIGHTING_RED_UPDATE_CHANNEL ),\
556 HID_USAGE ( HID_USAGE_LIGHTING_GREEN_UPDATE_CHANNEL ),\
557 HID_USAGE ( HID_USAGE_LIGHTING_BLUE_UPDATE_CHANNEL ),\
558 HID_USAGE ( HID_USAGE_LIGHTING_INTENSITY_UPDATE_CHANNEL ),\
559 HID_USAGE ( HID_USAGE_LIGHTING_RED_UPDATE_CHANNEL ),\
560 HID_USAGE ( HID_USAGE_LIGHTING_GREEN_UPDATE_CHANNEL ),\
561 HID_USAGE ( HID_USAGE_LIGHTING_BLUE_UPDATE_CHANNEL ),\
562 HID_USAGE ( HID_USAGE_LIGHTING_INTENSITY_UPDATE_CHANNEL ),\
563 HID_USAGE ( HID_USAGE_LIGHTING_RED_UPDATE_CHANNEL ),\
564 HID_USAGE ( HID_USAGE_LIGHTING_GREEN_UPDATE_CHANNEL ),\
565 HID_USAGE ( HID_USAGE_LIGHTING_BLUE_UPDATE_CHANNEL ),\
566 HID_USAGE ( HID_USAGE_LIGHTING_INTENSITY_UPDATE_CHANNEL ),\
567 HID_USAGE ( HID_USAGE_LIGHTING_RED_UPDATE_CHANNEL ),\
568 HID_USAGE ( HID_USAGE_LIGHTING_GREEN_UPDATE_CHANNEL ),\
569 HID_USAGE ( HID_USAGE_LIGHTING_BLUE_UPDATE_CHANNEL ),\
570 HID_USAGE ( HID_USAGE_LIGHTING_INTENSITY_UPDATE_CHANNEL ),\
571 HID_LOGICAL_MIN ( 0 ),\
572 HID_LOGICAL_MAX_N ( 255, 2 ),\
573 HID_REPORT_SIZE ( 8 ),\
574 HID_REPORT_COUNT ( 32 ),\
575 HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\
576 HID_COLLECTION_END ,\
577 /* Lamp Range Update Report */ \
578 HID_REPORT_ID ( report_id + 4 ) \
579 HID_USAGE ( HID_USAGE_LIGHTING_LAMP_RANGE_UPDATE_REPORT ),\
580 HID_COLLECTION ( HID_COLLECTION_LOGICAL ),\
581 HID_USAGE ( HID_USAGE_LIGHTING_LAMP_UPDATE_FLAGS ),\
582 HID_LOGICAL_MIN ( 0 ),\
583 HID_LOGICAL_MAX ( 8 ),\
584 HID_REPORT_SIZE ( 8 ),\
585 HID_REPORT_COUNT ( 1 ),\
586 HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\
587 HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ID_START ),\
588 HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ID_END ),\
589 HID_LOGICAL_MIN ( 0 ),\
590 HID_LOGICAL_MAX_N ( 65535, 3 ),\
591 HID_REPORT_SIZE ( 16 ),\
592 HID_REPORT_COUNT ( 2 ),\
593 HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\
594 HID_USAGE ( HID_USAGE_LIGHTING_RED_UPDATE_CHANNEL ),\
595 HID_USAGE ( HID_USAGE_LIGHTING_GREEN_UPDATE_CHANNEL ),\
596 HID_USAGE ( HID_USAGE_LIGHTING_BLUE_UPDATE_CHANNEL ),\
597 HID_USAGE ( HID_USAGE_LIGHTING_INTENSITY_UPDATE_CHANNEL ),\
598 HID_LOGICAL_MIN ( 0 ),\
599 HID_LOGICAL_MAX_N ( 255, 2 ),\
600 HID_REPORT_SIZE ( 8 ),\
601 HID_REPORT_COUNT ( 4 ),\
602 HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\
603 HID_COLLECTION_END ,\
604 /* Lamp Array Control Report */ \
605 HID_REPORT_ID ( report_id + 5 ) \
606 HID_USAGE ( HID_USAGE_LIGHTING_LAMP_ARRAY_CONTROL_REPORT ),\
607 HID_COLLECTION ( HID_COLLECTION_LOGICAL ),\
608 HID_USAGE ( HID_USAGE_LIGHTING_AUTONOMOUS_MODE ),\
609 HID_LOGICAL_MIN ( 0 ),\
610 HID_LOGICAL_MAX ( 1 ),\
611 HID_REPORT_SIZE ( 8 ),\
612 HID_REPORT_COUNT ( 1 ),\
613 HID_FEATURE ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ),\
614 HID_COLLECTION_END ,\
615 HID_COLLECTION_END \
616
617//--------------------------------------------------------------------+
618// Internal Class Driver API
619//--------------------------------------------------------------------+
620void hidd_init (void);
621bool hidd_deinit (void);
622void hidd_reset (uint8_t rhport);
623uint16_t hidd_open (uint8_t rhport, tusb_desc_interface_t const * itf_desc, uint16_t max_len);
624bool hidd_control_xfer_cb (uint8_t rhport, uint8_t stage, tusb_control_request_t const * request);
625bool hidd_xfer_cb (uint8_t rhport, uint8_t ep_addr, xfer_result_t event, uint32_t xferred_bytes);
626
627#ifdef __cplusplus
628 }
629#endif
630
631#endif
hid_report_type_t
hid_report_type_t
HID Request Report Type.
Definition: hid.h:85
tud_hid_n_ready
bool tud_hid_n_ready(uint8_t instance)
Definition: hid_device.c:104
hidd_reset
void hidd_reset(uint8_t rhport)
Definition: hid_device.c:203
tud_hid_set_idle_cb
bool tud_hid_set_idle_cb(uint8_t instance, uint8_t idle_rate)
Definition: hid_device.c:81
hidd_init
void hidd_init(void)
Definition: hid_device.c:195
tud_hid_mouse_report
static TU_ATTR_ALWAYS_INLINE bool tud_hid_mouse_report(uint8_t report_id, uint8_t buttons, int8_t x, int8_t y, int8_t vertical, int8_t horizontal)
Definition: hid_device.h:105
tud_hid_set_protocol_cb
void tud_hid_set_protocol_cb(uint8_t instance, uint8_t protocol)
Definition: hid_device.c:76
tud_hid_abs_mouse_report
static TU_ATTR_ALWAYS_INLINE bool tud_hid_abs_mouse_report(uint8_t report_id, uint8_t buttons, int16_t x, int16_t y, int8_t vertical, int8_t horizontal)
Definition: hid_device.h:109
tud_hid_keyboard_report
static TU_ATTR_ALWAYS_INLINE bool tud_hid_keyboard_report(uint8_t report_id, uint8_t modifier, const uint8_t keycode[6])
Definition: hid_device.h:101
tud_hid_n_mouse_report
bool tud_hid_n_mouse_report(uint8_t instance, uint8_t report_id, uint8_t buttons, int8_t x, int8_t y, int8_t vertical, int8_t horizontal)
Definition: hid_device.c:151
tud_hid_get_report_cb
uint16_t tud_hid_get_report_cb(uint8_t instance, uint8_t report_id, hid_report_type_t report_type, uint8_t *buffer, uint16_t reqlen)
Definition: global_callbacks.cpp:331
tud_hid_get_protocol
static TU_ATTR_ALWAYS_INLINE uint8_t tud_hid_get_protocol(void)
Definition: hid_device.h:93
hidd_xfer_cb
bool hidd_xfer_cb(uint8_t rhport, uint8_t ep_addr, xfer_result_t event, uint32_t xferred_bytes)
Definition: hid_device.c:373
tud_hid_n_get_protocol
uint8_t tud_hid_n_get_protocol(uint8_t instance)
Definition: hid_device.c:133
tud_hid_report
static TU_ATTR_ALWAYS_INLINE bool tud_hid_report(uint8_t report_id, void const *report, uint16_t len)
Definition: hid_device.h:97
tud_hid_n_interface_protocol
uint8_t tud_hid_n_interface_protocol(uint8_t instance)
Definition: hid_device.c:129
tud_hid_descriptor_report_cb
uint8_t const * tud_hid_descriptor_report_cb(uint8_t instance)
Definition: global_callbacks.cpp:290
tud_hid_report_complete_cb
void tud_hid_report_complete_cb(uint8_t instance, uint8_t const *report, uint16_t len)
Definition: hid_device.c:87
hidd_control_xfer_cb
bool hidd_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_request_t const *request)
Definition: hid_device.c:262
tud_hid_n_abs_mouse_report
bool tud_hid_n_abs_mouse_report(uint8_t instance, uint8_t report_id, uint8_t buttons, int16_t x, int16_t y, int8_t vertical, int8_t horizontal)
Definition: hid_device.c:164
tud_hid_set_report_cb
void tud_hid_set_report_cb(uint8_t instance, uint8_t report_id, hid_report_type_t report_type, uint8_t const *buffer, uint16_t bufsize)
Definition: global_callbacks.cpp:312
tud_hid_n_gamepad_report
bool tud_hid_n_gamepad_report(uint8_t instance, uint8_t report_id, int8_t x, int8_t y, int8_t z, int8_t rz, int8_t rx, int8_t ry, uint8_t hat, uint32_t buttons)
Definition: hid_device.c:176
hidd_deinit
bool hidd_deinit(void)
Definition: hid_device.c:199
tud_hid_n_keyboard_report
bool tud_hid_n_keyboard_report(uint8_t instance, uint8_t report_id, uint8_t modifier, const uint8_t keycode[6])
Definition: hid_device.c:137
tud_hid_gamepad_report
static TU_ATTR_ALWAYS_INLINE bool tud_hid_gamepad_report(uint8_t report_id, int8_t x, int8_t y, int8_t z, int8_t rz, int8_t rx, int8_t ry, uint8_t hat, uint32_t buttons)
Definition: hid_device.h:113
tud_hid_interface_protocol
static TU_ATTR_ALWAYS_INLINE uint8_t tud_hid_interface_protocol(void)
Definition: hid_device.h:89
tud_hid_ready
static TU_ATTR_ALWAYS_INLINE bool tud_hid_ready(void)
Definition: hid_device.h:85
tud_hid_report_failed_cb
void tud_hid_report_failed_cb(uint8_t instance, hid_report_type_t report_type, uint8_t const *report, uint16_t xferred_bytes)
Definition: hid_device.c:94
hidd_open
uint16_t hidd_open(uint8_t rhport, tusb_desc_interface_t const *itf_desc, uint16_t max_len)
Definition: hid_device.c:208
tud_hid_n_report
bool tud_hid_n_report(uint8_t instance, uint8_t report_id, void const *report, uint16_t len)
Definition: hid_device.c:110
buffer
uint8_t const * buffer
Definition: midi_device.h:100
bufsize
uint32_t bufsize
Definition: midi_device.h:95
TU_ATTR_PACKED
AUDIO Channel Cluster Descriptor (4.1)
Definition: audio.h:647
xfer_result_t
xfer_result_t
Definition: tusb_types.h:236
request
CFG_TUH_MEM_ALIGN tusb_control_request_t request
Definition: usbh.c:259
stage
volatile uint8_t stage
Definition: usbh.c:265