converter/adb_usb/matrix.c

   1 /*
   2 Copyright 2011 Jun Wako <wakojun@gmail.com>
   3
   4 This program is free software: you can redistribute it and/or modify
   5 it under the terms of the GNU General Public License as published by
   6 the Free Software Foundation, either version 2 of the License, or
   7 (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 */
  17
  18 /*
  19  * scan matrix
  20  */
  21 #include <stdint.h>
  22 #include <stdbool.h>
  23 #include <avr/io.h>
  24 #include <util/delay.h>
  25 #include "print.h"
  26 #include "util.h"
  27 #include "debug.h"
  28 #include "adb.h"
  29 #include "matrix.h"
  30 #include "report.h"
  31 #include "host.h"
  32
  33
  34 #if (MATRIX_COLS > 16)
  35 #   error "MATRIX_COLS must not exceed 16"
  36 #endif
  37 #if (MATRIX_ROWS > 255)
  38 #   error "MATRIX_ROWS must not exceed 255"
  39 #endif
  40
  41
  42 static bool is_modified = false;
  43 static report_mouse_t mouse_report = {};
  44
  45 // matrix state buffer(1:on, 0:off)
  46 #if (MATRIX_COLS <= 8)
  47 static uint8_t matrix[MATRIX_ROWS];
  48 #else
  49 static uint16_t matrix[MATRIX_ROWS];
  50 #endif
  51
  52 #ifdef MATRIX_HAS_GHOST
  53 static bool matrix_has_ghost_in_row(uint8_t row);
  54 #endif
  55 static void register_key(uint8_t key);
  56
  57
  58 inline
  59 uint8_t matrix_rows(void)
  60 {
  61     return MATRIX_ROWS;
  62 }
  63
  64 inline
  65 uint8_t matrix_cols(void)
  66 {
  67     return MATRIX_COLS;
  68 }
  69
  70 void matrix_init(void)
  71 {
  72     adb_host_init();
  73     // wait for keyboard to boot up and receive command
  74     _delay_ms(1000);
  75     // Enable keyboard left/right modifier distinction
  76     // Addr:Keyboard(0010), Cmd:Listen(10), Register3(11)
  77     // upper byte: reserved bits 0000, device address 0010
  78     // lower byte: device handler 00000011
  79     adb_host_listen(0x2B,0x02,0x03);
  80
  81     // initialize matrix state: all keys off
  82     for (uint8_t i=0; i < MATRIX_ROWS; i++) matrix[i] = 0x00;
  83
  84     debug_enable = true;
  85     //debug_matrix = true;
  86     //debug_keyboard = true;
  87     //debug_mouse = true;
  88     print("debug enabled.\n");
  89     return;
  90 }
  91
  92 #ifdef ADB_MOUSE_ENABLE
  93
  94 #ifdef MAX
  95 #undef MAX
  96 #endif
  97 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
  98
  99 void adb_mouse_task(void)
 100 {
 101     uint16_t codes;
 102     int16_t x, y;
 103     static int8_t mouseacc;
 104     _delay_ms(12);  // delay for preventing overload of poor ADB keyboard controller
 105     codes = adb_host_mouse_recv();
 106     // If nothing received reset mouse acceleration, and quit.
 107     if (!codes) {
 108         mouseacc = 1;
 109         return;
 110     };
 111     // Bit sixteen is button.
 112     if (~codes & (1 << 15))
 113         mouse_report.buttons |= MOUSE_BTN1;
 114     if (codes & (1 << 15))
 115         mouse_report.buttons &= ~MOUSE_BTN1;
 116     // lower seven bits are movement, as signed int_7.
 117     // low byte is X-axis, high byte is Y.
 118     y = (codes>>8 & 0x3F);
 119     x = (codes>>0 & 0x3F);
 120     // bit seven and fifteen is negative
 121     // usb does not use int_8, but int_7 (measuring distance) with sign-bit.
 122     if (codes & (1 << 6))
 123           x = (x-0x40);
 124     if (codes & (1 << 14))
 125          y = (y-0x40);
 126     // Accelerate mouse. (They weren't meant to be used on screens larger than 320x200).
 127     x *= mouseacc;
 128     y *= mouseacc;
 129     // Cap our two bytes per axis to one byte.
 130     // Easier with a MIN-function, but since -MAX(-a,-b) = MIN(a,b)...
 131          // I.E. MIN(MAX(x,-127),127) = -MAX(-MAX(x, -127), -127) = MIN(-MIN(-x,127),127)
 132     mouse_report.x = -MAX(-MAX(x, -127), -127);
 133     mouse_report.y = -MAX(-MAX(y, -127), -127);
 134     if (debug_mouse) {
 135             print("adb_host_mouse_recv: "); print_bin16(codes); print("\n");
 136             print("adb_mouse raw: [");
 137             phex(mouseacc); print(" ");
 138             phex(mouse_report.buttons); print("|");
 139             print_decs(mouse_report.x); print(" ");
 140             print_decs(mouse_report.y); print("]\n");
 141     }
 142     // Send result by usb.
 143     host_mouse_send(&mouse_report);
 144     // increase acceleration of mouse
 145     mouseacc += ( mouseacc < ADB_MOUSE_MAXACC ? 1 : 0 );
 146     return;
 147 }
 148 #endif
 149
 150 uint8_t matrix_scan(void)
 151 {
 152     /* extra_key is volatile and more convoluted than necessary because gcc refused
 153     to generate valid code otherwise. Making extra_key uint8_t and constructing codes
 154     here via codes = extra_key<<8 | 0xFF; would consistently fail to even LOAD
 155     extra_key from memory, and leave garbage in the high byte of codes. I tried
 156     dozens of code variations and it kept generating broken assembly output. So
 157     beware if attempting to make extra_key code more logical and efficient. */
 158     static volatile uint16_t extra_key = 0xFFFF;
 159     uint16_t codes;
 160     uint8_t key0, key1;
 161
 162     is_modified = false;
 163
 164     codes = extra_key;
 165     extra_key = 0xFFFF;
 166
 167     if ( codes == 0xFFFF )
 168     {
 169         _delay_ms(12);  // delay for preventing overload of poor ADB keyboard controller
 170         codes = adb_host_kbd_recv();
 171     }
 172     key0 = codes>>8;
 173     key1 = codes&0xFF;
 174
 175     if (debug_matrix && codes) {
 176         print("adb_host_kbd_recv: "); phex16(codes); print("\n");
 177     }
 178
 179     if (codes == 0) {                           // no keys
 180         return 0;
 181     } else if (codes == 0x7F7F) {   // power key press
 182         register_key(0x7F);
 183     } else if (codes == 0xFFFF) {   // power key release
 184         register_key(0xFF);
 185     } else if (key0 == 0xFF) {      // error
 186         xprintf("adb_host_kbd_recv: ERROR(%d)\n", codes);
 187         return key1;
 188     } else {
 189         register_key(key0);
 190         if (key1 != 0xFF)       // key1 is 0xFF when no second key.
 191             extra_key = key1<<8 | 0xFF; // process in a separate call
 192     }
 193
 194     return 1;
 195 }
 196
 197 bool matrix_is_modified(void)
 198 {
 199     return is_modified;
 200 }
 201
 202 inline
 203 bool matrix_has_ghost(void)
 204 {
 205 #ifdef MATRIX_HAS_GHOST
 206     for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
 207         if (matrix_has_ghost_in_row(i))
 208             return true;
 209     }
 210 #endif
 211     return false;
 212 }
 213
 214 inline
 215 bool matrix_is_on(uint8_t row, uint8_t col)
 216 {
 217     return (matrix[row] & (1<<col));
 218 }
 219
 220 inline
 221 #if (MATRIX_COLS <= 8)
 222 uint8_t matrix_get_row(uint8_t row)
 223 #else
 224 uint16_t matrix_get_row(uint8_t row)
 225 #endif
 226 {
 227     return matrix[row];
 228 }
 229
 230 void matrix_print(void)
 231 {
 232     if (!debug_matrix) return;
 233 #if (MATRIX_COLS <= 8)
 234     print("r/c 01234567\n");
 235 #else
 236     print("r/c 0123456789ABCDEF\n");
 237 #endif
 238     for (uint8_t row = 0; row < matrix_rows(); row++) {
 239         phex(row); print(": ");
 240 #if (MATRIX_COLS <= 8)
 241         pbin_reverse(matrix_get_row(row));
 242 #else
 243         pbin_reverse16(matrix_get_row(row));
 244 #endif
 245 #ifdef MATRIX_HAS_GHOST
 246         if (matrix_has_ghost_in_row(row)) {
 247             print(" <ghost");
 248         }
 249 #endif
 250         print("\n");
 251     }
 252 }
 253
 254 uint8_t matrix_key_count(void)
 255 {
 256     uint8_t count = 0;
 257     for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
 258 #if (MATRIX_COLS <= 8)
 259         count += bitpop(matrix[i]);
 260 #else
 261         count += bitpop16(matrix[i]);
 262 #endif
 263     }
 264     return count;
 265 }
 266
 267 #ifdef MATRIX_HAS_GHOST
 268 inline
 269 static bool matrix_has_ghost_in_row(uint8_t row)
 270 {
 271     // no ghost exists in case less than 2 keys on
 272     if (((matrix[row] - 1) & matrix[row]) == 0)
 273         return false;
 274
 275     // ghost exists in case same state as other row
 276     for (uint8_t i=0; i < MATRIX_ROWS; i++) {
 277         if (i != row && (matrix[i] & matrix[row]) == matrix[row])
 278             return true;
 279     }
 280     return false;
 281 }
 282 #endif
 283
 284 inline
 285 static void register_key(uint8_t key)
 286 {
 287     uint8_t col, row;
 288     col = key&0x07;
 289     row = (key>>3)&0x0F;
 290     if (key&0x80) {
 291         matrix[row] &= ~(1<<col);
 292     } else {
 293         matrix[row] |=  (1<<col);
 294     }
 295     is_modified = true;
 296 }