i2cisolator3.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 I2CISOLATOR3_H
#define I2CISOLATOR3_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 I2CISOLATOR3_THERMO20_CMD_RESET                            0x1E
#define I2CISOLATOR3_THERMO20_CMD_CONVERSION                       0x46
#define I2CISOLATOR3_THERMO20_CMD_READ_ADC                         0x00
 
#define I2CISOLATOR3_READ_WRITE_LEN_ERROR                          0x00
#define I2CISOLATOR3_READ_WRITE_LEN_MIN                            0x01
#define I2CISOLATOR3_SET_DEV_ADDR                                  0x40
 
 // i2cisolator3_set
 
#define I2CISOLATOR3_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    
 // i2cisolator3_map
 // i2cisolator3
 
typedef struct
{
    // Modules
    i2c_master_t i2c;                                 
    // I2C slave address                             
    uint8_t slave_address;                            
} i2cisolator3_t;
 
typedef struct
{
    pin_name_t  scl;                                  
    pin_name_t  sda;                                  
    uint32_t  i2c_speed;                              
    uint8_t   i2c_address;                            
} i2cisolator3_cfg_t;
 
typedef enum
{
   I2CISOLATOR3_OK = 0,
   I2CISOLATOR3_ERROR = -1
 
} i2cisolator3_return_value_t;
 
void i2cisolator3_cfg_setup ( i2cisolator3_cfg_t *cfg );
 
err_t i2cisolator3_init ( i2cisolator3_t *ctx, i2cisolator3_cfg_t *cfg );
 
err_t i2cisolator3_generic_write ( i2cisolator3_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t i2cisolator3_generic_read ( i2cisolator3_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
void i2cisolator3_send_cmd ( i2cisolator3_t *ctx, uint8_t command );
 
void i2cisolator3_write_byte ( i2cisolator3_t *ctx, uint8_t reg, uint8_t tx_data );
 
uint8_t i2cisolator3_read_byte ( i2cisolator3_t *ctx, uint8_t reg );
 
err_t i2cisolator3_burst_write ( i2cisolator3_t *ctx, uint8_t reg, uint8_t *p_tx_data, uint8_t n_bytes );
 
err_t i2cisolator3_burst_read ( i2cisolator3_t *ctx, uint8_t reg, uint8_t *p_rx_data, uint8_t n_bytes );
 
err_t i2cisolator3_adv_write ( i2cisolator3_t *ctx, uint8_t *p_reg, uint8_t n_reg_bytes, uint8_t *p_tx_data, uint8_t n_tx_data_bytes );
 
err_t i2cisolator3_adv_read ( i2cisolator3_t *ctx, uint8_t *p_reg, uint8_t n_reg_bytes, uint8_t *p_rx_data, uint8_t n_rx_data_bytes );
 
#ifdef __cplusplus
}
#endif
#endif // I2CISOLATOR3_H
 
 // i2cisolator3
 
// ------------------------------------------------------------------------ END