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