tmk_core/protocol/vusb/vusb.c

   1 /*
   2 Copyright 2011 Jun Wako <wakojun@gmail.com>
   3
   4 This program is free software: you can redistribute it and/or modify
   5 it under the terms of the GNU General Public License as published by
   6 the Free Software Foundation, either version 2 of the License, or
   7 (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 */
  17
  18 #include <stdint.h>
  19 #include "usbdrv.h"
  20 #include "usbconfig.h"
  21 #include "host.h"
  22 #include "report.h"
  23 #include "print.h"
  24 #include "debug.h"
  25 #include "host_driver.h"
  26 #include "vusb.h"
  27
  28
  29 static uint8_t vusb_keyboard_leds = 0;
  30 static uint8_t vusb_idle_rate = 0;
  31
  32 /* Keyboard report send buffer */
  33 #define KBUF_SIZE 16
  34 static report_keyboard_t kbuf[KBUF_SIZE];
  35 static uint8_t kbuf_head = 0;
  36 static uint8_t kbuf_tail = 0;
  37
  38 typedef struct {
  39         uint8_t modifier;
  40         uint8_t reserved;
  41         uint8_t keycode[6];
  42 } keyboard_report_t;
  43
  44 static keyboard_report_t keyboard_report; // sent to PC
  45
  46 /* transfer keyboard report from buffer */
  47 void vusb_transfer_keyboard(void)
  48 {
  49     if (usbInterruptIsReady()) {
  50         if (kbuf_head != kbuf_tail) {
  51             usbSetInterrupt((void *)&kbuf[kbuf_tail], sizeof(report_keyboard_t));
  52             kbuf_tail = (kbuf_tail + 1) % KBUF_SIZE;
  53             if (debug_keyboard) {
  54                 print("V-USB: kbuf["); pdec(kbuf_tail); print("->"); pdec(kbuf_head); print("](");
  55                 phex((kbuf_head < kbuf_tail) ? (KBUF_SIZE - kbuf_tail + kbuf_head) : (kbuf_head - kbuf_tail));
  56                 print(")\n");
  57             }
  58         }
  59     }
  60 }
  61
  62
  63 /*------------------------------------------------------------------*
  64  * Host driver
  65  *------------------------------------------------------------------*/
  66 static uint8_t keyboard_leds(void);
  67 static void send_keyboard(report_keyboard_t *report);
  68 static void send_mouse(report_mouse_t *report);
  69 static void send_system(uint16_t data);
  70 static void send_consumer(uint16_t data);
  71
  72 static host_driver_t driver = {
  73         keyboard_leds,
  74         send_keyboard,
  75         send_mouse,
  76         send_system,
  77         send_consumer
  78 };
  79
  80 host_driver_t *vusb_driver(void)
  81 {
  82     return &driver;
  83 }
  84
  85 static uint8_t keyboard_leds(void) {
  86     return vusb_keyboard_leds;
  87 }
  88
  89 static void send_keyboard(report_keyboard_t *report)
  90 {
  91     uint8_t next = (kbuf_head + 1) % KBUF_SIZE;
  92     if (next != kbuf_tail) {
  93         kbuf[kbuf_head] = *report;
  94         kbuf_head = next;
  95     } else {
  96         debug("kbuf: full\n");
  97     }
  98
  99     // NOTE: send key strokes of Macro
 100     usbPoll();
 101     vusb_transfer_keyboard();
 102 }
 103
 104
 105 typedef struct {
 106     uint8_t report_id;
 107     report_mouse_t report;
 108 } __attribute__ ((packed)) vusb_mouse_report_t;
 109
 110 static void send_mouse(report_mouse_t *report)
 111 {
 112     vusb_mouse_report_t r = {
 113         .report_id = REPORT_ID_MOUSE,
 114         .report = *report
 115     };
 116     if (usbInterruptIsReady3()) {
 117         usbSetInterrupt3((void *)&r, sizeof(vusb_mouse_report_t));
 118     }
 119 }
 120
 121
 122 typedef struct {
 123     uint8_t  report_id;
 124     uint16_t usage;
 125 } __attribute__ ((packed)) report_extra_t;
 126
 127 static void send_system(uint16_t data)
 128 {
 129     static uint16_t last_data = 0;
 130     if (data == last_data) return;
 131     last_data = data;
 132
 133     report_extra_t report = {
 134         .report_id = REPORT_ID_SYSTEM,
 135         .usage = data
 136     };
 137     if (usbInterruptIsReady3()) {
 138         usbSetInterrupt3((void *)&report, sizeof(report));
 139     }
 140 }
 141
 142 static void send_consumer(uint16_t data)
 143 {
 144     static uint16_t last_data = 0;
 145     if (data == last_data) return;
 146     last_data = data;
 147
 148     report_extra_t report = {
 149         .report_id = REPORT_ID_CONSUMER,
 150         .usage = data
 151     };
 152     if (usbInterruptIsReady3()) {
 153         usbSetInterrupt3((void *)&report, sizeof(report));
 154     }
 155 }
 156
 157
 158
 159 /*------------------------------------------------------------------*
 160  * Request from host                                                *
 161  *------------------------------------------------------------------*/
 162 static struct {
 163     uint16_t        len;
 164     enum {
 165         NONE,
 166         SET_LED
 167     }               kind;
 168 } last_req;
 169
 170 usbMsgLen_t usbFunctionSetup(uchar data[8])
 171 {
 172 usbRequest_t    *rq = (void *)data;
 173
 174     if((rq->bmRequestType & USBRQ_TYPE_MASK) == USBRQ_TYPE_CLASS){    /* class request type */
 175         if(rq->bRequest == USBRQ_HID_GET_REPORT){
 176             debug("GET_REPORT:");
 177             /* we only have one report type, so don't look at wValue */
 178             usbMsgPtr = (void *)&keyboard_report;
 179             return sizeof(keyboard_report);
 180         }else if(rq->bRequest == USBRQ_HID_GET_IDLE){
 181             debug("GET_IDLE: ");
 182             //debug_hex(vusb_idle_rate);
 183             usbMsgPtr = &vusb_idle_rate;
 184             return 1;
 185         }else if(rq->bRequest == USBRQ_HID_SET_IDLE){
 186             vusb_idle_rate = rq->wValue.bytes[1];
 187             debug("SET_IDLE: ");
 188             debug_hex(vusb_idle_rate);
 189         }else if(rq->bRequest == USBRQ_HID_SET_REPORT){
 190             debug("SET_REPORT: ");
 191             // Report Type: 0x02(Out)/ReportID: 0x00(none) && Interface: 0(keyboard)
 192             if (rq->wValue.word == 0x0200 && rq->wIndex.word == 0) {
 193                 debug("SET_LED: ");
 194                 last_req.kind = SET_LED;
 195                 last_req.len = rq->wLength.word;
 196             }
 197             return USB_NO_MSG; // to get data in usbFunctionWrite
 198         } else {
 199             debug("UNKNOWN:");
 200         }
 201     }else{
 202         debug("VENDOR:");
 203         /* no vendor specific requests implemented */
 204     }
 205     debug("\n");
 206     return 0;   /* default for not implemented requests: return no data back to host */
 207 }
 208
 209 uchar usbFunctionWrite(uchar *data, uchar len)
 210 {
 211     if (last_req.len == 0) {
 212         return -1;
 213     }
 214     switch (last_req.kind) {
 215         case SET_LED:
 216             debug("SET_LED: ");
 217             debug_hex(data[0]);
 218             debug("\n");
 219             vusb_keyboard_leds = data[0];
 220             last_req.len = 0;
 221             return 1;
 222             break;
 223         case NONE:
 224         default:
 225             return -1;
 226             break;
 227     }
 228     return 1;
 229 }
 230
 231
 232
 233 /*------------------------------------------------------------------*
 234  * Descriptors                                                      *
 235  *------------------------------------------------------------------*/
 236
 237 /*
 238  * Report Descriptor for keyboard
 239  *
 240  * from an example in HID spec appendix
 241  */
 242 const PROGMEM uchar keyboard_hid_report[] = {
 243     0x05, 0x01,          // Usage Page (Generic Desktop),
 244     0x09, 0x06,          // Usage (Keyboard),
 245     0xA1, 0x01,          // Collection (Application),
 246     0x75, 0x01,          //   Report Size (1),
 247     0x95, 0x08,          //   Report Count (8),
 248     0x05, 0x07,          //   Usage Page (Key Codes),
 249     0x19, 0xE0,          //   Usage Minimum (224),
 250     0x29, 0xE7,          //   Usage Maximum (231),
 251     0x15, 0x00,          //   Logical Minimum (0),
 252     0x25, 0x01,          //   Logical Maximum (1),
 253     0x81, 0x02,          //   Input (Data, Variable, Absolute), ;Modifier byte
 254     0x95, 0x01,          //   Report Count (1),
 255     0x75, 0x08,          //   Report Size (8),
 256     0x81, 0x03,          //   Input (Constant),                 ;Reserved byte
 257     0x95, 0x05,          //   Report Count (5),
 258     0x75, 0x01,          //   Report Size (1),
 259     0x05, 0x08,          //   Usage Page (LEDs),
 260     0x19, 0x01,          //   Usage Minimum (1),
 261     0x29, 0x05,          //   Usage Maximum (5),
 262     0x91, 0x02,          //   Output (Data, Variable, Absolute), ;LED report
 263     0x95, 0x01,          //   Report Count (1),
 264     0x75, 0x03,          //   Report Size (3),
 265     0x91, 0x03,          //   Output (Constant),                 ;LED report padding
 266     0x95, 0x06,          //   Report Count (6),
 267     0x75, 0x08,          //   Report Size (8),
 268     0x15, 0x00,          //   Logical Minimum (0),
 269     0x25, 0xFF,          //   Logical Maximum(255),
 270     0x05, 0x07,          //   Usage Page (Key Codes),
 271     0x19, 0x00,          //   Usage Minimum (0),
 272     0x29, 0xFF,          //   Usage Maximum (255),
 273     0x81, 0x00,          //   Input (Data, Array),
 274     0xc0                 // End Collection
 275 };
 276
 277 /*
 278  * Report Descriptor for mouse
 279  *
 280  * Mouse Protocol 1, HID 1.11 spec, Appendix B, page 59-60, with wheel extension
 281  * http://www.microchip.com/forums/tm.aspx?high=&m=391435&mpage=1#391521
 282  * http://www.keil.com/forum/15671/
 283  * http://www.microsoft.com/whdc/device/input/wheel.mspx
 284  */
 285 const PROGMEM uchar mouse_hid_report[] = {
 286     /* mouse */
 287     0x05, 0x01,                    // USAGE_PAGE (Generic Desktop)
 288     0x09, 0x02,                    // USAGE (Mouse)
 289     0xa1, 0x01,                    // COLLECTION (Application)
 290     0x85, REPORT_ID_MOUSE,         //   REPORT_ID (1)
 291     0x09, 0x01,                    //   USAGE (Pointer)
 292     0xa1, 0x00,                    //   COLLECTION (Physical)
 293                                    // ----------------------------  Buttons
 294     0x05, 0x09,                    //     USAGE_PAGE (Button)
 295     0x19, 0x01,                    //     USAGE_MINIMUM (Button 1)
 296     0x29, 0x05,                    //     USAGE_MAXIMUM (Button 5)
 297     0x15, 0x00,                    //     LOGICAL_MINIMUM (0)
 298     0x25, 0x01,                    //     LOGICAL_MAXIMUM (1)
 299     0x75, 0x01,                    //     REPORT_SIZE (1)
 300     0x95, 0x05,                    //     REPORT_COUNT (5)
 301     0x81, 0x02,                    //     INPUT (Data,Var,Abs)
 302     0x75, 0x03,                    //     REPORT_SIZE (3)
 303     0x95, 0x01,                    //     REPORT_COUNT (1)
 304     0x81, 0x03,                    //     INPUT (Cnst,Var,Abs)
 305                                    // ----------------------------  X,Y position
 306     0x05, 0x01,                    //     USAGE_PAGE (Generic Desktop)
 307     0x09, 0x30,                    //     USAGE (X)
 308     0x09, 0x31,                    //     USAGE (Y)
 309     0x15, 0x81,                    //     LOGICAL_MINIMUM (-127)
 310     0x25, 0x7f,                    //     LOGICAL_MAXIMUM (127)
 311     0x75, 0x08,                    //     REPORT_SIZE (8)
 312     0x95, 0x02,                    //     REPORT_COUNT (2)
 313     0x81, 0x06,                    //     INPUT (Data,Var,Rel)
 314                                    // ----------------------------  Vertical wheel
 315     0x09, 0x38,                    //     USAGE (Wheel)
 316     0x15, 0x81,                    //     LOGICAL_MINIMUM (-127)
 317     0x25, 0x7f,                    //     LOGICAL_MAXIMUM (127)
 318     0x35, 0x00,                    //     PHYSICAL_MINIMUM (0)        - reset physical
 319     0x45, 0x00,                    //     PHYSICAL_MAXIMUM (0)
 320     0x75, 0x08,                    //     REPORT_SIZE (8)
 321     0x95, 0x01,                    //     REPORT_COUNT (1)
 322     0x81, 0x06,                    //     INPUT (Data,Var,Rel)
 323                                    // ----------------------------  Horizontal wheel
 324     0x05, 0x0c,                    //     USAGE_PAGE (Consumer Devices)
 325     0x0a, 0x38, 0x02,              //     USAGE (AC Pan)
 326     0x15, 0x81,                    //     LOGICAL_MINIMUM (-127)
 327     0x25, 0x7f,                    //     LOGICAL_MAXIMUM (127)
 328     0x75, 0x08,                    //     REPORT_SIZE (8)
 329     0x95, 0x01,                    //     REPORT_COUNT (1)
 330     0x81, 0x06,                    //     INPUT (Data,Var,Rel)
 331     0xc0,                          //   END_COLLECTION
 332     0xc0,                          // END_COLLECTION
 333     /* system control */
 334     0x05, 0x01,                    // USAGE_PAGE (Generic Desktop)
 335     0x09, 0x80,                    // USAGE (System Control)
 336     0xa1, 0x01,                    // COLLECTION (Application)
 337     0x85, REPORT_ID_SYSTEM,        //   REPORT_ID (2)
 338     0x15, 0x01,                    //   LOGICAL_MINIMUM (0x1)
 339     0x25, 0xb7,                    //   LOGICAL_MAXIMUM (0xb7)
 340     0x19, 0x01,                    //   USAGE_MINIMUM (0x1)
 341     0x29, 0xb7,                    //   USAGE_MAXIMUM (0xb7)
 342     0x75, 0x10,                    //   REPORT_SIZE (16)
 343     0x95, 0x01,                    //   REPORT_COUNT (1)
 344     0x81, 0x00,                    //   INPUT (Data,Array,Abs)
 345     0xc0,                          // END_COLLECTION
 346     /* consumer */
 347     0x05, 0x0c,                    // USAGE_PAGE (Consumer Devices)
 348     0x09, 0x01,                    // USAGE (Consumer Control)
 349     0xa1, 0x01,                    // COLLECTION (Application)
 350     0x85, REPORT_ID_CONSUMER,      //   REPORT_ID (3)
 351     0x15, 0x01,                    //   LOGICAL_MINIMUM (0x1)
 352     0x26, 0x9c, 0x02,              //   LOGICAL_MAXIMUM (0x29c)
 353     0x19, 0x01,                    //   USAGE_MINIMUM (0x1)
 354     0x2a, 0x9c, 0x02,              //   USAGE_MAXIMUM (0x29c)
 355     0x75, 0x10,                    //   REPORT_SIZE (16)
 356     0x95, 0x01,                    //   REPORT_COUNT (1)
 357     0x81, 0x00,                    //   INPUT (Data,Array,Abs)
 358     0xc0,                          // END_COLLECTION
 359 };
 360
 361
 362 /*
 363  * Descriptor for compite device: Keyboard + Mouse
 364  *
 365  * contains: device, interface, HID and endpoint descriptors
 366  */
 367 #if USB_CFG_DESCR_PROPS_CONFIGURATION
 368 const PROGMEM char usbDescriptorConfiguration[] = {    /* USB configuration descriptor */
 369     9,          /* sizeof(usbDescriptorConfiguration): length of descriptor in bytes */
 370     USBDESCR_CONFIG,    /* descriptor type */
 371     9 + (9 + 9 + 7) + (9 + 9 + 7), 0,
 372     //18 + 7 * USB_CFG_HAVE_INTRIN_ENDPOINT + 7 * USB_CFG_HAVE_INTRIN_ENDPOINT3 + 9, 0,
 373                 /* total length of data returned (including inlined descriptors) */
 374     2,          /* number of interfaces in this configuration */
 375     1,          /* index of this configuration */
 376     0,          /* configuration name string index */
 377 #if USB_CFG_IS_SELF_POWERED
 378     (1 << 7) | USBATTR_SELFPOWER,       /* attributes */
 379 #else
 380     (1 << 7),                           /* attributes */
 381 #endif
 382     USB_CFG_MAX_BUS_POWER/2,            /* max USB current in 2mA units */
 383
 384     /*
 385      * Keyboard interface
 386      */
 387     /* Interface descriptor */
 388     9,          /* sizeof(usbDescrInterface): length of descriptor in bytes */
 389     USBDESCR_INTERFACE, /* descriptor type */
 390     0,          /* index of this interface */
 391     0,          /* alternate setting for this interface */
 392     USB_CFG_HAVE_INTRIN_ENDPOINT, /* endpoints excl 0: number of endpoint descriptors to follow */
 393     USB_CFG_INTERFACE_CLASS,
 394     USB_CFG_INTERFACE_SUBCLASS,
 395     USB_CFG_INTERFACE_PROTOCOL,
 396     0,          /* string index for interface */
 397     /* HID descriptor */
 398     9,          /* sizeof(usbDescrHID): length of descriptor in bytes */
 399     USBDESCR_HID,   /* descriptor type: HID */
 400     0x01, 0x01, /* BCD representation of HID version */
 401     0x00,       /* target country code */
 402     0x01,       /* number of HID Report (or other HID class) Descriptor infos to follow */
 403     0x22,       /* descriptor type: report */
 404     sizeof(keyboard_hid_report), 0,  /* total length of report descriptor */
 405     /* Endpoint descriptor */
 406 #if USB_CFG_HAVE_INTRIN_ENDPOINT    /* endpoint descriptor for endpoint 1 */
 407     7,          /* sizeof(usbDescrEndpoint) */
 408     USBDESCR_ENDPOINT,  /* descriptor type = endpoint */
 409     (char)0x81, /* IN endpoint number 1 */
 410     0x03,       /* attrib: Interrupt endpoint */
 411     8, 0,       /* maximum packet size */
 412     USB_CFG_INTR_POLL_INTERVAL, /* in ms */
 413 #endif
 414
 415     /*
 416      * Mouse interface
 417      */
 418     /* Interface descriptor */
 419     9,          /* sizeof(usbDescrInterface): length of descriptor in bytes */
 420     USBDESCR_INTERFACE, /* descriptor type */
 421     1,          /* index of this interface */
 422     0,          /* alternate setting for this interface */
 423     USB_CFG_HAVE_INTRIN_ENDPOINT3, /* endpoints excl 0: number of endpoint descriptors to follow */
 424     0x03,       /* CLASS: HID */
 425     0,          /* SUBCLASS: none */
 426     0,          /* PROTOCOL: none */
 427     0,          /* string index for interface */
 428     /* HID descriptor */
 429     9,          /* sizeof(usbDescrHID): length of descriptor in bytes */
 430     USBDESCR_HID,   /* descriptor type: HID */
 431     0x01, 0x01, /* BCD representation of HID version */
 432     0x00,       /* target country code */
 433     0x01,       /* number of HID Report (or other HID class) Descriptor infos to follow */
 434     0x22,       /* descriptor type: report */
 435     sizeof(mouse_hid_report), 0,  /* total length of report descriptor */
 436 #if USB_CFG_HAVE_INTRIN_ENDPOINT3   /* endpoint descriptor for endpoint 3 */
 437     /* Endpoint descriptor */
 438     7,          /* sizeof(usbDescrEndpoint) */
 439     USBDESCR_ENDPOINT,  /* descriptor type = endpoint */
 440     (char)(0x80 | USB_CFG_EP3_NUMBER), /* IN endpoint number 3 */
 441     0x03,       /* attrib: Interrupt endpoint */
 442     8, 0,       /* maximum packet size */
 443     USB_CFG_INTR_POLL_INTERVAL, /* in ms */
 444 #endif
 445 };
 446 #endif
 447
 448
 449 USB_PUBLIC usbMsgLen_t usbFunctionDescriptor(struct usbRequest *rq)
 450 {
 451     usbMsgLen_t len = 0;
 452
 453 /*
 454     debug("usbFunctionDescriptor: ");
 455     debug_hex(rq->bmRequestType); debug(" ");
 456     debug_hex(rq->bRequest); debug(" ");
 457     debug_hex16(rq->wValue.word); debug(" ");
 458     debug_hex16(rq->wIndex.word); debug(" ");
 459     debug_hex16(rq->wLength.word); debug("\n");
 460 */
 461     switch (rq->wValue.bytes[1]) {
 462 #if USB_CFG_DESCR_PROPS_CONFIGURATION
 463         case USBDESCR_CONFIG:
 464             usbMsgPtr = (unsigned char *)usbDescriptorConfiguration;
 465             len = sizeof(usbDescriptorConfiguration);
 466             break;
 467 #endif
 468         case USBDESCR_HID:
 469             switch (rq->wValue.bytes[0]) {
 470                 case 0:
 471                     usbMsgPtr = (unsigned char *)(usbDescriptorConfiguration + 9 + 9);
 472                     len = 9;
 473                     break;
 474                 case 1:
 475                     usbMsgPtr = (unsigned char *)(usbDescriptorConfiguration + 9 + (9 + 9 + 7) + 9);
 476                     len = 9;
 477                     break;
 478             }
 479             break;
 480         case USBDESCR_HID_REPORT:
 481             /* interface index */
 482             switch (rq->wIndex.word) {
 483                 case 0:
 484                     usbMsgPtr = keyboard_hid_report;
 485                     len = sizeof(keyboard_hid_report);
 486                     break;
 487                 case 1:
 488                     usbMsgPtr = mouse_hid_report;
 489                     len = sizeof(mouse_hid_report);
 490                     break;
 491             }
 492             break;
 493     }
 494     //debug("desc len: "); debug_hex(len); debug("\n");
 495     return len;
 496 }