Add mouse support to ADB

Adding the makefile options ADB_MOUSE_ENABLE and ADB_MOUSE_ACCMAX.
Might have gone overboard with comments, and tried but failed at not
adding more than necessary outside the converter/adb_usb/ folder.

8 files changed, 114 insertions, 1 deletions

diff --git a/converter/adb_usb/Makefile b/converter/adb_usb/Makefile
index a16873dc03..2369ee70ac 100644
--- a/converter/adb_usb/Makefile
+++ b/converter/adb_usb/Makefile
@@ -122,6 +122,10 @@ CONSOLE_ENABLE = yes	# Console for debug(+400)
 COMMAND_ENABLE = yes    # Commands for debug and configuration
 #SLEEP_LED_ENABLE = yes  # Breathing sleep LED during USB suspend
 #NKRO_ENABLE = yes	# USB Nkey Rollover
+ADB_MOUSE_ENABLE = yes
+
+# ADB Mice need acceleration for todays much bigger screens. 
+OPT_DEFS += -DADB_MOUSE_MAXACC=8
 
 
 # Optimize size but this may cause error "relocation truncated to fit"
diff --git a/converter/adb_usb/Makefile.pjrc b/converter/adb_usb/Makefile.pjrc
index b54ea142c5..c320c09d25 100644
--- a/converter/adb_usb/Makefile.pjrc
+++ b/converter/adb_usb/Makefile.pjrc
@@ -57,6 +57,10 @@ CONSOLE_ENABLE = yes    # Console for debug
 COMMAND_ENABLE = yes    # Commands for debug and configuration
 #SLEEP_LED_ENABLE = yes  # Breathing sleep LED during USB suspend
 #NKRO_ENABLE = yes	# USB Nkey Rollover(+500)
+ADB_MOUSE_ENABLE = yes
+
+# ADB Mice need acceleration for todays much bigger screens. 
+OPT_DEFS += -DADB_MOUSE_MAXACC=8
 
 
 # Search Path
diff --git a/converter/adb_usb/matrix.c b/converter/adb_usb/matrix.c
index 405391865f..6220ee6e1c 100644
--- a/converter/adb_usb/matrix.c
+++ b/converter/adb_usb/matrix.c
@@ -27,6 +27,8 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include "debug.h"
 #include "adb.h"
 #include "matrix.h"
+#include "report.h"
+#include "host.h"
 
 
 #if (MATRIX_COLS > 16)
@@ -38,6 +40,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
 static bool is_modified = false;
+static report_mouse_t mouse_report = {};
 
 // matrix state buffer(1:on, 0:off)
 #if (MATRIX_COLS <= 8)
@@ -86,6 +89,64 @@ void matrix_init(void)
     return;
 }
 
+#ifdef ADB_MOUSE_ENABLE
+
+#ifdef MAX
+#undef MAX
+#endif
+#define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
+
+void adb_mouse_task(void)
+{
+    uint16_t codes;
+    int16_t x, y;
+    static int8_t mouseacc; 
+    _delay_ms(12);  // delay for preventing overload of poor ADB keyboard controller
+    codes = adb_host_mouse_recv();
+    // If nothing received reset mouse acceleration, and quit. 
+    if (!codes) {
+        mouseacc = 1;
+        return;
+    };
+    // Bit sixteen is button.
+    if (~codes & (1 << 15))
+        mouse_report.buttons |= MOUSE_BTN1;
+    if (codes & (1 << 15))
+        mouse_report.buttons &= ~MOUSE_BTN1;
+    // lower seven bits are movement, as signed int_7. 
+    // low byte is X-axis, high byte is Y. 
+    y = (codes>>8 & 0x3F);
+    x = (codes>>0 & 0x3F);
+    // bit seven and fifteen is negative
+    // usb does not use int_8, but int_7 (measuring distance) with sign-bit. 
+    if (codes & (1 << 6))
+          x = (x-0x40);
+    if (codes & (1 << 14))
+         y = (y-0x40);
+    // Accelerate mouse. (They weren't meant to be used on screens larger than 320x200).
+    x *= mouseacc;
+    y *= mouseacc;
+    // Cap our two bytes per axis to one byte. 
+    // 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)
+    mouse_report.x = -MAX(-MAX(x, -127), -127);
+    mouse_report.y = -MAX(-MAX(y, -127), -127);
+    if (debug_mouse) {
+            print("adb_host_mouse_recv: "); print_bin16(codes); print("\n");
+            print("adb_mouse raw: [");
+            phex(mouseacc); print(" ");
+            phex(mouse_report.buttons); print("|");
+            print_decs(mouse_report.x); print(" ");
+            print_decs(mouse_report.y); print("]\n");
+    }
+    // Send result by usb. 
+    host_mouse_send(&mouse_report);
+    // increase acceleration of mouse
+    mouseacc += ( mouseacc < ADB_MOUSE_MAXACC ? 1 : 0 );
+    return;
+}
+#endif
+
 uint8_t matrix_scan(void)
 {
     /* extra_key is volatile and more convoluted than necessary because gcc refused
diff --git a/tmk_core/common/keyboard.c b/tmk_core/common/keyboard.c
index f0ead604ec..b03b124d76 100644
--- a/tmk_core/common/keyboard.c
+++ b/tmk_core/common/keyboard.c
@@ -39,6 +39,9 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #ifdef SERIAL_MOUSE_ENABLE
 #include "serial_mouse.h"
 #endif
+#ifdef ADB_MOUSE_ENABLE
+#include "adb.h"
+#endif
 
 
 #ifdef MATRIX_HAS_GHOST
@@ -69,6 +72,9 @@ void keyboard_init(void)
 #ifdef SERIAL_MOUSE_ENABLE
     serial_mouse_init();
 #endif
+#ifdef ADB_MOUSE_ENABLE
+    adb_mouse_init();
+#endif
 
 
 #ifdef BOOTMAGIC_ENABLE
@@ -147,6 +153,10 @@ MATRIX_LOOP_END:
         serial_mouse_task();
 #endif
 
+#ifdef ADB_MOUSE_ENABLE
+        adb_mouse_task();
+#endif
+
     // update LED
     if (led_status != host_keyboard_leds()) {
         led_status = host_keyboard_leds();
diff --git a/tmk_core/protocol.mk b/tmk_core/protocol.mk
index 726f658a04..54913329e6 100644
--- a/tmk_core/protocol.mk
+++ b/tmk_core/protocol.mk
@@ -46,5 +46,9 @@ ifdef SERIAL_MOUSE_USE_UART
     SRC += $(PROTOCOL_DIR)/serial_uart.c
 endif
 
+ifdef ADB_MOUSE_ENABLE
+	 OPT_DEFS += -DADB_MOUSE_ENABLE -DMOUSE_ENABLE
+endif
+
 # Search Path
 VPATH += $(TMK_DIR)/protocol
diff --git a/tmk_core/protocol/adb.c b/tmk_core/protocol/adb.c
index bbff66df03..5c6c99b4fc 100644
--- a/tmk_core/protocol/adb.c
+++ b/tmk_core/protocol/adb.c
@@ -60,6 +60,7 @@ static inline void place_bit1(void);
 static inline void send_byte(uint8_t data);
 static inline uint16_t wait_data_lo(uint16_t us);
 static inline uint16_t wait_data_hi(uint16_t us);
+static inline uint16_t adb_host_dev_recv(uint8_t device);
 
 
 void adb_host_init(void)
@@ -121,12 +122,33 @@ bool adb_host_psw(void)
 //
 // [from Apple IIgs Hardware Reference Second Edition]
 
+enum {
+    ADDR_KEYB  = 0x20,
+    ADDR_MOUSE = 0x30
+};
+
 uint16_t adb_host_kbd_recv(void)
 {
+    return adb_host_dev_recv(ADDR_KEYB);
+}
+
+#ifdef ADB_MOUSE_ENABLE
+void adb_mouse_init(void) {
+	    return;
+}
+
+uint16_t adb_host_mouse_recv(void)
+{
+    return adb_host_dev_recv(ADDR_MOUSE);
+}
+#endif
+
+static inline uint16_t adb_host_dev_recv(uint8_t device)
+{
     uint16_t data = 0;
     cli();
     attention();
-    send_byte(0x2C);            // Addr:Keyboard(0010), Cmd:Talk(11), Register0(00)
+    send_byte(device|0x0C);     // Addr:Keyboard(0010)/Mouse(0011), Cmd:Talk(11), Register0(00)
     place_bit0();               // Stopbit(0)
     if (!wait_data_hi(500)) {    // Service Request(310us Adjustable Keyboard): just ignored
         sei();
diff --git a/tmk_core/protocol/adb.h b/tmk_core/protocol/adb.h
index bfe598bbf1..b4b3633cf4 100644
--- a/tmk_core/protocol/adb.h
+++ b/tmk_core/protocol/adb.h
@@ -56,7 +56,11 @@ POSSIBILITY OF SUCH DAMAGE.
 void     adb_host_init(void);
 bool     adb_host_psw(void);
 uint16_t adb_host_kbd_recv(void);
+uint16_t adb_host_mouse_recv(void);
 void     adb_host_listen(uint8_t cmd, uint8_t data_h, uint8_t data_l);
 void     adb_host_kbd_led(uint8_t led);
+void     adb_mouse_task(void);
+void     adb_mouse_init(void);
+
 
 #endif
diff --git a/tmk_core/protocol/pjrc.mk b/tmk_core/protocol/pjrc.mk
index 36585de7df..2b1ba2cbfb 100644
--- a/tmk_core/protocol/pjrc.mk
+++ b/tmk_core/protocol/pjrc.mk
@@ -11,6 +11,10 @@ ifdef MOUSEKEY_ENABLE
     SRC += $(PJRC_DIR)/usb_mouse.c
 endif
 
+ifdef ADB_MOUSE_ENABLE
+    SRC += $(PJRC_DIR)/usb_mouse.c
+endif
+
 ifdef PS2_MOUSE_ENABLE
     SRC += $(PJRC_DIR)/usb_mouse.c
 endif