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 <fabiobaltieri@google.com>
Willmish · May 17, 2023 · 42d9cf1 · 42d9cf1
1 parent d793764
commit 42d9cf1
Showing 1 changed file with 18 additions and 3 deletions.
diff --git a/doc/services/input/index.rst b/doc/services/input/index.rst
@@ -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
 *************