forked from arpruss/USBComposite_stm32f1
-
Notifications
You must be signed in to change notification settings - Fork 0
/
USBHID.h
706 lines (654 loc) · 28.5 KB
/
USBHID.h
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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
/* Copyright (c) 2011, Peter Barrett
**
** Permission to use, copy, modify, and/or distribute this software for
** any purpose with or without fee is hereby granted, provided that the
** above copyright notice and this permission notice appear in all copies.
**
** THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
** WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
** WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR
** BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES
** OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
** WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
** ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
** SOFTWARE.
*/
#ifndef _USBHID_H_
#define _USBHID_H_
#include <Print.h>
#include <boards.h>
#include "Stream.h"
#include "usb_hid.h"
#define HID_MAX_REPORT_CHUNKS 24
#define HID_REPORT_ID_NONE -1
#define HID_REPORT_ID_AUTO -2
#define HID_MOUSE_REPORT_ID 1
#define HID_KEYBOARD_REPORT_ID 2
#define HID_CONSUMER_REPORT_ID 3
#define HID_DIGITIZER_REPORT_ID 4
#define HID_JOYSTICK_REPORT_ID 20
#define HID_KEYBOARD_ROLLOVER 6
#define HID_AUTO_REPORT_ID_START 0x80
#define MACRO_GET_ARGUMENT_2(x, y, ...) y
#define MACRO_GET_ARGUMENT_1_WITH_DEFAULT(default, ...) MACRO_GET_ARGUMENT_2(placeholder, ## __VA_ARGS__, default)
#define MACRO_ARGUMENT_2_TO_END(skip, ...) __VA_ARGS__
// HIDBuffer_t data buffers must have even memory length because of how PMA transfers work
#define HID_DATA_BUFFER_SIZE(n) (((n)+1)/2*2)
/* note that featureSize must be 1 less than the buffer size for the feature,
since the latter must include the reportId */
/* this only works in a collection with a report_id */
#define HID_FEATURE_REPORT_DESCRIPTOR(dataSize) \
0x06, 0x00, 0xFF, /* USAGE_PAGE (Vendor Defined Page 1) */ \
0x09, 0x01, /* USAGE (Vendor Usage 1) */ \
0x15, 0x00, /* LOGICAL_MINIMUM (0) */ \
0x26, 0xff, 0x00, /* LOGICAL_MAXIMUM (255) */ \
0x75, 0x08, /* REPORT_SIZE (8) */ \
0x95, dataSize, /* REPORT_COUNT (xx) */ \
0xB1, 0x02, /* FEATURE (Data,Var,Abs) */ \
#define HID_OUTPUT_REPORT_DESCRIPTOR(dataSize) \
0x06, 0x00, 0xFF, /* USAGE_PAGE (Vendor Defined Page 1) */ \
0x09, 0x01, /* USAGE (Vendor Usage 1) */ \
0x15, 0x00, /* LOGICAL_MINIMUM (0) */ \
0x26, 0xff, 0x00, /* LOGICAL_MAXIMUM (255) */ \
0x75, 0x08, /* REPORT_SIZE (8) */ \
0x95, dataSize, /* REPORT_COUNT (32) */ \
0x91, 0x02, /* OUTPUT (Data,Var,Abs) */ \
#define HID_CONSUMER_REPORT_DESCRIPTOR(...) \
0x05, 0x0C, /* usage page (consumer device) */ \
0x09, 0x01, /* usage -- consumer control */ \
0xA1, 0x01, /* collection (application) */ \
0x85, MACRO_GET_ARGUMENT_1_WITH_DEFAULT(HID_CONSUMER_REPORT_ID, ## __VA_ARGS__), /* REPORT_ID */ \
0x15, 0x00, /* logical minimum */ \
0x26, 0xFF, 0x03, /* logical maximum (3ff) */ \
0x19, 0x00, /* usage minimum (0) */ \
0x2A, 0xFF, 0x03, /* usage maximum (3ff) */ \
0x75, 0x10, /* report size (16) */ \
0x95, 0x01, /* report count (1) */ \
0x81, 0x00, /* input */ \
MACRO_ARGUMENT_2_TO_END(__VA_ARGS__) \
0xC0 /* end collection */
#define HID_MOUSE_REPORT_DESCRIPTOR(...) \
0x05, 0x01, /* USAGE_PAGE (Generic Desktop) // 54 */ \
0x09, 0x02, /* USAGE (Mouse) */ \
0xa1, 0x01, /* COLLECTION (Application) */ \
0x85, MACRO_GET_ARGUMENT_1_WITH_DEFAULT(HID_MOUSE_REPORT_ID, ## __VA_ARGS__), /* REPORT_ID */ \
0x09, 0x01, /* USAGE (Pointer) */ \
0xa1, 0x00, /* COLLECTION (Physical) */ \
0x05, 0x09, /* USAGE_PAGE (Button) */ \
0x19, 0x01, /* USAGE_MINIMUM (Button 1) */ \
0x29, 0x08, /* USAGE_MAXIMUM (Button 8) */ \
0x15, 0x00, /* LOGICAL_MINIMUM (0) */ \
0x25, 0x01, /* LOGICAL_MAXIMUM (1) */ \
0x95, 0x08, /* REPORT_COUNT (8) */ \
0x75, 0x01, /* REPORT_SIZE (1) */ \
0x81, 0x02, /* INPUT (Data,Var,Abs) */ \
0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */ \
0x09, 0x30, /* USAGE (X) */ \
0x09, 0x31, /* USAGE (Y) */ \
0x09, 0x38, /* USAGE (Wheel) */ \
0x15, 0x81, /* LOGICAL_MINIMUM (-127) */ \
0x25, 0x7f, /* LOGICAL_MAXIMUM (127) */ \
0x75, 0x08, /* REPORT_SIZE (8) */ \
0x95, 0x03, /* REPORT_COUNT (3) */ \
0x81, 0x06, /* INPUT (Data,Var,Rel) */ \
0xc0, /* END_COLLECTION */ \
MACRO_ARGUMENT_2_TO_END(__VA_ARGS__) \
0xc0 /* END_COLLECTION */
#define HID_ABS_MOUSE_REPORT_DESCRIPTOR(...) \
0x05, 0x01, /* USAGE_PAGE (Generic Desktop) // 54 */ \
0x09, 0x02, /* USAGE (Mouse) */ \
0xa1, 0x01, /* COLLECTION (Application) */ \
0x85, MACRO_GET_ARGUMENT_1_WITH_DEFAULT(HID_MOUSE_REPORT_ID, ## __VA_ARGS__), /* REPORT_ID */ \
0x09, 0x01, /* USAGE (Pointer) */ \
0xa1, 0x00, /* COLLECTION (Physical) */ \
0x05, 0x09, /* USAGE_PAGE (Button) */ \
0x19, 0x01, /* USAGE_MINIMUM (Button 1) */ \
0x29, 0x08, /* USAGE_MAXIMUM (Button 8) */ \
0x15, 0x00, /* LOGICAL_MINIMUM (0) */ \
0x25, 0x01, /* LOGICAL_MAXIMUM (1) */ \
0x95, 0x08, /* REPORT_COUNT (8) */ \
0x75, 0x01, /* REPORT_SIZE (1) */ \
0x81, 0x02, /* INPUT (Data,Var,Abs) */ \
0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */ \
0x09, 0x30, /* USAGE (X) */ \
0x09, 0x31, /* USAGE (Y) */ \
0x16, 0x00, 0x80, /* LOGICAL_MINIMUM (-32768) */ \
0x26, 0xFF, 0x7f, /* LOGICAL_MAXIMUM (32767) */ \
0x75, 0x10, /* REPORT_SIZE (16) */ \
0x95, 0x02, /* REPORT_COUNT (2) */ \
0x81, 0x02, /* INPUT (Data,Var,Abs) */ \
0x09, 0x38, /* USAGE (Wheel) */ \
0x15, 0x81, /* LOGICAL_MINIMUM (-127) */ \
0x25, 0x7f, /* LOGICAL_MAXIMUM (127) */ \
0x75, 0x08, /* REPORT_SIZE (8) */ \
0x95, 0x01, /* REPORT_COUNT (1) */ \
0x81, 0x06, /* INPUT (Data,Var,Rel) */ \
0xc0, /* END_COLLECTION */ \
MACRO_ARGUMENT_2_TO_END(__VA_ARGS__) \
0xc0 /* END_COLLECTION */
#define HID_DIGITIZER_REPORT_DESCRIPTOR(...) \
/* based on https://stackoverflow.com/questions/46033581/what-is-a-correct-usbhidreportdescriptor-for-android and https://forum.pjrc.com/threads/48762-USB-mouse-touchscreen-with-Teensy3-2-for-Android */ \
0x05, 0x0d, /* USAGE_PAGE (Digitizer) */ \
/*0x09, 0x02, */ /* USAGE (Pen) */ \
0x09, 0x04, /* USAGE (Touch Screen) */ \
0xa1, 0x01, /* COLLECTION (Application) */ \
0x85, MACRO_GET_ARGUMENT_1_WITH_DEFAULT(HID_DIGITIZER_REPORT_ID, ## __VA_ARGS__), /* REPORT_ID */ \
/* declare a finger collection */ \
0x09, 0x20, /* Usage (Stylus) */ \
0xA1, 0x00, /* Collection (Physical) */ \
/* Declare a finger touch (finger up/down) */ \
0x09, 0x42, /* Usage (Tip Switch) */ \
0x09, 0x32, /* USAGE (In Range) */ \
0x15, 0x00, /* LOGICAL_MINIMUM (0) */ \
0x25, 0x01, /* LOGICAL_MAXIMUM (1) */ \
0x75, 0x01, /* REPORT_SIZE (1) */ \
0x95, 0x08, /* REPORT_COUNT (8) */ \
0x81, 0x02, /* INPUT (Data,Var,Abs) */ \
/* Define absolute X and Y coordinates of 12 bits each */ \
/* http://www.usb.org/developers/hidpage/Hut1_12v2.pdf */ \
0x05, 0x01, /* Usage Page (Generic Desktop) */ \
0x09, 0x01, /* Usage (Pointer) */ \
0xA1, 0x00, /* Collection (Physical) */ \
0x09, 0x30, /* Usage (X) */ \
0x09, 0x31, /* Usage (Y) */ \
0x16, 0x00, 0x00, /* Logical Minimum (0) */ \
0x26, 0xFF, 0x0F, /* Logical Maximum (4095) */ \
0x36, 0x00, 0x00, /* Physical Minimum (0) */ \
0x46, 0xFF, 0x0F, /* Physical Maximum (4095) */ \
0x66, 0x00, 0x00, /* UNIT (None) */ \
0x75, 0x0C, /* Report Size (12), */ \
0x95, 0x02, /* Report Count (2), */ \
0x81, 0x02, /* Input (Data,Var,Abs) */ \
0xc0, /* END_COLLECTION */ \
0xc0, /* END_COLLECTION */ \
MACRO_ARGUMENT_2_TO_END(__VA_ARGS__) \
0xc0 /* END_COLLECTION */
// With this declaration a data packet must be sent as:
// bits 0-7 -> "touch" state (bit 0 = pen up/down, bit 1 = In Range)
// bits 8-19 -> absolute X coordinate (0...4095)
// bits 20-31-> absolute Y coordinate (0...4095)
#define HID_KEYBOARD_REPORT_DESCRIPTOR(...) \
0x05, 0x01, /* USAGE_PAGE (Generic Desktop) // 47 */ \
0x09, 0x06, /* USAGE (Keyboard) */ \
0xa1, 0x01, /* COLLECTION (Application) */ \
0x85, MACRO_GET_ARGUMENT_1_WITH_DEFAULT(HID_KEYBOARD_REPORT_ID, ## __VA_ARGS__), /* REPORT_ID */ \
0x05, 0x07, /* USAGE_PAGE (Keyboard) */ \
0x19, 0xe0, /* USAGE_MINIMUM (Keyboard LeftControl) */ \
0x29, 0xe7, /* USAGE_MAXIMUM (Keyboard Right GUI) */ \
0x15, 0x00, /* LOGICAL_MINIMUM (0) */ \
0x25, 0x01, /* LOGICAL_MAXIMUM (1) */ \
0x75, 0x01, /* REPORT_SIZE (1) */ \
0x95, 0x08, /* REPORT_COUNT (8) */ \
0x81, 0x02, /* INPUT (Data,Var,Abs) */ \
\
0x95, 0x01, /* REPORT_COUNT (1) */ \
0x75, 0x08, /* REPORT_SIZE (8) */ \
0x81, 0x03, /* INPUT (Cnst,Var,Abs) */ \
\
0x95, HID_KEYBOARD_ROLLOVER, /* REPORT_COUNT (6) */ \
0x75, 0x08, /* REPORT_SIZE (8) */ \
0x15, 0x00, /* LOGICAL_MINIMUM (0) */ \
0x26, 0xDD, 0x00, /* LOGICAL_MAXIMUM (261) */ \
0x05, 0x07, /* USAGE_PAGE (Keyboard) */ \
\
0x19, 0x00, /* USAGE_MINIMUM (Reserved (no event indicated)) */ \
0x29, 0xDD, /* USAGE_MAXIMUM (Keypad Hexadecimal) */ \
0x81, 0x00, /* INPUT (Data,Ary,Abs) */ \
\
0x05, 0x08, /* USAGE_PAGE (LEDs) */ \
0x19, 0x01, /* USAGE_MINIMUM (Num Lock) */ \
0x29, 0x08, /* USAGE_MAXIMUM (Kana + 3 custom)*/ \
0x95, 0x08, /* REPORT_COUNT (8) */ \
0x75, 0x01, /* REPORT_SIZE (1) */ \
0x91, 0x02, /* OUTPUT (Data,Var,Abs) */ \
MACRO_ARGUMENT_2_TO_END(__VA_ARGS__) \
0xc0 /* END_COLLECTION */
#define HID_BOOT_KEYBOARD_REPORT_DESCRIPTOR(...) \
0x05, 0x01, /* USAGE_PAGE (Generic Desktop) // 47 */ \
0x09, 0x06, /* USAGE (Keyboard) */ \
0xa1, 0x01, /* COLLECTION (Application) */ \
0x05, 0x07, /* USAGE_PAGE (Keyboard) */ \
0x19, 0xe0, /* USAGE_MINIMUM (Keyboard LeftControl) */ \
0x29, 0xe7, /* USAGE_MAXIMUM (Keyboard Right GUI) */ \
0x15, 0x00, /* LOGICAL_MINIMUM (0) */ \
0x25, 0x01, /* LOGICAL_MAXIMUM (1) */ \
0x75, 0x01, /* REPORT_SIZE (1) */ \
0x95, 0x08, /* REPORT_COUNT (8) */ \
0x81, 0x02, /* INPUT (Data,Var,Abs) */ \
\
0x95, 0x01, /* REPORT_COUNT (1) */ \
0x75, 0x08, /* REPORT_SIZE (8) */ \
0x81, 0x03, /* INPUT (Cnst,Var,Abs) */ \
\
0x95, 0x06, /* REPORT_COUNT (6) */ \
0x75, 0x08, /* REPORT_SIZE (8) */ \
0x15, 0x00, /* LOGICAL_MINIMUM (0) */ \
0x25, 0x65, /* LOGICAL_MAXIMUM (101) */ \
0x05, 0x07, /* USAGE_PAGE (Keyboard) */ \
\
0x19, 0x00, /* USAGE_MINIMUM (Reserved (no event indicated)) */ \
0x29, 0x65, /* USAGE_MAXIMUM (Keyboard Application) */ \
0x81, 0x00, /* INPUT (Data,Ary,Abs) */ \
\
0x05, 0x08, /* USAGE_PAGE (LEDs) */ \
0x19, 0x01, /* USAGE_MINIMUM (Num Lock) */ \
0x29, 0x08, /* USAGE_MAXIMUM (Kana + 3 custom)*/ \
0x95, 0x08, /* REPORT_COUNT (8) */ \
0x75, 0x01, /* REPORT_SIZE (1) */ \
0x91, 0x02, /* OUTPUT (Data,Var,Abs) */ \
__VA_ARGS__ \
0xc0 /* END_COLLECTION */
#define HID_JOYSTICK_REPORT_DESCRIPTOR(...) \
0x05, 0x01, /* Usage Page (Generic Desktop) */ \
0x09, 0x04, /* Usage (Joystick) */ \
0xA1, 0x01, /* Collection (Application) */ \
0x85, MACRO_GET_ARGUMENT_1_WITH_DEFAULT(HID_JOYSTICK_REPORT_ID, ## __VA_ARGS__), /* REPORT_ID */ \
0x15, 0x00, /* Logical Minimum (0) */ \
0x25, 0x01, /* Logical Maximum (1) */ \
0x75, 0x01, /* Report Size (1) */ \
0x95, 0x20, /* Report Count (32) */ \
0x05, 0x09, /* Usage Page (Button) */ \
0x19, 0x01, /* Usage Minimum (Button #1) */ \
0x29, 0x20, /* Usage Maximum (Button #32) */ \
0x81, 0x02, /* Input (variable,absolute) */ \
0x15, 0x00, /* Logical Minimum (0) */ \
0x25, 0x07, /* Logical Maximum (7) */ \
0x35, 0x00, /* Physical Minimum (0) */ \
0x46, 0x3B, 0x01, /* Physical Maximum (315) */ \
0x75, 0x04, /* Report Size (4) */ \
0x95, 0x01, /* Report Count (1) */ \
0x65, 0x14, /* Unit (20) */ \
0x05, 0x01, /* Usage Page (Generic Desktop) */ \
0x09, 0x39, /* Usage (Hat switch) */ \
0x81, 0x42, /* Input (variable,absolute,null_state) */ \
0x05, 0x01, /* Usage Page (Generic Desktop) */ \
0x09, 0x01, /* Usage (Pointer) */ \
0xA1, 0x00, /* Collection () */ \
0x15, 0x00, /* Logical Minimum (0) */ \
0x26, 0xFF, 0x03, /* Logical Maximum (1023) */ \
0x75, 0x0A, /* Report Size (10) */ \
0x95, 0x04, /* Report Count (4) */ \
0x09, 0x30, /* Usage (X) */ \
0x09, 0x31, /* Usage (Y) */ \
0x09, 0x33, /* Usage (Rx) */ \
0x09, 0x34, /* Usage (Ry) */ \
0x81, 0x02, /* Input (variable,absolute) */ \
0xC0, /* End Collection */ \
0x15, 0x00, /* Logical Minimum (0) */ \
0x26, 0xFF, 0x03, /* Logical Maximum (1023) */ \
0x75, 0x0A, /* Report Size (10) */ \
0x95, 0x02, /* Report Count (2) */ \
0x09, 0x36, /* Usage (Slider) */ \
0x09, 0x36, /* Usage (Slider) */ \
0x81, 0x02, /* Input (variable,absolute) */ \
MACRO_ARGUMENT_2_TO_END(__VA_ARGS__) \
0xC0
#define RAWHID_USAGE_PAGE 0xFFC0 // recommended: 0xFF00 to 0xFFFF
#define RAWHID_USAGE 0x0C00 // recommended: 0x0100 to 0xFFFF
#define LSB(x) ((x) & 0xFF)
#define MSB(x) (((x) & 0xFF00) >> 8)
// TODO: make this work for txSize > 255
#define HID_RAW_REPORT_DESCRIPTOR(txSize, rxSize) \
0x06, LSB(RAWHID_USAGE_PAGE), MSB(RAWHID_USAGE_PAGE), \
0x0A, LSB(RAWHID_USAGE), MSB(RAWHID_USAGE), \
0xA1, 0x01, /* Collection 0x01 */ \
/* 0x85, 10, */ /* REPORT_ID (1) */ \
0x75, 0x08, /* report size = 8 bits */ \
0x15, 0x00, /* logical minimum = 0 */ \
0x26, 0xFF, 0x00, /* logical maximum = 255 */ \
\
0x96, LSB(txSize), MSB(txSize), /* report count TX */ \
0x09, 0x01, /* usage */ \
0x81, 0x02, /* Input (array) */ \
\
0x75, 0x08, /* report size = 8 bits */ \
0x15, 0x00, /* logical minimum = 0 */ \
0x26, 0xFF, 0x00, /* logical maximum = 255 */ \
0x96, LSB(rxSize), MSB(rxSize), /* report count RX */ \
0x09, 0x02, /* usage */ \
0x91, 0x02, /* OUTPUT (0x91) */ \
0xC0 /* end collection */
typedef struct {
const uint8_t* descriptor;
uint16_t length;
} HIDReportDescriptor;
extern const HIDReportDescriptor* hidReportMouse;
extern const HIDReportDescriptor* hidReportKeyboard;
extern const HIDReportDescriptor* hidReportJoystick;
extern const HIDReportDescriptor* hidReportKeyboardMouse;
extern const HIDReportDescriptor* hidReportKeyboardJoystick;
extern const HIDReportDescriptor* hidReportKeyboardMouseJoystick;
extern const HIDReportDescriptor* hidReportBootKeyboard;
extern const HIDReportDescriptor* hidReportAbsMouse;
extern const HIDReportDescriptor* hidReportDigitizer;
extern const HIDReportDescriptor* hidReportConsumer;
#define HID_MOUSE hidReportMouse
#define HID_KEYBOARD hidReportKeyboard
#define HID_JOYSTICK hidReportJoystick
#define HID_KEYBOARD_MOUSE hidReportKeyboardMouse
#define HID_KEYBOARD_JOYSTICK hidReportKeyboardJoystick
#define HID_KEYBOARD_MOUSE_JOYSTICK hidReportKeyboardMouseJoystick
#define HID_BOOT_KEYBOARD hidReportBootKeyboard
class HIDReporter;
class USBHID {
private:
bool autoRegister = true;
bool enabledHID = false;
uint32 txPacketSize = 64;
struct usb_chunk* chunkList;
// baseChunk holds any explicitly specified report descriptor that
// overrides any report descriptors from the chain of registered profiles
struct usb_chunk baseChunk = { 0, 0, 0 };
HIDReporter* profiles;
public:
static bool init(USBHID* me);
// add a report to the list ; if always is false, then it only works if autoRegister is true
void addReport(HIDReporter* r, bool always=true);
void clear();
bool registerComponent();
void setReportDescriptor(const uint8_t* report_descriptor, uint16_t report_descriptor_length);
void setReportDescriptor(const HIDReportDescriptor* reportDescriptor=NULL);
// All the strings are zero-terminated ASCII strings. Use NULL for defaults.
void begin(const uint8_t* report_descriptor, uint16_t length);
void begin(const HIDReportDescriptor* reportDescriptor = NULL);
void begin(USBCompositeSerial serial, const uint8_t* report_descriptor, uint16_t length);
void begin(USBCompositeSerial serial, const HIDReportDescriptor* reportDescriptor = NULL);
void setBuffers(uint8_t buffers, volatile HIDBuffer_t* fb=NULL, int count=0); // type = HID_REPORT_TYPE_FEATURE or HID_REPORT_TYPE_OUTPUT
bool addBuffer(uint8_t type, volatile HIDBuffer_t* buffer);
void clearBuffers(uint8_t type);
void clearBuffers();
inline bool addFeatureBuffer(volatile HIDBuffer_t* buffer) {
return addBuffer(HID_REPORT_TYPE_FEATURE, buffer);
}
inline bool addOutputBuffer(volatile HIDBuffer_t* buffer) {
return addBuffer(HID_REPORT_TYPE_OUTPUT, buffer);
}
inline void setFeatureBuffers(volatile HIDBuffer_t* fb=NULL, int count=0) {
setBuffers(HID_REPORT_TYPE_FEATURE, fb, count);
}
inline void setOutputBuffers(volatile HIDBuffer_t* fb=NULL, int count=0) {
setBuffers(HID_REPORT_TYPE_OUTPUT, fb, count);
}
void end(void);
void setTXPacketSize(uint32 size=64) {
txPacketSize = size;
}
USBHID(bool _autoRegister=true) {
autoRegister = _autoRegister;
}
};
class HIDReporter {
private:
uint8_t* reportBuffer;
uint8_t reportID;
uint8_t userSuppliedReportID;
bool forceUserSuppliedReportID;
uint16_t bufferSize;
HIDReportDescriptor reportDescriptor;
struct usb_chunk reportChunks[3];
class HIDReporter* next;
friend class USBHID;
protected:
USBHID& HID;
public:
void sendReport();
// if you use this init function, the buffer starts with a reportID, even if the reportID is zero,
// and bufferSize includes the reportID; if reportID is zero, sendReport() will skip the initial
// reportID byte
HIDReporter(USBHID& _HID, const HIDReportDescriptor* r, uint8_t* _buffer, unsigned _size, uint8_t _reportID, bool forceReportID=false);
HIDReporter(USBHID& _HID, uint8_t* _buffer, unsigned _size, uint8_t _reportID, bool forceReportID=false) : HIDReporter(_HID, NULL, _buffer, _size, _reportID, forceReportID) {}
// if you use these init functions, the buffer has no reportID byte in it
HIDReporter(USBHID& _HID, const HIDReportDescriptor* r, uint8_t* _buffer, unsigned _size);
HIDReporter(USBHID& _HID, uint8_t* _buffer, unsigned _size) : HIDReporter(_HID, NULL, _buffer, _size) {}
uint16_t getFeature(uint8_t* out=NULL, uint8_t poll=1);
uint16_t getOutput(uint8_t* out=NULL, uint8_t poll=1);
uint16_t getData(uint8_t type, uint8_t* out, uint8_t poll=1); // type = HID_REPORT_TYPE_FEATURE or HID_REPORT_TYPE_OUTPUT
void setFeature(uint8_t* feature);
void registerProfile(bool always=true);
};
//================================================================================
//================================================================================
// Mouse
#define MOUSE_LEFT 1
#define MOUSE_RIGHT 2
#define MOUSE_MIDDLE 4
#define MOUSE_ALL (MOUSE_LEFT | MOUSE_RIGHT | MOUSE_MIDDLE)
class HIDMouse : public HIDReporter {
protected:
uint8_t _buttons;
void buttons(uint8_t b);
uint8_t reportBuffer[5];
public:
HIDMouse(USBHID& HID, uint8_t reportID=HID_MOUSE_REPORT_ID) : HIDReporter(HID, hidReportMouse, reportBuffer, sizeof(reportBuffer), reportID), _buttons(0) {}
void begin(void);
void end(void);
void click(uint8_t b = MOUSE_LEFT);
void move(signed char x, signed char y, signed char wheel = 0);
void press(uint8_t b = MOUSE_LEFT); // press LEFT by default
void release(uint8_t b = MOUSE_LEFT); // release LEFT by default
bool isPressed(uint8_t b = MOUSE_ALL); // check all buttons by default
};
typedef struct {
uint8_t reportID;
uint8_t buttons;
int16_t x;
int16_t y;
uint8_t wheel;
} __packed AbsMouseReport_t;
class HIDAbsMouse : public HIDReporter {
protected:
void buttons(uint8_t b);
AbsMouseReport_t report;
public:
HIDAbsMouse(USBHID& HID, uint8_t reportID=HID_MOUSE_REPORT_ID) : HIDReporter(HID, hidReportAbsMouse, (uint8_t*)&report, sizeof(report), reportID) {
report.buttons = 0;
report.x = 0;
report.y = 0;
report.wheel = 0;
}
void begin(void);
void end(void);
void click(uint8_t b = MOUSE_LEFT);
void move(int16_t x, int16_t y, int8_t wheel = 0);
void press(uint8_t b = MOUSE_LEFT); // press LEFT by default
void release(uint8_t b = MOUSE_LEFT); // release LEFT by default
bool isPressed(uint8_t b = MOUSE_ALL); // check all buttons by default
};
#define DIGITIZER_TOUCH 1 // for touch to be processed it could be required to be "in range" first
#define DIGITIZER_IN_RANGE 2
#define DIGITIZER_TOUCH_IN_RANGE (DIGITIZER_TOUCH | DIGITIZER_IN_RANGE)
typedef struct {
uint8_t reportID;
uint8_t buttons;
uint16_t x:12;
uint16_t y:12;
} __packed DigitizerReport_t;
class HIDDigitizer : public HIDReporter {
protected:
void buttons(uint8_t b);
DigitizerReport_t report;
public:
HIDDigitizer(USBHID& HID, uint8_t reportID=HID_DIGITIZER_REPORT_ID) : HIDReporter(HID, hidReportDigitizer, (uint8_t*)&report, sizeof(report), reportID) {
report.buttons = 0;
report.x = 0;
report.y = 0;
}
void begin(void);
void end(void);
void move(uint16_t x, uint16_t y); // coordinates are 0 to 16383
void click(uint8_t b = DIGITIZER_TOUCH_IN_RANGE);
void press(uint8_t b = DIGITIZER_TOUCH_IN_RANGE);
void release(uint8_t b = DIGITIZER_TOUCH_IN_RANGE);
bool isPressed(uint8_t b = DIGITIZER_TOUCH_IN_RANGE);
};
typedef struct {
uint8_t reportID;
uint16_t button;
} __packed ConsumerReport_t;
class HIDConsumer : public HIDReporter {
protected:
ConsumerReport_t report;
public:
enum {
BRIGHTNESS_UP = 0x6F,
BRIGHTNESS_DOWN = 0x70,
NEXT_TRACK = 0xB5,
PREVIOUS_TRACK = 0xB6,
PLAY_OR_PAUSE = 0xCD,
VOLUME_UP = 0xE9,
VOLUME_DOWN = 0xEA,
MUTE = 0xE2
// see pages 117 of https://www.usb.org/sites/default/files/hut1_22.pdf
};
HIDConsumer(USBHID& HID, uint8_t reportID=HID_CONSUMER_REPORT_ID) : HIDReporter(HID, hidReportConsumer, (uint8_t*)&report, sizeof(report), reportID) {
report.button = 0;
}
void begin(void);
void end(void);
void press(uint16_t button);
void release();
};
#define KEY_LEFT_CTRL 0x80
#define KEY_LEFT_SHIFT 0x81
#define KEY_LEFT_ALT 0x82
#define KEY_LEFT_GUI 0x83
#define KEY_RIGHT_CTRL 0x84
#define KEY_RIGHT_SHIFT 0x85
#define KEY_RIGHT_ALT 0x86
#define KEY_RIGHT_GUI 0x87
// The following definitions takes their value from the document at https://www.usb.org/sites/default/files/hut1_22.pdf, starting p82
// However, their value are augmented by 0x88 (for example, KEY_F12 real value is 0x45)
#define KEY_UP_ARROW 0xDA
#define KEY_DOWN_ARROW 0xD9
#define KEY_LEFT_ARROW 0xD8
#define KEY_RIGHT_ARROW 0xD7
#define KEY_BACKSPACE 0xB2
#define KEY_TAB 0xB3
#define KEY_RETURN 0xB0
#define KEY_ESC 0xB1
#define KEY_INSERT 0xD1
#define KEY_DELETE 0xD4
#define KEY_PAGE_UP 0xD3
#define KEY_PAGE_DOWN 0xD6
#define KEY_HOME 0xD2
#define KEY_END 0xD5
#define KEY_CAPS_LOCK 0xC1
#define KEY_F1 0xC2
#define KEY_F2 0xC3
#define KEY_F3 0xC4
#define KEY_F4 0xC5
#define KEY_F5 0xC6
#define KEY_F6 0xC7
#define KEY_F7 0xC8
#define KEY_F8 0xC9
#define KEY_F9 0xCA
#define KEY_F10 0xCB
#define KEY_F11 0xCC
#define KEY_F12 0xCD
typedef struct{
uint8_t reportID;
uint8_t modifiers;
uint8_t reserved;
uint8_t keys[HID_KEYBOARD_ROLLOVER];
} __packed KeyReport_t;
class HIDKeyboard : public Print, public HIDReporter {
public:
KeyReport_t keyReport;
protected:
uint8_t leds[HID_BUFFER_ALLOCATE_SIZE(1,1)];
HIDBuffer_t ledData;
uint8_t reportID;
uint8_t getKeyCode(uint8_t k, uint8_t* modifiersP);
bool adjustForHostCapsLock = true;
public:
HIDKeyboard(USBHID& HID, uint8_t _reportID=HID_KEYBOARD_REPORT_ID) :
HIDReporter(HID, hidReportKeyboard, (uint8*)&keyReport, sizeof(KeyReport_t), _reportID),
ledData(leds, HID_BUFFER_SIZE(1,_reportID), _reportID, HID_BUFFER_MODE_NO_WAIT),
reportID(_reportID)
{}
void begin(void);
void end(void);
void setAdjustForHostCapsLock(bool state) {
adjustForHostCapsLock = state;
}
inline uint8 getLEDs(void) {
return leds[reportID != 0 ? 1 : 0];
}
virtual size_t write(uint8_t k);
virtual size_t press(uint8_t k);
virtual size_t release(uint8_t k);
virtual void releaseAll(void);
};
//================================================================================
//================================================================================
// Joystick
// only works for little-endian machines, but makes the code so much more
// readable
typedef struct {
uint8_t reportID;
uint32_t buttons;
unsigned hat:4;
unsigned x:10;
unsigned y:10;
unsigned rx:10;
unsigned ry:10;
unsigned sliderLeft:10;
unsigned sliderRight:10;
} __packed JoystickReport_t;
static_assert(sizeof(JoystickReport_t)==13, "Wrong endianness/packing!");
class HIDJoystick : public HIDReporter {
protected:
JoystickReport_t joyReport;
bool manualReport = false;
void safeSendReport(void);
public:
inline void send(void) {
sendReport();
}
void setManualReportMode(bool manualReport); // in manual report mode, report only sent when send() is called
bool getManualReportMode();
void begin(void);
void end(void);
void button(uint8_t button, bool val);
void X(uint16_t val);
void Y(uint16_t val);
void position(uint16_t x, uint16_t y);
void Xrotate(uint16_t val);
void Yrotate(uint16_t val);
void sliderLeft(uint16_t val);
void sliderRight(uint16_t val);
void slider(uint16_t val);
void hat(int16_t dir);
HIDJoystick(USBHID& HID, uint8_t reportID=HID_JOYSTICK_REPORT_ID)
: HIDReporter(HID, hidReportJoystick, (uint8_t*)&joyReport, sizeof(joyReport), reportID) {
joyReport.buttons = 0;
joyReport.hat = 15;
joyReport.x = 512;
joyReport.y = 512;
joyReport.rx = 512;
joyReport.ry = 512;
joyReport.sliderLeft = 0;
joyReport.sliderRight = 0;
}
};
template<unsigned txSize,unsigned rxSize>class HIDRaw : public HIDReporter {
private:
uint8_t txBuffer[txSize];
uint8_t rxBuffer[HID_BUFFER_ALLOCATE_SIZE(rxSize,0)];
HIDBuffer_t buf;
public:
HIDRaw(USBHID& HID) : HIDReporter(HID, txBuffer, sizeof(txBuffer)) {}
void begin(void) {
buf.buffer = rxBuffer;
buf.bufferSize = HID_BUFFER_SIZE(rxSize,0);
buf.reportID = 0;
HID.addOutputBuffer(&buf);
}
void end(void);
void send(const uint8_t* data, unsigned n=sizeof(txBuffer)) {
memset(txBuffer, 0, sizeof(txBuffer));
memcpy(txBuffer, data, n>sizeof(txBuffer)?sizeof(txBuffer):n);
sendReport();
}
};
#endif