max/tmk_keyboard
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
tmk_keyboard/converter/ibmpc_usb/ibmpc_usb.cpp
tmk 16ff313820 ibmpc_usb: AT/XT Auto-Switching keyboard support 
Prefer selecting AT protocool to XT
Send resend command 'FE' to keyboard that starts with 'AA' including parity error
https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-Keyboard-Converter#atxt-auto-switching
2021-10-25 15:35:49 +09:00

1309 lines
49 KiB
C++
Raw Blame History

/*
Copyright 2019,2020 Jun Wako <wakojun@gmail.com>
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 <http://www.gnu.org/licenses/>.
*/
#include <stdint.h>
#include <stdbool.h>
#include <avr/pgmspace.h>
#include "print.h"
#include "util.h"
#include "debug.h"
#include "host.h"
#include "led.h"
#include "matrix.h"
#include "timer.h"
#include "action.h"
#include "hook.h"
#include "ibmpc.hpp"
#include "ibmpc_usb.hpp"
// Converter
IBMPCConverter converter0 = IBMPCConverter(IBMPC::interface0);
#if defined(IBMPC_CLOCK_BIT1) && defined(IBMPC_DATA_BIT1)
IBMPCConverter converter1 = IBMPCConverter(IBMPC::interface1);
#endif
void hook_early_init(void)
{
converter0.init();
#if defined(IBMPC_CLOCK_BIT1) && defined(IBMPC_DATA_BIT1)
converter1.init();
#endif
}
void matrix_init(void)
{
debug_enable = true;
matrix_clear();
}
matrix_row_t matrix_get_row(uint8_t row)
{
return IBMPCConverter::matrix_get_row(row);
}
void matrix_clear(void)
{
IBMPCConverter::matrix_clear();
}
uint8_t matrix_scan(void)
{
converter0.process_interface();
#if defined(IBMPC_CLOCK_BIT1) && defined(IBMPC_DATA_BIT1)
converter1.process_interface();
#endif
}
void led_set(uint8_t usb_led)
{
converter0.set_led(usb_led);
#if defined(IBMPC_CLOCK_BIT1) && defined(IBMPC_DATA_BIT1)
converter1.set_led(usb_led);
#endif
}
extern const action_t actionmaps[][UNIMAP_ROWS][UNIMAP_COLS];
action_t action_for_key(uint8_t layer, keypos_t key)
{
return (action_t){ .code = pgm_read_word(&actionmaps[(layer)][key.row & 0x07][key.col & 0x0F]) };
}
void IBMPCConverter::set_led(uint8_t usb_led)
{
// Sending before keyboard recognition may be harmful for XT keyboard
if (keyboard_kind == NONE) return;
// XT keyobard doesn't support any command and it is harmful perhaps
// https://github.com/tmk/tmk_keyboard/issues/635#issuecomment-626993437
if (keyboard_kind == PC_XT) return;
if (keyboard_kind == PC_MOUSE) return;
// It should be safe to send the command to keyboards with AT protocol
// - IBM Terminal doesn't support the command and response with 0xFE but it is not harmful.
// - Some other Terminals like G80-2551 supports the command.
// https://geekhack.org/index.php?topic=103648.msg2894921#msg2894921
// TODO: PC_TERMINAL_IBM_RT support
uint8_t ibmpc_led = 0;
if (usb_led & (1<<USB_LED_SCROLL_LOCK))
ibmpc_led |= (1<<IBMPC_LED_SCROLL_LOCK);
if (usb_led & (1<<USB_LED_NUM_LOCK))
ibmpc_led |= (1<<IBMPC_LED_NUM_LOCK);
if (usb_led & (1<<USB_LED_CAPS_LOCK))
ibmpc_led |= (1<<IBMPC_LED_CAPS_LOCK);
ibmpc.host_set_led(ibmpc_led);
}
int16_t IBMPCConverter::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;
}
/*
* Keyboard ID
*
* 0000: IBM 84-key keyboard
* FFFF: XT keyobard
* FFFE: Broken AT or PS/2 keyboard?
* FFFD: Zenith Z-150 AT
* AB83: AT or PS/2 keyboard
* BFBF: IBM Terminal keyboard
* 00FF: Mouse
* https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-AT-Keyboard-Protocol#keyboard-id
*/
uint16_t IBMPCConverter::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;
}
uint8_t IBMPCConverter::process_interface(void)
{
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))) {
if (state == LOOP) {
// Reset
state = ERROR;
}
if (ibmpc.error == IBMPC_ERR_PARITY_AA) {
// AT/XT Auto-Switching support
// https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-Keyboard-Converter#atxt-auto-switching
state = ERROR_PARITY_AA;
}
}
// 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());
init_time = timer_read();
ibmpc.host_enable();
state = WAIT_SETTLE;
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];
ibmpc.host_send(0xF5); // Disable
ibmpc.host_send(0xEA); // Set Stream Mode
mouse_read_status(s);
// 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);
mouse_read_status(s);
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) == MOUSE_INTELLI ? MOUSE_INTELLI : MOUSE_DEFAULT);
// 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) == MOUSE_EXPLORER ? MOUSE_EXPLORER : MOUSE_DEFAULT);
// 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
mouse_read_status(s);
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_PARITY_AA:
{
xprintf("P%u ", timer_read());
// AT/XT Auto-Switching support: Send Resend command to select AT
uint16_t code = ibmpc.host_send(0xFE);
if (0xAA == code) {
state = READ_ID;
break;
}
}
// FALL THROUGH
case ERROR:
xprintf("E%u ", timer_read());
// reinit state
init();
matrix_clear();
clear_keyboard();
state = INIT;
break;
default:
break;
}
return 1;
}
/*******************************************************************************
* XT: Scan Code Set 1
*
* See [3], [a]
*
* E0-escaped scan codes are translated into unused range of the matrix.(54-7F)
*
* 01-53: Normal codes used in original XT keyboard
* 54-7F: Not used in original XT keyboard
*
* 0 1 2 3 4 5 6 7 8 9 A B C D E F
* 50 - - - - * * x x x x * * * * * *
* 60 * * * * x x x x x x x x x x x *
* 70 x * * x * * x * * x * x * x x *
*
* -: codes existed in original XT keyboard
* *: E0-escaped codes translated
* x: Non-espcaped codes(Some are not used in real keyboards probably)
*
* Codes assigned in range 54-7F:
*
* 50 - 60 Up* 70 KANAx
* 51 - 61 Left* 71 Insert*
* 52 - 62 Down* 72 Delete*
* 53 - 63 Right* 73 ROx
* 54 PrintScr* 64 F13x 74 Home*
* 55 Pause* 65 F14x 75 End*
* 56 Euro2x 66 F15x 76 F24x
* 57 F11x 67 F16x 77 PageUp*
* 58 F12x 68 F17x 78 PageDown*
* 59 Keypad=x 69 F18x 79 HENKANx
* 5A LGUI* 6A F19x 7A RCTL*
* 5B RGUI* 6B F20x 7B MUHENKANx
* 5C APP* 6C F21x 7C RALT*
* 5D Mute* 6D F22x 7D JPYx
* 5E Volume Down* 6E F23x 7E Keypad,x
* 5F Volume Up* 6F Keypad Enter* 7F Keypad/ *
*/
uint8_t IBMPCConverter::cs1_e0code(uint8_t code) {
switch(code) {
// Original IBM XT keyboard doesn't use E0-codes probably
// Some XT compatilble keyobards need these keys?
case 0x37: return 0x54; // Print Screen
case 0x46: return 0x55; // Ctrl + Pause
case 0x5B: return 0x5A; // Left GUI
case 0x5C: return 0x5B; // Right GUI
case 0x5D: return 0x5C; // Application
case 0x20: return 0x5D; // Mute
case 0x2E: return 0x5E; // Volume Down
case 0x30: return 0x5F; // Volume Up
case 0x48: return 0x60; // Up
case 0x4B: return 0x61; // Left
case 0x50: return 0x62; // Down
case 0x4D: return 0x63; // Right
case 0x1C: return 0x6F; // Keypad Enter
case 0x52: return 0x71; // Insert
case 0x53: return 0x72; // Delete
case 0x47: return 0x74; // Home
case 0x4F: return 0x75; // End
case 0x49: return 0x77; // Page Up
case 0x51: return 0x78; // Page Down
case 0x1D: return 0x7A; // Right Ctrl
case 0x38: return 0x7C; // Right Alt
case 0x35: return 0x7F; // Keypad /
// Shared matrix cell with other keys
case 0x5E: return 0x70; // Power (KANA)
case 0x5F: return 0x79; // Sleep (HENKAN)
case 0x63: return 0x7B; // Wake (MUHENKAN)
default:
xprintf("!CS1_E0_%02X!\n", code);
return code;
}
return 0x00;
}
int8_t IBMPCConverter::process_cs1(uint8_t code)
{
switch (state_cs1) {
case CS1_INIT:
switch (code) {
case 0xE0:
state_cs1 = CS1_E0;
break;
case 0xE1:
state_cs1 = CS1_E1;
break;
default:
if (code < 0x80)
matrix_make(code);
else
matrix_break(code & 0x7F);
break;
}
break;
case CS1_E0:
switch (code) {
case 0x2A:
case 0xAA:
case 0x36:
case 0xB6:
//ignore fake shift
state_cs1 = CS1_INIT;
break;
default:
if (code < 0x80)
matrix_make(cs1_e0code(code));
else
matrix_break(cs1_e0code(code & 0x7F));
state_cs1 = CS1_INIT;
break;
}
break;
case CS1_E1:
switch (code) {
case 0x1D:
state_cs1 = CS1_E1_1D;
break;
case 0x9D:
state_cs1 = CS1_E1_9D;
break;
default:
state_cs1 = CS1_INIT;
break;
}
break;
case CS1_E1_1D:
switch (code) {
case 0x45:
matrix_make(0x55); // Pause
state_cs1 = CS1_INIT;
break;
default:
state_cs1 = CS1_INIT;
break;
}
break;
case CS1_E1_9D:
switch (code) {
case 0xC5:
matrix_break(0x55); // Pause
state_cs1 = CS1_INIT;
break;
default:
state_cs1 = CS1_INIT;
break;
}
break;
default:
state_cs1 = CS1_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 | <make> | <break>
* LShift | E0 F0 12 <make> | <break> E0 12
* RShift | E0 F0 59 <make> | <break> E0 59
* L+RShift | E0 F0 12 E0 F0 59 <make> | <break> E0 59 E0 12
*
* b) when Num Lock is on
* modifiers | make | break
* ----------+---------------------------+----------------------
* Other | E0 12 <make> | <break> E0 F0 12
* Shift'd | <make> | <break>
*
* Handling: These prefix/postfix codes are ignored.
*
*
* 2) Keypad /
* modifiers | make | break
* ----------+---------------------------+----------------------
* Ohter | <make> | <break>
* LShift | E0 F0 12 <make> | <break> E0 12
* RShift | E0 F0 59 <make> | <break> E0 59
* L+RShift | E0 F0 12 E0 F0 59 <make> | <break> 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.
*
*/
uint8_t IBMPCConverter::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
uint8_t IBMPCConverter::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;
}
uint8_t IBMPCConverter::translate_5576_cs2_e0(uint8_t code) {
switch (code) {
case 0x11: return 0x13; // Hiragana -> KANA
case 0x41: return 0x7C; // Keypad '
}
return code;
}
int8_t IBMPCConverter::process_cs2(uint8_t code)
{
switch (state_cs2) {
case CS2_INIT:
if (0xAB90 == keyboard_id || 0xAB91 == keyboard_id) {
code = translate_5576_cs2(code);
}
switch (code) {
case 0xE0:
state_cs2 = CS2_E0;
break;
case 0xF0:
state_cs2 = CS2_F0;
break;
case 0xE1:
state_cs2 = CS2_E1;
break;
case 0x83: // F7
matrix_make(0x02);
state_cs2 = CS2_INIT;
break;
case 0x84: // Alt'd PrintScreen
matrix_make(0x7F);
state_cs2 = CS2_INIT;
break;
case 0xAA: // Self-test passed
case 0xFC: // Self-test failed
// replug or unstable connection probably
default: // normal key make
state_cs2 = CS2_INIT;
if (code < 0x80) {
matrix_make(code);
} else {
matrix_clear();
xprintf("!CS2_INIT!\n");
return -1;
}
}
break;
case CS2_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_cs2 = CS2_INIT;
break;
case 0xF0:
state_cs2 = CS2_E0_F0;
break;
default:
state_cs2 = CS2_INIT;
if (code < 0x80) {
matrix_make(cs2_e0code(code));
} else {
matrix_clear();
xprintf("!CS2_E0!\n");
return -1;
}
}
break;
case CS2_F0: // Break code
if (0xAB90 == keyboard_id || 0xAB91 == keyboard_id) {
code = translate_5576_cs2(code);
}
switch (code) {
case 0x83: // F7
matrix_break(0x02);
state_cs2 = CS2_INIT;
break;
case 0x84: // Alt'd PrintScreen
matrix_break(0x7F);
state_cs2 = CS2_INIT;
break;
default:
state_cs2 = CS2_INIT;
if (code < 0x80) {
matrix_break(code);
} else {
matrix_clear();
xprintf("!CS2_F0! %02X\n", code);
return -1;
}
}
break;
case CS2_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_cs2 = CS2_INIT;
break;
default:
state_cs2 = CS2_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 CS2_E1:
switch (code) {
case 0x14:
state_cs2 = CS2_E1_14;
break;
case 0xF0:
state_cs2 = CS2_E1_F0;
break;
default:
state_cs2 = CS2_INIT;
}
break;
case CS2_E1_14:
switch (code) {
case 0x77:
matrix_make(0x00);
state_cs2 = CS2_INIT;
break;
default:
state_cs2 = CS2_INIT;
}
break;
// Pause break: E1 F0 14 F0 77
case CS2_E1_F0:
switch (code) {
case 0x14:
state_cs2 = CS2_E1_F0_14;
break;
default:
state_cs2 = CS2_INIT;
}
break;
case CS2_E1_F0_14:
switch (code) {
case 0xF0:
state_cs2 = CS2_E1_F0_14_F0;
break;
default:
state_cs2 = CS2_INIT;
}
break;
case CS2_E1_F0_14_F0:
switch (code) {
case 0x77:
matrix_break(0x00);
state_cs2 = CS2_INIT;
break;
default:
state_cs2 = CS2_INIT;
}
break;
default:
state_cs2 = CS2_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
uint8_t IBMPCConverter::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;
}
int8_t IBMPCConverter::process_cs3(uint8_t code)
{
switch (code) {
case 0xAA: // BAT code
case 0xFC: // BAT code
case 0xBF: // Part of keyboard ID
case 0xAB: // Part keyboard ID
state_cs3 = CS3_READY;
xprintf("!CS3_RESET!\n");
return -1;
}
switch (state_cs3) {
case CS3_READY:
if (0xAB92 == keyboard_id) {
code = translate_5576_cs3(code);
}
switch (code) {
case 0xF0:
state_cs3 = CS3_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_cs3 = CS3_G80;
break;
#endif
default: // normal key make
if (code < 0x80) {
matrix_make(code);
} else {
xprintf("!CS3_READY!\n");
}
}
break;
case CS3_F0: // Break code
state_cs3 = CS3_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 CS3_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_cs3 = CS3_G80_F0;
return 0;
default:
// Not supported
matrix_clear();
break;
}
state_cs3 = CS3_READY;
break;
case CS3_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_cs3 = CS3_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
*
*/
Reference in a new issue View git blame Copy permalink