This is the documentation for the latest (main) development branch of Zephyr. If you are looking for the documentation of previous releases, use the drop-down menu on the left and select the desired version.

nuvoton,npcx-kbd

Vendor: Nuvoton Technology Corporation

Description

Nuvoton NPCX keyboard scan controller

Properties

Properties not inherited from the base binding file.

Name

Type

Details

row-size

int

 
The number of rows in the keyboard matrix.

This property is required.

col-size

int

 
The number of column in the keyboard matrix.

This property is required.

poll-period-ms

int

 
Defines the poll period in msecs between between matrix scans, set to 0
to never exit poll mode. Defaults to 5ms if unspecified.

Default value: 5

poll-timeout-ms

int

 
How long to wait before going from polling back to idle state. Defaults
to 100ms if unspecified.

Default value: 100

debounce-down-ms

int

 
Debouncing time for a key press event. Defaults to 10ms if unspecified.

Default value: 10

debounce-up-ms

int

 
Debouncing time for a key release event. Defaults to 20ms if unspecified.

Default value: 20

settle-time-us

int

 
Delay between setting column output and reading the row values. Defaults
to 50us if unspecified.

Default value: 50

actual-key-mask

array

 
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

 
Ignore the ghost key checking in the driver if the diodes are used
in the matrix hardware.

pinctrl-0

phandles

 
Pin configuration/s for the first state. Content is specific to the
selected pin controller driver implementation.

This property is required.

pinctrl-1

phandles

 
Pin configuration/s for the second state. See pinctrl-0.

pinctrl-2

phandles

 
Pin configuration/s for the third state. See pinctrl-0.

pinctrl-3

phandles

 
Pin configuration/s for the fourth state. See pinctrl-0.

pinctrl-4

phandles

 
Pin configuration/s for the fifth state. See pinctrl-0.

pinctrl-names

string-array

 
Names for the provided states. The number of names needs to match the
number of states.

This property is required.

wui-maps

phandles

 
Mapping table between Wake-Up Input (WUI) and KSIs.

For example the WUI mapping on 8 KSI pads would be
   wui-maps = <&wui_io30 &wui_io31 &wui_io27 &wui_io26
               &wui_io25 &wui_io24 &wui_io23 &wui_io22>;

This property is required.