RIOT/cpu/atmega_common/include/atmega_gpio.h

/*
 * Copyright (C) 2015 HAW Hamburg
 *               2016 INRIA

 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */

/**
 * @ingroup     cpu_atmega_common
 * @ingroup     drivers_periph_gpio
 * @{
 *
 * @file
 * @brief       Macros and inline functions for accessing GPIOs of the ATmega
 *              family
 *
 * @author      René Herthel <rene-herthel@outlook.de>
 * @author      Francisco Acosta <francisco.acosta@inria.fr>
 * @author      Laurent Navet <laurent.navet@gmail.com>
 */

#ifndef ATMEGA_GPIO_H
#define ATMEGA_GPIO_H
#include <stddef.h>
#include <stdio.h>

#include <avr/interrupt.h>

#include "cpu.h"
#include "board.h"
#include "periph/gpio.h"
#include "periph_conf.h"
#include "periph_cpu.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief     Extract the pin number of the given pin
 */
static inline uint8_t atmega_pin_num(gpio_t pin)
{
    return (pin & 0x0f);
}

/**
 * @brief     Extract the port number of the given pin
 */
static inline uint8_t atmega_port_num(gpio_t pin)
{
    return (pin >> 4) & 0x0f;
}

/**
 * @brief     Generate the PINx address of the given pin.
 */
static inline uint16_t atmega_pin_addr(gpio_t pin)
{
    return (uintptr_t)atmega_gpio_port(atmega_port_num(pin));
}

/**
 * @brief     Generate the DDRx address of the given pin
 */
static inline uint16_t atmega_ddr_addr(gpio_t pin)
{
    return atmega_pin_addr(pin) + offsetof(atmega_gpio_port_t, ddr);
}

/**
 * @brief     Generate the PORTx address of the give pin.
 */
static inline uint16_t atmega_port_addr(gpio_t pin)
{
    return atmega_pin_addr(pin) + offsetof(atmega_gpio_port_t, port);
}

#ifdef __cplusplus
}
#endif

#endif /* ATMEGA_GPIO_H */
/** @} */