2 Copyright 2019,2020 Jun Wako <wakojun@gmail.com>
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>.
29 #include "ibmpc_usb.h"
33 static void matrix_make(uint8_t code);
34 static void matrix_break(uint8_t code);
36 static int8_t process_cs1(void);
37 static int8_t process_cs2(void);
38 static int8_t process_cs3(void);
41 static uint8_t matrix[MATRIX_ROWS];
42 #define ROW(code) ((code>>3)&0x0F)
43 #define COL(code) (code&0x07)
45 static int16_t read_wait(uint16_t wait_ms)
47 uint16_t start = timer_read();
49 while ((code = ibmpc_host_recv()) == -1 && timer_elapsed(start) < wait_ms);
53 static uint16_t read_keyboard_id(void)
59 //code = ibmpc_host_send(0xF5);
62 code = ibmpc_host_send(0xF2);
63 if (code == -1) { id = 0xFFFF; goto DONE; } // XT or No keyboard
64 if (code != 0xFA) { id = 0xFFFE; goto DONE; } // Broken PS/2?
66 // ID takes 500ms max TechRef [8] 4-41
67 code = read_wait(500);
68 if (code == -1) { id = 0x0000; goto DONE; } // AT
69 id = (code & 0xFF)<<8;
71 code = read_wait(500);
76 //code = ibmpc_host_send(0xF4);
81 void hook_early_init(void)
87 void matrix_init(void)
91 // initialize matrix state: all keys off
92 for (uint8_t i=0; i < MATRIX_ROWS; i++) matrix[i] = 0x00;
98 * keyboard recognition
100 * 1. Send F2 to get keyboard ID
101 * a. no ACK(FA): XT keyobard
102 * b. ACK but no ID: 84-key AT keyboard CodeSet2
103 * c. ID is AB 83: PS/2 keyboard CodeSet2
104 * d. ID is BF BF: Terminal keyboard CodeSet3
105 * e. error on recv: maybe broken PS/2
107 uint16_t keyboard_id = 0x0000;
108 keyboard_kind_t keyboard_kind = NONE;
109 uint8_t matrix_scan(void)
111 // scan code reading states
124 static uint16_t init_time;
128 xprintf("\nERR:%02X\n", ibmpc_error);
130 // when recv error, neither send error nor buffer full
131 if (!(ibmpc_error & (IBMPC_ERR_SEND | IBMPC_ERR_FULL))) {
132 // keyboard init again
139 // clear or process error
140 ibmpc_error = IBMPC_ERR_NONE;
145 xprintf("I%u ", timer_read());
146 keyboard_kind = NONE;
147 keyboard_id = 0x0000;
155 // Reset XT-initialize keyboard
156 // XT: hard reset 500ms for IBM XT Type-1 keyboard and clones
157 // XT: soft reset 20ms min(clock Lo)
158 ibmpc_host_disable(); // soft reset: inihibit(clock Lo/Data Hi)
159 IBMPC_RST_LO(); // hard reset: reset pin Lo
161 init_time = timer_read();
162 state = XT_RESET_WAIT;
165 if (timer_elapsed(init_time) > 500) {
166 state = XT_RESET_DONE;
170 IBMPC_RST_HIZ(); // hard reset: reset pin HiZ
171 ibmpc_host_isr_clear();
172 ibmpc_host_enable(); // soft reset: idle(clock Hi/Data Hi)
174 xprintf("X%u ", timer_read());
175 init_time = timer_read();
179 // 1) Read BAT code and ID on keybaord power-up
180 // For example, XT/AT sends 'AA' and Terminal sends 'AA BF BF' after BAT
181 // AT 84-key: POR and BAT can take 900-9900ms according to AT TechRef [8] 4-7
182 // AT 101/102-key: POR and BAT can take 450-2500ms according to AT TechRef [8] 4-39
183 // 2) Read key typed by user or anything after error on protocol or scan code
184 // This can happen in case of keyboard hotswap, unstable hardware, signal integrity problem or bug
186 /* wait until keyboard sends any code without 10000ms timeout
187 if (timer_elapsed(init_time) > 10000) {
191 if (ibmpc_host_recv() != -1) { // wait for AA
192 xprintf("W%u ", timer_read());
193 init_time = timer_read();
198 // NOTE: we can omit to wait BF BF
199 // ID takes 500ms max? TechRef [8] 4-41, though 1ms is enough for 122-key Terminal 6110345
200 if (timer_elapsed(init_time) > 500) {
203 if (ibmpc_host_recv() != -1) { // wait for BF
204 xprintf("W%u ", timer_read());
205 init_time = timer_read();
210 if (timer_elapsed(init_time) > 500) {
213 if (ibmpc_host_recv() != -1) { // wait for BF
214 xprintf("W%u ", timer_read());
219 xprintf("R%u ", timer_read());
221 keyboard_id = read_keyboard_id();
223 xprintf("\nERR:%02X\n", ibmpc_error);
224 ibmpc_error = IBMPC_ERR_NONE;
227 if (0xAB00 == (keyboard_id & 0xFF00)) { // CodeSet2 PS/2
228 keyboard_kind = PC_AT;
229 } else if (0xBF00 == (keyboard_id & 0xFF00)) { // CodeSet3 Terminal
230 keyboard_kind = PC_TERMINAL;
231 } else if (0x0000 == keyboard_id) { // CodeSet2 AT
232 keyboard_kind = PC_AT;
233 } else if (0xFFFF == keyboard_id) { // CodeSet1 XT
234 keyboard_kind = PC_XT;
235 } else if (0xFFFE == keyboard_id) { // CodeSet2 PS/2 fails to response?
236 keyboard_kind = PC_AT;
237 } else if (0x00FF == keyboard_id) { // Mouse is not supported
238 xprintf("Mouse: not supported\n");
239 keyboard_kind = NONE;
241 keyboard_kind = PC_AT;
244 xprintf("ID:%04X(%d)\n", keyboard_id, keyboard_kind);
249 xprintf("S%u ", timer_read());
250 switch (keyboard_kind) {
254 led_set(host_keyboard_leds());
257 ibmpc_host_send(0xF8);
263 xprintf("L%u ", timer_read());
265 switch (keyboard_kind) {
267 if (process_cs1() == -1) state = INIT;
270 if (process_cs2() == -1) state = INIT;
273 if (process_cs3() == -1) state = INIT;
286 bool matrix_is_on(uint8_t row, uint8_t col)
288 return (matrix[row] & (1<<col));
292 uint8_t matrix_get_row(uint8_t row)
297 uint8_t matrix_key_count(void)
300 for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
301 count += bitpop(matrix[i]);
308 static void matrix_make(uint8_t code)
310 if (!matrix_is_on(ROW(code), COL(code))) {
311 matrix[ROW(code)] |= 1<<COL(code);
316 static void matrix_break(uint8_t code)
318 if (matrix_is_on(ROW(code), COL(code))) {
319 matrix[ROW(code)] &= ~(1<<COL(code));
323 void matrix_clear(void)
325 for (uint8_t i=0; i < MATRIX_ROWS; i++) matrix[i] = 0x00;
328 void led_set(uint8_t usb_led)
330 if (keyboard_kind != PC_AT) return;
332 uint8_t ibmpc_led = 0;
333 if (usb_led & (1<<USB_LED_SCROLL_LOCK))
334 ibmpc_led |= (1<<IBMPC_LED_SCROLL_LOCK);
335 if (usb_led & (1<<USB_LED_NUM_LOCK))
336 ibmpc_led |= (1<<IBMPC_LED_NUM_LOCK);
337 if (usb_led & (1<<USB_LED_CAPS_LOCK))
338 ibmpc_led |= (1<<IBMPC_LED_CAPS_LOCK);
339 ibmpc_host_set_led(ibmpc_led);
343 /*******************************************************************************
344 * XT: Scan Code Set 1
348 * E0-escaped scan codes are translated into unused range of the matrix.(54-7F)
350 * 01-53: Normal codes used in original XT keyboard
351 * 54-7F: Not used in original XT keyboard
353 * 0 1 2 3 4 5 6 7 8 9 A B C D E F
354 * 50 - - - - * * x x x x * * * * * *
355 * 60 * * * * x x x x x x x x x x x *
356 * 70 x * * x * * x * * x * x * x x *
358 * -: codes existed in original XT keyboard
359 * *: E0-escaped codes translated
360 * x: Non-espcaped codes(Some are not used in real keyboards probably)
362 * Codes assigned in range 54-7F:
364 * 50 - 60 Up* 70 KANAx
365 * 51 - 61 Left* 71 Insert*
366 * 52 - 62 Down* 72 Delete*
367 * 53 - 63 Right* 73 ROx
368 * 54 PrintScr* 64 F13x 74 Home*
369 * 55 Pause* 65 F14x 75 End*
370 * 56 Euro2x 66 F15x 76 F24x
371 * 57 F11x 67 F16x 77 PageUp*
372 * 58 F12x 68 F17x 78 PageDown*
373 * 59 Keypad=x 69 F18x 79 HENKANx
374 * 5A LGUI* 6A F19x 7A RCTL*
375 * 5B RGUI* 6B F20x 7B MUHENKANx
376 * 5C APP* 6C F21x 7C RALT*
377 * 5D Mute* 6D F22x 7D JPYx
378 * 5E Volume Down* 6E F23x 7E Keypad,x
379 * 5F Volume Up* 6F Keypad Enter* 7F Keypad/ *
381 static uint8_t cs1_e0code(uint8_t code) {
383 // Original IBM XT keyboard doesn't use E0-codes probably
384 // Some XT compatilble keyobards need these keys?
385 case 0x37: return 0x54; // Print Screen
386 case 0x46: return 0x55; // Ctrl + Pause
387 case 0x5B: return 0x5A; // Left GUI
388 case 0x5C: return 0x5B; // Right GUI
389 case 0x5D: return 0x5C; // Application
390 case 0x20: return 0x5D; // Mute
391 case 0x2E: return 0x5E; // Volume Down
392 case 0x30: return 0x5F; // Volume Up
393 case 0x48: return 0x60; // Up
394 case 0x4B: return 0x61; // Left
395 case 0x50: return 0x62; // Down
396 case 0x4D: return 0x63; // Right
397 case 0x1C: return 0x6F; // Keypad Enter
398 case 0x52: return 0x71; // Insert
399 case 0x53: return 0x72; // Delete
400 case 0x47: return 0x74; // Home
401 case 0x4F: return 0x75; // End
402 case 0x49: return 0x77; // Page Up
403 case 0x51: return 0x78; // Page Down
404 case 0x1D: return 0x7A; // Right Ctrl
405 case 0x38: return 0x7C; // Right Alt
406 case 0x35: return 0x7F; // Keypad /
408 // Shared matrix cell with other keys
409 case 0x5E: return 0x70; // Power (KANA)
410 case 0x5F: return 0x79; // Sleep (HENKAN)
411 case 0x63: return 0x7B; // Wake (MUHENKAN)
414 xprintf("!CS1_E0_%02X!\n", code);
420 static int8_t process_cs1(void)
425 // Pause: E1 1D 45, E1 9D C5 [a] (TODO: test)
431 uint16_t code = ibmpc_host_recv();
436 // Check invalid codes; 0x59-7F won't be used in real XT keyboards probably
437 // 0x62 is used to handle escape code E0 and E1
438 if ((code & 0x7F) >= 0x62) {
439 xprintf("!CS1_INV!\n");
448 case 0xFF: // Error/Overrun [3]p.26
449 xprintf("!CS1_ERR!\n");
462 matrix_break(code & 0x7F);
477 matrix_make(cs1_e0code(code));
479 matrix_break(cs1_e0code(code & 0x7F));
524 /*******************************************************************************
525 * AT, PS/2: Scan Code Set 2
527 * Exceptional Handling
528 * --------------------
529 * Some keys should be handled exceptionally. See [b].
531 * Scan codes are varied or prefix/postfix'd depending on modifier key state.
533 * 1) Insert, Delete, Home, End, PageUp, PageDown, Up, Down, Right, Left
534 * a) when Num Lock is off
535 * modifiers | make | break
536 * ----------+---------------------------+----------------------
537 * Ohter | <make> | <break>
538 * LShift | E0 F0 12 <make> | <break> E0 12
539 * RShift | E0 F0 59 <make> | <break> E0 59
540 * L+RShift | E0 F0 12 E0 F0 59 <make> | <break> E0 59 E0 12
542 * b) when Num Lock is on
543 * modifiers | make | break
544 * ----------+---------------------------+----------------------
545 * Other | E0 12 <make> | <break> E0 F0 12
546 * Shift'd | <make> | <break>
548 * Handling: These prefix/postfix codes are ignored.
552 * modifiers | make | break
553 * ----------+---------------------------+----------------------
554 * Ohter | <make> | <break>
555 * LShift | E0 F0 12 <make> | <break> E0 12
556 * RShift | E0 F0 59 <make> | <break> E0 59
557 * L+RShift | E0 F0 12 E0 F0 59 <make> | <break> E0 59 E0 12
559 * Handling: These prefix/postfix codes are ignored.
563 * modifiers | make | break
564 * ----------+--------------+-----------------------------------
565 * Other | E0 12 E0 7C | E0 F0 7C E0 F0 12
566 * Shift'd | E0 7C | E0 F0 7C
567 * Control'd | E0 7C | E0 F0 7C
570 * Handling: These prefix/postfix codes are ignored, and both scan codes
571 * 'E0 7C' and 84 are seen as PrintScreen.
574 * modifiers | make(no break code)
575 * ----------+--------------------------------------------------
576 * Other | E1 14 77 E1 F0 14 F0 77
577 * Control'd | E0 7E E0 F0 7E
579 * Handling: Both code sequences are treated as a whole.
580 * And we need a ad hoc 'pseudo break code' hack to get the key off
581 * because it has no break code.
584 * 'Hanguel/English'(F1) and 'Hanja'(F2) have no break code. See [a].
585 * These two Korean keys need exceptional handling and are not supported for now.
588 static uint8_t cs2_e0code(uint8_t code) {
590 // E0 prefixed codes translation See [a].
591 case 0x11: return 0x0F; // right alt
592 case 0x14: return 0x17; // right control
593 case 0x1F: return 0x19; // left GUI
594 case 0x27: return 0x1F; // right GUI
595 case 0x2F: return 0x5C; // apps
596 case 0x4A: return 0x60; // keypad /
597 case 0x5A: return 0x62; // keypad enter
598 case 0x69: return 0x27; // end
599 case 0x6B: return 0x53; // cursor left
600 case 0x6C: return 0x2F; // home
601 case 0x70: return 0x39; // insert
602 case 0x71: return 0x37; // delete
603 case 0x72: return 0x3F; // cursor down
604 case 0x74: return 0x47; // cursor right
605 case 0x75: return 0x4F; // cursor up
606 case 0x7A: return 0x56; // page down
607 case 0x7D: return 0x5E; // page up
608 case 0x7C: return 0x6F; // Print Screen
609 case 0x7E: return 0x00; // Control'd Pause
611 case 0x21: return 0x65; // volume down
612 case 0x32: return 0x6E; // volume up
613 case 0x23: return 0x7F; // mute
614 case 0x10: return 0x08; // (WWW search) -> F13
615 case 0x18: return 0x10; // (WWW favourites) -> F14
616 case 0x20: return 0x18; // (WWW refresh) -> F15
617 case 0x28: return 0x20; // (WWW stop) -> F16
618 case 0x30: return 0x28; // (WWW forward) -> F17
619 case 0x38: return 0x30; // (WWW back) -> F18
620 case 0x3A: return 0x38; // (WWW home) -> F19
621 case 0x40: return 0x40; // (my computer) -> F20
622 case 0x48: return 0x48; // (email) -> F21
623 case 0x2B: return 0x50; // (calculator) -> F22
624 case 0x34: return 0x08; // (play/pause) -> F13
625 case 0x3B: return 0x10; // (stop) -> F14
626 case 0x15: return 0x18; // (previous track) -> F15
627 case 0x4D: return 0x20; // (next track) -> F16
628 case 0x50: return 0x28; // (media select) -> F17
629 case 0x5E: return 0x50; // (ACPI wake) -> F22
630 case 0x3F: return 0x57; // (ACPI sleep) -> F23
631 case 0x37: return 0x5F; // (ACPI power) -> F24
633 // https://github.com/tmk/tmk_keyboard/pull/636
634 case 0x03: return 0x18; // Help DEC LK411 -> F15
635 case 0x04: return 0x08; // F13 DEC LK411
636 case 0x0B: return 0x20; // Do DEC LK411 -> F16
637 case 0x0C: return 0x10; // F14 DEC LK411
638 case 0x0D: return 0x19; // LCompose DEC LK411 -> LGUI
639 case 0x79: return 0x6D; // KP- DEC LK411 -> PCMM
640 case 0x83: return 0x28; // F17 DEC LK411
641 default: return (code & 0x7F);
645 static int8_t process_cs2(void)
647 // scan code reading states
659 #ifdef G80_2551_SUPPORT
660 // G80-2551 four extra keys around cursor keys
666 uint16_t code = ibmpc_host_recv();
674 case 0x00: // Error/Overrun [3]p.26
675 xprintf("!CS2_OVR!\n");
681 xprintf("!CS2_ERR!\n");
698 case 0x84: // Alt'd PrintScreen
702 case 0xAA: // Self-test passed
703 case 0xFC: // Self-test failed
704 // reset or plugin-in new keyboard
708 #ifdef G80_2551_SUPPORT
710 * G80-2551 terminal keyboard support
712 case 0x80: // G80-2551 four extra keys around cursor keys
716 matrix_make(0x7F); // MUTE
719 matrix_make(0x6E); // VOLU
722 matrix_make(0x65); // VOLD
725 matrix_make(0x5C); // APP
728 matrix_make(0x19); // LGUI
731 matrix_make(0x1F); // RGUI
734 matrix_make(0x67); // MHEN
737 matrix_make(0x57); // F23
740 matrix_make(0x64); // HENK
743 matrix_make(0x77); // NLCK
746 default: // normal key make
752 xprintf("!CS2_INIT!\n");
757 case E0: // E0-Prefixed
759 case 0x12: // to be ignored
760 case 0x59: // to be ignored
769 matrix_make(cs2_e0code(code));
772 xprintf("!CS2_E0!\n");
777 case F0: // Break code
783 case 0x84: // Alt'd PrintScreen
787 #ifdef G80_2551_SUPPORT
789 * G80-2551 terminal keyboard support
790 * https://deskthority.net/wiki/Cherry_G80-2551
791 * https://geekhack.org/index.php?topic=103648.msg2893404#msg2893404
792 * https://gist.github.com/tmk/22cb8680ca8ef854630ecd1953268c5b
795 matrix_break(0x7F); // MUTE
799 matrix_break(0x6E); // VOLU
803 matrix_break(0x65); // VOLD
807 matrix_break(0x5C); // APP
811 matrix_break(0x19); // LGUI
815 matrix_break(0x1F); // RGUI
819 matrix_break(0x67); // MHEN
823 matrix_break(0x57); // F23
827 matrix_break(0x64); // HENK
831 matrix_break(0x77); // NLCK
841 xprintf("!CS2_F0!\n");
846 case E0_F0: // Break code of E0-prefixed
848 case 0x12: // to be ignored
849 case 0x59: // to be ignored
855 matrix_break(cs2_e0code(code));
858 xprintf("!CS2_E0_F0!\n");
863 // Pause make: E1 14 77
886 // Pause break: E1 F0 14 F0 77
915 #ifdef G80_2551_SUPPORT
916 case G80: // G80-2551 four extra keys around cursor keys
918 case (0x26): // TD= -> JYEN
921 case (0x25): // page with edge -> NUHS
924 case (0x16): // two pages -> RO
927 case (0x1E): // calc -> KANA
942 case (0x26): // TD= -> JYEN
945 case (0x25): // page with edge -> NUHS
948 case (0x16): // two pages -> RO
951 case (0x1E): // calc -> KANA
969 * Terminal: Scan Code Set 3
973 * Scan code 0x83 and 0x84 are handled exceptioanally to fit into 1-byte range index.
975 static int8_t process_cs3(void)
982 uint16_t code = ibmpc_host_recv();
990 case 0x00: // Error/Overrun [3]p.26
991 xprintf("!CS3_OVR!\n");
996 xprintf("!CS3_ERR!\n");
1002 case 0x83: // PrintScreen
1005 case 0x84: // Keypad *
1008 case 0x85: // Muhenkan
1011 case 0x86: // Henkan
1014 case 0x87: // Hiragana
1017 case 0x8B: // Left GUI
1020 case 0x8C: // Right GUI
1023 case 0x8D: // Application
1026 default: // normal key make
1030 xprintf("!CS3_READY!\n");
1035 case F0: // Break code
1038 xprintf("!CS3_F0_OVR!\n");
1044 xprintf("!CS3_F0_ERR!\n");
1048 case 0x83: // PrintScreen
1052 case 0x84: // Keypad *
1056 case 0x85: // Muhenkan
1060 case 0x86: // Henkan
1064 case 0x87: // Hiragana
1068 case 0x8B: // Left GUI
1072 case 0x8C: // Right GUI
1076 case 0x8D: // Application
1085 xprintf("!CS3_F0!\n");
1095 * IBM PC Keyboard Protocol Resources:
1097 * [a] Microsoft USB HID to PS/2 Translation Table - Scan Code Set 1 and 2
1098 * http://download.microsoft.com/download/1/6/1/161ba512-40e2-4cc9-843a-923143f3456c/translate.pdf
1100 * [b] Microsoft Keyboard Scan Code Specification - Special rules of Scan Code Set 1 and 2
1101 * http://download.microsoft.com/download/1/6/1/161ba512-40e2-4cc9-843a-923143f3456c/scancode.doc
1103 * [1] PS/2 Reference Manuals - Collection of IBM Personal System/2 documents.
1104 * http://www.mcamafia.de/pdf/pdfref.htm
1106 * [2] Keyboard and Auxiliary Device Controller - Signal Timing and Format
1107 * http://www.mcamafia.de/pdf/ibm_hitrc07.pdf
1109 * [3] Keyboards(101- and 102-key) - Keyboard Layout, Scan Code Set, POR, and Commands.
1110 * http://www.mcamafia.de/pdf/ibm_hitrc11.pdf
1112 * [4] IBM PC XT Keyboard Protocol
1113 * https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-XT-Keyboard-Protocol
1115 * [5] IBM Keyboard Scan Code by John Elliott - 83-key, 84-key, 102-key and 122-key
1116 * https://www.seasip.info/VintagePC/index.html
1118 * [6] IBM 1391406 Keyboard - Scan Code Set 2 of 102-key PS/2 keyboard
1119 * https://www.seasip.info/VintagePC/ibm_1391406.html
1121 * [7] The IBM 6110344 Keyboard - Scan Code Set 3 of 122-key terminal keyboard
1122 * https://www.seasip.info/VintagePC/ibm_6110344.html
1124 * [y] TrackPoint Engineering Specifications for version 3E
1125 * https://web.archive.org/web/20100526161812/http://wwwcssrv.almaden.ibm.com/trackpoint/download.html
1127 * [z] [Soarer's XT/AT/PS2/Terminal to USB converter]
1128 * https://geekhack.org/index.php?topic=17458.0