gpio.h

Go to the documentation of this file.

/* Copyright 2022 Wirepas Ltd. All Rights Reserved.
 *
 * See file LICENSE.txt for full license details.
 *
 */
 
#ifndef GPIO_H_
#define GPIO_H_
 
#include <stdint.h>
 
typedef uint8_t gpio_id_t;
 
typedef uint8_t gpio_port_t;
 
typedef uint8_t gpio_pin_t;
 
typedef enum
{
    GPIO_RES_OK = 0,
    GPIO_RES_UNINITIALIZED  = 1,
    GPIO_RES_NOT_IMPLEMENTED = 2,
    GPIO_RES_INVALID_PARAM = 3,
    GPIO_RES_INVALID_PIN   = 4,
    GPIO_RES_INVALID_DIRECTION   = 5,
    GPIO_RES_NO_FREE_IT = 6
} gpio_res_e;
 
typedef enum
{
    GPIO_LEVEL_LOW,
    GPIO_LEVEL_HIGH
} gpio_level_e;
 
typedef enum
{
    GPIO_IN_DISABLED,
    GPIO_IN_PULL_NONE,
    GPIO_IN_PULL_DOWN,
    GPIO_IN_PULL_UP
} gpio_in_mode_cfg_e;
 
typedef enum
{
    GPIO_OUT_MODE_PUSH_PULL,
    GPIO_OUT_MODE_OPEN_DRAIN,
    GPIO_OUT_MODE_OPEN_DRAIN_WITH_PULL_UP
} gpio_out_mode_cfg_e;
 
typedef enum
{
    GPIO_IN_EVENT_NONE = 0,
    GPIO_IN_EVENT_RISING_EDGE = 1U << 0U,
    GPIO_IN_EVENT_FALLING_EDGE = 1U << 1U,
} gpio_in_event_e;
 
#define IS_RISING_EDGE(event) ((event & GPIO_IN_EVENT_RISING_EDGE) == GPIO_IN_EVENT_RISING_EDGE)
 
#define IS_FALLING_EDGE(event) ((event & GPIO_IN_EVENT_FALLING_EDGE) == GPIO_IN_EVENT_FALLING_EDGE)
 
typedef void (*gpio_in_event_cb_f)(gpio_id_t id, gpio_in_event_e event);
 
typedef struct
{
    gpio_in_event_cb_f event_cb;
    gpio_in_event_e event_cfg : 2;
    gpio_in_mode_cfg_e in_mode_cfg : 2;
} gpio_in_cfg_t;
 
typedef struct
{
    gpio_out_mode_cfg_e out_mode_cfg : 2;
    gpio_level_e level_default : 1;
} gpio_out_cfg_t;
 
gpio_res_e Gpio_init(void);
 
gpio_res_e Gpio_inputSetCfg(gpio_id_t id, const gpio_in_cfg_t *in_cfg);
 
gpio_res_e Gpio_inputRead(gpio_id_t id, gpio_level_e *level);
 
gpio_res_e Gpio_outputSetCfg(gpio_id_t id, const gpio_out_cfg_t *out_cfg);
 
gpio_res_e Gpio_outputWrite(gpio_id_t id, gpio_level_e level);
 
gpio_res_e Gpio_outputToggle(gpio_id_t id);
 
gpio_res_e Gpio_outputRead(gpio_id_t id, gpio_level_e *level);
 
gpio_res_e Gpio_getPin(gpio_id_t id, gpio_port_t *port, gpio_pin_t *pin);
 
uint8_t Gpio_getNumber(void);
 
#endif /* GPIO_H_ */