charger2  2.0.0.0
charger2.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  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef CHARGER2_H
36 #define CHARGER2_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_i2c_master.h"
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define CHARGER2_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
69 
75 #define CHARGER2_RETVAL uint8_t
76 
77 #define CHARGER2_OK 0x00
78 #define CHARGER2_INIT_ERROR 0xFF
79 
85 #define R_SHUNT 0.05
86 
92 #define CHARGER2_REG_MODE 0x00
93 #define CHARGER2_REG_CONTROL 0x01
94 #define CHARGER2_REG_CHARGE_LOW 0x02
95 #define CHARGER2_REG_CHARGE_HIGH 0x03
96 #define CHARGER2_REG_COUNTER_LOW 0x04
97 #define CHARGER2_REG_COUNTER_HIGH 0x05
98 #define CHARGER2_REG_CURRENT_LOW 0x06
99 #define CHARGER2_REG_CURRENT_HIGH 0x07
100 #define CHARGER2_REG_VOLTAGE_LOW 0x08
101 #define CHARGER2_REG_VOLTAGE_HIGH 0x09
102 #define CHARGER2_REG_TEMPERATURE_LOW 0x0A
103 #define CHARGER2_REG_TEMPERATURE_HIGH 0x0B
104 #define CHARGER2_REG_ID0 0x18
105 #define CHARGER2_REG_ID1 0x19
106 #define CHARGER2_REG_ID2 0x1A
107 #define CHARGER2_REG_ID3 0x1B
108 #define CHARGER2_REG_ID4 0x1C
109 #define CHARGER2_REG_ID5 0x1D
110 #define CHARGER2_REG_ID6 0x1E
111 #define CHARGER2_REG_ID7 0x1F
112 #define CHARGER2_REG_RAM0 0x20
113 #define CHARGER2_REG_RAM1 0x21
114 #define CHARGER2_REG_RAM2 0x22
115 #define CHARGER2_REG_RAM3 0x23
116 #define CHARGER2_REG_RAM4 0x24
117 #define CHARGER2_REG_RAM5 0x25
118 #define CHARGER2_REG_RAM6 0x26
119 #define CHARGER2_REG_RAM7 0x27
120 #define CHARGER2_REG_RAM8 0x28
121 #define CHARGER2_REG_RAM9 0x29
122 #define CHARGER2_REG_RAM10 0x2A
123 #define CHARGER2_REG_RAM11 0x2B
124 #define CHARGER2_REG_RAM12 0x2C
125 #define CHARGER2_REG_RAM13 0x2D
126 #define CHARGER2_REG_RAM14 0x2E
127 #define CHARGER2_REG_RAM15 0x2F
128 #define CHARGER2_REG_RAM16 0x30
129 #define CHARGER2_REG_RAM17 0x31
130 #define CHARGER2_REG_RAM18 0x32
131 #define CHARGER2_REG_RAM19 0x33
132 #define CHARGER2_REG_RAM20 0x34
133 #define CHARGER2_REG_RAM21 0x35
134 #define CHARGER2_REG_RAM22 0x36
135 #define CHARGER2_REG_RAM23 0x37
136 #define CHARGER2_REG_RAM24 0x38
137 #define CHARGER2_REG_RAM25 0x39
138 #define CHARGER2_REG_RAM26 0x3A
139 #define CHARGER2_REG_RAM27 0x3B
140 #define CHARGER2_REG_RAM28 0x3C
141 #define CHARGER2_REG_RAM29 0x3D
142 #define CHARGER2_REG_RAM30 0x3E
143 #define CHARGER2_REG_RAM31 0x3F
144 
150 #define CHARGER2_AUTO_DETECT 0x00
151 #define CHARGER2_EXTERNAL_CLOCK 0x01
152 #define CHARGER2_14_BITS_RESOLUTION 0x00
153 #define CHARGER2_13_BITS_RESOLUTION 0x02
154 #define CHARGER2_12_BITS_RESOLUTION 0x04
155 #define CHARGER2_CALIBRATE_ADC 0x08
156 #define CHARGER2_STANDBY_MODE 0x00
157 #define CHARGER2_OPERATING_MODE 0x10
158 
164 #define CHARGER2_IO0_OUTPUT_LOW 0x00
165 #define CHARGER2_IO0_OUTPUT_OPEN 0x01
166 #define CHARGER2_RESET_CHARGE_ACCUM_AND_COUNTER 0x02
167 #define CHARGER2_RELEASE_SOFT_RESET 0x00
168 #define CHARGER2_ASSERT_SOFT_RESET 0x10
169 
175 #define CHARGER2_RESET_COUNTER_MODE 0x00
176 #define CHARGER2_SOFT_RESET_MODE 0x01
177 #define CHARGER2_CURRENT_CYCLE_CHECK 0x00
178 #define CHARGER2_VOLTAGE_TEMP_CYCLE_CHECK 0x01
179 #define CHARGER2_GAS_GAUGE_CHARGE_DATA 0x00
180 #define CHARGER2_CONV_NUMBER 0x01
181 #define CHARGER2_SHUNT_VOLTAGE 0x02
182 #define CHARGER2_BATTERY_VOLTAGE 0x03
183 #define CHARGER2_TEMPERATURE 0x04
184 #define CHARGER2_BATTERY_CURRENT 0x05
185  // End group macro
188 // --------------------------------------------------------------- PUBLIC TYPES
197 typedef struct
198 {
199  // Modules
200 
201  i2c_master_t i2c;
202 
203  // ctx variable
204 
205  uint8_t slave_address;
206 
207  uint8_t unit_mode;
208 
209 } charger2_t;
210 
214 typedef struct
215 {
216  // Communication gpio pins
217 
218  pin_name_t scl;
219  pin_name_t sda;
220 
221  // static variable
222 
223  uint32_t i2c_speed;
224  uint8_t i2c_address;
225 
227  // End types group
229 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
230 
236 #ifdef __cplusplus
237 extern "C"{
238 #endif
239 
249 
258 
269 void charger2_generic_write ( charger2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
270 
281 void charger2_generic_read ( charger2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
282 
292 uint8_t charger2_write_reg ( charger2_t *ctx, uint8_t register_address, uint8_t transfer_data );
293 
304 uint8_t charger2_read_reg ( charger2_t *ctx, uint8_t register_address, uint8_t *value_out, uint8_t n_bytes );
305 
315 uint8_t charger2_read_data ( charger2_t *ctx, uint8_t data_mode, uint32_t *data_out );
316 
325 uint8_t charger2_reset ( charger2_t *ctx, uint8_t reset_mode );
326 
336 uint8_t charger2_check_conv_cycle( charger2_t *ctx, uint8_t conv_mode );
337 
338 #ifdef __cplusplus
339 }
340 #endif
341 #endif // _CHARGER2_H_
342  // End public_function group
345 
346 // ------------------------------------------------------------------------- END
charger2_read_reg
uint8_t charger2_read_reg(charger2_t *ctx, uint8_t register_address, uint8_t *value_out, uint8_t n_bytes)
Read reg function.
charger2_read_data
uint8_t charger2_read_data(charger2_t *ctx, uint8_t data_mode, uint32_t *data_out)
Data Read function.
charger2_cfg_t
Click configuration structure definition.
Definition: charger2.h:215
charger2_cfg_t::scl
pin_name_t scl
Definition: charger2.h:218
charger2_cfg_t::i2c_address
uint8_t i2c_address
Definition: charger2.h:224
charger2_generic_read
void charger2_generic_read(charger2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
charger2_generic_write
void charger2_generic_write(charger2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
charger2_t::i2c
i2c_master_t i2c
Definition: charger2.h:201
charger2_write_reg
uint8_t charger2_write_reg(charger2_t *ctx, uint8_t register_address, uint8_t transfer_data)
Write reg function.
charger2_t::unit_mode
uint8_t unit_mode
Definition: charger2.h:207
charger2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: charger2.h:223
charger2_check_conv_cycle
uint8_t charger2_check_conv_cycle(charger2_t *ctx, uint8_t conv_mode)
Conversion Cycle Check function.
charger2_cfg_t::sda
pin_name_t sda
Definition: charger2.h:219
charger2_t::slave_address
uint8_t slave_address
Definition: charger2.h:205
charger2_t
Click ctx object definition.
Definition: charger2.h:198
charger2_init
CHARGER2_RETVAL charger2_init(charger2_t *ctx, charger2_cfg_t *cfg)
Initialization function.
charger2_reset
uint8_t charger2_reset(charger2_t *ctx, uint8_t reset_mode)
Reset function.
CHARGER2_RETVAL
#define CHARGER2_RETVAL
Definition: charger2.h:75
charger2_cfg_setup
void charger2_cfg_setup(charger2_cfg_t *cfg)
Config Object Initialization function.