added serial mouse driver for Microsoft and Mousesystems mice

 * Both drivers use the interface defined in serial_mouse.h
 * They should work with any UART implementation (hardware/software UART)
 * The Microsoft driver is currently untested.
   The Mousesystems driver is confirmed to work.

3 files changed, 291 insertions, 0 deletions

diff --git a/protocol/serial_mouse.h b/protocol/serial_mouse.h
new file mode 100644
index 0000000000..c3c19d7696
--- /dev/null
+++ b/protocol/serial_mouse.h
@@ -0,0 +1,26 @@
+/*
+Copyright 2011 Jun Wako <wakojun@gmail.com>
+
+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 <http://www.gnu.org/licenses/>.
+*/
+
+#ifndef SERIAL_MOUSE_H
+#define SERIAL_MOUSE_H
+
+#include <stdint.h>
+
+uint8_t serial_mouse_init(void);
+void serial_mouse_task(void);
+
+#endif
diff --git a/protocol/serial_mouse_microsoft.c b/protocol/serial_mouse_microsoft.c
new file mode 100644
index 0000000000..6b3f80648b
--- /dev/null
+++ b/protocol/serial_mouse_microsoft.c
@@ -0,0 +1,125 @@
+/*
+Copyright 2011,2013 Jun Wako <wakojun@gmail.com>
+
+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 <http://www.gnu.org/licenses/>.
+*/
+
+#include <stdint.h>
+#include <avr/io.h>
+#include <util/delay.h>
+
+#include "serial.h"
+#include "serial_mouse.h"
+#include "report.h"
+#include "host.h"
+#include "timer.h"
+#include "print.h"
+#include "debug.h"
+
+static void print_usb_data(const report_mouse_t *report);
+
+uint8_t serial_mouse_init(void)
+{
+    serial_init();
+    return 0;
+}
+
+void serial_mouse_task(void)
+{
+    /* 3 byte ring buffer */
+    static uint8_t buffer[3];
+    static int buffer_cur = 0;
+
+    static report_mouse_t report = {};
+
+    int16_t rcv;
+
+    rcv = serial_recv2();
+    if (rcv < 0)
+        /* no new data */
+        return;
+
+    if (debug_mouse)
+        xprintf("serial_mouse: byte: %04X\n", rcv);
+
+    /*
+     * If bit 6 is one, this signals the beginning
+     * of a 3 byte sequence/packet.
+     */
+    if (rcv & (1 << 6))
+        buffer_cur = 0;
+
+    buffer[buffer_cur] = (uint8_t)rcv;
+
+    if (buffer_cur == 0 && buffer[buffer_cur] == 0x20) {
+        /*
+         * Logitech extension: This must be a follow-up on
+         * the last 3-byte packet signaling a middle button click
+         */
+        report.buttons |= MOUSE_BTN3;
+        report.x = report.y = 0;
+
+        print_usb_data(&report);
+        host_mouse_send(&report);
+        return;
+    }
+
+    buffer_cur++;
+
+    if (buffer_cur < 3)
+        return;
+    buffer_cur = 0;
+
+    /*
+     * parse 3 byte packet.
+     * NOTE: We only get a complete packet
+     * if the mouse moved or the button states
+     * change.
+     */
+    report.buttons = 0;
+    if (buffer[0] & (1 << 5))
+        report.buttons |= MOUSE_BTN1;
+    if (buffer[0] & (1 << 4))
+        report.buttons |= MOUSE_BTN2;
+
+    report.x = (buffer[0] << 6) | buffer[1];
+    report.y = ((buffer[0] << 4) & 0xC0) | buffer[2];
+
+    /* USB HID uses values from -127 to 127 only */
+    report.x = report.x < -127 ? -127 : report.x;
+    report.y = report.y < -127 ? -127 : report.y;
+
+#if 0
+    if (!report.buttons && !report.x && !report.y) {
+        /*
+         * Microsoft extension: Middle mouse button pressed
+         * FIXME: I don't know how exactly this extension works.
+         */
+        report.buttons |= MOUSE_BTN3;
+    }
+#endif
+
+    print_usb_data(&report);
+    host_mouse_send(&report);
+}
+
+static void print_usb_data(const report_mouse_t *report)
+{
+    if (!debug_mouse)
+        return;
+
+    xprintf("serial_mouse usb: [%02X|%d %d %d %d]\n",
+            report->buttons, report->x, report->y,
+            report->v, report->h);
+}
diff --git a/protocol/serial_mouse_mousesystems.c b/protocol/serial_mouse_mousesystems.c
new file mode 100644
index 0000000000..ec708c911f
--- /dev/null
+++ b/protocol/serial_mouse_mousesystems.c
@@ -0,0 +1,140 @@
+/*
+Copyright 2011,2013 Jun Wako <wakojun@gmail.com>
+
+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 <http://www.gnu.org/licenses/>.
+*/
+
+#include <stdint.h>
+#include <avr/io.h>
+#include <util/delay.h>
+
+#include "serial.h"
+#include "serial_mouse.h"
+#include "report.h"
+#include "host.h"
+#include "timer.h"
+#include "print.h"
+#include "debug.h"
+
+#define SERIAL_MOUSE_CENTER_SCROLL
+
+static void print_usb_data(const report_mouse_t *report);
+
+uint8_t serial_mouse_init(void)
+{
+    serial_init();
+    return 0;
+}
+
+void serial_mouse_task(void)
+{
+    /* 5 byte ring buffer */
+    static uint8_t buffer[5];
+    static int buffer_cur = 0;
+
+    int16_t rcv;
+
+    report_mouse_t report = {0, 0, 0, 0, 0};
+
+    rcv = serial_recv2();
+    if (rcv < 0)
+        /* no new data */
+        return;
+
+    if (debug_mouse)
+        xprintf("serial_mouse: byte: %04X\n", rcv);
+
+    /*
+     * Synchronization: mouse(4) says that all
+     * bytes but the first one in the packet have
+     * bit 7 == 0, but this is untrue.
+     * Therefore we discard all bytes up to the
+     * first one with the characteristic bit pattern.
+     */
+    if (buffer_cur == 0 && (rcv >> 3) != 0x10)
+        return;
+
+    buffer[buffer_cur++] = (uint8_t)rcv;
+
+    if (buffer_cur < 5)
+        return;
+    buffer_cur = 0;
+
+#ifdef SERIAL_MOUSE_CENTER_SCROLL
+    if ((buffer[0] & 0x7) == 0x5 && (buffer[1] || buffer[2])) {
+        report.h = (int8_t)buffer[1];
+        /* USB HID uses only values from -127 to 127 */
+        report.h = report.h < -127 ? -127 : report.h;
+        report.v = (int8_t)buffer[2];
+        report.v = report.v < -127 ? -127 : report.v;
+
+        print_usb_data(&report);
+        host_mouse_send(&report);
+
+        if (buffer[3] || buffer[4]) {
+            report.h = (int8_t)buffer[3];
+            report.h = report.h < -127 ? -127 : report.h;
+            report.v = (int8_t)buffer[4];
+            report.v = report.v < -127 ? -127 : report.v;
+
+            print_usb_data(&report);
+            host_mouse_send(&report);
+        }
+
+        return;
+    }
+#endif
+
+    /*
+     * parse 5 byte packet.
+     * NOTE: We only get a complete packet
+     * if the mouse moved or the button states
+     * change.
+     */
+    if (!(buffer[0] & (1 << 2)))
+        report.buttons |= MOUSE_BTN1;
+    if (!(buffer[0] & (1 << 1)))
+        report.buttons |= MOUSE_BTN3;
+    if (!(buffer[0] & (1 << 0)))
+        report.buttons |= MOUSE_BTN2;
+
+    report.x = (int8_t)buffer[1];
+    /* USB HID uses only values from -127 to 127 */
+    report.x = report.x < -127 ? -127 : report.x;
+    report.y = -(int8_t)buffer[2];
+    report.y = report.y < -127 ? -127 : report.y;
+
+    print_usb_data(&report);
+    host_mouse_send(&report);
+
+    if (buffer[3] || buffer[4]) {
+        report.x = (int8_t)buffer[3];
+        report.x = report.x < -127 ? -127 : report.x;
+        report.y = -(int8_t)buffer[4];
+        report.y = report.y < -127 ? -127 : report.y;
+
+        print_usb_data(&report);
+        host_mouse_send(&report);
+    }
+}
+
+static void print_usb_data(const report_mouse_t *report)
+{
+    if (!debug_mouse)
+        return;
+
+    xprintf("serial_mouse usb: [%02X|%d %d %d %d]\n",
+            report->buttons, report->x, report->y,
+            report->v, report->h);
+}