/home/travis/build/lis-epfl/MAVRIC_Library/hal/stm32/gpio_stm32.hpp

/*******************************************************************************
 * Copyright (c) 2009-2016, MAV'RIC Development Team
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 ******************************************************************************/

/*******************************************************************************
 * \file    gpio_stm32.hpp
 *
 * \author  MAV'RIC Team
 *
 * \brief   Implementation of GPIO peripherals for STM32
 *
 ******************************************************************************/

#ifndef GPIO_STM32_HPP_
#define GPIO_STM32_HPP_

#include <libopencm3/stm32/gpio.h>
#include "hal/common/gpio.hpp"
#include <cstdint>


typedef enum
{
    GPIO_STM32_PORT_A = GPIOA,
    GPIO_STM32_PORT_B = GPIOB,
    GPIO_STM32_PORT_C = GPIOC,
    GPIO_STM32_PORT_D = GPIOD,
    GPIO_STM32_PORT_E = GPIOE,
    GPIO_STM32_PORT_F = GPIOF,
} gpio_stm32_port_t;


typedef enum
{
    GPIO_STM32_PIN_0  = GPIO0,
    GPIO_STM32_PIN_1  = GPIO1,
    GPIO_STM32_PIN_2  = GPIO2,
    GPIO_STM32_PIN_3  = GPIO3,
    GPIO_STM32_PIN_4  = GPIO4,
    GPIO_STM32_PIN_5  = GPIO5,
    GPIO_STM32_PIN_6  = GPIO6,
    GPIO_STM32_PIN_7  = GPIO7,
    GPIO_STM32_PIN_8  = GPIO8,
    GPIO_STM32_PIN_9  = GPIO9,
    GPIO_STM32_PIN_10 = GPIO10,
    GPIO_STM32_PIN_11 = GPIO11,
    GPIO_STM32_PIN_12 = GPIO12,
    GPIO_STM32_PIN_13 = GPIO13,
    GPIO_STM32_PIN_14 = GPIO14,
    GPIO_STM32_PIN_15 = GPIO15,
} gpio_stm32_pin_t;


typedef enum
{
    GPIO_STM32_AF_0     = GPIO_AF0 ,
    GPIO_STM32_AF_1     = GPIO_AF1 ,
    GPIO_STM32_AF_2     = GPIO_AF2 ,
    GPIO_STM32_AF_3     = GPIO_AF3 ,
    GPIO_STM32_AF_4     = GPIO_AF4 ,
    GPIO_STM32_AF_5     = GPIO_AF5 ,
    GPIO_STM32_AF_6     = GPIO_AF6 ,
    GPIO_STM32_AF_7     = GPIO_AF7 ,
    GPIO_STM32_AF_8     = GPIO_AF8 ,
    GPIO_STM32_AF_9     = GPIO_AF9 ,
    GPIO_STM32_AF_10    = GPIO_AF10,
    GPIO_STM32_AF_11    = GPIO_AF11,
    GPIO_STM32_AF_12    = GPIO_AF12,
    GPIO_STM32_AF_13    = GPIO_AF13,
    GPIO_STM32_AF_14    = GPIO_AF14,
    GPIO_STM32_AF_15    = GPIO_AF15,
} gpio_stm32_alt_function_t;


typedef struct
{
    gpio_stm32_port_t           port;           
    gpio_stm32_pin_t            pin;            
    gpio_dir_t                  dir;            
    gpio_pull_updown_t          pull;           
    gpio_stm32_alt_function_t   alt_fct;        
} gpio_stm32_conf_t;


static inline gpio_stm32_conf_t gpio_stm32_default_config();


class Gpio_stm32: public Gpio
{
public:
    Gpio_stm32(gpio_stm32_conf_t config = gpio_stm32_default_config());


    bool init(void);


    bool configure(gpio_dir_t dir, gpio_pull_updown_t pull);


    bool set_high(void);


    bool set_low(void);


    bool toggle(void);


    bool write(bool level);


    bool read(void);

private:
    gpio_stm32_conf_t   config_;    
};


static inline gpio_stm32_conf_t gpio_stm32_default_config()
{
    gpio_stm32_conf_t conf = {};
    conf.port   = GPIO_STM32_PORT_A;
    conf.pin    = GPIO_STM32_PIN_0;
    conf.dir    = GPIO_INPUT;
    conf.pull   = GPIO_PULL_UPDOWN_NONE;
    return conf;
}

#endif /* GPIO_STM32_HPP_ */