buck6  2.0.0.0
buck6.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 BUCK6_H
36 #define BUCK6_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 
57 // -------------------------------------------------------------- PUBLIC MACROS
67 #define BUCK6_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
69  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
70  cfg.en = MIKROBUS( mikrobus, MIKROBUS_AN ); \
71  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
72  cfg.syn = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
73 
74 
80 #define BUCK6_RETVAL uint8_t
81 
82 #define BUCK6_OK 0x00
83 #define BUCK6_INIT_ERROR 0xFF
84 
90 #define BUCK6_MAX_RANGE_1000mV 0xFA
91 #define BUCK6_MAX_RANGE_1500mV 0xF4
92 #define BUCK6_MAX_RANGE_2000mV 0xF1
93 #define BUCK6_MAX_RANGE_2500mV 0xEE
94 #define BUCK6_MAX_RANGE_3000mV 0xEA
95 #define BUCK6_MAX_RANGE_3500mV 0xE7
96 #define BUCK6_MAX_RANGE_4000mV 0xE4
97 #define BUCK6_MAX_RANGE_4500mV 0xE1
98 #define BUCK6_MAX_RANGE_5000mV 0xDE
99 #define BUCK6_MAX_RANGE_5500mV 0xDB
100 
101 #define BUCK6_MAX_RANGE_6000mV 0xD8
102 #define BUCK6_MAX_RANGE_6500mV 0xD4
103 #define BUCK6_MAX_RANGE_7000mV 0xD1
104 #define BUCK6_MAX_RANGE_7500mV 0xCF
105 #define BUCK6_MAX_RANGE_8000mV 0xCB
106 #define BUCK6_MAX_RANGE_8500mV 0xC8
107 #define BUCK6_MAX_RANGE_9000mV 0xC5
108 #define BUCK6_MAX_RANGE_9500mV 0xC2
109 #define BUCK6_MAX_RANGE_10000mV 0xBF
110 #define BUCK6_MAX_RANGE_10500mV 0xBC
111 #define BUCK6_MAX_RANGE_11000mV 0xB9
112 #define BUCK6_MAX_RANGE_11500mV 0xB6
113 #define BUCK6_MAX_RANGE_12000mV 0xB2
114 #define BUCK6_MAX_RANGE_12500mV 0xAF
115 
116 #define BUCK6_MAX_RANGE_13000mV 0xAB
117 #define BUCK6_MAX_RANGE_13500mV 0xA9
118 #define BUCK6_MAX_RANGE_14000mV 0xA6
119 #define BUCK6_MAX_RANGE_14500mV 0xA3
120 #define BUCK6_MAX_RANGE_15000mV 0xA0
121 #define BUCK6_MAX_RANGE_15500mV 0x9C
122 #define BUCK6_MAX_RANGE_16000mV 0x99
123 #define BUCK6_MAX_RANGE_16500mV 0x96
124 #define BUCK6_MAX_RANGE_17000mV 0x93
125 #define BUCK6_MAX_RANGE_17500mV 0x90
126 #define BUCK6_MAX_RANGE_18000mV 0x8D
127 #define BUCK6_MAX_RANGE_18500mV 0x8A
128 #define BUCK6_MAX_RANGE_19000mV 0x87
129 #define BUCK6_MAX_RANGE_19500mV 0x84
130 #define BUCK6_MAX_RANGE_20000mV 0x80
131 
137 #define BUCK6_SLEEP_MODE 0x00
138 
144 #define BUCK6_ACTIVE_MODE 0x01
145  // End group macro
148 // --------------------------------------------------------------- PUBLIC TYPES
157 typedef struct
158 {
159  // Output pins
160 
161  digital_out_t en;
162  digital_out_t syn;
163 
164  // Input pins
165 
166  digital_in_t rst;
167 
168  // Modules
169 
170  i2c_master_t i2c;
171 
172  // ctx variable
173 
174  uint8_t slave_address;
175 
176 } buck6_t;
177 
181 typedef struct
182 {
183  // Communication gpio pins
184 
185  pin_name_t scl;
186  pin_name_t sda;
187 
188  // Additional gpio pins
189 
190  pin_name_t en;
191  pin_name_t rst;
192  pin_name_t syn;
193 
194  // static variable
195 
196  uint32_t i2c_speed;
197  uint8_t i2c_address;
198 
199 } buck6_cfg_t;
200  // End types group
202 
203 
209 #ifdef __cplusplus
210 extern "C"{
211 #endif
212 
222 
231 
242 void buck6_generic_write ( buck6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
243 
255 void buck6_generic_read ( buck6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
256 
266 uint8_t buck6_get_rst( buck6_t *ctx );
267 
277 void buck6_set_mode( buck6_t *ctx, uint8_t mode);
278 
288 void buck6_set_max_voltage( buck6_t *ctx, uint8_t voltage );
289 
290 #ifdef __cplusplus
291 }
292 #endif
293 #endif // _BUCK6_H_
294  // End public_function group
297 
298 // ------------------------------------------------------------------------- END
buck6_get_rst
uint8_t buck6_get_rst(buck6_t *ctx)
buck6_cfg_t::i2c_address
uint8_t i2c_address
Definition: buck6.h:197
buck6_cfg_t::rst
pin_name_t rst
Definition: buck6.h:191
buck6_init
BUCK6_RETVAL buck6_init(buck6_t *ctx, buck6_cfg_t *cfg)
Initialization function.
buck6_generic_read
void buck6_generic_read(buck6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
buck6_cfg_t::sda
pin_name_t sda
Definition: buck6.h:186
buck6_t
Click ctx object definition.
Definition: buck6.h:158
buck6_set_mode
void buck6_set_mode(buck6_t *ctx, uint8_t mode)
Set mode.
buck6_cfg_t::en
pin_name_t en
Definition: buck6.h:190
buck6_cfg_setup
void buck6_cfg_setup(buck6_cfg_t *cfg)
Config Object Initialization function.
buck6_generic_write
void buck6_generic_write(buck6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
buck6_t::syn
digital_out_t syn
Definition: buck6.h:162
BUCK6_RETVAL
#define BUCK6_RETVAL
Definition: buck6.h:80
buck6_t::en
digital_out_t en
Definition: buck6.h:161
buck6_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: buck6.h:196
buck6_t::i2c
i2c_master_t i2c
Definition: buck6.h:170
buck6_t::rst
digital_in_t rst
Definition: buck6.h:166
buck6_cfg_t::syn
pin_name_t syn
Definition: buck6.h:192
buck6_set_max_voltage
void buck6_set_max_voltage(buck6_t *ctx, uint8_t voltage)
Set maximum voltage.
buck6_t::slave_address
uint8_t slave_address
Definition: buck6.h:174
buck6_cfg_t
Click configuration structure definition.
Definition: buck6.h:182
buck6_cfg_t::scl
pin_name_t scl
Definition: buck6.h:185