smartbuck2  2.1.0.0
smartbuck2.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 SMARTBUCK2_H
29 #define SMARTBUCK2_H
30 
31 #ifdef __cplusplus
32 extern "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 SMARTBUCK2_REG_SET0 0x00
60 #define SMARTBUCK2_REG_SET1 0x01
61 #define SMARTBUCK2_REG_SET2 0x02
62 #define SMARTBUCK2_REG_SET3 0x03
63 #define SMARTBUCK2_REG_CTRL 0x04
64 #define SMARTBUCK2_REG_TEMP 0x05
65 #define SMARTBUCK2_REG_RMPCTRL 0x06
66 #define SMARTBUCK2_REG_CHIP_ID_0 0x08
67 #define SMARTBUCK2_REG_CHIP_ID_1 0x09
68  // smartbuck2_reg
70 
85 #define SMARTBUCK2_OP_MOD_BIT_MASK 0x80
86 #define SMARTBUCK2_OP_MODE_FORCED_PWM 0x80
87 #define SMARTBUCK2_OP_MODE_PFM 0x00
88 
93 #define SMARTBUCK2_CTRL_BIT_MASK 0xE0
94 #define SMARTBUCK2_CTRL_PD_EN 0x80
95 #define SMARTBUCK2_CTRL_PD_DIS 0x00
96 #define SMARTBUCK2_CTRL_PD_VSEL0_EN 0x40
97 #define SMARTBUCK2_CTRL_PD_VSEL0_DIS 0x00
98 #define SMARTBUCK2_CTRL_PD_VSEL1_EN 0x20
99 #define SMARTBUCK2_CTRL_PD_VSEL1_DIS 0x00
100 #define SMARTBUCK2_CTRL_PD_VSEL 0x40
101 
106 #define SMARTBUCK2_TEMP_DIS_BIT_MASK 0xFB
107 #define SMARTBUCK2_TEMP_TS_ENABLE 0x00
108 #define SMARTBUCK2_TEMP_TS_DISABLE 0x04
109 #define SMARTBUCK2_TEMP_TJEW 0x02
110 #define SMARTBUCK2_TEMP_TJEW_BIT_MASK 0xFD
111 #define SMARTBUCK2_TEMP_LT_120_C 0x00
112 #define SMARTBUCK2_TEMP_GT_120_C 0x01
113 #define SMARTBUCK2_TEMP_ERROR 0x02
114 #define SMARTBUCK2_TEMP_TJTS 0x01
115 
120 #define SMARTBUCK2_RMP_VTG_T_BIT_MASK 0xE0
121 #define SMARTBUCK2_RMP_SET 0xE0
122 #define SMARTBUCK2_RMP_EN_DISC 0x04
123 #define SMARTBUCK2_RMP_PFM 0x02
124 #define SMARTBUCK2_RMP_VTG_T_32MVNS 0x00
125 #define SMARTBUCK2_RMP_VTG_T_16MVNS 0x01
126 #define SMARTBUCK2_RMP_VTG_T_8MVNS 0x02
127 #define SMARTBUCK2_RMP_VTG_T_4MVNS 0x03
128 #define SMARTBUCK2_RMP_VTG_T_2MVNS 0x04
129 #define SMARTBUCK2_RMP_VTG_T_1MVNS 0x05
130 #define SMARTBUCK2_RMP_VTG_T_0_5MVNS 0x06
131 #define SMARTBUCK2_RMP_VTG_T_0_25MVNS 0x07
132 
137 #define SMARTBUCK2_VENDOR_ID_BIT_MASK 0xF0
138 #define SMARTBUCK2_ID_VENDOR 0x80
139 #define SMARTBUCK2_PART_NUM_ID_BIT_MASK 0x0C
140 #define SMARTBUCK2_ID_PART_NUM 0x03
141 #define SMARTBUCK2_CHIP_REV_ID_BIT_MASK 0x03
142 
147 #define SMARTBUCK2_VOUT_MIN 500u
148 #define SMARTBUCK2_VOUT_MAX 1770u
149 #define SMARTBUCK2_VOUT_STEP_10MV 10u
150 #define SMARTBUCK2_VOUT_START_500MV 500u
151 
157 #define SMARTBUCK2_DEVICE_ADDRESS 0x60
158  // smartbuck2_set
160 
175 #define SMARTBUCK2_MAP_MIKROBUS( cfg, mikrobus ) \
176  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
177  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
178  // smartbuck2_map // smartbuck2
181 
186 typedef struct
187 {
188  // Modules
189  i2c_master_t i2c;
191  // I2C slave address
192  uint8_t slave_address;
194 } smartbuck2_t;
195 
200 typedef struct
201 {
202  pin_name_t scl;
203  pin_name_t sda;
205  uint32_t i2c_speed;
206  uint8_t i2c_address;
209 
214 typedef enum
215 {
217  SMARTBUCK2_ERROR = -1
218 
220 
237 
252 
266 
281 err_t smartbuck2_generic_write ( smartbuck2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
282 
297 err_t smartbuck2_generic_read ( smartbuck2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
298 
312 err_t smartbuck2_set_voltage ( smartbuck2_t *ctx, uint16_t vout_mv );
313 
327 err_t smartbuck2_get_voltage ( smartbuck2_t *ctx, uint16_t *vout_mv );
328 
344 err_t smartbuck2_set_op_mode ( smartbuck2_t *ctx, uint8_t op_mode );
345 
359 err_t smartbuck2_get_op_mode ( smartbuck2_t *ctx, uint8_t *op_mode );
360 
374 err_t smartbuck2_set_ctrl ( smartbuck2_t *ctx, uint8_t ctrl );
375 
391 err_t smartbuck2_set_temp_shd ( smartbuck2_t *ctx, uint8_t temp_enable );
392 
405 
427 err_t smartbuck2_set_vtg_ramp_timing ( smartbuck2_t *ctx, uint8_t slope );
428 
444 err_t smartbuck2_get_device_id ( smartbuck2_t *ctx, uint8_t *ven_id, uint8_t *part_num_id, uint8_t *chip_id );
445 
446 #ifdef __cplusplus
447 }
448 #endif
449 #endif // SMARTBUCK2_H
450  // smartbuck2
452 
453 // ------------------------------------------------------------------------ END
SMARTBUCK2_ERROR
@ SMARTBUCK2_ERROR
Definition: smartbuck2.h:217
smartbuck2_set_ctrl
err_t smartbuck2_set_ctrl(smartbuck2_t *ctx, uint8_t ctrl)
Smart Buck 2 set control function.
smartbuck2_cfg_t::scl
pin_name_t scl
Definition: smartbuck2.h:202
smartbuck2_cfg_t
Smart Buck 2 Click configuration object.
Definition: smartbuck2.h:201
smartbuck2_return_value_t
smartbuck2_return_value_t
Smart Buck 2 Click return value data.
Definition: smartbuck2.h:215
smartbuck2_check_temp_warning
uint8_t smartbuck2_check_temp_warning(smartbuck2_t *ctx)
Smart Buck 2 check temperature warning function.
smartbuck2_t::slave_address
uint8_t slave_address
Definition: smartbuck2.h:192
smartbuck2_cfg_t::i2c_address
uint8_t i2c_address
Definition: smartbuck2.h:206
smartbuck2_get_voltage
err_t smartbuck2_get_voltage(smartbuck2_t *ctx, uint16_t *vout_mv)
Smart Buck 2 get voltage function.
smartbuck2_get_op_mode
err_t smartbuck2_get_op_mode(smartbuck2_t *ctx, uint8_t *op_mode)
Smart Buck 2 get operation mode function.
smartbuck2_set_op_mode
err_t smartbuck2_set_op_mode(smartbuck2_t *ctx, uint8_t op_mode)
Smart Buck 2 set operation mode function.
smartbuck2_set_voltage
err_t smartbuck2_set_voltage(smartbuck2_t *ctx, uint16_t vout_mv)
Smart Buck 2 set voltage function.
smartbuck2_t
Smart Buck 2 Click context object.
Definition: smartbuck2.h:187
smartbuck2_cfg_t::sda
pin_name_t sda
Definition: smartbuck2.h:203
smartbuck2_t::i2c
i2c_master_t i2c
Definition: smartbuck2.h:189
smartbuck2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: smartbuck2.h:205
SMARTBUCK2_OK
@ SMARTBUCK2_OK
Definition: smartbuck2.h:216
smartbuck2_set_temp_shd
err_t smartbuck2_set_temp_shd(smartbuck2_t *ctx, uint8_t temp_enable)
Smart Buck 2 set temperature shutdown function.
smartbuck2_cfg_setup
void smartbuck2_cfg_setup(smartbuck2_cfg_t *cfg)
Smart Buck 2 configuration object setup function.
smartbuck2_generic_write
err_t smartbuck2_generic_write(smartbuck2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Smart Buck 2 I2C writing function.
smartbuck2_set_vtg_ramp_timing
err_t smartbuck2_set_vtg_ramp_timing(smartbuck2_t *ctx, uint8_t slope)
Smart Buck 2 set voltage ramp timing function.
smartbuck2_init
err_t smartbuck2_init(smartbuck2_t *ctx, smartbuck2_cfg_t *cfg)
Smart Buck 2 initialization function.
smartbuck2_generic_read
err_t smartbuck2_generic_read(smartbuck2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Smart Buck 2 I2C reading function.
smartbuck2_default_cfg
err_t smartbuck2_default_cfg(smartbuck2_t *ctx)
Smart Buck 2 default configuration function.
smartbuck2_get_device_id
err_t smartbuck2_get_device_id(smartbuck2_t *ctx, uint8_t *ven_id, uint8_t *part_num_id, uint8_t *chip_id)
Smart Buck 2 get device ID function.