i2cextend.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef I2CEXTEND_H
#define I2CEXTEND_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
 
#define I2CEXTEND_REG_CONFIG                                       0x00
#define I2CEXTEND_REG_STATUS                                       0x01
#define I2CEXTEND_REG_EVENT                                        0x02
#define I2CEXTEND_REG_ALERT_EN                                     0x03
#define I2CEXTEND_REG_FAULT                                        0x04
#define I2CEXTEND_REG_SCRATCH                                      0x05
#define I2CEXTEND_REG_ADDR_TRANS                                   0x06
#define I2CEXTEND_REG_CTRL                                         0x07
 
#define C6DOFIMU11_REG_WHO_AM_I                                     0x00
#define C6DOFIMU11_REG_CNTL2                                        0x3A
#define C6DOFIMU11_REG_INC3                                         0x2C
#define C6DOFIMU11_REG_ACCEL_XOUT_L                                 0x0A
#define C6DOFIMU11_REG_ACCEL_YOUT_L                                 0x0C
#define C6DOFIMU11_REG_ACCEL_ZOUT_L                                 0x0E
#define C6DOFIMU11_REG_MAG_XOUT_L                                   0x10
#define C6DOFIMU11_REG_MAG_YOUT_L                                   0x12
#define C6DOFIMU11_REG_MAG_ZOUT_L                                   0x14
 
 // i2cextend_reg
 
#define I2CEXTEND_CONFIG_INTR_MODE_BIT_MASK                        0x01
#define I2CEXTEND_CONFIG_INTR_MODE_SET_ALERT_PIN                   0x00
#define I2CEXTEND_CONFIG_INTR_MODE_IGNORE_ARA                      0x01
#define I2CEXTEND_CONFIG_CTRL_SEL_BIT_MASK                         0x02
#define I2CEXTEND_CONFIG_CTRL_SEL_MIRRORED_RMT_OUT                 0x00
#define I2CEXTEND_CONFIG_CTRL_SEL_USE_REG_CTRL_VAL                 0x02
 
#define I2CEXTEND_ALERT_EN_LINK_GOOD_DISABLE                       0x00
#define I2CEXTEND_ALERT_EN_LINK_GOOD                               0x01
#define I2CEXTEND_ALERT_EN_LINK_LOST_DISABLE                       0x00
#define I2CEXTEND_ALERT_EN_LINK_LOST                               0x02
#define I2CEXTEND_ALERT_EN_FAULT_DISABLE                           0x00
#define I2CEXTEND_ALERT_EN_FAULT                                   0x04
 
#define I2CEXTEND_CTRL_SEL_L                                       0x00
#define I2CEXTEND_CTRL_SEL_H                                       0x01
 
#define I2CEXTEND_PIN_STATE_LOW                                    0x00
#define I2CEXTEND_PIN_STATE_HIGH                                   0x01
 
#define C6DOFIMU11_CNTL2_TEMP_EN_STANDBY_MODE                       0x00
#define C6DOFIMU11_CNTL2_MAG_EN_STANDBY_MODE                        0x00
#define C6DOFIMU11_CNTL2_ACCEL_EN_STANDBY_MODE                      0x00
#define C6DOFIMU11_INC3_IEL2_FIFO_TRIG                              0x20
#define C6DOFIMU11_INC3_IEL1_FIFO_TRIG                              0x02
#define C6DOFIMU11_CNTL2_ACCEL_EN_OPERATING_MODE                    0x01
#define C6DOFIMU11_CNTL2_GSEL_8G                                    0x00
#define C6DOFIMU11_CNTL2_RES_MAX2                                   0x0C
#define C6DOFIMU11_CNTL2_MAG_EN_OPERATING_MODE                      0x02
#define C6DOFIMU11_WHO_AM_I_WIA_ID                                  0x2D
 
#define I2CEXTEND_I2C_SLAVE_ADDR_0                                 0x3E
#define I2CEXTEND_I2C_SLAVE_ADDR_1                                 0x3F
#define I2CEXTEND_I2C_SLAVE_ADDR_2                                 0x76
#define I2CEXTEND_I2C_SLAVE_ADDR_3                                 0x77
 
#define C6DOFIMU11_I2C_SLAVE_ADDRESS_GND                            0x0E
#define C6DOFIMU11_I2C_SLAVE_ADDRESS_VCC                            0x0F
 
 // i2cextend_set
 
#define I2CEXTEND_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.on = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // i2cextend_map
 // i2cextend
 
typedef struct
{
    // Output pins
    digital_out_t  cs;                                  
    digital_out_t  rst;                                 
    digital_out_t  on;                                  
    // Input pins
    digital_in_t  int_pin;                              
    // Modules
    i2c_master_t i2c;                                   
    // I2C slave address
    uint8_t slave_address;                              
} i2cextend_t;
 
typedef struct
{
    pin_name_t  scl;                                    
    pin_name_t  sda;                                    
    pin_name_t  cs;                                     
    pin_name_t  rst;                                    
    pin_name_t  on;                                     
    pin_name_t  int_pin;                                
    uint32_t  i2c_speed;                                
    uint8_t   i2c_address;                              
} i2cextend_cfg_t;
 
typedef struct
{
    uint8_t nlink;
    uint8_t nalert;
    uint8_t ext_nalert;
    uint8_t speed_idx;
} i2cextend_status_data_t;
 
typedef struct
{
    uint8_t i2c_write_fault;
    uint8_t link_fault;
    uint8_t ext_i2c_fault;
    uint8_t tx_buf_overflow;
} i2cextend_fault_data_t;
 
typedef enum
{
   I2CEXTEND_OK = 0,
   I2CEXTEND_ERROR = -1
 
} i2cextend_return_value_t;
 
void i2cextend_cfg_setup ( i2cextend_cfg_t *cfg );
 
err_t i2cextend_init ( i2cextend_t *ctx, i2cextend_cfg_t *cfg );
 
void i2cextend_generic_write ( i2cextend_t *ctx, uint8_t reg, uint8_t tx_data );
 
uint8_t i2cextend_generic_read ( i2cextend_t *ctx, uint8_t reg );
 
void i2cextend_rmt_write ( i2cextend_t *ctx, uint8_t rmt_slave_addr, uint8_t reg, uint8_t tx_data );
 
uint8_t i2cextend_rmt_read ( i2cextend_t *ctx, uint8_t rmt_slave_addr, uint8_t reg );
 
void i2cextend_rmt_multi_write ( i2cextend_t *ctx, uint8_t rmt_slave_addr, uint8_t reg, uint8_t *p_tx_data, uint8_t n_bytes );
 
void i2cextend_rmt_multi_read ( i2cextend_t *ctx, uint8_t rmt_slave_addr, uint8_t reg, uint8_t *p_rx_data, uint8_t n_bytes );
 
void i2cextend_set_config ( i2cextend_t *ctx, uint8_t intr_mode, uint8_t ctrl_sel );
 
void i2cextend_status ( i2cextend_t *ctx, i2cextend_status_data_t *status_data );
 
void i2cextend_enable_alerts ( i2cextend_t *ctx, uint8_t link_good, uint8_t link_lost, uint8_t fault );
 
void i2cextend_fault ( i2cextend_t *ctx, i2cextend_fault_data_t *fault_data );
 
uint8_t i2cextend_get_scratch ( i2cextend_t *ctx );
 
void i2cextend_set_out_slave_address ( i2cextend_t *ctx, uint8_t out_slave_address );
 
void i2cextend_set_out_ctrl ( i2cextend_t *ctx, uint8_t out_ctrl );
 
void i2cextend_set_rst ( i2cextend_t *ctx, uint8_t en_rst );
 
void i2cextend_set_cs ( i2cextend_t *ctx, uint8_t en_cs );
 
void i2cextend_set_on ( i2cextend_t *ctx, uint8_t on_state );
 
uint8_t i2cextend_check_int ( i2cextend_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // I2CEXTEND_H
 
 // i2cextend
 
// ------------------------------------------------------------------------ END