summaryrefslogtreecommitdiffstats
path: root/tmk_core/protocol/vusb/vusb.c
blob: 3719b7aa0f8c5fd845ad908e2d97f69c4078b892 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
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
/*
Copyright 2011 Jun Wako <wakojun@gmail.com>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#include <avr/eeprom.h>
#include <avr/wdt.h>
#include <stdint.h>
#include "usbdrv.h"
#include "usbconfig.h"
#include "host.h"
#include "report.h"
#include "print.h"
#include "debug.h"
#include "host_driver.h"
#include "vusb.h"
#include "bootloader.h"
#include <util/delay.h>

static uint8_t vusb_keyboard_leds = 0;
static uint8_t vusb_idle_rate     = 0;

/* Keyboard report send buffer */
#define KBUF_SIZE 16
static report_keyboard_t kbuf[KBUF_SIZE];
static uint8_t           kbuf_head = 0;
static uint8_t           kbuf_tail = 0;

typedef struct {
    uint8_t modifier;
    uint8_t reserved;
    uint8_t keycode[6];
} keyboard_report_t;

static keyboard_report_t keyboard_report;  // sent to PC

#define VUSB_TRANSFER_KEYBOARD_MAX_TRIES 10

/* transfer keyboard report from buffer */
void vusb_transfer_keyboard(void) {
    for (int i = 0; i < VUSB_TRANSFER_KEYBOARD_MAX_TRIES; i++) {
        if (usbInterruptIsReady()) {
            if (kbuf_head != kbuf_tail) {
                usbSetInterrupt((void *)&kbuf[kbuf_tail], sizeof(report_keyboard_t));
                kbuf_tail = (kbuf_tail + 1) % KBUF_SIZE;
                if (debug_keyboard) {
                    print("V-USB: kbuf[");
                    pdec(kbuf_tail);
                    print("->");
                    pdec(kbuf_head);
                    print("](");
                    phex((kbuf_head < kbuf_tail) ? (KBUF_SIZE - kbuf_tail + kbuf_head) : (kbuf_head - kbuf_tail));
                    print(")\n");
                }
            }
            break;
        }
        usbPoll();
        _delay_ms(1);
    }
}

/*------------------------------------------------------------------*
 * Host driver
 *------------------------------------------------------------------*/
static uint8_t keyboard_leds(void);
static void    send_keyboard(report_keyboard_t *report);
static void    send_mouse(report_mouse_t *report);
static void    send_system(uint16_t data);
static void    send_consumer(uint16_t data);

static host_driver_t driver = {keyboard_leds, send_keyboard, send_mouse, send_system, send_consumer};

host_driver_t *vusb_driver(void) { return &driver; }

static uint8_t keyboard_leds(void) { return vusb_keyboard_leds; }

static void send_keyboard(report_keyboard_t *report) {
    uint8_t next = (kbuf_head + 1) % KBUF_SIZE;
    if (next != kbuf_tail) {
        kbuf[kbuf_head] = *report;
        kbuf_head       = next;
    } else {
        debug("kbuf: full\n");
    }

    // NOTE: send key strokes of Macro
    usbPoll();
    vusb_transfer_keyboard();
}

typedef struct {
    uint8_t        report_id;
    report_mouse_t report;
} __attribute__((packed)) vusb_mouse_report_t;

static void send_mouse(report_mouse_t *report) {
    vusb_mouse_report_t r = {.report_id = REPORT_ID_MOUSE, .report = *report};
    if (usbInterruptIsReady3()) {
        usbSetInterrupt3((void *)&r, sizeof(vusb_mouse_report_t));
    }
}

typedef struct {
    uint8_t  report_id;
    uint16_t usage;
} __attribute__((packed)) report_extra_t;

static void send_system(uint16_t data) {
    static uint16_t last_data = 0;
    if (data == last_data) return;
    last_data = data;

    report_extra_t report = {.report_id = REPORT_ID_SYSTEM, .usage = data};
    if (usbInterruptIsReady3()) {
        usbSetInterrupt3((void *)&report, sizeof(report));
    }
}

static void send_consumer(uint16_t data) {
    static uint16_t last_data = 0;
    if (data == last_data) return;
    last_data = data;

    report_extra_t report = {.report_id = REPORT_ID_CONSUMER, .usage = data};
    if (usbInterruptIsReady3()) {
        usbSetInterrupt3((void *)&report, sizeof(report));
    }
}

/*------------------------------------------------------------------*
 * Request from host                                                *
 *------------------------------------------------------------------*/
static struct {
    uint16_t len;
    enum { NONE, BOOTLOADER, SET_LED } kind;
} last_req;

usbMsgLen_t usbFunctionSetup(uchar data[8]) {
    usbRequest_t *rq = (void *)data;

    if ((rq->bmRequestType & USBRQ_TYPE_MASK) == USBRQ_TYPE_CLASS) { /* class request type */
        if (rq->bRequest == USBRQ_HID_GET_REPORT) {
            debug("GET_REPORT:");
            /* we only have one report type, so don't look at wValue */
            usbMsgPtr = (void *)&keyboard_report;
            return sizeof(keyboard_report);
        } else if (rq->bRequest == USBRQ_HID_GET_IDLE) {
            debug("GET_IDLE: ");
            // debug_hex(vusb_idle_rate);
            usbMsgPtr = &vusb_idle_rate;
            return 1;
        } else if (rq->bRequest == USBRQ_HID_SET_IDLE) {
            vusb_idle_rate = rq->wValue.bytes[1];
            debug("SET_IDLE: ");
            debug_hex(vusb_idle_rate);
        } else if (rq->bRequest == USBRQ_HID_SET_REPORT) {
            debug("SET_REPORT: ");
            // Report Type: 0x02(Out)/ReportID: 0x00(none) && Interface: 0(keyboard)
            if (rq->wValue.word == 0x0200 && rq->wIndex.word == 0) {
                debug("SET_LED: ");
                last_req.kind = SET_LED;
                last_req.len  = rq->wLength.word;
#ifdef BOOTLOADER_SIZE
            } else if (rq->wValue.word == 0x0301) {
                last_req.kind = BOOTLOADER;
                last_req.len  = rq->wLength.word;
#endif
            }
            return USB_NO_MSG;  // to get data in usbFunctionWrite
        } else {
            debug("UNKNOWN:");
        }
    } else {
        debug("VENDOR:");
        /* no vendor specific requests implemented */
    }
    debug("\n");
    return 0; /* default for not implemented requests: return no data back to host */
}

uchar usbFunctionWrite(uchar *data, uchar len) {
    if (last_req.len == 0) {
        return -1;
    }
    switch (last_req.kind) {
        case SET_LED:
            debug("SET_LED: ");
            debug_hex(data[0]);
            debug("\n");
            vusb_keyboard_leds = data[0];
            last_req.len       = 0;
            return 1;
            break;
        case BOOTLOADER:
            usbDeviceDisconnect();
            bootloader_jump();
            return 1;
            break;
        case NONE:
        default:
            return -1;
            break;
    }
    return 1;
}

/*------------------------------------------------------------------*
 * Descriptors                                                      *
 *------------------------------------------------------------------*/

/*
 * Report Descriptor for keyboard
 *
 * from an example in HID spec appendix
 */
const PROGMEM uchar keyboard_hid_report[] = {
    0x05, 0x01,        // Usage Page (Generic Desktop),
    0x09, 0x06,        // Usage (Keyboard),
    0xA1, 0x01,        // Collection (Application),
    0x75, 0x01,        //   Report Size (1),
    0x95, 0x08,        //   Report Count (8),
    0x05, 0x07,        //   Usage Page (Key Codes),
    0x19, 0xE0,        //   Usage Minimum (224),
    0x29, 0xE7,        //   Usage Maximum (231),
    0x15, 0x00,        //   Logical Minimum (0),
    0x25, 0x01,        //   Logical Maximum (1),
    0x81, 0x02,        //   Input (Data, Variable, Absolute), ;Modifier byte
    0x95, 0x01,        //   Report Count (1),
    0x75, 0x08,        //   Report Size (8),
    0x81, 0x03,        //   Input (Constant),                 ;Reserved byte
    0x95, 0x05,        //   Report Count (5),
    0x75, 0x01,        //   Report Size (1),
    0x05, 0x08,        //   Usage Page (LEDs),
    0x19, 0x01,        //   Usage Minimum (1),
    0x29, 0x05,        //   Usage Maximum (5),
    0x91, 0x02,        //   Output (Data, Variable, Absolute), ;LED report
    0x95, 0x01,        //   Report Count (1),
    0x75, 0x03,        //   Report Size (3),
    0x91, 0x03,        //   Output (Constant),                 ;LED report padding
    0x95, 0x06,        //   Report Count (6),
    0x75, 0x08,        //   Report Size (8),
    0x15, 0x00,        //   Logical Minimum (0),
    0x26, 0xFF, 0x00,  //   Logical Maximum(255),
    0x05, 0x07,        //   Usage Page (Key Codes),
    0x19, 0x00,        //   Usage Minimum (0),
    0x29, 0xFF,        //   Usage Maximum (255),
    0x81, 0x00,        //   Input (Data, Array),
    0xc0               // End Collection
};

/*
 * Report Descriptor for mouse
 *
 * Mouse Protocol 1, HID 1.11 spec, Appendix B, page 59-60, with wheel extension
 * http://www.microchip.com/forums/tm.aspx?high=&m=391435&mpage=1#391521
 * http://www.keil.com/forum/15671/
 * http://www.microsoft.com/whdc/device/input/wheel.mspx
 */
const PROGMEM uchar mouse_hid_report[] = {
    /* mouse */
    0x05, 0x01,             // USAGE_PAGE (Generic Desktop)
    0x09, 0x02,             // USAGE (Mouse)
    0xa1, 0x01,             // COLLECTION (Application)
    0x85, REPORT_ID_MOUSE,  //   REPORT_ID (1)
    0x09, 0x01,             //   USAGE (Pointer)
    0xa1, 0x00,             //   COLLECTION (Physical)
                            // ----------------------------  Buttons
    0x05, 0x09,             //     USAGE_PAGE (Button)
    0x19, 0x01,             //     USAGE_MINIMUM (Button 1)
    0x29, 0x05,             //     USAGE_MAXIMUM (Button 5)
    0x15, 0x00,             //     LOGICAL_MINIMUM (0)
    0x25, 0x01,             //     LOGICAL_MAXIMUM (1)
    0x75, 0x01,             //     REPORT_SIZE (1)
    0x95, 0x05,             //     REPORT_COUNT (5)
    0x81, 0x02,             //     INPUT (Data,Var,Abs)
    0x75, 0x03,             //     REPORT_SIZE (3)
    0x95, 0x01,             //     REPORT_COUNT (1)
    0x81, 0x03,             //     INPUT (Cnst,Var,Abs)
                            // ----------------------------  X,Y position
    0x05, 0x01,             //     USAGE_PAGE (Generic Desktop)
    0x09, 0x30,             //     USAGE (X)
    0x09, 0x31,             //     USAGE (Y)
    0x15, 0x81,             //     LOGICAL_MINIMUM (-127)
    0x25, 0x7f,             //     LOGICAL_MAXIMUM (127)
    0x75, 0x08,             //     REPORT_SIZE (8)
    0x95, 0x02,             //     REPORT_COUNT (2)
    0x81, 0x06,             //     INPUT (Data,Var,Rel)
                            // ----------------------------  Vertical wheel
    0x09, 0x38,             //     USAGE (Wheel)
    0x15, 0x81,             //     LOGICAL_MINIMUM (-127)
    0x25, 0x7f,             //     LOGICAL_MAXIMUM (127)
    0x35, 0x00,             //     PHYSICAL_MINIMUM (0)        - reset physical
    0x45, 0x00,             //     PHYSICAL_MAXIMUM (0)
    0x75, 0x08,             //     REPORT_SIZE (8)
    0x95, 0x01,             //     REPORT_COUNT (1)
    0x81, 0x06,             //     INPUT (Data,Var,Rel)
                            // ----------------------------  Horizontal wheel
    0x05, 0x0c,             //     USAGE_PAGE (Consumer Devices)
    0x0a, 0x38, 0x02,       //     USAGE (AC Pan)
    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
    0xc0,                   // END_COLLECTION
    /* system control */
    0x05, 0x01,              // USAGE_PAGE (Generic Desktop)
    0x09, 0x80,              // USAGE (System Control)
    0xa1, 0x01,              // COLLECTION (Application)
    0x85, REPORT_ID_SYSTEM,  //   REPORT_ID (2)
    0x15, 0x01,              //   LOGICAL_MINIMUM (0x1)
    0x26, 0xb7, 0x00,        //   LOGICAL_MAXIMUM (0xb7)
    0x19, 0x01,              //   USAGE_MINIMUM (0x1)
    0x29, 0xb7,              //   USAGE_MAXIMUM (0xb7)
    0x75, 0x10,              //   REPORT_SIZE (16)
    0x95, 0x01,              //   REPORT_COUNT (1)
    0x81, 0x00,              //   INPUT (Data,Array,Abs)
    0xc0,                    // END_COLLECTION
    /* consumer */
    0x05, 0x0c,                // USAGE_PAGE (Consumer Devices)
    0x09, 0x01,                // USAGE (Consumer Control)
    0xa1, 0x01,                // COLLECTION (Application)
    0x85, REPORT_ID_CONSUMER,  //   REPORT_ID (3)
    0x15, 0x01,                //   LOGICAL_MINIMUM (0x1)
    0x26, 0x9c, 0x02,          //   LOGICAL_MAXIMUM (0x29c)
    0x19, 0x01,                //   USAGE_MINIMUM (0x1)
    0x2a, 0x9c, 0x02,          //   USAGE_MAXIMUM (0x29c)
    0x75, 0x10,                //   REPORT_SIZE (16)
    0x95, 0x01,                //   REPORT_COUNT (1)
    0x81, 0x00,                //   INPUT (Data,Array,Abs)
    0xc0,                      // END_COLLECTION
};

/*
 * Descriptor for compite device: Keyboard + Mouse
 *
 * contains: device, interface, HID and endpoint descriptors
 */
#if USB_CFG_DESCR_PROPS_CONFIGURATION
const PROGMEM char usbDescriptorConfiguration[] = {
    /* USB configuration descriptor */
    9,               /* sizeof(usbDescriptorConfiguration): length of descriptor in bytes */
    USBDESCR_CONFIG, /* descriptor type */
    9 + (9 + 9 + 7) + (9 + 9 + 7), 0,
    // 18 + 7 * USB_CFG_HAVE_INTRIN_ENDPOINT + 7 * USB_CFG_HAVE_INTRIN_ENDPOINT3 + 9, 0,
    /* total length of data returned (including inlined descriptors) */
    2, /* number of interfaces in this configuration */
    1, /* index of this configuration */
    0, /* configuration name string index */
#    if USB_CFG_IS_SELF_POWERED
    (1 << 7) | USBATTR_SELFPOWER, /* attributes */
#    else
    (1 << 7), /* attributes */
#    endif
    USB_CFG_MAX_BUS_POWER / 2, /* max USB current in 2mA units */

    /*
     * Keyboard interface
     */
    /* Interface descriptor */
    9,                                                                                  /* sizeof(usbDescrInterface): length of descriptor in bytes */
    USBDESCR_INTERFACE,                                                                 /* descriptor type */
    0,                                                                                  /* index of this interface */
    0,                                                                                  /* alternate setting for this interface */
    USB_CFG_HAVE_INTRIN_ENDPOINT,                                                       /* endpoints excl 0: number of endpoint descriptors to follow */
    USB_CFG_INTERFACE_CLASS, USB_CFG_INTERFACE_SUBCLASS, USB_CFG_INTERFACE_PROTOCOL, 0, /* string index for interface */
    /* HID descriptor */
    9,                              /* sizeof(usbDescrHID): length of descriptor in bytes */
    USBDESCR_HID,                   /* descriptor type: HID */
    0x01, 0x01,                     /* BCD representation of HID version */
    0x00,                           /* target country code */
    0x01,                           /* number of HID Report (or other HID class) Descriptor infos to follow */
    0x22,                           /* descriptor type: report */
    sizeof(keyboard_hid_report), 0, /* total length of report descriptor */
/* Endpoint descriptor */
#    if USB_CFG_HAVE_INTRIN_ENDPOINT /* endpoint descriptor for endpoint 1 */
    7,                               /* sizeof(usbDescrEndpoint) */
    USBDESCR_ENDPOINT,               /* descriptor type = endpoint */
    (char)0x81,                      /* IN endpoint number 1 */
    0x03,                            /* attrib: Interrupt endpoint */
    8, 0,                            /* maximum packet size */
    USB_CFG_INTR_POLL_INTERVAL,      /* in ms */
#    endif

    /*
     * Mouse interface
     */
    /* Interface descriptor */
    9,                             /* sizeof(usbDescrInterface): length of descriptor in bytes */
    USBDESCR_INTERFACE,            /* descriptor type */
    1,                             /* index of this interface */
    0,                             /* alternate setting for this interface */
    USB_CFG_HAVE_INTRIN_ENDPOINT3, /* endpoints excl 0: number of endpoint descriptors to follow */
    0x03,                          /* CLASS: HID */
    0,                             /* SUBCLASS: none */
    0,                             /* PROTOCOL: none */
    0,                             /* string index for interface */
    /* HID descriptor */
    9,                                /* sizeof(usbDescrHID): length of descriptor in bytes */
    USBDESCR_HID,                     /* descriptor type: HID */
    0x01, 0x01,                       /* BCD representation of HID version */
    0x00,                             /* target country code */
    0x01,                             /* number of HID Report (or other HID class) Descriptor infos to follow */
    0x22,                             /* descriptor type: report */
    sizeof(mouse_hid_report), 0,      /* total length of report descriptor */
#    if USB_CFG_HAVE_INTRIN_ENDPOINT3 /* endpoint descriptor for endpoint 3 */
    /* Endpoint descriptor */
    7,                                 /* sizeof(usbDescrEndpoint) */
    USBDESCR_ENDPOINT,                 /* descriptor type = endpoint */
    (char)(0x80 | USB_CFG_EP3_NUMBER), /* IN endpoint number 3 */
    0x03,                              /* attrib: Interrupt endpoint */
    8, 0,                              /* maximum packet size */
    USB_CFG_INTR_POLL_INTERVAL,        /* in ms */
#    endif
};
#endif

USB_PUBLIC usbMsgLen_t usbFunctionDescriptor(struct usbRequest *rq) {
    usbMsgLen_t len = 0;

    /*
        debug("usbFunctionDescriptor: ");
        debug_hex(rq->bmRequestType); debug(" ");
        debug_hex(rq->bRequest); debug(" ");
        debug_hex16(rq->wValue.word); debug(" ");
        debug_hex16(rq->wIndex.word); debug(" ");
        debug_hex16(rq->wLength.word); debug("\n");
    */
    switch (rq->wValue.bytes[1]) {
#if USB_CFG_DESCR_PROPS_CONFIGURATION
        case USBDESCR_CONFIG:
            usbMsgPtr = (unsigned char *)usbDescriptorConfiguration;
            len       = sizeof(usbDescriptorConfiguration);
            break;
#endif
        case USBDESCR_HID:
            switch (rq->wValue.bytes[0]) {
                case 0:
                    usbMsgPtr = (unsigned char *)(usbDescriptorConfiguration + 9 + 9);
                    len       = 9;
                    break;
                case 1:
                    usbMsgPtr = (unsigned char *)(usbDescriptorConfiguration + 9 + (9 + 9 + 7) + 9);
                    len       = 9;
                    break;
            }
            break;
        case USBDESCR_HID_REPORT:
            /* interface index */
            switch (rq->wIndex.word) {
                case 0:
                    usbMsgPtr = (unsigned char *)keyboard_hid_report;
                    len       = sizeof(keyboard_hid_report);
                    break;
                case 1:
                    usbMsgPtr = (unsigned char *)mouse_hid_report;
                    len       = sizeof(mouse_hid_report);
                    break;
            }
            break;
    }
    // debug("desc len: "); debug_hex(len); debug("\n");
    return len;
}