Zephyr Project API  3.3.0
A Scalable Open Source RTOS
gpio_utils.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2016 Intel Corporation.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7
8#ifndef ZEPHYR_INCLUDE_DRIVERS_GPIO_GPIO_UTILS_H_
9#define ZEPHYR_INCLUDE_DRIVERS_GPIO_GPIO_UTILS_H_
10
11#include <stdbool.h>
12#include <stdint.h>
13#include <errno.h>
14
15#include <zephyr/devicetree.h>
16#include <zephyr/drivers/gpio.h>
17#include <zephyr/sys/__assert.h>
18#include <zephyr/sys/slist.h>
19
20#define GPIO_PORT_PIN_MASK_FROM_NGPIOS(ngpios) \
21 ((gpio_port_pins_t)(((uint64_t)1 << (ngpios)) - 1U))
22
23#define GPIO_PORT_PIN_MASK_FROM_DT_NODE(node_id) \
24 GPIO_PORT_PIN_MASK_FROM_NGPIOS(DT_PROP(node_id, ngpios))
25
26#define GPIO_PORT_PIN_MASK_FROM_DT_INST(inst) \
27 GPIO_PORT_PIN_MASK_FROM_NGPIOS(DT_INST_PROP(inst, ngpios))
28
38static inline int gpio_manage_callback(sys_slist_t *callbacks,
39 struct gpio_callback *callback,
40 bool set)
41{
42 __ASSERT(callback, "No callback!");
43 __ASSERT(callback->handler, "No callback handler!");
44
45 if (!sys_slist_is_empty(callbacks)) {
46 if (!sys_slist_find_and_remove(callbacks, &callback->node)) {
47 if (!set) {
48 return -EINVAL;
49 }
50 }
51 } else if (!set) {
52 return -EINVAL;
53 }
54
55 if (set) {
56 sys_slist_prepend(callbacks, &callback->node);
57 }
58
59 return 0;
60}
61
69static inline void gpio_fire_callbacks(sys_slist_t *list,
70 const struct device *port,
71 uint32_t pins)
72{
73 struct gpio_callback *cb, *tmp;
74
76 if (cb->pin_mask & pins) {
77 __ASSERT(cb->handler, "No callback handler!");
78 cb->handler(port, cb, cb->pin_mask & pins);
79 }
80 }
81}
82
83#endif /* ZEPHYR_INCLUDE_DRIVERS_GPIO_GPIO_UTILS_H_ */
Devicetree main header.
Public APIs for GPIO drivers.
System error numbers.
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.
Definition: gpio_utils.h:69
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.
Definition: gpio_utils.h:38
static bool sys_slist_find_and_remove(sys_slist_t *list, sys_snode_t *node)
Find and remove a node from a list.
Definition: slist.h:417
static bool sys_slist_is_empty(sys_slist_t *list)
Test if the given list is empty.
Definition: slist.h:261
static void sys_slist_prepend(sys_slist_t *list, sys_snode_t *node)
Prepend a node to the given list.
Definition: slist.h:298
#define SYS_SLIST_FOR_EACH_CONTAINER_SAFE(__sl, __cn, __cns, __n)
Provide the primitive to safely iterate on a list under a container Note: __cn can be detached,...
Definition: slist.h:180
#define EINVAL
Definition: errno.h:61
Single-linked list implementation.
struct _slist sys_slist_t
Definition: slist.h:40
__UINT32_TYPE__ uint32_t
Definition: stdint.h:90
Runtime device structure (in ROM) per driver instance.
Definition: device.h:378
GPIO callback structure.
Definition: gpio.h:480
sys_snode_t node
Definition: gpio.h:484
gpio_port_pins_t pin_mask
Definition: gpio.h:495
gpio_callback_handler_t handler
Definition: gpio.h:487