patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

doc: input: expand the kscan compatibility description

Browse source 
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 <fabiobaltieri@google.com>
This commit is contained in:
Fabio Baltieri 2023-05-16 15:16:00 +00:00 committed by Carles Cufí
parent d793764cfa
commit 42d9cf1b9a
1 changed files with 18 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
doc/services/input/index.rst
View file

@ -59,9 +59,24 @@ Kscan Compatibility
*******************
Input devices generating X/Y/Touch events can be used in existing applications
based on the :ref:`kscan_api` API by defining a
:dtcompatible:`zephyr,kscan-input` node as a childnode of the corresponding
input device.
based on the :ref:`kscan_api` API by enabling both
:kconfig:option:`CONFIG_INPUT` and :kconfig:option:`CONFIG_KSCAN`, defining a
:dtcompatible:`zephyr,kscan-input` node as a child node of the corresponding
input device and pointing the ``zephyr,keyboard-scan`` chosen node to the
compatibility device node, for example:
.. code-block:: devicetree
chosen {
zephyr,keyboard-scan = &kscan_input;
};
ft5336@38 {
...
kscan_input: kscan-input {
compatible = "zephyr,kscan-input";
};
};
API Reference
*************