:orphan:
.. raw:: html
.. dtcompatible:: gpio-kbd-matrix
.. _dtbinding_gpio_kbd_matrix:
gpio-kbd-matrix
###############
Vendor: :ref:`Generic or vendor-independent `
Description
***********
.. code-block:: none
GPIO based keyboard matrix input device
Implement an input device for a GPIO based keyboard matrix.
Example configuration:
kbd-matrix {
compatible = "gpio-kbd-matrix";
row-gpios = <&gpio0 0 (GPIO_PULL_UP | GPIO_ACTIVE_LOW)>,
<&gpio0 1 (GPIO_PULL_UP | GPIO_ACTIVE_LOW)>;
col-gpios = <&gpio0 2 GPIO_ACTIVE_LOW>,
<&gpio0 3 GPIO_ACTIVE_LOW>,
<&gpio0 4 GPIO_ACTIVE_LOW>;
no-ghostkey-check;
};
Properties
**********
.. tabs::
.. group-tab:: Node specific properties
Properties not inherited from the base binding file.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``row-gpios``
- ``phandle-array``
- .. code-block:: none
GPIO for the keyboard matrix rows, up to 8 different GPIOs. All row GPIO
pins must have interrupt support if idle-mode is set to "interrupt"
(default).
This property is **required**.
* - ``col-gpios``
- ``phandle-array``
- .. code-block:: none
GPIO for the keyboard matrix columns, supports up to 32 different GPIOs.
When unselected, this pin will be either driven to inactive state or
configured to high impedance (input) depending on the col-drive-inactive
property.
This property is **required**.
* - ``col-drive-inactive``
- ``boolean``
- .. code-block:: none
If enabled, unselected column GPIOs will be driven to inactive state.
Default to configure unselected column GPIOs to high impedance.
* - ``idle-mode``
- ``string``
- .. code-block:: none
Controls the driver behavior on idle, "interrupt" waits for a new key
press using GPIO interrupts on the row lines, "poll" periodically polls
the row lines with all the columns selected, "scan" just keep scanning
the matrix continuously, requires "poll-timeout-ms" to be set to 0.
Default value: ``interrupt``
Legal values: ``'interrupt'``, ``'poll'``, ``'scan'``
* - ``poll-period-ms``
- ``int``
- .. code-block:: none
Defines the poll period in msecs between between matrix scans, set to 0
to never exit poll mode. Defaults to 5ms if unspecified.
Default value: ``5``
* - ``poll-timeout-ms``
- ``int``
- .. code-block:: none
How long to wait before going from polling back to idle state. Defaults
to 100ms if unspecified.
Default value: ``100``
* - ``debounce-down-ms``
- ``int``
- .. code-block:: none
Debouncing time for a key press event. Defaults to 10ms if unspecified.
Default value: ``10``
* - ``debounce-up-ms``
- ``int``
- .. code-block:: none
Debouncing time for a key release event. Defaults to 20ms if unspecified.
Default value: ``20``
* - ``settle-time-us``
- ``int``
- .. code-block:: none
Delay between setting column output and reading the row values. Defaults
to 50us if unspecified.
Default value: ``50``
* - ``actual-key-mask``
- ``array``
- .. code-block:: none
Keyboard scanning mask. For each keyboard column, specify which keyboard rows actually exist. Can be used to avoid triggering the ghost detection on non existing keys. No masking by default, any combination is valid.
* - ``no-ghostkey-check``
- ``boolean``
- .. code-block:: none
Ignore the ghost key checking in the driver if the diodes are used
in the matrix hardware.
.. group-tab:: Deprecated node specific properties
Deprecated properties not inherited from the base binding file.
(None)
.. group-tab:: Base properties
Properties inherited from the base binding file, which defines
common properties that may be set on many nodes. Not all of these
may apply to the "gpio-kbd-matrix" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``status``
- ``string``
- .. code-block:: none
indicates the operational status of a device
Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``
See :ref:`dt-important-props` for more information.
* - ``compatible``
- ``string-array``
- .. code-block:: none
compatible strings
This property is **required**.
See :ref:`dt-important-props` for more information.
* - ``reg``
- ``array``
- .. code-block:: none
register space
See :ref:`dt-important-props` for more information.
* - ``reg-names``
- ``string-array``
- .. code-block:: none
name of each register space
* - ``interrupts``
- ``array``
- .. code-block:: none
interrupts for device
See :ref:`dt-important-props` for more information.
* - ``interrupts-extended``
- ``compound``
- .. code-block:: none
extended interrupt specifier for device
* - ``interrupt-names``
- ``string-array``
- .. code-block:: none
name of each interrupt
* - ``interrupt-parent``
- ``phandle``
- .. code-block:: none
phandle to interrupt controller node
* - ``label``
- ``string``
- .. code-block:: none
Human readable string describing the device (used as device_get_binding() argument)
See :ref:`dt-important-props` for more information.
This property is **deprecated**.
* - ``clocks``
- ``phandle-array``
- .. code-block:: none
Clock gate information
* - ``clock-names``
- ``string-array``
- .. code-block:: none
name of each clock
* - ``#address-cells``
- ``int``
- .. code-block:: none
number of address cells in reg property
* - ``#size-cells``
- ``int``
- .. code-block:: none
number of size cells in reg property
* - ``dmas``
- ``phandle-array``
- .. code-block:: none
DMA channels specifiers
* - ``dma-names``
- ``string-array``
- .. code-block:: none
Provided names of DMA channel specifiers
* - ``io-channels``
- ``phandle-array``
- .. code-block:: none
IO channels specifiers
* - ``io-channel-names``
- ``string-array``
- .. code-block:: none
Provided names of IO channel specifiers
* - ``mboxes``
- ``phandle-array``
- .. code-block:: none
mailbox / IPM channels specifiers
* - ``mbox-names``
- ``string-array``
- .. code-block:: none
Provided names of mailbox / IPM channel specifiers
* - ``wakeup-source``
- ``boolean``
- .. code-block:: none
Property to identify that a device can be used as wake up source.
When this property is provided a specific flag is set into the
device that tells the system that the device is capable of
wake up the system.
Wake up capable devices are disabled (interruptions will not wake up
the system) by default but they can be enabled at runtime if necessary.
* - ``power-domain``
- ``phandle``
- .. code-block:: none
Power domain the device belongs to.
The device will be notified when the power domain it belongs to is either
suspended or resumed.
* - ``zephyr,pm-device-runtime-auto``
- ``boolean``
- .. code-block:: none
Automatically configure the device for runtime power management after the
init function runs.