smartbuck3  2.1.0.0
smartbuck3.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 SMARTBUCK3_H
29 #define SMARTBUCK3_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 SMARTBUCK3_REG_SET0 0x00
74 #define SMARTBUCK3_REG_SET1 0x01
75 #define SMARTBUCK3_REG_CTRL 0x04
76 #define SMARTBUCK3_REG_TEMP 0x05
77 #define SMARTBUCK3_REG_RMPCTRL 0x06
78 #define SMARTBUCK3_REG_CHIP_ID_0 0x08
79 #define SMARTBUCK3_REG_CHIP_ID_1 0x09
80  // smartbuck3_reg
82 
97 #define SMARTBUCK3_MOD_BIT_MASK 0x80
98 #define SMARTBUCK3_OP_MODE_FORCED_PWM 0x80
99 #define SMARTBUCK3_OP_MODE_PFM 0x00
100 #define SMARTBUCK3_OV_BIT_MASK 0x7F
101 #define SMARTBUCK3_CTRL_PD_EN 0x80
102 #define SMARTBUCK3_CTRL_PD_VSEL 0x40
103 #define SMARTBUCK3_TEMP_DIS_BIT_MASK 0xFB
104 #define SMARTBUCK3_TEMP_TS_ENABLE 0x00
105 #define SMARTBUCK3_TEMP_TS_DISABLE 0x04
106 #define SMARTBUCK3_TEMP_TJEW 0x02
107 #define SMARTBUCK3_TEMP_TJEW_BIT_MASK 0xFD
108 #define SMARTBUCK3_TEMP_LT_120_C 0x00
109 #define SMARTBUCK3_TEMP_GT_120_C 0x01
110 #define SMARTBUCK3_TEMP_ERROR 0x02
111 #define SMARTBUCK3_TEMP_TJTS 0x01
112 #define SMARTBUCK3_RMP_SET 0xE0
113 #define SMARTBUCK3_RMP_EN_DISC 0x04
114 #define SMARTBUCK3_RMP_PFM 0x02
115 #define SMARTBUCK3_ID_VENDOR 0xF0
116 #define SMARTBUCK3_ID_PART 0x0C
117 #define SMARTBUCK3_ID_REV 0x03
118 #define SMARTBUCK3_VTG_RAMP_T_32mVns 0x00
119 #define SMARTBUCK3_VTG_RAMP_T_16mVns 0x01
120 #define SMARTBUCK3_VTG_RAMP_T_8mVns 0x02
121 #define SMARTBUCK3_VTG_RAMP_T_4mVns 0x03
122 #define SMARTBUCK3_VTG_RAMP_T_2mVns 0x04
123 #define SMARTBUCK3_VTG_RAMP_T_1mVns 0x05
124 #define SMARTBUCK3_VTG_RAMP_T_0_5mVns 0x06
125 #define SMARTBUCK3_VTG_RAMP_T_0_25mVns 0x07
126 #define SMARTBUCK3_VTG_RAMP_T_BIT_MASK 0xE0
127 #define SMARTBUCK3_VOUT_MAX 1770
128 #define SMARTBUCK3_VOUT_MIN 500
129 #define SMARTBUCK3_DEVICE_ID 0x91
130 
136 #define SMARTBUCK3_DEVICE_ADDRESS 0x60
137  // smartbuck3_set
139 
154 #define SMARTBUCK3_MAP_MIKROBUS( cfg, mikrobus ) \
155  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
156  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
157  // smartbuck3_map // smartbuck3
160 
165 typedef struct
166 {
167  // Modules
168  i2c_master_t i2c;
170  // I2C slave address
171  uint8_t slave_address;
173 } smartbuck3_t;
174 
179 typedef struct
180 {
181  pin_name_t scl;
182  pin_name_t sda;
184  uint32_t i2c_speed;
185  uint8_t i2c_address;
188 
193 typedef enum
194 {
196  SMARTBUCK3_ERROR = -1
197 
199 
216 
231 
245 
260 err_t smartbuck3_generic_write ( smartbuck3_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
261 
276 err_t smartbuck3_generic_read ( smartbuck3_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
277 
291 err_t smartbuck3_set_voltage ( smartbuck3_t *ctx, uint16_t vout_mv );
292 
306 err_t smartbuck3_get_voltage ( smartbuck3_t *ctx, uint16_t *vout_mv );
307 
323 err_t smartbuck3_set_operation_mode ( smartbuck3_t *ctx, uint8_t op_mode );
324 
340 err_t smartbuck3_get_operation_mode ( smartbuck3_t *ctx, uint8_t *op_mode );
341 
357 err_t smartbuck3_set_temperature_shutdown ( smartbuck3_t *ctx, uint8_t temp_enable );
358 
371 
393 err_t smartbuck3_set_voltage_ramp_timing ( smartbuck3_t *ctx, uint8_t slope );
394 
410 err_t smartbuck3_get_device_id ( smartbuck3_t *ctx, uint8_t *device_id );
411 
412 #ifdef __cplusplus
413 }
414 #endif
415 #endif // SMARTBUCK3_H
416  // smartbuck3
418 
419 // ------------------------------------------------------------------------ END
smartbuck3_cfg_t::sda
pin_name_t sda
Definition: smartbuck3.h:182
smartbuck3_cfg_t
Smart Buck 3 Click configuration object.
Definition: smartbuck3.h:180
smartbuck3_init
err_t smartbuck3_init(smartbuck3_t *ctx, smartbuck3_cfg_t *cfg)
Smart Buck 3 initialization function.
smartbuck3_generic_write
err_t smartbuck3_generic_write(smartbuck3_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Smart Buck 3 I2C writing function.
smartbuck3_cfg_t::i2c_address
uint8_t i2c_address
Definition: smartbuck3.h:185
smartbuck3_return_value_t
smartbuck3_return_value_t
Smart Buck 3 Click return value data.
Definition: smartbuck3.h:194
smartbuck3_set_operation_mode
err_t smartbuck3_set_operation_mode(smartbuck3_t *ctx, uint8_t op_mode)
Smart Buck 3 set operation mode function.
smartbuck3_get_operation_mode
err_t smartbuck3_get_operation_mode(smartbuck3_t *ctx, uint8_t *op_mode)
Smart Buck 3 get operation mode function.
smartbuck3_t::slave_address
uint8_t slave_address
Definition: smartbuck3.h:171
smartbuck3_t
Smart Buck 3 Click context object.
Definition: smartbuck3.h:166
smartbuck3_get_voltage
err_t smartbuck3_get_voltage(smartbuck3_t *ctx, uint16_t *vout_mv)
Smart Buck 3 get voltage function.
smartbuck3_cfg_setup
void smartbuck3_cfg_setup(smartbuck3_cfg_t *cfg)
Smart Buck 3 configuration object setup function.
smartbuck3_get_device_id
err_t smartbuck3_get_device_id(smartbuck3_t *ctx, uint8_t *device_id)
Smart Buck 3 get device ID function.
smartbuck3_t::i2c
i2c_master_t i2c
Definition: smartbuck3.h:168
smartbuck3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: smartbuck3.h:184
smartbuck3_set_temperature_shutdown
err_t smartbuck3_set_temperature_shutdown(smartbuck3_t *ctx, uint8_t temp_enable)
Smart Buck 3 set temperature shutdown function.
smartbuck3_default_cfg
err_t smartbuck3_default_cfg(smartbuck3_t *ctx)
Smart Buck 3 default configuration function.
smartbuck3_check_temperature_warning
uint8_t smartbuck3_check_temperature_warning(smartbuck3_t *ctx)
Smart Buck 3 check temperature warning function.
smartbuck3_cfg_t::scl
pin_name_t scl
Definition: smartbuck3.h:181
SMARTBUCK3_ERROR
@ SMARTBUCK3_ERROR
Definition: smartbuck3.h:196
smartbuck3_set_voltage
err_t smartbuck3_set_voltage(smartbuck3_t *ctx, uint16_t vout_mv)
Smart Buck 3 set voltage function.
smartbuck3_generic_read
err_t smartbuck3_generic_read(smartbuck3_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Smart Buck 3 I2C reading function.
SMARTBUCK3_OK
@ SMARTBUCK3_OK
Definition: smartbuck3.h:195
smartbuck3_set_voltage_ramp_timing
err_t smartbuck3_set_voltage_ramp_timing(smartbuck3_t *ctx, uint8_t slope)
Smart Buck 3 set voltage ramp timing function.