zmk_mf68/app/drivers/zephyr/dts/bindings/kscan/zmk,kscan-gpio-matrix.yaml

# Copyright (c) 2020, Pete Johanson
# SPDX-License-Identifier: MIT

description: GPIO keyboard matrix controller

compatible: "zmk,kscan-gpio-matrix"

include: kscan.yaml

properties:
  row-gpios:
    type: phandle-array
    required: true
  col-gpios:
    type: phandle-array
    required: true
  debounce-period:
    type: int
    required: false
    deprecated: true
    description: Deprecated. Use debounce-press-ms and debounce-release-ms instead.
  debounce-press-ms:
    type: int
    default: 5
    description: Debounce time for key press in milliseconds. Use 0 for eager debouncing.
  debounce-release-ms:
    type: int
    default: 5
    description: Debounce time for key release in milliseconds.
  debounce-scan-period-ms:
    type: int
    default: 1
    description: Time between reads in milliseconds when any key is pressed.
  poll-period-ms:
    type: int
    default: 10
    description: Time between reads in milliseconds when no key is pressed and ZMK_KSCAN_MATRIX_POLLING is enabled.
  diode-direction:
    type: string
    default: row2col
    enum:
      - row2col
      - col2row
Initial import of GPIO kscan driver into ZMK. 2020-05-27 10:48:15 +10:00			`# Copyright (c) 2020, Pete Johanson`
Fix remaining Apache header lines. 2020-06-09 23:54:13 +10:00			`# SPDX-License-Identifier: MIT`
Initial import of GPIO kscan driver into ZMK. 2020-05-27 10:48:15 +10:00
			`description: GPIO keyboard matrix controller`

Initial working Clueboard California Macropad w/ proton-c fixes * Basic Clueboard Californai Macropad shield definition. * New "direct" KSCAN driver that supports non-matrix direct wiring for switches, needed for macropad that doesn't have a matrix at all. * Some renames for existing KSCAN GPIO driver to make the implied "matrix" part explicit. 2020-06-25 00:06:35 +10:00			`compatible: "zmk,kscan-gpio-matrix"`
Initial import of GPIO kscan driver into ZMK. 2020-05-27 10:48:15 +10:00
			`include: kscan.yaml`

			`properties:`
Fix remaining Apache header lines. 2020-06-09 23:54:13 +10:00			`row-gpios:`
			`type: phandle-array`
			`required: true`
			`col-gpios:`
			`type: phandle-array`
			`required: true`
			`debounce-period:`
feat(kscan): Improve matrix debouncing Switched the GPIO matrix driver to debouncing using a simple integrator algorithm. Whenever a key is pressed, we now scan at a rate controlled by debounce-scan-period-ms (default 1 ms) until all keys are released, then return to either waiting for an interrupt or polling more slowly. The timers for key press and release can now be controlled separately, so debounce-period is deprecated in favor of debounce-press-ms and debounce-release-ms. Global Kconfig options ZMK_KSCAN_DEBOUNCE_PRESS_MS and ZMK_KSCAN_DEBOUNCE_RELEASE_MS are also added to make these easier to set. Added documentation for debouncing options. 2021-07-31 16:23:33 +10:00			`type: int`
			`required: false`
			`deprecated: true`
			`description: Deprecated. Use debounce-press-ms and debounce-release-ms instead.`
			`debounce-press-ms:`
			`type: int`
			`default: 5`
			`description: Debounce time for key press in milliseconds. Use 0 for eager debouncing.`
			`debounce-release-ms:`
Fix remaining Apache header lines. 2020-06-09 23:54:13 +10:00			`type: int`
			`default: 5`
feat(kscan): Improve matrix debouncing Switched the GPIO matrix driver to debouncing using a simple integrator algorithm. Whenever a key is pressed, we now scan at a rate controlled by debounce-scan-period-ms (default 1 ms) until all keys are released, then return to either waiting for an interrupt or polling more slowly. The timers for key press and release can now be controlled separately, so debounce-period is deprecated in favor of debounce-press-ms and debounce-release-ms. Global Kconfig options ZMK_KSCAN_DEBOUNCE_PRESS_MS and ZMK_KSCAN_DEBOUNCE_RELEASE_MS are also added to make these easier to set. Added documentation for debouncing options. 2021-07-31 16:23:33 +10:00			`description: Debounce time for key release in milliseconds.`
			`debounce-scan-period-ms:`
			`type: int`
			`default: 1`
			`description: Time between reads in milliseconds when any key is pressed.`
refactor(kscan): Demacroify GPIO matrix driver Refactored the GPIO matrix kscan driver so that only the data and config structures are defined in the foreach macro. Functionality is unchanged except for the addition of DT properties to adjust polling speed. This should make it easier to add other enhancements later, like improved and customizable debounce behavior. 2021-07-26 06:23:04 +10:00			`poll-period-ms:`
			`type: int`
			`default: 10`
feat(kscan): Improve matrix debouncing Switched the GPIO matrix driver to debouncing using a simple integrator algorithm. Whenever a key is pressed, we now scan at a rate controlled by debounce-scan-period-ms (default 1 ms) until all keys are released, then return to either waiting for an interrupt or polling more slowly. The timers for key press and release can now be controlled separately, so debounce-period is deprecated in favor of debounce-press-ms and debounce-release-ms. Global Kconfig options ZMK_KSCAN_DEBOUNCE_PRESS_MS and ZMK_KSCAN_DEBOUNCE_RELEASE_MS are also added to make these easier to set. Added documentation for debouncing options. 2021-07-31 16:23:33 +10:00			`description: Time between reads in milliseconds when no key is pressed and ZMK_KSCAN_MATRIX_POLLING is enabled.`
Fix remaining Apache header lines. 2020-06-09 23:54:13 +10:00			`diode-direction:`
			`type: string`
			`default: row2col`
			`enum:`
			`- row2col`
			`- col2row`