converter/adb_usb/matrix.c

   1 /*
   2 Copyright 2011 Jun Wako <wakojun@gmail.com>
   3
   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.
   8
   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.
  13
  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/>.
  16 */
  17
  18 /*
  19  * scan matrix
  20  */
  21 #include <stdint.h>
  22 #include <stdbool.h>
  23 #include <avr/io.h>
  24 #include "print.h"
  25 #include "util.h"
  26 #include "debug.h"
  27 #include "adb.h"
  28 #include "matrix.h"
  29 #include "report.h"
  30 #include "host.h"
  31 #include "led.h"
  32 #include "timer.h"
  33 #include "wait.h"
  34
  35
  36
  37
  38 static bool has_media_keys = false;
  39 static bool is_iso_layout = false;
  40
  41 #if ADB_MOUSE_ENABLE
  42 #define dmprintf(fmt, ...)  do { /* if (debug_mouse) */ xprintf("M:" fmt, ##__VA_ARGS__); } while (0)
  43 static uint16_t mouse_cpi = 100;
  44 static void mouse_init(uint8_t addr);
  45 #endif
  46
  47 // matrix state buffer(1:on, 0:off)
  48 static matrix_row_t matrix[MATRIX_ROWS];
  49
  50 static void register_key(uint8_t key);
  51
  52 static void device_scan(void)
  53 {
  54     xprintf("\nScan:\n");
  55     for (uint8_t addr = 0; addr < 16; addr++) {
  56         uint16_t reg3 = adb_host_talk(addr, ADB_REG_3);
  57         if (reg3) {
  58             xprintf(" addr:%d, reg3:%04X\n", addr, reg3);
  59         }
  60     }
  61 }
  62
  63 void matrix_init(void)
  64 {
  65     debug_enable = true;
  66     //debug_matrix = true;
  67     //debug_keyboard = true;
  68     //debug_mouse = true;
  69
  70     // LED on
  71     DDRD |= (1<<6); PORTD |= (1<<6);
  72
  73     adb_host_init();
  74
  75     // wait for line and device to be stable
  76     wait_ms(100);
  77
  78     device_scan();
  79
  80     //
  81     // Keyboard
  82     //
  83     xprintf("\nKeyboard:\n");
  84     // Determine ISO keyboard by handler id
  85     // http://lxr.free-electrons.com/source/drivers/macintosh/adbhid.c?v=4.4#L815
  86     uint8_t handler_id = (uint8_t) adb_host_talk(ADB_ADDR_KEYBOARD, ADB_REG_3);
  87     switch (handler_id) {
  88     case 0x04: case 0x05: case 0x07: case 0x09: case 0x0D:
  89     case 0x11: case 0x14: case 0x19: case 0x1D: case 0xC1:
  90     case 0xC4: case 0xC7:
  91         is_iso_layout = true;
  92         break;
  93     default:
  94         is_iso_layout = false;
  95         break;
  96     }
  97     xprintf("hadler: %02X, ISO: %s\n", handler_id, (is_iso_layout ? "yes" : "no"));
  98
  99     // Adjustable keyboard media keys: address=0x07 and handlerID=0x02
 100     has_media_keys = (0x02 == (adb_host_talk(ADB_ADDR_APPLIANCE, ADB_REG_3) & 0xff));
 101     if (has_media_keys) {
 102         xprintf("Media keys\n");
 103     }
 104
 105     // Enable keyboard left/right modifier distinction
 106     // Listen Register3
 107     //  upper byte: reserved bits 0000, keyboard address 0010
 108     //  lower byte: device handler 00000011
 109     adb_host_listen(ADB_ADDR_KEYBOARD, ADB_REG_3, ADB_ADDR_KEYBOARD, ADB_HANDLER_EXTENDED_KEYBOARD);
 110
 111     // initialize matrix state: all keys off
 112     for (uint8_t i=0; i < MATRIX_ROWS; i++) matrix[i] = 0x00;
 113
 114     led_set(host_keyboard_leds());
 115
 116     // LED off
 117     DDRD |= (1<<6); PORTD &= ~(1<<6);
 118     return;
 119 }
 120
 121 #ifdef ADB_MOUSE_ENABLE
 122 static void mouse_init(uint8_t orig_addr)
 123 {
 124     uint16_t reg3;
 125     uint8_t mouse_handler;
 126     uint8_t addr;
 127
 128 again:
 129     // Move to tmp address 15 to setup mouse function
 130     mouse_handler = (reg3  = adb_host_talk(orig_addr, ADB_REG_3)) & 0xFF;
 131     if (!reg3) return;
 132     dmprintf("addr%d reg3: %04X\n", orig_addr, reg3);
 133
 134     // Move device to tmp address
 135     adb_host_flush(orig_addr);
 136     adb_host_listen(orig_addr, ADB_REG_3, ((reg3 >> 8) & 0xF0) | ADB_ADDR_TMP, 0xFE);
 137     adb_host_flush(ADB_ADDR_TMP);
 138
 139     mouse_handler = (reg3  = adb_host_talk(ADB_ADDR_TMP, ADB_REG_3)) & 0xFF;
 140     if (!reg3) {
 141         dmprintf("move fail\n");
 142         goto again;
 143     }
 144     addr = ADB_ADDR_TMP;
 145
 146
 147 detect_again:
 148     // Try to escalate into extended/classic2 protocol
 149     if (mouse_handler == ADB_HANDLER_CLASSIC1_MOUSE || mouse_handler == ADB_HANDLER_CLASSIC2_MOUSE) {
 150         adb_host_flush(addr);
 151         adb_host_listen(addr, ADB_REG_3, (reg3 >> 8), ADB_HANDLER_EXTENDED_MOUSE);
 152
 153         mouse_handler = (reg3  = adb_host_talk(addr, ADB_REG_3)) & 0xFF;
 154
 155
 156         if (mouse_handler == ADB_HANDLER_CLASSIC1_MOUSE) {
 157             adb_host_flush(addr);
 158             adb_host_listen(addr, ADB_REG_3, (reg3 >> 8), ADB_HANDLER_CLASSIC2_MOUSE);
 159
 160             mouse_handler = (reg3  = adb_host_talk(addr, ADB_REG_3)) & 0xFF;
 161         }
 162         dmprintf("addr%d reg3: %04X\n", addr, reg3);
 163
 164     }
 165
 166     // Classic Protocol 100cpi
 167     if (mouse_handler == ADB_HANDLER_CLASSIC1_MOUSE) {
 168         xprintf("Classic 100cpi\n");
 169         mouse_cpi = 100;
 170     }
 171
 172     // Classic Protocol 200cpi
 173     if (mouse_handler == ADB_HANDLER_CLASSIC2_MOUSE) {
 174         xprintf("Classic 200cpi\n");
 175         mouse_cpi = 200;
 176     }
 177
 178     // Extended Mouse Protocol
 179     if (mouse_handler == ADB_HANDLER_EXTENDED_MOUSE) {
 180         // Device info format(reg1 8-byte data)
 181         // 0-3: device id
 182         // 4-5: resolution in units/inch (0xC8=200upi)
 183         // 6  : device class      (0: Tablet, 1: Mouse, 2: Trackball)
 184         // 7  : num of buttons
 185         uint8_t len;
 186         uint8_t buf[8];
 187         len = adb_host_talk_buf(addr, ADB_REG_1, buf, sizeof(buf));
 188
 189         if (len > 5) {
 190             mouse_cpi = (buf[4]<<8) | buf[5];
 191         } else {
 192             mouse_cpi = 100;
 193         }
 194
 195         if (len) {
 196             xprintf("Ext: [", len);
 197             for (int8_t i = 0; i < len; i++) xprintf("%02X ", buf[i]);
 198             xprintf("] cpi=%d\n", mouse_cpi);
 199         }
 200
 201
 202         // Kensington Turbo Mouse 5: default device
 203         if (buf[0] == 0x4B && buf[1] == 0x4D && buf[2] == 0x4C && buf[3] == 0x31) {
 204             xprintf("TM5: default\n");
 205             // Move it to addr0 to remove this device and get new device with handle id 50 on addr 3
 206             // and the new device on address 3 should be handled with command sequence later.
 207             //
 208             // Turbo Mouse 5 has one default device on addr3 as normal mouse at first, and another device
 209             // with hander id 50 appears after the default device is moved from addr3.
 210             // The mouse has the two devices at same time transiently in the result. The default device is
 211             // removed automatically after the another device receives command sequence.
 212             // NOTE: The mouse hangs if you try moving the two deivces to same address.
 213             adb_host_flush(addr);
 214             adb_host_listen(addr, ADB_REG_3, ((reg3 >> 8) & 0xF0) | ADB_ADDR_0, 0xFE);
 215         } else {
 216             xprintf("Unknown\n");
 217         }
 218     }
 219
 220     // Kensington Turbo Mouse 5: setup
 221     if (mouse_handler == ADB_HANDLER_TURBO_MOUSE) {
 222         xprintf("TM5: ext\n");
 223
 224         // Kensington Turbo Mouse 5 command sequence to enable four buttons
 225         // https://elixir.bootlin.com/linux/v4.4/source/drivers/macintosh/adbhid.c#L1176
 226         // https://github.com/NetBSD/src/blob/64b8a48e1288eb3902ed73113d157af50b2ec596/sys/arch/macppc/dev/ams.c#L261
 227         static uint8_t cmd1[] = { 0xE7, 0x8C, 0x00, 0x00, 0x00, 0xFF, 0xFF, 0x94 };
 228         static uint8_t cmd2[] = { 0xA5, 0x14, 0x00, 0x00, 0x69, 0xFF, 0xFF, 0x27 };
 229
 230         adb_host_flush(addr);
 231         adb_host_listen_buf(addr, ADB_REG_2, cmd1, sizeof(cmd1));
 232         adb_host_flush(addr);
 233         adb_host_listen_buf(addr, ADB_REG_2, cmd2, sizeof(cmd2));
 234     }
 235
 236
 237     // Move to address 10 for mouse polling
 238     adb_host_flush(addr);
 239     adb_host_listen(addr, ADB_REG_3, ((reg3 >> 8) & 0xF0) | ADB_ADDR_MOUSE_POLL, 0xFE);
 240     adb_host_flush(ADB_ADDR_MOUSE_POLL);
 241
 242     mouse_handler = (reg3  = adb_host_talk(addr, ADB_REG_3)) & 0xFF;
 243     if (reg3) {
 244         dmprintf("detect again\n");
 245         goto detect_again;
 246     }
 247
 248     goto again;
 249 }
 250
 251 #ifdef MAX
 252 #undef MAX
 253 #endif
 254 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
 255
 256 static report_mouse_t mouse_report = {};
 257
 258 void adb_mouse_task(void)
 259 {
 260     uint8_t len;
 261     uint8_t buf[5];
 262     int16_t x, y;
 263     static int8_t mouseacc;
 264
 265     /* tick of last polling */
 266     static uint16_t tick_ms;
 267
 268     // polling with 12ms interval
 269     if (timer_elapsed(tick_ms) < 12) return;
 270     tick_ms = timer_read();
 271
 272     static uint16_t detect_ms;
 273     if (timer_elapsed(detect_ms) > 1000) {
 274         detect_ms = timer_read();
 275         // check new device on addr3
 276         mouse_init(ADB_ADDR_MOUSE);
 277     }
 278
 279     // Extended Mouse Protocol data can be 2-5 bytes
 280     // https://developer.apple.com/library/archive/technotes/hw/hw_01.html#Extended
 281     //
 282     //   Byte 0: b00 y06 y05 y04 y03 y02 y01 y00
 283     //   Byte 1: b01 x06 x05 x04 x03 x02 x01 x00
 284     //   Byte 2: b02 y09 y08 y07 b03 x09 x08 x07
 285     //   Byte 3: b04 y12 y11 y10 b05 x12 x11 x10
 286     //   Byte 4: b06 y15 y14 y13 b07 x15 x14 x13
 287     //
 288     //   b--: Button state.(0: on, 1: off)
 289     //   x--: X axis movement.
 290     //   y--: Y axis movement.
 291     len = adb_host_talk_buf(ADB_ADDR_MOUSE_POLL, ADB_REG_0, buf, sizeof(buf));
 292
 293     // If nothing received reset mouse acceleration, and quit.
 294     if (len < 2) {
 295         mouseacc = 1;
 296         return;
 297     };
 298     dmprintf("[%02X %02X %02X %02X %02X]\n", buf[0], buf[1], buf[2], buf[3], buf[4]);
 299
 300     // Store off-buttons and 0-movements in unused bytes
 301     bool xneg = false;
 302     bool yneg = false;
 303     if (len == 2) {
 304         if (buf[0] & 0x40) yneg = true;
 305         if (buf[1] & 0x40) xneg = true;
 306     } else {
 307         if (buf[len - 1] & 0x40) yneg = true;
 308         if (buf[len - 1] & 0x04) xneg = true;
 309     }
 310
 311     for (int8_t i = len; i < sizeof(buf); i++) {
 312         buf[i] = 0x88;
 313         if (yneg) buf[i] |= 0x70;
 314         if (xneg) buf[i] |= 0x07;
 315     }
 316
 317     // 8 buttons at max
 318     // TODO: Fix HID report descriptor for mouse to support button6-8
 319     uint8_t buttons = 0;
 320     if (!(buf[4] & 0x08)) buttons |= MOUSE_BTN8;
 321     if (!(buf[4] & 0x80)) buttons |= MOUSE_BTN7;
 322     if (!(buf[3] & 0x08)) buttons |= MOUSE_BTN6;
 323     if (!(buf[3] & 0x80)) buttons |= MOUSE_BTN5;
 324     if (!(buf[2] & 0x08)) buttons |= MOUSE_BTN4;
 325     if (!(buf[2] & 0x80)) buttons |= MOUSE_BTN3;
 326     if (!(buf[1] & 0x80)) buttons |= MOUSE_BTN2;
 327     if (!(buf[0] & 0x80)) buttons |= MOUSE_BTN1;
 328     mouse_report.buttons = buttons;
 329
 330     int16_t xx, yy;
 331     yy = (buf[0] & 0x7F) | (buf[2] & 0x70) << 3 | (buf[3] & 0x70) << 6 | (buf[4] & 0x70) << 9;
 332     xx = (buf[1] & 0x7F) | (buf[2] & 0x07) << 7 | (buf[3] & 0x07) << 10 | (buf[4] & 0x07) << 13;
 333
 334     // Accelerate mouse. (They weren't meant to be used on screens larger than 320x200).
 335     x = xx * mouseacc;
 336     y = yy * mouseacc;
 337
 338     // TODO: Fix HID report descriptor for mouse to support finer resolution
 339     // Cap our two bytes per axis to one byte.
 340     // Easier with a MIN-function, but since -MAX(-a,-b) = MIN(a,b)...
 341     // I.E. MIN(MAX(x,-127),127) = -MAX(-MAX(x, -127), -127) = MIN(-MIN(-x,127),127)
 342     mouse_report.x = -MAX(-MAX(x, -127), -127);
 343     mouse_report.y = -MAX(-MAX(y, -127), -127);
 344
 345     dmprintf("[B:%02X X:%d(%d) Y:%d(%d) A:%d]\n", mouse_report.buttons, mouse_report.x, xx, mouse_report.y, yy, mouseacc);
 346
 347     // Send result by usb.
 348     host_mouse_send(&mouse_report);
 349
 350     // TODO: acceleration curve is needed for precise operation?
 351     // increase acceleration of mouse
 352     mouseacc += ( mouseacc < (mouse_cpi < 200 ? ADB_MOUSE_MAXACC : ADB_MOUSE_MAXACC/2) ? 1 : 0 );
 353
 354     return;
 355 }
 356 #endif
 357
 358 uint8_t matrix_scan(void)
 359 {
 360     /* extra_key is volatile and more convoluted than necessary because gcc refused
 361     to generate valid code otherwise. Making extra_key uint8_t and constructing codes
 362     here via codes = extra_key<<8 | 0xFF; would consistently fail to even LOAD
 363     extra_key from memory, and leave garbage in the high byte of codes. I tried
 364     dozens of code variations and it kept generating broken assembly output. So
 365     beware if attempting to make extra_key code more logical and efficient. */
 366     static volatile uint16_t extra_key = 0xFFFF;
 367     uint16_t codes;
 368     uint8_t key0, key1;
 369
 370     /* tick of last polling */
 371     static uint16_t tick_ms;
 372
 373     codes = extra_key;
 374     extra_key = 0xFFFF;
 375
 376     if ( codes == 0xFFFF )
 377     {
 378         // polling with 12ms interval
 379         if (timer_elapsed(tick_ms) < 12) return 0;
 380         tick_ms = timer_read();
 381
 382         codes = adb_host_kbd_recv(ADB_ADDR_KEYBOARD);
 383
 384         // Adjustable keybaord media keys
 385         if (codes == 0 && has_media_keys &&
 386                 (codes = adb_host_kbd_recv(ADB_ADDR_APPLIANCE))) {
 387             // key1
 388             switch (codes & 0x7f ) {
 389             case 0x00:  // Mic
 390                 codes = (codes & ~0x007f) | 0x42;
 391                 break;
 392             case 0x01:  // Mute
 393                 codes = (codes & ~0x007f) | 0x4a;
 394                 break;
 395             case 0x02:  // Volume down
 396                 codes = (codes & ~0x007f) | 0x49;
 397                 break;
 398             case 0x03:  // Volume Up
 399                 codes = (codes & ~0x007f) | 0x48;
 400                 break;
 401             case 0x7F:  // no code
 402                 break;
 403             default:
 404                 xprintf("ERROR: media key1\n");
 405                 return 0x11;
 406             }
 407             // key0
 408             switch ((codes >> 8) & 0x7f ) {
 409             case 0x00:  // Mic
 410                 codes = (codes & ~0x7f00) | (0x42 << 8);
 411                 break;
 412             case 0x01:  // Mute
 413                 codes = (codes & ~0x7f00) | (0x4a << 8);
 414                 break;
 415             case 0x02:  // Volume down
 416                 codes = (codes & ~0x7f00) | (0x49 << 8);
 417                 break;
 418             case 0x03:  // Volume Up
 419                 codes = (codes & ~0x7f00) | (0x48 << 8);
 420                 break;
 421             default:
 422                 xprintf("ERROR: media key0\n");
 423                 return 0x10;
 424             }
 425         }
 426     }
 427     key0 = codes>>8;
 428     key1 = codes&0xFF;
 429
 430     if (debug_matrix && codes) {
 431         print("adb_host_kbd_recv: "); phex16(codes); print("\n");
 432     }
 433
 434     if (codes == 0) {                           // no keys
 435         return 0;
 436     } else if (codes == 0x7F7F) {   // power key press
 437         register_key(0x7F);
 438     } else if (codes == 0xFFFF) {   // power key release
 439         register_key(0xFF);
 440     } else {
 441         // Macally keyboard sends keys inversely against ADB protocol
 442         // https://deskthority.net/workshop-f7/macally-mk96-t20116.html
 443         if (key0 == 0xFF) {
 444             key0 = key1;
 445             key1 = 0xFF;
 446         }
 447
 448         /* Swap codes for ISO keyboard
 449          * https://github.com/tmk/tmk_keyboard/issues/35
 450          *
 451          * ANSI
 452          * ,-----------    ----------.
 453          * | *a|  1|  2     =|Backspa|
 454          * |-----------    ----------|
 455          * |Tab  |  Q|     |  ]|   *c|
 456          * |-----------    ----------|
 457          * |CapsLo|  A|    '|Return  |
 458          * |-----------    ----------|
 459          * |Shift   |      Shift     |
 460          * `-----------    ----------'
 461          *
 462          * ISO
 463          * ,-----------    ----------.
 464          * | *a|  1|  2     =|Backspa|
 465          * |-----------    ----------|
 466          * |Tab  |  Q|     |  ]|Retur|
 467          * |-----------    -----`    |
 468          * |CapsLo|  A|    '| *c|    |
 469          * |-----------    ----------|
 470          * |Shif| *b|      Shift     |
 471          * `-----------    ----------'
 472          *
 473          *         ADB scan code   USB usage
 474          *         -------------   ---------
 475          * Key     ANSI    ISO     ANSI    ISO
 476          * ---------------------------------------------
 477          * *a      0x32    0x0A    0x35    0x35
 478          * *b      ----    0x32    ----    0x64
 479          * *c      0x2A    0x2A    0x31    0x31(or 0x32)
 480          */
 481         if (is_iso_layout) {
 482             if ((key0 & 0x7F) == 0x32) {
 483                 key0 = (key0 & 0x80) | 0x0A;
 484             } else if ((key0 & 0x7F) == 0x0A) {
 485                 key0 = (key0 & 0x80) | 0x32;
 486             }
 487         }
 488         register_key(key0);
 489         if (key1 != 0xFF)       // key1 is 0xFF when no second key.
 490             extra_key = key1<<8 | 0xFF; // process in a separate call
 491     }
 492
 493     return 1;
 494 }
 495
 496 inline
 497 matrix_row_t matrix_get_row(uint8_t row)
 498 {
 499     return matrix[row];
 500 }
 501
 502 inline
 503 static void register_key(uint8_t key)
 504 {
 505     uint8_t col, row;
 506     col = key&0x07;
 507     row = (key>>3)&0x0F;
 508     if (key&0x80) {
 509         matrix[row] &= ~(1<<col);
 510     } else {
 511         matrix[row] |=  (1<<col);
 512     }
 513 }
 514
 515 void led_set(uint8_t usb_led)
 516 {
 517     adb_host_kbd_led(ADB_ADDR_KEYBOARD, ~usb_led);
 518 }