src/libs/USBDevice/USBHID/USBKeyboard.cpp

   1 /* Copyright (c) 2010-2011 mbed.org, MIT License
   2 *
   3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
   4 * and associated documentation files (the "Software"), to deal in the Software without
   5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
   6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
   7 * Software is furnished to do so, subject to the following conditions:
   8 *
   9 * The above copyright notice and this permission notice shall be included in all copies or
  10 * substantial portions of the Software.
  11 *
  12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
  13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
  15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  17 */
  18
  19 #include "stdint.h"
  20
  21 #include "USBKeyboard.h"
  22
  23 #define REPORT_ID_KEYBOARD 1
  24 #define REPORT_ID_VOLUME   3
  25
  26
  27 typedef struct {
  28     unsigned char usage;
  29     unsigned char modifier;
  30 } KEYMAP;
  31
  32 #ifdef US_KEYBOARD
  33 /* US keyboard (as HID standard) */
  34 #define KEYMAP_SIZE (148)
  35 const KEYMAP keymap[KEYMAP_SIZE] = {
  36     {0, 0},             /* NUL */
  37     {0, 0},             /* SOH */
  38     {0, 0},             /* STX */
  39     {0, 0},             /* ETX */
  40     {0, 0},             /* EOT */
  41     {0, 0},             /* ENQ */
  42     {0, 0},             /* ACK */
  43     {0, 0},             /* BEL */
  44     {0x2a, 0},          /* BS  */  /* Keyboard Delete (Backspace) */
  45     {0x2b, 0},          /* TAB */  /* Keyboard Tab */
  46     {0x28, 0},          /* LF  */  /* Keyboard Return (Enter) */
  47     {0, 0},             /* VT  */
  48     {0, 0},             /* FF  */
  49     {0, 0},             /* CR  */
  50     {0, 0},             /* SO  */
  51     {0, 0},             /* SI  */
  52     {0, 0},             /* DEL */
  53     {0, 0},             /* DC1 */
  54     {0, 0},             /* DC2 */
  55     {0, 0},             /* DC3 */
  56     {0, 0},             /* DC4 */
  57     {0, 0},             /* NAK */
  58     {0, 0},             /* SYN */
  59     {0, 0},             /* ETB */
  60     {0, 0},             /* CAN */
  61     {0, 0},             /* EM  */
  62     {0, 0},             /* SUB */
  63     {0, 0},             /* ESC */
  64     {0, 0},             /* FS  */
  65     {0, 0},             /* GS  */
  66     {0, 0},             /* RS  */
  67     {0, 0},             /* US  */
  68     {0x2c, 0},          /*   */
  69     {0x1e, KEY_SHIFT},      /* ! */
  70     {0x34, KEY_SHIFT},      /* " */
  71     {0x20, KEY_SHIFT},      /* # */
  72     {0x21, KEY_SHIFT},      /* $ */
  73     {0x22, KEY_SHIFT},      /* % */
  74     {0x24, KEY_SHIFT},      /* & */
  75     {0x34, 0},          /* ' */
  76     {0x26, KEY_SHIFT},      /* ( */
  77     {0x27, KEY_SHIFT},      /* ) */
  78     {0x25, KEY_SHIFT},      /* * */
  79     {0x2e, KEY_SHIFT},      /* + */
  80     {0x36, 0},          /* , */
  81     {0x2d, 0},          /* - */
  82     {0x37, 0},          /* . */
  83     {0x38, 0},          /* / */
  84     {0x27, 0},          /* 0 */
  85     {0x1e, 0},          /* 1 */
  86     {0x1f, 0},          /* 2 */
  87     {0x20, 0},          /* 3 */
  88     {0x21, 0},          /* 4 */
  89     {0x22, 0},          /* 5 */
  90     {0x23, 0},          /* 6 */
  91     {0x24, 0},          /* 7 */
  92     {0x25, 0},          /* 8 */
  93     {0x26, 0},          /* 9 */
  94     {0x33, KEY_SHIFT},      /* : */
  95     {0x33, 0},          /* ; */
  96     {0x36, KEY_SHIFT},      /* < */
  97     {0x2e, 0},          /* = */
  98     {0x37, KEY_SHIFT},      /* > */
  99     {0x38, KEY_SHIFT},      /* ? */
 100     {0x1f, KEY_SHIFT},      /* @ */
 101     {0x04, KEY_SHIFT},      /* A */
 102     {0x05, KEY_SHIFT},      /* B */
 103     {0x06, KEY_SHIFT},      /* C */
 104     {0x07, KEY_SHIFT},      /* D */
 105     {0x08, KEY_SHIFT},      /* E */
 106     {0x09, KEY_SHIFT},      /* F */
 107     {0x0a, KEY_SHIFT},      /* G */
 108     {0x0b, KEY_SHIFT},      /* H */
 109     {0x0c, KEY_SHIFT},      /* I */
 110     {0x0d, KEY_SHIFT},      /* J */
 111     {0x0e, KEY_SHIFT},      /* K */
 112     {0x0f, KEY_SHIFT},      /* L */
 113     {0x10, KEY_SHIFT},      /* M */
 114     {0x11, KEY_SHIFT},      /* N */
 115     {0x12, KEY_SHIFT},      /* O */
 116     {0x13, KEY_SHIFT},      /* P */
 117     {0x14, KEY_SHIFT},      /* Q */
 118     {0x15, KEY_SHIFT},      /* R */
 119     {0x16, KEY_SHIFT},      /* S */
 120     {0x17, KEY_SHIFT},      /* T */
 121     {0x18, KEY_SHIFT},      /* U */
 122     {0x19, KEY_SHIFT},      /* V */
 123     {0x1a, KEY_SHIFT},      /* W */
 124     {0x1b, KEY_SHIFT},      /* X */
 125     {0x1c, KEY_SHIFT},      /* Y */
 126     {0x1d, KEY_SHIFT},      /* Z */
 127     {0x2f, 0},          /* [ */
 128     {0x31, 0},          /* \ */
 129     {0x30, 0},          /* ] */
 130     {0x23, KEY_SHIFT},      /* ^ */
 131     {0x2d, KEY_SHIFT},      /* _ */
 132     {0x35, 0},          /* ` */
 133     {0x04, 0},          /* a */
 134     {0x05, 0},          /* b */
 135     {0x06, 0},          /* c */
 136     {0x07, 0},          /* d */
 137     {0x08, 0},          /* e */
 138     {0x09, 0},          /* f */
 139     {0x0a, 0},          /* g */
 140     {0x0b, 0},          /* h */
 141     {0x0c, 0},          /* i */
 142     {0x0d, 0},          /* j */
 143     {0x0e, 0},          /* k */
 144     {0x0f, 0},          /* l */
 145     {0x10, 0},          /* m */
 146     {0x11, 0},          /* n */
 147     {0x12, 0},          /* o */
 148     {0x13, 0},          /* p */
 149     {0x14, 0},          /* q */
 150     {0x15, 0},          /* r */
 151     {0x16, 0},          /* s */
 152     {0x17, 0},          /* t */
 153     {0x18, 0},          /* u */
 154     {0x19, 0},          /* v */
 155     {0x1a, 0},          /* w */
 156     {0x1b, 0},          /* x */
 157     {0x1c, 0},          /* y */
 158     {0x1d, 0},          /* z */
 159     {0x2f, KEY_SHIFT},      /* { */
 160     {0x31, KEY_SHIFT},      /* | */
 161     {0x30, KEY_SHIFT},      /* } */
 162     {0x35, KEY_SHIFT},      /* ~ */
 163     {0,0},              /* DEL */
 164
 165     {0x3a, 0},          /* F1 */
 166     {0x3b, 0},          /* F2 */
 167     {0x3c, 0},          /* F3 */
 168     {0x3d, 0},          /* F4 */
 169     {0x3e, 0},          /* F5 */
 170     {0x3f, 0},          /* F6 */
 171     {0x40, 0},          /* F7 */
 172     {0x41, 0},          /* F8 */
 173     {0x42, 0},          /* F9 */
 174     {0x43, 0},          /* F10 */
 175     {0x44, 0},          /* F11 */
 176     {0x45, 0},          /* F12 */
 177
 178     {0x46, 0},          /* PRINT_SCREEN */
 179     {0x47, 0},          /* SCROLL_LOCK */
 180     {0x39, 0},          /* CAPS_LOCK */
 181     {0x53, 0},          /* NUM_LOCK */
 182     {0x49, 0},          /* INSERT */
 183     {0x4a, 0},          /* HOME */
 184     {0x4b, 0},          /* PAGE_UP */
 185     {0x4e, 0},          /* PAGE_DOWN */
 186 };
 187
 188 #else
 189 /* UK keyboard */
 190 #define KEYMAP_SIZE (148)
 191 const KEYMAP keymap[KEYMAP_SIZE] = {
 192     {0, 0},             /* NUL */
 193     {0, 0},             /* SOH */
 194     {0, 0},             /* STX */
 195     {0, 0},             /* ETX */
 196     {0, 0},             /* EOT */
 197     {0, 0},             /* ENQ */
 198     {0, 0},             /* ACK */
 199     {0, 0},             /* BEL */
 200     {0x2a, 0},          /* BS  */  /* Keyboard Delete (Backspace) */
 201     {0x2b, 0},          /* TAB */  /* Keyboard Tab */
 202     {0x28, 0},          /* LF  */  /* Keyboard Return (Enter) */
 203     {0, 0},             /* VT  */
 204     {0, 0},             /* FF  */
 205     {0, 0},             /* CR  */
 206     {0, 0},             /* SO  */
 207     {0, 0},             /* SI  */
 208     {0, 0},             /* DEL */
 209     {0, 0},             /* DC1 */
 210     {0, 0},             /* DC2 */
 211     {0, 0},             /* DC3 */
 212     {0, 0},             /* DC4 */
 213     {0, 0},             /* NAK */
 214     {0, 0},             /* SYN */
 215     {0, 0},             /* ETB */
 216     {0, 0},             /* CAN */
 217     {0, 0},             /* EM  */
 218     {0, 0},             /* SUB */
 219     {0, 0},             /* ESC */
 220     {0, 0},             /* FS  */
 221     {0, 0},             /* GS  */
 222     {0, 0},             /* RS  */
 223     {0, 0},             /* US  */
 224     {0x2c, 0},          /*   */
 225     {0x1e, KEY_SHIFT},      /* ! */
 226     {0x1f, KEY_SHIFT},      /* " */
 227     {0x32, 0},          /* # */
 228     {0x21, KEY_SHIFT},      /* $ */
 229     {0x22, KEY_SHIFT},      /* % */
 230     {0x24, KEY_SHIFT},      /* & */
 231     {0x34, 0},          /* ' */
 232     {0x26, KEY_SHIFT},      /* ( */
 233     {0x27, KEY_SHIFT},      /* ) */
 234     {0x25, KEY_SHIFT},      /* * */
 235     {0x2e, KEY_SHIFT},      /* + */
 236     {0x36, 0},          /* , */
 237     {0x2d, 0},          /* - */
 238     {0x37, 0},          /* . */
 239     {0x38, 0},          /* / */
 240     {0x27, 0},          /* 0 */
 241     {0x1e, 0},          /* 1 */
 242     {0x1f, 0},          /* 2 */
 243     {0x20, 0},          /* 3 */
 244     {0x21, 0},          /* 4 */
 245     {0x22, 0},          /* 5 */
 246     {0x23, 0},          /* 6 */
 247     {0x24, 0},          /* 7 */
 248     {0x25, 0},          /* 8 */
 249     {0x26, 0},          /* 9 */
 250     {0x33, KEY_SHIFT},      /* : */
 251     {0x33, 0},          /* ; */
 252     {0x36, KEY_SHIFT},      /* < */
 253     {0x2e, 0},          /* = */
 254     {0x37, KEY_SHIFT},      /* > */
 255     {0x38, KEY_SHIFT},      /* ? */
 256     {0x34, KEY_SHIFT},      /* @ */
 257     {0x04, KEY_SHIFT},      /* A */
 258     {0x05, KEY_SHIFT},      /* B */
 259     {0x06, KEY_SHIFT},      /* C */
 260     {0x07, KEY_SHIFT},      /* D */
 261     {0x08, KEY_SHIFT},      /* E */
 262     {0x09, KEY_SHIFT},      /* F */
 263     {0x0a, KEY_SHIFT},      /* G */
 264     {0x0b, KEY_SHIFT},      /* H */
 265     {0x0c, KEY_SHIFT},      /* I */
 266     {0x0d, KEY_SHIFT},      /* J */
 267     {0x0e, KEY_SHIFT},      /* K */
 268     {0x0f, KEY_SHIFT},      /* L */
 269     {0x10, KEY_SHIFT},      /* M */
 270     {0x11, KEY_SHIFT},      /* N */
 271     {0x12, KEY_SHIFT},      /* O */
 272     {0x13, KEY_SHIFT},      /* P */
 273     {0x14, KEY_SHIFT},      /* Q */
 274     {0x15, KEY_SHIFT},      /* R */
 275     {0x16, KEY_SHIFT},      /* S */
 276     {0x17, KEY_SHIFT},      /* T */
 277     {0x18, KEY_SHIFT},      /* U */
 278     {0x19, KEY_SHIFT},      /* V */
 279     {0x1a, KEY_SHIFT},      /* W */
 280     {0x1b, KEY_SHIFT},      /* X */
 281     {0x1c, KEY_SHIFT},      /* Y */
 282     {0x1d, KEY_SHIFT},      /* Z */
 283     {0x2f, 0},          /* [ */
 284     {0x64, 0},          /* \ */
 285     {0x30, 0},          /* ] */
 286     {0x23, KEY_SHIFT},      /* ^ */
 287     {0x2d, KEY_SHIFT},      /* _ */
 288     {0x35, 0},          /* ` */
 289     {0x04, 0},          /* a */
 290     {0x05, 0},          /* b */
 291     {0x06, 0},          /* c */
 292     {0x07, 0},          /* d */
 293     {0x08, 0},          /* e */
 294     {0x09, 0},          /* f */
 295     {0x0a, 0},          /* g */
 296     {0x0b, 0},          /* h */
 297     {0x0c, 0},          /* i */
 298     {0x0d, 0},          /* j */
 299     {0x0e, 0},          /* k */
 300     {0x0f, 0},          /* l */
 301     {0x10, 0},          /* m */
 302     {0x11, 0},          /* n */
 303     {0x12, 0},          /* o */
 304     {0x13, 0},          /* p */
 305     {0x14, 0},          /* q */
 306     {0x15, 0},          /* r */
 307     {0x16, 0},          /* s */
 308     {0x17, 0},          /* t */
 309     {0x18, 0},          /* u */
 310     {0x19, 0},          /* v */
 311     {0x1a, 0},          /* w */
 312     {0x1b, 0},          /* x */
 313     {0x1c, 0},          /* y */
 314     {0x1d, 0},          /* z */
 315     {0x2f, KEY_SHIFT},      /* { */
 316     {0x64, KEY_SHIFT},      /* | */
 317     {0x30, KEY_SHIFT},      /* } */
 318     {0x32, KEY_SHIFT},      /* ~ */
 319     {0,0},             /* DEL */
 320
 321     {0x3a, 0},          /* F1 */
 322     {0x3b, 0},          /* F2 */
 323     {0x3c, 0},          /* F3 */
 324     {0x3d, 0},          /* F4 */
 325     {0x3e, 0},          /* F5 */
 326     {0x3f, 0},          /* F6 */
 327     {0x40, 0},          /* F7 */
 328     {0x41, 0},          /* F8 */
 329     {0x42, 0},          /* F9 */
 330     {0x43, 0},          /* F10 */
 331     {0x44, 0},          /* F11 */
 332     {0x45, 0},          /* F12 */
 333
 334     {0x46, 0},          /* PRINT_SCREEN */
 335     {0x47, 0},          /* SCROLL_LOCK */
 336     {0x39, 0},          /* CAPS_LOCK */
 337     {0x53, 0},          /* NUM_LOCK */
 338     {0x49, 0},          /* INSERT */
 339     {0x4a, 0},          /* HOME */
 340     {0x4b, 0},          /* PAGE_UP */
 341     {0x4e, 0},          /* PAGE_DOWN */
 342 };
 343 #endif
 344
 345 uint8_t * USBKeyboard::reportDesc() {
 346     static uint8_t reportDescriptor[] = {
 347         USAGE_PAGE(1), 0x01,                    // Generic Desktop
 348         USAGE(1), 0x06,                         // Keyboard
 349         COLLECTION(1), 0x01,                    // Application
 350         REPORT_ID(1),       REPORT_ID_KEYBOARD,
 351
 352         USAGE_PAGE(1), 0x07,                    // Key Codes
 353         USAGE_MINIMUM(1), 0xE0,
 354         USAGE_MAXIMUM(1), 0xE7,
 355         LOGICAL_MINIMUM(1), 0x00,
 356         LOGICAL_MAXIMUM(1), 0x01,
 357         REPORT_SIZE(1), 0x01,
 358         REPORT_COUNT(1), 0x08,
 359         INPUT(1), 0x02,                         // Data, Variable, Absolute
 360         REPORT_COUNT(1), 0x01,
 361         REPORT_SIZE(1), 0x08,
 362         INPUT(1), 0x01,                         // Constant
 363
 364
 365         REPORT_COUNT(1), 0x05,
 366         REPORT_SIZE(1), 0x01,
 367         USAGE_PAGE(1), 0x08,                    // LEDs
 368         USAGE_MINIMUM(1), 0x01,
 369         USAGE_MAXIMUM(1), 0x05,
 370         OUTPUT(1), 0x02,                        // Data, Variable, Absolute
 371         REPORT_COUNT(1), 0x01,
 372         REPORT_SIZE(1), 0x03,
 373         OUTPUT(1), 0x01,                        // Constant
 374
 375
 376         REPORT_COUNT(1), 0x06,
 377         REPORT_SIZE(1), 0x08,
 378         LOGICAL_MINIMUM(1), 0x00,
 379         LOGICAL_MAXIMUM(1), 0x65,
 380         USAGE_PAGE(1), 0x07,                    // Key Codes
 381         USAGE_MINIMUM(1), 0x00,
 382         USAGE_MAXIMUM(1), 0x65,
 383         INPUT(1), 0x00,                         // Data, Array
 384         END_COLLECTION(0),
 385
 386         // Media Control
 387         USAGE_PAGE(1), 0x0C,
 388         USAGE(1), 0x01,
 389         COLLECTION(1), 0x01,
 390         REPORT_ID(1), REPORT_ID_VOLUME,
 391         USAGE_PAGE(1), 0x0C,
 392         LOGICAL_MINIMUM(1), 0x00,
 393         LOGICAL_MAXIMUM(1), 0x01,
 394         REPORT_SIZE(1), 0x01,
 395         REPORT_COUNT(1), 0x07,
 396         USAGE(1), 0xB5,             // Next Track
 397         USAGE(1), 0xB6,             // Previous Track
 398         USAGE(1), 0xB7,             // Stop
 399         USAGE(1), 0xCD,             // Play / Pause
 400         USAGE(1), 0xE2,             // Mute
 401         USAGE(1), 0xE9,             // Volume Up
 402         USAGE(1), 0xEA,             // Volume Down
 403         INPUT(1), 0x02,             // Input (Data, Variable, Absolute)
 404         REPORT_COUNT(1), 0x01,
 405         INPUT(1), 0x01,
 406         END_COLLECTION(0),
 407     };
 408     reportLength = sizeof(reportDescriptor);
 409     return reportDescriptor;
 410 }
 411
 412
 413 bool USBKeyboard::EP1_OUT_callback() {
 414     uint16_t bytesRead = 0;
 415     uint8_t led[65];
 416     USBDevice::readEP(EPINT_OUT, led, &bytesRead, MAX_HID_REPORT_SIZE);
 417
 418     // we take led[1] because led[0] is the report ID
 419     lock_status = led[1] & 0x07;
 420
 421     // We activate the endpoint to be able to recceive data
 422     if (!readStart(EPINT_OUT, MAX_HID_REPORT_SIZE))
 423         return false;
 424     return true;
 425 }
 426
 427 uint8_t USBKeyboard::lockStatus() {
 428     return lock_status;
 429 }
 430
 431 int USBKeyboard::_putc(int c) {
 432     return keyCode(c, keymap[c].modifier);
 433 }
 434
 435 bool USBKeyboard::keyCode(uint8_t key, uint8_t modifier) {
 436     // Send a simulated keyboard keypress. Returns true if successful.
 437     HID_REPORT report;
 438
 439     report.data[0] = REPORT_ID_KEYBOARD;
 440     report.data[1] = modifier;
 441     report.data[2] = 0;
 442     report.data[3] = keymap[key].usage;
 443     report.data[4] = 0;
 444     report.data[5] = 0;
 445     report.data[6] = 0;
 446     report.data[7] = 0;
 447     report.data[8] = 0;
 448
 449     report.length = 9;
 450
 451     if (!send(&report)) {
 452         return false;
 453     }
 454
 455     report.data[1] = 0;
 456     report.data[3] = 0;
 457
 458     if (!send(&report)) {
 459         return false;
 460     }
 461
 462     return true;
 463
 464 }
 465
 466
 467 bool USBKeyboard::mediaControl(MEDIA_KEY key) {
 468     HID_REPORT report;
 469
 470     report.data[0] = REPORT_ID_VOLUME;
 471     report.data[1] = (1 << key) & 0x7f;
 472
 473     report.length = 2;
 474
 475     if (!send(&report)) {
 476         return false;
 477     }
 478
 479     report.data[0] = REPORT_ID_VOLUME;
 480     report.data[1] = 0;
 481
 482     report.length = 2;
 483
 484     return send(&report);
 485 }