boostinv3.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 BOOSTINV3_H
#define BOOSTINV3_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 BOOSTINV3_REG_P_OUT_VOLTAGE             0x00
#define BOOSTINV3_REG_N_OUT_VOLTAGE             0x01
#define BOOSTINV3_REG_CONFIG                    0x03
#define BOOSTINV3_REG_CONTROL                   0xFF
 
 
 // boostinv3_reg
 
#define BOOSTINV3_APPS_VALUE_40_MA              0x00
#define BOOSTINV3_APPS_VALUE_80_MA              0x40
#define BOOSTINV3_VPOS_NO_DISCHARGE             0x00
#define BOOSTINV3_VPOS_DISCHARGE_EN             0x02
#define BOOSTINV3_VPON_NO_DISCHARGE             0x00
#define BOOSTINV3_VPON_DISCHARGE_EN             0x01
 
#define BOOSTINV3_PIN_STATE_LOW                 0x00
#define BOOSTINV3_PIN_STATE_HIGH                0x01
 
#define BOOSTINV3_OUT_VOLTAGE_4V                0x00
#define BOOSTINV3_OUT_VOLTAGE_4V1               0x01
#define BOOSTINV3_OUT_VOLTAGE_4V2               0x02
#define BOOSTINV3_OUT_VOLTAGE_4V3               0x03
#define BOOSTINV3_OUT_VOLTAGE_4V4               0x04
#define BOOSTINV3_OUT_VOLTAGE_4V5               0x05
#define BOOSTINV3_OUT_VOLTAGE_4V6               0x06
#define BOOSTINV3_OUT_VOLTAGE_4V7               0x07
#define BOOSTINV3_OUT_VOLTAGE_4V8               0x08
#define BOOSTINV3_OUT_VOLTAGE_4V9               0x09
#define BOOSTINV3_OUT_VOLTAGE_5V                0x0A
#define BOOSTINV3_OUT_VOLTAGE_5V1               0x0B
#define BOOSTINV3_OUT_VOLTAGE_5V2               0x0C
#define BOOSTINV3_OUT_VOLTAGE_5V3               0x0D
#define BOOSTINV3_OUT_VOLTAGE_5V4               0x0E
#define BOOSTINV3_OUT_VOLTAGE_5V5               0x0F
#define BOOSTINV3_OUT_VOLTAGE_5V6               0x10
#define BOOSTINV3_OUT_VOLTAGE_5V7               0x11
#define BOOSTINV3_OUT_VOLTAGE_5V8               0x12
#define BOOSTINV3_OUT_VOLTAGE_5V9               0x13
#define BOOSTINV3_OUT_VOLTAGE_6V                0x14
 
#define BOOSTINV3_CMD_WRITE_EEPROM              0x80
#define BOOSTINV3_CMD_READ_EEPROM               0x01
#define BOOSTINV3_CMD_READ_REG                  0x00
 
#define BOOSTINV3_DEVICE_ADDRESS                0x3E
 
 // boostinv3_set
 
#define BOOSTINV3_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.enp = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.enn = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
 
 // boostinv3_map
 // boostinv3
 
typedef struct
{
    // Output pins
    digital_out_t enp;              
    digital_out_t enn;              
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address;          
} boostinv3_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t enp;             
    pin_name_t enn;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} boostinv3_cfg_t;
 
typedef enum
{
    BOOSTINV3_OK = 0,
    BOOSTINV3_ERROR = -1
 
} boostinv3_return_value_t;
 
void boostinv3_cfg_setup ( boostinv3_cfg_t *cfg );
 
err_t boostinv3_init ( boostinv3_t *ctx, boostinv3_cfg_t *cfg );
 
err_t boostinv3_default_cfg ( boostinv3_t *ctx );
 
err_t boostinv3_generic_write ( boostinv3_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t boostinv3_generic_read ( boostinv3_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void boostinv3_set_enp ( boostinv3_t *ctx, uint8_t out_state );
 
void boostinv3_set_enn ( boostinv3_t *ctx, uint8_t out_state );
 
err_t boostinv3_write_reg ( boostinv3_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t boostinv3_set_pos_out ( boostinv3_t *ctx, uint8_t out_val );
 
err_t boostinv3_set_neg_out ( boostinv3_t *ctx, uint8_t out_val );
 
#ifdef __cplusplus
}
#endif
#endif // BOOSTINV3_H
 
 // boostinv3
 
// ------------------------------------------------------------------------ END