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
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_i2c_master.h"
38
59#define SMARTBUCK4_REG_R600A_PROGRAM 0x80
60#define SMARTBUCK4_REG_R400A_PROGRAM 0x40
61#define SMARTBUCK4_REG_R600B_PROGRAM 0x20
62#define SMARTBUCK4_REG_R400B_PROGRAM 0x10
63#define SMARTBUCK4_REG_PULSE_SKIP_MODE 0x00
64#define SMARTBUCK4_REG_LDO_MODE 0x01
65#define SMARTBUCK4_REG_FORCED_BURST_MODE 0x02
66#define SMARTBUCK4_REG_BURST_MODE 0x03
67 // smartbuck4_reg
69
84#define SMARTBUCK4_PIN_STATE_LOW 0x00
85#define SMARTBUCK4_PIN_STATE_HIGH 0x01
86
91#define SMARTBUCK4_ENABLE_REGULATOR 0x80
92#define SMARTBUCK4_DISABLE_REGULATOR 0x00
93
99#define SMARTBUCK4_REGULATOR_A_FB_425_MV 0x00
100#define SMARTBUCK4_REGULATOR_A_FB_450_MV 0x01
101#define SMARTBUCK4_REGULATOR_A_FB_475_MV 0x02
102#define SMARTBUCK4_REGULATOR_A_FB_500_MV 0x03
103#define SMARTBUCK4_REGULATOR_A_FB_525_MV 0x04
104#define SMARTBUCK4_REGULATOR_A_FB_550_MV 0x05
105#define SMARTBUCK4_REGULATOR_A_FB_575_MV 0x06
106#define SMARTBUCK4_REGULATOR_A_FB_600_MV 0x07
107#define SMARTBUCK4_REGULATOR_A_FB_625_MV 0x08
108#define SMARTBUCK4_REGULATOR_A_FB_650_MV 0x09
109#define SMARTBUCK4_REGULATOR_A_FB_675_MV 0x0A
110#define SMARTBUCK4_REGULATOR_A_FB_700_MV 0x0B
111#define SMARTBUCK4_REGULATOR_A_FB_725_MV 0x0C
112#define SMARTBUCK4_REGULATOR_A_FB_750_MV 0x0D
113#define SMARTBUCK4_REGULATOR_A_FB_775_MV 0x0E
114#define SMARTBUCK4_REGULATOR_A_FB_800_MV 0x0F
115
121#define SMARTBUCK4_REGULATOR_B_600_MV 0x00
122#define SMARTBUCK4_REGULATOR_B_700_MV 0x04
123#define SMARTBUCK4_REGULATOR_B_800_MV 0x08
124#define SMARTBUCK4_REGULATOR_B_900_MV 0x0C
125#define SMARTBUCK4_REGULATOR_B_1000_MV 0x10
126#define SMARTBUCK4_REGULATOR_B_1100_MV 0x14
127#define SMARTBUCK4_REGULATOR_B_1200_MV 0x18
128#define SMARTBUCK4_REGULATOR_B_1300_MV 0x1C
129#define SMARTBUCK4_REGULATOR_B_1400_MV 0x20
130#define SMARTBUCK4_REGULATOR_B_1500_MV 0x24
131#define SMARTBUCK4_REGULATOR_B_1600_MV 0x28
132#define SMARTBUCK4_REGULATOR_B_1700_MV 0x2C
133#define SMARTBUCK4_REGULATOR_B_1800_MV 0x30
134#define SMARTBUCK4_REGULATOR_B_1900_MV 0x34
135#define SMARTBUCK4_REGULATOR_B_2000_MV 0x38
136#define SMARTBUCK4_REGULATOR_B_2100_MV 0x3C
137#define SMARTBUCK4_REGULATOR_B_2200_MV 0x40
138#define SMARTBUCK4_REGULATOR_B_2300_MV 0x44
139#define SMARTBUCK4_REGULATOR_B_2400_MV 0x48
140#define SMARTBUCK4_REGULATOR_B_2500_MV 0x4C
141#define SMARTBUCK4_REGULATOR_B_2600_MV 0x50
142#define SMARTBUCK4_REGULATOR_B_2700_MV 0x54
143#define SMARTBUCK4_REGULATOR_B_2800_MV 0x58
144#define SMARTBUCK4_REGULATOR_B_2900_MV 0x5C
145#define SMARTBUCK4_REGULATOR_B_3000_MV 0x60
146#define SMARTBUCK4_REGULATOR_B_3100_MV 0x64
147#define SMARTBUCK4_REGULATOR_B_3200_MV 0x68
148#define SMARTBUCK4_REGULATOR_B_3300_MV 0x6C
149#define SMARTBUCK4_REGULATOR_B_3400_MV 0x70
150#define SMARTBUCK4_REGULATOR_B_3500_MV 0x74
151#define SMARTBUCK4_REGULATOR_B_3600_MV 0x78
152#define SMARTBUCK4_REGULATOR_B_3700_MV 0x7C
153
159#define SMARTBUCK4_REGULATOR_B_INC_0_MV 0x00
160#define SMARTBUCK4_REGULATOR_B_INC_25_MV 0x01
161#define SMARTBUCK4_REGULATOR_B_INC_50_MV 0x02
162#define SMARTBUCK4_REGULATOR_B_INC_75_MV 0x03
163
169#define SMARTBUCK4_DEVICE_ADDRESS 0x65
170 // smartbuck4_set
172
187#define SMARTBUCK4_MAP_MIKROBUS( cfg, mikrobus ) \
188 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
189 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
190 cfg.r40 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
191 cfg.r60 = MIKROBUS( mikrobus, MIKROBUS_PWM )
192 // smartbuck4_map // smartbuck4
195
200typedef struct
201{
202 // Output pins
203 digital_out_t r40;
204 digital_out_t r60;
206 // Modules
207 i2c_master_t i2c;
209 // I2C slave address
213
218typedef struct
219{
220 pin_name_t scl;
221 pin_name_t sda;
223 pin_name_t r40;
224 pin_name_t r60;
226 uint32_t i2c_speed;
227 uint8_t i2c_address;
230
235typedef enum
236{
239
241
258
273
287
298void smartbuck4_set_r40_out ( smartbuck4_t *ctx, uint8_t out_level );
299
310
321
332void smartbuck4_set_r60_out ( smartbuck4_t *ctx, uint8_t out_level );
333
344
355
369err_t smartbuck4_send_command ( smartbuck4_t *ctx, uint8_t addr, uint8_t data_in );
370
383
384#ifdef __cplusplus
385}
386#endif
387#endif // SMARTBUCK4_H
388 // smartbuck4
390
391// ------------------------------------------------------------------------ END
err_t smartbuck4_disable_regulators(smartbuck4_t *ctx)
Smart Buck 4 disable regulators function.
err_t smartbuck4_send_command(smartbuck4_t *ctx, uint8_t addr, uint8_t data_in)
Smart Buck 4 send command function.
err_t smartbuck4_init(smartbuck4_t *ctx, smartbuck4_cfg_t *cfg)
Smart Buck 4 initialization function.
err_t smartbuck4_default_cfg(smartbuck4_t *ctx)
Smart Buck 4 default configuration function.
void smartbuck4_set_r60_out(smartbuck4_t *ctx, uint8_t out_level)
Smart Buck 4 set R60 pin state function.
void smartbuck4_en_r60_reg(smartbuck4_t *ctx)
Smart Buck 4 enable 600A regulator function.
void smartbuck4_dis_r60_reg(smartbuck4_t *ctx)
Smart Buck 4 disable 600A regulator function.
void smartbuck4_set_r40_out(smartbuck4_t *ctx, uint8_t out_level)
Smart Buck 4 set R40 pin state function.
void smartbuck4_en_r40_reg(smartbuck4_t *ctx)
Smart Buck 4 enable 400A regulator function.
void smartbuck4_cfg_setup(smartbuck4_cfg_t *cfg)
Smart Buck 4 configuration object setup function.
void smartbuck4_dis_r40_reg(smartbuck4_t *ctx)
Smart Buck 4 disable 400A regulator function.
smartbuck4_return_value_t
Smart Buck 4 Click return value data.
Definition: smartbuck4.h:236
@ SMARTBUCK4_OK
Definition: smartbuck4.h:237
@ SMARTBUCK4_ERROR
Definition: smartbuck4.h:238
Smart Buck 4 Click configuration object.
Definition: smartbuck4.h:219
uint32_t i2c_speed
Definition: smartbuck4.h:226
pin_name_t r60
Definition: smartbuck4.h:224
pin_name_t scl
Definition: smartbuck4.h:220
pin_name_t sda
Definition: smartbuck4.h:221
pin_name_t r40
Definition: smartbuck4.h:223
uint8_t i2c_address
Definition: smartbuck4.h:227
Smart Buck 4 Click context object.
Definition: smartbuck4.h:201
digital_out_t r40
Definition: smartbuck4.h:203
i2c_master_t i2c
Definition: smartbuck4.h:207
digital_out_t r60
Definition: smartbuck4.h:204
uint8_t slave_address
Definition: smartbuck4.h:210