boostinv.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 BOOSTINV_H
#define BOOSTINV_H
 
#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"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define BOOSTINV_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST );
#define BOOSTINV_RETVAL  uint8_t
 
#define BOOSTINV_OK           0x00
#define BOOSTINV_INIT_ERROR   0xFF
#define BOOSTINV_I2C_SLAVE_ADDRESS_GND           0x30   
#define BOOSTINV_I2C_SLAVE_ADDRESS_VCC           0x31 
#define BOOSTINV_REG_POSITIVE_VOUT               0x00 
#define BOOSTINV_REG_NEGATIVE_VOUT               0x01 
#define BOOSTINV_REG_CONFIG                      0x02 
#define BOOSTINV_REG_COMMAND                     0x04 
#define BOOSTINV_REG_OTP0                        0x00 
#define BOOSTINV_REG_OTP1                        0x01 
#define BOOSTINV_REG_OTP2                        0x02 
#define BOOSTINV_CFG_LOCKOUT_BIT_ENABLE          0x40
#define BOOSTINV_CFG_LOCKOUT_BIT_DISABLE         0x00
#define BOOSTINV_CFG_VPLUS_ENABLE                0x20
#define BOOSTINV_CFG_VPLUS_DISABLE               0x00
#define BOOSTINV_CFG_IRAMP_1uA                   0x00
#define BOOSTINV_CFG_IRAMP_2uA                   0x08
#define BOOSTINV_CFG_IRAMP_4uA                   0x10
#define BOOSTINV_CFG_IRAMP_8uA                   0x18
#define BOOSTINV_CFG_PDDIS_ENABLE                0x04
#define BOOSTINV_CFG_PDDIS_DISABLE               0x00
#define BOOSTINV_CFG_PUSEQ_OUTPUTS_DISABLED      0x00
#define BOOSTINV_CFG_PUSEQ_VOUTN_RAMP_1ST        0x01
#define BOOSTINV_CFG_PUSEQ_VOUTP_RAMP_1ST        0x02
#define BOOSTINV_CFG_PUSEQ_BOTH_RAMP_TOGETHER    0x03
#define BOOSTINV_CMD_WRITE_OTP_MEMORY            0x80
#define BOOSTINV_CMD_CLEAR_OTP_FAULT             0x40
#define BOOSTINV_CMD_RESET                       0x20
#define BOOSTINV_CMD_SWITCHES_OFF                0x10
#define BOOSTINV_CMD_REGISTER_SELECT_POS_VOUT    0x04
#define BOOSTINV_CMD_REGISTER_SELECT_NEG_VOUT    0x02
#define BOOSTINV_CMD_REGISTER_SELECT_CONFIG      0x01
#define BOOSTINV_CMD_REGISTER_SELECT_OTP2        0x00
#define BOOSTINV_CMD_REGISTER_SELECT_OTP1        0x00
#define BOOSTINV_CMD_REGISTER_SELECT_OTP0        0x00
#define BOOSTINV_VOLTAGE_POSITIVE_3200_mV        3200
#define BOOSTINV_VOLTAGE_POSITIVE_7750_mV        7750
#define BOOSTINV_VOLTAGE_POSITIVE_12000_mV       12000
#define BOOSTINV_VOLTAGE_NEGATIVE_1450_mV       -1450
#define BOOSTINV_VOLTAGE_NEGATIVE_6700_mV       -6700
#define BOOSTINV_VOLTAGE_NEGATIVE_11050_mV      -11050
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
     digital_out_t en;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} boostinv_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t en;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} boostinv_cfg_t;
 
 // End types group
 
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void boostinv_cfg_setup ( boostinv_cfg_t *cfg );
 
BOOSTINV_RETVAL boostinv_init ( boostinv_t *ctx, boostinv_cfg_t *cfg );
 
void boostinv_default_cfg ( boostinv_t *ctx );
 
void boostinv_generic_write ( boostinv_t *ctx, uint8_t reg_addr, uint8_t tx_data );
 
uint8_t boostinv_generic_read ( boostinv_t *ctx, uint8_t reg_addr );
 
void boostinv_enable ( boostinv_t *ctx );
 
void boostinv_set_positive_voltage ( boostinv_t *ctx, uint16_t voltage );
 
void boostinv_set_negative_voltage ( boostinv_t *ctx, int16_t voltage );
 
#ifdef __cplusplus
}
#endif
#endif  // _BOOSTINV_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END