buckboost4.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 BUCKBOOST4_H
#define BUCKBOOST4_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 BUCKBOOST4_REG_REF_MSB                   0x00
#define BUCKBOOST4_REG_REF_LSB                   0x01
#define BUCKBOOST4_REG_IOUT_LIMIT                0x02
#define BUCKBOOST4_REG_VOUT_SR                   0x03
#define BUCKBOOST4_REG_VOUT_FS                   0x04
#define BUCKBOOST4_REG_CDC                       0x05
#define BUCKBOOST4_REG_MODE                      0x06
#define BUCKBOOST4_REG_STATUS                    0x07
 
 // buckboost4_reg
 
#define BUCKBOOST4_VREF_MV_MIN                   45.0f
#define BUCKBOOST4_VREF_MV_MAX                   1200.0f
#define BUCKBOOST4_VREF_MV_STEP                  0.5645f
 
#define BUCKBOOST4_IOUT_LIMIT_CT_DIS             0x00
#define BUCKBOOST4_IOUT_LIMIT_CT_EN              0x01
#define BUCKBOOST4_IOUT_LIMIT_CLTV_MIN           0.0f
#define BUCKBOOST4_IOUT_LIMIT_CLTV_MAX           63.5f
#define BUCKBOOST4_IOUT_LIMIT_CLTV_STEP          0.5f
 
#define BUCKBOOST4_VOUT_SR_OCP_DELAY_128_US      0x00
#define BUCKBOOST4_VOUT_SR_OCP_DELAY_3_S         0x01
#define BUCKBOOST4_VOUT_SR_OCP_DELAY_6_S         0x02
#define BUCKBOOST4_VOUT_SR_OCP_DELAY_12_S        0x03
#define BUCKBOOST4_VOUT_SR_OCP_DELAY_BIT_MASK    0xCF
 
#define BUCKBOOST4_VOUT_SR_SR_MV_US_1_25         0x00
#define BUCKBOOST4_VOUT_SR_SR_MV_US_2_5          0x01
#define BUCKBOOST4_VOUT_SR_SR_MV_US_5            0x02
#define BUCKBOOST4_VOUT_SR_SR_MV_US_10           0x03
#define BUCKBOOST4_VOUT_SR_SR_BIT_MASK           0xFC
 
#define BUCKBOOST4_VOUT_FS_FB_EXT                0x80
#define BUCKBOOST4_VOUT_FS_INTFB_0_2256          0x00
#define BUCKBOOST4_VOUT_FS_INTFB_0_1128          0x01
#define BUCKBOOST4_VOUT_FS_INTFB_0_0752          0x02
#define BUCKBOOST4_VOUT_FS_INTFB_0_0564          0x03
#define BUCKBOOST4_VOUT_FS_INTFB_BIT_MASK        0xFC
 
#define BUCKBOOST4_MODE_OE_EN                    0x80
#define BUCKBOOST4_MODE_FSWDBL_DIS               0x00
#define BUCKBOOST4_MODE_FSWDBL_EN                0x01
#define BUCKBOOST4_MODE_HICCUP_DIS               0x00
#define BUCKBOOST4_MODE_HICCUP_EN                0x01
#define BUCKBOOST4_MODE_DISCHG_DIS               0x00
#define BUCKBOOST4_MODE_DISCHG_EN                0x01
#define BUCKBOOST4_MODE_FPWM_DIS                 0x00
#define BUCKBOOST4_MODE_FPWM_EN                  0x01
#define BUCKBOOST4_MODE_BIT_MASK                 0x8D
 
#define BUCKBOOST4_VOUT_LIM_MIN                  0.8f
#define BUCKBOOST4_VOUT_LIM_5_V                  5.0f
#define BUCKBOOST4_VOUT_LIM_10_V                 10.0f
#define BUCKBOOST4_VOUT_LIM_15_V                 15.0f
#define BUCKBOOST4_VOUT_LIM_20_V                 20.0f
#define BUCKBOOST4_VOUT_LIM_MAX                  21.286f
#define BUCKBOOST4_INTFB_STEP_MAX                0.2256f
#define BUCKBOOST4_CONVERT_V_TO_MV               1000.0f
 
#define BUCKBOOST4_DEVICE_ADDRESS_0              0x75
#define BUCKBOOST4_DEVICE_ADDRESS_1              0x74
 
 // buckboost4_set
 
#define BUCKBOOST4_MAP_MIKROBUS( cfg, mikrobus )   \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL );  \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );  \
    cfg.en  = MIKROBUS( mikrobus, MIKROBUS_PWM );  \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // buckboost4_map
 // buckboost4
 
typedef struct
{
    // Output pins
    digital_out_t en;        
    // Input pins
    digital_in_t int_pin;    
    // Modules
    i2c_master_t i2c;        
    // I2C slave address
    uint8_t slave_address;   
} buckboost4_t;
 
typedef struct
{
    pin_name_t scl;        
    pin_name_t sda;        
    pin_name_t en;         
    pin_name_t int_pin;    
    uint32_t   i2c_speed;      
    uint8_t    i2c_address;    
} buckboost4_cfg_t;
 
typedef enum
{
    BUCKBOOST4_OK = 0,
    BUCKBOOST4_ERROR = -1
 
} buckboost4_return_value_t;
 
void buckboost4_cfg_setup ( buckboost4_cfg_t *cfg );
 
err_t buckboost4_init ( buckboost4_t *ctx, buckboost4_cfg_t *cfg );
 
err_t buckboost4_default_cfg ( buckboost4_t *ctx );
 
err_t buckboost4_generic_write ( buckboost4_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t buckboost4_generic_read ( buckboost4_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void buckboost4_enable_device ( buckboost4_t *ctx );
 
void buckboost4_disable_device ( buckboost4_t *ctx );
 
err_t buckboost4_set_vref ( buckboost4_t *ctx, float vref_mv );
 
err_t buckboost4_current_limit_cfg ( buckboost4_t *ctx, uint8_t cl_en, float cltv_mv );
 
err_t buckboost4_set_ocp_delay ( buckboost4_t *ctx, uint8_t ocp_delay );
 
err_t buckboost4_set_slew_rate ( buckboost4_t *ctx, uint8_t slew_rate );
 
err_t buckboost4_en_ext_output_vtg ( buckboost4_t *ctx );
 
err_t buckboost4_set_int_fb_ratio ( buckboost4_t *ctx, uint8_t int_fb_ratio );
 
err_t buckboost4_output_enable ( buckboost4_t *ctx );
 
err_t buckboost4_output_disable ( buckboost4_t *ctx );
 
err_t buckboost4_set_mode ( buckboost4_t *ctx, uint8_t fswdbl, uint8_t hiccup, 
                                               uint8_t dischg, uint8_t fpwm );
 
err_t buckboost4_get_status ( buckboost4_t *ctx, uint8_t *status );
 
err_t buckboost4_set_vout ( buckboost4_t *ctx, float vout_v );
 
uint8_t buckboost4_fault_indicator ( buckboost4_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // BUCKBOOST4_H
 
 // buckboost4
 
// ------------------------------------------------------------------------ END