battman2.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 BATTMAN2_H
#define BATTMAN2_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 BATTMAN2_INT_GLBL0                                0x00
#define BATTMAN2_INT_GLBL1                                0x04
#define BATTMAN2_ERCFLAG                                  0x05 
#define BATTMAN2_STAT_GLBL                                0x06
#define BATTMAN2_INTM_GLBL1                               0x08
#define BATTMAN2_INTM_GLBL0                               0x09
#define BATTMAN2_CNFG_GLBL                                0x10
#define BATTMAN2_CNFG_GPIO0                               0x11
#define BATTMAN2_CNFG_GPIO1                               0x12
#define BATTMAN2_CNFG_GPIO2                               0x13
#define BATTMAN2_CID                                      0x14
#define BATTMAN2_CNFG_WDT                                 0x17                                       
#define BATTMAN2_INT_CHG                                  0x01
#define BATTMAN2_STAT_CHG_A                               0x02
#define BATTMAN2_STAT_CHG_B                               0x03
#define BATTMAN2_INT_M_CHG                                0x07
#define BATTMAN2_CNFG_CHG_A                               0x20
#define BATTMAN2_CNFG_CHG_B                               0x21
#define BATTMAN2_CNFG_CHG_C                               0x22
#define BATTMAN2_CNFG_CHG_D                               0x23
#define BATTMAN2_CNFG_CHG_E                               0x24
#define BATTMAN2_CNFG_CHG_F                               0x25
#define BATTMAN2_CNFG_CHG_G                               0x26
#define BATTMAN2_CNFG_CHG_H                               0x27
#define BATTMAN2_CNFG_CHG_I                               0x28                                    
#define BATTMAN2_CNFG_SBB0_A                              0x29
#define BATTMAN2_CNFG_SBB0_B                              0x2A
#define BATTMAN2_CNFG_SBB1_A                              0x2B
#define BATTMAN2_CNFG_SBB1_B                              0x2C
#define BATTMAN2_CNFG_SBB2_A                              0x2D
#define BATTMAN2_CNFG_SBB2_B                              0x2E
#define BATTMAN2_CNFG_SBB_TOP                             0x2F                                            
#define BATTMAN2_CNFG_LDO0_A                              0x38
#define BATTMAN2_CNFG_LDO0_B                              0x39
#define BATTMAN2_CNFG_LDO1_A                              0x3A
#define BATTMAN2_CNFG_LDO1_B                              0x3B
 
 // battman2_reg
 
#define BATTMAN2_SEL_LED_RED                              0x00
#define BATTMAN2_SEL_LED_YELLOW                           0x01
#define BATTMAN2_SEL_LED_BLUE                             0x02
#define BATTMAN2_PIN_STATE_OFF                            0x00
#define BATTMAN2_PIN_STATE_ON                             0x01
 
#define BATTMAN2_SEL_ALT_GPIO_STANDARD                    0x00
#define BATTMAN2_SEL_ALT_GPIO_A_OUTPUT_SBB2               0x20
#define BATTMAN2_DBEN_GPI_NO_DEBOUNCE                     0x00
#define BATTMAN2_DBEN_GPI_DEBOUNCE_30_ms                  0x10
#define BATTMAN2_DO_GPIO_LOGIC_LOW                        0x00
#define BATTMAN2_DO_GPIO_LOGIC_HIGH                       0x08
#define BATTMAN2_DRV_OPEN_DRAIN                           0x00
#define BATTMAN2_DRV_PUSH_PULL                            0x04
#define BATTMAN2_DI_GPIO_LOGIC_LOW                        0x00
#define BATTMAN2_DI_GPIO_LOGIC_HIGH                       0x02
#define BATTMAN2_DIR_OUTPUT                               0x00
#define BATTMAN2_DIR_INPUT                                0x01
 
#define BATTMAN2_THM_HOT_411_mV                           0x00
#define BATTMAN2_THM_HOT_367_mV                           0x01
#define BATTMAN2_THM_HOT_327_mV                           0x02
#define BATTMAN2_THM_HOT_291_mV                           0x03
#define BATTMAN2_THM_WARM_511_mV                          0x00
#define BATTMAN2_THM_WARM_459_mV                          0x01
#define BATTMAN2_THM_WARM_411_mV                          0x02
#define BATTMAN2_THM_WARM_367_mV                          0x03
#define BATTMAN2_THM_COOL_923_mV                          0x00
#define BATTMAN2_THM_COOL_867_mV                          0x01
#define BATTMAN2_THM_COOL_807_mV                          0x02
#define BATTMAN2_THM_COOL_747_mV                          0x03
#define BATTMAN2_THM_COLD_1024_mV                         0x00
#define BATTMAN2_THM_COLD_976_mV                          0x01
#define BATTMAN2_THM_COLD_923_mV                          0x02
#define BATTMAN2_THM_COLD_867_mV                          0x03
 
#define BATTMAN2_BIT_MASK_CHARGER_DISABLE                 0xFE
#define BATTMAN2_BIT_MASK_CHARGER_ENABLE                  0x01
#define BATTMAN2_SET_CHARGER_DISABLE                      0x00
#define BATTMAN2_SET_CHARGER_ENABLE                       0x01
 
#define BATTMAN2_I_PQ_10_PERCENTAGE                       0x00
#define BATTMAN2_I_PQ_20_PERCENTAGE                       0x01
 
#define BATTMAN2_I_TERM_5_PERCENTAGE                      0x00
#define BATTMAN2_I_TERM_7_5_PERCENTAGE                    0x01
#define BATTMAN2_I_TERM_10_PERCENTAGE                     0x02
#define BATTMAN2_I_TERM_15_PERCENTAGE                     0x03
 
#define BATTMAN2_T_TOPOFF_0_MIN                           0x00
#define BATTMAN2_T_TOPOFF_5_MIN                           0x01
#define BATTMAN2_T_TOPOFF_10_MIN                          0x02
#define BATTMAN2_T_TOPOFF_15_MIN                          0x03
#define BATTMAN2_T_TOPOFF_20_MIN                          0x04
#define BATTMAN2_T_TOPOFF_25_MIN                          0x05
#define BATTMAN2_T_TOPOFF_30_MIN                          0x06
#define BATTMAN2_T_TOPOFF_35_MIN                          0x07
 
#define BATTMAN2_TJ_REG_60_C                              0x00
#define BATTMAN2_TJ_REG_70_C                              0x01
#define BATTMAN2_TJ_REG_80_C                              0x02
#define BATTMAN2_TJ_REG_90_C                              0x03
#define BATTMAN2_TJ_REG_100_C                             0x04
 
#define BATTMAN2_T_FAST_CHG_TIMER_DISABLED                0x00
#define BATTMAN2_T_FAST_CHG_TIMER_3_HOURS                 0x01
#define BATTMAN2_T_FAST_CHG_TIMER_5_HOURS                 0x02
#define BATTMAN2_T_FAST_CHG_TIMER_7_HOURS                 0x03
 
#define BATTMAN2_THM_EN_THERMISTOR_DISABLED               0x00
#define BATTMAN2_THM_EN_THERMISTOR_ENABLED                0x01
 
#define BATTMAN2_USBS_CHGIN_IS_NOT_SUSPENDED              0x00
#define BATTMAN2_USBS_CHGIN_IS_SUSPENDED                  0x01
 
#define BATTMAN2_IMON_DISCHG_SCALE_8_2_mA                 0x00
#define BATTMAN2_IMON_DISCHG_SCALE_40_5_mA                0x01
#define BATTMAN2_IMON_DISCHG_SCALE_72_3_mA                0x02
#define BATTMAN2_IMON_DISCHG_SCALE_103_4_mA               0x03
#define BATTMAN2_IMON_DISCHG_SCALE_134_1_mA               0x04
#define BATTMAN2_IMON_DISCHG_SCALE_164_1_mA               0x05
#define BATTMAN2_IMON_DISCHG_SCALE_193_7_mA               0x06
#define BATTMAN2_IMON_DISCHG_SCALE_222_7_mA               0x07
#define BATTMAN2_IMON_DISCHG_SCALE_251_2_mA               0x08
#define BATTMAN2_IMON_DISCHG_SCALE_279_3_mA               0x09
#define BATTMAN2_IMON_DISCHG_SCALE_300_mA                 0x0A
 
#define BATTMAN2_MUX_SEL_MULTIPLEXER_DISABLED             0x00
#define BATTMAN2_MUX_SEL_CHGIN_VOLTAGE_MONITOR            0x01
#define BATTMAN2_MUX_SEL_CHGIN_CURRENT_MONITOR            0x02
#define BATTMAN2_MUX_SEL_BATT_VOLTAGE_MONITOR             0x03
#define BATTMAN2_MUX_SEL_BATT_CHARGE_CURRENT_MONITOR      0x04
#define BATTMAN2_MUX_SEL_BATT_DISCHARGE_CURRENT_NORMAL    0x05
#define BATTMAN2_MUX_SEL_BATT_DISCHARGE_CURRENT_NULLING   0x06
#define BATTMAN2_MUX_SEL_THM_VOLTAGE_MONITOR              0x07
#define BATTMAN2_MUX_SEL_TBIAS_VOLTAGE_MONITOR            0x08
#define BATTMAN2_MUX_SEL_AGND_VOLTAGE_MONITOR             0x09
#define BATTMAN2_MUX_SEL_SYS_VOLTAGE_MONITOR              0x0A
 
#define BATTMAN2_OP_MODE_BUCK_AND_BOOST                   0x00
#define BATTMAN2_OP_MODE_BUCK                             0x01
 
#define BATTMAN2_CURRENT_LIMIT_1000_mA                    0x00
#define BATTMAN2_CURRENT_LIMIT_750_mA                     0x01
#define BATTMAN2_CURRENT_LIMIT_500_mA                     0x02
#define BATTMAN2_CURRENT_LIMIT_333_mA                     0x03
 
#define BATTMAN2_ACTIVE_DISCHARGE_DISABLE                 0x00
#define BATTMAN2_ACTIVE_DISCHARGE_ENABLE                  0x01
 
#define BATTMAN2_ENABLE_CONTROL_FPS_SLOT_0                0x00
#define BATTMAN2_ENABLE_CONTROL_FPS_SLOT_1                0x01
#define BATTMAN2_ENABLE_CONTROL_FPS_SLOT_2                0x02
#define BATTMAN2_ENABLE_CONTROL_FPS_SLOT_3                0x03
#define BATTMAN2_ENABLE_CONTROL_OFF_IRRESPECTIVE_FPS      0x04
#define BATTMAN2_ENABLE_CONTROL_ON_IRRESPECTIVE_FPS       0x06
 
#define BATTMAN2_ICHGIN_LIM_95_mA                         0x00
#define BATTMAN2_ICHGIN_LIM_190_mA                        0x01
#define BATTMAN2_ICHGIN_LIM_285_mA                        0x02
#define BATTMAN2_ICHGIN_LIM_380_mA                        0x03
#define BATTMAN2_ICHGIN_LIM_475_mA                        0x04
 
#define BATTMAN2_DRV_SBB_FAST_TRANSITION_TIME             0x00
#define BATTMAN2_DRV_SBB_TRANSITION_TIME_1                0x01
#define BATTMAN2_DRV_SBB_TRANSITION_TIME_2                0x02
#define BATTMAN2_DRV_SBB_TRANSITION_TIME_3                0x03
 
#define BATTMAN2_SBB_CH_0                                 0x00
#define BATTMAN2_SBB_CH_1                                 0x01
#define BATTMAN2_SBB_CH_2                                 0x02
 
#define BATTMAN2_SET_DEV_ADDR                             0x48
 
 // battman2_set
 
#define BATTMAN2_CHG_DTLS_OFF                             0x00
#define BATTMAN2_CHG_DTLS_PREQUALIFICATION_MODE           0x01
#define BATTMAN2_CHG_DTLS_FAST_CHARGE_CONSTANT_CURRENT    0x02 
#define BATTMAN2_CHG_DTLS_JEITA_MODIFIED_FAST_CHRG_CC     0x03
#define BATTMAN2_CHG_DTLS_FAST_CHARGE_CONSTANT_VOLTAGE    0x04
#define BATTMAN2_CHG_DTLS_JEITA_MODIFIED_FAST_CHRG_CV     0x05
#define BATTMAN2_CHG_DTLS_TOP_OFF_MODE                    0x06
#define BATTMAN2_CHG_DTLS_JEITA_MODIFIED_TOP_OFF_MODE     0x07
#define BATTMAN2_CHG_DTLS_DONE                            0x08
#define BATTMAN2_CHG_DTLS_JEITA_MODIFIED_DONE             0x09
#define BATTMAN2_CHG_DTLS_PREQUALIFICATION_TIMER_FAULT    0x0A
#define BATTMAN2_CHG_DTLS_FAST_CHARGE_TIMER_FAULT         0x0B
#define BATTMAN2_CHG_DTLS_BATTERY_TEMPERATURE_FAULT       0x0C
 
#define BATTMAN2_CHG_NO_CHARGING                          0x00
#define BATTMAN2_CHG_CHARGING                             0x01
 
 // battman2_chrg_status
 
#define BATTMAN2_MAP_MIKROBUS( cfg, mikrobus )    \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.irq = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // battman2_map
 // battman2
 
typedef struct
{
    // Output pins
    digital_out_t  rst;      
    // Input pins
    digital_in_t  irq;       
    // Modules
    i2c_master_t i2c;        
    // I2C slave address
    uint8_t slave_address;   
} battman2_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  rst;        
    pin_name_t  irq;        
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
} battman2_cfg_t;
 
typedef enum
{
   BATTMAN2_OK = 0,
   BATTMAN2_ERROR = -1
 
} battman2_return_value_t;
 
typedef struct
{
    uint8_t   thm_hot;
    uint8_t   thm_warm;
    uint8_t   thm_cool;
    uint8_t   thm_cold;
    float     vchgin_min;
    float     ichgin_lim;
    uint8_t   i_pq;
    float     chg_pq;
    uint8_t   i_term;
    uint8_t   t_topoff;
    uint8_t   tj_reg;
    float     vsys_reg;
    float     chg_cc;
    uint8_t   t_fast_chg;
    float     chg_cc_jeita;
    uint8_t   thm_en;
    float     chg_cv;
    uint8_t   usbs;
    float     chg_cv_jeita;
    uint8_t   imon_dischg_scale;
    uint8_t   mux_sel;
 
} battman2_chg_cnfg_t;
 
typedef struct
{
    uint8_t   vchgin_min_stat;
    uint8_t   ichgin_lim_stat;
    uint8_t   vsys_min_stat;
    uint8_t   tj_reg_stat;
    uint8_t   thm_dtls;
    uint8_t   chg_dtls;
    uint8_t   chgin_dtls;
    uint8_t   chg;
    uint8_t   time_sus;
 
} battman2_stat_chg_t;
 
typedef struct
{
    float     output_vtg;
    uint8_t   op_mode;
    uint8_t   current_limit;
    uint8_t   active_discharge_enable;
    uint8_t   enable_control;
    uint8_t   ichgin_lim_def;
    uint8_t   drv_sbb;
 
} battman2_sbb_cnfg_t;
 
typedef struct
{
    float     output_vtg;
    uint8_t   op_mode;
    uint8_t   current_limit;
    uint8_t   active_discharge_enable;
    uint8_t   enable_control;
 
} battman2_ldo_cnfg_t;
 
void battman2_cfg_setup ( battman2_cfg_t *cfg );
 
err_t battman2_init ( battman2_t *ctx, battman2_cfg_t *cfg );
 
err_t battman2_default_cfg ( battman2_t *ctx );
 
err_t battman2_generic_write ( battman2_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t battman2_generic_read ( battman2_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t battman2_hw_reset ( battman2_t *ctx );
 
err_t battman2_check_int_glbl ( battman2_t *ctx, uint8_t *int_glbl0, uint8_t *int_glbl1 );
 
err_t battman2_check_faults_occurred ( battman2_t *ctx, uint8_t *faults );
 
err_t battman2_check_stat ( battman2_t *ctx, uint8_t *stat );
 
 
err_t battman2_set_gpio_output ( battman2_t *ctx, uint8_t gpio_sel, uint8_t led_state );
 
err_t battman2_get_id ( battman2_t *ctx, uint8_t *cid );
 
err_t battman2_set_charger_enable ( battman2_t *ctx, uint8_t en_chg );
 
err_t battman2_set_charger_cfg ( battman2_t *ctx, battman2_chg_cnfg_t chg_cnfg );
 
err_t battman2_get_charger_cfg ( battman2_t *ctx, battman2_chg_cnfg_t *chg_cnfg );
 
err_t battman2_get_chg_status ( battman2_t *ctx, battman2_stat_chg_t *chg_stat );
 
err_t battman2_set_sbb_config ( battman2_t *ctx, uint8_t sbb_sel, battman2_sbb_cnfg_t sbb_cfg );
 
err_t battman2_get_sbb_config ( battman2_t *ctx, uint8_t sbb_sel, battman2_sbb_cnfg_t *sbb_cfg );
 
err_t battman2_set_ldo_config ( battman2_t *ctx, battman2_ldo_cnfg_t ldo_cfg );
 
err_t battman2_get_ldo_config ( battman2_t *ctx, battman2_ldo_cnfg_t *ldo_cfg );
 
uint8_t battman2_check_interrupt ( battman2_t *ctx );
 
void battman2_led_intro ( battman2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // BATTMAN2_H
 
 // battman2
 
// ------------------------------------------------------------------------ END