smartbuck4.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 SMARTBUCK4_H
#define SMARTBUCK4_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 SMARTBUCK4_REG_R600A_PROGRAM            0x80
#define SMARTBUCK4_REG_R400A_PROGRAM            0x40
#define SMARTBUCK4_REG_R600B_PROGRAM            0x20
#define SMARTBUCK4_REG_R400B_PROGRAM            0x10
#define SMARTBUCK4_REG_PULSE_SKIP_MODE          0x00
#define SMARTBUCK4_REG_LDO_MODE                 0x01
#define SMARTBUCK4_REG_FORCED_BURST_MODE        0x02
#define SMARTBUCK4_REG_BURST_MODE               0x03
 
 // smartbuck4_reg
 
#define SMARTBUCK4_PIN_STATE_LOW                0x00
#define SMARTBUCK4_PIN_STATE_HIGH               0x01
 
#define SMARTBUCK4_ENABLE_REGULATOR             0x80
#define SMARTBUCK4_DISABLE_REGULATOR            0x00
 
#define SMARTBUCK4_REGULATOR_A_FB_425_MV        0x00
#define SMARTBUCK4_REGULATOR_A_FB_450_MV        0x01
#define SMARTBUCK4_REGULATOR_A_FB_475_MV        0x02
#define SMARTBUCK4_REGULATOR_A_FB_500_MV        0x03
#define SMARTBUCK4_REGULATOR_A_FB_525_MV        0x04
#define SMARTBUCK4_REGULATOR_A_FB_550_MV        0x05
#define SMARTBUCK4_REGULATOR_A_FB_575_MV        0x06
#define SMARTBUCK4_REGULATOR_A_FB_600_MV        0x07
#define SMARTBUCK4_REGULATOR_A_FB_625_MV        0x08
#define SMARTBUCK4_REGULATOR_A_FB_650_MV        0x09
#define SMARTBUCK4_REGULATOR_A_FB_675_MV        0x0A
#define SMARTBUCK4_REGULATOR_A_FB_700_MV        0x0B
#define SMARTBUCK4_REGULATOR_A_FB_725_MV        0x0C
#define SMARTBUCK4_REGULATOR_A_FB_750_MV        0x0D
#define SMARTBUCK4_REGULATOR_A_FB_775_MV        0x0E
#define SMARTBUCK4_REGULATOR_A_FB_800_MV        0x0F
 
#define SMARTBUCK4_REGULATOR_B_600_MV           0x00
#define SMARTBUCK4_REGULATOR_B_700_MV           0x04
#define SMARTBUCK4_REGULATOR_B_800_MV           0x08
#define SMARTBUCK4_REGULATOR_B_900_MV           0x0C
#define SMARTBUCK4_REGULATOR_B_1000_MV          0x10
#define SMARTBUCK4_REGULATOR_B_1100_MV          0x14
#define SMARTBUCK4_REGULATOR_B_1200_MV          0x18
#define SMARTBUCK4_REGULATOR_B_1300_MV          0x1C
#define SMARTBUCK4_REGULATOR_B_1400_MV          0x20
#define SMARTBUCK4_REGULATOR_B_1500_MV          0x24
#define SMARTBUCK4_REGULATOR_B_1600_MV          0x28
#define SMARTBUCK4_REGULATOR_B_1700_MV          0x2C
#define SMARTBUCK4_REGULATOR_B_1800_MV          0x30
#define SMARTBUCK4_REGULATOR_B_1900_MV          0x34
#define SMARTBUCK4_REGULATOR_B_2000_MV          0x38
#define SMARTBUCK4_REGULATOR_B_2100_MV          0x3C
#define SMARTBUCK4_REGULATOR_B_2200_MV          0x40
#define SMARTBUCK4_REGULATOR_B_2300_MV          0x44
#define SMARTBUCK4_REGULATOR_B_2400_MV          0x48
#define SMARTBUCK4_REGULATOR_B_2500_MV          0x4C
#define SMARTBUCK4_REGULATOR_B_2600_MV          0x50
#define SMARTBUCK4_REGULATOR_B_2700_MV          0x54
#define SMARTBUCK4_REGULATOR_B_2800_MV          0x58
#define SMARTBUCK4_REGULATOR_B_2900_MV          0x5C
#define SMARTBUCK4_REGULATOR_B_3000_MV          0x60
#define SMARTBUCK4_REGULATOR_B_3100_MV          0x64
#define SMARTBUCK4_REGULATOR_B_3200_MV          0x68
#define SMARTBUCK4_REGULATOR_B_3300_MV          0x6C
#define SMARTBUCK4_REGULATOR_B_3400_MV          0x70
#define SMARTBUCK4_REGULATOR_B_3500_MV          0x74
#define SMARTBUCK4_REGULATOR_B_3600_MV          0x78
#define SMARTBUCK4_REGULATOR_B_3700_MV          0x7C
 
#define SMARTBUCK4_REGULATOR_B_INC_0_MV         0x00
#define SMARTBUCK4_REGULATOR_B_INC_25_MV        0x01
#define SMARTBUCK4_REGULATOR_B_INC_50_MV        0x02
#define SMARTBUCK4_REGULATOR_B_INC_75_MV        0x03
 
#define SMARTBUCK4_DEVICE_ADDRESS               0x65
 
 // smartbuck4_set
 
#define SMARTBUCK4_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.r40 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.r60 = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // smartbuck4_map
 // smartbuck4
 
typedef struct
{
    // Output pins
    digital_out_t r40;              
    digital_out_t r60;              
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address;          
} smartbuck4_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t r40;             
    pin_name_t r60;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} smartbuck4_cfg_t;
 
typedef enum
{
    SMARTBUCK4_OK = 0,
    SMARTBUCK4_ERROR = -1
 
} smartbuck4_return_value_t;
 
void smartbuck4_cfg_setup ( smartbuck4_cfg_t *cfg );
 
err_t smartbuck4_init ( smartbuck4_t *ctx, smartbuck4_cfg_t *cfg );
 
err_t smartbuck4_default_cfg ( smartbuck4_t *ctx );
 
void smartbuck4_set_r40_out ( smartbuck4_t *ctx, uint8_t out_level );
 
void smartbuck4_en_r40_reg ( smartbuck4_t *ctx );
 
void smartbuck4_dis_r40_reg ( smartbuck4_t *ctx );
 
void smartbuck4_set_r60_out ( smartbuck4_t *ctx, uint8_t out_level );
 
void smartbuck4_en_r60_reg ( smartbuck4_t *ctx );
 
void smartbuck4_dis_r60_reg ( smartbuck4_t *ctx );
 
err_t smartbuck4_send_command ( smartbuck4_t *ctx, uint8_t addr, uint8_t data_in );
 
err_t smartbuck4_disable_regulators ( smartbuck4_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // SMARTBUCK4_H
 
 // smartbuck4
 
// ------------------------------------------------------------------------ END