battmon  2.0.0.0
battmon.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
32 // ----------------------------------------------------------------------------
33 
34 #ifndef BATTMON_H
35 #define BATTMON_H
36 
37 #include "drv_digital_out.h"
38 #include "drv_digital_in.h"
39 #include "drv_i2c_master.h"
40 
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define BATTMON_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55  cfg.rio = MIKROBUS( mikrobus, MIKROBUS_RST ); \
56  cfg.alm = MIKROBUS( mikrobus, MIKROBUS_INT )
57 
63 #define BATTMON_RETVAL uint8_t
64 
65 #define BATTMON_OK 0x00
66 #define BATTMON_INIT_ERROR 0xFF
67 
73 #define DUMMY_BYTE 0x00
74 
80 #define BATTMON_DEV_ADDR 0x70
81 
87 #define BATTMON_REG_MODE 0
88 #define BATTMON_REG_CTRL 1
89 #define BATTMON_REG_SOC 2
90 #define BATTMON_REG_COUNTER 4
91 #define BATTMON_REG_CURRENT 6
92 #define BATTMON_REG_VOLTAGE 8
93 #define BATTMON_REG_TEMPERATURE 10
94 #define BATTMON_REG_CC_ADJ_HIGH 11
95 #define BATTMON_REG_VM_ADJ_HIGH 12
96 #define BATTMON_REG_OCV 13
97 #define BATTMON_REG_CC_CNF 15
98 #define BATTMON_REG_VM_CNF 17
99 #define BATTMON_REG_ALARM_SOC 19
100 #define BATTMON_REG_ALARM_VOLTAGE 20
101 #define BATTMON_REG_CURRENT_THRES 21
102 #define BATTMON_REG_RELAX_COUNT 22
103 #define BATTMON_REG_RELAX_MAX 23
104 #define BATTMON_REG_ID 24
105 #define BATTMON_REG_CC_ADJ_LOW 25
106 #define BATTMON_REG_VM_ADJ_LOW 26
107 #define BATTMON_ACC_CC_ADJ 27
108 #define BATTMON_ACC_VM_ADJ 29
109 
115 #define BATTMON_REG_RAM0 32
116 #define BATTMON_REG_RAM1 33
117 #define BATTMON_REG_RAM2 34
118 #define BATTMON_REG_RAM3 35
119 #define BATTMON_REG_RAM4 36
120 #define BATTMON_REG_RAM5 37
121 #define BATTMON_REG_RAM6 38
122 #define BATTMON_REG_RAM7 39
123 #define BATTMON_REG_RAM8 40
124 #define BATTMON_REG_RAM9 41
125 #define BATTMON_REG_RAM10 42
126 #define BATTMON_REG_RAM11 43
127 #define BATTMON_REG_RAM12 44
128 #define BATTMON_REG_RAM13 45
129 #define BATTMON_REG_RAM14 46
130 #define BATTMON_REG_RAM15 47
131 
137 #define BATTMON_REG_OCVTAB0 48
138 #define BATTMON_REG_OCVTAB1 49
139 #define BATTMON_REG_OCVTAB2 50
140 #define BATTMON_REG_OCVTAB3 51
141 #define BATTMON_REG_OCVTAB4 52
142 #define BATTMON_REG_OCVTAB5 53
143 #define BATTMON_REG_OCVTAB6 54
144 #define BATTMON_REG_OCVTAB7 55
145 #define BATTMON_REG_OCVTAB8 56
146 #define BATTMON_REG_OCVTAB9 57
147 #define BATTMON_REG_OCVTAB10 58
148 #define BATTMON_REG_OCVTAB11 59
149 #define BATTMON_REG_OCVTAB12 60
150 #define BATTMON_REG_OCVTAB13 61
151 #define BATTMON_REG_OCVTAB14 62
152 #define BATTMON_REG_OCVTAB15 63
153 
159 #define BATTMON_MIXED_MODE 0x00
160 #define BATTMON_PWR_SAVE_VOLT_MODE 0x01
161 #define BATTMON_CLR_VM_ADJ 0x02
162 #define BATTMON_CLR_CC_ADJ 0x04
163 #define BATTMON_ALM_EN 0x08
164 #define BATTMON_STNDBY_RUN_MODE 0x00
165 #define BATTMON_OP_RUN_MODE 0x10
166 #define BATTMON_FORCE_CC 0x20
167 #define BATTMON_FORCE_VM 0x40
168 
174 #define BATTMON_ALM_PIN_STAT_MASK 0x01
175 #define BATTMON_FORCE_ALM_PIN_LOW 0x00
176 #define BATTMON_DRIVE_ALM_PIN_COND 0x01
177 #define BATTMON_RST_CONV_CNT 0x02
178 #define BATTMON_SOC_STAT_MASK 0x04
179 #define BATTMON_SOC_CC_MODE 0x00
180 #define BATTMON_SOC_VM_MODE 0x04
181 #define BATTMON_BATFAIL_DET_MASK 0x08
182 #define BATTMON_POR_DET_MASK 0x10
183 #define BATTMON_POR_INACTIVE 0x00
184 #define BATTMON_POR_ACTIVE 0x10
185 #define BATTMON_SOFT_RST 0x10
186 #define BATTMON_ALM_SOC_DET_MASK 0x20
187 #define BATTMON_ALM_VOLT_DET_MASK 0x40
188 
194 #define BATTMON_INVALID_ADDR 0xFF
195 #define BATTMON_INVALID_NBYTES 0xFE
196 #define BATTMON_INVALID_ALM_VAL 0xFD
197 #define BATTMON_OK 0x00
198 #define BATTMON_LOG_LOW 0x00
199 #define BATTMON_LOG_HIGH 0x01
200  // End group macro
203 // --------------------------------------------------------------- PUBLIC TYPES
212 typedef struct
213 {
214  // Input pins
215 
216  digital_in_t rio;
217  digital_in_t alm;
218 
219  // Modules
220 
221  i2c_master_t i2c;
222 
223  // ctx variable
224 
225  uint8_t slave_address;
226 
227 } battmon_t;
228 
232 typedef struct
233 {
234  // Communication gpio pins
235 
236  pin_name_t scl;
237  pin_name_t sda;
238 
239  // Additional gpio pins
240 
241  pin_name_t rio;
242  pin_name_t alm;
243 
244  // static variable
245 
246  uint32_t i2c_speed;
247  uint8_t i2c_address;
248 
249 } battmon_cfg_t;
250  // End types group
252 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
253 
259 #ifdef __cplusplus
260 extern "C"{
261 #endif
262 
271 void battmon_cfg_setup ( battmon_cfg_t *cfg );
272 
281 
303 void battmon_default_cfg ( battmon_t *ctx );
304 
315 void battmon_generic_write ( battmon_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
316 
328 void battmon_generic_read ( battmon_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
329 
342 uint8_t battmon_read_bytes ( battmon_t *ctx, uint8_t reg_addr, uint8_t *data_out, uint8_t n_bytes );
343 
355 uint8_t battmon_read_word ( battmon_t *ctx, uint8_t reg_addr, uint16_t *data_out );
356 
368 uint8_t battmon_write_byte ( battmon_t *ctx, uint8_t reg_addr, uint8_t data_in );
369 
381 uint8_t battmon_write_word ( battmon_t *ctx, uint8_t reg_addr, uint16_t data_in );
382 
402 float battmon_get_data ( battmon_t *ctx, uint8_t data_addr );
403 
418 uint8_t battmon_set_alarm ( battmon_t *ctx, uint8_t alarm_addr, float alarm_value );
419 
429 uint8_t battmon_get_rio_pin ( battmon_t *ctx );
430 
442 uint8_t battmon_get_alm_pin ( battmon_t *ctx );
443 
454 uint8_t battmon_check_clear_alarm ( battmon_t *ctx );
455 
463 void battmon_sw_reset ( battmon_t *ctx );
464 
472 void battmon_reset_conv_cnt ( battmon_t *ctx );
473 
474 #ifdef __cplusplus
475 }
476 #endif
477 #endif // _BATTMON_H_
478  // End public_function group
481 
482 // ------------------------------------------------------------------------- END
battmon_read_word
uint8_t battmon_read_word(battmon_t *ctx, uint8_t reg_addr, uint16_t *data_out)
Word Read function.
battmon_sw_reset
void battmon_sw_reset(battmon_t *ctx)
SW Reset function.
battmon_init
BATTMON_RETVAL battmon_init(battmon_t *ctx, battmon_cfg_t *cfg)
Initialization function.
battmon_get_data
float battmon_get_data(battmon_t *ctx, uint8_t data_addr)
Data Get function.
battmon_t::alm
digital_in_t alm
Definition: battmon.h:217
battmon_generic_write
void battmon_generic_write(battmon_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
battmon_reset_conv_cnt
void battmon_reset_conv_cnt(battmon_t *ctx)
Conversion Counter Reset function.
battmon_cfg_t::i2c_address
uint8_t i2c_address
Definition: battmon.h:247
BATTMON_RETVAL
#define BATTMON_RETVAL
Definition: battmon.h:63
battmon_cfg_t
Click configuration structure definition.
Definition: battmon.h:232
battmon_set_alarm
uint8_t battmon_set_alarm(battmon_t *ctx, uint8_t alarm_addr, float alarm_value)
Alarm Set function.
battmon_cfg_t::scl
pin_name_t scl
Definition: battmon.h:236
battmon_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: battmon.h:246
battmon_t::rio
digital_in_t rio
Definition: battmon.h:216
battmon_default_cfg
void battmon_default_cfg(battmon_t *ctx)
Click Default Configuration function.
battmon_write_byte
uint8_t battmon_write_byte(battmon_t *ctx, uint8_t reg_addr, uint8_t data_in)
Byte Write function.
battmon_cfg_t::sda
pin_name_t sda
Definition: battmon.h:237
battmon_write_word
uint8_t battmon_write_word(battmon_t *ctx, uint8_t reg_addr, uint16_t data_in)
Word Write function.
battmon_get_rio_pin
uint8_t battmon_get_rio_pin(battmon_t *ctx)
RIO Pin Get function.
battmon_check_clear_alarm
uint8_t battmon_check_clear_alarm(battmon_t *ctx)
Alarm Check And Clear function.
battmon_cfg_t::alm
pin_name_t alm
Definition: battmon.h:242
battmon_t::i2c
i2c_master_t i2c
Definition: battmon.h:221
battmon_t
Click ctx object definition.
Definition: battmon.h:212
battmon_read_bytes
uint8_t battmon_read_bytes(battmon_t *ctx, uint8_t reg_addr, uint8_t *data_out, uint8_t n_bytes)
Bytes Read function.
battmon_generic_read
void battmon_generic_read(battmon_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
battmon_cfg_setup
void battmon_cfg_setup(battmon_cfg_t *cfg)
Config Object Initialization function.
battmon_cfg_t::rio
pin_name_t rio
Definition: battmon.h:241
battmon_t::slave_address
uint8_t slave_address
Definition: battmon.h:225
battmon_get_alm_pin
uint8_t battmon_get_alm_pin(battmon_t *ctx)
ALM Pin Get function.