Fix to build ps2_mouse with both LUFA and PJRC

- change API of ps2_mouse; ps2_mouse_task()
- remove mouse_report from host.c

8 files changed, 119 insertions, 108 deletions

diff --git a/common/action.c b/common/action.c
index f7ae85b941..485abf81e3 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 d57f4a86ff..077711c231 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 0703dba013..1eafef75cc 100644
--- a/common/host.c
+++ b/common/host.c
@@ -27,9 +27,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 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 c1a0fbac40..8ff2629852 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 63a58b2187..2b66f20a01 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 3068fc5e37..017be94116 100644
--- a/common/mousekey.c
+++ b/common/mousekey.c
@@ -26,6 +26,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
 
+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 5e0b3657ca..ff730196c6 100644
--- a/protocol/ps2_mouse.c
+++ b/protocol/ps2_mouse.c
@@ -20,7 +20,8 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include<util/delay.h>
 #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 <http://www.gnu.org/licenses/>.
 #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 report_mouse_t mouse_report = {};
 
-static uint8_t ps2_mouse_btn_prev = 0;
 
+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)
+/* scroll support 
+ * TODO: should be build option
+ */
+#define PS2_MOUSE_SCROLL_BUTTON 0x04
+#define X_IS_NEG  (mouse_report.buttons & (1<<PS2_MOUSE_X_SIGN))
+#define Y_IS_NEG  (mouse_report.buttons & (1<<PS2_MOUSE_Y_SIGN))
+#define X_IS_OVF  (mouse_report.buttons & (1<<PS2_MOUSE_X_OVFLW))
+#define Y_IS_OVF  (mouse_report.buttons & (1<<PS2_MOUSE_Y_OVFLW))
+void ps2_mouse_task(void)
 {
+    enum { SCROLL_NONE, SCROLL_BTN, SCROLL_SENT };
+    static uint8_t scroll_state = SCROLL_NONE;
+    static uint8_t buttons_prev = 0;
+
+    /* 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;
+    }
 
-    if (!ps2_mouse_enable) return 1;
+    /* if mouse moves or buttons state changes */
+    if (mouse_report.x || mouse_report.y ||
+            ((mouse_report.buttons ^ buttons_prev) & PS2_MOUSE_BTN_MASK)) {
 
-    rcv = ps2_host_send(0xEB);
+        ps2_mouse_print_raw_data();
 
-    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;
-}
+        buttons_prev = mouse_report.buttons;
 
-bool ps2_mouse_changed(void)
-{
-    return (ps2_mouse_x || ps2_mouse_y || (ps2_mouse_btn & PS2_MOUSE_BTN_MASK) != ps2_mouse_btn_prev);
-}
+        // 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);
 
-#define PS2_MOUSE_SCROLL_BUTTON 0x04
-void ps2_mouse_usb_send(void)
-{
-    static bool scrolled = false;
-
-    if (!ps2_mouse_enable) return;
-
-    if (ps2_mouse_changed()) {
-        int8_t x, y, v, h;
-        x = y = v = h = 0;
-
-        // convert scale of X, Y: PS/2(-256/255) -> USB(-127/127)
-        if (ps2_mouse_btn & (1<<PS2_MOUSE_X_SIGN))
-            x = ps2_mouse_x > 128 ? (int8_t)ps2_mouse_x : -127;
-        else
-            x = ps2_mouse_x < 128 ? (int8_t)ps2_mouse_x : 127;
-
-        if (ps2_mouse_btn & (1<<PS2_MOUSE_Y_SIGN))
-            y = ps2_mouse_y > 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);
+        // 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 (!scrolled && (ps2_mouse_btn_prev & PS2_MOUSE_SCROLL_BUTTON)) {
-            usb_mouse_send(0,0,0,0, PS2_MOUSE_SCROLL_BUTTON);
+        } 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);
-            usb_mouse_send(0,0,0,0, 0);
+            mouse_report.buttons &= ~PS2_MOUSE_SCROLL_BUTTON;
+            host_mouse_send(&mouse_report);
         } else { 
-            scrolled = false;
-            usb_mouse_send(x, y, 0, 0, ps2_mouse_btn & PS2_MOUSE_BTN_MASK);
-        }
+            scroll_state = SCROLL_NONE;
 
-        ps2_mouse_btn_prev = (ps2_mouse_btn & PS2_MOUSE_BTN_MASK);
-        ps2_mouse_print();
+            host_mouse_send(&mouse_report);
+        }
+        ps2_mouse_print_usb_data();
     }
-    ps2_mouse_x = 0;
-    ps2_mouse_y = 0;
-    ps2_mouse_btn = 0;
+    // clear report
+    mouse_report.x = 0;
+    mouse_report.y = 0;
+    mouse_report.v = 0;
+    mouse_report.h = 0;
+    mouse_report.buttons = 0;
+}
+
+static void ps2_mouse_print_raw_data(void)
+{
+    if (!debug_mouse) return;
+    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");
 }
 
-void ps2_mouse_print(void)
+static void ps2_mouse_print_usb_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 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 4529ce1132..305a9bdbaa 100644
--- a/protocol/ps2_mouse.h
+++ b/protocol/ps2_mouse.h
@@ -20,6 +20,16 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 #include <stdbool.h>
 
+#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 <http://www.gnu.org/licenses/>.
 #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