/* Copyright 2019,2020 Jun Wako 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 . */ #include #include #include "print.h" #include "util.h" #include "debug.h" #include "ibmpc.h" #include "host.h" #include "led.h" #include "matrix.h" #include "timer.h" #include "action.h" #include "ibmpc_usb.h" #include "ibmpc.h" static void matrix_make(uint8_t code); static void matrix_break(uint8_t code); static int8_t process_cs1(void); static int8_t process_cs2(void); static int8_t process_cs3(void); static uint8_t matrix[MATRIX_ROWS]; #define ROW(code) ((code>>3)&0x0F) #define COL(code) (code&0x07) static int16_t read_wait(uint16_t wait_ms) { uint16_t start = timer_read(); int16_t code; while ((code = ibmpc_host_recv()) == -1 && timer_elapsed(start) < wait_ms); return code; } static uint16_t read_keyboard_id(void) { uint16_t id = 0; int16_t code = 0; // Disable //code = ibmpc_host_send(0xF5); // Read ID code = ibmpc_host_send(0xF2); if (code == -1) { id = 0xFFFF; goto DONE; } // XT or No keyboard if (code != 0xFA) { id = 0xFFFE; goto DONE; } // Broken PS/2? // ID takes 500ms max TechRef [8] 4-41 code = read_wait(500); if (code == -1) { id = 0x0000; goto DONE; } // AT id = (code & 0xFF)<<8; code = read_wait(500); id |= code & 0xFF; DONE: // Enable //code = ibmpc_host_send(0xF4); return id; } void hook_early_init(void) { ibmpc_host_init(); ibmpc_host_enable(); } void matrix_init(void) { debug_enable = true; // initialize matrix state: all keys off for (uint8_t i=0; i < MATRIX_ROWS; i++) matrix[i] = 0x00; return; } /* * keyboard recognition * * 1. Send F2 to get keyboard ID * a. no ACK(FA): XT keyobard * b. ACK but no ID: 84-key AT keyboard CodeSet2 * c. ID is AB 83: PS/2 keyboard CodeSet2 * d. ID is BF BF: Terminal keyboard CodeSet3 * e. error on recv: maybe broken PS/2 */ uint16_t keyboard_id = 0x0000; keyboard_kind_t keyboard_kind = NONE; uint8_t matrix_scan(void) { // scan code reading states static enum { INIT, XT_RESET, XT_RESET_WAIT, XT_RESET_DONE, WAIT_AA, WAIT_AABF, WAIT_AABFBF, READ_ID, SETUP, LOOP, } state = INIT; static uint16_t init_time; if (ibmpc_error) { xprintf("\nERR:%02X\n", ibmpc_error); // when recv error, neither send error nor buffer full if (!(ibmpc_error & (IBMPC_ERR_SEND | IBMPC_ERR_FULL))) { // keyboard init again if (state == LOOP) { xprintf("init\n"); state = INIT; } } // clear or process error ibmpc_error = IBMPC_ERR_NONE; } switch (state) { case INIT: xprintf("I%u ", timer_read()); keyboard_kind = NONE; keyboard_id = 0x0000; matrix_clear(); clear_keyboard(); state = XT_RESET; break; case XT_RESET: // Reset XT-initialize keyboard // XT: hard reset 500ms for IBM XT Type-1 keyboard and clones // XT: soft reset 20ms min(clock Lo) ibmpc_host_disable(); // soft reset: inihibit(clock Lo/Data Hi) IBMPC_RST_LO(); // hard reset: reset pin Lo init_time = timer_read(); state = XT_RESET_WAIT; break; case XT_RESET_WAIT: if (timer_elapsed(init_time) > 500) { state = XT_RESET_DONE; } break; case XT_RESET_DONE: IBMPC_RST_HIZ(); // hard reset: reset pin HiZ ibmpc_host_isr_clear(); ibmpc_host_enable(); // soft reset: idle(clock Hi/Data Hi) xprintf("X%u ", timer_read()); init_time = timer_read(); state = WAIT_AA; break; case WAIT_AA: // 1) Read BAT code and ID on keybaord power-up // For example, XT/AT sends 'AA' and Terminal sends 'AA BF BF' after BAT // AT 84-key: POR and BAT can take 900-9900ms according to AT TechRef [8] 4-7 // AT 101/102-key: POR and BAT can take 450-2500ms according to AT TechRef [8] 4-39 // 2) Read key typed by user or anything after error on protocol or scan code // This can happen in case of keyboard hotswap, unstable hardware, signal integrity problem or bug /* wait until keyboard sends any code without 10000ms timeout if (timer_elapsed(init_time) > 10000) { state = READ_ID; } */ if (ibmpc_host_recv() != -1) { // wait for AA xprintf("W%u ", timer_read()); init_time = timer_read(); state = WAIT_AABF; } break; case WAIT_AABF: // NOTE: we can omit to wait BF BF // ID takes 500ms max? TechRef [8] 4-41, though 1ms is enough for 122-key Terminal 6110345 if (timer_elapsed(init_time) > 500) { state = READ_ID; } if (ibmpc_host_recv() != -1) { // wait for BF xprintf("W%u ", timer_read()); init_time = timer_read(); state = WAIT_AABFBF; } break; case WAIT_AABFBF: if (timer_elapsed(init_time) > 500) { state = READ_ID; } if (ibmpc_host_recv() != -1) { // wait for BF xprintf("W%u ", timer_read()); state = READ_ID; } break; case READ_ID: xprintf("R%u ", timer_read()); keyboard_id = read_keyboard_id(); if (ibmpc_error) { xprintf("\nERR:%02X\n", ibmpc_error); ibmpc_error = IBMPC_ERR_NONE; } if (0xAB00 == (keyboard_id & 0xFF00)) { // CodeSet2 PS/2 keyboard_kind = PC_AT; } else if (0xBF00 == (keyboard_id & 0xFF00)) { // CodeSet3 Terminal keyboard_kind = PC_TERMINAL; } else if (0x0000 == keyboard_id) { // CodeSet2 AT keyboard_kind = PC_AT; } else if (0xFFFF == keyboard_id) { // CodeSet1 XT keyboard_kind = PC_XT; } else if (0xFFFE == keyboard_id) { // CodeSet2 PS/2 fails to response? keyboard_kind = PC_AT; } else if (0x00FF == keyboard_id) { // Mouse is not supported xprintf("Mouse: not supported\n"); keyboard_kind = NONE; } else { keyboard_kind = PC_AT; } xprintf("ID:%04X(%d)\n", keyboard_id, keyboard_kind); state = SETUP; break; case SETUP: xprintf("S%u ", timer_read()); switch (keyboard_kind) { case PC_XT: break; case PC_AT: led_set(host_keyboard_leds()); break; case PC_TERMINAL: ibmpc_host_send(0xF8); break; default: break; } state = LOOP; xprintf("L%u ", timer_read()); case LOOP: switch (keyboard_kind) { case PC_XT: if (process_cs1() == -1) state = INIT; break; case PC_AT: if (process_cs2() == -1) state = INIT; break; case PC_TERMINAL: if (process_cs3() == -1) state = INIT; break; default: break; } break; default: break; } return 1; } inline bool matrix_is_on(uint8_t row, uint8_t col) { return (matrix[row] & (1<= 0x62) { xprintf("!CS1_INV!\n"); state = INIT; return -1; } switch (state) { case INIT: switch (code) { case 0x00: case 0xFF: // Error/Overrun [3]p.26 xprintf("!CS1_ERR!\n"); return -1; break; case 0xE0: state = E0; break; case 0xE1: state = E1; break; default: if (code < 0x80) matrix_make(code); else matrix_break(code & 0x7F); break; } break; case E0: switch (code) { case 0x2A: case 0xAA: case 0x36: case 0xB6: //ignore fake shift state = INIT; break; default: if (code < 0x80) matrix_make(cs1_e0code(code)); else matrix_break(cs1_e0code(code & 0x7F)); state = INIT; break; } break; case E1: switch (code) { case 0x1D: state = E1_1D; break; case 0x9D: state = E1_9D; break; default: state = INIT; break; } break; case E1_1D: switch (code) { case 0x45: matrix_make(0x55); break; default: state = INIT; break; } break; case E1_9D: switch (code) { case 0x45: matrix_break(0x55); break; default: state = INIT; break; } break; default: state = INIT; } return 0; } /******************************************************************************* * AT, PS/2: Scan Code Set 2 * * Exceptional Handling * -------------------- * Some keys should be handled exceptionally. See [b]. * * Scan codes are varied or prefix/postfix'd depending on modifier key state. * * 1) Insert, Delete, Home, End, PageUp, PageDown, Up, Down, Right, Left * a) when Num Lock is off * modifiers | make | break * ----------+---------------------------+---------------------- * Ohter | | * LShift | E0 F0 12 | E0 12 * RShift | E0 F0 59 | E0 59 * L+RShift | E0 F0 12 E0 F0 59 | E0 59 E0 12 * * b) when Num Lock is on * modifiers | make | break * ----------+---------------------------+---------------------- * Other | E0 12 | E0 F0 12 * Shift'd | | * * Handling: These prefix/postfix codes are ignored. * * * 2) Keypad / * modifiers | make | break * ----------+---------------------------+---------------------- * Ohter | | * LShift | E0 F0 12 | E0 12 * RShift | E0 F0 59 | E0 59 * L+RShift | E0 F0 12 E0 F0 59 | E0 59 E0 12 * * Handling: These prefix/postfix codes are ignored. * * * 3) PrintScreen * modifiers | make | break * ----------+--------------+----------------------------------- * Other | E0 12 E0 7C | E0 F0 7C E0 F0 12 * Shift'd | E0 7C | E0 F0 7C * Control'd | E0 7C | E0 F0 7C * Alt'd | 84 | F0 84 * * Handling: These prefix/postfix codes are ignored, and both scan codes * 'E0 7C' and 84 are seen as PrintScreen. * * 4) Pause * modifiers | make(no break code) * ----------+-------------------------------------------------- * Other | E1 14 77 E1 F0 14 F0 77 * Control'd | E0 7E E0 F0 7E * * Handling: Both code sequences are treated as a whole. * And we need a ad hoc 'pseudo break code' hack to get the key off * because it has no break code. * * Notes: * 'Hanguel/English'(F1) and 'Hanja'(F2) have no break code. See [a]. * These two Korean keys need exceptional handling and are not supported for now. * */ static uint8_t cs2_e0code(uint8_t code) { switch(code) { // E0 prefixed codes translation See [a]. case 0x11: return 0x0F; // right alt case 0x14: return 0x17; // right control case 0x1F: return 0x19; // left GUI case 0x27: return 0x1F; // right GUI case 0x2F: return 0x5C; // apps case 0x4A: return 0x60; // keypad / case 0x5A: return 0x62; // keypad enter case 0x69: return 0x27; // end case 0x6B: return 0x53; // cursor left case 0x6C: return 0x2F; // home case 0x70: return 0x39; // insert case 0x71: return 0x37; // delete case 0x72: return 0x3F; // cursor down case 0x74: return 0x47; // cursor right case 0x75: return 0x4F; // cursor up case 0x7A: return 0x56; // page down case 0x7D: return 0x5E; // page up case 0x7C: return 0x6F; // Print Screen case 0x7E: return 0x00; // Control'd Pause case 0x21: return 0x65; // volume down case 0x32: return 0x6E; // volume up case 0x23: return 0x7F; // mute case 0x10: return 0x08; // (WWW search) -> F13 case 0x18: return 0x10; // (WWW favourites) -> F14 case 0x20: return 0x18; // (WWW refresh) -> F15 case 0x28: return 0x20; // (WWW stop) -> F16 case 0x30: return 0x28; // (WWW forward) -> F17 case 0x38: return 0x30; // (WWW back) -> F18 case 0x3A: return 0x38; // (WWW home) -> F19 case 0x40: return 0x40; // (my computer) -> F20 case 0x48: return 0x48; // (email) -> F21 case 0x2B: return 0x50; // (calculator) -> F22 case 0x34: return 0x08; // (play/pause) -> F13 case 0x3B: return 0x10; // (stop) -> F14 case 0x15: return 0x18; // (previous track) -> F15 case 0x4D: return 0x20; // (next track) -> F16 case 0x50: return 0x28; // (media select) -> F17 case 0x5E: return 0x50; // (ACPI wake) -> F22 case 0x3F: return 0x57; // (ACPI sleep) -> F23 case 0x37: return 0x5F; // (ACPI power) -> F24 // https://github.com/tmk/tmk_keyboard/pull/636 case 0x03: return 0x18; // Help DEC LK411 -> F15 case 0x04: return 0x08; // F13 DEC LK411 case 0x0B: return 0x20; // Do DEC LK411 -> F16 case 0x0C: return 0x10; // F14 DEC LK411 case 0x0D: return 0x19; // LCompose DEC LK411 -> LGUI case 0x79: return 0x6D; // KP- DEC LK411 -> PCMM case 0x83: return 0x28; // F17 DEC LK411 default: return (code & 0x7F); } } static int8_t process_cs2(void) { // scan code reading states static enum { INIT, F0, E0, E0_F0, // Pause E1, E1_14, E1_F0, E1_F0_14, E1_F0_14_F0, #ifdef G80_2551_SUPPORT // G80-2551 four extra keys around cursor keys G80, G80_F0, #endif } state = INIT; uint16_t code = ibmpc_host_recv(); if (code == -1) { return 0; } switch (state) { case INIT: switch (code) { case 0x00: // Error/Overrun [3]p.26 xprintf("!CS2_OVR!\n"); matrix_clear(); clear_keyboard(); break; case 0xFF: matrix_clear(); xprintf("!CS2_ERR!\n"); state = INIT; return -1; break; case 0xE0: state = E0; break; case 0xF0: state = F0; break; case 0xE1: state = E1; break; case 0x83: // F7 matrix_make(0x02); state = INIT; break; case 0x84: // Alt'd PrintScreen matrix_make(0x6F); state = INIT; break; case 0xAA: // Self-test passed case 0xFC: // Self-test failed // reset or plugin-in new keyboard state = INIT; return -1; break; #ifdef G80_2551_SUPPORT /* * G80-2551 terminal keyboard support */ case 0x80: // G80-2551 four extra keys around cursor keys state = G80; break; case 0x19: matrix_make(0x7F); // MUTE break; case 0x39: matrix_make(0x6E); // VOLU break; case 0x53: matrix_make(0x65); // VOLD break; case 0x6F: matrix_make(0x5C); // APP break; case 0x5C: matrix_make(0x19); // LGUI break; case 0x1F: matrix_make(0x1F); // RGUI break; case 0x27: matrix_make(0x67); // MHEN break; case 0x2F: matrix_make(0x57); // F23 break; case 0x5E: matrix_make(0x64); // HENK break; case 0x17: matrix_make(0x77); // NLCK break; #endif default: // normal key make state = INIT; if (code < 0x80) { matrix_make(code); } else { matrix_clear(); xprintf("!CS2_INIT!\n"); return -1; } } break; case E0: // E0-Prefixed switch (code) { case 0x12: // to be ignored case 0x59: // to be ignored state = INIT; break; case 0xF0: state = E0_F0; break; default: state = INIT; if (code < 0x80) { matrix_make(cs2_e0code(code)); } else { matrix_clear(); xprintf("!CS2_E0!\n"); return -1; } } break; case F0: // Break code switch (code) { case 0x83: // F7 matrix_break(0x02); state = INIT; break; case 0x84: // Alt'd PrintScreen matrix_break(0x6F); state = INIT; break; #ifdef G80_2551_SUPPORT /* * G80-2551 terminal keyboard support * https://deskthority.net/wiki/Cherry_G80-2551 * https://geekhack.org/index.php?topic=103648.msg2893404#msg2893404 * https://gist.github.com/tmk/22cb8680ca8ef854630ecd1953268c5b */ case 0x19: matrix_break(0x7F); // MUTE state = INIT; break; case 0x39: matrix_break(0x6E); // VOLU state = INIT; break; case 0x53: matrix_break(0x65); // VOLD state = INIT; break; case 0x6F: matrix_break(0x5C); // APP state = INIT; break; case 0x5C: matrix_break(0x19); // LGUI state = INIT; break; case 0x1F: matrix_break(0x1F); // RGUI state = INIT; break; case 0x27: matrix_break(0x67); // MHEN state = INIT; break; case 0x2F: matrix_break(0x57); // F23 state = INIT; break; case 0x5E: matrix_break(0x64); // HENK state = INIT; break; case 0x17: matrix_break(0x77); // NLCK state = INIT; break; #endif default: state = INIT; if (code < 0x80) { matrix_break(code); } else { matrix_clear(); xprintf("!CS2_F0!\n"); return -1; } } break; case E0_F0: // Break code of E0-prefixed switch (code) { case 0x12: // to be ignored case 0x59: // to be ignored state = INIT; break; default: state = INIT; if (code < 0x80) { matrix_break(cs2_e0code(code)); } else { matrix_clear(); xprintf("!CS2_E0_F0!\n"); return -1; } } break; // Pause make: E1 14 77 case E1: switch (code) { case 0x14: state = E1_14; break; case 0xF0: state = E1_F0; break; default: state = INIT; } break; case E1_14: switch (code) { case 0x77: matrix_make(0x00); state = INIT; break; default: state = INIT; } break; // Pause break: E1 F0 14 F0 77 case E1_F0: switch (code) { case 0x14: state = E1_F0_14; break; default: state = INIT; } break; case E1_F0_14: switch (code) { case 0xF0: state = E1_F0_14_F0; break; default: state = INIT; } break; case E1_F0_14_F0: switch (code) { case 0x77: matrix_break(0x00); state = INIT; break; default: state = INIT; } break; #ifdef G80_2551_SUPPORT case G80: // G80-2551 four extra keys around cursor keys switch (code) { case (0x26): // TD= -> JYEN matrix_make(0x6A); break; case (0x25): // page with edge -> NUHS matrix_make(0x68); break; case (0x16): // two pages -> RO matrix_make(0x51); break; case (0x1E): // calc -> KANA matrix_make(0x13); break; case (0xF0): state = G80_F0; return 0; default: // Not supported matrix_clear(); break; } state = INIT; break; case G80_F0: switch (code) { case (0x26): // TD= -> JYEN matrix_break(0x6A); break; case (0x25): // page with edge -> NUHS matrix_break(0x68); break; case (0x16): // two pages -> RO matrix_break(0x51); break; case (0x1E): // calc -> KANA matrix_break(0x13); break; default: // Not supported matrix_clear(); break; } state = INIT; break; #endif default: state = INIT; } return 0; } /* * Terminal: Scan Code Set 3 * * See [3], [7] * * Scan code 0x83 and 0x84 are handled exceptioanally to fit into 1-byte range index. */ static int8_t process_cs3(void) { static enum { READY, F0, } state = READY; uint16_t code = ibmpc_host_recv(); if (code == -1) { return 0; } switch (state) { case READY: switch (code) { case 0x00: // Error/Overrun [3]p.26 xprintf("!CS3_OVR!\n"); matrix_clear(); clear_keyboard(); break; case 0xFF: xprintf("!CS3_ERR!\n"); return -1; break; case 0xF0: state = F0; break; case 0x83: matrix_make(0x02); break; case 0x84: matrix_make(0x7F); break; default: // normal key make if (code < 0x80) { matrix_make(code); } else { xprintf("!CS3_READY!\n"); return -1; } } break; case F0: // Break code switch (code) { case 0x00: xprintf("!CS3_F0_OVR!\n"); matrix_clear(); clear_keyboard(); state = READY; break; case 0xFF: xprintf("!CS3_F0_ERR!\n"); state = READY; return -1; break; case 0x83: matrix_break(0x02); state = READY; break; case 0x84: matrix_break(0x7F); state = READY; break; default: state = READY; if (code < 0x80) { matrix_break(code); } else { xprintf("!CS3_F0!\n"); return -1; } } break; } return 0; } /* * IBM PC Keyboard Protocol Resources: * * [a] Microsoft USB HID to PS/2 Translation Table - Scan Code Set 1 and 2 * http://download.microsoft.com/download/1/6/1/161ba512-40e2-4cc9-843a-923143f3456c/translate.pdf * * [b] Microsoft Keyboard Scan Code Specification - Special rules of Scan Code Set 1 and 2 * http://download.microsoft.com/download/1/6/1/161ba512-40e2-4cc9-843a-923143f3456c/scancode.doc * * [1] PS/2 Reference Manuals - Collection of IBM Personal System/2 documents. * http://www.mcamafia.de/pdf/pdfref.htm * * [2] Keyboard and Auxiliary Device Controller - Signal Timing and Format * http://www.mcamafia.de/pdf/ibm_hitrc07.pdf * * [3] Keyboards(101- and 102-key) - Keyboard Layout, Scan Code Set, POR, and Commands. * http://www.mcamafia.de/pdf/ibm_hitrc11.pdf * * [4] IBM PC XT Keyboard Protocol * https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-XT-Keyboard-Protocol * * [5] IBM Keyboard Scan Code by John Elliott - 83-key, 84-key, 102-key and 122-key * https://www.seasip.info/VintagePC/index.html * * [6] IBM 1391406 Keyboard - Scan Code Set 2 of 102-key PS/2 keyboard * https://www.seasip.info/VintagePC/ibm_1391406.html * * [7] The IBM 6110344 Keyboard - Scan Code Set 3 of 122-key terminal keyboard * https://www.seasip.info/VintagePC/ibm_6110344.html * * [y] TrackPoint Engineering Specifications for version 3E * https://web.archive.org/web/20100526161812/http://wwwcssrv.almaden.ibm.com/trackpoint/download.html * * [z] [Soarer's XT/AT/PS2/Terminal to USB converter] * https://geekhack.org/index.php?topic=17458.0 * */