diff options
| author | XScorpion2 <rcalt2vt@gmail.com> | 2021-09-19 15:18:32 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-20 06:18:32 +1000 |
| commit | 4dbeeaa0d685ee7449010d2dc2a930a5921c8a8c (patch) | |
| tree | f83fb993ad8391043b759dc2015a00944db2114c /docs | |
| parent | 121ca7eca9a53727733645d9c4c90a206df02258 (diff) | |
| download | qmk_firmware-4dbeeaa0d685ee7449010d2dc2a930a5921c8a8c.tar.gz qmk_firmware-4dbeeaa0d685ee7449010d2dc2a930a5921c8a8c.zip | |
Doc Fixes & Custom Matrix Fix (#14526)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/custom_quantum_functions.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/custom_quantum_functions.md b/docs/custom_quantum_functions.md index 494e76996e..b0ed0f588d 100644 --- a/docs/custom_quantum_functions.md +++ b/docs/custom_quantum_functions.md @@ -148,8 +148,8 @@ This is useful for setting up stuff that you may need elsewhere, but isn't hardw * GPIO pin initialisation: `void matrix_init_pins(void)` * This needs to perform the low-level initialisation of all row and column pins. By default this will initialise the input/output state of each of the GPIO pins listed in `MATRIX_ROW_PINS` and `MATRIX_COL_PINS`, based on whether or not the keyboard is set up for `ROW2COL`, `COL2ROW`, or `DIRECT_PINS`. Should the keyboard designer override this function, no initialisation of pin state will occur within QMK itself, instead deferring to the keyboard's override. -* `COL2ROW`-based row reads: `void matrix_read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col)` -* `ROW2COL`-based column reads: `void matrix_read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)` +* `COL2ROW`-based row reads: `void matrix_read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)` +* `ROW2COL`-based column reads: `void matrix_read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col)` * `DIRECT_PINS`-based reads: `void matrix_read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)` * These three functions need to perform the low-level retrieval of matrix state of relevant input pins, based on the matrix type. Only one of the functions should be implemented, if needed. By default this will iterate through `MATRIX_ROW_PINS` and `MATRIX_COL_PINS`, configuring the inputs and outputs based on whether or not the keyboard is set up for `ROW2COL`, `COL2ROW`, or `DIRECT_PINS`. Should the keyboard designer override this function, no manipulation of matrix GPIO pin state will occur within QMK itself, instead deferring to the keyboard's override. |