gpio.h

Go to the documentation of this file.

/*
 * Copyright 2012-2015 Sebastian Neuser
 *
 * This file is part of the uMIDI firmware.
 *
 * The uMIDI firmware is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * The uMIDI firmware is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with the uMIDI firmware.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _GPIO_H
#define _GPIO_H


//---------------- includes ----------------//
#include <stdbool.h>
#include <stdint.h>
#include <avr/io.h>


//---------------- data types ----------------//

enum gpio_input_event
{
    GPIO_INPUT_EVENT_NONE,          
    GPIO_INPUT_EVENT_SHORT,         
    GPIO_INPUT_EVENT_LONG,          
};

enum gpio_type
{
    GPIO_INPUT,                     
    GPIO_INPUT_PULLDOWN,            
    GPIO_INPUT_PULLUP,              
    GPIO_OUTPUT,                    
    GPIO_UNUSED                     
};

struct gpio_pin
{
    PORT_t*             port;       
    uint8_t             bit;        
};

struct gpio_mapping
{
    const struct gpio_pin*  pin;        
    enum gpio_type          type;       
};

struct gpio_header
{
    const struct gpio_pin     pin2;     
    const struct gpio_pin     pin3;     
    const struct gpio_pin     pin4;     
    const struct gpio_pin     pin5;     
    const struct gpio_pin     pin6;     
    const struct gpio_pin     pin7;     
    const struct gpio_pin     pin8;     
    const struct gpio_pin     pin9;     
};

struct jumpers
{
    const struct gpio_pin     jp2;      
    const struct gpio_pin     jp3;      
    const struct gpio_pin     jp4;      
    const struct gpio_pin     jp5;      
};

struct gpio
{
    const struct gpio_header  header1;  
    const struct gpio_header  header2;  
    const struct gpio_header  header3;  
    const struct jumpers      jumpers;  
};


//---------------- public global variables ----------------//
extern const struct gpio gpio;


//---------------- functions and procedures ----------------//

void configure_gpio_pin(const struct gpio_pin* pin, enum gpio_type type);

void init_gpio_module(const struct gpio_mapping mappings[], uint8_t mappings_size);

bool poll_gpio_input(const struct gpio_pin pin, enum gpio_type type);

enum gpio_input_event poll_gpio_input_timeout(const struct gpio_pin pin, enum gpio_type type, uint8_t timeout);


//---------------- inline functions and procedures ----------------//

static inline void gpio_drive_high(const struct gpio_pin pin) {
    pin.port->OUT |= _BV(pin.bit);
}

static inline void gpio_drive_low(const struct gpio_pin pin) {
    pin.port->OUT &=~ _BV(pin.bit);
}

static inline bool gpio_get(const struct gpio_pin pin) {
    return pin.port->IN & _BV(pin.bit);
}

static inline void gpio_set(const struct gpio_pin pin, bool value) {
    value ? gpio_drive_high(pin) : gpio_drive_low(pin);
}

static inline void gpio_toggle(const struct gpio_pin pin) {
    pin.port->OUT ^= _BV(pin.bit);
}


//---------------- EOF ----------------//
#endif // _GPIO_H