battman3  2.0.0.0
battman3.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 BATTMAN3_H
29 #define BATTMAN3_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 BATTMAN3_REG_MANUFACTURE_AND_MODEL_ID 0x00
60 #define BATTMAN3_REG_SILICON_REVSION 0x01
61 #define BATTMAN3_REG_CHARGER_VBUS_ILIM 0x02
62 #define BATTMAN3_REG_CHARGER_TERMINATION_SETTING 0x03
63 #define BATTMAN3_REG_CHARGER_CURRENT_SETTING 0x04
64 #define BATTMAN3_REG_CHARGER_VOLTAGE_THRESHOLD 0x05
65 #define BATTMAN3_REG_CHARGER_TIMER_SETTING 0x06
66 #define BATTMAN3_REG_CHARGER_FUNCTION_SETTING1 0x07
67 #define BATTMAN3_REG_CHARGER_STATUS1 0x08
68 #define BATTMAN3_REG_CHARGER_STATUS2 0x09
69 #define BATTMAN3_REG_CHARGER_FAULT 0x0A
70 #define BATTMAN3_REG_BATTERY_SHORT 0x0B
71 #define BATTMAN3_REG_BATTERY_THERMISTOR_CONTROL 0x0C
72 #define BATTMAN3_REG_V_SOC_0 0x0D
73 #define BATTMAN3_REG_V_SOC_5 0x0E
74 #define BATTMAN3_REG_V_SOC_11 0x0F
75 #define BATTMAN3_REG_V_SOC_19 0x10
76 #define BATTMAN3_REG_V_SOC_28 0x11
77 #define BATTMAN3_REG_V_SOC_41 0x12
78 #define BATTMAN3_REG_V_SOC_55 0x13
79 #define BATTMAN3_REG_V_SOC_69 0x14
80 #define BATTMAN3_REG_V_SOC_84 0x15
81 #define BATTMAN3_REG_V_SOC_100 0x16
82 #define BATTMAN3_REG_FILTER_SETTING1 0x17
83 #define BATTMAN3_REG_FILTER_SETTING2 0x18
84 #define BATTMAN3_REG_RBAT_0 0x19
85 #define BATTMAN3_REG_RBAT_10 0x1A
86 #define BATTMAN3_REG_RBAT_20 0x1B
87 #define BATTMAN3_REG_RBAT_30 0x1C
88 #define BATTMAN3_REG_RBAT_40 0x1D
89 #define BATTMAN3_REG_RBAT_60 0x1E
90 #define BATTMAN3_REG_K_RBAT_CHARGE 0x1F
91 #define BATTMAN3_REG_BAT_TEMP 0x20
92 #define BATTMAN3_REG_BAT_SOC 0x21
93 #define BATTMAN3_REG_VBAT_READ_H 0x22
94 #define BATTMAN3_REG_VBAT_READ_L 0x23
95 #define BATTMAN3_REG_FUEL_GAUGE_MODE 0x24
96 #define BATTMAN3_REG_SOC_RESET 0x25
97 #define BATTMAN3_REG_BST_LED_CTRL 0x26
98 #define BATTMAN3_REG_BST_CFG 0x27
99 #define BATTMAN3_REG_IBL_SET 0x28
100 #define BATTMAN3_REG_ILED2_SET 0x29
101 #define BATTMAN3_REG_ILED3_SET 0x2A
102 #define BATTMAN3_REG_ILED4_SET 0x2B
103 #define BATTMAN3_REG_ILED5_SET 0x2C
104 #define BATTMAN3_REG_BL_FR 0x2D
105 #define BATTMAN3_REG_LED3_BLINK 0x2E
106 #define BATTMAN3_REG_LED4_BLINK 0x2F
107 #define BATTMAN3_REG_LED5_BLINK 0x30
108 #define BATTMAN3_REG_LED_STATUS 0x31
109 #define BATTMAN3_REG_LDO_CTRL 0x32
110 #define BATTMAN3_REG_LDO_CFG 0x33
111 #define BATTMAN3_REG_VID_LDO12 0x34
112 #define BATTMAN3_REG_VID_LDO3 0x35
113 #define BATTMAN3_REG_PGOOD_STATUS 0x36
114 #define BATTMAN3_REG_PGOOD_MASK 0x37
115 #define BATTMAN3_REG_CHARGER_INTERRUPT_ENABLE 0x38
116 #define BATTMAN3_REG_CHARGER_INTERRUPT_FLAG 0x39
117 #define BATTMAN3_REG_BOOST_LDO_INTERRUPT_ENABLE 0x3A
118 #define BATTMAN3_REG_BOOST_LDO_INTERRUPT_FLAG 0x3B
119 #define BATTMAN3_REG_DEFAULT_SET 0x3C
120 #define BATTMAN3_REG_NTC47K_SET 0x3D
121 
122 
123  // battman3_reg
125 
140 #define BATTMAN3_CHARGE_STATUS1_OFF 0x0
141 #define BATTMAN3_CHARGE_STATUS1_TRICLE_CHARGE 0x1
142 #define BATTMAN3_CHARGE_STATUS1_FAST_CHARGE_CC 0x2
143 #define BATTMAN3_CHARGE_STATUS1_FAST_CHARGE_CV 0x3
144 #define BATTMAN3_CHARGE_STATUS1_CHARGE_COMPLETE 0x4
145 #define BATTMAN3_CHARGE_STATUS1_SUSPEND 0x5
146 #define BATTMAN3_CHARGE_STATUS1_TIMER_EXPIRED 0x6
147 #define BATTMAN3_CHARGE_STATUS1_BATTERY_DETECTION 0x7
148 #define BATTMAN3_CHARGE_STATUS2_BATTERY_MONITOR_OFF 0x0
149 #define BATTMAN3_CHARGE_STATUS2_NO_BATTERY 0x1
150 #define BATTMAN3_CHARGE_STATUS2_VBSNS_LESSTHEN_VTRK 0x2
151 #define BATTMAN3_CHARGE_STATUS2_VBSNS_MIDDLE_VRK_VWEAK 0x3
152 #define BATTMAN3_CHARGE_STATUS2_VBSNS_MORETHEN_VWEAK 0x4
153 
158 #define BATTMAN3_ENABLE 0x1
159 #define BATTMAN3_DISABLE 0x0
160 
166 #define BATTMAN3_SET_DEV_ADDR 0x44
167  // battman3_set
169 
184 #define BATTMAN3_MAP_MIKROBUS( cfg, mikrobus ) \
185  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
186  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
187  cfg.pgood = MIKROBUS( mikrobus, MIKROBUS_CS ); \
188  cfg.bok = MIKROBUS( mikrobus, MIKROBUS_RST ); \
189  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
190  // battman3_map // battman3
193 
198 typedef struct
199 {
200  // Input pins
201  digital_in_t pgood;
202  digital_in_t bok;
203  digital_in_t int_pin;
205  // Modules
206  i2c_master_t i2c;
208  // I2C slave address
209  uint8_t slave_address;
211 } battman3_t;
212 
217 typedef struct
218 {
219  pin_name_t scl;
220  pin_name_t sda;
222  pin_name_t pgood;
223  pin_name_t bok;
224  pin_name_t int_pin;
226  uint32_t i2c_speed;
227  uint8_t i2c_address;
230 
235 typedef enum
236 {
238  BATTMAN3_ERROR = -1
239 
241 
246 typedef enum
247 {
264 
266 
271 typedef enum
272 {
276 
278 
283 typedef enum
284 {
289 
291 
308 
323 
338 
352 err_t battman3_generic_write ( battman3_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
353 
365 err_t battman3_reg_write ( battman3_t *ctx, uint8_t reg, uint8_t tx_data );
366 
380 err_t battman3_generic_read ( battman3_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
381 
393 err_t battman3_reg_read ( battman3_t *ctx, uint8_t reg, uint8_t *rx_data );
394 
403 
412 
421 
434 err_t battman3_set_charge_state ( battman3_t *ctx, uint8_t enable );
435 
447 
460 
471 err_t battman3_set_charge_vbus_current_limit ( battman3_t *ctx, uint16_t current );
472 
485 err_t battman3_set_ldo_state ( battman3_t *ctx, battman3_ldo_t ldo, uint8_t enable );
486 
499 
510 err_t battman3_get_battery_voltage ( battman3_t *ctx, float *vout );
511 
512 #ifdef __cplusplus
513 }
514 #endif
515 #endif // BATTMAN3_H
516  // battman3
518 
519 // ------------------------------------------------------------------------ END
BATTMAN3_LDO_3p00V
@ BATTMAN3_LDO_3p00V
Definition: battman3.h:252
BATTMAN3_LDO_1p20V
@ BATTMAN3_LDO_1p20V
Definition: battman3.h:261
BATTMAN3_LDO_3p60V
@ BATTMAN3_LDO_3p60V
Definition: battman3.h:249
battman3_cfg_t::sda
pin_name_t sda
Definition: battman3.h:220
battman3_cfg_t::pgood
pin_name_t pgood
Definition: battman3.h:222
BATTMAN3_OK
@ BATTMAN3_OK
Definition: battman3.h:237
battman3_ldo_vout_t
battman3_ldo_vout_t
BATT-MAN 3 Click LDO voltage output.
Definition: battman3.h:247
battman3_cfg_setup
void battman3_cfg_setup(battman3_cfg_t *cfg)
BATT-MAN 3 configuration object setup function.
BATTMAN3_VTRK_DEAD_3p3V
@ BATTMAN3_VTRK_DEAD_3p3V
Definition: battman3.h:288
BATTMAN3_LDO_1p10V
@ BATTMAN3_LDO_1p10V
Definition: battman3.h:262
battman3_cfg_t::bok
pin_name_t bok
Definition: battman3.h:223
battman3_default_cfg
err_t battman3_default_cfg(battman3_t *ctx)
BATT-MAN 3 default configuration function.
battman3_cfg_t::scl
pin_name_t scl
Definition: battman3.h:219
battman3_get_power_good
uint8_t battman3_get_power_good(battman3_t *ctx)
Get power good.
BATTMAN3_LDO_2p30V
@ BATTMAN3_LDO_2p30V
Definition: battman3.h:255
battman3_set_charge_state
err_t battman3_set_charge_state(battman3_t *ctx, uint8_t enable)
Enable/Disable charging.
BATTMAN3_LDO_3p30V
@ BATTMAN3_LDO_3p30V
Definition: battman3.h:250
battman3_init
err_t battman3_init(battman3_t *ctx, battman3_cfg_t *cfg)
BATT-MAN 3 initialization function.
BATTMAN3_LDO_3p15V
@ BATTMAN3_LDO_3p15V
Definition: battman3.h:251
battman3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: battman3.h:226
battman3_cfg_t::i2c_address
uint8_t i2c_address
Definition: battman3.h:227
battman3_set_ldo_state
err_t battman3_set_ldo_state(battman3_t *ctx, battman3_ldo_t ldo, uint8_t enable)
Enable/Disable LDO.
BATTMAN3_LDO_1p50V
@ BATTMAN3_LDO_1p50V
Definition: battman3.h:258
battman3_set_charge_vbus_current_limit
err_t battman3_set_charge_vbus_current_limit(battman3_t *ctx, uint16_t current)
Set charge current limit.
BATTMAN3_LDO_1p40V
@ BATTMAN3_LDO_1p40V
Definition: battman3.h:259
BATTMAN3_LDO_1p00V
@ BATTMAN3_LDO_1p00V
Definition: battman3.h:263
battman3_reg_read
err_t battman3_reg_read(battman3_t *ctx, uint8_t reg, uint8_t *rx_data)
Register reading function.
BATTMAN3_ERROR
@ BATTMAN3_ERROR
Definition: battman3.h:238
battman3_set_ldo_vout
err_t battman3_set_ldo_vout(battman3_t *ctx, battman3_ldo_t ldo, battman3_ldo_vout_t vout)
Set voltage output on LDO.
battman3_cfg_t::int_pin
pin_name_t int_pin
Definition: battman3.h:224
BATTMAN3_LDO_2p10V
@ BATTMAN3_LDO_2p10V
Definition: battman3.h:256
battman3_t
BATT-MAN 3 Click context object.
Definition: battman3.h:199
battman3_generic_read
err_t battman3_generic_read(battman3_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
BATT-MAN 3 I2C reading function.
BATTMAN3_LDO_1p30V
@ BATTMAN3_LDO_1p30V
Definition: battman3.h:260
battman3_get_interrupt
uint8_t battman3_get_interrupt(battman3_t *ctx)
Get interrupt.
BATTMAN3_LDO1
@ BATTMAN3_LDO1
Definition: battman3.h:273
battman3_generic_write
err_t battman3_generic_write(battman3_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
BATT-MAN 3 I2C writing function.
battman3_reg_write
err_t battman3_reg_write(battman3_t *ctx, uint8_t reg, uint8_t tx_data)
Register writing function.
battman3_t::bok
digital_in_t bok
Definition: battman3.h:202
battman3_get_battery_ok
uint8_t battman3_get_battery_ok(battman3_t *ctx)
Get battery OK.
BATTMAN3_LDO_2p50V
@ BATTMAN3_LDO_2p50V
Definition: battman3.h:254
battman3_t::i2c
i2c_master_t i2c
Definition: battman3.h:206
battman3_t::pgood
digital_in_t pgood
Definition: battman3.h:201
battman3_set_charge_termination_voltage
err_t battman3_set_charge_termination_voltage(battman3_t *ctx, float voltage)
Set charge termination voltage.
BATTMAN3_VTRK_DEAD_2p6V
@ BATTMAN3_VTRK_DEAD_2p6V
Definition: battman3.h:287
battman3_set_charge_voltage_threshold
err_t battman3_set_charge_voltage_threshold(battman3_t *ctx, battman3_vtrk_dead_t vtrk_dead, float vweak)
Set charge termination voltage.
battman3_t::int_pin
digital_in_t int_pin
Definition: battman3.h:203
BATTMAN3_LDO2
@ BATTMAN3_LDO2
Definition: battman3.h:274
battman3_ldo_t
battman3_ldo_t
BATT-MAN 3 Click LDO.
Definition: battman3.h:272
battman3_return_value_t
battman3_return_value_t
BATT-MAN 3 Click return value data.
Definition: battman3.h:236
BATTMAN3_LDO3
@ BATTMAN3_LDO3
Definition: battman3.h:275
BATTMAN3_VTRK_DEAD_2p5V
@ BATTMAN3_VTRK_DEAD_2p5V
Definition: battman3.h:286
BATTMAN3_LDO_4p20V
@ BATTMAN3_LDO_4p20V
Definition: battman3.h:248
battman3_get_battery_voltage
err_t battman3_get_battery_voltage(battman3_t *ctx, float *vout)
Read battery voltage level.
battman3_cfg_t
BATT-MAN 3 Click configuration object.
Definition: battman3.h:218
battman3_t::slave_address
uint8_t slave_address
Definition: battman3.h:209
BATTMAN3_LDO_2p85V
@ BATTMAN3_LDO_2p85V
Definition: battman3.h:253
BATTMAN3_VTRK_DEAD_2p4V
@ BATTMAN3_VTRK_DEAD_2p4V
Definition: battman3.h:285
BATTMAN3_LDO_1p80V
@ BATTMAN3_LDO_1p80V
Definition: battman3.h:257
battman3_vtrk_dead_t
battman3_vtrk_dead_t
BATT-MAN 3 Click dead battery voltage.
Definition: battman3.h:284