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
  18 #ifndef MATRIX_H
  19 #define MATRIX_H
  20
  21 #include <stdbool.h>
  22
  23 /* number of matrix rows */
  24 uint8_t matrix_rows(void);
  25 /* number of matrix columns */
  26 uint8_t matrix_cols(void);
  27 /* intialize matrix for scaning. should be called once. */
  28 void matrix_init(void);
  29 /* scan all key states on matrix */
  30 uint8_t matrix_scan(void);
  31 /* whether modified from previous scan. used after matrix_scan. */
  32 bool matrix_is_modified(void);
  33 /* whether ghosting occur on matrix. */
  34 bool matrix_has_ghost(void);
  35 /* whether a swtich is on */
  36 bool matrix_is_on(uint8_t row, uint8_t col);
  37 /* matrix state on row */
  38 #if (MATRIX_COLS <= 8)
  39 uint8_t matrix_get_row(uint8_t row);
  40 #else
  41 uint16_t matrix_get_row(uint8_t row);
  42 #endif
  43 /* count keys pressed */
  44 uint8_t matrix_key_count(void);
  45 /* print matrix for debug */
  46 void matrix_print(void);
  47
  48
  49 #endif