Zephyr Project API  3.3.0
A Scalable Open Source RTOS
GPIO KeysDriver APIs

GPIO Keys Driver APIs. More...

Data Structures

struct  gpio_keys_api
 

Functions

int gpio_keys_enable_interrupt (const struct device *dev, gpio_keys_callback_handler_t cb)
 Enable interrupt. More...
 
int gpio_keys_disable_interrupt (const struct device *dev)
 Disable interrupt. More...
 
int gpio_keys_get_pin (const struct device *dev, uint32_t idx)
 Get the logical level of GPIO Key. More...
 

Detailed Description

GPIO Keys Driver APIs.

Function Documentation

◆ gpio_keys_disable_interrupt()

int gpio_keys_disable_interrupt ( const struct device dev)

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

Disable interrupt.

Parameters
devPointer to device structure for the driver instance.
Returns
0 If successful

◆ gpio_keys_enable_interrupt()

int gpio_keys_enable_interrupt ( const struct device dev,
gpio_keys_callback_handler_t  cb 
)

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

Enable interrupt.

Parameters
devPointer to device structure for the driver instance.
cbFunction callback to be invoked after GPIO key has been debounced
Returns
0 If successful

◆ gpio_keys_get_pin()

int gpio_keys_get_pin ( const struct device dev,
uint32_t  idx 
)

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

Get the logical level of GPIO Key.

Parameters
devPointer to device structure for the driver instance.
idxGPIO Key index in device tree
Return values
0If successful.
-EIOI/O error when accessing an external GPIO chip.
-EWOULDBLOCKif operation would block.