/home/travis/build/lis-epfl/MAVRIC_Library/hal/stm32/i2c_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 i2c_stm32.hpp
 *
 * \author MAV'RIC Team
 * \author Gregoire HEITZ
 *
 * \brief I2C peripheral driver for STM32
 *
 ******************************************************************************/

#ifndef I2C_STM32_HPP_
#define I2C_STM32_HPP_

#include "hal/common/i2c.hpp"
#include "hal/stm32/gpio_stm32.hpp"

extern "C"
{
    #include <libopencm3/stm32/i2c.h>
    #include <libopencm3/stm32/rcc.h>
}


typedef enum
{
    STM32_I2C1 = I2C1,
    STM32_I2C2 = I2C2,
    STM32_I2C3 = I2C3
} i2c_stm32_devices_t;


typedef struct
{
    i2c_stm32_devices_t i2c_device_config;      
    bool                tenbit_config;          
    gpio_stm32_conf_t   sda_config;             
    gpio_stm32_conf_t   clk_config;             
    rcc_periph_clken    rcc_i2c_config;         
    rcc_periph_clken    rcc_sda_port_config;    
    rcc_periph_clken    rcc_clk_port_config;    
    uint32_t            clk_speed;              
    uint16_t            timeout;                
} i2c_stm32_conf_t;

static inline  i2c_stm32_conf_t i2c_stm32_default_config();

class I2c_stm32: public I2c
{
public:
    I2c_stm32(i2c_stm32_conf_t config = i2c_stm32_default_config());


    bool init(void);


    bool probe(uint32_t address);


    bool write(const uint8_t* buffer, uint32_t nbytes, uint32_t address);


    bool read(uint8_t* buffer, uint32_t nbytes, uint32_t address);


private:
    i2c_stm32_conf_t        config_;        
    i2c_stm32_devices_t     i2c_;           
    uint16_t                i2c_timeout_;   

    bool check_event(uint32_t i2c_event);

    bool start(uint8_t address, bool direction_is_transmit, bool ack);

    bool stop(void);

    uint8_t read_ack(void);

    uint8_t read_nack(void);
};

static inline  i2c_stm32_conf_t i2c_stm32_default_config()
{
    i2c_stm32_conf_t conf = {};
    conf.i2c_device_config  = STM32_I2C2;
    conf.rcc_i2c_config     = RCC_I2C2;
    conf.rcc_sda_port_config     = RCC_GPIOB;
    conf.sda_config.port    = GPIO_STM32_PORT_B;
    conf.sda_config.pin     = GPIO_STM32_PIN_11;
    conf.sda_config.alt_fct = GPIO_STM32_AF_4;
    conf.rcc_clk_port_config     = RCC_GPIOB;
    conf.clk_config.port    = GPIO_STM32_PORT_B;
    conf.clk_config.pin     = GPIO_STM32_PIN_10;
    conf.clk_config.alt_fct = GPIO_STM32_AF_4;
    conf.clk_speed          = 100000;
    conf.tenbit_config      = false;  // currently only support 8 bits addressing
    conf.timeout            = 20000;
    return conf;
}


#endif /* I2C_STM32_HPP_ */