:orphan:
.. raw:: html
.. dtcompatible:: realtek,bee-keyscan
.. _dtbinding_realtek_bee_keyscan:
realtek,bee-keyscan
###################
.. sidebar:: Overview
:Name: ``realtek,bee-keyscan``
:Vendor: :ref:`Realtek Semiconductor Corp. `
:Used in: :zephyr:board-catalog:`List of boards <#compatibles=realtek,bee-keyscan>` using
this compatible
:Driver: :zephyr_file:`drivers/input/input_bee_keyscan.c`
Description
***********
.. code-block:: none
Bee Keyscan.
The Bee Keyscan should be used with an external keyscan matrix.
There is a total of 12 rows and 20 columns.
You can assign any available pins to row or colunm by pinctrl.
The rows and columns need to be indexed starting from 0.
Examples
********
.. code-block:: dts
&keyscan {
pinctrl-0 = <&keyscan_default>;
pinctrl-names = "default";
row-size = <2>;
col-size = <2>;
debounce-down-ms = <10>;
debounce-up-ms = <10>;
poll-period-us = <10000>;
release-time-us = <10000>;
status = "okay";
};
&pinctrl {
keyscan_default: keyscan_default {
group1 {
psels = ,
;
output-enable;
output-low;
bias-disable;
};
group2 {
psels = ,
;
output-disable;
bias-pull-up;
bias-pull-strong;
};
};
};
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
* - ``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
Actual row size of the external keyscan matrix.
Hardware supports up to 12 rows.
This property is **required**.
Default value: ``2``
* - ``col-size``
- ``int``
- .. code-block:: none
Actual column size of the external keyscan matrix.
Hardware supports up to 20 columns.
This property is **required**.
Default value: ``2``
* - ``scan-div``
- ``int``
- .. code-block:: none
Clock divider for the Keyscan scanning clock.
Formula: scan_clock = source_clock / (scan-div + 1).
Assuming the source_clock is 5MHz, the default value 1 results in a 2.5MHz scan_clock.
Maximum value: 65535.
Default value: ``1``
* - ``delay-div``
- ``int``
- .. code-block:: none
Clock divider for the Keyscan delay clock (used for debounce, poll interval and release).
Formula: delay_clock = scan_clock / (delay-div + 1).
With the default 2.5MHz scan_clock, the default value 49 results in a 50kHz delay_clock.
Maximum value: 255.
poll-period-us and release-time-us each depend on the delay_clock period
(T_delay = 1 / delay_clock), and each has its own maximum of 512 ticks.
With the default 50kHz delay_clock (20us period), all three properties have:
- Resolution: 20us
- Range: 0 to 10240us
Default value: ``49``
* - ``poll-period-us``
- ``int``
- .. code-block:: none
Keyscan interval during scans, in microseconds.
In manual mode, there is no hardware limit on this value because key
scanning is driven by a software timer.
In auto mode, the allowed range depends on the delay clock period
(T_delay = 1 / delay_clock) and the maximum delay counter value
(512 ticks).
Default value: ``5000``
* - ``release-time-us``
- ``int``
- .. code-block:: none
Time to detect all keys released in auto-scan mode.
Default value: ``5000``
* - ``stable-poll-period-us``
- ``int``
- .. code-block:: none
Defines the poll period in usecs between matrix scans when the matrix is
stable, defaults to poll-period-us value if unspecified.
* - ``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 "realtek,bee-keyscan" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``reg``
- ``array``
- .. code-block:: none
Information used to address the device. The value is specific to
the device (i.e. is different depending on the compatible
property).
The "reg" property is typically a sequence of (address, length) pairs.
Each pair is called a "register block". Values are
conventionally written in hex.
For details, see "2.3.6 reg" in Devicetree Specification v0.4.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``clocks``
- ``phandle-array``
- .. code-block:: none
Information about the device's clock providers. In general, this property
should follow conventions established in the dt-schema binding:
https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/clock/clock.yaml
This property is **required**.
* - ``interrupts``
- ``array``
- .. code-block:: none
Information about interrupts generated by the device, encoded as an array
of one or more interrupt specifiers. The format of the data in this property
varies by where the device appears in the interrupt tree. Devices with the same
"interrupt-parent" will use the same format in their interrupts properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``status``
- ``string``
- .. code-block:: none
Indicates the operational status of the hardware or other
resource that the node represents. In particular:
- "okay" means the resource is operational and, for example,
can be used by device drivers
- "disabled" means the resource is not operational and the system
should treat it as if it is not present
For details, see "2.3.4 status" in Devicetree Specification v0.4.
Legal values: ``okay``, ``disabled``, ``reserved``, ``fail``, ``fail-sss``
See :ref:`zephyr:dt-important-props` for more information.
* - ``compatible``
- ``string-array``
- .. code-block:: none
This property is a list of strings that essentially define what
type of hardware or other resource this devicetree node
represents. Each device driver checks for specific compatible
property values to find the devicetree nodes that represent
resources that the driver should manage.
The recommended format is "vendor,device", The "vendor" part is
an abbreviated name of the vendor. The "device" is usually from
the datasheet.
The compatible property can have multiple values, ordered from
most- to least-specific. Having additional values is useful when the
device is a specific instance of a more general family, to allow the
system to match the most specific driver available.
For details, see "2.3.1 compatible" in Devicetree Specification v0.4.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg-names``
- ``string-array``
- .. code-block:: none
Optional names given to each register block in the "reg" property.
For example:
/ {
soc {
#address-cells = <1>;
#size-cells = <1>;
uart@1000 {
reg = <0x1000 0x2000>, <0x3000 0x4000>;
reg-names = "foo", "bar";
};
};
};
The uart@1000 node has two register blocks:
- one with base address 0x1000, size 0x2000, and name "foo"
- another with base address 0x3000, size 0x4000, and name "bar"
* - ``interrupts-extended``
- ``compound``
- .. code-block:: none
Extended interrupt specifier for device, used as an alternative to
the "interrupts" property.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``interrupt-names``
- ``string-array``
- .. code-block:: none
Optional names given to each interrupt generated by a device.
The interrupts themselves are defined in either "interrupts" or
"interrupts-extended" properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``interrupt-parent``
- ``phandle``
- .. code-block:: none
If present, this refers to the node which handles interrupts generated
by this device.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``label``
- ``string``
- .. code-block:: none
Human readable string describing the device. Use of this property is
deprecated except as needed on a case-by-case basis.
For details, see "4.1.2 Miscellaneous Properties" in Devicetree
Specification v0.4.
See :ref:`zephyr:dt-important-props` for more information.
* - ``clock-names``
- ``string-array``
- .. code-block:: none
Optional names given to each clock provider in the "clocks" property.
* - ``#address-cells``
- ``int``
- .. code-block:: none
This property encodes the number of cells used by address fields
in "reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
* - ``#size-cells``
- ``int``
- .. code-block:: none
This property encodes the number of cells used by size fields in
"reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
* - ``dmas``
- ``phandle-array``
- .. code-block:: none
DMA channel specifiers relevant to the device.
* - ``dma-names``
- ``string-array``
- .. code-block:: none
Optional names given to the DMA channel specifiers in the "dmas" property.
* - ``io-channels``
- ``phandle-array``
- .. code-block:: none
IO channel specifiers relevant to the device.
* - ``io-channel-names``
- ``string-array``
- .. code-block:: none
Optional names given to the IO channel specifiers in the "io-channels" property.
* - ``mboxes``
- ``phandle-array``
- .. code-block:: none
Mailbox / IPM channel specifiers relevant to the device.
* - ``mbox-names``
- ``string-array``
- .. code-block:: none
Optional names given to the mbox specifiers in the "mboxes" property.
* - ``power-domains``
- ``phandle-array``
- .. code-block:: none
Power domain specifiers relevant to the device.
* - ``power-domain-names``
- ``string-array``
- .. code-block:: none
Optional names given to the power domain specifiers in the "power-domains" property.
* - ``#power-domain-cells``
- ``int``
- .. code-block:: none
Number of cells in power-domains property
* - ``hwlocks``
- ``phandle-array``
- .. code-block:: none
HW spinlock id relevant to the device.
* - ``hwlock-names``
- ``string-array``
- .. code-block:: none
Optional names given to the hwlock specifiers in the "hwlocks" property.
* - ``zephyr,deferred-init``
- ``boolean``
- .. code-block:: none
Do not initialize device automatically on boot. Device should be manually
initialized using device_init().
* - ``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.
* - ``zephyr,pm-device-runtime-auto``
- ``boolean``
- .. code-block:: none
Automatically configure the device for runtime power management after the
init function runs.
* - ``zephyr,disabling-power-states``
- ``phandles``
- .. code-block:: none
List of power states that will disable this device power.