gpio_utils.h File Reference

#include <stdbool.h>
#include <stdint.h>
#include <errno.h>
#include <zephyr/devicetree.h>
#include <zephyr/drivers/gpio.h>
#include <zephyr/sys/__assert.h>
#include <zephyr/sys/slist.h>

Go to the source code of this file.

Macros
#define	GPIO_PORT_PIN_MASK_FROM_NGPIOS(ngpios)
#define	GPIO_PORT_PIN_MASK_FROM_DT_NODE(node_id)
	Makes a bitmask of allowed GPIOs from the "gpio-reserved-ranges" and "ngpios" DT properties values.
#define	GPIO_PORT_PIN_MASK_FROM_DT_INST(inst)
	Make a bitmask of allowed GPIOs from a DT_DRV_COMPAT instance's GPIO "gpio-reserved-ranges" and "ngpios" DT properties values.

Functions
static int	gpio_manage_callback (sys_slist_t *callbacks, struct gpio_callback *callback, bool set)
	Generic function to insert or remove a callback from a callback list.
static void	gpio_fire_callbacks (sys_slist_t *list, const struct device *port, uint32_t pins)
	Generic function to go through and fire callback from a callback list.

Macro Definition Documentation

GPIO_PORT_PIN_MASK_FROM_DT_INST

#define GPIO_PORT_PIN_MASK_FROM_DT_INST

(

inst

)

Value:

        GPIO_PORT_PIN_MASK_FROM_DT_NODE(DT_DRV_INST(inst))

Make a bitmask of allowed GPIOs from a DT_DRV_COMPAT instance's GPIO "gpio-reserved-ranges" and "ngpios" DT properties values.

Parameters

inst	DT_DRV_COMPAT instance number

Returns

the bitmask of allowed gpios

See also

GPIO_DT_PORT_PIN_MASK_NGPIOS_EXC()

GPIO_PORT_PIN_MASK_FROM_DT_NODE

#define GPIO_PORT_PIN_MASK_FROM_DT_NODE

(

node_id

)

Value:

        GPIO_DT_PORT_PIN_MASK_NGPIOS_EXC(node_id, DT_PROP(node_id, ngpios))

Makes a bitmask of allowed GPIOs from the "gpio-reserved-ranges" and "ngpios" DT properties values.

Parameters

node_id

GPIO controller node identifier.

Returns

the bitmask of allowed gpios

See also

GPIO_DT_PORT_PIN_MASK_NGPIOS_EXC()

GPIO_PORT_PIN_MASK_FROM_NGPIOS

#define GPIO_PORT_PIN_MASK_FROM_NGPIOS

(

ngpios

)

Value:

        ((gpio_port_pins_t)(((uint64_t)1 << (ngpios)) - 1U))

Function Documentation

gpio_fire_callbacks()

static void gpio_fire_callbacks ( sys_slist_t * list, const struct device * port, uint32_t pins )

inlinestatic

Generic function to go through and fire callback from a callback list.

Parameters

list	A pointer on the gpio callback list
port	A pointer on the gpio driver instance
pins	The actual pin mask that triggered the interrupt

gpio_manage_callback()

static int gpio_manage_callback ( sys_slist_t * callbacks, struct gpio_callback * callback, bool set )

inlinestatic

Generic function to insert or remove a callback from a callback list.

Parameters

callbacks	A pointer to the original list of callbacks (can be NULL)
callback	A pointer of the callback to insert or remove from the list
set	A boolean indicating insertion or removal of the callback

Returns

0 on success, negative errno otherwise.