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 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
53 #define BUCK6_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
55  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
56  cfg.en = MIKROBUS( mikrobus, MIKROBUS_AN ); \
57  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
58  cfg.syn = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
59 
60 
66 #define BUCK6_RETVAL uint8_t
67 
68 #define BUCK6_OK 0x00
69 #define BUCK6_INIT_ERROR 0xFF
70 
76 #define BUCK6_MAX_RANGE_1000mV 0xFA
77 #define BUCK6_MAX_RANGE_1500mV 0xF4
78 #define BUCK6_MAX_RANGE_2000mV 0xF1
79 #define BUCK6_MAX_RANGE_2500mV 0xEE
80 #define BUCK6_MAX_RANGE_3000mV 0xEA
81 #define BUCK6_MAX_RANGE_3500mV 0xE7
82 #define BUCK6_MAX_RANGE_4000mV 0xE4
83 #define BUCK6_MAX_RANGE_4500mV 0xE1
84 #define BUCK6_MAX_RANGE_5000mV 0xDE
85 #define BUCK6_MAX_RANGE_5500mV 0xDB
86 
87 #define BUCK6_MAX_RANGE_6000mV 0xD8
88 #define BUCK6_MAX_RANGE_6500mV 0xD4
89 #define BUCK6_MAX_RANGE_7000mV 0xD1
90 #define BUCK6_MAX_RANGE_7500mV 0xCF
91 #define BUCK6_MAX_RANGE_8000mV 0xCB
92 #define BUCK6_MAX_RANGE_8500mV 0xC8
93 #define BUCK6_MAX_RANGE_9000mV 0xC5
94 #define BUCK6_MAX_RANGE_9500mV 0xC2
95 #define BUCK6_MAX_RANGE_10000mV 0xBF
96 #define BUCK6_MAX_RANGE_10500mV 0xBC
97 #define BUCK6_MAX_RANGE_11000mV 0xB9
98 #define BUCK6_MAX_RANGE_11500mV 0xB6
99 #define BUCK6_MAX_RANGE_12000mV 0xB2
100 #define BUCK6_MAX_RANGE_12500mV 0xAF
101 
102 #define BUCK6_MAX_RANGE_13000mV 0xAB
103 #define BUCK6_MAX_RANGE_13500mV 0xA9
104 #define BUCK6_MAX_RANGE_14000mV 0xA6
105 #define BUCK6_MAX_RANGE_14500mV 0xA3
106 #define BUCK6_MAX_RANGE_15000mV 0xA0
107 #define BUCK6_MAX_RANGE_15500mV 0x9C
108 #define BUCK6_MAX_RANGE_16000mV 0x99
109 #define BUCK6_MAX_RANGE_16500mV 0x96
110 #define BUCK6_MAX_RANGE_17000mV 0x93
111 #define BUCK6_MAX_RANGE_17500mV 0x90
112 #define BUCK6_MAX_RANGE_18000mV 0x8D
113 #define BUCK6_MAX_RANGE_18500mV 0x8A
114 #define BUCK6_MAX_RANGE_19000mV 0x87
115 #define BUCK6_MAX_RANGE_19500mV 0x84
116 #define BUCK6_MAX_RANGE_20000mV 0x80
117 
123 #define BUCK6_SLEEP_MODE 0x00
124 
130 #define BUCK6_ACTIVE_MODE 0x01
131  // End group macro
134 // --------------------------------------------------------------- PUBLIC TYPES
143 typedef struct
144 {
145  // Output pins
146 
147  digital_out_t en;
148  digital_out_t syn;
149 
150  // Input pins
151 
152  digital_in_t rst;
153 
154  // Modules
155 
156  i2c_master_t i2c;
157 
158  // ctx variable
159 
160  uint8_t slave_address;
161 
162 } buck6_t;
163 
167 typedef struct
168 {
169  // Communication gpio pins
170 
171  pin_name_t scl;
172  pin_name_t sda;
173 
174  // Additional gpio pins
175 
176  pin_name_t en;
177  pin_name_t rst;
178  pin_name_t syn;
179 
180  // static variable
181 
182  uint32_t i2c_speed;
183  uint8_t i2c_address;
184 
185 } buck6_cfg_t;
186  // End types group
188 
189 
195 #ifdef __cplusplus
196 extern "C"{
197 #endif
198 
207 void buck6_cfg_setup ( buck6_cfg_t *cfg );
208 
217 
228 void buck6_generic_write ( buck6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
229 
241 void buck6_generic_read ( buck6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
242 
252 uint8_t buck6_get_rst( buck6_t *ctx );
253 
263 void buck6_set_mode( buck6_t *ctx, uint8_t mode);
264 
274 void buck6_set_max_voltage( buck6_t *ctx, uint8_t voltage );
275 
276 #ifdef __cplusplus
277 }
278 #endif
279 #endif // _BUCK6_H_
280  // End public_function group
283 
284 // ------------------------------------------------------------------------- END
buck6_get_rst
uint8_t buck6_get_rst(buck6_t *ctx)
buck6_cfg_t::i2c_address
uint8_t i2c_address
Definition: buck6.h:183
buck6_cfg_t::rst
pin_name_t rst
Definition: buck6.h:177
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:172
buck6_t
Click ctx object definition.
Definition: buck6.h:143
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:176
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:148
BUCK6_RETVAL
#define BUCK6_RETVAL
Definition: buck6.h:66
buck6_t::en
digital_out_t en
Definition: buck6.h:147
buck6_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: buck6.h:182
buck6_t::i2c
i2c_master_t i2c
Definition: buck6.h:156
buck6_t::rst
digital_in_t rst
Definition: buck6.h:152
buck6_cfg_t::syn
pin_name_t syn
Definition: buck6.h:178
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:160
buck6_cfg_t
Click configuration structure definition.
Definition: buck6.h:167
buck6_cfg_t::scl
pin_name_t scl
Definition: buck6.h:171