i2cisolator5.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 I2CISOLATOR5_H
#define I2CISOLATOR5_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 I2CISOLATOR5_PIN_STATE_HIGH        0x01
#define I2CISOLATOR5_PIN_STATE_LOW         0x00
 
#define I2CISOLATOR5_DEVICE_ADDRESS        0x00
 
 // i2cisolator5_set
 
#define I2CISOLATOR5_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.otb = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.ota = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.ina = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // i2cisolator5_map
 // i2cisolator5
 
typedef struct
{
    // Output pins
    digital_out_t otb;              
    digital_out_t ota;              
    // Input pins
    digital_in_t ina;               
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address;          
} i2cisolator5_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t otb;             
    pin_name_t ota;             
    pin_name_t ina;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} i2cisolator5_cfg_t;
 
typedef enum
{
    I2CISOLATOR5_OK = 0,
    I2CISOLATOR5_ERROR = -1
 
} i2cisolator5_return_value_t;
 
void i2cisolator5_cfg_setup ( i2cisolator5_cfg_t *cfg );
 
err_t i2cisolator5_init ( i2cisolator5_t *ctx, i2cisolator5_cfg_t *cfg );
 
err_t i2cisolator5_default_cfg ( i2cisolator5_t *ctx );
 
err_t i2cisolator5_write ( i2cisolator5_t *ctx, uint8_t *data_in, uint8_t len );
 
err_t i2cisolator5_read ( i2cisolator5_t *ctx, uint8_t *data_out, uint8_t len );
 
err_t i2cisolator5_write_then_read ( i2cisolator5_t *ctx, uint8_t *data_in, uint8_t data_in_len, 
                                     uint8_t *data_out, uint8_t data_out_len );
 
err_t i2cisolator5_set_slave_address ( i2cisolator5_t *ctx, uint8_t address );
 
void i2cisolator5_set_outa_state ( i2cisolator5_t *ctx, uint8_t outa_state );
 
void i2cisolator5_set_outb_state ( i2cisolator5_t *ctx, uint8_t outb_state );
 
uint8_t i2cisolator5_get_ina_state ( i2cisolator5_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // I2CISOLATOR5_H
 
 // i2cisolator5
 
// ------------------------------------------------------------------------ END