max/tmk_keyboard
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

core:adb_usb: Add Extended Mouse Protocol support #274

Browse source 
Also add Kensington Turbo Mouse 5 specific initialization
This commit is contained in:
tmk 2019-06-21 13:03:49 +09:00
parent 6df651203a
commit 814eaa2dff
4 changed files with 221 additions and 76 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

181
converter/adb_usb/matrix.c
View file

@ -37,6 +37,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
static bool has_media_keys = false; static bool has_media_keys = false;
static bool is_iso_layout = false; static bool is_iso_layout = false;
static uint8_t mouse_handler = ADB_HANDLER_CLASSIC1_MOUSE;
// matrix state buffer(1:on, 0:off) // matrix state buffer(1:on, 0:off)
static matrix_row_t matrix[MATRIX_ROWS]; static matrix_row_t matrix[MATRIX_ROWS];
@ -54,15 +55,20 @@ void matrix_init(void)
_delay_ms(2000); _delay_ms(2000);
// device scan // device scan
xprintf("Before init:\n"); xprintf("\nScan:\n");
for (uint8_t addr = 1; addr < 16; addr++) { for (uint8_t addr = 1; addr < 16; addr++) {
uint16_t reg3 = adb_host_talk(addr, ADB_REG_3); uint16_t reg3 = adb_host_talk(addr, ADB_REG_3);
if (reg3) { if (reg3) {
xprintf("Scan: addr:%d, reg3:%04X\n", addr, reg3); xprintf(" addr:%d, reg3:%04X\n", addr, reg3);
} }
_delay_ms(20); _delay_ms(20);
} }
//
// Keyboard
//
xprintf("\nKeyboard:\n");
// Determine ISO keyboard by handler id // Determine ISO keyboard by handler id
// http://lxr.free-electrons.com/source/drivers/macintosh/adbhid.c?v=4.4#L815 // http://lxr.free-electrons.com/source/drivers/macintosh/adbhid.c?v=4.4#L815
uint8_t handler_id = (uint8_t) adb_host_talk(ADB_ADDR_KEYBOARD, ADB_REG_3); uint8_t handler_id = (uint8_t) adb_host_talk(ADB_ADDR_KEYBOARD, ADB_REG_3);
@ -76,26 +82,88 @@ void matrix_init(void)
is_iso_layout = false; is_iso_layout = false;
break; break;
} }
xprintf("hadler_id: %02X, is_iso_layout: %s\n", handler_id, (is_iso_layout ? "yes" : "no")); xprintf("hadler: %02X, ISO: %s\n", handler_id, (is_iso_layout ? "yes" : "no"));
// Adjustable keyboard media keys: address=0x07 and handlerID=0x02 // Adjustable keyboard media keys: address=0x07 and handlerID=0x02
has_media_keys = (0x02 == (adb_host_talk(ADB_ADDR_APPLIANCE, ADB_REG_3) & 0xff)); has_media_keys = (0x02 == (adb_host_talk(ADB_ADDR_APPLIANCE, ADB_REG_3) & 0xff));
if (has_media_keys) { if (has_media_keys) {
xprintf("Found: media keys\n"); xprintf("Media keys\n");
} }
// Enable keyboard left/right modifier distinction // Enable keyboard left/right modifier distinction
// Listen Register3 // Listen Register3
// upper byte: reserved bits 0000, keyboard address 0010 // upper byte: reserved bits 0000, keyboard address 0010
// lower byte: device handler 00000011 // lower byte: device handler 00000011
adb_host_listen(ADB_ADDR_KEYBOARD, ADB_REG_3, ADB_ADDR_KEYBOARD, ADB_HANDLER_EXTENDED_PROTOCOL); adb_host_listen(ADB_ADDR_KEYBOARD, ADB_REG_3, ADB_ADDR_KEYBOARD, ADB_HANDLER_EXTENDED_KEYBOARD);
// device scan
xprintf("After init:\n"); #ifdef ADB_MOUSE_ENABLE
//
// Mouse
//
// https://developer.apple.com/library/archive/technotes/hw/hw_01.html#Extended
xprintf("\nMouse:\n");
// Some old mouses seems to need wait between commands.
_delay_ms(20);
adb_host_listen(ADB_ADDR_MOUSE, ADB_REG_3, ADB_ADDR_MOUSE, ADB_HANDLER_CLASSIC2_MOUSE);
_delay_ms(20);
adb_host_listen(ADB_ADDR_MOUSE, ADB_REG_3, ADB_ADDR_MOUSE, ADB_HANDLER_EXTENDED_MOUSE);
_delay_ms(20);
mouse_handler = adb_host_talk(ADB_ADDR_MOUSE, ADB_REG_3) & 0xff;
mouse_handler = mouse_handler ? mouse_handler : ADB_HANDLER_CLASSIC1_MOUSE;
// Extended Mouse Protocol
if (mouse_handler == ADB_HANDLER_EXTENDED_MOUSE) {
// Device info format(reg1 8-byte data)
// 0-3: device id
// 4-5: resolution in units/inch (0xC8=200upi)
// 6 : device class (0: Tablet, 1: Mouse, 2: Trackball)
// 7 : num of buttons
uint8_t len;
uint8_t buf[8];
len = adb_host_talk_buf(ADB_ADDR_MOUSE, ADB_REG_1, buf, sizeof(buf));
if (len) {
xprintf("Devinfo: [", len);
for (int8_t i = 0; i < len; i++) xprintf("%02X ", buf[i]);
xprintf("]\n");
}
// Kensington Turbo Mouse 5
if (len == 8 && buf[0] == 0x4B && buf[1] == 0x4D && buf[2] == 0x4C && buf[3] == 0x31) {
xprintf("Turbo Mouse 5\n");
// Turbo Mouse command sequence to enable four buttons
// https://elixir.bootlin.com/linux/v4.4/source/drivers/macintosh/adbhid.c#L1176
// https://github.com/NetBSD/src/blob/64b8a48e1288eb3902ed73113d157af50b2ec596/sys/arch/macppc/dev/ams.c#L261
static uint8_t cmd1[] = { 0xE7, 0x8C, 0x00, 0x00, 0x00, 0xFF, 0xFF, 0x94 };
static uint8_t cmd2[] = { 0xA5, 0x14, 0x00, 0x00, 0x69, 0xFF, 0xFF, 0x27 };
// configure with new address 9
adb_host_listen(ADB_ADDR_MOUSE, ADB_REG_3, 0x69, 0xFE);
adb_host_flush(9);
adb_host_flush(ADB_ADDR_MOUSE);
adb_host_listen_buf(ADB_ADDR_MOUSE, ADB_REG_2, cmd1, sizeof(cmd1));
adb_host_flush(ADB_ADDR_MOUSE);
adb_host_listen_buf(ADB_ADDR_MOUSE, ADB_REG_2, cmd2, sizeof(cmd2));
}
// Add device specific init here
}
mouse_handler = adb_host_talk(ADB_ADDR_MOUSE, ADB_REG_3) & 0xff;
mouse_handler = mouse_handler ? mouse_handler : ADB_HANDLER_CLASSIC1_MOUSE;
xprintf("handler: %d\n", mouse_handler);
#endif
xprintf("\nScan:\n");
for (uint8_t addr = 1; addr < 16; addr++) { for (uint8_t addr = 1; addr < 16; addr++) {
uint16_t reg3 = adb_host_talk(addr, ADB_REG_3); uint16_t reg3 = adb_host_talk(addr, ADB_REG_3);
if (reg3) { if (reg3) {
xprintf("Scan: addr:%d, reg3:%04X\n", addr, reg3); xprintf(" addr:%d, reg3:%04X\n", addr, reg3);
} }
_delay_ms(20); _delay_ms(20);
} }
@ -108,8 +176,7 @@ void matrix_init(void)
debug_enable = true; debug_enable = true;
//debug_matrix = true; //debug_matrix = true;
//debug_keyboard = true; //debug_keyboard = true;
//debug_mouse = true; debug_mouse = true;
print("debug enabled.\n");
// LED off // LED off
DDRD |= (1<<6); PORTD &= ~(1<<6); DDRD |= (1<<6); PORTD &= ~(1<<6);
@ -127,7 +194,8 @@ static report_mouse_t mouse_report = {};
void adb_mouse_task(void) void adb_mouse_task(void)
{ {
uint16_t codes; uint8_t len;
uint8_t buf[5];
int16_t x, y; int16_t x, y;
static int8_t mouseacc; static int8_t mouseacc;
@ -138,47 +206,86 @@ void adb_mouse_task(void)
if (timer_elapsed(tick_ms) < 12) return; if (timer_elapsed(tick_ms) < 12) return;
tick_ms = timer_read(); tick_ms = timer_read();
codes = adb_host_mouse_recv(); // Extended Mouse Protocol data can be 2-5 bytes
// https://developer.apple.com/library/archive/technotes/hw/hw_01.html#Extended
//
// Byte 0: b00 y06 y05 y04 y03 y02 y01 y00
// Byte 1: b01 x06 x05 x04 x03 x02 x01 x00
// Byte 2: b02 y09 y08 y07 b03 x09 x08 x07
// Byte 3: b04 y12 y11 y10 b05 x12 x11 x10
// Byte 4: b06 y15 y14 y13 b07 x15 x14 x13
//
// b--: Button state.(0: on, 1: off)
// x--: X axis movement.
// y--: Y axis movement.
len = adb_host_talk_buf(ADB_ADDR_MOUSE, ADB_REG_0, buf, sizeof(buf));
// If nothing received reset mouse acceleration, and quit. // If nothing received reset mouse acceleration, and quit.
if (!codes) { if (len < 2) {
mouseacc = 1; mouseacc = 1;
return; return;
}; };
// Bit sixteen is button.
if (~codes & (1 << 15)) // Store off-buttons and 0-movements in unused bytes
mouse_report.buttons |= MOUSE_BTN1; bool xneg = false;
if (codes & (1 << 15)) bool yneg = false;
mouse_report.buttons &= ~MOUSE_BTN1; if (len == 2) {
// lower seven bits are movement, as signed int_7. if (buf[0] & 0x40) yneg = true;
// low byte is X-axis, high byte is Y. if (buf[1] & 0x40) xneg = true;
y = (codes>>8 & 0x3F); } else {
x = (codes>>0 & 0x3F); if (buf[len - 1] & 0x40) yneg = true;
// bit seven and fifteen is negative if (buf[len - 1] & 0x04) xneg = true;
// usb does not use int_8, but int_7 (measuring distance) with sign-bit. }
if (codes & (1 << 6))
x = (x-0x40); for (int8_t i = len; i < sizeof(buf); i++) {
if (codes & (1 << 14)) buf[i] = 0x88;
y = (y-0x40); if (yneg) buf[i] |= 0x70;
if (xneg) buf[i] |= 0x07;
}
// 8 buttons at max
// TODO: Fix HID report descriptor for mouse to support button6-8
uint8_t buttons = 0;
if (!(buf[4] & 0x08)) buttons |= MOUSE_BTN8;
if (!(buf[4] & 0x80)) buttons |= MOUSE_BTN7;
if (!(buf[3] & 0x08)) buttons |= MOUSE_BTN6;
if (!(buf[3] & 0x80)) buttons |= MOUSE_BTN5;
if (!(buf[2] & 0x08)) buttons |= MOUSE_BTN4;
if (!(buf[2] & 0x80)) buttons |= MOUSE_BTN3;
if (!(buf[1] & 0x80)) buttons |= MOUSE_BTN2;
if (!(buf[0] & 0x80)) buttons |= MOUSE_BTN1;
mouse_report.buttons = buttons;
int16_t xx, yy;
yy = (buf[0] & 0x7F) | (buf[2] & 0x70) << 3 | (buf[3] & 0x70) << 6 | (buf[4] & 0x70) << 9;
xx = (buf[1] & 0x7F) | (buf[2] & 0x07) << 7 | (buf[3] & 0x07) << 10 | (buf[4] & 0x07) << 13;
// Accelerate mouse. (They weren't meant to be used on screens larger than 320x200). // Accelerate mouse. (They weren't meant to be used on screens larger than 320x200).
x *= mouseacc; x = xx * mouseacc;
y *= mouseacc; y = yy * mouseacc;
// TODO: Fix HID report descriptor for mouse to support finer resolution
// Cap our two bytes per axis to one byte. // Cap our two bytes per axis to one byte.
// Easier with a MIN-function, but since -MAX(-a,-b) = MIN(a,b)... // Easier with a MIN-function, but since -MAX(-a,-b) = MIN(a,b)...
// I.E. MIN(MAX(x,-127),127) = -MAX(-MAX(x, -127), -127) = MIN(-MIN(-x,127),127) // I.E. MIN(MAX(x,-127),127) = -MAX(-MAX(x, -127), -127) = MIN(-MIN(-x,127),127)
mouse_report.x = -MAX(-MAX(x, -127), -127); mouse_report.x = -MAX(-MAX(x, -127), -127);
mouse_report.y = -MAX(-MAX(y, -127), -127); mouse_report.y = -MAX(-MAX(y, -127), -127);
if (debug_mouse) { if (debug_mouse) {
print("adb_host_mouse_recv: "); print_bin16(codes); print("\n"); xprintf("Mouse raw: [");
print("adb_mouse raw: ["); for (int8_t i = 0; i < len; i++) xprintf("%02X ", buf[i]);
phex(mouseacc); print(" "); xprintf("]\n");
phex(mouse_report.buttons); print("|");
print_decs(mouse_report.x); print(" "); xprintf("Mouse info[");
print_decs(mouse_report.y); print("]\n"); xprintf("B:%02X, X:%d(%d), Y:%d(%d), A:%d]\n", buttons, x, xx, y, yy, mouseacc);
} }
// Send result by usb. // Send result by usb.
host_mouse_send(&mouse_report); host_mouse_send(&mouse_report);
// increase acceleration of mouse // increase acceleration of mouse
mouseacc += ( mouseacc < ADB_MOUSE_MAXACC ? 1 : 0 ); mouseacc += ( mouseacc < ADB_MOUSE_MAXACC ? 1 : 0 );
return; return;
} }
#endif #endif

3
tmk_core/common/report.h
View file

@ -33,6 +33,9 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define MOUSE_BTN3 (1<<2) #define MOUSE_BTN3 (1<<2)
#define MOUSE_BTN4 (1<<3) #define MOUSE_BTN4 (1<<3)
#define MOUSE_BTN5 (1<<4) #define MOUSE_BTN5 (1<<4)
#define MOUSE_BTN6 (1<<5)
#define MOUSE_BTN7 (1<<6)
#define MOUSE_BTN8 (1<<7)
/* Consumer Page(0x0C) /* Consumer Page(0x0C)
* following are supported by Windows: http://msdn.microsoft.com/en-us/windows/hardware/gg463372.aspx * following are supported by Windows: http://msdn.microsoft.com/en-us/windows/hardware/gg463372.aspx

100
tmk_core/protocol/adb.c
View file

@ -41,6 +41,7 @@ POSSIBILITY OF SUCH DAMAGE.
#include <avr/io.h> #include <avr/io.h>
#include <avr/interrupt.h> #include <avr/interrupt.h>
#include "adb.h" #include "adb.h"
#include "print.h"
// GCC doesn't inline functions normally // GCC doesn't inline functions normally
@ -92,22 +93,25 @@ uint16_t adb_host_kbd_recv(uint8_t addr)
} }
#ifdef ADB_MOUSE_ENABLE #ifdef ADB_MOUSE_ENABLE
__attribute__ ((weak))
void adb_mouse_init(void) { void adb_mouse_init(void) {
return; return;
} }
uint16_t adb_host_mouse_recv(void) __attribute__ ((weak))
{ void adb_mouse_task(void) {
return adb_host_talk(ADB_ADDR_MOUSE, ADB_REG_0); return;
} }
#endif #endif
uint16_t adb_host_talk(uint8_t addr, uint8_t reg) // This sends Talk command to read data from register and returns length of the data.
uint8_t adb_host_talk_buf(uint8_t addr, uint8_t reg, uint8_t *buf, uint8_t len)
{ {
uint16_t data = 0; for (int8_t i =0; i < len; i++) buf[i] = 0;
cli(); cli();
attention(); attention();
send_byte((addr<<4) | (ADB_CMD_TALK<<2) | reg); send_byte((addr<<4) | ADB_CMD_TALK | reg);
place_bit0(); // Stopbit(0) place_bit0(); // Stopbit(0)
if (!wait_data_hi(500)) { // Service Request(310us Adjustable Keyboard): just ignored if (!wait_data_hi(500)) { // Service Request(310us Adjustable Keyboard): just ignored
sei(); sei();
@ -118,55 +122,81 @@ uint16_t adb_host_talk(uint8_t addr, uint8_t reg)
return 0; // No data to send return 0; // No data to send
} }
uint8_t n = 17; // start bit + 16 data bits // start bit(1)
if (!wait_data_hi(40)) return 0;
if (!wait_data_lo(100)) return 0;
uint8_t n = 0; // bit count
do { do {
//
// |<- bit_cell_max(130) ->|
// | |<- lo ->|
// | | |<-hi->|
// _______
// | | |
// | 130-lo | lo-hi |
// |________| |
//
uint8_t lo = (uint8_t) wait_data_hi(130); uint8_t lo = (uint8_t) wait_data_hi(130);
if (!lo) if (!lo)
goto error; goto error; // no more bit or after stop bit
uint8_t hi = (uint8_t) wait_data_lo(lo); uint8_t hi = (uint8_t) wait_data_lo(lo);
if (!hi) if (!hi)
goto error; goto error; // stop bit extedned by Srq
hi = lo - hi; if (n/8 >= len) continue; // can't store in buf
lo = 130 - lo;
data <<= 1; buf[n/8] <<= 1;
if (lo < hi) { if ((130 - lo) < (lo - hi)) {
data |= 1; buf[n/8] |= 1;
}
else if (n == 17) {
sei();
return -20;
} }
} }
while ( --n ); while ( ++n );
// Stop bit can't be checked normally since it could have service request lenghtening
// and its high state never goes low.
if (!wait_data_hi(351) || wait_data_lo(91)) {
sei();
return -21;
}
sei();
return data;
error: error:
sei(); sei();
return -n; return n/8;
}
uint16_t adb_host_talk(uint8_t addr, uint8_t reg)
{
uint8_t len;
uint8_t buf[8];
len = adb_host_talk_buf(addr, reg, buf, 8);
if (len != 2) return 0;
return (buf[0]<<8 | buf[1]);
}
void adb_host_listen_buf(uint8_t addr, uint8_t reg, uint8_t *buf, uint8_t len)
{
cli();
attention();
send_byte((addr<<4) | ADB_CMD_LISTEN | reg);
place_bit0(); // Stopbit(0)
_delay_us(200); // Tlt/Stop to Start
place_bit1(); // Startbit(1)
for (int8_t i = 0; i < len; i++) {
send_byte(buf[i]);
//xprintf("%02X ", buf[i]);
}
place_bit0(); // Stopbit(0);
sei();
} }
void adb_host_listen(uint8_t addr, uint8_t reg, uint8_t data_h, uint8_t data_l) void adb_host_listen(uint8_t addr, uint8_t reg, uint8_t data_h, uint8_t data_l)
{
uint8_t buf[2] = { data_h, data_l };
adb_host_listen_buf(addr, reg, buf, 2);
}
void adb_host_flush(uint8_t addr)
{ {
cli(); cli();
attention(); attention();
send_byte((addr<<4) | (ADB_CMD_LISTEN<<2) | reg); send_byte((addr<<4) | ADB_CMD_FLUSH);
place_bit0(); // Stopbit(0) place_bit0(); // Stopbit(0)
_delay_us(200); // Tlt/Stop to Start _delay_us(200); // Tlt/Stop to Start
place_bit1(); // Startbit(1)
send_byte(data_h);
send_byte(data_l);
place_bit0(); // Stopbit(0);
sei(); sei();
} }

13
tmk_core/protocol/adb.h
View file

@ -62,8 +62,8 @@ POSSIBILITY OF SUCH DAMAGE.
// Command Type // Command Type
#define ADB_CMD_RESET 0 #define ADB_CMD_RESET 0
#define ADB_CMD_FLUSH 1 #define ADB_CMD_FLUSH 1
#define ADB_CMD_LISTEN 2 #define ADB_CMD_LISTEN 8
#define ADB_CMD_TALK 3 #define ADB_CMD_TALK 12
// Register // Register
#define ADB_REG_0 0 #define ADB_REG_0 0
#define ADB_REG_1 1 #define ADB_REG_1 1
@ -76,16 +76,21 @@ POSSIBILITY OF SUCH DAMAGE.
#define ADB_HANDLER_M0115 0x02 #define ADB_HANDLER_M0115 0x02
#define ADB_HANDLER_M3501 0x02 #define ADB_HANDLER_M3501 0x02
#define ADB_HANDLER_M1242_ANSI 0x10 #define ADB_HANDLER_M1242_ANSI 0x10
#define ADB_HANDLER_EXTENDED_PROTOCOL 0x03 #define ADB_HANDLER_EXTENDED_KEYBOARD 0x03
#define ADB_HANDLER_CLASSIC1_MOUSE 0x01
#define ADB_HANDLER_CLASSIC2_MOUSE 0x02
#define ADB_HANDLER_EXTENDED_MOUSE 0x04
// ADB host // ADB host
void adb_host_init(void); void adb_host_init(void);
bool adb_host_psw(void); bool adb_host_psw(void);
uint16_t adb_host_kbd_recv(uint8_t addr); uint16_t adb_host_kbd_recv(uint8_t addr);
uint16_t adb_host_mouse_recv(void);
uint16_t adb_host_talk(uint8_t addr, uint8_t reg); uint16_t adb_host_talk(uint8_t addr, uint8_t reg);
uint8_t adb_host_talk_buf(uint8_t addr, uint8_t reg, uint8_t *buf, uint8_t len);
void adb_host_listen(uint8_t addr, uint8_t reg, uint8_t data_h, uint8_t data_l); void adb_host_listen(uint8_t addr, uint8_t reg, uint8_t data_h, uint8_t data_l);
void adb_host_listen_buf(uint8_t addr, uint8_t reg, uint8_t *buf, uint8_t len);
void adb_host_flush(uint8_t addr);
void adb_host_kbd_led(uint8_t addr, uint8_t led); void adb_host_kbd_led(uint8_t addr, uint8_t led);
void adb_mouse_task(void); void adb_mouse_task(void);
void adb_mouse_init(void); void adb_mouse_init(void);