vcpmonitor  2.0.0.0
vcpmonitor.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 VCPMONITOR_H
36 #define VCPMONITOR_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 VCPMONITOR_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
69  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
70 
76 #define VCPMONITOR_RETVAL uint8_t
77 
78 #define VCPMONITOR_OK 0x00
79 #define VCPMONITOR_INIT_ERROR 0xFF
80 
86 #define VCPMONITOR_REG_CONFIGURATION 0x00
87 #define VCPMONITOR_REG_CURRENT_DATA 0x01
88 #define VCPMONITOR_REG_BUS_VOLTAGE_DATA 0x02
89 #define VCPMONITOR_REG_POWER_DATA 0x03
90 #define VCPMONITOR_REG_MASK_ENABLE 0x06
91 #define VCPMONITOR_REG_ALERT_LIMIT 0x07
92 #define VCPMONITOR_REG_MANUFACTURE_ID 0xFE
93 #define VCPMONITOR_REG_DIE_ID 0xFF
94 
100 #define VCPMONITOR_SLAVE_ADDR_GND_GND 0x40
101 #define VCPMONITOR_SLAVE_ADDR_GND_VS 0x41
102 #define VCPMONITOR_SLAVE_ADDR_GND_SDA 0x42
103 #define VCPMONITOR_SLAVE_ADDR_GND_SCL 0x43
104 #define VCPMONITOR_SLAVE_ADDR_VS_GND 0x44
105 #define VCPMONITOR_SLAVE_ADDR_VS_VS 0x45
106 #define VCPMONITOR_SLAVE_ADDR_VS_SDA 0x46
107 #define VCPMONITOR_SLAVE_ADDR_VS_SCL 0x47
108 #define VCPMONITOR_SLAVE_ADDR_SDA_GND 0x48
109 #define VCPMONITOR_SLAVE_ADDR_SDA_VS 0x49
110 #define VCPMONITOR_SLAVE_ADDR_SDA_SDA 0x4A
111 #define VCPMONITOR_SLAVE_ADDR_SDA_SCL 0x4B
112 #define VCPMONITOR_SLAVE_ADDR_SCL_GND 0x4C
113 #define VCPMONITOR_SLAVE_ADDR_SCL_VS 0x4D
114 #define VCPMONITOR_SLAVE_ADDR_SCL_SDA 0x4E
115 #define VCPMONITOR_SLAVE_ADDR_SCL_SCL 0x4F
116 
122 #define VCPMONITOR_DEF_MANUFACTURE_ID 0x5449
123 #define VCPMONITOR_DEF_DIE_ID 0x2270
124 #define VCPMONITOR_DEF_CONFIGURATION 0x6127
125 
132 #define VCPMONITOR_CFG_RESET_ON 0x8000
133 #define VCPMONITOR_CFG_RESET_OFF 0x0000
134 #define VCPMONITOR_CFG_NUM_OF_AVG_1 0x0000
135 #define VCPMONITOR_CFG_NUM_OF_AVG_4 0x0200
136 #define VCPMONITOR_CFG_NUM_OF_AVG_16 0x0400
137 #define VCPMONITOR_CFG_NUM_OF_AVG_64 0x0600
138 #define VCPMONITOR_CFG_NUM_OF_AVG_128 0x0800
139 #define VCPMONITOR_CFG_NUM_OF_AVG_256 0x0A00
140 #define VCPMONITOR_CFG_NUM_OF_AVG_512 0x0C00
141 #define VCPMONITOR_CFG_NUM_OF_AVG_1024 0x0E00
142 #define VCPMONITOR_CFG_VBUSCT_140us 0x0000
143 #define VCPMONITOR_CFG_VBUSCT_204us 0x0040
144 #define VCPMONITOR_CFG_VBUSCT_332us 0x0080
145 #define VCPMONITOR_CFG_VBUSCT_588us 0x00C0
146 #define VCPMONITOR_CFG_VBUSCT_1p1ms 0x0100
147 #define VCPMONITOR_CFG_VBUSCT_2p116ms 0x0140
148 #define VCPMONITOR_CFG_VBUSCT_4p156ms 0x0180
149 #define VCPMONITOR_CFG_VBUSCT_8p244ms 0x01C0
150 #define VCPMONITOR_CFG_ISHCT_140us 0x0000
151 #define VCPMONITOR_CFG_ISHCT_204us 0x0008
152 #define VCPMONITOR_CFG_ISHCT_332us 0x0010
153 #define VCPMONITOR_CFG_ISHCT_588us 0x0018
154 #define VCPMONITOR_CFG_ISHCT_1p1ms 0x0020
155 #define VCPMONITOR_CFG_ISHCT_2p116ms 0x0028
156 #define VCPMONITOR_CFG_ISHCT_4p156ms 0x0030
157 #define VCPMONITOR_CFG_ISHCT_8p244ms 0x0038
158 #define VCPMONITOR_CFG_MODE_POWER_DOWN 0x0000
159 #define VCPMONITOR_CFG_MODE_CURRENT_TRIG 0x0001
160 #define VCPMONITOR_CFG_MODE_VOLTAGE_TRIG 0x0002
161 #define VCPMONITOR_CFG_MODE_CURR_VOLT_TRIG 0x0003
162 #define VCPMONITOR_CFG_MODE_CURRENT_CONT 0x0005
163 #define VCPMONITOR_CFG_MODE_VOLTAGE_CONT 0x0006
164 #define VCPMONITOR_CFG_MODE_CURR_VOLT_CONT 0x0007
165 
172 #define CURRENT_CONSTANT 1.25
173 #define VOLTAGE_CONSTANT 1.25
174 #define POWER_CONSTANT 10
175 
181 // Mask Enable register
182 #define VCPMONITOR_MASK_OCL_DISABLE 0x0000
183 #define VCPMONITOR_MASK_UCL_ENABLE 0x4000
184 #define VCPMONITOR_MASK_UCL_DISABLE 0x0000
185 #define VCPMONITOR_MASK_BOL_ENABLE 0x2000
186 #define VCPMONITOR_MASK_BOL_DISABLE 0x0000
187 #define VCPMONITOR_MASK_BUL_ENABLE 0x1000
188 #define VCPMONITOR_MASK_OCL_ENABLE 0x8000
189 #define VCPMONITOR_MASK_BUL_DISABLE 0x0000
190 #define VCPMONITOR_MASK_POL_ENABLE 0x0800
191 #define VCPMONITOR_MASK_POL_DISABLE 0x0000
192 #define VCPMONITOR_MASK_CNVR_ENABLE 0x0400
193 #define VCPMONITOR_MASK_CNVR_DISABLE 0x0000
194 #define VCPMONITOR_MASK_AFF_ENABLE 0x0010
195 #define VCPMONITOR_MASK_AFF_DISABLE 0x0000
196 #define VCPMONITOR_MASK_CVRF_ENABLE 0x0008
197 #define VCPMONITOR_MASK_CVRF_DISABLE 0x0000
198 #define VCPMONITOR_MASK_OVF_ENABLE 0x0004
199 #define VCPMONITOR_MASK_OVF_DISABLE 0x0000
200 #define VCPMONITOR_MASK_APOL_ENABLE 0x0002
201 #define VCPMONITOR_MASK_APOL_DISABLE 0x0000
202 #define VCPMONITOR_MASK_LEN_ENABLE 0x0001
203 #define VCPMONITOR_MASK_LEN_DISABLE 0x0000
204  // End group macro
207 // --------------------------------------------------------------- PUBLIC TYPES
216 typedef struct
217 {
218  // Input pins
219 
220  digital_in_t int_pin;
221 
222  // Modules
223 
224  i2c_master_t i2c;
225 
226  // ctx variable
227 
228  uint8_t slave_address;
229 
230 } vcpmonitor_t;
231 
235 typedef struct
236 {
237  // Communication gpio pins
238 
239  pin_name_t scl;
240  pin_name_t sda;
241 
242  // Additional gpio pins
243 
244  pin_name_t int_pin;
245 
246  // static variable
247 
248  uint32_t i2c_speed;
249  uint8_t i2c_address;
250 
252  // End types group
254 
255 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
256 
262 #ifdef __cplusplus
263 extern "C"{
264 #endif
265 
275 
285 
294 
305 void vcpmonitor_generic_write ( vcpmonitor_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
306 
317 void vcpmonitor_generic_read ( vcpmonitor_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
318 
328 void vcpmonitor_write_data ( vcpmonitor_t *ctx, uint8_t reg, uint16_t tx_data );
329 
339 int16_t vcpmonitor_read_data ( vcpmonitor_t *ctx, uint8_t reg_addr );
340 
351 
362 
373 
384 
396 uint8_t vcpmonitor_get_id_value ( vcpmonitor_t *ctx, uint16_t *manufacture_id, uint16_t* did_id );
397 
398 
399 #ifdef __cplusplus
400 }
401 #endif
402 #endif // _VCPMONITOR_H_
403  // End public_function group
406 
407 // ------------------------------------------------------------------------- END
vcpmonitor_get_voltage
float vcpmonitor_get_voltage(vcpmonitor_t *ctx)
Reads voltage data in mV.
vcpmonitor_get_current
float vcpmonitor_get_current(vcpmonitor_t *ctx)
Reads current data in mA.
vcpmonitor_init
VCPMONITOR_RETVAL vcpmonitor_init(vcpmonitor_t *ctx, vcpmonitor_cfg_t *cfg)
Initialization function.
VCPMONITOR_RETVAL
#define VCPMONITOR_RETVAL
Definition: vcpmonitor.h:76
vcpmonitor_get_power
float vcpmonitor_get_power(vcpmonitor_t *ctx)
Reads power data in mW.
vcpmonitor_t::i2c
i2c_master_t i2c
Definition: vcpmonitor.h:224
vcpmonitor_write_data
void vcpmonitor_write_data(vcpmonitor_t *ctx, uint8_t reg, uint16_t tx_data)
Writes data to register.
vcpmonitor_get_id_value
uint8_t vcpmonitor_get_id_value(vcpmonitor_t *ctx, uint16_t *manufacture_id, uint16_t *did_id)
Gets Manufacture ID and Device ID.
vcpmonitor_cfg_setup
void vcpmonitor_cfg_setup(vcpmonitor_cfg_t *cfg)
Config Object Initialization function.
vcpmonitor_generic_write
void vcpmonitor_generic_write(vcpmonitor_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
vcpmonitor_cfg_t
Click configuration structure definition.
Definition: vcpmonitor.h:236
vcpmonitor_get_interrupt_state
uint8_t vcpmonitor_get_interrupt_state(vcpmonitor_t *ctx)
Gets Interrupt pin state.
vcpmonitor_cfg_t::int_pin
pin_name_t int_pin
Definition: vcpmonitor.h:244
vcpmonitor_t
Click ctx object definition.
Definition: vcpmonitor.h:217
vcpmonitor_cfg_t::sda
pin_name_t sda
Definition: vcpmonitor.h:240
vcpmonitor_t::int_pin
digital_in_t int_pin
Definition: vcpmonitor.h:220
vcpmonitor_t::slave_address
uint8_t slave_address
Definition: vcpmonitor.h:228
vcpmonitor_cfg_t::i2c_address
uint8_t i2c_address
Definition: vcpmonitor.h:249
vcpmonitor_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: vcpmonitor.h:248
vcpmonitor_cfg_t::scl
pin_name_t scl
Definition: vcpmonitor.h:239
vcpmonitor_read_data
int16_t vcpmonitor_read_data(vcpmonitor_t *ctx, uint8_t reg_addr)
Reads data from register.
vcpmonitor_default_cfg
void vcpmonitor_default_cfg(vcpmonitor_t *ctx)
Click Default Configuration function.
vcpmonitor_generic_read
void vcpmonitor_generic_read(vcpmonitor_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.