buck22.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 BUCK22_H
#define BUCK22_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 BUCK22_REG_VOUT                     0x01
#define BUCK22_REG_CONTROL                  0x03
#define BUCK22_REG_STATUS                   0x05
 
 // buck22_reg
 
#define BUCK22_VOUT_MIN                     800
#define BUCK22_VOUT_MAX                     3350
#define BUCK22_VOLTAGE_FACTOR               2
#define BUCK22_VOUT_RESOLUTION              ( 5 * BUCK22_VOLTAGE_FACTOR )
 
#define BUCK22_CONTROL_RESET                0x80
#define BUCK22_CONTROL_FPWM_VOUT_CHANGE     0x40
#define BUCK22_CONTROL_SOFT_EN              0x20
#define BUCK22_CONTROL_FPWM_EN              0x10
#define BUCK22_CONTROL_DISCHARGE_EN         0x08
#define BUCK22_CONTROL_HICCUP_EN            0x04
#define BUCK22_CONTROL_VRAMP_SPEED_20       0x00
#define BUCK22_CONTROL_VRAMP_SPEED_10       0x01
#define BUCK22_CONTROL_VRAMP_SPEED_5        0x02
#define BUCK22_CONTROL_VRAMP_SPEED_1        0x03
#define BUCK22_CONTROL_VRAMP_SPEED_MASK     0x03
#define BUCK22_CONTROL_DEFAULT_SETTING      ( BUCK22_CONTROL_FPWM_VOUT_CHANGE | \
                                              BUCK22_CONTROL_SOFT_EN | \
                                              BUCK22_CONTROL_DISCHARGE_EN | \
                                              BUCK22_CONTROL_HICCUP_EN | \
                                              BUCK22_CONTROL_VRAMP_SPEED_1 )
 
#define BUCK22_STATUS_THERMAL_WARNING       0x10
#define BUCK22_STATUS_HICCUP                0x08
#define BUCK22_STATUS_UVLO                  0x01
 
#define BUCK22_DEVICE_ADDRESS               0x42
 
 // buck22_set
 
#define BUCK22_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.pg = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // buck22_map
 // buck22
 
typedef struct
{
    // Input pins
    digital_in_t pg;                
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address;          
} buck22_t;
 
typedef struct
{
    pin_name_t scl;                 
    pin_name_t sda;                 
    pin_name_t pg;                  
    uint32_t   i2c_speed;           
    uint8_t    i2c_address;         
} buck22_cfg_t;
 
typedef enum
{
    BUCK22_OK = 0,
    BUCK22_ERROR = -1
 
} buck22_return_value_t;
 
void buck22_cfg_setup ( buck22_cfg_t *cfg );
 
err_t buck22_init ( buck22_t *ctx, buck22_cfg_t *cfg );
 
err_t buck22_set_vout ( buck22_t *ctx, uint16_t vout_mv );
 
err_t buck22_read_vout ( buck22_t *ctx, uint16_t *vout_mv );
 
err_t buck22_set_control ( buck22_t *ctx, uint8_t control );
 
err_t buck22_read_status ( buck22_t *ctx, uint8_t *status );
 
uint8_t buck22_get_pg_pin ( buck22_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // BUCK22_H
 
 // buck22
 
// ------------------------------------------------------------------------ END