-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathKeyboardHIDSub.cpp
494 lines (455 loc) · 14.9 KB
/
KeyboardHIDSub.cpp
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
#if 0
#include <NimBLEDevice.h>
#include <NimBLEUtils.h>
#include <NimBLEServer.h>
#include "NimBLEHIDDevice.h"
#include "HIDTypes.h"
#include <driver/adc.h>
#include "sdkconfig.h"
#include "KeyboardOutputCallbacks.h"
#include "KeyboardHIDSub.h"
#include <Print.h>
#endif
#include "BleFlexHID.h"
#include "KeyboardOutputCallbacks.h"
#include "KeyboardHIDSub.h"
#if defined(CONFIG_ARDUHAL_ESP_LOG)
#include "esp32-hal-log.h"
#define LOG_TAG ""
#else
#include "esp_log.h"
static const char* LOG_TAG = "BLEDevice";
#endif
// Sequence of the reports in the sub device descriptor table
#define SUB_REPORT_IDX_KEYBOARD_ID 0
#define SUB_REPORT_IDX_MEDIA_KEYS_ID 1
const uint8_t KMTComboHIDReportDescriptor[] =
{
USAGE_PAGE(1), 0x01, // USAGE_PAGE (Generic Desktop Ctrls)
USAGE(1), 0x06, // USAGE (Keyboard)
COLLECTION(1), 0x01, // COLLECTION (Application)
// ------------------------------------------------- Keyboard
REPORT_ID(1), KEYBOARD_REPORT_ID, // REPORT_ID (1)
USAGE_PAGE(1), 0x07, // USAGE_PAGE (Kbrd/Keypad)
USAGE_MINIMUM(1), 0xE0, // USAGE_MINIMUM (0xE0)
USAGE_MAXIMUM(1), 0xE7, // USAGE_MAXIMUM (0xE7)
LOGICAL_MINIMUM(1), 0x00, // LOGICAL_MINIMUM (0)
LOGICAL_MAXIMUM(1), 0x01, // Logical Maximum (1)
REPORT_SIZE(1), 0x01, // REPORT_SIZE (1)
REPORT_COUNT(1), 0x08, // REPORT_COUNT (8)
HIDINPUT(1), 0x02, // INPUT (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position)
REPORT_COUNT(1), 0x01, // REPORT_COUNT (1) ; 1 byte (Reserved)
REPORT_SIZE(1), 0x08, // REPORT_SIZE (8)
HIDINPUT(1), 0x01, // INPUT (Const,Array,Abs,No Wrap,Linear,Preferred State,No Null Position)
REPORT_COUNT(1), 0x05, // REPORT_COUNT (5) ; 5 bits (Num lock, Caps lock, Scroll lock, Compose, Kana)
REPORT_SIZE(1), 0x01, // REPORT_SIZE (1)
USAGE_PAGE(1), 0x08, // USAGE_PAGE (LEDs)
USAGE_MINIMUM(1), 0x01, // USAGE_MINIMUM (0x01) ; Num Lock
USAGE_MAXIMUM(1), 0x05, // USAGE_MAXIMUM (0x05) ; Kana
//---------------------------------------
HIDOUTPUT(1), 0x02, // OUTPUT (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position,Non-volatile)
REPORT_COUNT(1), 0x01, // REPORT_COUNT (1) ; 3 bits (Padding)
REPORT_SIZE(1), 0x03, // REPORT_SIZE (3)
//---------------------------------------
HIDOUTPUT(1), 0x01, // OUTPUT (Const,Array,Abs,No Wrap,Linear,Preferred State,No Null Position,Non-volatile)
REPORT_COUNT(1), 0x06, // REPORT_COUNT (6) ; 6 bytes (Keys)
REPORT_SIZE(1), 0x08, // REPORT_SIZE(8)
LOGICAL_MINIMUM(1), 0x00, // LOGICAL_MINIMUM(0)
LOGICAL_MAXIMUM(1), 0x65, // LOGICAL_MAXIMUM(0x65) ; 101 keys
USAGE_PAGE(1), 0x07, // USAGE_PAGE (Kbrd/Keypad)
USAGE_MINIMUM(1), 0x00, // USAGE_MINIMUM (0)
USAGE_MAXIMUM(1), 0x65, // USAGE_MAXIMUM (0x65)
//---------------------------------------
HIDINPUT(1), 0x00, // INPUT (Data,Array,Abs,No Wrap,Linear,Preferred State,No Null Position)
END_COLLECTION(0), // END_COLLECTION
// ------------------------------------------------- Media Keys
USAGE_PAGE(1), 0x0C, // USAGE_PAGE (Consumer)
USAGE(1), 0x01, // USAGE (Consumer Control)
COLLECTION(1), 0x01, // COLLECTION (Application)
REPORT_ID(1), MEDIA_KEYS_REPORT_ID, // REPORT_ID (3)
USAGE_PAGE(1), 0x0C, // USAGE_PAGE (Consumer)
LOGICAL_MINIMUM(1), 0x00, // LOGICAL_MINIMUM (0)
LOGICAL_MAXIMUM(1), 0x01, // LOGICAL_MAXIMUM (1)
REPORT_SIZE(1), 0x01, // REPORT_SIZE (1)
REPORT_COUNT(1), 0x10, // REPORT_COUNT (16)
USAGE(1), 0xB5, // USAGE (Scan Next Track) ; bit 0: 1
USAGE(1), 0xB6, // USAGE (Scan Previous Track) ; bit 1: 2
USAGE(1), 0xB7, // USAGE (Stop) ; bit 2: 4
USAGE(1), 0xCD, // USAGE (Play/Pause) ; bit 3: 8
USAGE(1), 0xE2, // USAGE (Mute) ; bit 4: 16
USAGE(1), 0xE9, // USAGE (Volume Increment) ; bit 5: 32
USAGE(1), 0xEA, // USAGE (Volume Decrement) ; bit 6: 64
USAGE(2), 0x23, 0x02, // Usage (WWW Home) ; bit 7: 128
USAGE(2), 0x94, 0x01, // Usage (My Computer) ; bit 0: 1
USAGE(2), 0x92, 0x01, // Usage (Calculator) ; bit 1: 2
USAGE(2), 0x2A, 0x02, // Usage (WWW fav) ; bit 2: 4
USAGE(2), 0x21, 0x02, // Usage (WWW search) ; bit 3: 8
USAGE(2), 0x26, 0x02, // Usage (WWW stop) ; bit 4: 16
USAGE(2), 0x24, 0x02, // Usage (WWW back) ; bit 5: 32
USAGE(2), 0x83, 0x01, // Usage (Media sel) ; bit 6: 64
USAGE(2), 0x8A, 0x01, // Usage (Mail) ; bit 7: 128
HIDINPUT(1), 0x02, // INPUT (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position)
END_COLLECTION(0), // END_COLLECTION
};
KeyboardHIDSub::KeyboardHIDSub()
{
}
extern
const uint8_t ASCII2ScanCode[128] PROGMEM;
// NOTE: This table converts ASCII to scan codes to ASCII, so positions on the KB.
#define SHIFT 0x80
const uint8_t ASCII2ScanCode[128] =
{
0x00, // NUL
0x00, // SOH
0x00, // STX
0x00, // ETX
0x00, // EOT
0x00, // ENQ
0x00, // ACK
0x00, // BEL
0x2a, // BS Backspace
0x2b, // TAB Tab
0x28, // LF Enter 28
0x00, // VT
0x00, // FF
0x28, // CR
0x00, // SO
0x00, // SI
0x00, // DEL
0x00, // DC1
0x00, // DC2
0x00, // DC3
0x00, // DC4
0x00, // NAK
0x00, // SYN
0x00, // ETB
0x00, // CAN
0x00, // EM
0x00, // SUB
0x00, // ESC
0x00, // FS
0x00, // GS
0x00, // RS
0x00, // US
0x2c, // ' '
0x1e|SHIFT, // !
0x34|SHIFT, // "
0x20|SHIFT, // #
0x21|SHIFT, // $
0x22|SHIFT, // %
0x24|SHIFT, // &
0x34, // '
0x26|SHIFT, // (
0x27|SHIFT, // )
0x25|SHIFT, // *
0x2e|SHIFT, // +
0x36, // ,
0x2d, // -
0x37, // .
0x38, // /
0x27, // 0
0x1e, // 1
0x1f, // 2
0x20, // 3
0x21, // 4
0x22, // 5
0x23, // 6
0x24, // 7
0x25, // 8
0x26, // 9
0x33|SHIFT, // :
0x33, // ;
0x36|SHIFT, // <
0x2e, // =
0x37|SHIFT, // >
0x38|SHIFT, // ?
0x1f|SHIFT, // @
0x04|SHIFT, // A
0x05|SHIFT, // B
0x06|SHIFT, // C
0x07|SHIFT, // D
0x08|SHIFT, // E
0x09|SHIFT, // F
0x0a|SHIFT, // G
0x0b|SHIFT, // H
0x0c|SHIFT, // I
0x0d|SHIFT, // J
0x0e|SHIFT, // K
0x0f|SHIFT, // L
0x10|SHIFT, // M
0x11|SHIFT, // N
0x12|SHIFT, // O
0x13|SHIFT, // P
0x14|SHIFT, // Q
0x15|SHIFT, // R
0x16|SHIFT, // S
0x17|SHIFT, // T
0x18|SHIFT, // U
0x19|SHIFT, // V
0x1a|SHIFT, // W
0x1b|SHIFT, // X
0x1c|SHIFT, // Y
0x1d|SHIFT, // Z
0x2f, // [
0x31, // bslash
0x30, // ]
0x23|SHIFT, // ^
0x2d|SHIFT, // _
0x35, // `
0x04, // a
0x05, // b
0x06, // c
0x07, // d
0x08, // e
0x09, // f
0x0a, // g
0x0b, // h
0x0c, // i
0x0d, // j
0x0e, // k
0x0f, // l
0x10, // m
0x11, // n
0x12, // o
0x13, // p
0x14, // q
0x15, // r
0x16, // s
0x17, // t
0x18, // u
0x19, // v
0x1a, // w
0x1b, // x
0x1c, // y
0x1d, // z
0x2f|SHIFT, // {
0x31|SHIFT, // |
0x30|SHIFT, // }
0x35|SHIFT, // ~
0 // DEL
};
// press() adds the specified key (printing, non-printing, or modifier)
// to the persistent key report and sends the report. Because of the way
// USB HID works, the host acts like the key remains pressed until we
// call release(), releaseAll(), or otherwise clear the report and resend.
size_t KeyboardHIDSub::press(uint8_t k)
{
// Serial.println("KeyboardHIDSub::press(uint8_t k)" );
uint8_t i;
if (k >= 136)
{ // it's a non-printing key (not a modifier)
k = k - 136;
}
else if (k >= 128)
{ // it's a modifier key
_keyReport.modifiers |= (1<<(k-128));
k = 0;
}
else
{ // it's a printing key
k = pgm_read_byte(ASCII2ScanCode + k);
if (!k)
{
Serial.println("Write Error");
setWriteError();
return 0;
}
if (k & 0x80)
{ // it's a capital letter or other character reached with shift
_keyReport.modifiers |= 0x02; // the left shift modifier
k &= 0x7F;
}
}
// Add k to the key report only if it's not already present
// and if there is an empty slot.
if (_keyReport.keys[0] != k && _keyReport.keys[1] != k &&
_keyReport.keys[2] != k && _keyReport.keys[3] != k &&
_keyReport.keys[4] != k && _keyReport.keys[5] != k)
{
for (i=0; i<6; i++)
{
if (_keyReport.keys[i] == 0x00)
{
_keyReport.keys[i] = k;
break;
}
}
if (i == 6)
{
Serial.println("Write Error");
setWriteError();
return 0;
}
}
sendReport(&_keyReport);
return 1;
}
size_t KeyboardHIDSub::press(const MediaKeyReport k)
{
uint16_t k_16 = k[1] | (k[0] << 8);
uint16_t mediaKeyReport_16 = _mediaKeyReport[1] | (_mediaKeyReport[0] << 8);
mediaKeyReport_16 |= k_16;
_mediaKeyReport[0] = (uint8_t)((mediaKeyReport_16 & 0xFF00) >> 8);
_mediaKeyReport[1] = (uint8_t)(mediaKeyReport_16 & 0x00FF);
sendReport(&_mediaKeyReport);
return 1;
}
// release() takes the specified key out of the persistent key report and
// sends the report. This tells the OS the key is no longer pressed and that
// it shouldn't be repeated any more.
size_t KeyboardHIDSub::release(uint8_t k)
{
uint8_t i;
if (k >= 136)
{ // it's a non-printing key (not a modifier)
k = k - 136;
}
else if (k >= 128)
{ // it's a modifier key
_keyReport.modifiers &= ~(1<<(k-128));
k = 0;
}
else
{ // it's a printing key
k = pgm_read_byte(ASCII2ScanCode + k);
if (!k)
{
return 0;
}
if (k & 0x80)
{ // it's a capital letter or other character reached with shift
_keyReport.modifiers &= ~(0x02); // the left shift modifier
k &= 0x7F;
}
}
// Test the key report to see if k is present. Clear it if it exists.
// Check all positions in case the key is present more than once (which it shouldn't be)
bool KeyFoundForRelease=false;
for (i=0; i<6; i++)
{
if (0 != k && _keyReport.keys[i] == k)
{
_keyReport.keys[i] = 0x00;
KeyFoundForRelease = true;
}
}
if (!KeyFoundForRelease)
Serial.printf("Key not found\n");
sendReport(&_keyReport);
return 1;
}
size_t KeyboardHIDSub::release(const MediaKeyReport k)
{
uint16_t k_16 = k[1] | (k[0] << 8);
uint16_t mediaKeyReport_16 = _mediaKeyReport[1] | (_mediaKeyReport[0] << 8);
mediaKeyReport_16 &= ~k_16;
_mediaKeyReport[0] = (uint8_t)((mediaKeyReport_16 & 0xFF00) >> 8);
_mediaKeyReport[1] = (uint8_t)(mediaKeyReport_16 & 0x00FF);
sendReport(&_mediaKeyReport);
return 1;
}
void KeyboardHIDSub::releaseAll(void)
{
_keyReport.keys[0] = 0;
_keyReport.keys[1] = 0;
_keyReport.keys[2] = 0;
_keyReport.keys[3] = 0;
_keyReport.keys[4] = 0;
_keyReport.keys[5] = 0;
_keyReport.modifiers = 0;
_mediaKeyReport[0] = 0;
_mediaKeyReport[1] = 0;
sendReport(&_keyReport);
}
size_t KeyboardHIDSub::write(uint8_t c)
{
// Serial.println("KeyboardHIDSub::write()");
uint8_t p = press(c); // Keydown
release(c); // Keyup
delay(10);
return p; // just return the result of press() since release() almost always returns 1
}
size_t KeyboardHIDSub::write(const MediaKeyReport c)
{
uint16_t p = press(c); // Keydown
release(c); // Keyup
return p; // just return the result of press() since release() almost always returns 1
}
size_t KeyboardHIDSub::write(const uint8_t *buffer, size_t size)
{
// Serial.println("KeyboardHIDSub::write(const uint8_t *buffer, size_t size)");
int i=0;
for (i=0; i<size; i++)
if (buffer[i] == 0 || !write(buffer[i]))
break;
return i-1;
}
void KeyboardHIDSub::sendReport(KeyReport* keys)
{
// Serial.println("KeyboardHIDSub::sendReport(KeyReport* keys)");
if (IsConnected())
{
// Serial.printf("sending KEYBOARD_ID report: %c\n", keys->keys[0]); delay(500);
NimBLECharacteristic* pC = pHIDMaster->GetInputCharacterstics(SubDeviceIndex, SUB_REPORT_IDX_KEYBOARD_ID);
pC->setValue((uint8_t*)keys, sizeof(KeyReport));
pC->notify();
}
}
void KeyboardHIDSub::sendReport(MediaKeyReport* keys)
{
if (IsConnected())
{
NimBLECharacteristic* pC = pHIDMaster->GetInputCharacterstics(SubDeviceIndex, SUB_REPORT_IDX_MEDIA_KEYS_ID);
pC->setValue((uint8_t*)keys, sizeof(MediaKeyReport));
pC->notify();
}
}
//************************************************************
// Functions required by the BLE Master
// Return the HID descriptor for the device
const uint8_t* KeyboardHIDSub::GetHIDDecsriptor(int* NumBytes)
{
*NumBytes = sizeof(KMTComboHIDReportDescriptor);
return KMTComboHIDReportDescriptor;
};
// Return the input and output characteristics of the device.
// Called multiple times, until the function returns 0. Index is the count.
int KeyboardHIDSub::GetInputReportIndex(int Index)
{
int ReportID=-1;
switch(Index)
{
case SUB_REPORT_IDX_KEYBOARD_ID: ReportID = KEYBOARD_REPORT_ID; break;
case SUB_REPORT_IDX_MEDIA_KEYS_ID: ReportID = MEDIA_KEYS_REPORT_ID; break;
// case SUB_REPORT_IDX_MOUSE_ID: ReportID = MOUSE_REPORT_ID; break;
// case SUB_REPORT_IDX_TOUCH_REPORTID: ReportID = TOUCH_REPORTID; break;
default: ReportID = -1;
}
return ReportID;
}
int KeyboardHIDSub::GetOutputReportIndex(int Index, NimBLECharacteristicCallbacks** OutputCallback)
{
int ReportID=-1;
// Serial.printf("KeyboardHIDSub::GetOutputReportIndex() request for output report ID with index %d\n", Index);
switch(Index)
{
case SUB_REPORT_IDX_KEYBOARD_ID:
ReportID = KEYBOARD_REPORT_ID;
*OutputCallback = new KeyboardOutputCallbacks();
break;
default: ReportID = -1;
}
return ReportID;
}
#if 0
#define SUB_REPORT_IDX_KEYBOARD_ID 0
#define SUB_REPORT_IDX_MEDIA_KEYS_ID 1
#define SUB_REPORT_IDX_MOUSE_ID 2
#define SUB_REPORT_IDX_TOUCH_REPORTID 3
#define KEYBOARD_ID 0x01
#define MEDIA_KEYS_ID 0x02
#define MOUSE_ID 0x03
#define TOUCH_REPORTID 0x04
#define GAMEPAD_REPORTID 0x05
#endif