summaryrefslogtreecommitdiff
path: root/quantum/matrix.h
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2021-02-07 23:16:47 +0000
committerQMK Bot <hello@qmk.fm>2021-02-07 23:16:47 +0000
commit3a98bd75c88c5cc64aed72b9d2e3a8857d949fed (patch)
tree7edcbbfa0c0efd16e456d6012f90833922d3bb3c /quantum/matrix.h
parentb8031a1613290ada50f4cb746216fcae90d8935d (diff)
parent99bffc2a21ebed07fd767ad2a9a7e1aadd491ef3 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'quantum/matrix.h')
-rw-r--r--quantum/matrix.h79
1 files changed, 79 insertions, 0 deletions
diff --git a/quantum/matrix.h b/quantum/matrix.h
new file mode 100644
index 0000000000..ce57010a47
--- /dev/null
+++ b/quantum/matrix.h
@@ -0,0 +1,79 @@
+/*
+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
+
+#include <stdint.h>
+#include <stdbool.h>
+
+#if (MATRIX_COLS <= 8)
+typedef uint8_t matrix_row_t;
+#elif (MATRIX_COLS <= 16)
+typedef uint16_t matrix_row_t;
+#elif (MATRIX_COLS <= 32)
+typedef uint32_t matrix_row_t;
+#else
+# error "MATRIX_COLS: invalid value"
+#endif
+
+#define MATRIX_ROW_SHIFTER ((matrix_row_t)1)
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* number of matrix rows */
+uint8_t matrix_rows(void);
+/* number of matrix columns */
+uint8_t matrix_cols(void);
+/* should be called at early stage of startup before matrix_init.(optional) */
+void matrix_setup(void);
+/* intialize matrix for scaning. */
+void matrix_init(void);
+/* scan all key states on matrix */
+uint8_t matrix_scan(void);
+/* whether modified from previous scan. used after matrix_scan. */
+bool matrix_is_modified(void) __attribute__((deprecated));
+/* whether a switch is on */
+bool matrix_is_on(uint8_t row, uint8_t col);
+/* matrix state on row */
+matrix_row_t matrix_get_row(uint8_t row);
+/* print matrix for debug */
+void matrix_print(void);
+/* delay between changing matrix pin state and reading values */
+void matrix_output_select_delay(void);
+void matrix_output_unselect_delay(void);
+/* only for backwards compatibility. delay between changing matrix pin state and reading values */
+void matrix_io_delay(void);
+
+/* power control */
+void matrix_power_up(void);
+void matrix_power_down(void);
+
+/* 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