2 Copyright 2011 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/>.
24 #include <util/delay.h>
38 static bool has_media_keys = false;
39 static bool is_iso_layout = false;
42 #define dmprintf(fmt, ...) do { if (debug_mouse) xprintf(fmt, ##__VA_ARGS__); } while (0)
43 static uint16_t mouse_cpi = 100;
44 static void mouse_init(uint8_t addr);
47 // matrix state buffer(1:on, 0:off)
48 static matrix_row_t matrix[MATRIX_ROWS];
50 static void register_key(uint8_t key);
52 static void device_scan(void)
55 for (uint8_t addr = 0; addr < 16; addr++) {
56 uint16_t reg3 = adb_host_talk(addr, ADB_REG_3);
58 xprintf(" addr:%d, reg3:%04X\n", addr, reg3);
64 void matrix_init(void)
67 //debug_matrix = true;
68 //debug_keyboard = true;
72 DDRD |= (1<<6); PORTD |= (1<<6);
75 // wait for keyboard to boot up and receive command
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);
88 case 0x04: case 0x05: case 0x07: case 0x09: case 0x0D:
89 case 0x11: case 0x14: case 0x19: case 0x1D: case 0xC1:
94 is_iso_layout = false;
97 xprintf("hadler: %02X, ISO: %s\n", handler_id, (is_iso_layout ? "yes" : "no"));
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");
105 // Enable keyboard left/right modifier distinction
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);
115 // https://developer.apple.com/library/archive/technotes/hw/hw_01.html#Extended
116 #ifdef ADB_MOUSE_ENABLE
117 xprintf("\nMouse:\n");
119 // Check device on addr3
120 mouse_init(ADB_ADDR_MOUSE);
125 // initialize matrix state: all keys off
126 for (uint8_t i=0; i < MATRIX_ROWS; i++) matrix[i] = 0x00;
128 led_set(host_keyboard_leds());
131 DDRD |= (1<<6); PORTD &= ~(1<<6);
135 #ifdef ADB_MOUSE_ENABLE
136 static void mouse_init(uint8_t orig_addr)
139 uint8_t mouse_handler;
143 // Some old mouses seems to need wait between commands.
145 mouse_handler = (reg3 = adb_host_talk(orig_addr, ADB_REG_3)) & 0xFF;
147 dmprintf("addr%d reg3: %02X\n", orig_addr, reg3);
149 // Move device to tmp address
151 adb_host_flush(orig_addr);
153 adb_host_listen(orig_addr, ADB_REG_3, ((reg3 >> 8) & 0xF0) | ADB_ADDR_TMP, 0xFE);
154 adb_host_flush(ADB_ADDR_TMP);
157 mouse_handler = (reg3 = adb_host_talk(ADB_ADDR_TMP, ADB_REG_3)) & 0xFF;
159 dmprintf("move fail\n");
163 dmprintf("addr%d reg3: %02X\n", addr, reg3);
167 if (mouse_handler == ADB_HANDLER_CLASSIC1_MOUSE || mouse_handler == ADB_HANDLER_CLASSIC2_MOUSE) {
169 adb_host_flush(addr);
170 adb_host_listen(addr, ADB_REG_3, (reg3 >> 8), ADB_HANDLER_EXTENDED_MOUSE);
173 mouse_handler = (reg3 = adb_host_talk(addr, ADB_REG_3)) & 0xFF;
176 if (mouse_handler == ADB_HANDLER_CLASSIC1_MOUSE) {
178 adb_host_flush(addr);
179 adb_host_listen(addr, ADB_REG_3, (reg3 >> 8), ADB_HANDLER_CLASSIC2_MOUSE);
182 mouse_handler = (reg3 = adb_host_talk(addr, ADB_REG_3)) & 0xFF;
185 if (mouse_handler == ADB_HANDLER_CLASSIC1_MOUSE) {
186 xprintf("Classic 100cpi\n");
189 if (mouse_handler == ADB_HANDLER_CLASSIC2_MOUSE) {
190 xprintf("Classic 200cpi\n");
195 // Extended Mouse Protocol
196 if (mouse_handler == ADB_HANDLER_EXTENDED_MOUSE) {
197 // Device info format(reg1 8-byte data)
199 // 4-5: resolution in units/inch (0xC8=200upi)
200 // 6 : device class (0: Tablet, 1: Mouse, 2: Trackball)
201 // 7 : num of buttons
205 len = adb_host_talk_buf(addr, ADB_REG_1, buf, sizeof(buf));
208 mouse_cpi = (buf[4]<<8) | buf[5];
214 xprintf("Ext: [", len);
215 for (int8_t i = 0; i < len; i++) xprintf("%02X ", buf[i]);
216 xprintf("] cpi=%d\n", mouse_cpi);
220 // Kensington Turbo Mouse 5: default device
221 if (buf[0] == 0x4B && buf[1] == 0x4D && buf[2] == 0x4C && buf[3] == 0x31) {
222 xprintf("TM5: default\n");
223 // Move it to addr0 to remove this device and get new device with handle id 50 on addr 3
224 // and the new device on address 3 should be handled with command sequence later.
226 // Turbo Mouse 5 has one default device on addr3 as normal mouse at first, and another device
227 // with hander id 50 appears after the default device is moved from addr3.
228 // The mouse has the two devices at same time transiently in the result. The default device is
229 // removed automatically after the another device receives command sequence.
230 // NOTE: The mouse hangs if you try moving the two deivces to same address.
231 adb_host_flush(addr);
232 adb_host_listen(addr, ADB_REG_3, ((reg3 >> 8) & 0xF0) | ADB_ADDR_0, 0xFE);
234 xprintf("Unknown\n");
238 if (mouse_handler == ADB_HANDLER_TURBO_MOUSE) {
239 xprintf("TM5: ext\n");
241 // Kensington Turbo Mouse 5 command sequence to enable four buttons
242 // https://elixir.bootlin.com/linux/v4.4/source/drivers/macintosh/adbhid.c#L1176
243 // https://github.com/NetBSD/src/blob/64b8a48e1288eb3902ed73113d157af50b2ec596/sys/arch/macppc/dev/ams.c#L261
244 static uint8_t cmd1[] = { 0xE7, 0x8C, 0x00, 0x00, 0x00, 0xFF, 0xFF, 0x94 };
245 static uint8_t cmd2[] = { 0xA5, 0x14, 0x00, 0x00, 0x69, 0xFF, 0xFF, 0x27 };
248 adb_host_flush(addr);
249 adb_host_listen_buf(addr, ADB_REG_2, cmd1, sizeof(cmd1));
250 adb_host_flush(addr);
251 adb_host_listen_buf(addr, ADB_REG_2, cmd2, sizeof(cmd2));
255 // Move all mouses to a address after init to be polled
257 adb_host_flush(addr);
258 adb_host_listen(addr, ADB_REG_3, ((reg3 >> 8) & 0xF0) | ADB_ADDR_MOUSE_POLL, 0xFE);
259 adb_host_flush(ADB_ADDR_MOUSE_POLL);
262 mouse_handler = (reg3 = adb_host_talk(addr, ADB_REG_3)) & 0xFF;
264 dmprintf("detect again\n");
270 // dmprintf("handler: %d\n", mouse_handler);
271 // dmprintf("cpi: %d\n", mouse_cpi);
277 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
279 static report_mouse_t mouse_report = {};
281 void adb_mouse_task(void)
286 static int8_t mouseacc;
288 /* tick of last polling */
289 static uint16_t tick_ms;
291 // polling with 12ms interval
292 if (timer_elapsed(tick_ms) < 12) return;
293 tick_ms = timer_read();
295 static uint16_t detect_ms;
296 if (timer_elapsed(detect_ms) > 1000) {
297 detect_ms = timer_read();
299 // check new device on addr3
300 mouse_init(ADB_ADDR_MOUSE);
303 // Extended Mouse Protocol data can be 2-5 bytes
304 // https://developer.apple.com/library/archive/technotes/hw/hw_01.html#Extended
306 // Byte 0: b00 y06 y05 y04 y03 y02 y01 y00
307 // Byte 1: b01 x06 x05 x04 x03 x02 x01 x00
308 // Byte 2: b02 y09 y08 y07 b03 x09 x08 x07
309 // Byte 3: b04 y12 y11 y10 b05 x12 x11 x10
310 // Byte 4: b06 y15 y14 y13 b07 x15 x14 x13
312 // b--: Button state.(0: on, 1: off)
313 // x--: X axis movement.
314 // y--: Y axis movement.
315 len = adb_host_talk_buf(ADB_ADDR_MOUSE_POLL, ADB_REG_0, buf, sizeof(buf));
317 // If nothing received reset mouse acceleration, and quit.
323 // Store off-buttons and 0-movements in unused bytes
327 if (buf[0] & 0x40) yneg = true;
328 if (buf[1] & 0x40) xneg = true;
330 if (buf[len - 1] & 0x40) yneg = true;
331 if (buf[len - 1] & 0x04) xneg = true;
334 for (int8_t i = len; i < sizeof(buf); i++) {
336 if (yneg) buf[i] |= 0x70;
337 if (xneg) buf[i] |= 0x07;
341 // TODO: Fix HID report descriptor for mouse to support button6-8
343 if (!(buf[4] & 0x08)) buttons |= MOUSE_BTN8;
344 if (!(buf[4] & 0x80)) buttons |= MOUSE_BTN7;
345 if (!(buf[3] & 0x08)) buttons |= MOUSE_BTN6;
346 if (!(buf[3] & 0x80)) buttons |= MOUSE_BTN5;
347 if (!(buf[2] & 0x08)) buttons |= MOUSE_BTN4;
348 if (!(buf[2] & 0x80)) buttons |= MOUSE_BTN3;
349 if (!(buf[1] & 0x80)) buttons |= MOUSE_BTN2;
350 if (!(buf[0] & 0x80)) buttons |= MOUSE_BTN1;
351 mouse_report.buttons = buttons;
354 yy = (buf[0] & 0x7F) | (buf[2] & 0x70) << 3 | (buf[3] & 0x70) << 6 | (buf[4] & 0x70) << 9;
355 xx = (buf[1] & 0x7F) | (buf[2] & 0x07) << 7 | (buf[3] & 0x07) << 10 | (buf[4] & 0x07) << 13;
357 // Accelerate mouse. (They weren't meant to be used on screens larger than 320x200).
361 // TODO: Fix HID report descriptor for mouse to support finer resolution
362 // Cap our two bytes per axis to one byte.
363 // Easier with a MIN-function, but since -MAX(-a,-b) = MIN(a,b)...
364 // I.E. MIN(MAX(x,-127),127) = -MAX(-MAX(x, -127), -127) = MIN(-MIN(-x,127),127)
365 mouse_report.x = -MAX(-MAX(x, -127), -127);
366 mouse_report.y = -MAX(-MAX(y, -127), -127);
370 for (int8_t i = 0; i < len; i++) xprintf("%02X ", buf[i]);
372 xprintf("[B:%02X, X:%d(%d), Y:%d(%d), A:%d]\n", mouse_report.buttons, mouse_report.x, xx, mouse_report.y, yy, mouseacc);
375 // Send result by usb.
376 host_mouse_send(&mouse_report);
378 // TODO: acceleration curve is needed for precise operation?
379 // increase acceleration of mouse
380 mouseacc += ( mouseacc < (mouse_cpi < 200 ? ADB_MOUSE_MAXACC : ADB_MOUSE_MAXACC/2) ? 1 : 0 );
386 uint8_t matrix_scan(void)
388 /* extra_key is volatile and more convoluted than necessary because gcc refused
389 to generate valid code otherwise. Making extra_key uint8_t and constructing codes
390 here via codes = extra_key<<8 | 0xFF; would consistently fail to even LOAD
391 extra_key from memory, and leave garbage in the high byte of codes. I tried
392 dozens of code variations and it kept generating broken assembly output. So
393 beware if attempting to make extra_key code more logical and efficient. */
394 static volatile uint16_t extra_key = 0xFFFF;
398 /* tick of last polling */
399 static uint16_t tick_ms;
404 if ( codes == 0xFFFF )
406 // polling with 12ms interval
407 if (timer_elapsed(tick_ms) < 12) return 0;
408 tick_ms = timer_read();
410 codes = adb_host_kbd_recv(ADB_ADDR_KEYBOARD);
412 // Adjustable keybaord media keys
413 if (codes == 0 && has_media_keys &&
414 (codes = adb_host_kbd_recv(ADB_ADDR_APPLIANCE))) {
416 switch (codes & 0x7f ) {
418 codes = (codes & ~0x007f) | 0x42;
421 codes = (codes & ~0x007f) | 0x4a;
423 case 0x02: // Volume down
424 codes = (codes & ~0x007f) | 0x49;
426 case 0x03: // Volume Up
427 codes = (codes & ~0x007f) | 0x48;
429 case 0x7F: // no code
432 xprintf("ERROR: media key1\n");
436 switch ((codes >> 8) & 0x7f ) {
438 codes = (codes & ~0x7f00) | (0x42 << 8);
441 codes = (codes & ~0x7f00) | (0x4a << 8);
443 case 0x02: // Volume down
444 codes = (codes & ~0x7f00) | (0x49 << 8);
446 case 0x03: // Volume Up
447 codes = (codes & ~0x7f00) | (0x48 << 8);
450 xprintf("ERROR: media key0\n");
458 if (debug_matrix && codes) {
459 print("adb_host_kbd_recv: "); phex16(codes); print("\n");
462 if (codes == 0) { // no keys
464 } else if (codes == 0x7F7F) { // power key press
466 } else if (codes == 0xFFFF) { // power key release
468 } else if (key0 == 0xFF) { // error
469 xprintf("adb_host_kbd_recv: ERROR(%d)\n", codes);
470 // something wrong or plug-in
474 /* Swap codes for ISO keyboard
475 * https://github.com/tmk/tmk_keyboard/issues/35
478 * ,----------- ----------.
479 * | *a| 1| 2 =|Backspa|
480 * |----------- ----------|
482 * |----------- ----------|
483 * |CapsLo| A| '|Return |
484 * |----------- ----------|
486 * `----------- ----------'
489 * ,----------- ----------.
490 * | *a| 1| 2 =|Backspa|
491 * |----------- ----------|
492 * |Tab | Q| | ]|Retur|
493 * |----------- -----` |
494 * |CapsLo| A| '| *c| |
495 * |----------- ----------|
497 * `----------- ----------'
499 * ADB scan code USB usage
500 * ------------- ---------
501 * Key ANSI ISO ANSI ISO
502 * ---------------------------------------------
503 * *a 0x32 0x0A 0x35 0x35
504 * *b ---- 0x32 ---- 0x64
505 * *c 0x2A 0x2A 0x31 0x31(or 0x32)
508 if ((key0 & 0x7F) == 0x32) {
509 key0 = (key0 & 0x80) | 0x0A;
510 } else if ((key0 & 0x7F) == 0x0A) {
511 key0 = (key0 & 0x80) | 0x32;
515 if (key1 != 0xFF) // key1 is 0xFF when no second key.
516 extra_key = key1<<8 | 0xFF; // process in a separate call
523 matrix_row_t matrix_get_row(uint8_t row)
529 static void register_key(uint8_t key)
535 matrix[row] &= ~(1<<col);
537 matrix[row] |= (1<<col);
541 void led_set(uint8_t usb_led)
543 adb_host_kbd_led(ADB_ADDR_KEYBOARD, ~usb_led);