123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452 |
- /*
- Copyright 2011 Jun Wako <[email protected]>
-
- 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 <stdbool.h>
- #include <avr/io.h>
- #include <util/delay.h>
- #include "print.h"
- #include "util.h"
- #include "debug.h"
- #include "ps2.h"
- #include "matrix.h"
-
-
- static void matrix_make(uint8_t code);
- static void matrix_break(uint8_t code);
- #ifdef MATRIX_HAS_GHOST
- static bool matrix_has_ghost_in_row(uint8_t row);
- #endif
-
-
- /*
- * Matrix Array usage:
- * 'Scan Code Set 2' is assigned into 256(32x8)cell matrix.
- * Hmm, it is very sparse and not efficient :(
- *
- * Notes:
- * Both 'Hanguel/English'(F1) and 'Hanja'(F2) collide with 'Delete'(E0 71) and 'Down'(E0 72).
- * These two Korean keys need exceptional handling and are not supported for now. Sorry.
- *
- * 8bit wide
- * +---------+
- * 0| |
- * :| XX | 00-7F for normal codes(without E0-prefix)
- * f|_________|
- * 10| |
- * :| E0 YY | 80-FF for E0-prefixed codes
- * 1f| | (<YY>|0x80) is used as matrix position.
- * +---------+
- *
- * Exceptions:
- * 0x83: F7(0x83) This is a normal code but beyond 0x7F.
- * 0xFC: PrintScreen
- * 0xFE: Pause
- */
- static uint8_t matrix[MATRIX_ROWS];
- #define ROW(code) (code>>3)
- #define COL(code) (code&0x07)
-
- // matrix positions for exceptional keys
- #define F7 (0x83)
- #define PRINT_SCREEN (0xFC)
- #define PAUSE (0xFE)
-
- static bool is_modified = false;
-
-
- inline
- uint8_t matrix_rows(void)
- {
- return MATRIX_ROWS;
- }
-
- inline
- uint8_t matrix_cols(void)
- {
- return MATRIX_COLS;
- }
-
- void matrix_init(void)
- {
- ps2_host_init();
-
- // initialize matrix state: all keys off
- for (uint8_t i=0; i < MATRIX_ROWS; i++) matrix[i] = 0x00;
-
- return;
- }
-
- /*
- * PS/2 Scan Code Set 2: Exceptional Handling
- *
- * There are several keys to be handled exceptionally.
- * The scan code for these keys are varied or prefix/postfix'd
- * depending on modifier key state.
- *
- * Keyboard Scan Code Specification:
- * http://www.microsoft.com/whdc/archive/scancode.mspx
- * http://download.microsoft.com/download/1/6/1/161ba512-40e2-4cc9-843a-923143f3456c/scancode.doc
- *
- *
- * 1) Insert, Delete, Home, End, PageUp, PageDown, Up, Down, Right, Left
- * a) when Num Lock is off
- * modifiers | make | break
- * ----------+---------------------------+----------------------
- * Ohter | <make> | <break>
- * LShift | E0 F0 12 <make> | <break> E0 12
- * RShift | E0 F0 59 <make> | <break> E0 59
- * L+RShift | E0 F0 12 E0 F0 59 <make> | <break> E0 59 E0 12
- *
- * b) when Num Lock is on
- * modifiers | make | break
- * ----------+---------------------------+----------------------
- * Other | E0 12 <make> | <break> E0 F0 12
- * Shift'd | <make> | <break>
- *
- * Handling: These prefix/postfix codes are ignored.
- *
- *
- * 2) Keypad /
- * modifiers | make | break
- * ----------+---------------------------+----------------------
- * Ohter | <make> | <break>
- * LShift | E0 F0 12 <make> | <break> E0 12
- * RShift | E0 F0 59 <make> | <break> E0 59
- * L+RShift | E0 F0 12 E0 F0 59 <make> | <break> E0 59 E0 12
- *
- * Handling: These prefix/postfix codes are ignored.
- *
- *
- * 3) PrintScreen
- * modifiers | make | break
- * ----------+--------------+-----------------------------------
- * Other | E0 12 E0 7C | E0 F0 7C E0 F0 12
- * Shift'd | E0 7C | E0 F0 7C
- * Control'd | E0 7C | E0 F0 7C
- * Alt'd | 84 | F0 84
- *
- * Handling: These prefix/postfix codes are ignored, and both scan codes
- * 'E0 7C' and 84 are seen as PrintScreen.
- *
- * 4) Pause
- * modifiers | make(no break code)
- * ----------+--------------------------------------------------
- * Other | E1 14 77 E1 F0 14 F0 77
- * Control'd | E0 7E E0 F0 7E
- *
- * Handling: Both code sequences are treated as a whole.
- * And we need a ad hoc 'pseudo break code' hack to get the key off
- * because it has no break code.
- *
- */
- uint8_t matrix_scan(void)
- {
-
- // scan code reading states
- static enum {
- INIT,
- F0,
- E0,
- E0_F0,
- // Pause
- E1,
- E1_14,
- E1_14_77,
- E1_14_77_E1,
- E1_14_77_E1_F0,
- E1_14_77_E1_F0_14,
- E1_14_77_E1_F0_14_F0,
- // Control'd Pause
- E0_7E,
- E0_7E_E0,
- E0_7E_E0_F0,
- } state = INIT;
-
-
- is_modified = false;
-
- // 'pseudo break code' hack
- if (matrix_is_on(ROW(PAUSE), COL(PAUSE))) {
- matrix_break(PAUSE);
- }
-
- uint8_t code;
- while ((code = ps2_host_recv())) {
- switch (state) {
- case INIT:
- switch (code) {
- case 0xE0:
- state = E0;
- break;
- case 0xF0:
- state = F0;
- break;
- case 0xE1:
- state = E1;
- break;
- case 0x83: // F7
- matrix_make(F7);
- state = INIT;
- break;
- case 0x84: // Alt'd PrintScreen
- matrix_make(PRINT_SCREEN);
- state = INIT;
- break;
- default: // normal key make
- if (code < 0x80) {
- matrix_make(code);
- } else {
- debug("unexpected scan code at INIT: "); debug_hex(code); debug("\n");
- }
- state = INIT;
- }
- break;
- case E0: // E0-Prefixed
- switch (code) {
- case 0x12: // to be ignored
- case 0x59: // to be ignored
- state = INIT;
- break;
- case 0x7E: // Control'd Pause
- state = E0_7E;
- break;
- case 0xF0:
- state = E0_F0;
- break;
- default:
- if (code < 0x80) {
- matrix_make(code|0x80);
- } else {
- debug("unexpected scan code at E0: "); debug_hex(code); debug("\n");
- }
- state = INIT;
- }
- break;
- case F0: // Break code
- switch (code) {
- case 0x83: // F7
- matrix_break(F7);
- state = INIT;
- break;
- case 0x84: // Alt'd PrintScreen
- matrix_break(PRINT_SCREEN);
- state = INIT;
- break;
- default:
- if (code < 0x80) {
- matrix_break(code);
- } else {
- debug("unexpected scan code at F0: "); debug_hex(code); debug("\n");
- }
- state = INIT;
- }
- break;
- case E0_F0: // Break code of E0-prefixed
- switch (code) {
- case 0x12: // to be ignored
- case 0x59: // to be ignored
- state = INIT;
- break;
- default:
- if (code < 0x80) {
- matrix_break(code|0x80);
- } else {
- debug("unexpected scan code at E0_F0: "); debug_hex(code); debug("\n");
- }
- state = INIT;
- }
- break;
- // following are states of Pause
- case E1:
- switch (code) {
- case 0x14:
- state = E1_14;
- break;
- default:
- state = INIT;
- }
- break;
- case E1_14:
- switch (code) {
- case 0x77:
- state = E1_14_77;
- break;
- default:
- state = INIT;
- }
- break;
- case E1_14_77:
- switch (code) {
- case 0xE1:
- state = E1_14_77_E1;
- break;
- default:
- state = INIT;
- }
- break;
- case E1_14_77_E1:
- switch (code) {
- case 0xF0:
- state = E1_14_77_E1_F0;
- break;
- default:
- state = INIT;
- }
- break;
- case E1_14_77_E1_F0:
- switch (code) {
- case 0x14:
- state = E1_14_77_E1_F0_14;
- break;
- default:
- state = INIT;
- }
- break;
- case E1_14_77_E1_F0_14:
- switch (code) {
- case 0xF0:
- state = E1_14_77_E1_F0_14_F0;
- break;
- default:
- state = INIT;
- }
- break;
- case E1_14_77_E1_F0_14_F0:
- switch (code) {
- case 0x77:
- matrix_make(PAUSE);
- state = INIT;
- break;
- default:
- state = INIT;
- }
- break;
- // Following are states of Control'd Pause
- case E0_7E:
- if (code == 0xE0)
- state = E0_7E_E0;
- else
- state = INIT;
- break;
- case E0_7E_E0:
- if (code == 0xF0)
- state = E0_7E_E0_F0;
- else
- state = INIT;
- break;
- case E0_7E_E0_F0:
- if (code == 0x7E)
- matrix_make(PAUSE);
- state = INIT;
- break;
- default:
- state = INIT;
- }
- phex(code);
- }
- return 1;
- }
-
- bool matrix_is_modified(void)
- {
- return is_modified;
- }
-
- inline
- bool matrix_has_ghost(void)
- {
- #ifdef MATRIX_HAS_GHOST
- for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
- if (matrix_has_ghost_in_row(i))
- return true;
- }
- #endif
- return false;
- }
-
- inline
- bool matrix_is_on(uint8_t row, uint8_t col)
- {
- return (matrix[row] & (1<<col));
- }
-
- inline
- uint8_t matrix_get_row(uint8_t row)
- {
- return matrix[row];
- }
-
- void matrix_print(void)
- {
- print("\nr/c 01234567\n");
- for (uint8_t row = 0; row < matrix_rows(); row++) {
- phex(row); print(": ");
- pbin_reverse(matrix_get_row(row));
- #ifdef MATRIX_HAS_GHOST
- if (matrix_has_ghost_in_row(row)) {
- print(" <ghost");
- }
- #endif
- print("\n");
- }
- }
-
- uint8_t matrix_key_count(void)
- {
- uint8_t count = 0;
- for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
- count += bitpop(matrix[i]);
- }
- return count;
- }
-
- #ifdef MATRIX_HAS_GHOST
- inline
- static bool matrix_has_ghost_in_row(uint8_t row)
- {
- // no ghost exists in case less than 2 keys on
- if (((matrix[row] - 1) & matrix[row]) == 0)
- return false;
-
- // ghost exists in case same state as other row
- for (uint8_t i=0; i < MATRIX_ROWS; i++) {
- if (i != row && (matrix[i] & matrix[row]) == matrix[row])
- return true;
- }
- return false;
- }
- #endif
-
-
- inline
- static void matrix_make(uint8_t code)
- {
- if (!matrix_is_on(ROW(code), COL(code))) {
- matrix[ROW(code)] |= 1<<COL(code);
- is_modified = true;
- }
- }
-
- inline
- static void matrix_break(uint8_t code)
- {
- if (matrix_is_on(ROW(code), COL(code))) {
- matrix[ROW(code)] &= ~(1<<COL(code));
- is_modified = true;
- }
- }
|