Skip to content

Commit 60d5657

Browse files
franciscomunozandrewboie
authored andcommitted
doc: peripherals: KSCAN API documentation
Append KSCAN API to the list of peripherals Signed-off-by: Francisco Munoz <[email protected]>
1 parent a755bac commit 60d5657

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

doc/reference/peripherals/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Peripherals
1616
i2c.rst
1717
i2s.rst
1818
ipm.rst
19+
kscan.rst
1920
pinmux.rst
2021
pwm.rst
2122
ps2.rst
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
.. _kscan:
2+
3+
4+
KSCAN
5+
#####
6+
7+
Overview
8+
********
9+
The kscan driver (keyboard scan matrix) is used for detecting a key press in a
10+
connected matrix keyboard or any device with buttons such as joysticks.
11+
Typically, matrix keyboards are implemented using a two-dimensional
12+
configuration in order to sense several keys. This allows interfacing to
13+
many keys through fewer physical pins. Keyboard matrix
14+
drivers read the rows while applying power through the columns one at a time
15+
with the purpose of detecting key events.
16+
There is no correlation between the physical and electrical layout of keys.
17+
For, example, the physical layout may be one array of 16 or fewer keys, which
18+
may be electrically connected to a 4 x 4 array. In addition, key values are
19+
defined by a keymap provided by the keyboard manufacturer.
20+
21+
Configuration Options
22+
*********************
23+
24+
Related configuration options:
25+
26+
* :option:`CONFIG_KSCAN`
27+
28+
API Reference
29+
*************
30+
31+
.. doxygengroup:: kscan_interface
32+
:project: Zephyr

0 commit comments

Comments
 (0)