gpio.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
/*
 * Author: Andreas Werner <kernel@andy89.org>
 * Date: 2016
 */
#ifndef GPIO_H_
#define GPIO_H_
#include <stdint.h>
#include <stdbool.h>
#include <mux.h> 
#include <hal.h>
 
struct gpio;
struct gpio_pin;
enum gpio_direction {
        GPIO_INPUT,
        GPIO_OUTPUT
};
enum gpio_setting {
        GPIO_OPEN,
        GPIO_PULL_UP,
        GPIO_PULL_DOWN
};
enum gpio_interrupt  {
        GPIO_FALLING,
        GPIO_RISING,
        GPIO_EITHER
};
 
#ifdef CONFIG_GPIO_MULTI
 
struct gpio_ops {
        struct gpio *(*gpio_init)(uint32_t index);
        int32_t (*gpio_deinit)(struct gpio *gpio);
        struct gpio_pin *(*gpioPin_init)(struct gpio *gpio, uint32_t pin, enum gpio_direction dir, enum gpio_setting setting);
        int32_t (*gpioPin_deinit)(struct gpio_pin *pin);
        int32_t (*gpioPin_enableInterrupt)(struct gpio_pin *pin);
        int32_t (*gpioPin_disableInterrupt)(struct gpio_pin *pin);
        int32_t (*gpioPin_setCallback)(struct gpio_pin *pin, bool (*callback)(struct gpio_pin *pin, uint32_t pinID, void *data), void *data, enum gpio_interrupt inter);
        int32_t (*gpioPin_setDirection)(struct gpio_pin *pin, enum gpio_direction dir);
        int32_t (*gpioPin_setSetting)(struct gpio_pin *pin, enum gpio_setting setting);
        int32_t (*gpioPin_SchmittTrigger)(struct gpio_pin *pin, bool schmitt);
        int32_t (*gpioPin_setValue)(struct gpio_pin *pin, bool value);
        int32_t (*gpioPin_setPin)(struct gpio_pin *pin);
        int32_t (*gpioPin_clearPin)(struct gpio_pin *pin);
        int32_t (*gpioPin_togglePin)(struct gpio_pin *pin);
        bool (*gpioPin_getValue)(struct gpio_pin *pin);
};
#endif
 
struct gpio_generic {
        bool init;
#ifdef CONFIG_INSTANCE_NAME
 
        const char *name;
#endif
#ifdef CONFIG_GPIO_MULTI
 
        const struct gpio_ops *ops;
#endif
};
struct gpio_pin_generic {
        struct gpio_generic *gpio;
};
 
#ifndef CONFIG_GPIO_MULTI
 
struct gpio *gpio_init(uint32_t index);
int32_t gpio_deinit(struct gpio *gpio);
 
struct gpio_pin *gpioPin_init(struct gpio *gpio, uint32_t pin, enum gpio_direction dir, enum gpio_setting setting);
int32_t gpioPin_deinit(struct gpio_pin *pin);
int32_t gpioPin_enableInterrupt(struct gpio_pin *pin);
int32_t gpioPin_disableInterrupt(struct gpio_pin *pin);
int32_t gpioPin_setCallback(struct gpio_pin *pin, bool (*callback)(struct gpio_pin *pin, uint32_t pinID, void *data), void *data, enum gpio_interrupt inter);
int32_t gpioPin_setDirection(struct gpio_pin *pin, enum gpio_direction dir);
int32_t gpioPin_setSetting(struct gpio_pin *pin, enum gpio_setting setting);
int32_t gpioPin_SchmittTrigger(struct gpio_pin *pin, bool schmitt);
int32_t gpioPin_setValue(struct gpio_pin *pin, bool value);
int32_t gpioPin_setPin(struct gpio_pin *pin);
int32_t gpioPin_clearPin(struct gpio_pin *pin);
int32_t gpioPin_togglePin(struct gpio_pin *pin);
bool gpioPin_getValue(struct gpio_pin *pin);
#else
inline struct gpio *gpio_init(uint32_t index) {
        HAL_DEFINE_GLOBAL_ARRAY(gpio);
        struct gpio_generic *gpio = (struct gpio_generic *) HAL_GET_DEV(gpio, index);
        if (gpio == NULL) {
                return NULL;
        }
        return gpio->ops->gpio_init(index);
}
inline int32_t gpio_deinit(struct gpio *gpio) {
        struct gpio_generic *g = (struct gpio_generic *) gpio;
        return g->ops->gpio_deinit(gpio);
}
inline struct gpio_pin *gpioPin_init(struct gpio *gpio, uint32_t pin, enum gpio_direction dir, enum gpio_setting setting) {
        struct gpio_generic *g = (struct gpio_generic *) gpio;
        return g->ops->gpioPin_init(gpio, pin, dir, setting);
}
inline int32_t gpioPin_deinit(struct gpio_pin *pin) {
        struct gpio_pin_generic *p = (struct gpio_pin_generic *) pin;
        struct gpio_generic *g = (struct gpio_generic *) p->gpio;
        return g->ops->gpioPin_deinit(pin);
}
inline int32_t gpioPin_enableInterrupt(struct gpio_pin *pin) {
        struct gpio_pin_generic *p = (struct gpio_pin_generic *) pin;
        struct gpio_generic *g = (struct gpio_generic *) p->gpio;
        return g->ops->gpioPin_enableInterrupt(pin);
}
inline int32_t gpioPin_disableInterrupt(struct gpio_pin *pin) {
        struct gpio_pin_generic *p = (struct gpio_pin_generic *) pin;
        struct gpio_generic *g = (struct gpio_generic *) p->gpio;
        return g->ops->gpioPin_disableInterrupt(pin);
}
inline int32_t gpioPin_setCallback(struct gpio_pin *pin, bool (*callback)(struct gpio_pin *pin, uint32_t pinID, void *data), void *data, enum gpio_interrupt inter) {
        struct gpio_pin_generic *p = (struct gpio_pin_generic *) pin;
        struct gpio_generic *g = (struct gpio_generic *) p->gpio;
        return g->ops->gpioPin_setCallback(pin, callback, data, inter);
}
inline int32_t gpioPin_setDirection(struct gpio_pin *pin, enum gpio_direction dir) {
        struct gpio_pin_generic *p = (struct gpio_pin_generic *) pin;
        struct gpio_generic *g = (struct gpio_generic *) p->gpio;
        return g->ops->gpioPin_setDirection(pin, dir);
}
inline int32_t gpioPin_setSetting(struct gpio_pin *pin, enum gpio_setting setting) {
        struct gpio_pin_generic *p = (struct gpio_pin_generic *) pin;
        struct gpio_generic *g = (struct gpio_generic *) p->gpio;
        return g->ops->gpioPin_setSetting(pin, setting);
}
inline int32_t gpioPin_SchmittTrigger(struct gpio_pin *pin, bool schmitt) {
        struct gpio_pin_generic *p = (struct gpio_pin_generic *) pin;
        struct gpio_generic *g = (struct gpio_generic *) p->gpio;
        return g->ops->gpioPin_SchmittTrigger(pin, schmitt);
}
inline int32_t gpioPin_setValue(struct gpio_pin *pin, bool value) {
        struct gpio_pin_generic *p = (struct gpio_pin_generic *) pin;
        struct gpio_generic *g = (struct gpio_generic *) p->gpio;
        return g->ops->gpioPin_setValue(pin, value);
}
inline int32_t gpioPin_setPin(struct gpio_pin *pin) {
        struct gpio_pin_generic *p = (struct gpio_pin_generic *) pin;
        struct gpio_generic *g = (struct gpio_generic *) p->gpio;
        return g->ops->gpioPin_setPin(pin);
}
inline int32_t gpioPin_clearPin(struct gpio_pin *pin) {
        struct gpio_pin_generic *p = (struct gpio_pin_generic *) pin;
        struct gpio_generic *g = (struct gpio_generic *) p->gpio;
        return g->ops->gpioPin_clearPin(pin);
}
inline int32_t gpioPin_togglePin(struct gpio_pin *pin) {
        struct gpio_pin_generic *p = (struct gpio_pin_generic *) pin;
        struct gpio_generic *g = (struct gpio_generic *) p->gpio;
        return g->ops->gpioPin_togglePin(pin);
}
inline bool gpioPin_getValue(struct gpio_pin *pin) {
        struct gpio_pin_generic *p = (struct gpio_pin_generic *) pin;
        struct gpio_generic *g = (struct gpio_generic *) p->gpio;
        return g->ops->gpioPin_getValue(pin);
}
#endif
 
#endif