tmk_keyboard_custom/converter/xt_usb/matrix.c

/*
Copyright 2011 Jun Wako <wakojun@gmail.com>
Copyright 2016 Ethan Apodaca <papodaca@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 <stdbool.h>
#include "action.h"
#include "print.h"
#include "util.h"
#include "debug.h"
#include "xt.h"
#include "matrix.h"


static void matrix_make(uint8_t code);
static void matrix_break(uint8_t code);
static void matrix_clear(void);
#ifdef MATRIX_HAS_GHOST
static bool matrix_has_ghost_in_row(uint8_t row);
#endif

static uint8_t matrix[MATRIX_ROWS];
#define ROW(code)      (code>>3)
#define COL(code)      (code&0x07)

// matrix positions for exceptional keys
#define PRINT_SCREEN   (0x7C)
#define PAUSE          (0x7D)

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)
{
    debug_enable = true;
    xt_host_init();

    // initialize matrix state: all keys off
    for (uint8_t i=0; i < MATRIX_ROWS; i++) matrix[i] = 0x00;

    return;
}

static uint8_t move_codes(uint8_t code) {
    switch(code) {
        case 0x10:
            code += 0x5E;
            break;
        case 0x19:
            code += 0x41;
            break;
        case 0x1C:
        case 0x1D:
            code += 0x38;
            break;
        case 0x20:
        case 0x21:
        case 0x22:
        case 0x24:
            code += 0x40;
            break;
        case 0x2E:
        case 0x30:
        case 0x32:
            code += 0x44;
            break;
        case 0x35:
        case 0x38:
            code += 0x21;
            break;
        case 0x47:
        case 0x48:
        case 0x49:
        case 0x4B:
        case 0x4D:
        case 0x4F:
        case 0x50:
        case 0x51:
        case 0x52:
        case 0x53:
            code += 0x28;
            break;
    }
    return code;
}

uint8_t matrix_scan(void)
{

    // scan code reading states
    static enum {
        INIT,
        E0,
        E0_2A,
        E0_2A_E0,
        E0_B7,
        E0_B7_E0,

        // print screen
        E1,
        E1_1D,
        E1_1D_45,
        E1_1D_45_E1,
        E1_1D_45_E1_9D,
        // pause
    } state = INIT;


    is_modified = false;

    // 'pseudo break code' hack
    if (matrix_is_on(ROW(PAUSE), COL(PAUSE))) {
        matrix_break(PAUSE);
    }

    uint8_t code = xt_host_recv();
    if (code) xprintf("%X\r\n", code);
    switch (state) {
        case INIT:
            switch (code) {
                case 0xE0:
                    state = E0;
                    break;
                case 0xE1:
                    state = E1;
                    break;
                case 0x00:
                    break;
                default:    // normal key make
                    if (code < 0x80) {
                        xprintf("make: %X\r\n", code);
                        matrix_make(code);
                    } else if (code > 0x80 && code < 0xFF) {
                        xprintf("break %X\r\n", code);
                        matrix_break(code - 0x80);
                    } else {
                        matrix_clear();
                        clear_keyboard();
                        xprintf("unexpected scan code at INIT: %02X\n", code);
                    }
                    state = INIT;
            }
            break;
        case E0:    // E0-Prefixed
            switch (code) { //move these codes to unused places on the matrix
                case 0x2A:
                    state = E0_2A;
                    break;
                case 0xB7:
                    state = E0_B7;
                    break;
                case 0x00:
                    state = INIT;
                    break;
                default:
                    if (code < 0x80) {
                        matrix_make(move_codes(code));
                    } else if (code > 0x80 && code < 0xFF) {
                        matrix_break(move_codes(code - 0x80));
                    } else {
                        matrix_clear();
                        clear_keyboard();
                        xprintf("unexpected scan code at E0: %02X\n", code);
                    }
                    state = INIT;
            }
            break;
        case E0_2A:
            switch (code) {
                case 0xE0:
                    state = E0_2A_E0;
                    break;
                default:
                    state = INIT;
            }
            break;
        case E0_2A_E0:
            switch (code) {
                case 0x37:
                    matrix_make(PRINT_SCREEN);
                    break;
                default:
                    state = INIT;
            }
            break;
        case E0_B7:
            switch (code) {
                case 0xE0:
                    state = E0_B7;
                    break;
                default:
                    state = INIT;
            }
            break;
        case E0_B7_E0:
          switch (code) {
              case 0xAA:
                  matrix_break(PRINT_SCREEN);
                  break;
              default:
                  state = INIT;
          }
          break;
        case E1:
            switch (code) {
                case 0x1D:
                    state = E1_1D;
                    break;
                default:
                    state = INIT;
            }
            break;
        case E1_1D:
            switch (code) {
                case 0x45:
                    state = E1_1D_45;
                    break;
                default:
                    state = INIT;
            }
            break;
        case E1_1D_45:
            switch (code) {
                case 0xE1:
                    state = E1_1D_45_E1;
                    break;
                default:
                    state = INIT;
            }
            break;
        case E1_1D_45_E1:
            switch (code) {
                case 0x9D:
                    state = E1_1D_45_E1_9D;
                    break;
                default:
                    state = INIT;
            }
            break;
        case E1_1D_45_E1_9D:
            switch (code) {
                case 0xC5:
                    matrix_make(PAUSE);
                    break;
                default:
                    state = INIT;
            }
            break;
        default:
            state = INIT;
    }

    // TODO: request RESEND when error occurs?
/*
    if (PS2_IS_FAILED(ps2_error)) {
        uint8_t ret = ps2_host_send(PS2_RESEND);
        xprintf("Resend: %02X\n", ret);
    }
*/
    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;
    }
}

inline
static void matrix_clear(void)
{
    for (uint8_t i=0; i < MATRIX_ROWS; i++) matrix[i] = 0x00;
}