M0110: Fixed timing of signal handling.

2 files changed, 87 insertions, 26 deletions

diff --git a/m0110.c b/m0110.c
index f4f5223dd..522c3ec0d 100644
--- a/m0110.c
+++ b/m0110.c
@@ -66,7 +66,7 @@ Signaling
 ---------
 CLOCK is always from KEYBOARD. DATA are sent with MSB first.
 
-1) IDLE: both line is high.
+1) IDLE: both lines are high.
     CLOCK ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
     DATA  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -79,7 +79,7 @@ CLOCK is always from KEYBOARD. DATA are sent with MSB first.
 3) HOST->KEYBOARD: HOST asserts bit on falling edge.
     CLOCK ~~~~~~~~~~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~~~~~~~~~
     DATA  ~~~~~~|_____X777777X666666X555555X444444X333333X222222X111111X000000X~~~~~~~
-                <----> 840us(request to send by host)                     <-> 80us(hold DATA)
+                <----> 840us(request to send by host)                     <---> 80us(hold DATA)
                       <--> 180us(clock low)
                          <---> 220us(clock high)
 
@@ -98,11 +98,18 @@ COMMAND:
 
 KEY EVENT:
     bit 7       key state(0:press 1:release)
-    bit 6-1     scan code
+    bit 6-1     scan code(see below)
     bit 0       always 1
-    To get scan code,  use ((bits&(1<<7)) | ((bits&7F))>>1).
+    To get scan code use this: ((bits&(1<<7)) | ((bits&0x7F))>>1).
+
+    Note: On the M0110A, the numpad keys and the arrow keys are preceded by 0x79.
+          Moreover, the numpad keys =, /, * and + are preceded by shift-down 0x71 on press and shift-up 0xF1 on release.
+          So, the data transferred by nupmad 5 is "79 2F" whereas for numpad + it's "71 79 0D".
 
 SCAN CODE:
+    m0111_recv_key() function returns follwing scan codes instead of raw key events.
+    Scan codes are 1 byte long and bit7 is set when key is released. 
+
     M0110
     ,---------------------------------------------------------.
     |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backs|
@@ -127,29 +134,74 @@ SCAN CODE:
          | 3A|  37|             31              |   34| 3A|
          `------------------------------------------------'
 
+    M0110A
+    ,---------------------------------------------------------. ,---------------.
+    |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Bcksp| |Clr|  =|  /|  *|
+    |---------------------------------------------------------| |---------------|
+    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|   | |  7|  8|  9|  -|
+    |-----------------------------------------------------'   | |---------------|
+    |CapsLo|  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return| |  4|  5|  6|  +|
+    |---------------------------------------------------------| |---------------|
+    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  ,|  /|Shft|Up | |  1|  2|  3|   |
+    |---------------------------------------------------------' |-----------|Ent|
+    |Optio|Mac    |           Space           |  \|Lft|Rgt|Dn | |      0|  .|   |
+    `---------------------------------------------------------' `---------------'
+    ,---------------------------------------------------------. ,---------------.
+    | 32| 12| 13| 14| 15| 17| 16| 1A| 1C| 19| 1D| 1B| 18|   33| | 47| 68| 6D| 62|
+    |---------------------------------------------------------| |---------------|
+    |   30| 0C| 0D| 0E| 0F| 10| 11| 20| 22| 1F| 23| 21| 1E|   | | 59| 5B| 5C| 4E|
+    |-----------------------------------------------------'   | |---------------|
+    |    39| 00| 01| 02| 03| 05| 04| 26| 28| 25| 29| 27|    24| | 56| 57| 58| 66|
+    |---------------------------------------------------------| |---------------|
+    |      38| 06| 07| 08| 09| 0B| 2D| 2E| 2B| 2F| 2C|  38| 4D| | 53| 54| 55|   |
+    |---------------------------------------------------------' |-----------| 4C|
+    |   3A|     37|            31             | 2A| 46| 42| 48| |     52| 41|   |
+    `---------------------------------------------------------' `---------------'
+
 
 References
 ----------
+Technical Info for 128K/512K and Plus
+    ftp://ftp.apple.asimov.net/pub/apple_II/documentation/macintosh/Mac%20Hardware%20Info%20-%20Mac%20128K.pdf
+    ftp://ftp.apple.asimov.net/pub/apple_II/documentation/macintosh/Mac%20Hardware%20Info%20-%20Mac%20Plus.pdf
 Protocol:
+    Page 20 of Tech Info for 128K/512K
     http://www.mac.linux-m68k.org/devel/plushw.php
 Connector:
+    Page 20 of Tech Info for 128K/512K
     http://www.kbdbabel.org/conn/kbd_connector_macplus.png
 Signaling:
     http://www.kbdbabel.org/signaling/kbd_signaling_mac.png
     http://typematic.blog.shinobi.jp/Entry/14/
 Scan Codes:
+    Page 22 of Tech Info for 128K/512K
+    Page 07 of Tech Info for Plus
     http://m0115.web.fc2.com/m0110.jpg
     http://m0115.web.fc2.com/m0110a.jpg
 */
 
 
-#define WAIT(stat, us, err) do { \
+#define WAIT_US(stat, us, err) do { \
     if (!wait_##stat(us)) { \
         m0110_error = err; \
         goto ERROR; \
     } \
 } while (0)
 
+#define WAIT_MS(stat, ms, err) do { \
+    uint16_t _ms = ms; \
+    while (_ms) { \
+        if (wait_##stat(1000)) { \
+            break; \
+        } \
+        _ms--; \
+    } \
+    if (_ms == 0) { \
+        m0110_error = err; \
+        goto ERROR; \
+    } \
+} while (0)
+
 
 uint8_t m0110_error = 0;
 
@@ -158,9 +210,13 @@ void m0110_init(void)
 {
     uint8_t data;
     idle();
-    _delay_ms(255);
+    _delay_ms(1000);
 
-    m0110_send(M0110_MODLE);
+    // Model Number
+    // M0110 : 0x09  00001001 : model number 4 (100)
+    // M0110A: 0x0B  00001011 : model number 5 (101)
+    // M0110 & M0120: ???
+    m0110_send(M0110_MODEL);
     data = m0110_recv();
     print("m0110_init model: "); phex(data); print("\n");
 
@@ -174,24 +230,22 @@ uint8_t m0110_send(uint8_t data)
     m0110_error = 0;
 
     request();
-    WAIT(clock_lo, 1000, 0);
+    WAIT_MS(clock_lo, 250, 1);  // keyboard may block long time
     for (uint8_t bit = 0x80; bit; bit >>= 1) {
-        WAIT(clock_lo, 250, 3);
-        _delay_us(15);
+        WAIT_US(clock_lo, 250, 3);
         if (data&bit) {
             data_hi();
         } else {
             data_lo();
         }
-        WAIT(clock_hi, 200, 4);
+        WAIT_US(clock_hi, 200, 4);
     }
     _delay_us(100); // hold last bit for 80us
     idle();
     return 1;
 ERROR:
-    if (m0110_error) {
-        print("m0110_send err: "); phex(m0110_error); print("\n");
-    }
+    print("m0110_send err: "); phex(m0110_error); print("\n");
+    _delay_ms(500);
     idle();
     return 0;
 }
@@ -201,24 +255,20 @@ uint8_t m0110_recv(void)
     uint8_t data = 0;
     m0110_error = 0;
 
-    WAIT(clock_lo, -1, 0); // need 250ms? insted 0xffff(16bit max)us
+    WAIT_MS(clock_lo, 250, 1);  // keyboard may block long time
     for (uint8_t i = 0; i < 8; i++) {
         data <<= 1;
-        WAIT(clock_lo, 200, 2);
-        WAIT(clock_hi, 200, 3);
+        WAIT_US(clock_lo, 200, 2);
+        WAIT_US(clock_hi, 200, 3);
         if (data_in()) {
             data |= 1;
         }
     }
     idle();
-    if (data != M0110_NULL) {
-        print("m0110_recv data: "); phex(data); print("\n");
-    }
     return data;
 ERROR:
-    if (m0110_error) {
-        print("m0110_recv err: "); phex(m0110_error); print("\n");
-    }
+    print("m0110_recv err: "); phex(m0110_error); print("\n");
+    _delay_ms(500);
     idle();
     return 0xFF;
 }
@@ -231,7 +281,7 @@ uint8_t m0110_recv_key(void)
     if (key == 0xFF || key == M0110_NULL)
         return M0110_NULL;
     else 
-        return ((key&(1<<7)) | ((key&0x7F)>>1));
+        return M0110_RAW2SCAN(key);
 }
 
 
diff --git a/m0110.h b/m0110.h
index f5c1e21bd..287c45b54 100644
--- a/m0110.h
+++ b/m0110.h
@@ -55,11 +55,22 @@ POSSIBILITY OF SUCH DAMAGE.
 #endif
 
 #define M0110_INQUIRY     0x10
-#define M0110_INSTNAT     0x14
-#define M0110_MODLE       0x16
+#define M0110_INSTANT     0x14
+#define M0110_MODEL       0x16
 #define M0110_TEST        0x36
 
+#define M0110_PAD         0x79
 #define M0110_NULL        0x7B
+#define M0110_TEST_ACK    0x7D
+#define M0110_TEST_NAK    0x77
+
+
+/* scan code offset for keypad and arrow keys */
+#define M0110_KEYPAD_OFFSET 0x40
+#define M0110_ARROW_OFFSET  0x60
+
+/* convert key event raw response into scan code */
+#define M0110_RAW2SCAN(key) ((key&(1<<7)) | ((key&0x7F)>>1))
 
 
 extern uint8_t m0110_error;