WireWrapper.h

Go to the documentation of this file.

/****************************************************************/
#ifndef __WIREWRAPPER_H__
    #define __WIREWRAPPER_H__
/****************************************************************/
 
#if defined(DOXY)
    // Define gcc __attribute__ as void when Doxygen runs
    #define __attribute__(a)    
#endif
 
#if defined(__AVR_ATtiny25__) | defined(__AVR_ATtiny45__) | defined(__AVR_ATtiny85__) | defined(__AVR_AT90Tiny26__) | defined(__AVR_ATtiny26__)
    #define     __TINY__
#endif
 
#if (ARDUINO >= 100)
    #include <Arduino.h>
#else
    #include <WProgram.h>
#endif
 
extern "C" {
#include <stdbool.h>
#include <inttypes.h>
}
 
#include <Wire.h>
 
 
#define DEF_CI2C_NB_RETRIES     3       
#define DEF_CI2C_TIMEOUT        100     
 

typedef enum __attribute__((__packed__)) enI2C_RW {
    I2C_WRITE = 0, 
    I2C_READ        
} I2C_RW;
 

typedef enum __attribute__((__packed__)) enI2C_SPEED {
    I2C_STD = 100,       
    I2C_FM = 400,     
    I2C_FMP = 1000,      
    I2C_HS = 3400     
} I2C_SPEED;
 
#if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ESP8266_ESP01)
#undef I2C_OK   
#endif

typedef enum __attribute__((__packed__)) enI2C_STATUS {
    I2C_OK = 0x00,    
    I2C_BUSY,       
    I2C_NACK        
} I2C_STATUS;

typedef enum __attribute__((__packed__)) enI2C_INT_SIZE {
    I2C_NO_REG = 0x00,    
    I2C_8B_REG,           
    I2C_16B_REG          
} I2C_INT_SIZE;
 
 
typedef bool (*ci2c_fct_ptr) (void*, const uint16_t, uint8_t*, const uint16_t); 
 

typedef struct __attribute__((__packed__)) StructI2CSlave {
    struct {
        uint8_t         addr;       
        I2C_INT_SIZE    reg_size;   
        ci2c_fct_ptr    wr;           
        ci2c_fct_ptr    rd;           
    } cfg;
    uint16_t            reg_addr;   
    I2C_STATUS            status;       
} I2C_SLAVE;
 
 
/***************************/
/*** I2C SLAVE FUNCTIONS ***/
/***************************/

void I2C_slave_init(I2C_SLAVE * slave, const uint8_t sl_addr, const I2C_INT_SIZE reg_sz);

void I2C_slave_set_rw_func(I2C_SLAVE * slave, const ci2c_fct_ptr func, const I2C_RW rw);

bool I2C_slave_set_addr(I2C_SLAVE * slave, const uint8_t sl_addr);

bool I2C_slave_set_reg_size(I2C_SLAVE * slave, const I2C_INT_SIZE reg_sz);

inline uint8_t __attribute__((__always_inline__)) I2C_slave_get_addr(const I2C_SLAVE * slave) {
    return slave->cfg.addr; }

inline bool __attribute__((__always_inline__)) I2C_slave_get_reg_size(const I2C_SLAVE * slave) {
    return slave->cfg.reg_size; }

inline uint16_t __attribute__((__always_inline__)) I2C_slave_get_reg_addr(const I2C_SLAVE * slave) {
    return slave->reg_addr; }
 
 
/*************************/
/*** I2C BUS FUNCTIONS ***/
/*************************/

void I2C_init(const uint16_t speed);

inline void __attribute__((__always_inline__)) I2C_uninit()
{
    #if !defined(__TINY__) && !defined(ARDUINO_ARCH_ESP8266) && !defined(ARDUINO_ESP8266_ESP01) && !defined(ARDUINO_ARCH_ESP32)
        Wire.end();
    #endif
}

uint16_t I2C_set_speed(const uint16_t speed);

uint16_t I2C_set_timeout(const uint16_t timeout);

uint8_t I2C_set_retries(const uint8_t retries);

bool I2C_is_busy(void);

I2C_STATUS I2C_write(I2C_SLAVE * slave, const uint16_t reg_addr, uint8_t * data, const uint16_t bytes);

inline I2C_STATUS __attribute__((__always_inline__)) I2C_write_next(I2C_SLAVE * slave, uint8_t * data, const uint16_t bytes) {
    return I2C_write(slave, slave->reg_addr, data, bytes); }

I2C_STATUS I2C_read(I2C_SLAVE * slave, const uint16_t reg_addr, uint8_t * data, const uint16_t bytes);

inline I2C_STATUS __attribute__((__always_inline__)) I2C_read_next(I2C_SLAVE * slave, uint8_t * data, const uint16_t bytes) {
    return I2C_read(slave, slave->reg_addr, data, bytes); }
 
#endif