qmk_firmware/keyboard/planck/matrix.c

/*
Copyright 2012 Jun Wako 
Generated by planckkeyboard.com (2014 Jack Humbert)

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/>.
*/

/*
 * scan matrix
 */
#include <stdint.h>
#include <stdbool.h>
#include <avr/io.h>
#include <util/delay.h>
#include "print.h"
#include "debug.h"
#include "util.h"
#include "matrix.h"
#include "backlight.h" // TODO fix this dependency 


#ifndef DEBOUNCE
#   define DEBOUNCE 10
#endif
static uint8_t debouncing = DEBOUNCE;

/* matrix state(1:on, 0:off) */
static matrix_row_t matrix[MATRIX_ROWS];
static matrix_row_t matrix_debouncing[MATRIX_ROWS];

static matrix_row_t read_cols(void);
static void init_cols(void);
static void unselect_rows(void);
static void select_row(uint8_t row);

inline
uint8_t matrix_rows(void)
{
    return MATRIX_ROWS;
}

inline
uint8_t matrix_cols(void)
{
    return MATRIX_COLS;
}

void matrix_init(void)
{
    // To use PORTF disable JTAG with writing JTD bit twice within four cycles.
    MCUCR |= (1<<JTD);
    MCUCR |= (1<<JTD);

    // Pass default level here
    backlight_init_ports(15);
    
    // initialize row and col
    unselect_rows();
    init_cols();

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

uint8_t matrix_scan(void)
{
    for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
        select_row(i);
        _delay_us(30);  // without this wait read unstable value.
        matrix_row_t cols = read_cols();
        if (matrix_debouncing[i] != cols) {
            matrix_debouncing[i] = cols;
            if (debouncing) {
                debug("bounce!: "); debug_hex(debouncing); debug("\n");
            }
            debouncing = DEBOUNCE;
        }
        unselect_rows();
    }

    if (debouncing) {
        if (--debouncing) {
            _delay_ms(1);
        } else {
            for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
                matrix[i] = matrix_debouncing[i];
            }
        }
    }

    return 1;
}

bool matrix_is_modified(void)
{
    if (debouncing) return false;
    return true;
}

inline
bool matrix_is_on(uint8_t row, uint8_t col)
{
    return (matrix[row] & ((matrix_row_t)1<col));
}

inline
matrix_row_t matrix_get_row(uint8_t row)
{
    return matrix[row];
}

void matrix_print(void)
{
    print("\nr/c 0123456789ABCDEF\n");
    for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
        phex(row); print(": ");
        pbin_reverse16(matrix_get_row(row));
        print("\n");
    }
}

uint8_t matrix_key_count(void)
{
    uint8_t count = 0;
    for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
        count += bitpop16(matrix[i]);
    }
    return count;
}

//
// Planck PCB Rev 1 Pin Assignments
//
// Column: 0,  1,  2,  3,  4,  5,  6,  7,  8,  9,  10, 11
// Pin:    F1, F0, B0, C7, F4, F5, F6, F7, D4, D6, B4, D7
//

static void init_cols(void)
{
    DDRB &= ~(1<<4 | 1<<0);
    PORTB |= (1<<4 | 1<<0);
    DDRC &= ~(1<<7);
    PORTC |= (1<<7);
    DDRD &= ~(1<<7 | 1<<6 | 1<<4);
    PORTD |= (1<<7 | 1<<6 | 1<<4);
    DDRF &= ~(1<<0 | 1<<1 | 1<<4 | 1<<5 | 1<<6 | 1<<7);
    PORTF |= (1<<0 | 1<<1 | 1<<4 | 1<<5 | 1<<6 | 1<<7);
    
}

static matrix_row_t read_cols(void)
{
  return (PINF&(1<<1) ? 0 : (1<<0)) |
         (PINF&(1<<0) ? 0 : (1<<1)) |
         (PINB&(1<<0) ? 0 : (1<<2)) |
         (PINC&(1<<7) ? 0 : (1<<3)) |
         (PINF&(1<<4) ? 0 : (1<<4)) |
         (PINF&(1<<5) ? 0 : (1<<5)) |
         (PINF&(1<<6) ? 0 : (1<<6)) |
         (PINF&(1<<7) ? 0 : (1<<7)) |
         (PIND&(1<<4) ? 0 : (1<<8)) |
         (PIND&(1<<6) ? 0 : (1<<9)) |
         (PINB&(1<<4) ? 0 : (1<<10)) |
         (PIND&(1<<7) ? 0 : (1<<11));
         
}

static void unselect_rows(void)
{
    DDRB &= ~(1<<5 | 1<<6);
    PORTB |= (1<<5 | 1<<6);
    DDRD &= ~(1<<0 | 1<<5);
    PORTD |= (1<<0 | 1<<5);
    
}

//
// Planck PCB Rev 1 Pin Assignments
//
// Row: 0,  1,  2,  3
// Pin: D0, D5, B5, B6
//

static void select_row(uint8_t row)
{
    switch (row) {
        case 0:
            DDRD  |= (1<<0);
            PORTD &= ~(1<<0);
            break;
        case 1:
            DDRD  |= (1<<5);
            PORTD &= ~(1<<5);
            break;
        case 2:
            DDRB  |= (1<<5);
            PORTB &= ~(1<<5);
            break;
        case 3:
            DDRB  |= (1<<6);
            PORTB &= ~(1<<6);
            break;
        
    }
}