smartbuck3.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef SMARTBUCK3_H
#define SMARTBUCK3_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
 
#define SMARTBUCK3_REG_SET0               0x00
#define SMARTBUCK3_REG_SET1               0x01
#define SMARTBUCK3_REG_CTRL               0x04
#define SMARTBUCK3_REG_TEMP               0x05
#define SMARTBUCK3_REG_RMPCTRL            0x06
#define SMARTBUCK3_REG_CHIP_ID_0          0x08
#define SMARTBUCK3_REG_CHIP_ID_1          0x09
 
 // smartbuck3_reg
 
#define SMARTBUCK3_MOD_BIT_MASK           0x80
#define SMARTBUCK3_OP_MODE_FORCED_PWM     0x80
#define SMARTBUCK3_OP_MODE_PFM            0x00
#define SMARTBUCK3_OV_BIT_MASK            0x7F
#define SMARTBUCK3_CTRL_PD_EN             0x80
#define SMARTBUCK3_CTRL_PD_VSEL           0x40
#define SMARTBUCK3_TEMP_DIS_BIT_MASK      0xFB
#define SMARTBUCK3_TEMP_TS_ENABLE         0x00
#define SMARTBUCK3_TEMP_TS_DISABLE        0x04
#define SMARTBUCK3_TEMP_TJEW              0x02
#define SMARTBUCK3_TEMP_TJEW_BIT_MASK     0xFD
#define SMARTBUCK3_TEMP_LT_120_C          0x00
#define SMARTBUCK3_TEMP_GT_120_C          0x01
#define SMARTBUCK3_TEMP_ERROR             0x02
#define SMARTBUCK3_TEMP_TJTS              0x01
#define SMARTBUCK3_RMP_SET                0xE0
#define SMARTBUCK3_RMP_EN_DISC            0x04
#define SMARTBUCK3_RMP_PFM                0x02
#define SMARTBUCK3_ID_VENDOR              0xF0
#define SMARTBUCK3_ID_PART                0x0C
#define SMARTBUCK3_ID_REV                 0x03
#define SMARTBUCK3_VTG_RAMP_T_32mVns      0x00
#define SMARTBUCK3_VTG_RAMP_T_16mVns      0x01
#define SMARTBUCK3_VTG_RAMP_T_8mVns       0x02
#define SMARTBUCK3_VTG_RAMP_T_4mVns       0x03
#define SMARTBUCK3_VTG_RAMP_T_2mVns       0x04
#define SMARTBUCK3_VTG_RAMP_T_1mVns       0x05
#define SMARTBUCK3_VTG_RAMP_T_0_5mVns     0x06
#define SMARTBUCK3_VTG_RAMP_T_0_25mVns    0x07
#define SMARTBUCK3_VTG_RAMP_T_BIT_MASK    0xE0
#define SMARTBUCK3_VOUT_MAX               1770
#define SMARTBUCK3_VOUT_MIN                500
#define SMARTBUCK3_DEVICE_ID              0x91
 
#define SMARTBUCK3_DEVICE_ADDRESS         0x60
 
 // smartbuck3_set
 
#define SMARTBUCK3_MAP_MIKROBUS( cfg, mikrobus )  \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // smartbuck3_map
 // smartbuck3
 
typedef struct
{
    // Modules
    i2c_master_t i2c;         
    // I2C slave address
    uint8_t slave_address;    
} smartbuck3_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} smartbuck3_cfg_t;
 
typedef enum
{
    SMARTBUCK3_OK = 0,
    SMARTBUCK3_ERROR = -1
 
} smartbuck3_return_value_t;
 
void smartbuck3_cfg_setup ( smartbuck3_cfg_t *cfg );
 
err_t smartbuck3_init ( smartbuck3_t *ctx, smartbuck3_cfg_t *cfg );
 
err_t smartbuck3_default_cfg ( smartbuck3_t *ctx );
 
err_t smartbuck3_generic_write ( smartbuck3_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t smartbuck3_generic_read ( smartbuck3_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t smartbuck3_set_voltage ( smartbuck3_t *ctx, uint16_t vout_mv );
 
err_t smartbuck3_get_voltage ( smartbuck3_t *ctx, uint16_t *vout_mv );
 
err_t smartbuck3_set_operation_mode ( smartbuck3_t *ctx, uint8_t op_mode );
 
err_t smartbuck3_get_operation_mode ( smartbuck3_t *ctx, uint8_t *op_mode );
 
err_t smartbuck3_set_temperature_shutdown ( smartbuck3_t *ctx, uint8_t temp_enable );
 
uint8_t smartbuck3_check_temperature_warning ( smartbuck3_t *ctx );
 
err_t smartbuck3_set_voltage_ramp_timing ( smartbuck3_t *ctx, uint8_t slope );
 
err_t smartbuck3_get_device_id ( smartbuck3_t *ctx, uint8_t *device_id );
 
#ifdef __cplusplus
}
#endif
#endif // SMARTBUCK3_H
 
 // smartbuck3
 
// ------------------------------------------------------------------------ END