:orphan:

.. raw:: html

    <!--
    FIXME: do not limit page width until content uses another representation
    format other than tables
    -->
    <style>.wy-nav-content { max-width: none; !important }</style>

.. dtcompatible:: ite,it8xxx2-kbd
.. _dtbinding_ite_it8xxx2_kbd:

ite,it8xxx2-kbd
###############

Vendor: :ref:`ITE Tech. Inc. <dt_vendor_ite>`

Description
***********



.. code-block:: none

   ITE it8xxx2 keyboard matrix controller

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

         * - ``wucctrl``
           - ``phandles``
           - .. code-block:: none

                Configure wakeup controller, this controller is used to set that
                when the interrupt is triggered in EC low power mode, it can wakeup
                EC or not. Via this controller, we set the wakeup trigger edge,
                enable, disable, and clear wakeup status for the specific pin which
                may be gpio pins or alternate pins.



         * - ``kso16-gpios``
           - ``phandle-array``
           - .. code-block:: none

                The KSO16 pin for the selected port.



             This property is **required**.

         * - ``kso17-gpios``
           - ``phandle-array``
           - .. code-block:: none

                The KSO17 pin for the selected port.



             This property is **required**.

         * - ``pinctrl-0``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the first state. Content is specific to the
                selected pin controller driver implementation.



             This property is **required**.

         * - ``pinctrl-names``
           - ``string-array``
           - .. code-block:: none

                Names for the provided states. The number of names needs to match the
                number of states.



             This property is **required**.

         * - ``row-size``
           - ``int``
           - .. code-block:: none

                The number of rows in the keyboard matrix.



             This property is **required**.

         * - ``col-size``
           - ``int``
           - .. code-block:: none

                The number of column in the keyboard matrix.



             This property is **required**.

         * - ``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.



         * - ``pinctrl-1``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the second state. See pinctrl-0.



         * - ``pinctrl-2``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the third state. See pinctrl-0.



         * - ``pinctrl-3``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the fourth state. See pinctrl-0.



         * - ``pinctrl-4``
           - ``phandles``
           - .. code-block:: none

                Pin configuration/s for the fifth state. See pinctrl-0.





   .. 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 "ite,it8xxx2-kbd" compatible.

      .. list-table::
         :widths: 1 1 4
         :header-rows: 1

         * - Name
           - Type
           - Details

         * - ``reg``
           - ``array``
           - .. code-block:: none

                register space


             This property is **required**.

             See :ref:`zephyr:dt-important-props` for more information.

         * - ``interrupts``
           - ``array``
           - .. code-block:: none

                interrupts for device


             This property is **required**.

             See :ref:`zephyr:dt-important-props` for more information.

         * - ``status``
           - ``string``
           - .. code-block:: none

                indicates the operational status of a device


             Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``

             See :ref:`zephyr:dt-important-props` for more information.

         * - ``compatible``
           - ``string-array``
           - .. code-block:: none

                compatible strings


             This property is **required**.

             See :ref:`zephyr:dt-important-props` for more information.

         * - ``reg-names``
           - ``string-array``
           - .. code-block:: none

                name of each register space


         * - ``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:`zephyr: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.