charger25  2.1.0.0
charger25.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef CHARGER25_H
29 #define CHARGER25_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 
59 #define CHARGER25_REG_MINIMAL_SYSTEM_VOLTAGE 0x00
60 #define CHARGER25_REG_CHARGE_VOLTAGE_LIMIT 0x01
61 #define CHARGER25_REG_CHARGE_CURRENT_LIMIT 0x03
62 #define CHARGER25_REG_INPUT_VOLTAGE_LIMIT 0x05
63 #define CHARGER25_REG_INPUT_CURRENT_LIMIT 0x06
64 #define CHARGER25_REG_PRECHARGE_CONTROL 0x08
65 #define CHARGER25_REG_TERMINATION_CONTROL 0x09
66 #define CHARGER25_REG_RECHARGE_CONTROL 0x0A
67 #define CHARGER25_REG_VOTG_REGULATION 0x0B
68 #define CHARGER25_REG_IOTG_REGULATION 0x0D
69 #define CHARGER25_REG_TIMER_CONTROL 0x0E
70 #define CHARGER25_REG_CHARGER_CONTROL_0 0x0F
71 #define CHARGER25_REG_CHARGER_CONTROL_1 0x10
72 #define CHARGER25_REG_CHARGER_CONTROL_2 0x11
73 #define CHARGER25_REG_CHARGER_CONTROL_3 0x12
74 #define CHARGER25_REG_CHARGER_CONTROL_4 0x13
75 #define CHARGER25_REG_CHARGER_CONTROL_5 0x14
76 #define CHARGER25_REG_RESERVED 0x15
77 #define CHARGER25_REG_TEMPERATURE_CONTROL 0x16
78 #define CHARGER25_REG_NTC_CONTROL_0 0x17
79 #define CHARGER25_REG_NTC_CONTROL_1 0x18
80 #define CHARGER25_REG_ICO_CURRENT_LIMIT 0x19
81 #define CHARGER25_REG_CHARGER_STATUS_0 0x1B
82 #define CHARGER25_REG_CHARGER_STATUS_1 0x1C
83 #define CHARGER25_REG_CHARGER_STATUS_2 0x1D
84 #define CHARGER25_REG_CHARGER_STATUS_3 0x1E
85 #define CHARGER25_REG_CHARGER_STATUS_4 0x1F
86 #define CHARGER25_REG_FAULT_STATUS_0 0x20
87 #define CHARGER25_REG_FAULT_STATUS_1 0x21
88 #define CHARGER25_REG_CHARGER_FLAG_0 0x22
89 #define CHARGER25_REG_CHARGER_FLAG_1 0x23
90 #define CHARGER25_REG_CHARGER_FLAG_2 0x24
91 #define CHARGER25_REG_CHARGER_FLAG_3 0x25
92 #define CHARGER25_REG_FAULT_FLAG_0 0x26
93 #define CHARGER25_REG_FAULT_FLAG_1 0x27
94 #define CHARGER25_REG_CHARGER_MASK_0 0x28
95 #define CHARGER25_REG_CHARGER_MASK_1 0x29
96 #define CHARGER25_REG_CHARGER_MASK_2 0x2A
97 #define CHARGER25_REG_CHARGER_MASK_3 0x2B
98 #define CHARGER25_REG_FAULT_MASK_0 0x2C
99 #define CHARGER25_REG_FAULT_MASK_1 0x2D
100 #define CHARGER25_REG_ADC_CONTROL 0x2E
101 #define CHARGER25_REG_ADC_FUNCTION_DISABLE_0 0x2F
102 #define CHARGER25_REG_ADC_FUNCTION_DISABLE_1 0x30
103 #define CHARGER25_REG_IBUS_ADC 0x31
104 #define CHARGER25_REG_IBAT_ADC 0x33
105 #define CHARGER25_REG_VBUS_ADC 0x35
106 #define CHARGER25_REG_VAC1_ADC 0x37
107 #define CHARGER25_REG_VAC2_ADC 0x39
108 #define CHARGER25_REG_VBAT_ADC 0x3B
109 #define CHARGER25_REG_VSYS_ADC 0x3D
110 #define CHARGER25_REG_TS_ADC 0x3F
111 #define CHARGER25_REG_TDIE_ADC 0x41
112 #define CHARGER25_REG_D_P_ADC 0x43
113 #define CHARGER25_REG_D_M_ADC 0x45
114 #define CHARGER25_REG_DPDM_DRIVER 0x47
115 #define CHARGER25_REG_PART_INFORMATION 0x48
116  // charger25_reg
118 
133 #define CHARGER25_SOFT_RESET 0x40
134 
139 #define CHARGER25_VSYS_MIN_BIT_MASK 0x3F
140 #define CHARGER25_VSYS_MIN_STEP_SIZE 250.0f
141 #define CHARGER25_VSYS_MIN_FIXED_OFFSET 2500.0f
142 
147 #define CHARGER25_VTG_LIM_MSB_BIT_MASK 0x07
148 #define CHARGER25_VTG_CONV_V_MV 10.0f
149 #define CHARGER25_VTG_CELL_COUNT_DIV 3.0f
150 #define CHARGER25_VTG_CELL_SEL_1 1
151 #define CHARGER25_VTG_CELL_SEL_2 2
152 #define CHARGER25_VTG_CELL_SEL_3 3
153 #define CHARGER25_VTG_CELL_SEL_4 4
154 #define CHARGER25_VTG_CELL_COUNT_MIN 1
155 #define CHARGER25_VTG_CELL_COUNT_MAX 4
156 #define CHARGER25_VTG_CELL_COUNT_MUL 7
157 
162 #define CHARGER25_CURR_LIM_MSB_BIT_MASK 0x01
163 #define CHARGER25_CURR_CONV_A_MA 10.0f
164 
169 #define CHARGER25_INPUT_VTG_CONV_V_MV 100.0f
170 
175 #define CHARGER25_SET_ADC_FUNC_ENABLE 0x00
176 #define CHARGER25_SET_ADC_FUNC_DISABLE 0x01
177 #define CHARGER25_SET_ADC_CTRL_DISABLE 0x00
178 #define CHARGER25_SET_ADC_CTRL_ENABLE 0x01
179 
184 #define CHARGER25_SET_ADC_RATE_CONT_CNV 0x00
185 #define CHARGER25_SET_ADC_ONES_HOT_CNV 0x01
186 #define CHARGER25_SET_ADC_SAMPLE_15_BIT 0x00
187 #define CHARGER25_SET_ADC_SAMPLE_14_BIT 0x01
188 #define CHARGER25_SET_ADC_SAMPLE_13_BIT 0x02
189 #define CHARGER25_SET_ADC_SAMPLE_12_BIT 0x03
190 
195 #define CHARGER25_SET_ADC_AVG_SINGLE_VAL 0x00
196 #define CHARGER25_SET_ADC_AVG_RUN_AVG 0x01
197 #define CHARGER25_SET_ADC_AVG_INIT_EXI_VAL 0x00
198 #define CHARGER25_SET_ADC_AVG_INIT_ADC_CNV 0x01
199 
204 #define CHARGER25_CH_STAT_NOT_CHARGING 0x00
205 #define CHARGER25_CH_STAT_TRICKLE_CHARGE 0x01
206 #define CHARGER25_CH_STAT_PRE_CHARGE 0x02
207 #define CHARGER25_CH_STAT_FAST_CHARGE 0x03
208 #define CHARGER25_CH_STAT_TAPER_CHARGE 0x04
209 #define CHARGER25_CH_STAT_TIMER_ACT_CHARGING 0x06
210 #define CHARGER25_CH_STAT_CHARGE_TERMIN_DONE 0x07
211 
216 #define CHARGER25_STATE_PIN_QON_LOW 0x00
217 #define CHARGER25_STATE_PIN_QON_HIGH 0x01
218 
224 #define CHARGER25_DEVICE_ADDRESS 0x6B
225  // charger25_set
227 
242 #define CHARGER25_MAP_MIKROBUS( cfg, mikrobus ) \
243  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
244  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
245  cfg.qon = MIKROBUS( mikrobus, MIKROBUS_AN ); \
246  cfg.ce = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
247  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
248  // charger25_map // charger25
251 
256 typedef struct
257 {
258  // Output pins
259  digital_out_t qon;
260  digital_out_t ce;
262  // Input pins
263  digital_in_t int_pin;
265  // Modules
266  i2c_master_t i2c;
268  // I2C slave address
269  uint8_t slave_address;
271 } charger25_t;
272 
277 typedef struct
278 {
279  pin_name_t scl;
280  pin_name_t sda;
282  pin_name_t qon;
283  pin_name_t ce;
284  pin_name_t int_pin;
286  uint32_t i2c_speed;
287  uint8_t i2c_address;
290 
295 typedef struct
296 {
297  uint8_t iindpm_stat;
298  uint8_t vindpm_stat;
299  uint8_t wd_stat;
300  uint8_t poorsrc_stat;
301  uint8_t pg_stat;
305  uint8_t chg_stat;
306  uint8_t vbus_stat;
307  uint8_t bc1_2_done;
308  uint8_t ico_stat;
309  uint8_t treg_stat;
310  uint8_t dpdm_stat;
312  uint8_t acrb2_stat;
313  uint8_t acrb1_stat;
314  uint8_t adc_done_stat;
315  uint8_t vsys_stat;
316  uint8_t chg_tmr_stat;
317  uint8_t trichg_tmr_stat;
318  uint8_t prechg_tmr_stat;
320  uint8_t ts_cold_stat;
321  uint8_t ts_cool_stat;
322  uint8_t ts_warm_stat;
323  uint8_t ts_hot_stat;
326 
331 typedef struct
332 {
333  uint8_t adc_en;
334  uint8_t adc_rate;
335  uint8_t adc_sample;
336  uint8_t adc_avg;
337  uint8_t adc_avg_init;
340 
345 typedef struct
346 {
347  uint8_t ibus_adc_dis;
348  uint8_t ibat_adc_dis;
349  uint8_t vbus_adc_dis;
350  uint8_t vbat_adc_dis;
351  uint8_t vsys_adc_dis;
352  uint8_t ts_adc_dis;
353  uint8_t tdie_adc_dis;
354  uint8_t dp_adc_dis;
355  uint8_t dm_adc_dis;
356  uint8_t vac2_adc_dis;
357  uint8_t vac1_adc_dis;
360 
365 typedef enum
366 {
368  CHARGER25_ERROR = -1
369 
371 
372 
373 
390 
405 
419 
434 err_t charger25_generic_write ( charger25_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
435 
450 err_t charger25_generic_read ( charger25_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
451 
465 void charger25_set_qon_pin ( charger25_t *ctx, uint8_t state );
466 
479 
492 
506 
521 
536 err_t charger25_get_vbat ( charger25_t *ctx, float *vbat );
537 
552 err_t charger25_get_vsys_min ( charger25_t *ctx, float *vsys_min );
553 
570 
587 
602 err_t charger25_get_vbat_lim ( charger25_t *ctx, float *vtg_lim );
603 
622 err_t charger25_set_vbat_lim ( charger25_t *ctx, float vtg_lim );
623 
642 err_t charger25_get_cell_count ( charger25_t *ctx, uint8_t *cell_count );
643 
662 err_t charger25_set_cell_count ( charger25_t *ctx, uint8_t cell_count );
663 
678 err_t charger25_get_current_limit ( charger25_t *ctx, float *current_lim );
679 
694 err_t charger25_set_current_limit ( charger25_t *ctx, float current_lim );
695 
710 err_t charger25_get_input_vtg_limit ( charger25_t *ctx, float *input_vtg_limit );
711 
726 err_t charger25_set_input_vtg_limit ( charger25_t *ctx, float input_vtg_limit );
727 
742 err_t charger25_get_input_curr_limit ( charger25_t *ctx, float *input_curr_limit );
743 
758 err_t charger25_set_input_curr_limit ( charger25_t *ctx, float input_curr_limit );
759 
776 
777 #ifdef __cplusplus
778 }
779 #endif
780 #endif // CHARGER25_H
781  // charger25
783 
784 // ------------------------------------------------------------------------ END
charger25_adc_func_t::dp_adc_dis
uint8_t dp_adc_dis
Definition: charger25.h:354
charger25_status_t::chg_tmr_stat
uint8_t chg_tmr_stat
Definition: charger25.h:316
charger25_cfg_t
Charger 25 Click configuration object.
Definition: charger25.h:278
charger25_adc_func_t::ibus_adc_dis
uint8_t ibus_adc_dis
Definition: charger25.h:347
charger25_cfg_t::scl
pin_name_t scl
Definition: charger25.h:279
charger25_adc_ctrl_t::adc_avg_init
uint8_t adc_avg_init
Definition: charger25.h:337
charger25_status_t::ac1_present_stat
uint8_t ac1_present_stat
Definition: charger25.h:303
charger25_set_adc_control
err_t charger25_set_adc_control(charger25_t *ctx, charger25_adc_ctrl_t adc_ctrl)
Charger 25 set ADC control function.
charger25_set_adc_function
err_t charger25_set_adc_function(charger25_t *ctx, charger25_adc_func_t adc_func)
Charger 25 set ADC function function.
charger25_status_t::acrb2_stat
uint8_t acrb2_stat
Definition: charger25.h:312
charger25_generic_write
err_t charger25_generic_write(charger25_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Charger 25 I2C writing function.
charger25_status_t::ts_hot_stat
uint8_t ts_hot_stat
Definition: charger25.h:323
charger25_get_vbat
err_t charger25_get_vbat(charger25_t *ctx, float *vbat)
Charger 25 get VBAT function.
charger25_status_t::poorsrc_stat
uint8_t poorsrc_stat
Definition: charger25.h:300
charger25_t
Charger 25 Click context object.
Definition: charger25.h:257
charger25_status_t::ts_cold_stat
uint8_t ts_cold_stat
Definition: charger25.h:320
charger25_cfg_t::qon
pin_name_t qon
Definition: charger25.h:282
charger25_set_current_limit
err_t charger25_set_current_limit(charger25_t *ctx, float current_lim)
Charger 25 set charge current limit function.
charger25_disable
void charger25_disable(charger25_t *ctx)
Charger 25 charge disable function.
charger25_get_current_limit
err_t charger25_get_current_limit(charger25_t *ctx, float *current_lim)
Charger 25 get charge current limit function.
charger25_sw_reset
err_t charger25_sw_reset(charger25_t *ctx)
Charger 25 software reset function.
charger25_status_t::vbus_stat
uint8_t vbus_stat
Definition: charger25.h:306
charger25_cfg_t::i2c_address
uint8_t i2c_address
Definition: charger25.h:287
charger25_t::int_pin
digital_in_t int_pin
Definition: charger25.h:263
charger25_cfg_t::ce
pin_name_t ce
Definition: charger25.h:283
charger25_status_t::ico_stat
uint8_t ico_stat
Definition: charger25.h:308
charger25_get_interrupt
uint8_t charger25_get_interrupt(charger25_t *ctx)
Charger 25 get interrupt function.
charger25_status_t::iindpm_stat
uint8_t iindpm_stat
Definition: charger25.h:297
charger25_adc_func_t
Charger 25 Click ADC function object.
Definition: charger25.h:346
charger25_t::i2c
i2c_master_t i2c
Definition: charger25.h:266
charger25_adc_func_t::vsys_adc_dis
uint8_t vsys_adc_dis
Definition: charger25.h:351
charger25_status_t::dpdm_stat
uint8_t dpdm_stat
Definition: charger25.h:310
charger25_return_value_t
charger25_return_value_t
Charger 25 Click return value data.
Definition: charger25.h:366
charger25_set_cell_count
err_t charger25_set_cell_count(charger25_t *ctx, uint8_t cell_count)
Charger 25 set battery cell count function.
charger25_status_t::vbus_present_stat
uint8_t vbus_present_stat
Definition: charger25.h:304
charger25_get_vsys_min
err_t charger25_get_vsys_min(charger25_t *ctx, float *vsys_min)
Charger 25 get VSYS function.
charger25_enable
void charger25_enable(charger25_t *ctx)
Charger 25 charge enable function.
charger25_get_input_curr_limit
err_t charger25_get_input_curr_limit(charger25_t *ctx, float *input_curr_limit)
Charger 25 get input current limit function.
charger25_get_status
err_t charger25_get_status(charger25_t *ctx, charger25_status_t *status)
Charger 25 get charging status function.
charger25_status_t::bc1_2_done
uint8_t bc1_2_done
Definition: charger25.h:307
charger25_adc_func_t::vbat_adc_dis
uint8_t vbat_adc_dis
Definition: charger25.h:350
charger25_adc_ctrl_t
Charger 25 Click ADC control object.
Definition: charger25.h:332
charger25_status_t::pg_stat
uint8_t pg_stat
Definition: charger25.h:301
charger25_adc_func_t::ts_adc_dis
uint8_t ts_adc_dis
Definition: charger25.h:352
charger25_set_qon_pin
void charger25_set_qon_pin(charger25_t *ctx, uint8_t state)
Charger 25 set QON pin state function.
charger25_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: charger25.h:286
charger25_set_input_curr_limit
err_t charger25_set_input_curr_limit(charger25_t *ctx, float input_curr_limit)
Charger 25 set input current limit function.
charger25_default_cfg
err_t charger25_default_cfg(charger25_t *ctx)
Charger 25 default configuration function.
charger25_t::ce
digital_out_t ce
Definition: charger25.h:260
charger25_adc_func_t::tdie_adc_dis
uint8_t tdie_adc_dis
Definition: charger25.h:353
charger25_adc_func_t::vac1_adc_dis
uint8_t vac1_adc_dis
Definition: charger25.h:357
charger25_adc_func_t::ibat_adc_dis
uint8_t ibat_adc_dis
Definition: charger25.h:348
charger25_t::slave_address
uint8_t slave_address
Definition: charger25.h:269
charger25_adc_ctrl_t::adc_rate
uint8_t adc_rate
Definition: charger25.h:334
charger25_set_input_vtg_limit
err_t charger25_set_input_vtg_limit(charger25_t *ctx, float input_vtg_limit)
Charger 25 set input voltage limit function.
charger25_set_vbat_lim
err_t charger25_set_vbat_lim(charger25_t *ctx, float vtg_lim)
Charger 25 set battery voltage limit function.
charger25_status_t
Charger 25 Click status object.
Definition: charger25.h:296
charger25_status_t::chg_stat
uint8_t chg_stat
Definition: charger25.h:305
charger25_get_cell_count
err_t charger25_get_cell_count(charger25_t *ctx, uint8_t *cell_count)
Charger 25 get battery cell count function.
charger25_status_t::vindpm_stat
uint8_t vindpm_stat
Definition: charger25.h:298
charger25_init
err_t charger25_init(charger25_t *ctx, charger25_cfg_t *cfg)
Charger 25 initialization function.
charger25_adc_ctrl_t::adc_avg
uint8_t adc_avg
Definition: charger25.h:336
charger25_status_t::prechg_tmr_stat
uint8_t prechg_tmr_stat
Definition: charger25.h:318
charger25_generic_read
err_t charger25_generic_read(charger25_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Charger 25 I2C reading function.
charger25_cfg_t::int_pin
pin_name_t int_pin
Definition: charger25.h:284
charger25_status_t::adc_done_stat
uint8_t adc_done_stat
Definition: charger25.h:314
charger25_get_input_vtg_limit
err_t charger25_get_input_vtg_limit(charger25_t *ctx, float *input_vtg_limit)
Charger 25 get input voltage limit function.
charger25_cfg_setup
void charger25_cfg_setup(charger25_cfg_t *cfg)
Charger 25 configuration object setup function.
charger25_status_t::wd_stat
uint8_t wd_stat
Definition: charger25.h:299
charger25_status_t::vsys_stat
uint8_t vsys_stat
Definition: charger25.h:315
CHARGER25_OK
@ CHARGER25_OK
Definition: charger25.h:367
charger25_status_t::ac2_present_stat
uint8_t ac2_present_stat
Definition: charger25.h:302
charger25_status_t::ts_cool_stat
uint8_t ts_cool_stat
Definition: charger25.h:321
charger25_status_t::vbat_present_stat
uint8_t vbat_present_stat
Definition: charger25.h:311
CHARGER25_ERROR
@ CHARGER25_ERROR
Definition: charger25.h:368
charger25_get_vbat_lim
err_t charger25_get_vbat_lim(charger25_t *ctx, float *vtg_lim)
Charger 25 get battery voltage limit function.
charger25_status_t::trichg_tmr_stat
uint8_t trichg_tmr_stat
Definition: charger25.h:317
charger25_status_t::ts_warm_stat
uint8_t ts_warm_stat
Definition: charger25.h:322
charger25_adc_func_t::vac2_adc_dis
uint8_t vac2_adc_dis
Definition: charger25.h:356
charger25_status_t::acrb1_stat
uint8_t acrb1_stat
Definition: charger25.h:313
charger25_cfg_t::sda
pin_name_t sda
Definition: charger25.h:280
charger25_status_t::vbatotg_low_stat
uint8_t vbatotg_low_stat
Definition: charger25.h:319
charger25_adc_func_t::dm_adc_dis
uint8_t dm_adc_dis
Definition: charger25.h:355
charger25_adc_ctrl_t::adc_sample
uint8_t adc_sample
Definition: charger25.h:335
charger25_adc_ctrl_t::adc_en
uint8_t adc_en
Definition: charger25.h:333
charger25_adc_func_t::vbus_adc_dis
uint8_t vbus_adc_dis
Definition: charger25.h:349
charger25_t::qon
digital_out_t qon
Definition: charger25.h:259
charger25_status_t::treg_stat
uint8_t treg_stat
Definition: charger25.h:309