]> git.friedersdorff.com Git - max/tmk_keyboard.git/blobdiff - converter/ibmpc_usb/ibmpc_usb.c
ibmpc_usb: Fix led_set
[max/tmk_keyboard.git] / converter / ibmpc_usb / ibmpc_usb.c
index 17bdba83fcfb495b5bc9a659fbf77203fed1d3dc..52fffc3d245acb1714db9633a6466e1c5aa3a2e7 100644 (file)
@@ -68,6 +68,7 @@ static uint16_t read_keyboard_id(void)
     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;
 
@@ -104,6 +105,7 @@ void matrix_init(void)
  *      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)
@@ -140,6 +142,18 @@ uint8_t matrix_scan(void)
         ibmpc_error = IBMPC_ERR_NONE;
     }
 
+    // check ISR state debug
+    if (ibmpc_isr_debug) {
+        xprintf("\nISR:%04X\n", ibmpc_isr_debug);
+        ibmpc_isr_debug = 0;
+    }
+
+    // check protocol AT/XT
+    if (ibmpc_protocol != current_protocol) {
+        xprintf("\nPROTO:%02X\n", ibmpc_protocol);
+        current_protocol = ibmpc_protocol;
+    }
+
     switch (state) {
         case INIT:
             xprintf("I%u ", timer_read());
@@ -218,25 +232,50 @@ uint8_t matrix_scan(void)
         case READ_ID:
             xprintf("R%u ", timer_read());
 
+            // SKIDATA-2-DE(and some other keyboards?) stores 'Code Set' setting in nonvlatile 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
+            //ibmpc_host_send(0xFF);  // reset command
+            //read_wait(500);         // BAT takes 600-900ms(84-key) or 300-500ms(101/102-key) [8] 4-7, 4-39
+
             keyboard_id = read_keyboard_id();
             if (ibmpc_error) {
                 xprintf("\nERR:%02X\n", ibmpc_error);
                 ibmpc_error = IBMPC_ERR_NONE;
             }
 
-            if (0xAB00 == (keyboard_id & 0xFF00)) {         // CodeSet2 PS/2
+            if (0x0000 == keyboard_id) {            // CodeSet2 AT(IBM PC AT 84-key)
                 keyboard_kind = PC_AT;
-            } else if (0xBF00 == (keyboard_id & 0xFF00)) {  // CodeSet3 Terminal
-                keyboard_kind = PC_TERMINAL;
-            } else if (0x0000 == keyboard_id) {             // CodeSet2 AT
-                keyboard_kind = PC_AT;
-            } else if (0xFFFF == keyboard_id) {             // CodeSet1 XT
+            } else if (0xFFFF == keyboard_id) {     // CodeSet1 XT
                 keyboard_kind = PC_XT;
-            } else if (0xFFFE == keyboard_id) {             // CodeSet2 PS/2 fails to response?
+            } else if (0xFFFE == keyboard_id) {     // CodeSet2 PS/2 fails to response?
                 keyboard_kind = PC_AT;
-            } else if (0x00FF == keyboard_id) {             // Mouse is not supported
+            } else if (0x00FF == keyboard_id) {     // Mouse is not supported
                 xprintf("Mouse: not supported\n");
                 keyboard_kind = NONE;
+#ifdef G80_2551_SUPPORT
+            } else if (0xAB86 == keyboard_id ||
+                       0xAB85 == keyboard_id) {     // For G80-2551 and other 122-key terminal
+                // 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#ab85
+
+                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;
+                }
+#endif
+            } 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 {
                 keyboard_kind = PC_AT;
             }
@@ -254,6 +293,7 @@ uint8_t matrix_scan(void)
                     led_set(host_keyboard_leds());
                     break;
                 case PC_TERMINAL:
+                    // Set all keys to make/break type
                     ibmpc_host_send(0xF8);
                     break;
                 default:
@@ -327,7 +367,8 @@ void matrix_clear(void)
 
 void led_set(uint8_t usb_led)
 {
-    if (keyboard_kind != PC_AT) return;
+    if (keyboard_kind == NONE) return;
+    //if (keyboard_kind != PC_AT) return;
 
     uint8_t ibmpc_led = 0;
     if (usb_led &  (1<<USB_LED_SCROLL_LOCK))
@@ -605,12 +646,12 @@ static uint8_t cs2_e0code(uint8_t code) {
         case 0x75: return 0x4F; // cursor up
         case 0x7A: return 0x56; // page down
         case 0x7D: return 0x5E; // page up
-        case 0x7C: return 0x6F; // Print Screen
+        case 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 0x7F; // mute
+        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
@@ -656,11 +697,6 @@ static int8_t process_cs2(void)
         E1_F0,
         E1_F0_14,
         E1_F0_14_F0,
-#ifdef G80_2551_SUPPORT
-        // G80-2551 four extra keys around cursor keys
-        G80,
-        G80_F0,
-#endif
     } state = INIT;
 
     uint16_t code = ibmpc_host_recv();
@@ -696,7 +732,7 @@ static int8_t process_cs2(void)
                     state = INIT;
                     break;
                 case 0x84:  // Alt'd PrintScreen
-                    matrix_make(0x6F);
+                    matrix_make(0x7F);
                     state = INIT;
                     break;
                 case 0xAA:  // Self-test passed
@@ -705,44 +741,6 @@ static int8_t process_cs2(void)
                     state = INIT;
                     return -1;
                     break;
-#ifdef G80_2551_SUPPORT
-                /*
-                 * G80-2551 terminal keyboard support
-                 */
-                case 0x80:  // G80-2551 four extra keys around cursor keys
-                    state = G80;
-                    break;
-                case 0x19:
-                    matrix_make(0x7F);  // MUTE
-                    break;
-                case 0x39:
-                    matrix_make(0x6E);  // VOLU
-                    break;
-                case 0x53:
-                    matrix_make(0x65);  // VOLD
-                    break;
-                case 0x6F:
-                    matrix_make(0x5C);  // APP
-                    break;
-                case 0x5C:
-                    matrix_make(0x19);  // LGUI
-                    break;
-                case 0x1F:
-                    matrix_make(0x1F);  // RGUI
-                    break;
-                case 0x27:
-                    matrix_make(0x67);  // MHEN
-                    break;
-                case 0x2F:
-                    matrix_make(0x57);  // F23
-                    break;
-                case 0x5E:
-                    matrix_make(0x64);  // HENK
-                    break;
-                case 0x17:
-                    matrix_make(0x77);  // NLCK
-                    break;
-#endif
                 default:    // normal key make
                     state = INIT;
                     if (code < 0x80) {
@@ -781,57 +779,9 @@ static int8_t process_cs2(void)
                     state = INIT;
                     break;
                 case 0x84:  // Alt'd PrintScreen
-                    matrix_break(0x6F);
-                    state = INIT;
-                    break;
-#ifdef G80_2551_SUPPORT
-                /*
-                 * G80-2551 terminal keyboard support
-                 * https://deskthority.net/wiki/Cherry_G80-2551
-                 * https://geekhack.org/index.php?topic=103648.msg2893404#msg2893404
-                 * https://gist.github.com/tmk/22cb8680ca8ef854630ecd1953268c5b
-                 */
-                case 0x19:
-                    matrix_break(0x7F);  // MUTE
-                    state = INIT;
-                    break;
-                case 0x39:
-                    matrix_break(0x6E);  // VOLU
-                    state = INIT;
-                    break;
-                case 0x53:
-                    matrix_break(0x65);  // VOLD
-                    state = INIT;
-                    break;
-                case 0x6F:
-                    matrix_break(0x5C);  // APP
-                    state = INIT;
-                    break;
-                case 0x5C:
-                    matrix_break(0x19);  // LGUI
-                    state = INIT;
-                    break;
-                case 0x1F:
-                    matrix_break(0x1F);  // RGUI
-                    state = INIT;
-                    break;
-                case 0x27:
-                    matrix_break(0x67);  // MHEN
-                    state = INIT;
-                    break;
-                case 0x2F:
-                    matrix_break(0x57);  // F23
-                    state = INIT;
-                    break;
-                case 0x5E:
-                    matrix_break(0x64);  // HENK
-                    state = INIT;
-                    break;
-                case 0x17:
-                    matrix_break(0x77);  // NLCK
+                    matrix_break(0x7F);
                     state = INIT;
                     break;
-#endif
                 default:
                     state = INIT;
                     if (code < 0x80) {
@@ -912,53 +862,6 @@ static int8_t process_cs2(void)
                     state = INIT;
             }
             break;
-#ifdef G80_2551_SUPPORT
-        case G80:   // G80-2551 four extra keys around cursor keys
-            switch (code) {
-                case (0x26):    // TD= -> JYEN
-                    matrix_make(0x6A);
-                    break;
-                case (0x25):    // page with edge -> NUHS
-                    matrix_make(0x68);
-                    break;
-                case (0x16):    // two pages -> RO
-                    matrix_make(0x51);
-                    break;
-                case (0x1E):    // calc -> KANA
-                    matrix_make(0x13);
-                    break;
-                case (0xF0):
-                    state = G80_F0;
-                    return 0;
-                default:
-                    // Not supported
-                    matrix_clear();
-                    break;
-            }
-            state = INIT;
-            break;
-        case G80_F0:
-            switch (code) {
-                case (0x26):    // TD= -> JYEN
-                    matrix_break(0x6A);
-                    break;
-                case (0x25):    // page with edge -> NUHS
-                    matrix_break(0x68);
-                    break;
-                case (0x16):    // two pages -> RO
-                    matrix_break(0x51);
-                    break;
-                case (0x1E):    // calc -> KANA
-                    matrix_break(0x13);
-                    break;
-                default:
-                    // Not supported
-                    matrix_clear();
-                    break;
-            }
-            state = INIT;
-            break;
-#endif
         default:
             state = INIT;
     }
@@ -968,15 +871,19 @@ static int8_t process_cs2(void)
 /*
  * Terminal: Scan Code Set 3
  *
- * See [3], [7]
- *
- * Scan code 0x83 and 0x84 are handled exceptioanally to fit into 1-byte range index.
+ * See [3], [7] and
+ * https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-AT-Keyboard-Protocol#scan-code-set-3
  */
 static int8_t process_cs3(void)
 {
     static enum {
         READY,
         F0,
+#ifdef G80_2551_SUPPORT
+        // G80-2551 four extra keys around cursor keys
+        G80,
+        G80_F0,
+#endif
     } state = READY;
 
     uint16_t code = ibmpc_host_recv();
@@ -1023,6 +930,11 @@ static int8_t process_cs3(void)
                 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);
@@ -1087,6 +999,58 @@ static int8_t process_cs3(void)
                     }
             }
             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;
 }
@@ -1121,6 +1085,9 @@ static int8_t process_cs3(void)
  * [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
  *