Keyboard Scan Driver APIs

KSCAN APIs. More...

Typedefs
typedef void(*	kscan_callback_t) (const struct device *dev, uint32_t row, uint32_t column, bool pressed)
	Keyboard scan callback called when user press/release a key on a matrix keyboard.

Functions
int	kscan_config (const struct device *dev, kscan_callback_t callback)
	Configure a Keyboard scan instance.
int	kscan_enable_callback (const struct device *dev)
	Enables callback.
int	kscan_disable_callback (const struct device *dev)
	Disables callback.

Detailed Description

KSCAN APIs.

Since

2.1

Version

1.0.0

Typedef Documentation

kscan_callback_t

typedef void(* kscan_callback_t) (const struct device *dev, uint32_t row, uint32_t column, bool pressed)

#include <include/zephyr/drivers/kscan.h>

Keyboard scan callback called when user press/release a key on a matrix keyboard.

Parameters

dev	Pointer to the device structure for the driver instance.
row	Describes row change.
column	Describes column change.
pressed	Describes the kind of key event.

Function Documentation

kscan_config()

int kscan_config	(	const struct device *	dev,
		kscan_callback_t	callback
	)

#include <include/zephyr/drivers/kscan.h>

Configure a Keyboard scan instance.

Parameters

dev	Pointer to the device structure for the driver instance.
callback	called when keyboard devices reply to a keyboard event such as key pressed/released.

Return values

0	If successful.
Negative	errno code if failure.

kscan_disable_callback()

int kscan_disable_callback

(

const struct device *

dev

)

#include <include/zephyr/drivers/kscan.h>

Disables callback.

Parameters

dev	Pointer to the device structure for the driver instance.

Return values

0	If successful.
Negative	errno code if failure.

kscan_enable_callback()

int kscan_enable_callback

(

const struct device *

dev

)

#include <include/zephyr/drivers/kscan.h>

Enables callback.

Parameters

dev	Pointer to the device structure for the driver instance.

Return values

0	If successful.
Negative	errno code if failure.