From 7fd2c6a6660089203b3f0131e0f399cc0c780509 Mon Sep 17 00:00:00 2001 From: tmk Date: Tue, 18 Jan 2022 13:26:22 +0900 Subject: [PATCH] ibmpc: Remove old unused files --- converter/ibmpc_usb/ibmpc_usb.c | 1413 ----------------------------- converter/ibmpc_usb/ibmpc_usb.h | 12 - converter/ibmpc_usb/ibmpc_usb.hpp | 10 +- tmk_core/protocol/ibmpc.c | 394 -------- tmk_core/protocol/ibmpc.h | 204 ----- 5 files changed, 9 insertions(+), 2024 deletions(-) delete mode 100644 converter/ibmpc_usb/ibmpc_usb.c delete mode 100644 converter/ibmpc_usb/ibmpc_usb.h delete mode 100644 tmk_core/protocol/ibmpc.c delete mode 100644 tmk_core/protocol/ibmpc.h diff --git a/converter/ibmpc_usb/ibmpc_usb.c b/converter/ibmpc_usb/ibmpc_usb.c deleted file mode 100644 index b2dc8e85..00000000 --- a/converter/ibmpc_usb/ibmpc_usb.c +++ /dev/null @@ -1,1413 +0,0 @@ -/* -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 -#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 "unimap.h" -#include "unimap_trans.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(uint8_t code); -static int8_t process_cs2(uint8_t code); -static int8_t process_cs3(uint8_t code); - - -static matrix_row_t matrix[MATRIX_ROWS]; -#define ROW(code) ((code>>4)&0x07) -#define COL(code) (code&0x0F) - -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; -} - -#define ID_STR(id) (id == 0xFFFE ? "_????" : \ - (id == 0xFFFD ? "_Z150" : \ - (id == 0x0000 ? "_AT84" : \ - ""))) - -static uint16_t read_keyboard_id(void) -{ - uint16_t id = 0; - int16_t code = 0; - - // temporary fix Z-150 AT should response with ID - if (ibmpc_protocol == IBMPC_PROTOCOL_AT_Z150) return 0xFFFD; - - // 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; - - // Mouse responds with one-byte 00, this returns 00FF [y] p.14 - code = read_wait(500); - id |= code & 0xFF; - -DONE: - // Enable - //code = ibmpc_host_send(0xF4); - - return id; -} - -void hook_early_init(void) -{ - ibmpc_host_init(); -} - -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 - */ -uint8_t current_protocol = 0; -uint16_t keyboard_id = 0x0000; -keyboard_kind_t keyboard_kind = NONE; -uint8_t matrix_scan(void) -{ - // scan code reading states - static enum { - INIT, - WAIT_SETTLE, - AT_RESET, - XT_RESET, - XT_RESET_WAIT, - XT_RESET_DONE, - WAIT_AA, - WAIT_AABF, - WAIT_AABFBF, - READ_ID, - SETUP, - LOOP, - ERROR, - } state = INIT; - static uint16_t init_time; - -#ifdef IBMPC_MOUSE_ENABLE - static enum { - MOUSE_DEFAULT = 0, // Default three-button - MOUSE_INTELLI = 3, // Intellimouse Explorer 3-button & wheel - MOUSE_EXPLORER = 4, // Intellimouse Explorer 5-button & wheel - MOUSE_LOGITECH = 9 // Logitech PS/2++ - } mouse_id = MOUSE_DEFAULT; - static uint8_t mouse_btn = 0; -#endif - - if (ibmpc_error) { - xprintf("\n%u ERR:%02X ISR:%04X ", timer_read(), ibmpc_error, ibmpc_isr_debug); - - // 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("[RST] "); - state = ERROR; - } - } - - // clear or process error - ibmpc_error = IBMPC_ERR_NONE; - ibmpc_isr_debug = 0; - } - - // check protocol change AT/XT - if (ibmpc_protocol && ibmpc_protocol != current_protocol) { - xprintf("\n%u PRT:%02X ISR:%04X ", timer_read(), ibmpc_protocol, ibmpc_isr_debug); - - // protocol change between AT and XT indicates that - // keyboard is hotswapped or something goes wrong. - // This requires initializing keyboard again probably. - if (((current_protocol&IBMPC_PROTOCOL_XT) && (ibmpc_protocol&IBMPC_PROTOCOL_AT)) || - ((current_protocol&IBMPC_PROTOCOL_AT) && (ibmpc_protocol&IBMPC_PROTOCOL_XT))) { - if (state == LOOP) { - xprintf("[CHG] "); - state = ERROR; - } - } - - current_protocol = ibmpc_protocol; - ibmpc_isr_debug = 0; - } - - switch (state) { - case INIT: - xprintf("I%u ", timer_read()); - keyboard_kind = NONE; - keyboard_id = 0x0000; - current_protocol = 0; - - matrix_clear(); - - init_time = timer_read(); - state = WAIT_SETTLE; - ibmpc_host_enable(); - break; - case WAIT_SETTLE: - while (ibmpc_host_recv() != -1) ; // read data - - // wait for keyboard to settle after plugin - if (timer_elapsed(init_time) > 3000) { - state = AT_RESET; - } - break; - case AT_RESET: - xprintf("A%u ", timer_read()); - - // SKIDATA-2-DE(and some other keyboards?) stores 'Code Set' setting in nonvolatile memory - // and keeps it until receiving reset. Sending reset here may be useful to clear it, perhaps. - // https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-AT-Keyboard-Protocol#select-alternate-scan-codesf0 - - // reset command - if (0xFA == ibmpc_host_send(0xFF)) { - state = WAIT_AA; - } else { - 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 - // https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-XT-Keyboard-Protocol#keyboard-soft-reset - ibmpc_host_disable(); // soft reset: 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: - keyboard_id = read_keyboard_id(); - xprintf("R%u ", timer_read()); - - if (0x0000 == keyboard_id) { // CodeSet2 AT(IBM PC AT 84-key) - 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 (0xFFFD == keyboard_id) { // Zenith Z-150 AT - keyboard_kind = PC_AT; - } else if (0x00FF == keyboard_id) { // Mouse is not supported - keyboard_kind = PC_MOUSE; - } else if (0xAB85 == keyboard_id || // IBM 122-key Model M, NCD N-97 - 0xAB86 == keyboard_id || // Cherry G80-2551, IBM 1397000 - 0xAB92 == keyboard_id) { // IBM 5576-001 - // https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-AT-Keyboard-Protocol#ab85 - // https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-AT-Keyboard-Protocol#ab86 - // https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-AT-Keyboard-Protocol#ab92 - - if ((0xFA == ibmpc_host_send(0xF0)) && - (0xFA == ibmpc_host_send(0x03))) { - // switch to code set 3 - keyboard_kind = PC_TERMINAL; - } else { - keyboard_kind = PC_AT; - } - } else if (0xAB90 == keyboard_id || // IBM 5576-002 - 0xAB91 == keyboard_id) { // IBM 5576-003 - // https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-AT-Keyboard-Protocol#ab90 - // https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-AT-Keyboard-Protocol#ab91 - - xprintf("\n5576_CS82h:"); - if ((0xFA == ibmpc_host_send(0xF0)) && - (0xFA == ibmpc_host_send(0x82))) { - // switch to code set 82h - // https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-AT-Keyboard-Protocol#ibm-5576-scan-codes-set - xprintf("OK "); - } else { - xprintf("NG "); - } - keyboard_kind = PC_AT; - } else if (0xBFB0 == keyboard_id) { // IBM RT Keyboard - // https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-AT-Keyboard-Protocol#bfb0 - // TODO: LED indicator fix - //keyboard_kind = PC_TERMINAL_IBM_RT; - keyboard_kind = PC_TERMINAL; - } else 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 (0x7F00 == (keyboard_id & 0xFF00)) { // CodeSet3 Terminal 1394204 - keyboard_kind = PC_TERMINAL; - } else { - xprintf("\nUnknown ID: Report to TMK "); - if ((0xFA == ibmpc_host_send(0xF0)) && - (0xFA == ibmpc_host_send(0x02))) { - // switch to code set 2 - keyboard_kind = PC_AT; - } else if ((0xFA == ibmpc_host_send(0xF0)) && - (0xFA == ibmpc_host_send(0x03))) { - // switch to code set 3 - keyboard_kind = PC_TERMINAL; - } else { - keyboard_kind = PC_AT; - } - } - - xprintf("\nID:%04X(%s%s) ", keyboard_id, KEYBOARD_KIND_STR(keyboard_kind), ID_STR(keyboard_id)); - - 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: - // Set all keys to make/break type - ibmpc_host_send(0xF8); - // This should not be harmful - led_set(host_keyboard_leds()); - break; -#ifdef IBMPC_MOUSE_ENABLE - case PC_MOUSE: { - uint8_t s[3]; - void read_status(void) { - ibmpc_host_send(0xE9); - s[0] = ibmpc_host_recv_response(); - s[1] = ibmpc_host_recv_response(); - s[2] = ibmpc_host_recv_response(); - xprintf("S[%02X %02X %02X] ", s[0], s[1], s[2]); - } - - ibmpc_host_send(0xF5); // Disable - ibmpc_host_send(0xEA); // Set Stream Mode - read_status(); - - // Logitech Magic Status - // https://github.com/torvalds/linux/blob/master/drivers/input/mouse/logips2pp.c#L352 - xprintf("\nLMS: "); - ibmpc_host_send(0xE8); ibmpc_host_send(0x00); - ibmpc_host_send(0xE6); ibmpc_host_send(0xE6); ibmpc_host_send(0xE6); - read_status(); - if (s[0] == 0 || s[1] == 0) { - // Not Logitech - goto MOUSE_INTELLI; - } - - // Logitech Magic Knock - // https://www.win.tue.nl/~aeb/linux/kbd/scancodes-13.html - // https://web.archive.org/web/20030714000535/www.dqcs.com/logitech/ps2ppspec.htm - // https://github.com/torvalds/linux/blob/5bfc75d92efd494db37f5c4c173d3639d4772966/drivers/input/serio/libps2.c#L347 - xprintf("\nLOG: "); - // sliced magic byte: 0x39 - ibmpc_host_send(0xE6); - ibmpc_host_send(0xE8); ibmpc_host_send(0x00); - ibmpc_host_send(0xE8); ibmpc_host_send(0x03); - ibmpc_host_send(0xE8); ibmpc_host_send(0x02); - ibmpc_host_send(0xE8); ibmpc_host_send(0x01); - // sliced magic byte: 0xDB - ibmpc_host_send(0xE6); - ibmpc_host_send(0xE8); ibmpc_host_send(0x03); - ibmpc_host_send(0xE8); ibmpc_host_send(0x01); - ibmpc_host_send(0xE8); ibmpc_host_send(0x02); - ibmpc_host_send(0xE8); ibmpc_host_send(0x03); - mouse_id = MOUSE_LOGITECH; // 9 - goto MOUSE_DONE; - -MOUSE_INTELLI: - // Intellimouse protocol: 3 - xprintf("\nINT: "); - ibmpc_host_send(0xF3); ibmpc_host_send(0xC8); - ibmpc_host_send(0xF3); ibmpc_host_send(0x64); - ibmpc_host_send(0xF3); ibmpc_host_send(0x50); - mouse_id = read_keyboard_id() >> 8; - - // Intellimouse Explorer protocol: 4 - xprintf("\nEXP: "); - ibmpc_host_send(0xF3); ibmpc_host_send(0xC8); - ibmpc_host_send(0xF3); ibmpc_host_send(0xC8); - ibmpc_host_send(0xF3); ibmpc_host_send(0x50); - mouse_id = read_keyboard_id() >> 8; - - // Not Intellimouse - if (mouse_id == 0) { - xprintf("\nDEF: "); - ibmpc_host_send(0xF6); // Set Default - } - -MOUSE_DONE: - //ibmpc_host_send(0xEA); // Set Stream Mode - ibmpc_host_send(0xF4); // Enable - read_status(); - xprintf("\nMouse: %s\n", ((mouse_id == MOUSE_LOGITECH) ? "LOGITECH" : - ((mouse_id == MOUSE_INTELLI) ? "INTELLI" : - ((mouse_id == MOUSE_EXPLORER) ? "EXPLORER" : - ((mouse_id == MOUSE_DEFAULT) ? "DEFAULT" : "???"))))); - break; } -#endif - default: - break; - } - state = LOOP; - xprintf("L%u ", timer_read()); - case LOOP: - { - uint16_t code = ibmpc_host_recv(); - if (code == -1) { - // no code - break; - } - - // Keyboard Error/Overrun([3]p.26) or Buffer full - // Scan Code Set 1: 0xFF - // Scan Code Set 2 and 3: 0x00 - // Buffer full(IBMPC_ERR_FULL): 0xFF - if (keyboard_kind != PC_MOUSE && (code == 0x00 || code == 0xFF)) { - // clear stuck keys - matrix_clear(); - clear_keyboard(); - - xprintf("\n[CLR] "); - break; - } - - switch (keyboard_kind) { - case PC_XT: - if (process_cs1(code) == -1) state = ERROR; - break; - case PC_AT: - if (process_cs2(code) == -1) state = ERROR; - break; - case PC_TERMINAL: - if (process_cs3(code) == -1) state = ERROR; - break; -#ifdef IBMPC_MOUSE_ENABLE - case PC_MOUSE: { - // Logitec Mouse Data: - // https://github.com/torvalds/linux/blob/d2912cb15bdda8ba4a5dd73396ad62641af2f520/drivers/input/mouse/logips2pp.c#L41 - // Intellimouse Data: - // https://www.win.tue.nl/~aeb/linux/kbd/scancodes-13.html - int16_t b0, b1, b2, b3; - int16_t x = 0, y = 0; - int8_t v = 0, h = 0; - - b0 = code; - b1 = ibmpc_host_recv_response(); - if (b1 == -1) { state = ERROR; break; } - b2 = ibmpc_host_recv_response(); - if (b2 == -1) { state = ERROR; break; } - - switch (mouse_id) { - case MOUSE_DEFAULT: - case MOUSE_INTELLI: - case MOUSE_EXPLORER: - mouse_btn = (mouse_btn & 0xF8) | (b0 & 0x07); - x = (b0 & 0x10) ? (b1 | 0xFF00) : b1; - y = (b0 & 0x20) ? (b2 | 0xFF00) : b2; - break; - case MOUSE_LOGITECH: - if ((b0 & 0x48) == 0x48 && (b1 & 0x02) == 0x02) { - switch (((b0 & 0x30) >> 2) | ((b1 & 0x30) >> 4)) { - case 1: // C8 Dx xx - // Ignored while Scroll-Up/Down is pressed - if (!(b2 & 0x40)) { - if (b2 & 0x80) - h = ((b2 & 0x08) ? 0xF0 : 0x00) | (b2 & 0x0F); - else - v = ((b2 & 0x08) ? 0xF0 : 0x00) | (b2 & 0x0F); - } - // Back - if (b2 & 0x10) mouse_btn |= (1 << 3); else mouse_btn &= ~(1 << 3); - // Forward - if (b2 & 0x20) mouse_btn |= (1 << 4); else mouse_btn &= ~(1 << 4); - break; - case 2: // C8 Ex xx - if (b2 & 0x01) mouse_btn |= (1 << 6); else mouse_btn &= ~(1 << 6); - if (b2 & 0x02) mouse_btn |= (1 << 7); else mouse_btn &= ~(1 << 7); - // Task - if (b2 & 0x04) mouse_btn |= (1 << 5); else mouse_btn &= ~(1 << 5); - // Scroll-Up - if (b2 & 0x08) mouse_btn |= (1 << 6); else mouse_btn &= ~(1 << 6); - // Scroll-Down - if (b2 & 0x10) mouse_btn |= (1 << 7); else mouse_btn &= ~(1 << 7); - break; - case 3: // TouchPad? - if (b2 & 0x80) - h = ((b2 & 0x80) ? 0xF0 : 0x00) | ((b2 >> 4) & 0x0F); - else - v = ((b2 & 0x80) ? 0xF0 : 0x00) | ((b2 >> 4) & 0x0F); - - mouse_btn = (mouse_btn & 0xF8) | (b2 & 0x07); - break; - } - } else { - mouse_btn = (mouse_btn & 0xF8) | (b0 & 0x07); - x = (b0 & 0x10) ? (b1 | 0xFF00) : b1; - y = (b0 & 0x20) ? (b2 | 0xFF00) : b2; - } - break; - } - - // Extra byte - switch (mouse_id) { - case MOUSE_INTELLI: - b3 = ibmpc_host_recv_response(); - if (b3 == -1) break; - v = b3 & 0xFF; - break; - case MOUSE_EXPLORER: - b3 = ibmpc_host_recv_response(); - if (b3 == -1) break; - // sign extension - v = ((b3 & 0x08) ? 0xF0 : 0x00) | (b3 & 0x0F); - - // Back/Forward - if (b3 & 0x10) mouse_btn |= (1 << 3); else mouse_btn &= ~(1 << 3); - if (b3 & 0x20) mouse_btn |= (1 << 4); else mouse_btn &= ~(1 << 4); - break; - default: - break; - } - - - // chop to 8-bit - #define CHOP8(a) (((a) > 127) ? 127 : (((a) < -127) ? -127 : (a))) - report_mouse_t mouse_report = {}; - mouse_report.buttons = mouse_btn; - #ifdef MOUSE_EXT_REPORT - mouse_report.x = x; - mouse_report.y = -y; - #else - mouse_report.x = CHOP8(x); - mouse_report.y = -CHOP8(y); - #endif - mouse_report.v = -CHOP8(v); - mouse_report.h = CHOP8(h); - host_mouse_send(&mouse_report); - xprintf("M[x:%d y:%d v:%d h:%d b:%02X]\n", mouse_report.x, mouse_report.y, - mouse_report.v, mouse_report.h, mouse_report.buttons); - break; } -#endif - default: - break; - } - } - break; - case ERROR: - // something goes wrong - clear_keyboard(); - state = INIT; - break; - default: - break; - } - return 1; -} - -inline -bool matrix_is_on(uint8_t row, uint8_t col) -{ - return (matrix[row] & (1< 0x7F) return; - if (!matrix_is_on(ROW(u), COL(u))) { - matrix[ROW(u)] |= 1< 0x7F) return; - if (matrix_is_on(ROW(u), COL(u))) { - matrix[ROW(u)] &= ~(1< | - * 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 0x7F; // Print Screen - case 0x7E: return 0x00; // Control'd Pause - - case 0x21: return 0x65; // volume down - case 0x32: return 0x6E; // volume up - case 0x23: return 0x6F; // 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); - } -} - -// IBM 5576-002/003 Scan code translation -// https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-AT-Keyboard-Protocol#ibm-5576-code-set-82h -static uint8_t translate_5576_cs2(uint8_t code) { - switch (code) { - case 0x11: return 0x0F; // Zenmen -> RALT - case 0x13: return 0x11; // Kanji -> LALT - case 0x0E: return 0x54; // @ - case 0x54: return 0x5B; // [ - case 0x5B: return 0x5D; // ] - case 0x5C: return 0x6A; // JYEN - case 0x5D: return 0x6A; // JYEN - case 0x62: return 0x0E; // Han/Zen -> `~ - case 0x7C: return 0x77; // Keypad * - } - return code; -} -static uint8_t translate_5576_cs2_e0(uint8_t code) { - switch (code) { - case 0x11: return 0x13; // Hiragana -> KANA - case 0x41: return 0x7C; // Keypad ' - } - return code; -} - -static int8_t process_cs2(uint8_t code) -{ - // scan code reading states - static enum { - INIT, - F0, - E0, - E0_F0, - // Pause - E1, - E1_14, - E1_F0, - E1_F0_14, - E1_F0_14_F0, - } state = INIT; - - switch (state) { - case INIT: - if (0xAB90 == keyboard_id || 0xAB91 == keyboard_id) { - code = translate_5576_cs2(code); - } - switch (code) { - 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(0x7F); - state = INIT; - break; - case 0xAA: // Self-test passed - case 0xFC: // Self-test failed - // replug or unstable connection probably - 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 - if (0xAB90 == keyboard_id || 0xAB91 == keyboard_id) { - code = translate_5576_cs2_e0(code); - } - 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 - if (0xAB90 == keyboard_id || 0xAB91 == keyboard_id) { - code = translate_5576_cs2(code); - } - switch (code) { - case 0x83: // F7 - matrix_break(0x02); - state = INIT; - break; - case 0x84: // Alt'd PrintScreen - matrix_break(0x7F); - state = INIT; - break; - 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 - if (0xAB90 == keyboard_id || 0xAB91 == keyboard_id) { - code = translate_5576_cs2_e0(code); - } - 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; - default: - state = INIT; - } - return 0; -} - - -/* - * Terminal: Scan Code Set 3 - * - * See [3], [7] and - * https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-AT-Keyboard-Protocol#scan-code-set-3 - */ -// IBM 5576-001 Scan code translation -// https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-AT-Keyboard-Protocol#ibm-5576-code-set-3 -static uint8_t translate_5576_cs3(uint8_t code) { - switch (code) { - // Fix positon of keys to fit 122-key layout - case 0x13: return 0x5D; // JYEN - case 0x5C: return 0x51; // RO - case 0x76: return 0x7E; // Keypad ' - case 0x7E: return 0x76; // Keypad Dup - } - return code; -} - -static int8_t process_cs3(uint8_t code) -{ - static enum { - READY, - F0, -#ifdef G80_2551_SUPPORT - // G80-2551 four extra keys around cursor keys - G80, - G80_F0, -#endif - } state = READY; - - switch (code) { - case 0xAA: // BAT code - case 0xFC: // BAT code - case 0xBF: // Part of keyboard ID - case 0xAB: // Part keyboard ID - state = READY; - xprintf("!CS3_RESET!\n"); - return -1; - } - - switch (state) { - case READY: - if (0xAB92 == keyboard_id) { - code = translate_5576_cs3(code); - } - switch (code) { - case 0xF0: - state = F0; - break; - case 0x83: // PrintScreen - matrix_make(0x02); - break; - case 0x84: // Keypad * - matrix_make(0x7F); - break; - case 0x85: // Muhenkan - matrix_make(0x68); - break; - case 0x86: // Henkan - matrix_make(0x78); - break; - case 0x87: // Hiragana - matrix_make(0x00); - break; - case 0x8B: // Left GUI - matrix_make(0x01); - break; - case 0x8C: // Right GUI - matrix_make(0x09); - break; - case 0x8D: // Application - matrix_make(0x0A); - break; -#ifdef G80_2551_SUPPORT - case 0x80: // G80-2551 four extra keys around cursor keys - state = G80; - break; -#endif - default: // normal key make - if (code < 0x80) { - matrix_make(code); - } else { - xprintf("!CS3_READY!\n"); - } - } - break; - case F0: // Break code - state = READY; - if (0xAB92 == keyboard_id) { - code = translate_5576_cs3(code); - } - switch (code) { - case 0x83: // PrintScreen - matrix_break(0x02); - break; - case 0x84: // Keypad * - matrix_break(0x7F); - break; - case 0x85: // Muhenkan - matrix_break(0x68); - break; - case 0x86: // Henkan - matrix_break(0x78); - break; - case 0x87: // Hiragana - matrix_break(0x00); - break; - case 0x8B: // Left GUI - matrix_break(0x01); - break; - case 0x8C: // Right GUI - matrix_break(0x09); - break; - case 0x8D: // Application - matrix_break(0x0A); - break; - default: - if (code < 0x80) { - matrix_break(code); - } else { - xprintf("!CS3_F0!\n"); - } - } - break; -#ifdef G80_2551_SUPPORT - /* - * G80-2551 terminal keyboard support - * https://deskthority.net/wiki/Cherry_G80-2551 - * https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-AT-Keyboard-Protocol#g80-2551-in-code-set-3 - */ - case G80: // G80-2551 four extra keys around cursor keys - switch (code) { - case (0x26): // TD= -> JYEN - matrix_make(0x5D); - break; - case (0x25): // page with edge -> NUHS - matrix_make(0x53); - break; - case (0x16): // two pages -> RO - matrix_make(0x51); - break; - case (0x1E): // calc -> KANA - matrix_make(0x00); - break; - case (0xF0): - state = G80_F0; - return 0; - default: - // Not supported - matrix_clear(); - break; - } - state = READY; - break; - case G80_F0: - switch (code) { - case (0x26): // TD= -> JYEN - matrix_break(0x5D); - break; - case (0x25): // page with edge -> NUHS - matrix_break(0x53); - break; - case (0x16): // two pages -> RO - matrix_break(0x51); - break; - case (0x1E): // calc -> KANA - matrix_break(0x00); - break; - default: - // Not supported - matrix_clear(); - break; - } - state = READY; - break; -#endif - } - 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 - * - * [8] IBM PC AT Technical Reference 1986 - * http://bitsavers.org/pdf/ibm/pc/at/6183355_PC_AT_Technical_Reference_Mar86.pdf - * - * [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 - * - */ diff --git a/converter/ibmpc_usb/ibmpc_usb.h b/converter/ibmpc_usb/ibmpc_usb.h deleted file mode 100644 index 9f9bf35e..00000000 --- a/converter/ibmpc_usb/ibmpc_usb.h +++ /dev/null @@ -1,12 +0,0 @@ -#ifndef IBMPC_USB_H -#define IBMPC_USB_H - -typedef enum { NONE, PC_XT, PC_AT, PC_TERMINAL, PC_MOUSE } keyboard_kind_t; -#define KEYBOARD_KIND_STR(kind) \ - (kind == PC_XT ? "XT" : \ - kind == PC_AT ? "AT" : \ - kind == PC_TERMINAL ? "TERMINAL" : \ - kind == PC_MOUSE ? "MOUSE" : \ - "NONE") - -#endif diff --git a/converter/ibmpc_usb/ibmpc_usb.hpp b/converter/ibmpc_usb/ibmpc_usb.hpp index acb6d1fa..552bec8f 100644 --- a/converter/ibmpc_usb/ibmpc_usb.hpp +++ b/converter/ibmpc_usb/ibmpc_usb.hpp @@ -4,10 +4,18 @@ #include #include "matrix.h" #include "unimap_trans.h" -#include "ibmpc_usb.h" +typedef enum { NONE, PC_XT, PC_AT, PC_TERMINAL, PC_MOUSE } keyboard_kind_t; + +#define KEYBOARD_KIND_STR(kind) \ + (kind == PC_XT ? "XT" : \ + kind == PC_AT ? "AT" : \ + kind == PC_TERMINAL ? "TERMINAL" : \ + kind == PC_MOUSE ? "MOUSE" : \ + "NONE") + #define ID_STR(id) (id == 0xFFFE ? "_????" : \ (id == 0xFFFD ? "_Z150" : \ (id == 0x0000 ? "_AT84" : \ diff --git a/tmk_core/protocol/ibmpc.c b/tmk_core/protocol/ibmpc.c deleted file mode 100644 index 4fd0f508..00000000 --- a/tmk_core/protocol/ibmpc.c +++ /dev/null @@ -1,394 +0,0 @@ -/* -Copyright 2010,2011,2012,2013,2019 Jun WAKO - -This software is licensed with a Modified BSD License. -All of this is supposed to be Free Software, Open Source, DFSG-free, -GPL-compatible, and OK to use in both free and proprietary applications. -Additions and corrections to this file are welcome. - - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -* Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - -* Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in - the documentation and/or other materials provided with the - distribution. - -* Neither the name of the copyright holders nor the names of - contributors may be used to endorse or promote products derived - from this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE -LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -POSSIBILITY OF SUCH DAMAGE. -*/ - -/* - * IBM PC keyboard protocol - */ - -#include -#include -#include -#include "ibmpc.h" -#include "debug.h" -#include "timer.h" -#include "wait.h" -#include "ringbuf.h" - - -#define WAIT(stat, us, err) do { \ - if (!wait_##stat(us)) { \ - ibmpc_error = err; \ - goto ERROR; \ - } \ -} while (0) - - -volatile uint16_t ibmpc_isr_debug = 0; -volatile uint8_t ibmpc_protocol = IBMPC_PROTOCOL_NO; -volatile uint8_t ibmpc_error = IBMPC_ERR_NONE; - -/* buffer for data received from device */ -#define RINGBUF_SIZE 16 -static uint8_t rbuf[RINGBUF_SIZE]; -static ringbuf_t rb = {}; - -/* internal state of receiving data */ -static volatile uint16_t isr_state = 0x8000; -static uint8_t timer_start = 0; - -void ibmpc_host_init(void) -{ - // initialize reset pin to HiZ - IBMPC_RST_HIZ(); - inhibit(); - IBMPC_INT_INIT(); - IBMPC_INT_OFF(); - ringbuf_init(&rb, rbuf, RINGBUF_SIZE); -} - -void ibmpc_host_enable(void) -{ - IBMPC_INT_ON(); - idle(); -} - -void ibmpc_host_disable(void) -{ - IBMPC_INT_OFF(); - inhibit(); -} - -int16_t ibmpc_host_send(uint8_t data) -{ - bool parity = true; - ibmpc_error = IBMPC_ERR_NONE; - uint8_t retry = 0; - - dprintf("w%02X ", data); - - // Not receiving data - if (isr_state != 0x8000) dprintf("isr:%04X ", isr_state); - while (isr_state != 0x8000) ; - - // Not clock Lo - if (!clock_in()) dprintf("c:%u ", wait_clock_hi(1000)); - - // Not data Lo - if (!data_in()) dprintf("d:%u ", wait_data_hi(1000)); - - IBMPC_INT_OFF(); - -RETRY: - /* terminate a transmission if we have */ - inhibit(); - wait_us(200); // [5]p.54 - - /* 'Request to Send' and Start bit */ - data_lo(); - wait_us(200); - clock_hi(); // [5]p.54 [clock low]>100us [5]p.50 - WAIT(clock_lo, 10000, 1); // [5]p.53, -10ms [5]p.50 - - /* Data bit[2-9] */ - for (uint8_t i = 0; i < 8; i++) { - wait_us(15); - if (data&(1<= 3) { - ibmpc_isr_debug = isr_state; - ibmpc_error = IBMPC_ERR_TIMEOUT; - goto ERROR; - - // timeout error recovery - start receiving new data - // it seems to work somehow but may not under unstable situation - //timer_start = t; - //isr_state = 0x8000; - } - } - - isr_state = isr_state>>1; - if (dbit) isr_state |= 0x8000; - - // isr_state: state of receiving data from keyboard - // - // This should be initialized with 0x8000 before receiving data and - // the MSB '*1' works as marker to discrimitate between protocols. - // It stores sampled bit at MSB after right shift on each clock falling edge. - // - // XT protocol has two variants of signaling; XT_IBM and XT_Clone. - // XT_IBM uses two start bits 0 and 1 while XT_Clone uses just start bit 1. - // https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-XT-Keyboard-Protocol - // - // 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 - // ----------------------------------------------------- - // *1 0 0 0 0 0 0 0 | 0 0 0 0 0 0 0 0 Initial state(0x8000) - // - // x x x x x x x x | 0 0 0 0 0 0 0 0 midway(0-7 bits received) - // x x x x x x x x | *1 0 0 0 0 0 0 0 midway(8 bits received) - // b6 b5 b4 b3 b2 b1 b0 1 | 0 *1 0 0 0 0 0 0 XT_IBM-midway ^1 - // b7 b6 b5 b4 b3 b2 b1 b0 | 0 *1 0 0 0 0 0 0 AT-midway ^1 - // b7 b6 b5 b4 b3 b2 b1 b0 | 1 *1 0 0 0 0 0 0 XT_Clone-done ^3 - // b6 b5 b4 b3 b2 b1 b0 1 | 1 *1 0 0 0 0 0 0 XT_IBM-error ^3 - // pr b7 b6 b5 b4 b3 b2 b1 | 0 0 *1 0 0 0 0 0 AT-midway[b0=0] - // b7 b6 b5 b4 b3 b2 b1 b0 | 1 0 *1 0 0 0 0 0 XT_IBM-done ^2 - // pr b7 b6 b5 b4 b3 b2 b1 | 1 0 *1 0 0 0 0 0 AT-midway[b0=1] ^2 - // b7 b6 b5 b4 b3 b2 b1 b0 | 1 1 *1 0 0 0 0 0 XT_IBM-error-done - // x x x x x x x x | x 1 1 0 0 0 0 0 illegal - // st pr b7 b6 b5 b4 b3 b2 | b1 b0 0 *1 0 0 0 0 AT-done - // x x x x x x x x | x x 1 *1 0 0 0 0 illegal - // all other states than above illegal - // - // ^1: AT and XT_IBM takes same state. - // ^2: AT and XT_IBM takes same state in case that AT b0 is 1, - // we have to check AT stop bit to discriminate between the two protocol. - switch (isr_state & 0xFF) { - case 0b00000000: - case 0b10000000: - case 0b01000000: // ^1 - case 0b00100000: - // midway - goto NEXT; - break; - case 0b11000000: // ^3 - { - uint8_t us = 100; - // wait for rising and falling edge of b7 of XT_IBM - while (!(IBMPC_CLOCK_PIN&(1<>8; - ibmpc_protocol = IBMPC_PROTOCOL_XT_CLONE; - goto DONE; - } - } - break; - case 0b11100000: - // XT_IBM-error-done - ibmpc_isr_debug = isr_state; - isr_state = isr_state>>8; - ibmpc_protocol = IBMPC_PROTOCOL_XT_ERROR; - goto DONE; - break; - case 0b10100000: // ^2 - { - uint8_t us = 100; - // wait for rising and falling edge of AT stop bit to discriminate between XT and AT - while (!(IBMPC_CLOCK_PIN&(1<>8; - ibmpc_protocol = IBMPC_PROTOCOL_XT_IBM; - goto DONE; - } - } - break; - case 0b00010000: - case 0b10010000: - case 0b01010000: - case 0b11010000: - // AT-done - // TODO: parity check? - ibmpc_isr_debug = isr_state; - // stop bit check - if (isr_state & 0x8000) { - ibmpc_protocol = IBMPC_PROTOCOL_AT; - } else { - // Zenith Z-150 AT(beige/white lable) asserts stop bit as low - // https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-AT-Keyboard-Protocol#zenith-z-150-beige - ibmpc_protocol = IBMPC_PROTOCOL_AT_Z150; - } - isr_state = isr_state>>6; - goto DONE; - break; - case 0b01100000: - case 0b00110000: - case 0b10110000: - case 0b01110000: - case 0b11110000: - default: // xxxx_oooo(any 1 in low nibble) - // Illegal - ibmpc_isr_debug = isr_state; - ibmpc_error = IBMPC_ERR_ILLEGAL; - goto ERROR; - break; - } - -DONE: - // store data - ringbuf_push(&rb, isr_state & 0xFF); - if (ringbuf_is_full(&rb)) { - // just became full - // Disable ISR if buffer is full - IBMPC_INT_OFF(); - // inhibit: clock_lo - IBMPC_CLOCK_PORT &= ~(1< - -This software is licensed with a Modified BSD License. -All of this is supposed to be Free Software, Open Source, DFSG-free, -GPL-compatible, and OK to use in both free and proprietary applications. -Additions and corrections to this file are welcome. - - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -* Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - -* Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in - the documentation and/or other materials provided with the - distribution. - -* Neither the name of the copyright holders nor the names of - contributors may be used to endorse or promote products derived - from this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE -LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -POSSIBILITY OF SUCH DAMAGE. -*/ - -#ifndef IBMPC_H -#define IBMPC_H - -#include -#include "wait.h" -#include "print.h" - -/* - * IBM PC keyboard protocol - * - * PS/2 Resources - * -------------- - * [1] The PS/2 Mouse/Keyboard Protocol - * http://www.computer-engineering.org/ps2protocol/ - * Concise and thorough primer of PS/2 protocol. - * - * [2] Keyboard and Auxiliary Device Controller - * http://www.mcamafia.de/pdf/ibm_hitrc07.pdf - * Signal Timing and Format - * - * [3] Keyboards(101- and 102-key) - * http://www.mcamafia.de/pdf/ibm_hitrc11.pdf - * Keyboard Layout, Scan Code Set, POR, and Commands. - * - * [4] PS/2 Reference Manuals - * http://www.mcamafia.de/pdf/ibm_hitrc07.pdf - * Collection of IBM Personal System/2 documents. - * - * [5] TrackPoint Engineering Specifications for version 3E - * https://web.archive.org/web/20100526161812/http://wwwcssrv.almaden.ibm.com/trackpoint/download.html - */ -#define IBMPC_ACK 0xFA -#define IBMPC_RESEND 0xFE -#define IBMPC_SET_LED 0xED - -#define IBMPC_PROTOCOL_NO 0 -#define IBMPC_PROTOCOL_AT 0x10 -#define IBMPC_PROTOCOL_AT_Z150 0x11 -#define IBMPC_PROTOCOL_XT 0x20 -#define IBMPC_PROTOCOL_XT_IBM 0x21 -#define IBMPC_PROTOCOL_XT_CLONE 0x22 -#define IBMPC_PROTOCOL_XT_ERROR 0x23 - -// Error numbers -#define IBMPC_ERR_NONE 0 -#define IBMPC_ERR_RECV 0x00 -#define IBMPC_ERR_SEND 0x10 -#define IBMPC_ERR_TIMEOUT 0x20 -#define IBMPC_ERR_FULL 0x40 -#define IBMPC_ERR_ILLEGAL 0x80 -#define IBMPC_ERR_FF 0xF0 - -#define IBMPC_LED_SCROLL_LOCK 0 -#define IBMPC_LED_NUM_LOCK 1 -#define IBMPC_LED_CAPS_LOCK 2 - - -extern volatile uint16_t ibmpc_isr_debug; -extern volatile uint8_t ibmpc_protocol; -extern volatile uint8_t ibmpc_error; - -void ibmpc_host_init(void); -void ibmpc_host_enable(void); -void ibmpc_host_disable(void); -int16_t ibmpc_host_send(uint8_t data); -int16_t ibmpc_host_recv_response(void); -int16_t ibmpc_host_recv(void); -void ibmpc_host_isr_clear(void); -void ibmpc_host_set_led(uint8_t usb_led); - - -/*-------------------------------------------------------------------- - * static functions - *------------------------------------------------------------------*/ -#if defined(__AVR__) -/* - * Clock - */ -static inline void clock_lo(void) -{ - IBMPC_CLOCK_PORT &= ~(1<