From 74eb8aef99acf3fe9af74a4689778ea436aecfb3 Mon Sep 17 00:00:00 2001 From: tmk Date: Sat, 2 Nov 2013 03:06:51 +0900 Subject: [PATCH 01/18] Tweak time values of busywait PS/2 --- protocol/ps2.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/protocol/ps2.c b/protocol/ps2.c index ed456091..4c6c2fcb 100644 --- a/protocol/ps2.c +++ b/protocol/ps2.c @@ -109,12 +109,12 @@ uint8_t ps2_host_send(uint8_t data) #endif /* terminate a transmission if we have */ inhibit(); - _delay_us(100); + _delay_us(200); // at least 100us /* start bit [1] */ data_lo(); clock_hi(); - WAIT(clock_lo, 15000, 1); + WAIT(clock_lo, 20000, 10); // may take 15ms at most until device starts clocking /* data [2-9] */ for (uint8_t i = 0; i < 8; i++) { _delay_us(15); @@ -167,7 +167,7 @@ uint8_t ps2_host_recv_response(void) idle(); /* wait start bit */ - wait_clock_lo(2000); + wait_clock_lo(25000); // command response may take 20 ms at most data = recv_data(); inhibit(); From 755b81f0ad55e409ebc267f13ce87b5b87317c1a Mon Sep 17 00:00:00 2001 From: tmk Date: Sat, 2 Nov 2013 03:10:49 +0900 Subject: [PATCH 02/18] Fix PS/2 mouse support --- common.mk | 11 +--- common/keyboard.c | 15 +++++- protocol.mk | 25 +++++++++ protocol/pjrc.mk | 6 ++- protocol/ps2_mouse.c | 122 ++++++++++++++++++------------------------- 5 files changed, 95 insertions(+), 84 deletions(-) diff --git a/common.mk b/common.mk index 5b70db94..2ca06daa 100644 --- a/common.mk +++ b/common.mk @@ -25,6 +25,7 @@ endif ifdef MOUSEKEY_ENABLE SRC += $(COMMON_DIR)/mousekey.c OPT_DEFS += -DMOUSEKEY_ENABLE + OPT_DEFS += -DMOUSE_ENABLE endif ifdef EXTRAKEY_ENABLE @@ -47,16 +48,6 @@ ifdef NKRO_ENABLE OPT_DEFS += -DNKRO_ENABLE endif -ifdef PS2_MOUSE_ENABLE - SRC += $(COMMON_DIR)/ps2.c \ - $(COMMON_DIR)/ps2_mouse.c - OPT_DEFS += -DPS2_MOUSE_ENABLE -endif - -ifdef $(or MOUSEKEY_ENABLE, PS2_MOUSE_ENABLE) - OPT_DEFS += -DMOUSE_ENABLE -endif - ifdef SLEEP_LED_ENABLE SRC += $(COMMON_DIR)/sleep_led.c OPT_DEFS += -DSLEEP_LED_ENABLE diff --git a/common/keyboard.c b/common/keyboard.c index 601e3abe..63a58b21 100644 --- a/common/keyboard.c +++ b/common/keyboard.c @@ -30,8 +30,13 @@ along with this program. If not, see . #include "sendchar.h" #include "bootmagic.h" #include "eeconfig.h" -#include "mousekey.h" #include "backlight.h" +#ifdef MOUSEKEY_ENABLE +# include "mousekey.h" +#endif +#ifdef PS2_MOUSE_ENABLE +# include "ps2_mouse.h" +#endif #ifdef MATRIX_HAS_GHOST @@ -111,10 +116,18 @@ void keyboard_task(void) action_exec(TICK); MATRIX_LOOP_END: + #ifdef MOUSEKEY_ENABLE // mousekey repeat & acceleration mousekey_task(); #endif + +#ifdef PS2_MOUSE_ENABLE + if (ps2_mouse_read() == 0) { + ps2_mouse_usb_send(); + } +#endif + // update LED if (led_status != host_keyboard_leds()) { led_status = host_keyboard_leds(); diff --git a/protocol.mk b/protocol.mk index 1442c520..0d5f06c7 100644 --- a/protocol.mk +++ b/protocol.mk @@ -1,2 +1,27 @@ +PROTOCOL_DIR = protocol + + +ifdef PS2_MOUSE_ENABLE + SRC += $(PROTOCOL_DIR)/ps2_mouse.c + OPT_DEFS += -DPS2_MOUSE_ENABLE + OPT_DEFS += -DMOUSE_ENABLE +endif + +ifdef PS2_USE_BUSYWAIT + SRC += protocol/ps2.c + OPT_DEFS += -DPS2_USE_BUSYWAIT +endif + +ifdef PS2_USE_INT + SRC += protocol/ps2.c + OPT_DEFS += -DPS2_USE_INT +endif + +ifdef PS2_USE_USART + SRC += protocol/ps2_usart.c + OPT_DEFS += -DPS2_USE_USART +endif + + # Search Path VPATH += $(TOP_DIR)/protocol diff --git a/protocol/pjrc.mk b/protocol/pjrc.mk index 27f908b1..5a446138 100644 --- a/protocol/pjrc.mk +++ b/protocol/pjrc.mk @@ -7,7 +7,11 @@ SRC += $(PJRC_DIR)/main.c \ $(PJRC_DIR)/usb.c # Option modules -ifdef $(or MOUSEKEY_ENABLE, PS2_MOUSE_ENABLE) +ifdef MOUSEKEY_ENABLE + SRC += $(PJRC_DIR)/usb_mouse.c +endif + +ifdef PS2_MOUSE_ENABLE SRC += $(PJRC_DIR)/usb_mouse.c endif diff --git a/protocol/ps2_mouse.c b/protocol/ps2_mouse.c index f796b2b4..701d9721 100644 --- a/protocol/ps2_mouse.c +++ b/protocol/ps2_mouse.c @@ -1,5 +1,5 @@ /* -Copyright 2011 Jun Wako +Copyright 2011,2013 Jun Wako 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,27 +32,7 @@ along with this program. If not, see . # define phex16(h) #endif -// disable when errors occur 255 times. -#define ERROR_RETURN() do { \ - if (ps2_error) { \ - if (ps2_mouse_error_count < 255) { \ - ps2_mouse_error_count++; \ - } else { \ - ps2_mouse_error_count = 0; \ - ps2_mouse_enable = false; \ - } \ - return ps2_error; \ - } \ -} while (0) - -/* -TODO ----- -- Stream mode -- Tracpoint command support: needed -- Middle button + move = Wheel traslation -*/ bool ps2_mouse_enable = true; uint8_t ps2_mouse_x = 0; uint8_t ps2_mouse_y = 0; @@ -69,85 +49,50 @@ uint8_t ps2_mouse_init(void) { ps2_host_init(); - // Reset + // Not reliable: sometime fail to initialize mouse + + // send Reset + _delay_ms(1000); // wait for powering up rcv = ps2_host_send(0xFF); - print("ps2_mouse_init: send 0xFF: "); - phex(ps2_error); print("\n"); - ERROR_RETURN(); - - // ACK - rcv = ps2_host_recv(); - print("ps2_mouse_init: read ACK: "); + print("ps2_mouse_init: send Reset: "); phex(rcv); phex(ps2_error); print("\n"); - ERROR_RETURN(); - // BAT takes some time - _delay_ms(100); + // read completion code of BAT + //_delay_ms(1000); // wait for Basic Assurance Test rcv = ps2_host_recv(); print("ps2_mouse_init: read BAT: "); phex(rcv); phex(ps2_error); print("\n"); - ERROR_RETURN(); - // Device ID + // read Device ID rcv = ps2_host_recv(); print("ps2_mouse_init: read DevID: "); phex(rcv); phex(ps2_error); print("\n"); - ERROR_RETURN(); - // Enable data reporting - ps2_host_send(0xF4); + // send Enable Data Reporting + rcv = ps2_host_send(0xF4); print("ps2_mouse_init: send 0xF4: "); - phex(ps2_error); print("\n"); - ERROR_RETURN(); - - // ACK - rcv = ps2_host_recv(); - print("ps2_mouse_init: read ACK: "); phex(rcv); phex(ps2_error); print("\n"); - ERROR_RETURN(); - // Set Remote mode - ps2_host_send(0xF0); + // send Set Remote mode + rcv = ps2_host_send(0xF0); print("ps2_mouse_init: send 0xF0: "); - phex(ps2_error); print("\n"); - ERROR_RETURN(); - - // ACK - rcv = ps2_host_recv(); - print("ps2_mouse_init: read ACK: "); phex(rcv); phex(ps2_error); print("\n"); - ERROR_RETURN(); return 0; } -/* -Data format: - bit: 7 6 5 4 3 2 1 0 ------------------------------------------------------------------------ -0 btn: Yovflw Xovflw Ysign Xsign 1 Middle Right Left -1 x: X movement(0-255) -2 y: Y movement(0-255) -*/ uint8_t ps2_mouse_read(void) { uint8_t rcv; if (!ps2_mouse_enable) return 1; - ps2_host_send(0xEB); - ERROR_RETURN(); - - rcv=ps2_host_recv(); - ERROR_RETURN(); + rcv = ps2_host_send(0xEB); if(rcv==0xFA) { - ps2_mouse_btn = ps2_host_recv(); - ERROR_RETURN(); - ps2_mouse_x = ps2_host_recv(); - ERROR_RETURN(); - ps2_mouse_y = ps2_host_recv(); - ERROR_RETURN(); + ps2_mouse_btn = ps2_host_recv_response(); + ps2_mouse_x = ps2_host_recv_response(); + ps2_mouse_y = ps2_host_recv_response(); } return 0; } @@ -216,3 +161,36 @@ void ps2_mouse_print(void) phex(ps2_mouse_x); print(" "); phex(ps2_mouse_y); print("\n"); } + + +/* PS/2 Mouse Synopsis + * http://www.computer-engineering.org/ps2mouse/ + * + * Command: + * 0xFF: Reset + * 0xF6: Set Defaults Sampling; rate=100, resolution=4cnt/mm, scaling=1:1, reporting=disabled + * 0xF5: Disable Data Reporting + * 0xF4: Enable Data Reporting + * 0xF3: Set Sample Rate + * 0xF2: Get Device ID + * 0xF0: Set Remote Mode + * 0xEB: Read Data + * 0xEA: Set Stream Mode + * 0xE9: Status Request + * 0xE8: Set Resolution + * 0xE7: Set Scaling 2:1 + * 0xE6: Set Scaling 1:1 + * + * Mode: + * Stream Mode: devices sends the data when it changs its state + * Remote Mode: host polls the data periodically + * + * This code uses Remote Mode and polls the data with Read Data(0xEB). + * + * Data format: + * byte|7 6 5 4 3 2 1 0 + * ----+-------------------------------------------------------------- + * 0|Yovflw Xovflw Ysign Xsign 1 Middle Right Left + * 1| X movement(0-255) + * 2| Y movement(0-255) + */ From 448d2ed1f8440b2d2cc73e49cbffe8c895937183 Mon Sep 17 00:00:00 2001 From: tmk Date: Tue, 19 Nov 2013 03:20:25 +0900 Subject: [PATCH 03/18] Wait for USB starting up to make debug print available --- common/action_util.h | 1 + protocol/lufa/lufa.c | 9 ++++++++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/common/action_util.h b/common/action_util.h index 939bc2b6..f9d3161a 100644 --- a/common/action_util.h +++ b/common/action_util.h @@ -18,6 +18,7 @@ along with this program. If not, see . #define ACTION_UTIL_H #include +#include "report.h" extern report_keyboard_t *keyboard_report; diff --git a/protocol/lufa/lufa.c b/protocol/lufa/lufa.c index a230d5ba..04e8e78f 100644 --- a/protocol/lufa/lufa.c +++ b/protocol/lufa/lufa.c @@ -539,11 +539,18 @@ int main(void) { SetupHardware(); sei(); + + /* wait for USB startup & debug output */ + while (USB_DeviceState != DEVICE_STATE_Configured) { #if defined(INTERRUPT_CONTROL_ENDPOINT) - while (USB_DeviceState != DEVICE_STATE_Configured) ; + ; +#else + USB_USBTask(); #endif + } print("USB configured.\n"); + /* init modules */ keyboard_init(); host_set_driver(&lufa_driver); #ifdef SLEEP_LED_ENABLE From 8e8d2cc53d27182a0cc205b3fec21a9ced3c9387 Mon Sep 17 00:00:00 2001 From: tmk Date: Tue, 19 Nov 2013 03:25:31 +0900 Subject: [PATCH 04/18] Fix delay of PS/2 mouse init --- protocol/ps2_mouse.c | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/protocol/ps2_mouse.c b/protocol/ps2_mouse.c index 701d9721..5e0b3657 100644 --- a/protocol/ps2_mouse.c +++ b/protocol/ps2_mouse.c @@ -49,16 +49,14 @@ uint8_t ps2_mouse_init(void) { ps2_host_init(); - // Not reliable: sometime fail to initialize mouse + _delay_ms(1000); // wait for powering up // send Reset - _delay_ms(1000); // wait for powering up rcv = ps2_host_send(0xFF); print("ps2_mouse_init: send Reset: "); phex(rcv); phex(ps2_error); print("\n"); // read completion code of BAT - //_delay_ms(1000); // wait for Basic Assurance Test rcv = ps2_host_recv(); print("ps2_mouse_init: read BAT: "); phex(rcv); phex(ps2_error); print("\n"); From a045313fa3a240c9454419234dfb596b3180932a Mon Sep 17 00:00:00 2001 From: tmk Date: Wed, 20 Nov 2013 11:19:59 +0900 Subject: [PATCH 05/18] Fix to build ps2_mouse with both LUFA and PJRC - change API of ps2_mouse; ps2_mouse_task() - remove mouse_report from host.c --- common/action.c | 6 -- common/action.h | 1 - common/host.c | 8 -- common/host.h | 6 -- common/keyboard.c | 4 +- common/mousekey.c | 1 + protocol/ps2_mouse.c | 198 +++++++++++++++++++++++++------------------ protocol/ps2_mouse.h | 21 ++--- 8 files changed, 128 insertions(+), 117 deletions(-) diff --git a/common/action.c b/common/action.c index f7ae85b9..485abf81 100644 --- a/common/action.c +++ b/common/action.c @@ -485,12 +485,6 @@ void clear_keyboard_but_mods(void) #endif } -bool sending_anykey(void) -{ - return (has_anykey() || host_mouse_in_use() || - host_last_sysytem_report() || host_last_consumer_report()); -} - bool is_tap_key(key_t key) { action_t action = layer_switch_get_action(key); diff --git a/common/action.h b/common/action.h index d57f4a86..077711c2 100644 --- a/common/action.h +++ b/common/action.h @@ -64,7 +64,6 @@ void unregister_mods(uint8_t mods); //void set_mods(uint8_t mods); void clear_keyboard(void); void clear_keyboard_but_mods(void); -bool sending_anykey(void); void layer_switch(uint8_t new_layer); bool is_tap_key(key_t key); diff --git a/common/host.c b/common/host.c index 0703dba0..1eafef75 100644 --- a/common/host.c +++ b/common/host.c @@ -27,9 +27,6 @@ along with this program. If not, see . bool keyboard_nkro = false; #endif -report_mouse_t mouse_report = {}; - - static host_driver_t *driver; static uint16_t last_system_report = 0; static uint16_t last_consumer_report = 0; @@ -89,11 +86,6 @@ void host_consumer_send(uint16_t report) (*driver->send_consumer)(report); } -uint8_t host_mouse_in_use(void) -{ - return (mouse_report.buttons | mouse_report.x | mouse_report.y | mouse_report.v | mouse_report.h); -} - uint16_t host_last_sysytem_report(void) { return last_system_report; diff --git a/common/host.h b/common/host.h index c1a0fbac..8ff26298 100644 --- a/common/host.h +++ b/common/host.h @@ -32,9 +32,6 @@ extern "C" { extern bool keyboard_nkro; #endif -/* report */ -extern report_mouse_t mouse_report; - /* host driver */ void host_set_driver(host_driver_t *driver); @@ -47,9 +44,6 @@ void host_mouse_send(report_mouse_t *report); void host_system_send(uint16_t data); void host_consumer_send(uint16_t data); -/* mouse report utils */ -uint8_t host_mouse_in_use(void); - uint16_t host_last_sysytem_report(void); uint16_t host_last_consumer_report(void); diff --git a/common/keyboard.c b/common/keyboard.c index 63a58b21..2b66f20a 100644 --- a/common/keyboard.c +++ b/common/keyboard.c @@ -123,9 +123,7 @@ MATRIX_LOOP_END: #endif #ifdef PS2_MOUSE_ENABLE - if (ps2_mouse_read() == 0) { - ps2_mouse_usb_send(); - } + ps2_mouse_task(); #endif // update LED diff --git a/common/mousekey.c b/common/mousekey.c index 3068fc5e..017be941 100644 --- a/common/mousekey.c +++ b/common/mousekey.c @@ -26,6 +26,7 @@ along with this program. If not, see . +static report_mouse_t mouse_report = {}; static uint8_t mousekey_repeat = 0; static uint8_t mousekey_accel = 0; diff --git a/protocol/ps2_mouse.c b/protocol/ps2_mouse.c index 5e0b3657..ff730196 100644 --- a/protocol/ps2_mouse.c +++ b/protocol/ps2_mouse.c @@ -20,7 +20,8 @@ along with this program. If not, see . #include #include "ps2.h" #include "ps2_mouse.h" -#include "usb_mouse.h" +#include "report.h" +#include "host.h" #define PS2_MOUSE_DEBUG #ifdef PS2_MOUSE_DEBUG @@ -33,20 +34,17 @@ along with this program. If not, see . #endif -bool ps2_mouse_enable = true; -uint8_t ps2_mouse_x = 0; -uint8_t ps2_mouse_y = 0; -uint8_t ps2_mouse_btn = 0; -uint8_t ps2_mouse_error_count = 0; - -static uint8_t ps2_mouse_btn_prev = 0; +static report_mouse_t mouse_report = {}; +static void ps2_mouse_print_raw_data(void); +static void ps2_mouse_print_usb_data(void); + + +/* supports only 3 button mouse at this time */ uint8_t ps2_mouse_init(void) { uint8_t rcv; - if (!ps2_mouse_enable) return 1; - ps2_host_init(); _delay_ms(1000); // wait for powering up @@ -79,85 +77,119 @@ uint8_t ps2_mouse_init(void) { return 0; } -uint8_t ps2_mouse_read(void) -{ - uint8_t rcv; - - if (!ps2_mouse_enable) return 1; - - rcv = ps2_host_send(0xEB); - - if(rcv==0xFA) { - ps2_mouse_btn = ps2_host_recv_response(); - ps2_mouse_x = ps2_host_recv_response(); - ps2_mouse_y = ps2_host_recv_response(); - } - return 0; -} - -bool ps2_mouse_changed(void) -{ - return (ps2_mouse_x || ps2_mouse_y || (ps2_mouse_btn & PS2_MOUSE_BTN_MASK) != ps2_mouse_btn_prev); -} - +/* scroll support + * TODO: should be build option + */ #define PS2_MOUSE_SCROLL_BUTTON 0x04 -void ps2_mouse_usb_send(void) +#define X_IS_NEG (mouse_report.buttons & (1< USB(-127/127) - if (ps2_mouse_btn & (1< 128 ? (int8_t)ps2_mouse_x : -127; - else - x = ps2_mouse_x < 128 ? (int8_t)ps2_mouse_x : 127; - - if (ps2_mouse_btn & (1< 128 ? (int8_t)ps2_mouse_y : -127; - else - y = ps2_mouse_y < 128 ? (int8_t)ps2_mouse_y : 127; - - // Y is needed to reverse - y = -y; - - if (ps2_mouse_btn & PS2_MOUSE_SCROLL_BUTTON) { - // scroll - if (x > 0 || x < 0) h = (x > 64 ? 64 : (x < -64 ? -64 :x)); - if (y > 0 || y < 0) v = (y > 64 ? 64 : (y < -64 ? -64 :y)); - if (h || v) { - scrolled = true; - usb_mouse_send(0,0, -v/16, h/16, 0); - _delay_ms(100); - } - } else if (!scrolled && (ps2_mouse_btn_prev & PS2_MOUSE_SCROLL_BUTTON)) { - usb_mouse_send(0,0,0,0, PS2_MOUSE_SCROLL_BUTTON); - _delay_ms(100); - usb_mouse_send(0,0,0,0, 0); - } else { - scrolled = false; - usb_mouse_send(x, y, 0, 0, ps2_mouse_btn & PS2_MOUSE_BTN_MASK); - } - - ps2_mouse_btn_prev = (ps2_mouse_btn & PS2_MOUSE_BTN_MASK); - ps2_mouse_print(); + /* receives packet from mouse */ + uint8_t rcv; + rcv = ps2_host_send(PS2_MOUSE_READ_DATA); + if (rcv == PS2_ACK) { + mouse_report.buttons = ps2_host_recv_response(); + mouse_report.x = ps2_host_recv_response(); + mouse_report.y = ps2_host_recv_response(); + } else { + if (!debug_mouse) print("ps2_mouse: fail to get mouse packet\n"); + return; } - ps2_mouse_x = 0; - ps2_mouse_y = 0; - ps2_mouse_btn = 0; + + /* if mouse moves or buttons state changes */ + if (mouse_report.x || mouse_report.y || + ((mouse_report.buttons ^ buttons_prev) & PS2_MOUSE_BTN_MASK)) { + + ps2_mouse_print_raw_data(); + + buttons_prev = mouse_report.buttons; + + // PS/2 mouse data is '9-bit integer'(-256 to 255) which is comprised of sign-bit and 8-bit value. + // bit: 8 7 ... 0 + // sign \8-bit/ + // + // Meanwhile USB HID mouse indicates 8bit data(-127 to 127), note that -128 is not used. + // + // This converts PS/2 data into HID value. Use only -127-127 out of PS/2 9-bit. + mouse_report.x = X_IS_NEG ? + ((!X_IS_OVF && -127 <= mouse_report.x && mouse_report.x <= -1) ? mouse_report.x : -127) : + ((!X_IS_OVF && 0 <= mouse_report.x && mouse_report.x <= 127) ? mouse_report.x : 127); + mouse_report.y = Y_IS_NEG ? + ((!Y_IS_OVF && -127 <= mouse_report.y && mouse_report.y <= -1) ? mouse_report.y : -127) : + ((!Y_IS_OVF && 0 <= mouse_report.y && mouse_report.y <= 127) ? mouse_report.y : 127); + + // remove sign and overflow flags + mouse_report.buttons &= PS2_MOUSE_BTN_MASK; + + // invert coordinate of y to conform to USB HID mouse + mouse_report.y = -mouse_report.y; + + + if ((mouse_report.buttons & PS2_MOUSE_SCROLL_BUTTON) == PS2_MOUSE_SCROLL_BUTTON) { + if (scroll_state == SCROLL_NONE) scroll_state = SCROLL_BTN; + + // doesn't send Scroll Button + mouse_report.buttons &= ~PS2_MOUSE_SCROLL_BUTTON; + + if (mouse_report.x || mouse_report.y) { + scroll_state = SCROLL_SENT; + + mouse_report.v = -mouse_report.y/2; + mouse_report.h = mouse_report.x/2; + mouse_report.x = 0; + mouse_report.y = 0; + host_mouse_send(&mouse_report); + } + } else if (scroll_state == SCROLL_BTN && + (mouse_report.buttons & PS2_MOUSE_SCROLL_BUTTON) == 0) { + scroll_state = SCROLL_NONE; + + // send Scroll Button(down and up at once) when not scrolled + mouse_report.buttons |= PS2_MOUSE_SCROLL_BUTTON; + host_mouse_send(&mouse_report); + _delay_ms(100); + mouse_report.buttons &= ~PS2_MOUSE_SCROLL_BUTTON; + host_mouse_send(&mouse_report); + } else { + scroll_state = SCROLL_NONE; + + host_mouse_send(&mouse_report); + } + ps2_mouse_print_usb_data(); + } + // clear report + mouse_report.x = 0; + mouse_report.y = 0; + mouse_report.v = 0; + mouse_report.h = 0; + mouse_report.buttons = 0; } -void ps2_mouse_print(void) +static void ps2_mouse_print_raw_data(void) { if (!debug_mouse) return; - print("ps2_mouse[btn|x y]: "); - phex(ps2_mouse_btn); print("|"); - phex(ps2_mouse_x); print(" "); - phex(ps2_mouse_y); print("\n"); + print("ps2_mouse raw [btn|x y]: ["); + phex(mouse_report.buttons); print("|"); + print_hex8((uint8_t)mouse_report.x); print(" "); + print_hex8((uint8_t)mouse_report.y); print("]\n"); +} + +static void ps2_mouse_print_usb_data(void) +{ + if (!debug_mouse) return; + print("ps2_mouse usb [btn|x y v h]: ["); + phex(mouse_report.buttons); print("|"); + print_hex8((uint8_t)mouse_report.x); print(" "); + print_hex8((uint8_t)mouse_report.y); print(" "); + print_hex8((uint8_t)mouse_report.v); print(" "); + print_hex8((uint8_t)mouse_report.h); print("]\n"); } @@ -189,6 +221,6 @@ void ps2_mouse_print(void) * byte|7 6 5 4 3 2 1 0 * ----+-------------------------------------------------------------- * 0|Yovflw Xovflw Ysign Xsign 1 Middle Right Left - * 1| X movement(0-255) - * 2| Y movement(0-255) + * 1| X movement + * 2| Y movement */ diff --git a/protocol/ps2_mouse.h b/protocol/ps2_mouse.h index 4529ce11..305a9bdb 100644 --- a/protocol/ps2_mouse.h +++ b/protocol/ps2_mouse.h @@ -20,6 +20,16 @@ along with this program. If not, see . #include +#define PS2_MOUSE_READ_DATA 0xEB + +/* + * Data format: + * byte|7 6 5 4 3 2 1 0 + * ----+-------------------------------------------------------------- + * 0|Yovflw Xovflw Ysign Xsign 1 Middle Right Left + * 1| X movement(0-255) + * 2| Y movement(0-255) + */ #define PS2_MOUSE_BTN_MASK 0x07 #define PS2_MOUSE_BTN_LEFT 0 #define PS2_MOUSE_BTN_RIGHT 1 @@ -29,16 +39,7 @@ along with this program. If not, see . #define PS2_MOUSE_X_OVFLW 6 #define PS2_MOUSE_Y_OVFLW 7 -bool ps2_mouse_enable; -extern uint8_t ps2_mouse_x; -extern uint8_t ps2_mouse_y; -extern uint8_t ps2_mouse_btn; -extern uint8_t ps2_mouse_error_count; - uint8_t ps2_mouse_init(void); -uint8_t ps2_mouse_read(void); -bool ps2_mouse_changed(void); -void ps2_mouse_usb_send(void); -void ps2_mouse_print(void); +void ps2_mouse_task(void); #endif From ec0e762ea5e5e6bace2c06f4f89e82b51a775532 Mon Sep 17 00:00:00 2001 From: tmk Date: Wed, 20 Nov 2013 15:28:58 +0900 Subject: [PATCH 06/18] Add build options of ps2_mouse --- protocol/ps2_mouse.c | 92 +++++++++++++++++++++----------------------- protocol/ps2_mouse.h | 21 ++++++++++ 2 files changed, 64 insertions(+), 49 deletions(-) diff --git a/protocol/ps2_mouse.c b/protocol/ps2_mouse.c index ff730196..ea629655 100644 --- a/protocol/ps2_mouse.c +++ b/protocol/ps2_mouse.c @@ -22,23 +22,15 @@ along with this program. If not, see . #include "ps2_mouse.h" #include "report.h" #include "host.h" - -#define PS2_MOUSE_DEBUG -#ifdef PS2_MOUSE_DEBUG -# include "print.h" -# include "debug.h" -#else -# define print(s) -# define phex(h) -# define phex16(h) -#endif +#include "timer.h" +#include "print.h" +#include "debug.h" static report_mouse_t mouse_report = {}; -static void ps2_mouse_print_raw_data(void); -static void ps2_mouse_print_usb_data(void); +static void print_usb_data(void); /* supports only 3 button mouse at this time */ @@ -77,10 +69,6 @@ uint8_t ps2_mouse_init(void) { return 0; } -/* scroll support - * TODO: should be build option - */ -#define PS2_MOUSE_SCROLL_BUTTON 0x04 #define X_IS_NEG (mouse_report.buttons & (1<. #define PS2_MOUSE_X_OVFLW 6 #define PS2_MOUSE_Y_OVFLW 7 + +/* + * Scroll by mouse move with pressing button + */ +/* mouse button to start scrolling; set 0 to disable scroll */ +#ifndef PS2_MOUSE_SCROLL_BTN_MASK +#define PS2_MOUSE_SCROLL_BTN_MASK (1< Date: Tue, 19 Nov 2013 15:29:09 -0800 Subject: [PATCH 07/18] Add tap toggle modifiers Including documentation. --- common/action.c | 11 +++++++++++ common/action_code.h | 3 +++ doc/keymap.md | 6 ++++++ 3 files changed, 20 insertions(+) diff --git a/common/action.c b/common/action.c index f7ae85b9..38ee12ab 100644 --- a/common/action.c +++ b/common/action.c @@ -128,6 +128,17 @@ void process_action(keyrecord_t *record) } break; #endif + case MODS_TAP_TOGGLE: + if (event.pressed) { + if (tap_count <= TAPPING_TOGGLE) { + register_mods(mods); + } + } else { + if (tap_count < TAPPING_TOGGLE) { + unregister_mods(mods); + } + } + break; default: if (event.pressed) { if (tap_count > 0) { diff --git a/common/action_code.h b/common/action_code.h index c153838f..bd3652e3 100644 --- a/common/action_code.h +++ b/common/action_code.h @@ -34,6 +34,7 @@ along with this program. If not, see . * * ACT_MODS_TAP(001r): * 001r|mods|0000 0000 Modifiers with OneShot + * 001r|mods|0000 0001 Modifiers with tap toggle * 001r|mods|0000 00xx (reserved) * 001r|mods| keycode Modifiers with Tap Key(Dual role) * @@ -205,12 +206,14 @@ enum mods_bit { }; enum mods_codes { MODS_ONESHOT = 0x00, + MODS_TAP_TOGGLE = 0x01, }; #define ACTION_KEY(key) ACTION(ACT_MODS, (key)) #define ACTION_MODS(mods) ACTION(ACT_MODS, (mods&0x1f)<<8 | 0) #define ACTION_MODS_KEY(mods, key) ACTION(ACT_MODS, (mods&0x1f)<<8 | (key)) #define ACTION_MODS_TAP_KEY(mods, key) ACTION(ACT_MODS_TAP, (mods&0x1f)<<8 | (key)) #define ACTION_MODS_ONESHOT(mods) ACTION(ACT_MODS_TAP, (mods&0x1f)<<8 | MODS_ONESHOT) +#define ACTION_MODS_TAP_TOGGLE(mods) ACTION(ACT_MODS_TAP, (mods&0x1f)<<8 | MODS_TAP_TOGGLE) /* diff --git a/doc/keymap.md b/doc/keymap.md index 11e80a9c..3a549de6 100644 --- a/doc/keymap.md +++ b/doc/keymap.md @@ -526,6 +526,12 @@ Say you want to type 'The', you have to push and hold Shift key before type 't' Oneshot effect is cancel unless following key is pressed down within `ONESHOT_TIMEOUT` of `config.h`. No timeout when it is `0` or not defined. +### 4.4 Tap Toggle Mods +Similar to layer tap toggle, this works as a momentary modifier when holding, but toggles on with several taps. A single tap will 'unstick' the modifier again. + + ACTION_MODS_TAP_TOGGLE(MOD_LSFT) + + ## 5. Legacy Keymap From 20d283ea0c059b7988f99c22987eb9dccecceaae Mon Sep 17 00:00:00 2001 From: tmk Date: Thu, 21 Nov 2013 08:10:09 +0900 Subject: [PATCH 08/18] Fix interrupt version of ps2.c --- protocol/ps2.c | 53 +++++++++++++++++++++++++++++--------------- protocol/ps2_mouse.c | 9 ++------ 2 files changed, 37 insertions(+), 25 deletions(-) diff --git a/protocol/ps2.c b/protocol/ps2.c index 4c6c2fcb..e5873a9b 100644 --- a/protocol/ps2.c +++ b/protocol/ps2.c @@ -1,5 +1,5 @@ /* -Copyright 2010,2011 Jun WAKO +Copyright 2010,2011,2012,2013 Jun WAKO This software is licensed with a Modified BSD License. All of this is supposed to be Free Software, Open Source, DFSG-free, @@ -43,7 +43,9 @@ POSSIBILITY OF SUCH DAMAGE. #include "debug.h" +#ifndef PS2_USE_INT static uint8_t recv_data(void); +#endif static inline void clock_lo(void); static inline void clock_hi(void); static inline bool clock_in(void); @@ -143,6 +145,9 @@ uint8_t ps2_host_send(uint8_t data) WAIT(clock_hi, 50, 8); WAIT(data_hi, 50, 9); +#ifdef PS2_USE_INT + PS2_INT_ON(); +#endif res = ps2_host_recv_response(); ERROR: #ifdef PS2_USE_INT @@ -154,11 +159,15 @@ ERROR: return res; } +#ifndef PS2_USE_INT /* receive data when host want else inhibit communication */ uint8_t ps2_host_recv_response(void) { uint8_t data = 0; +#ifdef PS2_USE_INT + PS2_INT_OFF(); +#endif /* terminate a transmission if we have */ inhibit(); _delay_us(100); @@ -173,6 +182,7 @@ uint8_t ps2_host_recv_response(void) inhibit(); return data; } +#endif #ifndef PS2_USE_INT uint8_t ps2_host_recv(void) @@ -187,9 +197,6 @@ static uint8_t pbuf_head = 0; static uint8_t pbuf_tail = 0; static inline void pbuf_enqueue(uint8_t data) { - if (!data) - return; - uint8_t sreg = SREG; cli(); uint8_t next = (pbuf_head + 1) % PBUF_SIZE; @@ -215,6 +222,21 @@ static inline uint8_t pbuf_dequeue(void) return val; } +static inline bool pbuf_has_data(void) +{ + uint8_t sreg = SREG; + cli(); + bool has_data = (pbuf_head != pbuf_tail); + SREG = sreg; + return has_data; +} +static inline void pbuf_clear(void) +{ + uint8_t sreg = SREG; + cli(); + pbuf_head = pbuf_tail = 0; + SREG = sreg; +} /* get data received by interrupt */ uint8_t ps2_host_recv(void) @@ -229,13 +251,12 @@ uint8_t ps2_host_recv(void) return pbuf_dequeue(); } -#if 0 -#define DEBUGP_INIT() do { DDRC = 0xFF; } while (0) -#define DEBUGP(x) do { PORTC = x; } while (0) -#else -#define DEBUGP_INIT() -#define DEBUGP(x) -#endif +uint8_t ps2_host_recv_response(void) +{ + while (!pbuf_has_data()) ; + return pbuf_dequeue(); +} + ISR(PS2_INT_VECT) { static enum { @@ -256,7 +277,6 @@ ISR(PS2_INT_VECT) } state++; - DEBUGP(state); switch (state) { case START: if (data_in()) @@ -289,6 +309,7 @@ ISR(PS2_INT_VECT) if (!data_in()) goto ERROR; pbuf_enqueue(data); +//phex(data); goto DONE; break; default: @@ -296,7 +317,6 @@ ISR(PS2_INT_VECT) } goto RETURN; ERROR: - DEBUGP(0x0F); inhibit(); ps2_error = state; DONE: @@ -309,11 +329,6 @@ RETURN: #endif -static void ps2_reset(void) -{ - ps2_host_send(0xFF); -} - /* send LED state to keyboard */ void ps2_host_set_led(uint8_t led) { @@ -322,6 +337,7 @@ void ps2_host_set_led(uint8_t led) } +#ifndef PS2_USE_INT /* called after start bit comes */ static uint8_t recv_data(void) { @@ -361,6 +377,7 @@ static uint8_t recv_data(void) ERROR: return 0; } +#endif static inline void clock_lo() { diff --git a/protocol/ps2_mouse.c b/protocol/ps2_mouse.c index ea629655..4702f12c 100644 --- a/protocol/ps2_mouse.c +++ b/protocol/ps2_mouse.c @@ -47,20 +47,15 @@ uint8_t ps2_mouse_init(void) { phex(rcv); phex(ps2_error); print("\n"); // read completion code of BAT - rcv = ps2_host_recv(); + rcv = ps2_host_recv_response(); print("ps2_mouse_init: read BAT: "); phex(rcv); phex(ps2_error); print("\n"); // read Device ID - rcv = ps2_host_recv(); + rcv = ps2_host_recv_response(); print("ps2_mouse_init: read DevID: "); phex(rcv); phex(ps2_error); print("\n"); - // send Enable Data Reporting - rcv = ps2_host_send(0xF4); - print("ps2_mouse_init: send 0xF4: "); - phex(rcv); phex(ps2_error); print("\n"); - // send Set Remote mode rcv = ps2_host_send(0xF0); print("ps2_mouse_init: send 0xF0: "); From 591c58807976ef148d7e1e359d0a2147522f6b64 Mon Sep 17 00:00:00 2001 From: tmk Date: Thu, 21 Nov 2013 12:15:33 +0900 Subject: [PATCH 09/18] Fix PS/2 USART version --- protocol/ps2_usart.c | 54 ++++++++++++++++++++------------------------ 1 file changed, 25 insertions(+), 29 deletions(-) diff --git a/protocol/ps2_usart.c b/protocol/ps2_usart.c index 9ea6b778..40c46c49 100644 --- a/protocol/ps2_usart.c +++ b/protocol/ps2_usart.c @@ -1,5 +1,5 @@ /* -Copyright 2010,2011 Jun WAKO +Copyright 2010,2011,2012,2013 Jun WAKO This software is licensed with a Modified BSD License. All of this is supposed to be Free Software, Open Source, DFSG-free, @@ -64,14 +64,6 @@ http://www.mcamafia.de/pdf/ibm_hitrc07.pdf #include "debug.h" -#if 0 -#define DEBUGP_INIT() do { DDRC = 0xFF; } while (0) -#define DEBUGP(x) do { PORTC = x; } while (0) -#else -#define DEBUGP_INIT() -#define DEBUGP(x) -#endif - #define WAIT(stat, us, err) do { \ if (!wait_##stat(us)) { \ ps2_error = err; \ @@ -97,12 +89,12 @@ static inline void idle(void); static inline void inhibit(void); static inline uint8_t pbuf_dequeue(void); static inline void pbuf_enqueue(uint8_t data); +static inline bool pbuf_has_data(void); +static inline void pbuf_clear(void); void ps2_host_init(void) { - DEBUGP_INIT(); - DEBUGP(0x1); idle(); PS2_USART_INIT(); PS2_USART_RX_INT_ON(); @@ -114,7 +106,6 @@ uint8_t ps2_host_send(uint8_t data) bool parity = true; ps2_error = PS2_ERR_NONE; - DEBUGP(0x6); PS2_USART_OFF(); /* terminate a transmission if we have */ @@ -153,6 +144,8 @@ uint8_t ps2_host_send(uint8_t data) WAIT(clock_hi, 50, 8); WAIT(data_hi, 50, 9); + PS2_USART_INIT(); + PS2_USART_RX_INT_ON(); res = ps2_host_recv_response(); ERROR: idle(); @@ -164,15 +157,10 @@ ERROR: // Do polling data from keyboard to get response to last command. uint8_t ps2_host_recv_response(void) { - uint8_t data = 0; - PS2_USART_INIT(); - PS2_USART_RX_POLL_ON(); - while (!PS2_USART_RX_READY) - ; - data = PS2_USART_RX_DATA; - PS2_USART_OFF(); - DEBUGP(0x9); - return data; + while (!pbuf_has_data()) { + _delay_ms(1); // without this delay it seems to fall into deadlock + } + return pbuf_dequeue(); } uint8_t ps2_host_recv(void) @@ -182,15 +170,11 @@ uint8_t ps2_host_recv(void) ISR(PS2_USART_RX_VECT) { - DEBUGP(0x7); uint8_t error = PS2_USART_ERROR; uint8_t data = PS2_USART_RX_DATA; - if (error) { - DEBUGP(error>>2); - } else { + if (!error) { pbuf_enqueue(data); } - DEBUGP(0x8); } /* send LED state to keyboard */ @@ -293,9 +277,6 @@ static uint8_t pbuf_head = 0; static uint8_t pbuf_tail = 0; static inline void pbuf_enqueue(uint8_t data) { - if (!data) - return; - uint8_t sreg = SREG; cli(); uint8_t next = (pbuf_head + 1) % PBUF_SIZE; @@ -322,3 +303,18 @@ static inline uint8_t pbuf_dequeue(void) return val; } +static inline bool pbuf_has_data(void) +{ + uint8_t sreg = SREG; + cli(); + bool has_data = (pbuf_head != pbuf_tail); + SREG = sreg; + return has_data; +} +static inline void pbuf_clear(void) +{ + uint8_t sreg = SREG; + cli(); + pbuf_head = pbuf_tail = 0; + SREG = sreg; +} From 2cec79962639f2cd7a2757466eeb15cd78525670 Mon Sep 17 00:00:00 2001 From: tmk Date: Thu, 21 Nov 2013 23:23:57 +0900 Subject: [PATCH 10/18] Add parenthses ito macro arguments --- common/action_code.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/common/action_code.h b/common/action_code.h index c153838f..b08d3612 100644 --- a/common/action_code.h +++ b/common/action_code.h @@ -207,10 +207,10 @@ enum mods_codes { MODS_ONESHOT = 0x00, }; #define ACTION_KEY(key) ACTION(ACT_MODS, (key)) -#define ACTION_MODS(mods) ACTION(ACT_MODS, (mods&0x1f)<<8 | 0) -#define ACTION_MODS_KEY(mods, key) ACTION(ACT_MODS, (mods&0x1f)<<8 | (key)) -#define ACTION_MODS_TAP_KEY(mods, key) ACTION(ACT_MODS_TAP, (mods&0x1f)<<8 | (key)) -#define ACTION_MODS_ONESHOT(mods) ACTION(ACT_MODS_TAP, (mods&0x1f)<<8 | MODS_ONESHOT) +#define ACTION_MODS(mods) ACTION(ACT_MODS, ((mods)&0x1f)<<8 | 0) +#define ACTION_MODS_KEY(mods, key) ACTION(ACT_MODS, ((mods)&0x1f)<<8 | (key)) +#define ACTION_MODS_TAP_KEY(mods, key) ACTION(ACT_MODS_TAP, ((mods)&0x1f)<<8 | (key)) +#define ACTION_MODS_ONESHOT(mods) ACTION(ACT_MODS_TAP, ((mods)&0x1f)<<8 | MODS_ONESHOT) /* From 06681b0ab99ee8125f4f0fce452b9ebf25d6f17c Mon Sep 17 00:00:00 2001 From: tmk Date: Mon, 25 Nov 2013 17:39:45 +0900 Subject: [PATCH 11/18] Add printf macro as alias of xprintf --- common/print.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/common/print.h b/common/print.h index 930e84be..a828328b 100644 --- a/common/print.h +++ b/common/print.h @@ -40,6 +40,10 @@ #endif #define println(s) print_P(PSTR(s "\n")) +#ifndef AVR_LIBC_PRINTF +#define printf(f, ...) xprintf(f, ##__VA_ARGS__) +#endif + /* for old name */ #define pdec(data) print_dec(data) #define pdec16(data) print_dec(data) From 084bdb977e79f73d1103fde05e32daeb00bbdf74 Mon Sep 17 00:00:00 2001 From: tmk Date: Mon, 25 Nov 2013 17:43:26 +0900 Subject: [PATCH 12/18] Add ps2_busywait.c and recfactor PS/2 protocol --- protocol.mk | 2 +- protocol/ps2.c | 65 +++++++++------ protocol/ps2.h | 142 ++++++++++++++++++++++++++----- protocol/ps2_busywait.c | 179 ++++++++++++++++++++++++++++++++++++++++ 4 files changed, 342 insertions(+), 46 deletions(-) create mode 100644 protocol/ps2_busywait.c diff --git a/protocol.mk b/protocol.mk index 0d5f06c7..e3320087 100644 --- a/protocol.mk +++ b/protocol.mk @@ -8,7 +8,7 @@ ifdef PS2_MOUSE_ENABLE endif ifdef PS2_USE_BUSYWAIT - SRC += protocol/ps2.c + SRC += protocol/ps2_busywait.c OPT_DEFS += -DPS2_USE_BUSYWAIT endif diff --git a/protocol/ps2.c b/protocol/ps2.c index e5873a9b..4886b16d 100644 --- a/protocol/ps2.c +++ b/protocol/ps2.c @@ -91,6 +91,9 @@ uint8_t ps2_error = PS2_ERR_NONE; void ps2_host_init(void) { + // POR(150-2000ms) plus BAT(300-500ms) may take 2.5sec([3]p.20) + _delay_ms(2500); + #ifdef PS2_USE_INT PS2_INT_INIT(); PS2_INT_ON(); @@ -163,23 +166,11 @@ ERROR: /* receive data when host want else inhibit communication */ uint8_t ps2_host_recv_response(void) { + // Command might take 20ms to response([3]p.21) + // TrackPoint might take 25ms ([5]2.7) uint8_t data = 0; - -#ifdef PS2_USE_INT - PS2_INT_OFF(); -#endif - /* terminate a transmission if we have */ - inhibit(); - _delay_us(100); - - /* release lines(idle state) */ - idle(); - - /* wait start bit */ - wait_clock_lo(25000); // command response may take 20 ms at most - data = recv_data(); - - inhibit(); + uint8_t try = 200; + while (try-- && (data = ps2_host_recv())) ; return data; } #endif @@ -187,7 +178,17 @@ uint8_t ps2_host_recv_response(void) #ifndef PS2_USE_INT uint8_t ps2_host_recv(void) { - return ps2_host_recv_response(); + uint8_t data = 0; + + /* release lines(idle state) */ + idle(); + + /* wait start bit */ + wait_clock_lo(100); // TODO: this is enough? + data = recv_data(); + + inhibit(); + return data; } #else /* ring buffer to store ps/2 key data */ @@ -241,13 +242,6 @@ static inline void pbuf_clear(void) /* get data received by interrupt */ uint8_t ps2_host_recv(void) { - if (ps2_error) { - print("x"); - phex(ps2_error); - ps2_host_send(0xFE); // request to resend - ps2_error = PS2_ERR_NONE; - } - idle(); return pbuf_dequeue(); } @@ -450,3 +444,26 @@ static inline void inhibit(void) clock_lo(); data_hi(); } + + +/* PS/2 Resources + * + * [1] The PS/2 Mouse/Keyboard Protocol + * http://www.computer-engineering.org/ps2protocol/ + * Concise and thorough primer of PS/2 protocol. + * + * [2] Keyboard and Auxiliary Device Controller + * http://www.mcamafia.de/pdf/ibm_hitrc07.pdf + * Signal Timing and Format + * + * [3] Keyboards(101- and 102-key) + * http://www.mcamafia.de/pdf/ibm_hitrc11.pdf + * Keyboard Layout, Scan Code Set, POR, and Commands. + * + * [4] PS/2 Reference Manuals + * http://www.mcamafia.de/pdf/ibm_hitrc07.pdf + * Collection of IBM Personal System/2 documents. + * + * [5] TrackPoint Engineering Specifications for version 3E + * https://web.archive.org/web/20100526161812/http://wwwcssrv.almaden.ibm.com/trackpoint/download.html + */ diff --git a/protocol/ps2.h b/protocol/ps2.h index 83416535..b780d01a 100644 --- a/protocol/ps2.h +++ b/protocol/ps2.h @@ -1,5 +1,5 @@ /* -Copyright 2010,2011 Jun WAKO +Copyright 2010,2011,2012,2013 Jun WAKO This software is licensed with a Modified BSD License. All of this is supposed to be Free Software, Open Source, DFSG-free, @@ -37,12 +37,60 @@ POSSIBILITY OF SUCH DAMAGE. #ifndef PS2_H #define PS2_H + +#include +#include +#include + /* * Primitive PS/2 Library for AVR + * + * PS/2 Resources + * -------------- + * [1] The PS/2 Mouse/Keyboard Protocol + * http://www.computer-engineering.org/ps2protocol/ + * Concise and thorough primer of PS/2 protocol. + * + * [2] Keyboard and Auxiliary Device Controller + * http://www.mcamafia.de/pdf/ibm_hitrc07.pdf + * Signal Timing and Format + * + * [3] Keyboards(101- and 102-key) + * http://www.mcamafia.de/pdf/ibm_hitrc11.pdf + * Keyboard Layout, Scan Code Set, POR, and Commands. + * + * [4] PS/2 Reference Manuals + * http://www.mcamafia.de/pdf/ibm_hitrc07.pdf + * Collection of IBM Personal System/2 documents. + * + * [5] TrackPoint Engineering Specifications for version 3E + * https://web.archive.org/web/20100526161812/http://wwwcssrv.almaden.ibm.com/trackpoint/download.html */ +#define PS2_ACK 0xFA +#define PS2_RESEND 0xFE +#define PS2_SET_LED 0xED + +#define PS2_ERR_NONE 0 +#define PS2_ERR_STARTBIT1 1 +#define PS2_ERR_STARTBIT2 2 +#define PS2_ERR_STARTBIT3 3 +#define PS2_ERR_PARITY 0x10 + +#define PS2_LED_SCROLL_LOCK 0 +#define PS2_LED_NUM_LOCK 1 +#define PS2_LED_CAPS_LOCK 2 -/* port settings for clock and data line */ +extern uint8_t ps2_error; + +void ps2_host_init(void); +uint8_t ps2_host_send(uint8_t data); +uint8_t ps2_host_recv_response(void); +uint8_t ps2_host_recv(void); +void ps2_host_set_led(uint8_t usb_led); + + +/* Check port settings for clock and data line */ #if !(defined(PS2_CLOCK_PORT) && \ defined(PS2_CLOCK_PIN) && \ defined(PS2_CLOCK_DDR) && \ @@ -57,27 +105,79 @@ POSSIBILITY OF SUCH DAMAGE. # error "PS/2 data port setting is required in config.h" #endif -#define PS2_ACK 0xFA -#define PS2_RESEND 0xFE -#define PS2_SET_LED 0xED +/*-------------------------------------------------------------------- + * static functions + *------------------------------------------------------------------*/ +static inline void clock_lo(void) +{ + PS2_CLOCK_PORT &= ~(1< + +This software is licensed with a Modified BSD License. +All of this is supposed to be Free Software, Open Source, DFSG-free, +GPL-compatible, and OK to use in both free and proprietary applications. +Additions and corrections to this file are welcome. + + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + +* Neither the name of the copyright holders nor the names of + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +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. +*/ + +#include +#include +#include "ps2.h" +#include "debug.h" + + +/* + * PS/2 protocol busywait version + */ + +#define WAIT(stat, us, err) do { \ + if (!wait_##stat(us)) { \ + ps2_error = err; \ + goto ERROR; \ + } \ +} while (0) + +uint8_t ps2_error = PS2_ERR_NONE; + + +void ps2_host_init(void) +{ + // POR(150-2000ms) plus BAT(300-500ms) may take 2.5sec([3]p.20) + _delay_ms(2500); + + inhibit(); +} + +uint8_t ps2_host_send(uint8_t data) +{ + uint8_t res = 0; + bool parity = true; + ps2_error = PS2_ERR_NONE; + /* terminate a transmission if we have */ + inhibit(); + _delay_us(200); // at least 100us + + /* start bit [1] */ + data_lo(); + clock_hi(); + WAIT(clock_lo, 20000, 10); // may take 15ms at most until device starts clocking + /* data [2-9] */ + for (uint8_t i = 0; i < 8; i++) { + _delay_us(15); + if (data&(1< PS2_ERR_STARTBIT3) { + printf("x%02X\n", ps2_error); + } + inhibit(); + return 0; +} From 00c71f2d21adccda97206f646949a9adecdeae07 Mon Sep 17 00:00:00 2001 From: tmk Date: Tue, 26 Nov 2013 14:31:57 +0900 Subject: [PATCH 13/18] Fix ps2_host_recv_response --- common/print.h | 4 ---- protocol/ps2_busywait.c | 11 +++++++---- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/common/print.h b/common/print.h index a828328b..930e84be 100644 --- a/common/print.h +++ b/common/print.h @@ -40,10 +40,6 @@ #endif #define println(s) print_P(PSTR(s "\n")) -#ifndef AVR_LIBC_PRINTF -#define printf(f, ...) xprintf(f, ##__VA_ARGS__) -#endif - /* for old name */ #define pdec(data) print_dec(data) #define pdec16(data) print_dec(data) diff --git a/protocol/ps2_busywait.c b/protocol/ps2_busywait.c index 1e292588..5ab37787 100644 --- a/protocol/ps2_busywait.c +++ b/protocol/ps2_busywait.c @@ -104,6 +104,7 @@ uint8_t ps2_host_send(uint8_t data) WAIT(clock_hi, 50, 8); WAIT(data_hi, 50, 9); + inhibit(); res = ps2_host_recv_response(); ERROR: inhibit(); @@ -113,12 +114,14 @@ ERROR: /* receive data when host want else inhibit communication */ uint8_t ps2_host_recv_response(void) { - // TODO: // Command might take 20ms to response([3]p.21) // TrackPoint might take 25ms ([5]2.7) + // 250 * 100us(wait for start bit in ps2_host_recv) uint8_t data = 0; - uint8_t try = 200; - while (try-- && (data = ps2_host_recv())) ; + uint8_t try = 250; + do { + data = ps2_host_recv(); + } while (try-- && ps2_error); return data; } @@ -172,7 +175,7 @@ uint8_t ps2_host_recv(void) return data; ERROR: if (ps2_error > PS2_ERR_STARTBIT3) { - printf("x%02X\n", ps2_error); + xprintf("x%02X\n", ps2_error); } inhibit(); return 0; From 0b5af532ed4798c7a78a920e436048940fa1434c Mon Sep 17 00:00:00 2001 From: Benjamin Gould Date: Wed, 27 Nov 2013 00:24:57 -0500 Subject: [PATCH 14/18] Added bluefruit protocol and converter for 70% M --- protocol/bluefruit.mk | 27 +++++ protocol/bluefruit/bluefruit.c | 202 +++++++++++++++++++++++++++++++++ protocol/bluefruit/bluefruit.h | 28 +++++ protocol/bluefruit/main.c | 116 +++++++++++++++++++ 4 files changed, 373 insertions(+) create mode 100644 protocol/bluefruit.mk create mode 100644 protocol/bluefruit/bluefruit.c create mode 100644 protocol/bluefruit/bluefruit.h create mode 100644 protocol/bluefruit/main.c diff --git a/protocol/bluefruit.mk b/protocol/bluefruit.mk new file mode 100644 index 00000000..7e6328f6 --- /dev/null +++ b/protocol/bluefruit.mk @@ -0,0 +1,27 @@ +BLUEFRUIT_DIR = protocol/bluefruit +PJRC_DIR = protocol/pjrc + +SRC += $(BLUEFRUIT_DIR)/main.c \ + $(BLUEFRUIT_DIR)/bluefruit.c \ + serial_uart.c \ + $(PJRC_DIR)/pjrc.c \ + $(PJRC_DIR)/usb_keyboard.c \ + $(PJRC_DIR)/usb_debug.c \ + $(PJRC_DIR)/usb.c + +# Option modules +ifdef $(or MOUSEKEY_ENABLE, PS2_MOUSE_ENABLE) + SRC += $(PJRC_DIR)/usb_mouse.c +endif + +ifdef EXTRAKEY_ENABLE + SRC += $(PJRC_DIR)/usb_extra.c +endif + +# Search Path +VPATH += $(TOP_DIR)/$(BLUEFRUIT_DIR) +#VPATH += $(TOP_DIR)/$(BLUEFRUIT_DIR)/usb_debug_only +VPATH += $(TOP_DIR)/$(PJRC_DIR) + +OPT_DEFS += -DPROTOCOL_BLUEFRUIT +OPT_DEFS += -DPROTOCOL_PJRC diff --git a/protocol/bluefruit/bluefruit.c b/protocol/bluefruit/bluefruit.c new file mode 100644 index 00000000..bdc3de3e --- /dev/null +++ b/protocol/bluefruit/bluefruit.c @@ -0,0 +1,202 @@ +/* +Bluefruit Protocol for TMK firmware +Author: Benjamin Gould, 2013 +Based on code Copyright 2011 Jun Wako + +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 +the Free Software Foundation, either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +*/ + +#include +#include "host.h" +#include "report.h" +#include "print.h" +#include "debug.h" +#include "host_driver.h" +#include "serial.h" +#include "bluefruit.h" + +#define BLUEFRUIT_TRACE_SERIAL 1 + +static uint8_t bluefruit_keyboard_leds = 0; + +static void bluefruit_serial_send(uint8_t); + +void bluefruit_keyboard_print_report(report_keyboard_t *report) +{ + if (!debug_keyboard) return; + dprintf("keys: "); for (int i = 0; i < REPORT_KEYS; i++) { debug_hex8(report->keys[i]); dprintf(" "); } + dprintf(" mods: "); debug_hex8(report->mods); + dprintf(" reserved: "); debug_hex8(report->reserved); + dprintf("\n"); +} + +#ifdef BLUEFRUIT_TRACE_SERIAL +static void bluefruit_trace_header() +{ + dprintf("+------------------------------------+\n"); + dprintf("| HID report to Bluefruit via serial |\n"); + dprintf("+------------------------------------+\n|"); +} + +static void bluefruit_trace_footer() +{ + dprintf("|\n+------------------------------------+\n\n"); +} +#endif + +static void bluefruit_serial_send(uint8_t data) +{ +#ifdef BLUEFRUIT_TRACE_SERIAL + dprintf(" "); + debug_hex8(data); + dprintf(" "); +#endif + serial_send(data); +} + +/*------------------------------------------------------------------* + * Host driver + *------------------------------------------------------------------*/ + +static uint8_t keyboard_leds(void); +static void send_keyboard(report_keyboard_t *report); +static void send_mouse(report_mouse_t *report); +static void send_system(uint16_t data); +static void send_consumer(uint16_t data); + +static host_driver_t driver = { + keyboard_leds, + send_keyboard, + send_mouse, + send_system, + send_consumer +}; + +host_driver_t *bluefruit_driver(void) +{ + return &driver; +} + +static uint8_t keyboard_leds(void) { + return bluefruit_keyboard_leds; +} + +static void send_keyboard(report_keyboard_t *report) +{ +#ifdef BLUEFRUIT_TRACE_SERIAL + bluefruit_trace_header(); +#endif + bluefruit_serial_send(0xFD); + for (uint8_t i = 0; i < REPORT_SIZE; i++) { + bluefruit_serial_send(report->raw[i]); + } +#ifdef BLUEFRUIT_TRACE_SERIAL + bluefruit_trace_footer(); +#endif +} + +static void send_mouse(report_mouse_t *report) +{ +#ifdef BLUEFRUIT_TRACE_SERIAL + bluefruit_trace_header(); +#endif + bluefruit_serial_send(0xFD); + bluefruit_serial_send(0x00); + bluefruit_serial_send(0x03); + bluefruit_serial_send(report->buttons); + bluefruit_serial_send(report->x); + bluefruit_serial_send(report->y); + bluefruit_serial_send(report->v); // should try sending the wheel v here + bluefruit_serial_send(report->h); // should try sending the wheel h here + bluefruit_serial_send(0x00); +#ifdef BLUEFRUIT_TRACE_SERIAL + bluefruit_trace_footer(); +#endif +} + +static void send_system(uint16_t data) +{ +} + +/* ++-----------------+-------------------+-------+ +| Consumer Key | Bit Map | Hex | ++-----------------+-------------------+-------+ +| Home | 00000001 00000000 | 01 00 | +| KeyboardLayout | 00000010 00000000 | 02 00 | +| Search | 00000100 00000000 | 04 00 | +| Snapshot | 00001000 00000000 | 08 00 | +| VolumeUp | 00010000 00000000 | 10 00 | +| VolumeDown | 00100000 00000000 | 20 00 | +| Play/Pause | 01000000 00000000 | 40 00 | +| Fast Forward | 10000000 00000000 | 80 00 | +| Rewind | 00000000 00000001 | 00 01 | +| Scan Next Track | 00000000 00000010 | 00 02 | +| Scan Prev Track | 00000000 00000100 | 00 04 | +| Random Play | 00000000 00001000 | 00 08 | +| Stop | 00000000 00010000 | 00 10 | ++-------------------------------------+-------+ +*/ +#define CONSUMER2BLUEFRUIT(usage) \ + (usage == AUDIO_MUTE ? 0x0000 : \ + (usage == AUDIO_VOL_UP ? 0x1000 : \ + (usage == AUDIO_VOL_DOWN ? 0x2000 : \ + (usage == TRANSPORT_NEXT_TRACK ? 0x0002 : \ + (usage == TRANSPORT_PREV_TRACK ? 0x0004 : \ + (usage == TRANSPORT_STOP ? 0x0010 : \ + (usage == TRANSPORT_STOP_EJECT ? 0x0000 : \ + (usage == TRANSPORT_PLAY_PAUSE ? 0x4000 : \ + (usage == AL_CC_CONFIG ? 0x0000 : \ + (usage == AL_EMAIL ? 0x0000 : \ + (usage == AL_CALCULATOR ? 0x0000 : \ + (usage == AL_LOCAL_BROWSER ? 0x0000 : \ + (usage == AC_SEARCH ? 0x0400 : \ + (usage == AC_HOME ? 0x0100 : \ + (usage == AC_BACK ? 0x0000 : \ + (usage == AC_FORWARD ? 0x0000 : \ + (usage == AC_STOP ? 0x0000 : \ + (usage == AC_REFRESH ? 0x0000 : \ + (usage == AC_BOOKMARKS ? 0x0000 : 0))))))))))))))))))) + +static void send_consumer(uint16_t data) +{ + static uint16_t last_data = 0; + if (data == last_data) return; + last_data = data; + + uint16_t bitmap = CONSUMER2BLUEFRUIT(data); + +#ifdef BLUEFRUIT_TRACE_SERIAL + dprintf("\nData: "); + debug_hex16(data); + dprintf("; bitmap: "); + debug_hex16(bitmap); + dprintf("\n"); + bluefruit_trace_header(); +#endif + bluefruit_serial_send(0xFD); + bluefruit_serial_send(0x00); + bluefruit_serial_send(0x02); + bluefruit_serial_send((bitmap>>8)&0xFF); + bluefruit_serial_send(bitmap&0xFF); + bluefruit_serial_send(0x00); + bluefruit_serial_send(0x00); + bluefruit_serial_send(0x00); + bluefruit_serial_send(0x00); +#ifdef BLUEFRUIT_TRACE_SERIAL + bluefruit_trace_footer(); +#endif +} + diff --git a/protocol/bluefruit/bluefruit.h b/protocol/bluefruit/bluefruit.h new file mode 100644 index 00000000..4f9b5883 --- /dev/null +++ b/protocol/bluefruit/bluefruit.h @@ -0,0 +1,28 @@ +/* +Bluefruit Protocol for TMK firmware +Author: Benjamin Gould, 2013 +Based on code Copyright 2011 Jun Wako + +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 +the Free Software Foundation, either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + +#ifndef VUSB_H +#define VUSB_H + +#include "host_driver.h" + + +host_driver_t *bluefruit_driver(void); + +#endif diff --git a/protocol/bluefruit/main.c b/protocol/bluefruit/main.c new file mode 100644 index 00000000..871062ab --- /dev/null +++ b/protocol/bluefruit/main.c @@ -0,0 +1,116 @@ +/* +Bluefruit Protocol for TMK firmware +Author: Benjamin Gould, 2013 +Based on code Copyright 2011 Jun Wako + +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 +the Free Software Foundation, either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + +#include +#include +#include +#include +#include +#include "serial.h" +#include "keyboard.h" +#include "usb.h" +#include "host.h" +#include "timer.h" +#include "print.h" +#include "debug.h" +#include "sendchar.h" +#include "suspend.h" +#include "bluefruit.h" +#include "pjrc.h" + +#define CPU_PRESCALE(n) (CLKPR = 0x80, CLKPR = (n)) + +#define HOST_DRIVER_NOT_SET 0 +#define BLUEFRUIT_HOST_DRIVER 1 +#define PJRC_HOST_DRIVER 2 + +int main(void) +{ + + CPU_PRESCALE(0); + + DDRD = _BV(PD5); + DDRB = _BV(PB0); + + PORTD = _BV(PD5); + PORTB = _BV(PB0); + + print_set_sendchar(sendchar); + + usb_init(); + _delay_ms(2000); + // while (!usb_configured()) /* wait */ + + dprintf("Initializing keyboard...\n"); + keyboard_init(); + + // This implementation is pretty simplistic... if the USB connection + // is not configured, choose the Bluefruit, otherwise use USB + // Definitely would prefer to have this driven by an input pin and make + // it switch dynamically - BCG + if (!usb_configured()) { + + // Send power to Bluefruit... Adafruit says it takes 27 mA, I think + // the pins should provide 40 mA, but just in case I switch the + // Bluefruit using a transistor - BCG + DDRB = _BV(PB6); + PORTB |= _BV(PB6); + + dprintf("Setting host driver to bluefruit...\n"); + host_set_driver(bluefruit_driver()); + + dprintf("Initializing serial...\n"); + serial_init(); + + // wait an extra second for the PC's operating system + // to load drivers and do whatever it does to actually + // be ready for input + _delay_ms(1000); + PORTD = ~_BV(PD5); + dprintf("Starting main loop"); + while (1) { + keyboard_task(); + } + + } else { + + // I'm not smart enough to get this done with LUFA - BCG + dprintf("Setting host driver to PJRC...\n"); + host_set_driver(pjrc_driver()); +#ifdef SLEEP_LED_ENABLE + sleep_led_init(); +#endif + // wait an extra second for the PC's operating system + // to load drivers and do whatever it does to actually + // be ready for input + _delay_ms(1000); + PORTB = ~_BV(PB0); + dprintf("Starting main loop"); + while (1) { + while (suspend) { + suspend_power_down(); + if (remote_wakeup && suspend_wakeup_condition()) { + usb_remote_wakeup(); + } + } + keyboard_task(); + } + } + +} From a28376e93042a790ca45f2a36a7659150a2edbdb Mon Sep 17 00:00:00 2001 From: Benjamin Gould Date: Wed, 27 Nov 2013 00:32:20 -0500 Subject: [PATCH 15/18] changed tabs to spaces in bluefruit.c --- protocol/bluefruit/bluefruit.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/protocol/bluefruit/bluefruit.c b/protocol/bluefruit/bluefruit.c index bdc3de3e..f991e4d0 100644 --- a/protocol/bluefruit/bluefruit.c +++ b/protocol/bluefruit/bluefruit.c @@ -45,14 +45,14 @@ void bluefruit_keyboard_print_report(report_keyboard_t *report) #ifdef BLUEFRUIT_TRACE_SERIAL static void bluefruit_trace_header() { - dprintf("+------------------------------------+\n"); - dprintf("| HID report to Bluefruit via serial |\n"); - dprintf("+------------------------------------+\n|"); + dprintf("+------------------------------------+\n"); + dprintf("| HID report to Bluefruit via serial |\n"); + dprintf("+------------------------------------+\n|"); } static void bluefruit_trace_footer() { - dprintf("|\n+------------------------------------+\n\n"); + dprintf("|\n+------------------------------------+\n\n"); } #endif @@ -103,7 +103,7 @@ static void send_keyboard(report_keyboard_t *report) bluefruit_serial_send(report->raw[i]); } #ifdef BLUEFRUIT_TRACE_SERIAL - bluefruit_trace_footer(); + bluefruit_trace_footer(); #endif } From 7d193e2440f46ab5cc4e588f34ccfe5eeecfc060 Mon Sep 17 00:00:00 2001 From: tmk Date: Thu, 28 Nov 2013 10:42:41 +0900 Subject: [PATCH 16/18] Add ps2_usart.c and fix set_led at USB wake --- protocol/lufa/lufa.c | 4 +- protocol/pjrc/usb.c | 3 +- protocol/ps2.h | 2 + protocol/ps2_usart.c | 146 +++++++------------------------------------ 4 files changed, 29 insertions(+), 126 deletions(-) diff --git a/protocol/lufa/lufa.c b/protocol/lufa/lufa.c index 04e8e78f..eca51c87 100644 --- a/protocol/lufa/lufa.c +++ b/protocol/lufa/lufa.c @@ -148,7 +148,6 @@ static void Console_Task(void) */ void EVENT_USB_Device_Connect(void) { - led_set(0x1f); // all on } void EVENT_USB_Device_Disconnect(void) @@ -172,8 +171,9 @@ void EVENT_USB_Device_WakeUp() #ifdef SLEEP_LED_ENABLE sleep_led_disable(); -#endif + // NOTE: converters may not accept this led_set(host_keyboard_leds()); +#endif } void EVENT_USB_Device_StartOfFrame(void) diff --git a/protocol/pjrc/usb.c b/protocol/pjrc/usb.c index 84c99972..393b36f7 100644 --- a/protocol/pjrc/usb.c +++ b/protocol/pjrc/usb.c @@ -662,8 +662,9 @@ ISR(USB_GEN_vect) suspend_wakeup_init(); #ifdef SLEEP_LED_ENABLE sleep_led_disable(); -#endif + // NOTE: converters may not accept this led_set(host_keyboard_leds()); +#endif UDIEN |= (1< #include #include @@ -75,18 +58,6 @@ http://www.mcamafia.de/pdf/ibm_hitrc07.pdf uint8_t ps2_error = PS2_ERR_NONE; -static inline void clock_lo(void); -static inline void clock_hi(void); -static inline bool clock_in(void); -static inline void data_lo(void); -static inline void data_hi(void); -static inline bool data_in(void); -static inline uint16_t wait_clock_lo(uint16_t us); -static inline uint16_t wait_clock_hi(uint16_t us); -static inline uint16_t wait_data_lo(uint16_t us); -static inline uint16_t wait_data_hi(uint16_t us); -static inline void idle(void); -static inline void inhibit(void); static inline uint8_t pbuf_dequeue(void); static inline void pbuf_enqueue(uint8_t data); static inline bool pbuf_has_data(void); @@ -95,14 +66,15 @@ static inline void pbuf_clear(void); void ps2_host_init(void) { - idle(); + idle(); // without this many USART errors occur when cable is disconnected PS2_USART_INIT(); PS2_USART_RX_INT_ON(); + // POR(150-2000ms) plus BAT(300-500ms) may take 2.5sec([3]p.20) + //_delay_ms(2500); } uint8_t ps2_host_send(uint8_t data) { - uint8_t res = 0; bool parity = true; ps2_error = PS2_ERR_NONE; @@ -144,20 +116,22 @@ uint8_t ps2_host_send(uint8_t data) WAIT(clock_hi, 50, 8); WAIT(data_hi, 50, 9); + idle(); PS2_USART_INIT(); PS2_USART_RX_INT_ON(); - res = ps2_host_recv_response(); + return ps2_host_recv_response(); ERROR: idle(); PS2_USART_INIT(); PS2_USART_RX_INT_ON(); - return res; + return 0; } // Do polling data from keyboard to get response to last command. uint8_t ps2_host_recv_response(void) { - while (!pbuf_has_data()) { + uint8_t retry = 25; + while (retry-- && !pbuf_has_data()) { _delay_ms(1); // without this delay it seems to fall into deadlock } return pbuf_dequeue(); @@ -165,106 +139,32 @@ uint8_t ps2_host_recv_response(void) uint8_t ps2_host_recv(void) { - return pbuf_dequeue(); + if (pbuf_has_data()) { + ps2_error = PS2_ERR_NONE; + return pbuf_dequeue(); + } else { + ps2_error = PS2_ERR_NODATA; + return 0; + } } ISR(PS2_USART_RX_VECT) { - uint8_t error = PS2_USART_ERROR; + // TODO: request RESEND when error occurs? + uint8_t error = PS2_USART_ERROR; // USART error should be read before data uint8_t data = PS2_USART_RX_DATA; if (!error) { pbuf_enqueue(data); + } else { + xprintf("PS2 USART error: %02X data: %02X\n", error, data); } } /* send LED state to keyboard */ void ps2_host_set_led(uint8_t led) { - // send 0xED then keyboard keeps waiting for next LED data - // and keyboard does not send any scan codes during waiting. - // If fail to send LED data keyboard looks like being freezed. - uint8_t retry = 3; - while (retry-- && ps2_host_send(PS2_SET_LED) != PS2_ACK) - ; - retry = 3; - while (retry-- && ps2_host_send(led) != PS2_ACK) - ; -} - - -/*-------------------------------------------------------------------- - * static functions - *------------------------------------------------------------------*/ -static inline void clock_lo() -{ - PS2_CLOCK_PORT &= ~(1< Date: Thu, 28 Nov 2013 14:20:00 +0900 Subject: [PATCH 17/18] Add ps2_interrupt.c --- protocol.mk | 2 +- protocol/ps2_busywait.c | 51 ++-- protocol/{ps2.c => ps2_interrupt.c} | 358 +++++++--------------------- protocol/ps2_usart.c | 23 +- 4 files changed, 124 insertions(+), 310 deletions(-) rename protocol/{ps2.c => ps2_interrupt.c} (51%) diff --git a/protocol.mk b/protocol.mk index e3320087..7f561e62 100644 --- a/protocol.mk +++ b/protocol.mk @@ -13,7 +13,7 @@ ifdef PS2_USE_BUSYWAIT endif ifdef PS2_USE_INT - SRC += protocol/ps2.c + SRC += protocol/ps2_interrupt.c OPT_DEFS += -DPS2_USE_INT endif diff --git a/protocol/ps2_busywait.c b/protocol/ps2_busywait.c index 5ab37787..05dd7b27 100644 --- a/protocol/ps2_busywait.c +++ b/protocol/ps2_busywait.c @@ -35,16 +35,16 @@ ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +/* + * PS/2 protocol busywait version + */ + #include #include #include "ps2.h" #include "debug.h" -/* - * PS/2 protocol busywait version - */ - #define WAIT(stat, us, err) do { \ if (!wait_##stat(us)) { \ ps2_error = err; \ @@ -52,6 +52,7 @@ POSSIBILITY OF SUCH DAMAGE. } \ } while (0) + uint8_t ps2_error = PS2_ERR_NONE; @@ -65,18 +66,19 @@ void ps2_host_init(void) uint8_t ps2_host_send(uint8_t data) { - uint8_t res = 0; bool parity = true; ps2_error = PS2_ERR_NONE; + /* terminate a transmission if we have */ inhibit(); - _delay_us(200); // at least 100us + _delay_us(100); // 100us [4]p.13, [5]p.50 - /* start bit [1] */ + /* 'Request to Send' and Start bit */ data_lo(); clock_hi(); - WAIT(clock_lo, 20000, 10); // may take 15ms at most until device starts clocking - /* data [2-9] */ + WAIT(clock_lo, 10000, 10); // 10ms [5]p.50 + + /* Data bit */ for (uint8_t i = 0; i < 8; i++) { _delay_us(15); if (data&(1< -#include -#include #include #include "ps2.h" #include "debug.h" -#ifndef PS2_USE_INT -static uint8_t recv_data(void); -#endif -static inline void clock_lo(void); -static inline void clock_hi(void); -static inline bool clock_in(void); -static inline void data_lo(void); -static inline void data_hi(void); -static inline bool data_in(void); -static inline uint16_t wait_clock_lo(uint16_t us); -static inline uint16_t wait_clock_hi(uint16_t us); -static inline uint16_t wait_data_lo(uint16_t us); -static inline uint16_t wait_data_hi(uint16_t us); -static inline void idle(void); -static inline void inhibit(void); - - -/* -Primitive PS/2 Library for AVR -============================== -Host side is only supported now. - - -I/O control ------------ -High state is asserted by input with pull up. - - -PS/2 References ---------------- -http://www.computer-engineering.org/ps2protocol/ -http://www.mcamafia.de/pdf/ibm_hitrc07.pdf -*/ - - #define WAIT(stat, us, err) do { \ if (!wait_##stat(us)) { \ ps2_error = err; \ @@ -89,38 +56,38 @@ http://www.mcamafia.de/pdf/ibm_hitrc07.pdf uint8_t ps2_error = PS2_ERR_NONE; +static inline uint8_t pbuf_dequeue(void); +static inline void pbuf_enqueue(uint8_t data); +static inline bool pbuf_has_data(void); +static inline void pbuf_clear(void); + + void ps2_host_init(void) { - // POR(150-2000ms) plus BAT(300-500ms) may take 2.5sec([3]p.20) - _delay_ms(2500); - -#ifdef PS2_USE_INT + idle(); PS2_INT_INIT(); PS2_INT_ON(); - idle(); -#else - inhibit(); -#endif + // POR(150-2000ms) plus BAT(300-500ms) may take 2.5sec([3]p.20) + //_delay_ms(2500); } -// TODO: send using interrupt if available uint8_t ps2_host_send(uint8_t data) { - uint8_t res = 0; bool parity = true; ps2_error = PS2_ERR_NONE; -#ifdef PS2_USE_INT + PS2_INT_OFF(); -#endif + /* terminate a transmission if we have */ inhibit(); - _delay_us(200); // at least 100us + _delay_us(100); // 100us [4]p.13, [5]p.50 - /* start bit [1] */ + /* 'Request to Send' and Start bit */ data_lo(); clock_hi(); - WAIT(clock_lo, 20000, 10); // may take 15ms at most until device starts clocking - /* data [2-9] */ + WAIT(clock_lo, 10000, 10); // 10ms [5]p.50 + + /* Data bit[2-9] */ for (uint8_t i = 0; i < 8; i++) { _delay_us(15); if (data&(1< Date: Thu, 28 Nov 2013 14:44:59 +0900 Subject: [PATCH 18/18] Add included header file and fix debug print --- protocol/ps2_interrupt.c | 5 +++-- protocol/ps2_usart.c | 5 ++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/protocol/ps2_interrupt.c b/protocol/ps2_interrupt.c index 355d4e82..259d2540 100644 --- a/protocol/ps2_interrupt.c +++ b/protocol/ps2_interrupt.c @@ -40,9 +40,10 @@ POSSIBILITY OF SUCH DAMAGE. */ #include +#include #include #include "ps2.h" -#include "debug.h" +#include "print.h" #define WAIT(stat, us, err) do { \ @@ -241,7 +242,7 @@ static inline void pbuf_enqueue(uint8_t data) pbuf[pbuf_head] = data; pbuf_head = next; } else { - debug("pbuf: full\n"); + print("pbuf: full\n"); } SREG = sreg; } diff --git a/protocol/ps2_usart.c b/protocol/ps2_usart.c index 27947143..c2d9d0a2 100644 --- a/protocol/ps2_usart.c +++ b/protocol/ps2_usart.c @@ -40,11 +40,10 @@ POSSIBILITY OF SUCH DAMAGE. */ #include -#include #include #include #include "ps2.h" -#include "debug.h" +#include "print.h" #define WAIT(stat, us, err) do { \ @@ -188,7 +187,7 @@ static inline void pbuf_enqueue(uint8_t data) pbuf[pbuf_head] = data; pbuf_head = next; } else { - debug("pbuf: full\n"); + print("pbuf: full\n"); } SREG = sreg; }