matrix.h 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
  1. /*
  2. Copyright 2011 Jun Wako <wakojun@gmail.com>
  3. This program is free software: you can redistribute it and/or modify
  4. it under the terms of the GNU General Public License as published by
  5. the Free Software Foundation, either version 2 of the License, or
  6. (at your option) any later version.
  7. This program is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. GNU General Public License for more details.
  11. You should have received a copy of the GNU General Public License
  12. along with this program. If not, see <http://www.gnu.org/licenses/>.
  13. */
  14. #ifndef MATRIX_H
  15. #define MATRIX_H
  16. #include <stdint.h>
  17. #include <stdbool.h>
  18. #if (MATRIX_COLS <= 8)
  19. typedef uint8_t matrix_row_t;
  20. #elif (MATRIX_COLS <= 16)
  21. typedef uint16_t matrix_row_t;
  22. #elif (MATRIX_COLS <= 32)
  23. typedef uint32_t matrix_row_t;
  24. #else
  25. #error "MATRIX_COLS: invalid value"
  26. #endif
  27. #if (MATRIX_ROWS <= 8)
  28. typedef uint8_t matrix_col_t;
  29. #elif (MATRIX_ROWS <= 16)
  30. typedef uint16_t matrix_col_t;
  31. #elif (MATRIX_ROWS <= 32)
  32. typedef uint32_t matrix_col_t;
  33. #else
  34. #error "MATRIX_ROWS: invalid value"
  35. #endif
  36. #define MATRIX_IS_ON(row, col) (matrix_get_row(row) && (1<<col))
  37. #ifdef __cplusplus
  38. extern "C" {
  39. #endif
  40. /* number of matrix rows */
  41. uint8_t matrix_rows(void);
  42. /* number of matrix columns */
  43. uint8_t matrix_cols(void);
  44. /* should be called at early stage of startup before matrix_init.(optional) */
  45. void matrix_setup(void);
  46. /* intialize matrix for scaning. */
  47. void matrix_init(void);
  48. /* scan all key states on matrix */
  49. uint8_t matrix_scan(void);
  50. /* whether modified from previous scan. used after matrix_scan. */
  51. bool matrix_is_modified(void) __attribute__ ((deprecated));
  52. /* whether a switch is on */
  53. bool matrix_is_on(uint8_t row, uint8_t col);
  54. /* matrix state on row */
  55. matrix_row_t matrix_get_row(uint8_t row);
  56. /* print matrix for debug */
  57. void matrix_print(void);
  58. /* power control */
  59. void matrix_power_up(void);
  60. void matrix_power_down(void);
  61. /* executes code for Quantum */
  62. void matrix_init_quantum(void);
  63. void matrix_scan_quantum(void);
  64. void matrix_init_kb(void);
  65. void matrix_scan_kb(void);
  66. void matrix_init_user(void);
  67. void matrix_scan_user(void);
  68. #ifdef I2C_SPLIT
  69. void slave_matrix_init(void);
  70. uint8_t slave_matrix_scan(void);
  71. #endif
  72. #ifdef __cplusplus
  73. }
  74. #endif
  75. #endif