battboost.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 BATTBOOST_H
#define BATTBOOST_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 BATTBOOST_REG_STATUS                    0x00
#define BATTBOOST_REG_CHENERGY_3                0x01
#define BATTBOOST_REG_CHENERGY_2                0x02
#define BATTBOOST_REG_CHENERGY_1                0x03
#define BATTBOOST_REG_CHENERGY_0                0x04
#define BATTBOOST_REG_VCAP                      0x05
#define BATTBOOST_REG_VCHEND                    0x06
#define BATTBOOST_REG_PROFILE_MSB               0x07
#define BATTBOOST_REG_COMMAND                   0x08
#define BATTBOOST_REG_SET1                      0x09
#define BATTBOOST_REG_SET2                      0x0A
#define BATTBOOST_REG_SET3                      0x0B
#define BATTBOOST_REG_SET4                      0x0C
#define BATTBOOST_REG_SET5                      0x0D
 
 // battboost_reg
 
#define BATTBOOST_STATUS_LOWBAT                 0x80
#define BATTBOOST_STATUS_EW                     0x40
#define BATTBOOST_STATUS_ALRM                   0x20
#define BATTBOOST_STATUS_RDY                    0x01
 
#define BATTBOOST_VCAP_BIT_MASK                 0x1F
 
#define BATTBOOST_VCHEND_BIT_MASK               0x1F
 
#define BATTBOOST_SET2_VMIN_2_4V                2.4f
#define BATTBOOST_SET2_VMIN_2_6V                2.6f
#define BATTBOOST_SET2_VMIN_2_8V                2.8f
#define BATTBOOST_SET2_VMIN_3_0V                3.0f
#define BATTBOOST_SET2_VMIN_3_2V                3.2f
#define BATTBOOST_SET2_VMIN_BIT_MASK            0xF8
#define BATTBOOST_SET2_ICH_BIT_MASK             0x1F
#define BATTBOOST_SET2_SET_VDH_VBT              0x10
 
#define BATTBOOST_SET3_VEW_2_4V                 0
#define BATTBOOST_SET3_VEW_2_6V                 1
#define BATTBOOST_SET3_VEW_2_8V                 2
#define BATTBOOST_SET3_VEW_3_0V                 3
#define BATTBOOST_SET3_VEW_3_2V                 4
#define BATTBOOST_SET3_VEW_3_4V                 5
#define BATTBOOST_SET3_VEW_3_6V                 6
#define BATTBOOST_SET3_VEW_3_84V                7
#define BATTBOOST_SET3_VEW_4_1V                 8
#define BATTBOOST_SET3_VEW_4_3V                 9
#define BATTBOOST_SET3_VEW_BIT_MASK             0x0F
#define BATTBOOST_SET3_EEW_DISABLE              0
#define BATTBOOST_SET3_EEW_ENABLE               1
 
#define BATTBOOST_SET5_OPT_MARG_MIN             0
#define BATTBOOST_SET5_OPT_MARG_NORMAL          1
#define BATTBOOST_SET5_OPT_MARG_SAFE            2
#define BATTBOOST_SET5_OPT_MARG_EXTRA_SAFE      3
 
#define BATTBOOST_SET4_VCAPMAX_4_95V            0
#define BATTBOOST_SET4_VCAPMAX_5_54V            1
#define BATTBOOST_SET4_VCAPMAX_BIT_MASK         0xEF
 
 
#define BATTBOOST_CMD_PROF_0_FIXED_MODE         0
#define BATTBOOST_CMD_PROF_BIT_MASK             0xFC
#define BATTBOOST_CMD_BIT_MASK                  0x0F
#define BATTBOOST_PROF_MSB_BIT_MASK             0x03
#define BATTBOOST_PROF_BIT_MASK                 0xF0
 
#define BATTBOOST_OP_MODE_STANDBY               0
#define BATTBOOST_OP_MODE_STBY_BIT_MASK         0x06
#define BATTBOOST_OP_MODE_CHARGE                1
#define BATTBOOST_OP_MODE_CHG_BIT_MASK          0xF0
#define BATTBOOST_OP_MODE_SET_CHARGE            0x02
#define BATTBOOST_OP_MODE_ACTIVE                2
#define BATTBOOST_OP_MODE_SET_ACT_ACTIVE        0x04
 
#define BATTBOOST_CMD_RESET_BIT_MASK            0x08
 
#define BATTBOOST_CMD_AUTOMODE_ENABLE           0x80
 
#define BATTBOOST_SET1_VSET_1_8V                1.8f
#define BATTBOOST_SET1_VSET_2_0V                2.0f
#define BATTBOOST_SET1_VSET_2_2V                2.2f
#define BATTBOOST_SET1_VSET_2_4V                2.4f
#define BATTBOOST_SET1_VSET_2_5V                2.5f
#define BATTBOOST_SET1_VSET_2_6V                2.6f
#define BATTBOOST_SET1_VSET_2_7V                2.7f
#define BATTBOOST_SET1_VSET_2_8V                2.8f
#define BATTBOOST_SET1_VSET_2_9V                2.9f
#define BATTBOOST_SET1_VSET_3_0V                3.0f
#define BATTBOOST_SET1_VSET_3_1V                3.1f
#define BATTBOOST_SET1_VSET_3_2V                3.2f
#define BATTBOOST_SET1_VSET_3_3V                3.3f
#define BATTBOOST_SET1_VSET_3_4V                3.4f
#define BATTBOOST_SET1_VSET_3_5V                3.5f
#define BATTBOOST_SET1_VSET_3_6V                3.6f
#define BATTBOOST_SET1_VSET_BIT_MASK            0xF0
#define BATTBOOST_SET1_VFIX_BIT_MASK            0x0F
 
#define BATTBOOST_CONDITION_STOP                0
#define BATTBOOST_CONDITION_START               1
 
#define BATTBOOST_STATUS_NOT_READY              0
#define BATTBOOST_STATUS_READY                  1
 
#define BATTBOOST_DEVICE_ADDRESS_0              0x2E
#define BATTBOOST_DEVICE_ADDRESS_1              0x2F
 
 // battboost_set
 
#define BATTBOOST_MAP_MIKROBUS( cfg, mikrobus )   \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.on  = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // battboost_map
 // battboost
 
typedef struct
{
    // Output pins
    digital_out_t on;       
    // Input pins
    digital_in_t rdy;       
    // Modules
    i2c_master_t i2c;       
    // I2C slave address
    uint8_t slave_address;  
} battboost_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t on;              
    pin_name_t rdy;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} battboost_cfg_t;
 
typedef enum
{
    BATTBOOST_OK = 0,
    BATTBOOST_ERROR = -1
 
} battboost_return_value_t;
 
typedef enum
{
    BATTBOOST_VFIX_2_60V = 3,
    BATTBOOST_VFIX_2_95V,
    BATTBOOST_VFIX_3_27V,
    BATTBOOST_VFIX_3_57V,
    BATTBOOST_VFIX_3_84V,
    BATTBOOST_VFIX_4_10V,
    BATTBOOST_VFIX_4_33V,
    BATTBOOST_VFIX_4_55V,
    BATTBOOST_VFIX_4_76V,
    BATTBOOST_VFIX_4_95V,
    BATTBOOST_VFIX_5_16V,
    BATTBOOST_VFIX_5_34V,
    BATTBOOST_VFIX_5_54V
 
} battboost_vfix_t;
 
typedef enum
{
    BATTBOOST_ICH_2_MA = 0,
    BATTBOOST_ICH_4_MA,
    BATTBOOST_ICH_8_MA,
    BATTBOOST_ICH_16_MA,
    BATTBOOST_ICH_50_MA
 
} battboost_ich_t;
 
void battboost_cfg_setup ( battboost_cfg_t *cfg );
 
err_t battboost_init ( battboost_t *ctx, battboost_cfg_t *cfg );
 
err_t battboost_default_cfg ( battboost_t *ctx );
 
err_t battboost_generic_write ( battboost_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t battboost_generic_read ( battboost_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t battboost_get_status ( battboost_t *ctx, uint8_t *status );
 
err_t battboost_get_chenergy ( battboost_t *ctx, uint32_t *chenergy );
 
err_t battboost_get_vcap ( battboost_t *ctx, float *vcap );
 
err_t battboost_get_vchend ( battboost_t *ctx, uint8_t *vchend );
 
err_t battboost_set_prof ( battboost_t *ctx, uint8_t prof );
 
err_t battboost_get_prof ( battboost_t *ctx, uint8_t *prof );
 
err_t battboost_set_op_mode ( battboost_t *ctx, uint8_t op_mode );
 
err_t battboost_reset_optimizer ( battboost_t *ctx );
 
err_t battboost_set_automode ( battboost_t *ctx );
 
err_t battboost_set_vset ( battboost_t *ctx, float vset );
 
err_t battboost_set_vfix ( battboost_t *ctx, battboost_vfix_t vfix );
 
err_t battboost_set_vmin ( battboost_t *ctx, float vmin );
 
err_t battboost_set_ich ( battboost_t *ctx, battboost_ich_t ich );
 
err_t battboost_high_impedance_mode ( battboost_t *ctx );
 
err_t battboost_vdh_vbt_mode ( battboost_t *ctx );
 
err_t battboost_set_vew ( battboost_t *ctx, uint8_t vew, uint8_t eew );
 
err_t battboost_set_vcapmax ( battboost_t *ctx, uint8_t vcapmax );
 
err_t battboost_set_opt_marg ( battboost_t *ctx, uint8_t opt_marg );
 
void battboost_set_on_pin_state ( battboost_t *ctx, uint8_t start );
 
uint8_t battboost_get_ready ( battboost_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // BATTBOOST_H
 
 // battboost
 
// ------------------------------------------------------------------------ END