qmk_firmware/tmk_core/common/matrix.h

79 lines
2.1 KiB
C
Raw Normal View History

2011-07-20 15:32:52 +00:00
/*
Copyright 2011 Jun Wako <wakojun@gmail.com>
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/>.
*/
#pragma once
2010-10-23 16:17:26 +00:00
#include <stdint.h>
2010-10-23 16:17:26 +00:00
#include <stdbool.h>
2016-07-04 15:45:58 +00:00
#if (MATRIX_COLS <= 8)
2019-08-30 18:19:03 +00:00
typedef uint8_t matrix_row_t;
2016-07-04 15:45:58 +00:00
#elif (MATRIX_COLS <= 16)
2019-08-30 18:19:03 +00:00
typedef uint16_t matrix_row_t;
2016-07-04 15:45:58 +00:00
#elif (MATRIX_COLS <= 32)
2019-08-30 18:19:03 +00:00
typedef uint32_t matrix_row_t;
#else
2019-08-30 18:19:03 +00:00
# error "MATRIX_COLS: invalid value"
#endif
#define MATRIX_ROW_SHIFTER ((matrix_row_t)1)
2019-08-30 18:19:03 +00:00
#define MATRIX_IS_ON(row, col) (matrix_get_row(row) && (1 << col))
#ifdef __cplusplus
extern "C" {
#endif
2016-07-04 15:45:58 +00:00
/* number of matrix rows */
uint8_t matrix_rows(void);
2016-07-04 15:45:58 +00:00
/* number of matrix columns */
uint8_t matrix_cols(void);
2016-07-04 15:45:58 +00:00
/* should be called at early stage of startup before matrix_init.(optional) */
void matrix_setup(void);
2016-07-04 15:45:58 +00:00
/* intialize matrix for scaning. */
2010-10-23 16:17:26 +00:00
void matrix_init(void);
2016-07-04 15:45:58 +00:00
/* scan all key states on matrix */
uint8_t matrix_scan(void);
2016-07-04 15:45:58 +00:00
/* whether modified from previous scan. used after matrix_scan. */
2019-08-30 18:19:03 +00:00
bool matrix_is_modified(void) __attribute__((deprecated));
2017-02-06 00:55:08 +00:00
/* whether a switch is on */
bool matrix_is_on(uint8_t row, uint8_t col);
2016-07-04 15:45:58 +00:00
/* matrix state on row */
matrix_row_t matrix_get_row(uint8_t row);
2016-07-04 15:45:58 +00:00
/* print matrix for debug */
void matrix_print(void);
/* delay between changing matrix pin state and reading values */
void matrix_io_delay(void);
2016-07-04 15:45:58 +00:00
/* power control */
2014-11-23 04:08:05 +00:00
void matrix_power_up(void);
void matrix_power_down(void);
2016-07-04 15:45:58 +00:00
2016-05-24 03:42:21 +00:00
/* executes code for Quantum */
void matrix_init_quantum(void);
void matrix_scan_quantum(void);
void matrix_init_kb(void);
void matrix_scan_kb(void);
void matrix_init_user(void);
void matrix_scan_user(void);
#ifdef __cplusplus
}
#endif