buck15.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 BUCK15_H
#define BUCK15_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 BUCK15_INSTR_RDAC_SEL_1           0x00
#define BUCK15_INSTR_RDAC_SEL_2           0x80
 
#define BUCK15_INSTR_RDAC_MIDSCALE_DIS    0x00
#define BUCK15_INSTR_RDAC_MIDSCALE_EN     0x40
 
#define BUCK15_INSTR_RDAC_SHUTDOWN_DIS    0x00
#define BUCK15_INSTR_RDAC_SHUTDOWN_EN     0x20
 
#define BUCK15_INSTR_RDAC_OTUPUT_0        0x00
#define BUCK15_INSTR_RDAC_OTUPUT_1        0x08
#define BUCK15_INSTR_RDAC_OTUPUT_2        0x10
#define BUCK15_INSTR_RDAC_OTUPUT_3        0x18
 
#define BUCK15_VOS_WIPER_POS              255, 175, 128, 128, 128, 199, 105,  \
                                          81, 91, 80, 79, 70, 69, 132, 130,   \
                                          130, 38, 102, 71, 8, 5, 1
 
#define BUCK15_VSET_WIPER_POS             1, 10, 63, 101, 146, 218, 180, 175, \
                                          185, 190, 200, 200, 205, 225, 227,  \
                                          228, 211, 235, 252, 254, 254, 255
 
#define BUCK15_VOUT_TABLE                 0.6f, 0.8f, 1.0f, 1.1f, 1.3f, 1.5f, \
                                          1.8f, 1.9f, 2.0f, 2.2f, 2.5f, 2.6f, \
                                          2.8f, 3.0f, 3.2f, 3.3f, 3.5f, 3.8f, \
                                          4.0f, 4.3f, 4.6f, 5.0f
 
 
#define BUCK15_DEVICE_ADDRESS_GND         0x2C
#define BUCK15_DEVICE_ADDRESS_VCC         0x2D
 
 // buck15_set
 
#define BUCK15_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.en  = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.pg  = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // buck15_map
 // buck15
 
typedef struct
{
    // Output pins
    digital_out_t en;    
    // Input pins
    digital_in_t pg;     
    // Modules
    i2c_master_t i2c;    
    // I2C slave address
    uint8_t slave_address;    
} buck15_t;
 
typedef struct
{
    pin_name_t scl;    
    pin_name_t sda;    
    pin_name_t en;     
    pin_name_t pg;     
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} buck15_cfg_t;
 
typedef enum
{
    BUCK15_OK = 0,
    BUCK15_ERROR = -1
 
} buck15_return_value_t;
 
typedef enum
{
    BUCK15_VOUT_0V6 = 0,
    BUCK15_VOUT_0V8,
    BUCK15_VOUT_1V,
    BUCK15_VOUT_1V1,
    BUCK15_VOUT_1V3,
    BUCK15_VOUT_1V5,
    BUCK15_VOUT_1V8,
    BUCK15_VOUT_1V9,
    BUCK15_VOUT_2V,
    BUCK15_VOUT_2V2,
    BUCK15_VOUT_2V5,
    BUCK15_VOUT_2V6,
    BUCK15_VOUT_2V8,
    BUCK15_VOUT_3V,
    BUCK15_VOUT_3V2,
    BUCK15_VOUT_3V3,
    BUCK15_VOUT_3V5,
    BUCK15_VOUT_3V8,
    BUCK15_VOUT_4V,
    BUCK15_VOUT_4V3,
    BUCK15_VOUT_4V6,
    BUCK15_VOUT_5V,
 
} buck15_vout_t;
 
void buck15_cfg_setup ( buck15_cfg_t *cfg );
 
err_t buck15_init ( buck15_t *ctx, buck15_cfg_t *cfg );
 
err_t buck15_default_cfg ( buck15_t *ctx );
 
void buck15_enable_device ( buck15_t *ctx );
 
void buck15_disable_device ( buck15_t *ctx );
 
uint8_t buck15_get_power_good ( buck15_t *ctx );
 
err_t buck15_generic_write ( buck15_t *ctx, uint8_t instr, uint8_t data_in );
 
err_t buck15_generic_read ( buck15_t *ctx, uint8_t instr, uint8_t *data_out );
 
err_t buck15_set_vset ( buck15_t *ctx, uint8_t vset_wp );
 
err_t buck15_set_vos ( buck15_t *ctx, uint8_t vos_wp );
 
err_t buck15_set_vout ( buck15_t *ctx, buck15_vout_t vout );
 
#ifdef __cplusplus
}
#endif
#endif // BUCK15_H
 
 // buck15
 
// ------------------------------------------------------------------------ END