tmk_core/common/matrix.h

   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 #ifndef MATRIX_H
  18 #define MATRIX_H
  19
  20 #include <stdint.h>
  21 #include <stdbool.h>
  22
  23 #if (MATRIX_COLS <= 8)
  24 typedef uint8_t matrix_row_t;
  25 #elif (MATRIX_COLS <= 16)
  26 typedef uint16_t matrix_row_t;
  27 #elif (MATRIX_COLS <= 32)
  28 typedef uint32_t matrix_row_t;
  29 #else
  30 #    error "MATRIX_COLS: invalid value"
  31 #endif
  32
  33 #if (MATRIX_ROWS <= 8)
  34 typedef uint8_t matrix_col_t;
  35 #elif (MATRIX_ROWS <= 16)
  36 typedef uint16_t matrix_col_t;
  37 #elif (MATRIX_ROWS <= 32)
  38 typedef uint32_t matrix_col_t;
  39 #else
  40 #    error "MATRIX_ROWS: invalid value"
  41 #endif
  42
  43 #define MATRIX_ROW_SHIFTER ((matrix_row_t)1)
  44
  45 #define MATRIX_IS_ON(row, col) (matrix_get_row(row) && (1 << col))
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51 /* number of matrix rows */
  52 uint8_t matrix_rows(void);
  53 /* number of matrix columns */
  54 uint8_t matrix_cols(void);
  55 /* should be called at early stage of startup before matrix_init.(optional) */
  56 void matrix_setup(void);
  57 /* intialize matrix for scaning. */
  58 void matrix_init(void);
  59 /* scan all key states on matrix */
  60 uint8_t matrix_scan(void);
  61 /* whether modified from previous scan. used after matrix_scan. */
  62 bool matrix_is_modified(void) __attribute__((deprecated));
  63 /* whether a switch is on */
  64 bool matrix_is_on(uint8_t row, uint8_t col);
  65 /* matrix state on row */
  66 matrix_row_t matrix_get_row(uint8_t row);
  67 /* print matrix for debug */
  68 void matrix_print(void);
  69
  70 /* power control */
  71 void matrix_power_up(void);
  72 void matrix_power_down(void);
  73
  74 /* executes code for Quantum */
  75 void matrix_init_quantum(void);
  76 void matrix_scan_quantum(void);
  77
  78 void matrix_init_kb(void);
  79 void matrix_scan_kb(void);
  80
  81 void matrix_init_user(void);
  82 void matrix_scan_user(void);
  83
  84 #ifdef __cplusplus
  85 }
  86 #endif
  87
  88 #endif