smartbuck2.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 SMARTBUCK2_H
#define SMARTBUCK2_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 SMARTBUCK2_REG_SET0               0x00
#define SMARTBUCK2_REG_SET1               0x01
#define SMARTBUCK2_REG_SET2               0x02
#define SMARTBUCK2_REG_SET3               0x03
#define SMARTBUCK2_REG_CTRL               0x04
#define SMARTBUCK2_REG_TEMP               0x05
#define SMARTBUCK2_REG_RMPCTRL            0x06
#define SMARTBUCK2_REG_CHIP_ID_0          0x08
#define SMARTBUCK2_REG_CHIP_ID_1          0x09
 
 // smartbuck2_reg
 
#define SMARTBUCK2_OP_MOD_BIT_MASK        0x80
#define SMARTBUCK2_OP_MODE_FORCED_PWM     0x80
#define SMARTBUCK2_OP_MODE_PFM            0x00
 
#define SMARTBUCK2_CTRL_BIT_MASK          0xE0
#define SMARTBUCK2_CTRL_PD_EN             0x80
#define SMARTBUCK2_CTRL_PD_DIS            0x00
#define SMARTBUCK2_CTRL_PD_VSEL0_EN       0x40
#define SMARTBUCK2_CTRL_PD_VSEL0_DIS      0x00
#define SMARTBUCK2_CTRL_PD_VSEL1_EN       0x20
#define SMARTBUCK2_CTRL_PD_VSEL1_DIS      0x00
#define SMARTBUCK2_CTRL_PD_VSEL           0x40
 
#define SMARTBUCK2_TEMP_DIS_BIT_MASK      0xFB
#define SMARTBUCK2_TEMP_TS_ENABLE         0x00
#define SMARTBUCK2_TEMP_TS_DISABLE        0x04
#define SMARTBUCK2_TEMP_TJEW              0x02
#define SMARTBUCK2_TEMP_TJEW_BIT_MASK     0xFD
#define SMARTBUCK2_TEMP_LT_120_C          0x00
#define SMARTBUCK2_TEMP_GT_120_C          0x01
#define SMARTBUCK2_TEMP_ERROR             0x02
#define SMARTBUCK2_TEMP_TJTS              0x01
 
#define SMARTBUCK2_RMP_VTG_T_BIT_MASK     0xE0
#define SMARTBUCK2_RMP_SET                0xE0
#define SMARTBUCK2_RMP_EN_DISC            0x04
#define SMARTBUCK2_RMP_PFM                0x02
#define SMARTBUCK2_RMP_VTG_T_32MVNS       0x00
#define SMARTBUCK2_RMP_VTG_T_16MVNS       0x01
#define SMARTBUCK2_RMP_VTG_T_8MVNS        0x02
#define SMARTBUCK2_RMP_VTG_T_4MVNS        0x03
#define SMARTBUCK2_RMP_VTG_T_2MVNS        0x04
#define SMARTBUCK2_RMP_VTG_T_1MVNS        0x05
#define SMARTBUCK2_RMP_VTG_T_0_5MVNS      0x06
#define SMARTBUCK2_RMP_VTG_T_0_25MVNS     0x07
 
#define SMARTBUCK2_VENDOR_ID_BIT_MASK     0xF0
#define SMARTBUCK2_ID_VENDOR              0x80
#define SMARTBUCK2_PART_NUM_ID_BIT_MASK   0x0C
#define SMARTBUCK2_ID_PART_NUM            0x03
#define SMARTBUCK2_CHIP_REV_ID_BIT_MASK   0x03
 
#define SMARTBUCK2_VOUT_MIN                500u
#define SMARTBUCK2_VOUT_MAX               1770u
#define SMARTBUCK2_VOUT_STEP_10MV           10u
#define SMARTBUCK2_VOUT_START_500MV        500u
 
#define SMARTBUCK2_DEVICE_ADDRESS        0x60
 
 // smartbuck2_set
 
#define SMARTBUCK2_MAP_MIKROBUS( cfg, mikrobus )   \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL );  \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
#define SMARTBUCK2_MAP_MIKROBUS( cfg, mikrobus )   \ …
 
 // smartbuck2_map
 // smartbuck2
 
typedef struct
{
    // Modules
    i2c_master_t i2c;         
    // I2C slave address
    uint8_t slave_address;    
} smartbuck2_t;
typedef struct {…};
 
typedef struct
{
    pin_name_t scl;    
    pin_name_t sda;    
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} smartbuck2_cfg_t;
typedef struct {…};
 
typedef enum
{
    SMARTBUCK2_OK = 0,
    SMARTBUCK2_ERROR = -1
 
} smartbuck2_return_value_t;
typedef enum {…};
 
void smartbuck2_cfg_setup ( smartbuck2_cfg_t *cfg );
 
err_t smartbuck2_init ( smartbuck2_t *ctx, smartbuck2_cfg_t *cfg );
 
err_t smartbuck2_default_cfg ( smartbuck2_t *ctx );
 
err_t smartbuck2_generic_write ( smartbuck2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t smartbuck2_generic_read ( smartbuck2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t smartbuck2_set_voltage ( smartbuck2_t *ctx, uint16_t vout_mv );
 
err_t smartbuck2_get_voltage ( smartbuck2_t *ctx, uint16_t *vout_mv );
 
err_t smartbuck2_set_op_mode ( smartbuck2_t *ctx, uint8_t op_mode );
 
err_t smartbuck2_get_op_mode ( smartbuck2_t *ctx, uint8_t *op_mode );
 
err_t smartbuck2_set_ctrl ( smartbuck2_t *ctx, uint8_t ctrl );
 
err_t smartbuck2_set_temp_shd ( smartbuck2_t *ctx, uint8_t temp_enable );
 
uint8_t smartbuck2_check_temp_warning ( smartbuck2_t *ctx );
 
err_t smartbuck2_set_vtg_ramp_timing ( smartbuck2_t *ctx, uint8_t slope ); 
 
err_t smartbuck2_get_device_id ( smartbuck2_t *ctx, uint8_t *ven_id, uint8_t *part_num_id, uint8_t *chip_id );
 
#ifdef __cplusplus
}
#endif
#endif // SMARTBUCK2_H
 
 // smartbuck2
 
// ------------------------------------------------------------------------ END