Skip to content

Commit 42d9cf1

Browse files
fabiobaltiericarlescufi
authored andcommitted
doc: input: expand the kscan compatibility description
Add few details about the kscan compatibility driver, mention the relevant Kconfig options and an example (which is also present in the binding file). Signed-off-by: Fabio Baltieri <[email protected]>
1 parent d793764 commit 42d9cf1

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

doc/services/input/index.rst

+18-3
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,24 @@ Kscan Compatibility
5959
*******************
6060

6161
Input devices generating X/Y/Touch events can be used in existing applications
62-
based on the :ref:`kscan_api` API by defining a
63-
:dtcompatible:`zephyr,kscan-input` node as a childnode of the corresponding
64-
input device.
62+
based on the :ref:`kscan_api` API by enabling both
63+
:kconfig:option:`CONFIG_INPUT` and :kconfig:option:`CONFIG_KSCAN`, defining a
64+
:dtcompatible:`zephyr,kscan-input` node as a child node of the corresponding
65+
input device and pointing the ``zephyr,keyboard-scan`` chosen node to the
66+
compatibility device node, for example:
67+
68+
.. code-block:: devicetree
69+
70+
chosen {
71+
zephyr,keyboard-scan = &kscan_input;
72+
};
73+
74+
ft5336@38 {
75+
...
76+
kscan_input: kscan-input {
77+
compatible = "zephyr,kscan-input";
78+
};
79+
};
6580
6681
API Reference
6782
*************

0 commit comments

Comments
 (0)