gpio.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2015 Freie Universität Berlin
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <limits.h>
#include <stdbool.h>
 
#include "periph_cpu.h"
#include "periph_conf.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef HAVE_GPIO_T
typedef unsigned int gpio_t;
#endif
 
#ifndef GPIO_PIN
/* Default GPIO macro maps port-pin tuples to the pin value */
#define GPIO_PIN(x,y)       ((gpio_t)((x & 0) | y))
#endif
 
#ifndef GPIO_UNDEF
#define GPIO_UNDEF          ((gpio_t)(UINT_MAX))
#endif

#ifndef HAVE_GPIO_MODE_T
typedef enum {
    GPIO_IN ,               
    GPIO_IN_PD,             
    GPIO_IN_PU,             
    GPIO_OUT,               
    GPIO_OD,                
    GPIO_OD_PU              
} gpio_mode_t;
#endif

#ifndef HAVE_GPIO_FLANK_T
typedef enum {
    GPIO_FALLING = 0,       
    GPIO_RISING = 1,        
    GPIO_BOTH = 2           
} gpio_flank_t;
#endif

typedef void (*gpio_cb_t)(void *arg);

#ifndef HAVE_GPIO_ISR_CTX_T
typedef struct {
    gpio_cb_t cb;           
    void *arg;              
} gpio_isr_ctx_t;
#endif

int gpio_init(gpio_t pin, gpio_mode_t mode);
 
#if defined(MODULE_PERIPH_GPIO_IRQ) || defined(DOXYGEN)
int gpio_init_int(gpio_t pin, gpio_mode_t mode, gpio_flank_t flank,
                  gpio_cb_t cb, void *arg);

void gpio_irq_enable(gpio_t pin);

void gpio_irq_disable(gpio_t pin);
 
#endif /* defined(MODULE_PERIPH_GPIO_IRQ) || defined(DOXYGEN) */

bool gpio_read(gpio_t pin);

void gpio_set(gpio_t pin);

void gpio_clear(gpio_t pin);

void gpio_toggle(gpio_t pin);

void gpio_write(gpio_t pin, bool value);

static inline int gpio_is_equal(gpio_t gpio1, gpio_t gpio2)
{
    return (gpio1 == gpio2);
}

static inline int gpio_is_valid(gpio_t gpio)
{
    return (gpio != GPIO_UNDEF);
}
 
#ifdef __cplusplus
}
#endif