2 Copyright 2011 Jun Wako <wakojun@gmail.com>
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.
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.
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/>.
21 #include <util/delay.h>
30 static void matrix_make(uint8_t code);
31 static void matrix_break(uint8_t code);
32 static void matrix_clear(void);
33 #ifdef MATRIX_HAS_GHOST
34 static bool matrix_has_ghost_in_row(uint8_t row);
40 * 'Scan Code Set 2' is assigned into 256(32x8)cell matrix.
41 * Hmm, it is very sparse and not efficient :(
44 * Both 'Hanguel/English'(F1) and 'Hanja'(F2) collide with 'Delete'(E0 71) and 'Down'(E0 72).
45 * These two Korean keys need exceptional handling and are not supported for now. Sorry.
50 * :| XX | 00-7F for normal codes(without E0-prefix)
53 * :| E0 YY | 80-FF for E0-prefixed codes
54 * 1f| | (<YY>|0x80) is used as matrix position.
58 * 0x83: F7(0x83) This is a normal code but beyond 0x7F.
62 static uint8_t matrix[MATRIX_ROWS];
63 #define ROW(code) (code>>3)
64 #define COL(code) (code&0x07)
66 // matrix positions for exceptional keys
68 #define PRINT_SCREEN (0xFC)
71 static bool is_modified = false;
75 uint8_t matrix_rows(void)
81 uint8_t matrix_cols(void)
86 void matrix_init(void)
91 // initialize matrix state: all keys off
92 for (uint8_t i=0; i < MATRIX_ROWS; i++) matrix[i] = 0x00;
98 * PS/2 Scan Code Set 2: Exceptional Handling
100 * There are several keys to be handled exceptionally.
101 * The scan code for these keys are varied or prefix/postfix'd
102 * depending on modifier key state.
104 * Keyboard Scan Code Specification:
105 * http://www.microsoft.com/whdc/archive/scancode.mspx
106 * http://download.microsoft.com/download/1/6/1/161ba512-40e2-4cc9-843a-923143f3456c/scancode.doc
109 * 1) Insert, Delete, Home, End, PageUp, PageDown, Up, Down, Right, Left
110 * a) when Num Lock is off
111 * modifiers | make | break
112 * ----------+---------------------------+----------------------
113 * Ohter | <make> | <break>
114 * LShift | E0 F0 12 <make> | <break> E0 12
115 * RShift | E0 F0 59 <make> | <break> E0 59
116 * L+RShift | E0 F0 12 E0 F0 59 <make> | <break> E0 59 E0 12
118 * b) when Num Lock is on
119 * modifiers | make | break
120 * ----------+---------------------------+----------------------
121 * Other | E0 12 <make> | <break> E0 F0 12
122 * Shift'd | <make> | <break>
124 * Handling: These prefix/postfix codes are ignored.
128 * modifiers | make | break
129 * ----------+---------------------------+----------------------
130 * Ohter | <make> | <break>
131 * LShift | E0 F0 12 <make> | <break> E0 12
132 * RShift | E0 F0 59 <make> | <break> E0 59
133 * L+RShift | E0 F0 12 E0 F0 59 <make> | <break> E0 59 E0 12
135 * Handling: These prefix/postfix codes are ignored.
139 * modifiers | make | break
140 * ----------+--------------+-----------------------------------
141 * Other | E0 12 E0 7C | E0 F0 7C E0 F0 12
142 * Shift'd | E0 7C | E0 F0 7C
143 * Control'd | E0 7C | E0 F0 7C
146 * Handling: These prefix/postfix codes are ignored, and both scan codes
147 * 'E0 7C' and 84 are seen as PrintScreen.
150 * modifiers | make(no break code)
151 * ----------+--------------------------------------------------
152 * Other | E1 14 77 E1 F0 14 F0 77
153 * Control'd | E0 7E E0 F0 7E
155 * Handling: Both code sequences are treated as a whole.
156 * And we need a ad hoc 'pseudo break code' hack to get the key off
157 * because it has no break code.
160 uint8_t matrix_scan(void)
163 // scan code reading states
176 E1_14_77_E1_F0_14_F0,
186 // 'pseudo break code' hack
187 if (matrix_is_on(ROW(PAUSE), COL(PAUSE))) {
191 uint8_t code = ps2_host_recv();
209 case 0x84: // Alt'd PrintScreen
210 matrix_make(PRINT_SCREEN);
213 case 0x00: // Overrun [3]p.25
219 default: // normal key make
225 xprintf("unexpected scan code at INIT: %02X\n", code);
230 case E0: // E0-Prefixed
232 case 0x12: // to be ignored
233 case 0x59: // to be ignored
236 case 0x7E: // Control'd Pause
244 matrix_make(code|0x80);
248 xprintf("unexpected scan code at E0: %02X\n", code);
253 case F0: // Break code
259 case 0x84: // Alt'd PrintScreen
260 matrix_break(PRINT_SCREEN);
266 xprintf("unexpected scan code at F0: F0(clear and cont.)\n");
274 xprintf("unexpected scan code at F0: %02X\n", code);
279 case E0_F0: // Break code of E0-prefixed
281 case 0x12: // to be ignored
282 case 0x59: // to be ignored
287 matrix_break(code|0x80);
291 xprintf("unexpected scan code at E0_F0: %02X\n", code);
296 // following are states of Pause
327 state = E1_14_77_E1_F0;
336 state = E1_14_77_E1_F0_14;
342 case E1_14_77_E1_F0_14:
345 state = E1_14_77_E1_F0_14_F0;
351 case E1_14_77_E1_F0_14_F0:
361 // Following are states of Control'd Pause
384 // TODO: request RESEND when error occurs?
386 if (PS2_IS_FAILED(ps2_error)) {
387 uint8_t ret = ps2_host_send(PS2_RESEND);
388 xprintf("Resend: %02X\n", ret);
394 bool matrix_is_modified(void)
400 bool matrix_has_ghost(void)
402 #ifdef MATRIX_HAS_GHOST
403 for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
404 if (matrix_has_ghost_in_row(i))
412 bool matrix_is_on(uint8_t row, uint8_t col)
414 return (matrix[row] & (1<<col));
418 uint8_t matrix_get_row(uint8_t row)
423 void matrix_print(void)
425 print("\nr/c 01234567\n");
426 for (uint8_t row = 0; row < matrix_rows(); row++) {
427 phex(row); print(": ");
428 pbin_reverse(matrix_get_row(row));
429 #ifdef MATRIX_HAS_GHOST
430 if (matrix_has_ghost_in_row(row)) {
438 uint8_t matrix_key_count(void)
441 for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
442 count += bitpop(matrix[i]);
447 #ifdef MATRIX_HAS_GHOST
449 static bool matrix_has_ghost_in_row(uint8_t row)
451 // no ghost exists in case less than 2 keys on
452 if (((matrix[row] - 1) & matrix[row]) == 0)
455 // ghost exists in case same state as other row
456 for (uint8_t i=0; i < MATRIX_ROWS; i++) {
457 if (i != row && (matrix[i] & matrix[row]) == matrix[row])
466 static void matrix_make(uint8_t code)
468 if (!matrix_is_on(ROW(code), COL(code))) {
469 matrix[ROW(code)] |= 1<<COL(code);
475 static void matrix_break(uint8_t code)
477 if (matrix_is_on(ROW(code), COL(code))) {
478 matrix[ROW(code)] &= ~(1<<COL(code));
484 static void matrix_clear(void)
486 for (uint8_t i=0; i < MATRIX_ROWS; i++) matrix[i] = 0x00;