gpio_utils.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 Intel Corporation.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_DRIVERS_GPIO_GPIO_UTILS_H_
#define ZEPHYR_INCLUDE_DRIVERS_GPIO_GPIO_UTILS_H_

 
#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>
#include <zephyr/tracing/tracing.h>
 
#ifdef __cplusplus
extern "C" {
#endif

#define GPIO_PORT_PIN_MASK_FROM_NGPIOS(ngpios)                  \
        ((gpio_port_pins_t)(((uint64_t)1 << (ngpios)) - 1U))

#define GPIO_PORT_PIN_MASK_FROM_DT_NODE(node_id)                \
        GPIO_DT_PORT_PIN_MASK_NGPIOS_EXC(node_id, DT_PROP(node_id, ngpios))

#define GPIO_PORT_PIN_MASK_FROM_DT_INST(inst)                   \
        GPIO_PORT_PIN_MASK_FROM_DT_NODE(DT_DRV_INST(inst))
 

#define GPIO_COMMON_CONFIG_FROM_DT_NODE(node_id)                           \
        {                                                                  \
                .port_pin_mask = GPIO_PORT_PIN_MASK_FROM_DT_NODE(node_id), \
        }

#define GPIO_COMMON_CONFIG_FROM_DT_INST(inst)                   \
        GPIO_COMMON_CONFIG_FROM_DT_NODE(DT_DRV_INST(inst))

static inline int gpio_manage_callback(sys_slist_t *callbacks,
                                        struct gpio_callback *callback,
                                        bool set)
{
        __ASSERT(callback, "No callback!");
        __ASSERT(callback->handler, "No callback handler!");
 
        if (!sys_slist_is_empty(callbacks)) {
                if (!sys_slist_find_and_remove(callbacks, &callback->node)) {
                        if (!set) {
                                return -EINVAL;
                        }
                }
        } else if (!set) {
                return -EINVAL;
        }
 
        if (set) {
                sys_slist_prepend(callbacks, &callback->node);
        }
 
        return 0;
}

static inline void gpio_fire_callbacks(sys_slist_t *list,
                                        const struct device *port,
                                        uint32_t pins)
{
        struct gpio_callback *cb, *tmp;
 
        sys_port_trace_gpio_fire_callbacks_enter(list, port, pins);
 
        SYS_SLIST_FOR_EACH_CONTAINER_SAFE(list, cb, tmp, node) {
                if (cb->pin_mask & pins) {
                        __ASSERT(cb->handler, "No callback handler!");
 
                        cb->handler(port, cb, cb->pin_mask & pins);
                        sys_port_trace_gpio_fire_callback(port, cb);
                }
        }
}
 
#ifdef __cplusplus
}
#endif

 
#endif /* ZEPHYR_INCLUDE_DRIVERS_GPIO_GPIO_UTILS_H_ */