Merge branch 'm0110a'

m0110.c

@@ -1,5 +1,5 @@
 /*
-Copyright 2011 Jun WAKO <wakojun@gmail.com>
+Copyright 2011,2012 Jun WAKO <wakojun@gmail.com>
 
 This software is licensed with a Modified BSD License.
 All of this is supposed to be Free Software, Open Source, DFSG-free,
@@ -34,6 +34,7 @@ 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.
 */
+/* M0110A Support was contributed by skagon@github */
 
 #include <stdbool.h>
 #include <avr/io.h>
@@ -43,6 +44,9 @@ POSSIBILITY OF SUCH DAMAGE.
 #include "debug.h"
 
 
+static inline uint8_t raw2scan(uint8_t raw);
+static inline uint8_t inquiry(void);
+static inline uint8_t instant(void);
 static inline void clock_lo(void);
 static inline void clock_hi(void);
 static inline bool clock_in(void);
@@ -57,130 +61,6 @@ static inline void idle(void);
 static inline void request(void);
 
 
-/*
-Primitive M0110 Library for AVR
-==============================
-
-
-Signaling
----------
-CLOCK is always from KEYBOARD. DATA are sent with MSB first.
-
-1) IDLE: both lines are high.
-    CLOCK ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-    DATA  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-2) KEYBOARD->HOST: HOST reads bit on rising edge.
-    CLOCK ~~~~~~~~~~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~~~~~~~~~
-    DATA  ~~~~~~~~~~~~X777777X666666X555555X444444X333333X222222X111111X000000X~~~~~~~
-                      <--> 160us(clock low)
-                         <---> 180us(clock high)
-
-3) HOST->KEYBOARD: HOST asserts bit on falling edge.
-    CLOCK ~~~~~~~~~~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~~~~~~~~~
-    DATA  ~~~~~~|_____X777777X666666X555555X444444X333333X222222X111111X000000X~~~~~~~
-                <----> 840us(request to send by host)                     <---> 80us(hold DATA)
-                      <--> 180us(clock low)
-                         <---> 220us(clock high)
-
-
-Protocol
---------
-COMMAND:
-    Inquiry     0x10    get key event
-    Instant     0x12    get key event
-    Model       0x14    get model number(M0110 responds with 0x09)
-                        bit 7   1 if another device connected(used when keypad exists?)
-                        bit4-6  next device model number
-                        bit1-3  keyboard model number
-                        bit 0   always 1
-    Test        0x16    test(ACK:0x7D/NAK:0x77)
-
-KEY EVENT:
-    bit 7       key state(0:press 1:release)
-    bit 6-1     scan code(see below)
-    bit 0       always 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|
-    |---------------------------------------------------------|
-    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|  \|
-    |---------------------------------------------------------|
-    |CapsLo|  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return|
-    |---------------------------------------------------------|
-    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  ,|  /|        |
-    `---------------------------------------------------------'
-         |Opt|Mac |         Space               |Enter|Opt|
-         `------------------------------------------------'
-    ,---------------------------------------------------------.
-    | 32| 12| 13| 14| 15| 17| 16| 1A| 1C| 19| 1D| 1B| 18|   33|
-    |---------------------------------------------------------|
-    |   30| 0C| 0D| 0E| 0F| 10| 11| 20| 22| 1F| 23| 21| 1E| 2A|
-    |---------------------------------------------------------|
-    |    39| 00| 01| 02| 03| 05| 04| 26| 28| 25| 29| 27|    24|
-    |---------------------------------------------------------|
-    |      38| 06| 07| 08| 09| 0B| 2D| 2E| 2B| 2F| 2C|      38|
-    `---------------------------------------------------------'
-         | 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_US(stat, us, err) do { \
     if (!wait_##stat(us)) { \
         m0110_error = err; \
@@ -202,6 +82,9 @@ Scan Codes:
     } \
 } while (0)
 
+#define KEY(raw)        ((raw) & 0x7f)
+#define IS_BREAK(raw)   (((raw) & 0x80) == 0x80)
+
 
 uint8_t m0110_error = 0;
 
@@ -212,10 +95,6 @@ void m0110_init(void)
     idle();
     _delay_ms(1000);
 
-    // 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");
@@ -273,17 +152,179 @@ ERROR:
     return 0xFF;
 }
 
+/*
+Handling for exceptional case of key combinations for M0110A
+
+Shift and Calc/Arrow key could be operated simultaneously:
+
+    Case Shift   Arrow   Events          Interpret
+    -------------------------------------------------------------------
+    1    Down    Down    71, 79, DD      Calc(d)*a *b
+    2    Down    Up      71, 79, UU      Arrow&Calc(u)*a
+    3    Up      Down    F1, 79, DD      Shift(u) *c
+    4    Up      Up      F1, 79, UU      Shift(u) and Arrow&Calc(u)*a
+
+    Case Shift   Calc    Events          Interpret
+    -------------------------------------------------------------------
+    5(1) Down    Down    71, 71, 79, DD  Shift(d) and Cacl(d)
+    6(2) Down    Up      F1, 71, 79, UU  Shift(u) and Arrow&Calc(u)*a
+    7(1) Up      Down    F1, 71, 79, DD  Shift(u) and Calc(d)
+    8(4) Up      Up      F1, F1, 79, UU  Shift(ux2) and Arrow&Calc(u)*a
+
+During Calc key is hold:
+    Case Shift   Arrow   Events          Interpret
+    -------------------------------------------------------------------
+    A(3) ----    Down    F1, 79, DD      Shift(u) *c
+    B    ----    Up      79, UU          Arrow&Calc(u)*a
+    C    Down    ----    F1, 71          Shift(u) and Shift(d)
+    D    Up      ----    F1              Shift(u)
+    E    Hold    Down    79, DD          Normal
+    F    Hold    Up      79, UU          Arrow&Calc(u)*a
+    G(1) Down    Down    F1, 71, 79, DD  Shift(u)*b and Calc(d)*a
+    H(2) Down    Up      F1, 71, 79, UU  Shift(u) and Arrow&Calc(u)*a
+    I(3) Up      Down    F1, F1, 79, DD  Shift(ux2) *c
+    J(4) Up      Up      F1, 79, UU      Shift(u) and Arrow&Calc(u)*a
+
+    Case Shift   Calc    Events          Interpret
+    -------------------------------------------------------------------
+    K(1) ----    Down    71, 79, DD      Calc(d)*a
+    L(4) ----    Up      F1, 79, UU      Shift(u) and Arrow&Calc(u)*a
+    M(1) Hold    Down    71, 79, DD      Calc(d)*a
+    N    Hold    Up      79, UU          Arrow&Calc(u)*a
+
+    Where DD/UU indicates part of Keypad Down/Up event.
+    *a: Impossible to distinguish btween Arrow and Calc event.
+    *b: Shift(d) event is ignored.
+    *c: Arrow/Calc(d) event is ignored.
+*/
 uint8_t m0110_recv_key(void)
 {
-    uint8_t key;
+    static uint8_t keybuf = 0x00;
+    static uint8_t keybuf2 = 0x00;
+    static uint8_t rawbuf = 0x00;
+    uint8_t raw, raw2, raw3;
+
+    if (keybuf) {
+        raw = keybuf;
+        keybuf = 0x00;
+        return raw;
+    }
+    if (keybuf2) {
+        raw = keybuf2;
+        keybuf2 = 0x00;
+        return raw;
+    }
+
+    if (rawbuf) {
+        raw = rawbuf;
+        rawbuf = 0x00;
+    } else {
+        raw = instant();  // Use INSTANT for better response. Should be INQUIRY ?
+    }
+    switch (KEY(raw)) {
+        case M0110_KEYPAD:
+            raw2 = instant();
+            switch (KEY(raw2)) {
+                case M0110_ARROW_UP:
+                case M0110_ARROW_DOWN:
+                case M0110_ARROW_LEFT:
+                case M0110_ARROW_RIGHT:
+                    if (IS_BREAK(raw2)) {
+                        // Case B,F,N:
+                        keybuf = (raw2scan(raw2) | M0110_CALC_OFFSET); // Calc(u)
+                        return (raw2scan(raw2) | M0110_KEYPAD_OFFSET); // Arrow(u)
+                    }
+                    break;
+            }
+            // Keypad or Arrow
+            return (raw2scan(raw2) | M0110_KEYPAD_OFFSET);
+            break;
+        case M0110_SHIFT:
+            raw2 = instant();
+            switch (KEY(raw2)) {
+                case M0110_SHIFT:
+                    // Case: 5-8,C,G,H
+                    rawbuf = raw2;
+                    return raw2scan(raw); // Shift(d/u)
+                    break;
+                case M0110_KEYPAD:
+                    // Shift + Arrow, Calc, or etc.
+                    raw3 = instant();
+                    switch (KEY(raw3)) {
+                        case M0110_ARROW_UP:
+                        case M0110_ARROW_DOWN:
+                        case M0110_ARROW_LEFT:
+                        case M0110_ARROW_RIGHT:
+                            if (IS_BREAK(raw)) {
+                                if (IS_BREAK(raw3)) {
+                                    // Case 4:
+                                    print("(4)\n");
+                                    keybuf2 = raw2scan(raw); // Shift(u)
+                                    keybuf  = (raw2scan(raw3) | M0110_CALC_OFFSET); // Calc(u)
+                                    return (raw2scan(raw3) | M0110_KEYPAD_OFFSET);  // Arrow(u)
+                                } else {
+                                    // Case 3:
+                                    print("(3)\n");
+                                    return (raw2scan(raw)); // Shift(u)
+                                }
+                            } else {
+                                if (IS_BREAK(raw3)) {
+                                    // Case 2:
+                                    print("(2)\n");
+                                    keybuf  = (raw2scan(raw3) | M0110_CALC_OFFSET); // Calc(u)
+                                    return (raw2scan(raw3) | M0110_KEYPAD_OFFSET);  // Arrow(u)
+                                } else {
+                                    // Case 1:
+                                    print("(1)\n");
+                                    return (raw2scan(raw3) | M0110_CALC_OFFSET); // Calc(d)
+                                }
+                            }
+                            break;
+                        default:
+                            // Shift + Keypad
+                            keybuf = (raw2scan(raw3) | M0110_KEYPAD_OFFSET);
+                            return raw2scan(raw);   // Shift(d/u)
+                            break;
+                    }
+                    break;
+                default:
+                    // Shift + Normal keys
+                    keybuf = raw2scan(raw2);
+                    return raw2scan(raw);   // Shift(d/u)
+                    break;
+            }
+            break;
+        default:
+            // Normal keys
+            return raw2scan(raw);
+            break;
+    }
+}
+
+
+static inline uint8_t raw2scan(uint8_t raw) {
+    return (raw == M0110_NULL) ?  M0110_NULL : (
+                (raw == M0110_ERROR) ?  M0110_ERROR : (
+                    ((raw&0x80) | ((raw&0x7F)>>1))
+                )
+           );
+}
+
+static inline uint8_t inquiry(void)
+{
     m0110_send(M0110_INQUIRY);
-    key = m0110_recv();
-    if (key == 0xFF || key == M0110_NULL)
-        return M0110_NULL;
-    else 
-        return M0110_RAW2SCAN(key);
+    return m0110_recv();
 }
 
+static inline uint8_t instant(void)
+{
+    m0110_send(M0110_INSTANT);
+    uint8_t data = m0110_recv();
+    if (data != M0110_NULL) {
+        phex(data); print(" ");
+    }
+    return data;
+}
 
 static inline void clock_lo()
 {
@@ -354,3 +395,180 @@ static inline void request(void)
     clock_hi();
     data_lo();
 }
+
+
+
+/*
+Primitive M0110 Library for AVR
+==============================
+
+
+Signaling
+---------
+CLOCK is always from KEYBOARD. DATA are sent with MSB first.
+
+1) IDLE: both lines are high.
+    CLOCK ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    DATA  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+2) KEYBOARD->HOST: HOST reads bit on rising edge.
+    CLOCK ~~~~~~~~~~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~~~~~~~~~
+    DATA  ~~~~~~~~~~~~X777777X666666X555555X444444X333333X222222X111111X000000X~~~~~~~
+                      <--> 160us(clock low)
+                         <---> 180us(clock high)
+
+3) HOST->KEYBOARD: HOST asserts bit on falling edge.
+    CLOCK ~~~~~~~~~~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~|__|~~~~~~~~~~~
+    DATA  ~~~~~~|_____X777777X666666X555555X444444X333333X222222X111111X000000X~~~~~~~
+                <----> 840us(request to send by host)                     <---> 80us(hold DATA)
+                      <--> 180us(clock low)
+                         <---> 220us(clock high)
+
+
+Protocol
+--------
+COMMAND:
+    Inquiry     0x10    get key event with block
+    Instant     0x12    get key event
+    Model       0x14    get model number(M0110 responds with 0x09)
+                        bit 7   1 if another device connected(used when keypad exists?)
+                        bit4-6  next device model number
+                        bit1-3  keyboard model number
+                        bit 0   always 1
+    Test        0x16    test(ACK:0x7D/NAK:0x77)
+
+KEY EVENT:
+    bit 7       key state(0:press 1:release)
+    bit 6-1     scan code(see below)
+    bit 0       always 1
+    To get scan code use this: ((bits&(1<<7)) | ((bits&0x7F))>>1).
+
+    Note: On the M0110A, Keypad keys and Arrow keys are preceded by 0x79.
+          Moreover, some Keypad keys(=, /, * and +) are preceded by 0x71 on press and 0xF1 on release.
+
+ARROW KEYS:
+    Arrow keys and Calc keys(+,*,/,= on keypad) share same byte sequence and preceding byte of
+    Calc keys(0x71 and 0xF1) means press and release event of SHIFT. This causes a very confusing situation,
+    it is difficult or impossible to tell Calc key from Arrow key plus SHIFT in some cases.
+
+    Raw key events:
+            press               release
+            ----------------    ----------------
+    Left:         0x79, 0x0D          0x79, 0x8D
+    Right:        0x79, 0x05          0x79, 0x85
+    Up:           0x79, 0x1B          0x79, 0x9B
+    Down:         0x79, 0x11          0x79, 0x91
+    Pad+:   0x71, 0x79, 0x0D    0xF1, 0x79, 0x8D
+    Pad*:   0x71, 0x79, 0x05    0xF1, 0x79, 0x85
+    Pad/:   0x71, 0x79, 0x1B    0xF1, 0x79, 0x9B
+    Pad=:   0x71, 0x79, 0x11    0xF1, 0x79, 0x91
+
+
+RAW CODE:
+    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|  .|   |
+    `---------------------------------------------------------' `---------------'
+    ,---------------------------------------------------------. ,---------------.
+    | 65| 25| 27| 29| 2B| 2F| 2D| 35| 39| 33| 3B| 37| 31|   67| |+0F|*11|*1B|*05|
+    |---------------------------------------------------------| |---------------|
+    |   61| 19| 1B| 1D| 1F| 23| 21| 41| 45| 3F| 47| 43| 3D|   | |+33|+37|+39|+1D|
+    |-----------------------------------------------------'   | |---------------|
+    |    73| 01| 03| 05| 07| 0B| 09| 4D| 51| 4B| 53| 4F|    49| |+2D|+2F|+31|*0D|
+    |---------------------------------------------------------| |---------------|
+    |      71| 0D| 0F| 11| 13| 17| 5B| 5D| 27| 5F| 59|  71|+1B| |+27|+29|+2B|   |
+    |---------------------------------------------------------' |-----------|+19|
+    |   75|     6F|            63             | 55|+0D|+05|+11| |    +25|+03|   |
+    `---------------------------------------------------------' `---------------'
+    + 0x79, 0xDD / 0xF1, 0xUU
+    * 0x71, 0x79,DD / 0xF1, 0x79, 0xUU
+
+
+MODEL NUMBER:
+    M0110:           0x09  00001001 : model number 4 (100)
+    M0110A:          0x0B  00001011 : model number 5 (101)
+    M0110 & M0120:   ???
+
+
+Scan Code
+---------
+    m0110_recv_key() function returns following scan codes instead of raw key events.
+    Scan codes are 1 byte long and MSB(bit7) is set when key is released. 
+
+    M0110
+    ,---------------------------------------------------------.
+    |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backs|
+    |---------------------------------------------------------|
+    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|  \|
+    |---------------------------------------------------------|
+    |CapsLo|  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return|
+    |---------------------------------------------------------|
+    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  ,|  /|        |
+    `---------------------------------------------------------'
+         |Opt|Mac |         Space               |Enter|Opt|
+         `------------------------------------------------'
+    ,---------------------------------------------------------.
+    | 32| 12| 13| 14| 15| 17| 16| 1A| 1C| 19| 1D| 1B| 18|   33|
+    |---------------------------------------------------------|
+    |   30| 0C| 0D| 0E| 0F| 10| 11| 20| 22| 1F| 23| 21| 1E| 2A|
+    |---------------------------------------------------------|
+    |    39| 00| 01| 02| 03| 05| 04| 26| 28| 25| 29| 27|    24|
+    |---------------------------------------------------------|
+    |      38| 06| 07| 08| 09| 0B| 2D| 2E| 2B| 2F| 2C|      38|
+    `---------------------------------------------------------'
+         | 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
+*/

m0110.h

@@ -1,5 +1,5 @@
 /*
-Copyright 2011 Jun WAKO <wakojun@gmail.com>
+Copyright 2011,2012 Jun WAKO <wakojun@gmail.com>
 
 This software is licensed with a Modified BSD License.
 All of this is supposed to be Free Software, Open Source, DFSG-free,
@@ -54,23 +54,29 @@ POSSIBILITY OF SUCH DAMAGE.
 #   error "M0110 data port setting is required in config.h"
 #endif
 
-#define M0110_INQUIRY     0x10
-#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
-
+/* Commands */
+#define M0110_INQUIRY       0x10
+#define M0110_INSTANT       0x14
+#define M0110_MODEL         0x16
+#define M0110_TEST          0x36
+
+/* Response(raw byte from M0110) */
+#define M0110_NULL          0x7B
+#define M0110_KEYPAD        0x79
+#define M0110_TEST_ACK      0x7D
+#define M0110_TEST_NAK      0x77
+#define M0110_SHIFT         0x71
+#define M0110_ARROW_UP      0x1B
+#define M0110_ARROW_DOWN    0x11
+#define M0110_ARROW_LEFT    0x0D
+#define M0110_ARROW_RIGHT   0x05
+
+/* This inidcates no response. */
+#define M0110_ERROR         0xFF
 
 /* 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))
+#define M0110_CALC_OFFSET   0x60
 
 
 extern uint8_t m0110_error;
@@ -80,5 +86,7 @@ void m0110_init(void);
 uint8_t m0110_send(uint8_t data);
 uint8_t m0110_recv(void);
 uint8_t m0110_recv_key(void);
+uint8_t m0110_inquiry(void);
+uint8_t m0110_instant(void);
 
 #endif

m0110_usb/README

@@ -1,55 +0,0 @@
-M0110 to USB keyboard converter
-===============================
-This firmware converts the protocol of Apple Macintosh keyboard M0110 into USB.
-
-
-Connection
-----------
-You need 4P4C plug and cable to connect Teensy into M0110.
-Teensy port F0 is assigned for CLOCK line and F1 for DATA by default, you can change pin configuration with editing config.h..
-
-Plug:
-    http://en.wikipedia.org/wiki/Modular_connector#4P4C
-
-Pinout:
-    http://www.kbdbabel.org/conn/kbd_connector_macplus.png
-    1(Black):   GND
-    2(Red):     CLOCK
-    3(Green):   DATA
-    4(Yellow):  +5V
-
-
-
-Build Frimware
---------------
-Optionally edit Makefile and config.h for build options, pin configuration or MCU.
-
-$ cd m0110_usb
-$ make
-and program your Teensy with loader.
-
-
-
-Keymap
-------
-You can change a keymap by editing code of keymap.c like following.
-How to define the keymap is probably obvious. You can find  key symbols in usb_keycodes.h.
-
-This is a default keymap for M0110.
-,---------------------------------------------------------.
-|  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Bacpa|
-|---------------------------------------------------------|
-|Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|  \|
-|---------------------------------------------------------|
-|CapsLo|  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return|
-|---------------------------------------------------------|
-|Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  ,|  /|Shift   |
-`---------------------------------------------------------'
-     |Opt|Alt |         Space               |Alt |Opt|
-     `-----------------------------------------------'
-
-
-Notes
------
-
-EOF

m0110_usb/README.md

@@ -0,0 +1,126 @@
+M0110/M0110A to USB keyboard converter
+======================================
+This firmware converts the protocol of Apple Macintosh keyboard M0110/M0110A into USB.
+Target board of this project is [PJRC Teensy](http://www.pjrc.com/teensy/), though,
+you can use other board with USB AVR like `ATmega32U4` and `AT90USB`.
+
+![M0110](https://github.com/tmk/tmk_keyboard/raw/master/m0110_usb/doc/m0110.jpg)
+
+M0110A support was contributed by [skagon@github](https://github.com/skagon).
+
+
+
+Connection
+----------
+You need 4P4C plug and cable to connect Teensy or other AVR dev board into the keyboard.
+Teensy port `PF0` is assigned for `CLOCK` line and `PF1` for `DATA` by default,
+you can change pin configuration with editing *config.h*.
+
+You can find 4P4C plugs on telephone handset cable. Note that it is *crossover* connection
+while Macintosh keyboard cable is *straight*.
+
+[![Conection](http://i.imgur.com/vJoVOm.jpg)](http://i.imgur.com/vJoVO.jpg)
+
+In this pic:
+
+1. `GND`(Black)
+2. `CLOCK`(Red)
+3. `DATA`(Green)
+4. `+5V`(Yellow)
+
+Not that wire colors may vary in your cable.
+
+
+### Pinout
+- <http://pinouts.ru/Inputs/MacKeyboard_pinout.shtml>
+- <http://en.wikipedia.org/wiki/Modular_connector#4P4C>
+
+![Jack fig](http://www.kbdbabel.org/conn/kbd_connector_macplus.png)
+
+
+### Pull-up Registor
+You may need pull-up registors on signal lines(`CLOCK`, `DATA`) in particular
+when you have long or coiled cable. 1k-10k Ohm will be OK for this purpose.
+In some cases MCU can't read signal from keyboard correctly without pull-up resistors.
+
+
+
+Building Frimware
+-----------------
+To compile firmware you need AVR GCC. You can use [WinAVR](http://winavr.sourceforge.net/) on Windows.
+You can edit *Makefile* and *config.h* to change compile options and pin configuration.
+
+    $ git clone ... (or download source)
+    $ cd m0110_usb
+    $ make
+
+and program your Teensy with [PJRC Teensy loader](http://www.pjrc.com/teensy/loader.html).
+
+
+
+Keymap
+------
+You can change keymaps by editing *keymap.c*.
+
+### M0110
+#### *Default*
+    ,---------------------------------------------------------.
+    |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backs|
+    |---------------------------------------------------------|
+    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|  \|
+    |---------------------------------------------------------|
+    |Fn0   |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return|
+    |---------------------------------------------------------|
+    |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  ,|  /|Shift   |
+    `---------------------------------------------------------'
+         |Ctr|Alt |         Space               |Gui |Ctr|
+         `-----------------------------------------------'
+    You can register Esc by hitting(press&release) Fn0 quickly.
+
+#### *HHKB/WASD cursor Layer(Fn0)*
+    ,---------------------------------------------------------.
+    |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delet|
+    |---------------------------------------------------------|
+    |Caps |Hom| Up|PgU|   |   |   |   |Psc|Slk|Pau|Up |Ins|  \|
+    |---------------------------------------------------------|
+    |Fn0   |Lef|Dow|Rig|   |   |   |   |Hom|PgU|Lef|Rig|Return|
+    |---------------------------------------------------------|
+    |Shift   |End|   |PgD|   |VoD|VoU|Mut|End|PgD|Dow|Shift   |
+    `---------------------------------------------------------'
+         |Ctr|Alt |         Space               |Gui |Ctr|
+         `-----------------------------------------------'
+
+### M0110A
+#### *Default*
+    ,---------------------------------------------------------. ,---------------.
+    |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backs| |Gui|  =|  /|  *|
+    |---------------------------------------------------------| |---------------|
+    |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|   | |  7|  8|  9|  -|
+    |-----------------------------------------------------'   | |---------------|
+    |Fn0   |  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|
+    |Ctrl |Alt    |         Space             |  \|Lft|Rgt|Dn | |      0|  .|   |
+    `---------------------------------------------------------' `---------------'
+#### *HHKB/WASD cursor Layer(Fn0)*
+    ,---------------------------------------------------------. ,---------------.
+    |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delet| |Nlk|Mb1|Mb3|Mb2|
+    |---------------------------------------------------------| |---------------|
+    |Caps |Hom| Up|PgU|   |   |   |   |Psc|Slk|Pau|Up |Ins|   | |MwD|McU|MwU|MwU|
+    |-----------------------------------------------------'   | |---------------|
+    |Fn0   |Lef|Dow|Rig|   |   |   |   |Hom|PgU|Lef|Rig|Return| |McL|McD|McR|MwD|
+    |---------------------------------------------------------| |---------------|
+    |Shift   |End|   |PgD|   |VoD|VoU|Mut|End|PgD|Dow|Shif|Up | |MwL|McD|MwR|   |
+    |---------------------------------------------------------| |-----------|Mb2|
+    |Ctrl |Alt    |         Space        |Gui |  \|Lft|Rgt|Dn | |    Mb1|Mb3|   |
+    `---------------------------------------------------------' `---------------'
+
+
+
+Debug
+-----
+You can use [PJRC HID listen](http://www.pjrc.com/teensy/hid_listen.html) to see debug output.
+
+The converter has some functions for debug, press `Alt+Gui+H` simultaneously to get help.
+These function is totally undocumented, tentative, inconsistent and buggy.

m0110_usb/config.h

@@ -1,5 +1,5 @@
 /*
-Copyright 2011 Jun Wako <wakojun@gmail.com>
+Copyright 2011,2012 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
@@ -30,7 +30,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
 /* matrix size */
-#define MATRIX_ROWS 8
+#define MATRIX_ROWS 14
 #define MATRIX_COLS 8
 
 /* Locking Caps Lock support */
@@ -38,8 +38,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 /* key combination for command */
 #define IS_COMMAND() ( \
-    keyboard_report->mods == (MOD_BIT(KB_LSHIFT) | MOD_BIT(KB_LCTRL) | MOD_BIT(KB_LALT) | MOD_BIT(KB_LGUI)) || \
-    keyboard_report->mods == (MOD_BIT(KB_LSHIFT) | MOD_BIT(KB_RSHIFT)) \
+    keyboard_report->mods == (MOD_BIT(KB_LALT) | MOD_BIT(KB_LGUI)) \
 )
 
 

m0110_usb/matrix.c

@@ -1,5 +1,5 @@
 /*
-Copyright 2011 Jun Wako <wakojun@gmail.com>
+Copyright 2011,2012 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
@@ -32,7 +32,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
 #define CAPS        0x39
-#define CAPS_UP     (CAPS | 0x80)
+#define CAPS_BREAK  (CAPS | 0x80)
 #define ROW(key)    ((key)>>3&0x0F)
 #define COL(key)    ((key)&0x07)
 
@@ -43,9 +43,6 @@ static bool is_modified = false;
 static uint8_t *matrix;
 static uint8_t _matrix0[MATRIX_ROWS];
 
-#ifdef MATRIX_HAS_GHOST
-static bool matrix_has_ghost_in_row(uint8_t row);
-#endif
 static void register_key(uint8_t key);
 
 
@@ -88,11 +85,13 @@ uint8_t matrix_scan(void)
     // Send Caps key up event
     if (matrix_is_on(ROW(CAPS), COL(CAPS))) {
         is_modified = true;
-        register_key(CAPS_UP);
+        register_key(CAPS_BREAK);
     }
 #endif
     if (key == M0110_NULL) {
         return 0;
+    } else if (key == M0110_ERROR) {
+        return 0;
     } else {
 #ifdef MATRIX_HAS_LOCKING_CAPS    
         if (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) {
@@ -100,11 +99,11 @@ uint8_t matrix_scan(void)
             // Ignore LockingCaps key down event
             if (key == CAPS) return 0;
             // Convert LockingCaps key up event into down event
-            if (key == CAPS_UP) key = CAPS;
+            if (key == CAPS_BREAK) key = CAPS;
         } else {
             // CAPS LOCK off:
             // Ignore LockingCaps key up event
-            if (key == CAPS_UP) return 0;
+            if (key == CAPS_BREAK) return 0;
         }
 #endif        
         is_modified = true;
@@ -112,7 +111,7 @@ uint8_t matrix_scan(void)
     }
 
     if (debug_enable) {
-        print("key: "); phex(key); print("\n");
+        print("["); phex(key); print("]\n");
     }
     return 1;
 }
@@ -125,12 +124,6 @@ bool matrix_is_modified(void)
 inline
 bool matrix_has_ghost(void)
 {
-#ifdef MATRIX_HAS_GHOST
-    for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
-        if (matrix_has_ghost_in_row(i))
-            return true;
-    }
-#endif
     return false;
 }
 
@@ -165,23 +158,6 @@ uint8_t matrix_key_count(void)
     return count;
 }
 
-#ifdef MATRIX_HAS_GHOST
-inline
-static bool matrix_has_ghost_in_row(uint8_t row)
-{
-    // no ghost exists in case less than 2 keys on
-    if (((matrix[row] - 1) & matrix[row]) == 0)
-        return false;
-
-    // ghost exists in case same state as other row
-    for (uint8_t i=0; i < MATRIX_ROWS; i++) {
-        if (i != row && (matrix[i] & matrix[row]) == matrix[row])
-            return true;
-    }
-    return false;
-}
-#endif
-
 inline
 static void register_key(uint8_t key)
 {

rules.mk

@@ -230,6 +230,8 @@ LDFLAGS += $(EXTMEMOPTS)
 LDFLAGS += $(patsubst %,-L%,$(EXTRALIBDIRS))
 LDFLAGS += $(PRINTF_LIB) $(SCANF_LIB) $(MATH_LIB)
 #LDFLAGS += -T linker_script.x
+# You can give EXTRALDFLAGS at 'make' command line.
+LDFLAGS += $(EXTRALDFLAGS)
 
 
 
@@ -315,9 +317,10 @@ GENDEPFLAGS = -MMD -MP -MF .dep/$(@F).d
 
 # Combine all necessary flags and optional flags.
 # Add target processor to flags.
-ALL_CFLAGS = -mmcu=$(MCU) -I. $(CFLAGS) $(GENDEPFLAGS)
-ALL_CPPFLAGS = -mmcu=$(MCU) -I. -x c++ $(CPPFLAGS) $(GENDEPFLAGS)
-ALL_ASFLAGS = -mmcu=$(MCU) -I. -x assembler-with-cpp $(ASFLAGS)
+# You can give extra flags at 'make' command line like: make EXTRAFLAGS=-DFOO=bar
+ALL_CFLAGS = -mmcu=$(MCU) -I. $(CFLAGS) $(GENDEPFLAGS) $(EXTRAFLAGS)
+ALL_CPPFLAGS = -mmcu=$(MCU) -I. -x c++ $(CPPFLAGS) $(GENDEPFLAGS) $(EXTRAFLAGS)
+ALL_ASFLAGS = -mmcu=$(MCU) -I. -x assembler-with-cpp $(ASFLAGS) $(EXTRAFLAGS)