include/gpio/port.h

Go to the documentation of this file.

#ifndef GPIO_PORT_H_INCLUDED
#define GPIO_PORT_H_INCLUDED

#include <compiler.h>
#include <types.h>
#include <regs/xmega_port.h>

typedef uint8_t pin_mask_t;

typedef uint16_t gpio_pin_t;

typedef uint16_t port_pin_flags_t;


#define PORT_DIR_INPUT          (0 << 8) //!< Pin is Input
#define PORT_DIR_OUTPUT         (1 << 8) //!< Pin is Output



#define PORT_INIT_LOW           (0 << 9) //!< Initial Ouptput State is High
#define PORT_INIT_HIGH          (1 << 9) //!< Initial Ouptput State is Low



#define PORT_BOTHEDGES          (0 << 0) //!< Sense Both Edges
#define PORT_RISING             (1 << 0) //!< Sense Risign Edge
#define PORT_FALLING            (2 << 0) //!< Sense Falling Edge
#define PORT_LEVEL              (3 << 0) //!< Sense Low Level
#define PORT_INPUT_DISABLE      (7 << 0) //!< Input Buffer Disabled



#define PORT_TOTEM              (0 << 3) //!< Normal push/pull output
#define PORT_BUSKEEPER          (1 << 3) //!< Bus Keeper
#define PORT_PULL_DOWN          (2 << 3) //!< Pull-Down (when input)
#define PORT_PULL_UP            (3 << 3) //!< Pull-Up (when input)
#define PORT_WIRED_OR           (4 << 3) //!< Wired OR
#define PORT_WIRED_AND          (5 << 3) //!< Wired AND
#define PORT_WIRED_OR_PULL_DOWN (6 << 3) //!< Wired OR and Pull-Down
#define PORT_WIRED_AND_PULL_UP  (7 << 3) //!< Wired AND and Pull-Up



#define PORT_INV_ENABLED        (1 << 6) //!< I/O is Inverted
#define PORT_INV_DISABLE        (0 << 6) //!< I/O is Not Inverted



#define PORT_SRL_ENABLED        (1 << 7) //!< Slew Rate Limit Enabled
#define PORT_SRL_DISABLED       (0 << 7) //!< Slew Rate Limit Disabled



#define CREATE_GPIO_PIN(port, pin) ((PORT_##port) + (pin))

static inline void *gpio_pin_to_port(gpio_pin_t pin)
{
        // Each port has an offset of 0x20
        return (void *)(PORTA_BASE + (pin >> 3) * 0x20);
}

static inline pin_mask_t gpio_pin_to_mask(gpio_pin_t pin)
{
        return 1U << (pin & 0x7);
}

extern void port_select_gpio(void *port, pin_mask_t pin_mask,
                port_pin_flags_t flags);

static inline void port_select_gpio_pin(gpio_pin_t pin, port_pin_flags_t flags)
{
        port_select_gpio(gpio_pin_to_port(pin), gpio_pin_to_mask(pin), flags);
}


#define PORT_PORTA        (0 * 8)
#define PORT_PORTB        (1 * 8)
#define PORT_PORTC        (2 * 8)
#define PORT_PORTD        (3 * 8)
#define PORT_PORTE        (4 * 8)
#define PORT_PORTF        (5 * 8)
#define PORT_PORTG        (6 * 8)
#define PORT_PORTH        (7 * 8)
#define PORT_PORTJ        (8 * 8)
#define PORT_PORTK        (9 * 8)
#define PORT_PORTL        (10 * 8)
#define PORT_PORTM        (11 * 8)
#define PORT_PORTN        (12 * 8)
#define PORT_PORTP        (13 * 8)
#define PORT_PORTQ        (14 * 8)
#define PORT_PORTR        (15 * 8)


__always_inline static void gpio_set_value_inline(gpio_pin_t pin, bool value)
{
        pin_mask_t pin_mask = gpio_pin_to_mask(pin);
        void *port = gpio_pin_to_port(pin);

        if (value)
                port_write_reg(port, OUTSET, pin_mask);
        else
                port_write_reg(port, OUTCLR, pin_mask);
}

__always_inline static bool gpio_get_value_inline(gpio_pin_t pin)
{
        return (port_read_reg(gpio_pin_to_port(pin), IN) >> (pin & 0x7)) & 1;
}

extern void gpio_set_value_noninline(gpio_pin_t pin, bool value);
extern bool gpio_get_value_noninline(gpio_pin_t pin);


__always_inline static void gpio_set_value(gpio_pin_t pin, bool value)
{
        if (is_constant(pin))
                gpio_set_value_inline(pin, value);
        else
                gpio_set_value_noninline(pin, value);
}

__always_inline static bool gpio_get_value(gpio_pin_t pin)
{
        if (is_constant(pin))
                return gpio_get_value_inline(pin);
        else
                return gpio_get_value_noninline(pin);
}

__always_inline static void gpio_toggle_value(gpio_pin_t pin)
{
        pin_mask_t pin_mask = gpio_pin_to_mask(pin);
        void *port = gpio_pin_to_port(pin);

        port_write_reg(port, OUTTGL, pin_mask);
}


#endif /* GPIO_PORT_H_INCLUDED */

---