Zephyr API Documentation  3.7.0-rc3
A Scalable Open Source RTOS
No Matches
kscan.h File Reference

Public API for Keyboard scan matrix devices. More...

#include <errno.h>
#include <zephyr/types.h>
#include <stddef.h>
#include <zephyr/device.h>
#include <zephyr/syscalls/kscan.h>

Go to the source code of this file.


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.


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

Public API for Keyboard scan matrix devices.

The scope of this API is simply to report which key event was triggered and users can later decode keys using their desired scan code tables in their application. In addition, typematic rate and delay can easily be implemented using a timer if desired.