converter/ibmpc_usb/ibmpc_usb.c

   1 /*
   2 Copyright 2019,2020 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 <stdbool.h>
  20 #include "print.h"
  21 #include "util.h"
  22 #include "debug.h"
  23 #include "ibmpc.h"
  24 #include "host.h"
  25 #include "led.h"
  26 #include "matrix.h"
  27 #include "timer.h"
  28 #include "action.h"
  29 #include "ibmpc_usb.h"
  30 #include "ibmpc.h"
  31
  32
  33 static void matrix_make(uint8_t code);
  34 static void matrix_break(uint8_t code);
  35
  36 static int8_t process_cs1(void);
  37 static int8_t process_cs2(void);
  38 static int8_t process_cs3(void);
  39
  40
  41 static uint8_t matrix[MATRIX_ROWS];
  42 #define ROW(code)      ((code>>3)&0x0F)
  43 #define COL(code)      (code&0x07)
  44
  45 static int16_t read_wait(uint16_t wait_ms)
  46 {
  47     uint16_t start = timer_read();
  48     int16_t code;
  49     while ((code = ibmpc_host_recv()) == -1 && timer_elapsed(start) < wait_ms);
  50     return code;
  51 }
  52
  53 static uint16_t read_keyboard_id(void)
  54 {
  55     uint16_t id = 0;
  56     int16_t  code = 0;
  57
  58     // Disable
  59     //code = ibmpc_host_send(0xF5);
  60
  61     // Read ID
  62     code = ibmpc_host_send(0xF2);
  63     if (code == -1) { id = 0xFFFF; goto DONE; }     // XT or No keyboard
  64     if (code != 0xFA) { id = 0xFFFE; goto DONE; }   // Broken PS/2?
  65
  66     // ID takes 500ms max TechRef [8] 4-41
  67     code = read_wait(500);
  68     if (code == -1) { id = 0x0000; goto DONE; }     // AT
  69     id = (code & 0xFF)<<8;
  70
  71     // Mouse responds with one-byte 00, this returns 00FF [y] p.14
  72     code = read_wait(500);
  73     id |= code & 0xFF;
  74
  75 DONE:
  76     // Enable
  77     //code = ibmpc_host_send(0xF4);
  78
  79     return id;
  80 }
  81
  82 void hook_early_init(void)
  83 {
  84     ibmpc_host_init();
  85     ibmpc_host_enable();
  86 }
  87
  88 void matrix_init(void)
  89 {
  90     debug_enable = true;
  91
  92     // initialize matrix state: all keys off
  93     for (uint8_t i=0; i < MATRIX_ROWS; i++) matrix[i] = 0x00;
  94
  95     return;
  96 }
  97
  98 /*
  99  * keyboard recognition
 100  *
 101  * 1. Send F2 to get keyboard ID
 102  *      a. no ACK(FA): XT keyobard
 103  *      b. ACK but no ID: 84-key AT keyboard CodeSet2
 104  *      c. ID is AB 83: PS/2 keyboard CodeSet2
 105  *      d. ID is BF BF: Terminal keyboard CodeSet3
 106  *      e. error on recv: maybe broken PS/2
 107  */
 108 uint16_t keyboard_id = 0x0000;
 109 keyboard_kind_t keyboard_kind = NONE;
 110 uint8_t matrix_scan(void)
 111 {
 112     // scan code reading states
 113     static enum {
 114         INIT,
 115         XT_RESET,
 116         XT_RESET_WAIT,
 117         XT_RESET_DONE,
 118         WAIT_AA,
 119         WAIT_AABF,
 120         WAIT_AABFBF,
 121         READ_ID,
 122         SETUP,
 123         LOOP,
 124     } state = INIT;
 125     static uint16_t init_time;
 126
 127
 128     if (ibmpc_error) {
 129         xprintf("\nERR:%02X\n", ibmpc_error);
 130
 131         // when recv error, neither send error nor buffer full
 132         if (!(ibmpc_error & (IBMPC_ERR_SEND | IBMPC_ERR_FULL))) {
 133             // keyboard init again
 134             if (state == LOOP) {
 135                 xprintf("init\n");
 136                 state = INIT;
 137             }
 138         }
 139
 140         // clear or process error
 141         ibmpc_error = IBMPC_ERR_NONE;
 142     }
 143
 144     switch (state) {
 145         case INIT:
 146             xprintf("I%u ", timer_read());
 147             keyboard_kind = NONE;
 148             keyboard_id = 0x0000;
 149
 150             matrix_clear();
 151             clear_keyboard();
 152
 153             state = XT_RESET;
 154             break;
 155         case XT_RESET:
 156             // Reset XT-initialize keyboard
 157             // XT: hard reset 500ms for IBM XT Type-1 keyboard and clones
 158             // XT: soft reset 20ms min(clock Lo)
 159             ibmpc_host_disable();   // soft reset: inihibit(clock Lo/Data Hi)
 160             IBMPC_RST_LO();         // hard reset: reset pin Lo
 161
 162             init_time = timer_read();
 163             state = XT_RESET_WAIT;
 164             break;
 165         case XT_RESET_WAIT:
 166             if (timer_elapsed(init_time) > 500) {
 167                 state = XT_RESET_DONE;
 168             }
 169             break;
 170         case XT_RESET_DONE:
 171             IBMPC_RST_HIZ();        // hard reset: reset pin HiZ
 172             ibmpc_host_isr_clear();
 173             ibmpc_host_enable();    // soft reset: idle(clock Hi/Data Hi)
 174
 175             xprintf("X%u ", timer_read());
 176             init_time = timer_read();
 177             state = WAIT_AA;
 178             break;
 179         case WAIT_AA:
 180             // 1) Read BAT code and ID on keybaord power-up
 181             // For example, XT/AT sends 'AA' and Terminal sends 'AA BF BF' after BAT
 182             // AT 84-key: POR and BAT can take 900-9900ms according to AT TechRef [8] 4-7
 183             // AT 101/102-key: POR and BAT can take 450-2500ms according to AT TechRef [8] 4-39
 184             // 2) Read key typed by user or anything after error on protocol or scan code
 185             // This can happen in case of keyboard hotswap, unstable hardware, signal integrity problem or bug
 186
 187             /* wait until keyboard sends any code without 10000ms timeout
 188             if (timer_elapsed(init_time) > 10000) {
 189                 state = READ_ID;
 190             }
 191             */
 192             if (ibmpc_host_recv() != -1) {  // wait for AA
 193                 xprintf("W%u ", timer_read());
 194                 init_time = timer_read();
 195                 state = WAIT_AABF;
 196             }
 197             break;
 198         case WAIT_AABF:
 199             // NOTE: we can omit to wait BF BF
 200             // ID takes 500ms max? TechRef [8] 4-41, though 1ms is enough for 122-key Terminal 6110345
 201             if (timer_elapsed(init_time) > 500) {
 202                 state = READ_ID;
 203             }
 204             if (ibmpc_host_recv() != -1) {  // wait for BF
 205                 xprintf("W%u ", timer_read());
 206                 init_time = timer_read();
 207                 state = WAIT_AABFBF;
 208             }
 209             break;
 210         case WAIT_AABFBF:
 211             if (timer_elapsed(init_time) > 500) {
 212                 state = READ_ID;
 213             }
 214             if (ibmpc_host_recv() != -1) {  // wait for BF
 215                 xprintf("W%u ", timer_read());
 216                 state = READ_ID;
 217             }
 218             break;
 219         case READ_ID:
 220             xprintf("R%u ", timer_read());
 221
 222             // SKIDATA-2-DE(and some other keyboards?) stores 'Code Set' setting in nonvlatile memory
 223             // and keeps it until receiving reset. Sending reset here may be useful to clear it, perhaps.
 224             // https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-AT-Keyboard-Protocol#select-alternate-scan-codesf0
 225             //ibmpc_host_send(0xFF);  // reset command
 226             //read_wait(500);         // BAT takes 600-900ms(84-key) or 300-500ms(101/102-key) [8] 4-7, 4-39
 227
 228             keyboard_id = read_keyboard_id();
 229             if (ibmpc_error) {
 230                 xprintf("\nERR:%02X\n", ibmpc_error);
 231                 ibmpc_error = IBMPC_ERR_NONE;
 232             }
 233
 234             if (0x0000 == keyboard_id) {            // CodeSet2 AT(IBM PC AT 84-key)
 235                 keyboard_kind = PC_AT;
 236             } else if (0xFFFF == keyboard_id) {     // CodeSet1 XT
 237                 keyboard_kind = PC_XT;
 238             } else if (0xFFFE == keyboard_id) {     // CodeSet2 PS/2 fails to response?
 239                 keyboard_kind = PC_AT;
 240             } else if (0x00FF == keyboard_id) {     // Mouse is not supported
 241                 xprintf("Mouse: not supported\n");
 242                 keyboard_kind = NONE;
 243 #ifdef G80_2551_SUPPORT
 244             } else if (0xAB86 == keyboard_id) {     // CodeSet2 PS/2 Terminal
 245                 // For G80-2551 and other 122-key terminal keyboards
 246                 // https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-AT-Keyboard-Protocol#ab86
 247                 if ((0xFA == ibmpc_host_send(0xF0)) &&
 248                     (0xFA == ibmpc_host_send(0x03))) {
 249                     // switch to code set 3
 250                     keyboard_kind = PC_TERMINAL;
 251                 } else {
 252                     keyboard_kind = PC_AT;
 253                 }
 254 #endif
 255             } else if (0xAB00 == (keyboard_id & 0xFF00)) {  // CodeSet2 PS/2
 256                 keyboard_kind = PC_AT;
 257             } else if (0xBF00 == (keyboard_id & 0xFF00)) {  // CodeSet3 Terminal
 258                 keyboard_kind = PC_TERMINAL;
 259             } else {
 260                 keyboard_kind = PC_AT;
 261             }
 262
 263             xprintf("ID:%04X(%d)\n", keyboard_id, keyboard_kind);
 264
 265             state = SETUP;
 266             break;
 267         case SETUP:
 268             xprintf("S%u ", timer_read());
 269             switch (keyboard_kind) {
 270                 case PC_XT:
 271                     break;
 272                 case PC_AT:
 273                     led_set(host_keyboard_leds());
 274                     break;
 275                 case PC_TERMINAL:
 276                     // Set all keys to make/break type
 277                     ibmpc_host_send(0xF8);
 278                     break;
 279                 default:
 280                     break;
 281             }
 282             state = LOOP;
 283             xprintf("L%u ", timer_read());
 284         case LOOP:
 285             switch (keyboard_kind) {
 286                 case PC_XT:
 287                     if (process_cs1() == -1) state = INIT;
 288                     break;
 289                 case PC_AT:
 290                     if (process_cs2() == -1) state = INIT;
 291                     break;
 292                 case PC_TERMINAL:
 293                     if (process_cs3() == -1) state = INIT;
 294                     break;
 295                 default:
 296                     break;
 297             }
 298             break;
 299         default:
 300             break;
 301     }
 302     return 1;
 303 }
 304
 305 inline
 306 bool matrix_is_on(uint8_t row, uint8_t col)
 307 {
 308     return (matrix[row] & (1<<col));
 309 }
 310
 311 inline
 312 uint8_t matrix_get_row(uint8_t row)
 313 {
 314     return matrix[row];
 315 }
 316
 317 uint8_t matrix_key_count(void)
 318 {
 319     uint8_t count = 0;
 320     for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
 321         count += bitpop(matrix[i]);
 322     }
 323     return count;
 324 }
 325
 326
 327 inline
 328 static void matrix_make(uint8_t code)
 329 {
 330     if (!matrix_is_on(ROW(code), COL(code))) {
 331         matrix[ROW(code)] |= 1<<COL(code);
 332     }
 333 }
 334
 335 inline
 336 static void matrix_break(uint8_t code)
 337 {
 338     if (matrix_is_on(ROW(code), COL(code))) {
 339         matrix[ROW(code)] &= ~(1<<COL(code));
 340     }
 341 }
 342
 343 void matrix_clear(void)
 344 {
 345     for (uint8_t i=0; i < MATRIX_ROWS; i++) matrix[i] = 0x00;
 346 }
 347
 348 void led_set(uint8_t usb_led)
 349 {
 350     //if (keyboard_kind != PC_AT) return;
 351
 352     uint8_t ibmpc_led = 0;
 353     if (usb_led &  (1<<USB_LED_SCROLL_LOCK))
 354         ibmpc_led |= (1<<IBMPC_LED_SCROLL_LOCK);
 355     if (usb_led &  (1<<USB_LED_NUM_LOCK))
 356         ibmpc_led |= (1<<IBMPC_LED_NUM_LOCK);
 357     if (usb_led &  (1<<USB_LED_CAPS_LOCK))
 358         ibmpc_led |= (1<<IBMPC_LED_CAPS_LOCK);
 359     ibmpc_host_set_led(ibmpc_led);
 360 }
 361
 362
 363 /*******************************************************************************
 364  * XT: Scan Code Set 1
 365  *
 366  * See [3], [a]
 367  *
 368  * E0-escaped scan codes are translated into unused range of the matrix.(54-7F)
 369  *
 370  *     01-53: Normal codes used in original XT keyboard
 371  *     54-7F: Not used in original XT keyboard
 372  *
 373  *         0   1   2   3   4   5   6   7   8   9   A   B   C   D   E   F
 374  *     50  -   -   -   -   *   *   x   x   x   x   *   *   *   *   *   *
 375  *     60  *   *   *   *   x   x   x   x   x   x   x   x   x   x   x   *
 376  *     70  x   *   *   x   *   *   x   *   *   x   *   x   *   x   x   *
 377  *
 378  * -: codes existed in original XT keyboard
 379  * *: E0-escaped codes translated
 380  * x: Non-espcaped codes(Some are not used in real keyboards probably)
 381  *
 382  * Codes assigned in range 54-7F:
 383  *
 384  *     50  -                60  Up*                 70  KANAx
 385  *     51  -                61  Left*               71  Insert*
 386  *     52  -                62  Down*               72  Delete*
 387  *     53  -                63  Right*              73  ROx
 388  *     54  PrintScr*        64  F13x                74  Home*
 389  *     55  Pause*           65  F14x                75  End*
 390  *     56  Euro2x           66  F15x                76  F24x
 391  *     57  F11x             67  F16x                77  PageUp*
 392  *     58  F12x             68  F17x                78  PageDown*
 393  *     59  Keypad=x         69  F18x                79  HENKANx
 394  *     5A  LGUI*            6A  F19x                7A  RCTL*
 395  *     5B  RGUI*            6B  F20x                7B  MUHENKANx
 396  *     5C  APP*             6C  F21x                7C  RALT*
 397  *     5D  Mute*            6D  F22x                7D  JPYx
 398  *     5E  Volume Down*     6E  F23x                7E  Keypad,x
 399  *     5F  Volume Up*       6F  Keypad Enter*       7F  Keypad/ *
 400  */
 401 static uint8_t cs1_e0code(uint8_t code) {
 402     switch(code) {
 403         // Original IBM XT keyboard doesn't use E0-codes probably
 404         // Some XT compatilble keyobards need these keys?
 405         case 0x37: return 0x54; // Print Screen
 406         case 0x46: return 0x55; // Ctrl + Pause
 407         case 0x5B: return 0x5A; // Left  GUI
 408         case 0x5C: return 0x5B; // Right GUI
 409         case 0x5D: return 0x5C; // Application
 410         case 0x20: return 0x5D; // Mute
 411         case 0x2E: return 0x5E; // Volume Down
 412         case 0x30: return 0x5F; // Volume Up
 413         case 0x48: return 0x60; // Up
 414         case 0x4B: return 0x61; // Left
 415         case 0x50: return 0x62; // Down
 416         case 0x4D: return 0x63; // Right
 417         case 0x1C: return 0x6F; // Keypad Enter
 418         case 0x52: return 0x71; // Insert
 419         case 0x53: return 0x72; // Delete
 420         case 0x47: return 0x74; // Home
 421         case 0x4F: return 0x75; // End
 422         case 0x49: return 0x77; // Page Up
 423         case 0x51: return 0x78; // Page Down
 424         case 0x1D: return 0x7A; // Right Ctrl
 425         case 0x38: return 0x7C; // Right Alt
 426         case 0x35: return 0x7F; // Keypad /
 427
 428         // Shared matrix cell with other keys
 429         case 0x5E: return 0x70; // Power (KANA)
 430         case 0x5F: return 0x79; // Sleep (HENKAN)
 431         case 0x63: return 0x7B; // Wake  (MUHENKAN)
 432
 433         default:
 434            xprintf("!CS1_E0_%02X!\n", code);
 435            return code;
 436     }
 437     return 0x00;
 438 }
 439
 440 static int8_t process_cs1(void)
 441 {
 442     static enum {
 443         INIT,
 444         E0,
 445         // Pause: E1 1D 45, E1 9D C5 [a] (TODO: test)
 446         E1,
 447         E1_1D,
 448         E1_9D,
 449     } state = INIT;
 450
 451     uint16_t code = ibmpc_host_recv();
 452     if (code == -1) {
 453         return 0;
 454     }
 455
 456     // Check invalid codes; 0x59-7F won't be used in real XT keyboards probably
 457     // 0x62 is used to handle escape code E0 and E1
 458     if ((code & 0x7F) >= 0x62) {
 459         xprintf("!CS1_INV!\n");
 460         state = INIT;
 461         return -1;
 462     }
 463
 464     switch (state) {
 465         case INIT:
 466             switch (code) {
 467                 case 0x00:
 468                 case 0xFF:  // Error/Overrun [3]p.26
 469                     xprintf("!CS1_ERR!\n");
 470                     return -1;
 471                     break;
 472                 case 0xE0:
 473                     state = E0;
 474                     break;
 475                 case 0xE1:
 476                     state = E1;
 477                     break;
 478                 default:
 479                     if (code < 0x80)
 480                         matrix_make(code);
 481                     else
 482                         matrix_break(code & 0x7F);
 483                     break;
 484             }
 485             break;
 486         case E0:
 487             switch (code) {
 488                 case 0x2A:
 489                 case 0xAA:
 490                 case 0x36:
 491                 case 0xB6:
 492                     //ignore fake shift
 493                     state = INIT;
 494                     break;
 495                 default:
 496                     if (code < 0x80)
 497                         matrix_make(cs1_e0code(code));
 498                     else
 499                         matrix_break(cs1_e0code(code & 0x7F));
 500                     state = INIT;
 501                     break;
 502             }
 503             break;
 504         case E1:
 505             switch (code) {
 506                 case 0x1D:
 507                     state = E1_1D;
 508                     break;
 509                 case 0x9D:
 510                     state = E1_9D;
 511                     break;
 512                 default:
 513                     state = INIT;
 514                     break;
 515             }
 516             break;
 517         case E1_1D:
 518             switch (code) {
 519                 case 0x45:
 520                     matrix_make(0x55);
 521                     break;
 522                 default:
 523                     state = INIT;
 524                     break;
 525             }
 526             break;
 527         case E1_9D:
 528             switch (code) {
 529                 case 0x45:
 530                     matrix_break(0x55);
 531                     break;
 532                 default:
 533                     state = INIT;
 534                     break;
 535             }
 536             break;
 537         default:
 538             state = INIT;
 539     }
 540     return 0;
 541 }
 542
 543
 544 /*******************************************************************************
 545  * AT, PS/2: Scan Code Set 2
 546  *
 547  * Exceptional Handling
 548  * --------------------
 549  * Some keys should be handled exceptionally. See [b].
 550  *
 551  * Scan codes are varied or prefix/postfix'd depending on modifier key state.
 552  *
 553  * 1) Insert, Delete, Home, End, PageUp, PageDown, Up, Down, Right, Left
 554  *     a) when Num Lock is off
 555  *     modifiers | make                      | break
 556  *     ----------+---------------------------+----------------------
 557  *     Ohter     |                    <make> | <break>
 558  *     LShift    | E0 F0 12           <make> | <break>  E0 12
 559  *     RShift    | E0 F0 59           <make> | <break>  E0 59
 560  *     L+RShift  | E0 F0 12  E0 F0 59 <make> | <break>  E0 59 E0 12
 561  *
 562  *     b) when Num Lock is on
 563  *     modifiers | make                      | break
 564  *     ----------+---------------------------+----------------------
 565  *     Other     | E0 12              <make> | <break>  E0 F0 12
 566  *     Shift'd   |                    <make> | <break>
 567  *
 568  *     Handling: These prefix/postfix codes are ignored.
 569  *
 570  *
 571  * 2) Keypad /
 572  *     modifiers | make                      | break
 573  *     ----------+---------------------------+----------------------
 574  *     Ohter     |                    <make> | <break>
 575  *     LShift    | E0 F0 12           <make> | <break>  E0 12
 576  *     RShift    | E0 F0 59           <make> | <break>  E0 59
 577  *     L+RShift  | E0 F0 12  E0 F0 59 <make> | <break>  E0 59 E0 12
 578  *
 579  *     Handling: These prefix/postfix codes are ignored.
 580  *
 581  *
 582  * 3) PrintScreen
 583  *     modifiers | make         | break
 584  *     ----------+--------------+-----------------------------------
 585  *     Other     | E0 12  E0 7C | E0 F0 7C  E0 F0 12
 586  *     Shift'd   |        E0 7C | E0 F0 7C
 587  *     Control'd |        E0 7C | E0 F0 7C
 588  *     Alt'd     |           84 | F0 84
 589  *
 590  *     Handling: These prefix/postfix codes are ignored, and both scan codes
 591  *               'E0 7C' and 84 are seen as PrintScreen.
 592  *
 593  * 4) Pause
 594  *     modifiers | make(no break code)
 595  *     ----------+--------------------------------------------------
 596  *     Other     | E1 14 77 E1 F0 14 F0 77
 597  *     Control'd | E0 7E E0 F0 7E
 598  *
 599  *     Handling: Both code sequences are treated as a whole.
 600  *               And we need a ad hoc 'pseudo break code' hack to get the key off
 601  *               because it has no break code.
 602  *
 603  * Notes:
 604  * 'Hanguel/English'(F1) and 'Hanja'(F2) have no break code. See [a].
 605  * These two Korean keys need exceptional handling and are not supported for now.
 606  *
 607  */
 608 static uint8_t cs2_e0code(uint8_t code) {
 609     switch(code) {
 610         // E0 prefixed codes translation See [a].
 611         case 0x11: return 0x0F; // right alt
 612         case 0x14: return 0x17; // right control
 613         case 0x1F: return 0x19; // left GUI
 614         case 0x27: return 0x1F; // right GUI
 615         case 0x2F: return 0x5C; // apps
 616         case 0x4A: return 0x60; // keypad /
 617         case 0x5A: return 0x62; // keypad enter
 618         case 0x69: return 0x27; // end
 619         case 0x6B: return 0x53; // cursor left
 620         case 0x6C: return 0x2F; // home
 621         case 0x70: return 0x39; // insert
 622         case 0x71: return 0x37; // delete
 623         case 0x72: return 0x3F; // cursor down
 624         case 0x74: return 0x47; // cursor right
 625         case 0x75: return 0x4F; // cursor up
 626         case 0x7A: return 0x56; // page down
 627         case 0x7D: return 0x5E; // page up
 628         case 0x7C: return 0x6F; // Print Screen
 629         case 0x7E: return 0x00; // Control'd Pause
 630
 631         case 0x21: return 0x65; // volume down
 632         case 0x32: return 0x6E; // volume up
 633         case 0x23: return 0x7F; // mute
 634         case 0x10: return 0x08; // (WWW search)     -> F13
 635         case 0x18: return 0x10; // (WWW favourites) -> F14
 636         case 0x20: return 0x18; // (WWW refresh)    -> F15
 637         case 0x28: return 0x20; // (WWW stop)       -> F16
 638         case 0x30: return 0x28; // (WWW forward)    -> F17
 639         case 0x38: return 0x30; // (WWW back)       -> F18
 640         case 0x3A: return 0x38; // (WWW home)       -> F19
 641         case 0x40: return 0x40; // (my computer)    -> F20
 642         case 0x48: return 0x48; // (email)          -> F21
 643         case 0x2B: return 0x50; // (calculator)     -> F22
 644         case 0x34: return 0x08; // (play/pause)     -> F13
 645         case 0x3B: return 0x10; // (stop)           -> F14
 646         case 0x15: return 0x18; // (previous track) -> F15
 647         case 0x4D: return 0x20; // (next track)     -> F16
 648         case 0x50: return 0x28; // (media select)   -> F17
 649         case 0x5E: return 0x50; // (ACPI wake)      -> F22
 650         case 0x3F: return 0x57; // (ACPI sleep)     -> F23
 651         case 0x37: return 0x5F; // (ACPI power)     -> F24
 652
 653         // https://github.com/tmk/tmk_keyboard/pull/636
 654         case 0x03: return 0x18; // Help        DEC LK411 -> F15
 655         case 0x04: return 0x08; // F13         DEC LK411
 656         case 0x0B: return 0x20; // Do          DEC LK411 -> F16
 657         case 0x0C: return 0x10; // F14         DEC LK411
 658         case 0x0D: return 0x19; // LCompose    DEC LK411 -> LGUI
 659         case 0x79: return 0x6D; // KP-         DEC LK411 -> PCMM
 660         case 0x83: return 0x28; // F17         DEC LK411
 661         default: return (code & 0x7F);
 662     }
 663 }
 664
 665 static int8_t process_cs2(void)
 666 {
 667     // scan code reading states
 668     static enum {
 669         INIT,
 670         F0,
 671         E0,
 672         E0_F0,
 673         // Pause
 674         E1,
 675         E1_14,
 676         E1_F0,
 677         E1_F0_14,
 678         E1_F0_14_F0,
 679     } state = INIT;
 680
 681     uint16_t code = ibmpc_host_recv();
 682     if (code == -1) {
 683         return 0;
 684     }
 685
 686     switch (state) {
 687         case INIT:
 688             switch (code) {
 689                 case 0x00:  // Error/Overrun [3]p.26
 690                     xprintf("!CS2_OVR!\n");
 691                     matrix_clear();
 692                     clear_keyboard();
 693                     break;
 694                 case 0xFF:
 695                     matrix_clear();
 696                     xprintf("!CS2_ERR!\n");
 697                     state = INIT;
 698                     return -1;
 699                     break;
 700                 case 0xE0:
 701                     state = E0;
 702                     break;
 703                 case 0xF0:
 704                     state = F0;
 705                     break;
 706                 case 0xE1:
 707                     state = E1;
 708                     break;
 709                 case 0x83:  // F7
 710                     matrix_make(0x02);
 711                     state = INIT;
 712                     break;
 713                 case 0x84:  // Alt'd PrintScreen
 714                     matrix_make(0x6F);
 715                     state = INIT;
 716                     break;
 717                 case 0xAA:  // Self-test passed
 718                 case 0xFC:  // Self-test failed
 719                     // reset or plugin-in new keyboard
 720                     state = INIT;
 721                     return -1;
 722                     break;
 723                 default:    // normal key make
 724                     state = INIT;
 725                     if (code < 0x80) {
 726                         matrix_make(code);
 727                     } else {
 728                         matrix_clear();
 729                         xprintf("!CS2_INIT!\n");
 730                         return -1;
 731                     }
 732             }
 733             break;
 734         case E0:    // E0-Prefixed
 735             switch (code) {
 736                 case 0x12:  // to be ignored
 737                 case 0x59:  // to be ignored
 738                     state = INIT;
 739                     break;
 740                 case 0xF0:
 741                     state = E0_F0;
 742                     break;
 743                 default:
 744                     state = INIT;
 745                     if (code < 0x80) {
 746                         matrix_make(cs2_e0code(code));
 747                     } else {
 748                         matrix_clear();
 749                         xprintf("!CS2_E0!\n");
 750                         return -1;
 751                     }
 752             }
 753             break;
 754         case F0:    // Break code
 755             switch (code) {
 756                 case 0x83:  // F7
 757                     matrix_break(0x02);
 758                     state = INIT;
 759                     break;
 760                 case 0x84:  // Alt'd PrintScreen
 761                     matrix_break(0x6F);
 762                     state = INIT;
 763                     break;
 764                 default:
 765                     state = INIT;
 766                     if (code < 0x80) {
 767                         matrix_break(code);
 768                     } else {
 769                         matrix_clear();
 770                         xprintf("!CS2_F0!\n");
 771                         return -1;
 772                     }
 773             }
 774             break;
 775         case E0_F0: // Break code of E0-prefixed
 776             switch (code) {
 777                 case 0x12:  // to be ignored
 778                 case 0x59:  // to be ignored
 779                     state = INIT;
 780                     break;
 781                 default:
 782                     state = INIT;
 783                     if (code < 0x80) {
 784                         matrix_break(cs2_e0code(code));
 785                     } else {
 786                         matrix_clear();
 787                         xprintf("!CS2_E0_F0!\n");
 788                         return -1;
 789                     }
 790             }
 791             break;
 792         // Pause make: E1 14 77
 793         case E1:
 794             switch (code) {
 795                 case 0x14:
 796                     state = E1_14;
 797                     break;
 798                 case 0xF0:
 799                     state = E1_F0;
 800                     break;
 801                 default:
 802                     state = INIT;
 803             }
 804             break;
 805         case E1_14:
 806             switch (code) {
 807                 case 0x77:
 808                     matrix_make(0x00);
 809                     state = INIT;
 810                     break;
 811                 default:
 812                     state = INIT;
 813             }
 814             break;
 815         // Pause break: E1 F0 14 F0 77
 816         case E1_F0:
 817             switch (code) {
 818                 case 0x14:
 819                     state = E1_F0_14;
 820                     break;
 821                 default:
 822                     state = INIT;
 823             }
 824             break;
 825         case E1_F0_14:
 826             switch (code) {
 827                 case 0xF0:
 828                     state = E1_F0_14_F0;
 829                     break;
 830                 default:
 831                     state = INIT;
 832             }
 833             break;
 834         case E1_F0_14_F0:
 835             switch (code) {
 836                 case 0x77:
 837                     matrix_break(0x00);
 838                     state = INIT;
 839                     break;
 840                 default:
 841                     state = INIT;
 842             }
 843             break;
 844         default:
 845             state = INIT;
 846     }
 847     return 0;
 848 }
 849
 850 /*
 851  * Terminal: Scan Code Set 3
 852  *
 853  * See [3], [7]
 854  *
 855  * Scan code 0x83 and 0x84 are handled exceptioanally to fit into 1-byte range index.
 856  */
 857 static int8_t process_cs3(void)
 858 {
 859     static enum {
 860         READY,
 861         F0,
 862 #ifdef G80_2551_SUPPORT
 863         // G80-2551 four extra keys around cursor keys
 864         G80,
 865         G80_F0,
 866 #endif
 867     } state = READY;
 868
 869     uint16_t code = ibmpc_host_recv();
 870     if (code == -1) {
 871         return 0;
 872     }
 873
 874     switch (state) {
 875         case READY:
 876             switch (code) {
 877                 case 0x00:  // Error/Overrun [3]p.26
 878                     xprintf("!CS3_OVR!\n");
 879                     matrix_clear();
 880                     clear_keyboard();
 881                     break;
 882                 case 0xFF:
 883                     xprintf("!CS3_ERR!\n");
 884                     return -1;
 885                     break;
 886                 case 0xF0:
 887                     state = F0;
 888                     break;
 889                 case 0x83:  // PrintScreen
 890                     matrix_make(0x02);
 891                     break;
 892                 case 0x84:  // Keypad *
 893                     matrix_make(0x7F);
 894                     break;
 895                 case 0x85:  // Muhenkan
 896                     matrix_make(0x0B);
 897                     break;
 898                 case 0x86:  // Henkan
 899                     matrix_make(0x06);
 900                     break;
 901                 case 0x87:  // Hiragana
 902                     matrix_make(0x00);
 903                     break;
 904                 case 0x8B:  // Left GUI
 905                     matrix_make(0x01);
 906                     break;
 907                 case 0x8C:  // Right GUI
 908                     matrix_make(0x09);
 909                     break;
 910                 case 0x8D:  // Application
 911                     matrix_make(0x0A);
 912                     break;
 913 #ifdef G80_2551_SUPPORT
 914                 case 0x80:  // G80-2551 four extra keys around cursor keys
 915                     state = G80;
 916                     break;
 917 #endif
 918                 default:    // normal key make
 919                     if (code < 0x80) {
 920                         matrix_make(code);
 921                     } else {
 922                         xprintf("!CS3_READY!\n");
 923                         //return -1;
 924                     }
 925             }
 926             break;
 927         case F0:    // Break code
 928             switch (code) {
 929                 case 0x00:
 930                     xprintf("!CS3_F0_OVR!\n");
 931                     matrix_clear();
 932                     clear_keyboard();
 933                     state = READY;
 934                     break;
 935                 case 0xFF:
 936                     xprintf("!CS3_F0_ERR!\n");
 937                     state = READY;
 938                     return -1;
 939                     break;
 940                 case 0x83:  // PrintScreen
 941                     matrix_break(0x02);
 942                     state = READY;
 943                     break;
 944                 case 0x84:  // Keypad *
 945                     matrix_break(0x7F);
 946                     state = READY;
 947                     break;
 948                 case 0x85:  // Muhenkan
 949                     matrix_break(0x0B);
 950                     state = READY;
 951                     break;
 952                 case 0x86:  // Henkan
 953                     matrix_break(0x06);
 954                     state = READY;
 955                     break;
 956                 case 0x87:  // Hiragana
 957                     matrix_break(0x00);
 958                     state = READY;
 959                     break;
 960                 case 0x8B:  // Left GUI
 961                     matrix_break(0x01);
 962                     state = READY;
 963                     break;
 964                 case 0x8C:  // Right GUI
 965                     matrix_break(0x09);
 966                     state = READY;
 967                     break;
 968                 case 0x8D:  // Application
 969                     matrix_break(0x0A);
 970                     state = READY;
 971                     break;
 972                 default:
 973                     state = READY;
 974                     if (code < 0x80) {
 975                         matrix_break(code);
 976                     } else {
 977                         xprintf("!CS3_F0!\n");
 978                         //return -1;
 979                     }
 980             }
 981             break;
 982 #ifdef G80_2551_SUPPORT
 983         /*
 984          * G80-2551 terminal keyboard support
 985          * https://deskthority.net/wiki/Cherry_G80-2551
 986          * https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-AT-Keyboard-Protocol#g80-2551-in-code-set-3
 987          */
 988         case G80:   // G80-2551 four extra keys around cursor keys
 989             switch (code) {
 990                 case (0x26):    // TD= -> JYEN
 991                     matrix_make(0x5D);
 992                     break;
 993                 case (0x25):    // page with edge -> NUHS
 994                     matrix_make(0x53);
 995                     break;
 996                 case (0x16):    // two pages -> RO
 997                     matrix_make(0x51);
 998                     break;
 999                 case (0x1E):    // calc -> KANA
1000                     matrix_make(0x00);
1001                     break;
1002                 case (0xF0):
1003                     state = G80_F0;
1004                     return 0;
1005                 default:
1006                     // Not supported
1007                     matrix_clear();
1008                     break;
1009             }
1010             state = READY;
1011             break;
1012         case G80_F0:
1013             switch (code) {
1014                 case (0x26):    // TD= -> JYEN
1015                     matrix_break(0x5D);
1016                     break;
1017                 case (0x25):    // page with edge -> NUHS
1018                     matrix_break(0x53);
1019                     break;
1020                 case (0x16):    // two pages -> RO
1021                     matrix_break(0x51);
1022                     break;
1023                 case (0x1E):    // calc -> KANA
1024                     matrix_break(0x00);
1025                     break;
1026                 default:
1027                     // Not supported
1028                     matrix_clear();
1029                     break;
1030             }
1031             state = READY;
1032             break;
1033 #endif
1034     }
1035     return 0;
1036 }
1037
1038 /*
1039  * IBM PC Keyboard Protocol Resources:
1040  *
1041  * [a] Microsoft USB HID to PS/2 Translation Table - Scan Code Set 1 and 2
1042  * http://download.microsoft.com/download/1/6/1/161ba512-40e2-4cc9-843a-923143f3456c/translate.pdf
1043  *
1044  * [b] Microsoft Keyboard Scan Code Specification - Special rules of Scan Code Set 1 and 2
1045  * http://download.microsoft.com/download/1/6/1/161ba512-40e2-4cc9-843a-923143f3456c/scancode.doc
1046  *
1047  * [1] PS/2 Reference Manuals - Collection of IBM Personal System/2 documents.
1048  * http://www.mcamafia.de/pdf/pdfref.htm
1049  *
1050  * [2] Keyboard and Auxiliary Device Controller - Signal Timing and Format
1051  * http://www.mcamafia.de/pdf/ibm_hitrc07.pdf
1052  *
1053  * [3] Keyboards(101- and 102-key) - Keyboard Layout, Scan Code Set, POR, and Commands.
1054  * http://www.mcamafia.de/pdf/ibm_hitrc11.pdf
1055  *
1056  * [4] IBM PC XT Keyboard Protocol
1057  * https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-XT-Keyboard-Protocol
1058  *
1059  * [5] IBM Keyboard Scan Code by John Elliott - 83-key, 84-key, 102-key and 122-key
1060  * https://www.seasip.info/VintagePC/index.html
1061  *
1062  * [6] IBM 1391406 Keyboard - Scan Code Set 2 of 102-key PS/2 keyboard
1063  * https://www.seasip.info/VintagePC/ibm_1391406.html
1064  *
1065  * [7] The IBM 6110344 Keyboard - Scan Code Set 3 of 122-key terminal keyboard
1066  * https://www.seasip.info/VintagePC/ibm_6110344.html
1067  *
1068  * [8] IBM PC AT Technical Reference 1986
1069  * http://bitsavers.org/pdf/ibm/pc/at/6183355_PC_AT_Technical_Reference_Mar86.pdf
1070  *
1071  * [y] TrackPoint Engineering Specifications for version 3E
1072  * https://web.archive.org/web/20100526161812/http://wwwcssrv.almaden.ibm.com/trackpoint/download.html
1073  *
1074  * [z] [Soarer's XT/AT/PS2/Terminal to USB converter]
1075  * https://geekhack.org/index.php?topic=17458.0
1076  *
1077  */