charger25.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 CHARGER25_H
#define CHARGER25_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 CHARGER25_REG_MINIMAL_SYSTEM_VOLTAGE     0x00
#define CHARGER25_REG_CHARGE_VOLTAGE_LIMIT       0x01
#define CHARGER25_REG_CHARGE_CURRENT_LIMIT       0x03
#define CHARGER25_REG_INPUT_VOLTAGE_LIMIT        0x05
#define CHARGER25_REG_INPUT_CURRENT_LIMIT        0x06
#define CHARGER25_REG_PRECHARGE_CONTROL          0x08
#define CHARGER25_REG_TERMINATION_CONTROL        0x09
#define CHARGER25_REG_RECHARGE_CONTROL           0x0A
#define CHARGER25_REG_VOTG_REGULATION            0x0B
#define CHARGER25_REG_IOTG_REGULATION            0x0D
#define CHARGER25_REG_TIMER_CONTROL              0x0E
#define CHARGER25_REG_CHARGER_CONTROL_0          0x0F
#define CHARGER25_REG_CHARGER_CONTROL_1          0x10
#define CHARGER25_REG_CHARGER_CONTROL_2          0x11
#define CHARGER25_REG_CHARGER_CONTROL_3          0x12
#define CHARGER25_REG_CHARGER_CONTROL_4          0x13
#define CHARGER25_REG_CHARGER_CONTROL_5          0x14
#define CHARGER25_REG_RESERVED                   0x15
#define CHARGER25_REG_TEMPERATURE_CONTROL        0x16
#define CHARGER25_REG_NTC_CONTROL_0              0x17
#define CHARGER25_REG_NTC_CONTROL_1              0x18
#define CHARGER25_REG_ICO_CURRENT_LIMIT          0x19
#define CHARGER25_REG_CHARGER_STATUS_0           0x1B
#define CHARGER25_REG_CHARGER_STATUS_1           0x1C
#define CHARGER25_REG_CHARGER_STATUS_2           0x1D
#define CHARGER25_REG_CHARGER_STATUS_3           0x1E
#define CHARGER25_REG_CHARGER_STATUS_4           0x1F
#define CHARGER25_REG_FAULT_STATUS_0             0x20
#define CHARGER25_REG_FAULT_STATUS_1             0x21
#define CHARGER25_REG_CHARGER_FLAG_0             0x22
#define CHARGER25_REG_CHARGER_FLAG_1             0x23
#define CHARGER25_REG_CHARGER_FLAG_2             0x24
#define CHARGER25_REG_CHARGER_FLAG_3             0x25
#define CHARGER25_REG_FAULT_FLAG_0               0x26
#define CHARGER25_REG_FAULT_FLAG_1               0x27
#define CHARGER25_REG_CHARGER_MASK_0             0x28
#define CHARGER25_REG_CHARGER_MASK_1             0x29
#define CHARGER25_REG_CHARGER_MASK_2             0x2A
#define CHARGER25_REG_CHARGER_MASK_3             0x2B
#define CHARGER25_REG_FAULT_MASK_0               0x2C
#define CHARGER25_REG_FAULT_MASK_1               0x2D
#define CHARGER25_REG_ADC_CONTROL                0x2E
#define CHARGER25_REG_ADC_FUNCTION_DISABLE_0     0x2F
#define CHARGER25_REG_ADC_FUNCTION_DISABLE_1     0x30
#define CHARGER25_REG_IBUS_ADC                   0x31
#define CHARGER25_REG_IBAT_ADC                   0x33
#define CHARGER25_REG_VBUS_ADC                   0x35
#define CHARGER25_REG_VAC1_ADC                   0x37
#define CHARGER25_REG_VAC2_ADC                   0x39
#define CHARGER25_REG_VBAT_ADC                   0x3B
#define CHARGER25_REG_VSYS_ADC                   0x3D
#define CHARGER25_REG_TS_ADC                     0x3F
#define CHARGER25_REG_TDIE_ADC                   0x41
#define CHARGER25_REG_D_P_ADC                    0x43
#define CHARGER25_REG_D_M_ADC                    0x45
#define CHARGER25_REG_DPDM_DRIVER                0x47
#define CHARGER25_REG_PART_INFORMATION           0x48
 
 // charger25_reg
 
#define CHARGER25_SOFT_RESET                     0x40
 
#define CHARGER25_VSYS_MIN_BIT_MASK              0x3F
#define CHARGER25_VSYS_MIN_STEP_SIZE             250
#define CHARGER25_VSYS_MIN_FIXED_OFFSET          2500
 
#define CHARGER25_VTG_LIM_MSB_BIT_MASK           0x07
#define CHARGER25_VTG_CONV_V_MV                  10
#define CHARGER25_VTG_CELL_COUNT_DIV             3
#define CHARGER25_VTG_CELL_SEL_1                 1
#define CHARGER25_VTG_CELL_SEL_2                 2
#define CHARGER25_VTG_CELL_SEL_3                 3
#define CHARGER25_VTG_CELL_SEL_4                 4
#define CHARGER25_VTG_CELL_COUNT_MIN             1
#define CHARGER25_VTG_CELL_COUNT_MAX             4
#define CHARGER25_VTG_CELL_COUNT_MUL             7
 
#define CHARGER25_CURR_LIM_MSB_BIT_MASK          0x01
#define CHARGER25_CURR_CONV_A_MA                 10
 
#define CHARGER25_INPUT_VTG_CONV_V_MV            100
 
#define CHARGER25_SET_ADC_FUNC_ENABLE            0x00
#define CHARGER25_SET_ADC_FUNC_DISABLE           0x01
#define CHARGER25_SET_ADC_CTRL_DISABLE           0x00
#define CHARGER25_SET_ADC_CTRL_ENABLE            0x01
 
#define CHARGER25_SET_ADC_RATE_CONT_CNV          0x00
#define CHARGER25_SET_ADC_ONES_HOT_CNV           0x01
#define CHARGER25_SET_ADC_SAMPLE_15_BIT          0x00
#define CHARGER25_SET_ADC_SAMPLE_14_BIT          0x01
#define CHARGER25_SET_ADC_SAMPLE_13_BIT          0x02
#define CHARGER25_SET_ADC_SAMPLE_12_BIT          0x03
 
#define CHARGER25_SET_ADC_AVG_SINGLE_VAL         0x00
#define CHARGER25_SET_ADC_AVG_RUN_AVG            0x01
#define CHARGER25_SET_ADC_AVG_INIT_EXI_VAL       0x00
#define CHARGER25_SET_ADC_AVG_INIT_ADC_CNV       0x01
 
#define CHARGER25_CH_STAT_NOT_CHARGING           0x00
#define CHARGER25_CH_STAT_TRICKLE_CHARGE         0x01
#define CHARGER25_CH_STAT_PRE_CHARGE             0x02
#define CHARGER25_CH_STAT_FAST_CHARGE            0x03
#define CHARGER25_CH_STAT_TAPER_CHARGE           0x04
#define CHARGER25_CH_STAT_TIMER_ACT_CHARGING     0x06
#define CHARGER25_CH_STAT_CHARGE_TERMIN_DONE     0x07
 
#define CHARGER25_STATE_PIN_QON_LOW              0x00
#define CHARGER25_STATE_PIN_QON_HIGH             0x01
 
#define CHARGER25_DEVICE_ADDRESS                 0x6B
 
 // charger25_set
 
#define CHARGER25_MAP_MIKROBUS( cfg, mikrobus )   \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.qon = MIKROBUS( mikrobus, MIKROBUS_AN );  \
    cfg.ce = MIKROBUS( mikrobus, MIKROBUS_PWM );  \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // charger25_map
 // charger25
 
typedef struct
{
    // Output pins
    digital_out_t qon;        
    digital_out_t ce;         
    // Input pins
    digital_in_t int_pin;     
    // Modules
    i2c_master_t i2c;         
    // I2C slave address
    uint8_t slave_address;    
} charger25_t;
 
typedef struct
{
    pin_name_t scl;            
    pin_name_t sda;            
    pin_name_t qon;            
    pin_name_t ce;             
    pin_name_t int_pin;        
    uint32_t   i2c_speed;      
    uint8_t    i2c_address;    
} charger25_cfg_t;
 
typedef struct
{
    uint8_t iindpm_stat;          
    uint8_t vindpm_stat;          
    uint8_t wd_stat;              
    uint8_t poorsrc_stat;         
    uint8_t pg_stat;              
    uint8_t ac2_present_stat;     
    uint8_t ac1_present_stat;     
    uint8_t vbus_present_stat;    
    uint8_t chg_stat;             
    uint8_t vbus_stat;            
    uint8_t bc1_2_done;           
    uint8_t ico_stat;             
    uint8_t treg_stat;            
    uint8_t dpdm_stat;            
    uint8_t vbat_present_stat;    
    uint8_t acrb2_stat;           
    uint8_t acrb1_stat;           
    uint8_t adc_done_stat;        
    uint8_t vsys_stat;            
    uint8_t chg_tmr_stat;         
    uint8_t trichg_tmr_stat;      
    uint8_t prechg_tmr_stat;      
    uint8_t vbatotg_low_stat;     
    uint8_t ts_cold_stat;         
    uint8_t ts_cool_stat;         
    uint8_t ts_warm_stat;         
    uint8_t ts_hot_stat;          
} charger25_status_t;
 
typedef struct
{
    uint8_t adc_en;          
    uint8_t adc_rate;        
    uint8_t adc_sample;      
    uint8_t adc_avg;         
    uint8_t adc_avg_init;    
} charger25_adc_ctrl_t;
 
typedef struct
{
    uint8_t ibus_adc_dis;    
    uint8_t ibat_adc_dis;    
    uint8_t vbus_adc_dis;    
    uint8_t vbat_adc_dis;    
    uint8_t vsys_adc_dis;    
    uint8_t ts_adc_dis;      
    uint8_t tdie_adc_dis;    
    uint8_t dp_adc_dis;      
    uint8_t dm_adc_dis;      
    uint8_t vac2_adc_dis;    
    uint8_t vac1_adc_dis;    
} charger25_adc_func_t;
 
typedef enum
{
    CHARGER25_OK = 0,
    CHARGER25_ERROR = -1
 
} charger25_return_value_t;
 
 
 
void charger25_cfg_setup ( charger25_cfg_t *cfg );
 
err_t charger25_init ( charger25_t *ctx, charger25_cfg_t *cfg );
 
err_t charger25_default_cfg ( charger25_t *ctx );
 
err_t charger25_generic_write ( charger25_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t charger25_generic_read ( charger25_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void charger25_set_qon_pin ( charger25_t *ctx, uint8_t state );
 
void charger25_enable ( charger25_t *ctx );
 
void charger25_disable ( charger25_t *ctx );
 
uint8_t charger25_get_interrupt ( charger25_t *ctx );
 
err_t charger25_sw_reset ( charger25_t *ctx );
 
err_t charger25_get_vbat ( charger25_t *ctx, uint16_t *vbat );
 
err_t charger25_get_vsys_min ( charger25_t *ctx, uint16_t *vsys_min );
 
err_t charger25_set_adc_control ( charger25_t *ctx, charger25_adc_ctrl_t adc_ctrl );
 
err_t charger25_set_adc_function ( charger25_t *ctx, charger25_adc_func_t adc_func );
 
err_t charger25_get_vbat_lim ( charger25_t *ctx, uint16_t *vtg_lim );
 
err_t charger25_set_vbat_lim ( charger25_t *ctx, uint16_t vtg_lim );
 
err_t charger25_get_cell_count ( charger25_t *ctx, uint8_t *cell_count );
 
err_t charger25_set_cell_count ( charger25_t *ctx, uint8_t cell_count );
 
err_t charger25_get_current_limit ( charger25_t *ctx, uint16_t *current_lim );
 
err_t charger25_set_current_limit ( charger25_t *ctx, uint16_t current_lim );
 
err_t charger25_get_input_vtg_limit ( charger25_t *ctx, uint16_t *input_vtg_limit );
 
err_t charger25_set_input_vtg_limit ( charger25_t *ctx, uint16_t input_vtg_limit );
 
err_t charger25_get_input_curr_limit ( charger25_t *ctx, uint16_t *input_curr_limit );
 
err_t charger25_set_input_curr_limit ( charger25_t *ctx, uint16_t input_curr_limit );
 
err_t charger25_get_status ( charger25_t *ctx, charger25_status_t *status );
 
#ifdef __cplusplus
}
#endif
#endif // CHARGER25_H
 
 // charger25
 
// ------------------------------------------------------------------------ END