smartbuck4  2.1.0.0
smartbuck4.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef SMARTBUCK4_H
29 #define SMARTBUCK4_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_i2c_master.h"
52 
73 #define SMARTBUCK4_REG_R600A_PROGRAM 0x80
74 #define SMARTBUCK4_REG_R400A_PROGRAM 0x40
75 #define SMARTBUCK4_REG_R600B_PROGRAM 0x20
76 #define SMARTBUCK4_REG_R400B_PROGRAM 0x10
77 #define SMARTBUCK4_REG_PULSE_SKIP_MODE 0x00
78 #define SMARTBUCK4_REG_LDO_MODE 0x01
79 #define SMARTBUCK4_REG_FORCED_BURST_MODE 0x02
80 #define SMARTBUCK4_REG_BURST_MODE 0x03
81  // smartbuck4_reg
83 
98 #define SMARTBUCK4_PIN_STATE_LOW 0x00
99 #define SMARTBUCK4_PIN_STATE_HIGH 0x01
100 
105 #define SMARTBUCK4_ENABLE_REGULATOR 0x80
106 #define SMARTBUCK4_DISABLE_REGULATOR 0x00
107 
113 #define SMARTBUCK4_REGULATOR_A_FB_425_MV 0x00
114 #define SMARTBUCK4_REGULATOR_A_FB_450_MV 0x01
115 #define SMARTBUCK4_REGULATOR_A_FB_475_MV 0x02
116 #define SMARTBUCK4_REGULATOR_A_FB_500_MV 0x03
117 #define SMARTBUCK4_REGULATOR_A_FB_525_MV 0x04
118 #define SMARTBUCK4_REGULATOR_A_FB_550_MV 0x05
119 #define SMARTBUCK4_REGULATOR_A_FB_575_MV 0x06
120 #define SMARTBUCK4_REGULATOR_A_FB_600_MV 0x07
121 #define SMARTBUCK4_REGULATOR_A_FB_625_MV 0x08
122 #define SMARTBUCK4_REGULATOR_A_FB_650_MV 0x09
123 #define SMARTBUCK4_REGULATOR_A_FB_675_MV 0x0A
124 #define SMARTBUCK4_REGULATOR_A_FB_700_MV 0x0B
125 #define SMARTBUCK4_REGULATOR_A_FB_725_MV 0x0C
126 #define SMARTBUCK4_REGULATOR_A_FB_750_MV 0x0D
127 #define SMARTBUCK4_REGULATOR_A_FB_775_MV 0x0E
128 #define SMARTBUCK4_REGULATOR_A_FB_800_MV 0x0F
129 
135 #define SMARTBUCK4_REGULATOR_B_600_MV 0x00
136 #define SMARTBUCK4_REGULATOR_B_700_MV 0x04
137 #define SMARTBUCK4_REGULATOR_B_800_MV 0x08
138 #define SMARTBUCK4_REGULATOR_B_900_MV 0x0C
139 #define SMARTBUCK4_REGULATOR_B_1000_MV 0x10
140 #define SMARTBUCK4_REGULATOR_B_1100_MV 0x14
141 #define SMARTBUCK4_REGULATOR_B_1200_MV 0x18
142 #define SMARTBUCK4_REGULATOR_B_1300_MV 0x1C
143 #define SMARTBUCK4_REGULATOR_B_1400_MV 0x20
144 #define SMARTBUCK4_REGULATOR_B_1500_MV 0x24
145 #define SMARTBUCK4_REGULATOR_B_1600_MV 0x28
146 #define SMARTBUCK4_REGULATOR_B_1700_MV 0x2C
147 #define SMARTBUCK4_REGULATOR_B_1800_MV 0x30
148 #define SMARTBUCK4_REGULATOR_B_1900_MV 0x34
149 #define SMARTBUCK4_REGULATOR_B_2000_MV 0x38
150 #define SMARTBUCK4_REGULATOR_B_2100_MV 0x3C
151 #define SMARTBUCK4_REGULATOR_B_2200_MV 0x40
152 #define SMARTBUCK4_REGULATOR_B_2300_MV 0x44
153 #define SMARTBUCK4_REGULATOR_B_2400_MV 0x48
154 #define SMARTBUCK4_REGULATOR_B_2500_MV 0x4C
155 #define SMARTBUCK4_REGULATOR_B_2600_MV 0x50
156 #define SMARTBUCK4_REGULATOR_B_2700_MV 0x54
157 #define SMARTBUCK4_REGULATOR_B_2800_MV 0x58
158 #define SMARTBUCK4_REGULATOR_B_2900_MV 0x5C
159 #define SMARTBUCK4_REGULATOR_B_3000_MV 0x60
160 #define SMARTBUCK4_REGULATOR_B_3100_MV 0x64
161 #define SMARTBUCK4_REGULATOR_B_3200_MV 0x68
162 #define SMARTBUCK4_REGULATOR_B_3300_MV 0x6C
163 #define SMARTBUCK4_REGULATOR_B_3400_MV 0x70
164 #define SMARTBUCK4_REGULATOR_B_3500_MV 0x74
165 #define SMARTBUCK4_REGULATOR_B_3600_MV 0x78
166 #define SMARTBUCK4_REGULATOR_B_3700_MV 0x7C
167 
173 #define SMARTBUCK4_REGULATOR_B_INC_0_MV 0x00
174 #define SMARTBUCK4_REGULATOR_B_INC_25_MV 0x01
175 #define SMARTBUCK4_REGULATOR_B_INC_50_MV 0x02
176 #define SMARTBUCK4_REGULATOR_B_INC_75_MV 0x03
177 
183 #define SMARTBUCK4_DEVICE_ADDRESS 0x65
184  // smartbuck4_set
186 
201 #define SMARTBUCK4_MAP_MIKROBUS( cfg, mikrobus ) \
202  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
203  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
204  cfg.r40 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
205  cfg.r60 = MIKROBUS( mikrobus, MIKROBUS_PWM )
206  // smartbuck4_map // smartbuck4
209 
214 typedef struct
215 {
216  // Output pins
217  digital_out_t r40;
218  digital_out_t r60;
220  // Modules
221  i2c_master_t i2c;
223  // I2C slave address
224  uint8_t slave_address;
226 } smartbuck4_t;
227 
232 typedef struct
233 {
234  pin_name_t scl;
235  pin_name_t sda;
237  pin_name_t r40;
238  pin_name_t r60;
240  uint32_t i2c_speed;
241  uint8_t i2c_address;
244 
249 typedef enum
250 {
252  SMARTBUCK4_ERROR = -1
253 
255 
272 
287 
301 
312 void smartbuck4_set_r40_out ( smartbuck4_t *ctx, uint8_t out_level );
313 
324 
335 
346 void smartbuck4_set_r60_out ( smartbuck4_t *ctx, uint8_t out_level );
347 
358 
369 
383 err_t smartbuck4_send_command ( smartbuck4_t *ctx, uint8_t addr, uint8_t data_in );
384 
397 
398 #ifdef __cplusplus
399 }
400 #endif
401 #endif // SMARTBUCK4_H
402  // smartbuck4
404 
405 // ------------------------------------------------------------------------ END
smartbuck4_set_r60_out
void smartbuck4_set_r60_out(smartbuck4_t *ctx, uint8_t out_level)
Smart Buck 4 set R60 pin state function.
smartbuck4_set_r40_out
void smartbuck4_set_r40_out(smartbuck4_t *ctx, uint8_t out_level)
Smart Buck 4 set R40 pin state function.
smartbuck4_cfg_t
Smart Buck 4 Click configuration object.
Definition: smartbuck4.h:233
smartbuck4_t::i2c
i2c_master_t i2c
Definition: smartbuck4.h:221
SMARTBUCK4_OK
@ SMARTBUCK4_OK
Definition: smartbuck4.h:251
smartbuck4_init
err_t smartbuck4_init(smartbuck4_t *ctx, smartbuck4_cfg_t *cfg)
Smart Buck 4 initialization function.
smartbuck4_default_cfg
err_t smartbuck4_default_cfg(smartbuck4_t *ctx)
Smart Buck 4 default configuration function.
smartbuck4_cfg_t::r40
pin_name_t r40
Definition: smartbuck4.h:237
smartbuck4_disable_regulators
err_t smartbuck4_disable_regulators(smartbuck4_t *ctx)
Smart Buck 4 disable regulators function.
smartbuck4_cfg_t::scl
pin_name_t scl
Definition: smartbuck4.h:234
smartbuck4_t::r60
digital_out_t r60
Definition: smartbuck4.h:218
smartbuck4_dis_r40_reg
void smartbuck4_dis_r40_reg(smartbuck4_t *ctx)
Smart Buck 4 disable 400A regulator function.
smartbuck4_t
Smart Buck 4 Click context object.
Definition: smartbuck4.h:215
smartbuck4_cfg_t::r60
pin_name_t r60
Definition: smartbuck4.h:238
SMARTBUCK4_ERROR
@ SMARTBUCK4_ERROR
Definition: smartbuck4.h:252
smartbuck4_t::slave_address
uint8_t slave_address
Definition: smartbuck4.h:224
smartbuck4_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: smartbuck4.h:240
smartbuck4_en_r60_reg
void smartbuck4_en_r60_reg(smartbuck4_t *ctx)
Smart Buck 4 enable 600A regulator function.
smartbuck4_dis_r60_reg
void smartbuck4_dis_r60_reg(smartbuck4_t *ctx)
Smart Buck 4 disable 600A regulator function.
smartbuck4_return_value_t
smartbuck4_return_value_t
Smart Buck 4 Click return value data.
Definition: smartbuck4.h:250
smartbuck4_cfg_t::sda
pin_name_t sda
Definition: smartbuck4.h:235
smartbuck4_en_r40_reg
void smartbuck4_en_r40_reg(smartbuck4_t *ctx)
Smart Buck 4 enable 400A regulator function.
smartbuck4_t::r40
digital_out_t r40
Definition: smartbuck4.h:217
smartbuck4_cfg_setup
void smartbuck4_cfg_setup(smartbuck4_cfg_t *cfg)
Smart Buck 4 configuration object setup function.
smartbuck4_cfg_t::i2c_address
uint8_t i2c_address
Definition: smartbuck4.h:241
smartbuck4_send_command
err_t smartbuck4_send_command(smartbuck4_t *ctx, uint8_t addr, uint8_t data_in)
Smart Buck 4 send command function.