buck19.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 BUCK19_H
#define BUCK19_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 BUCK19_REG_VOUT                 0x00
#define BUCK19_REG_ILIMIT               0x01
#define BUCK19_REG_INT_STATUS           0x02
#define BUCK19_REG_INT_LATCH            0x03
#define BUCK19_REG_INT_MASK             0x04
#define BUCK19_REG_CONFIG_0             0x05
#define BUCK19_REG_CONFIG_1             0x06
 
 // buck19_reg
 
#define BUCK19_VOUT_MIN                 3.0f
#define BUCK19_VOUT_MAX                 20.0f
#define BUCK19_VOUT_DEFAULT             5.0f
#define BUCK19_VOUT_11V                 11.0f
#define BUCK19_VOUT_11V_STEP            0.2f
#define BUCK19_VOUT_5p9V                5.9f
#define BUCK19_VOUT_5p9V_STEP           0.1f
#define BUCK19_VOUT_STEP                0.02f
#define BUCK19_FLOAT_COMPARE_TOLERANCE  0.0001f
 
#define BUCK19_ILIMIT_MIN               100
#define BUCK19_ILIMIT_MAX               3000
#define BUCK19_ILIMIT_STEP              100
#define BUCK19_ILIMIT_DEFAULT           500
 
#define BUCK19_INT_INDUCTOR_PCP         0x80
#define BUCK19_INT_OT_WARNING           0x40
#define BUCK19_INT_OT_PROTECT           0x20
#define BUCK19_INT_WATCHDOG             0x10
#define BUCK19_INT_POWER_ON             0x08
#define BUCK19_INT_SHORT_PROTECT        0x04
#define BUCK19_INT_CC_FUNCTION          0x02
#define BUCK19_INT_OV_PROTECT           0x01
#define BUCK19_INT_DISABLE_ALL          0x00
 
#define BUCK19_CONFIG_0_WATCHDOG_100MS  0x00
#define BUCK19_CONFIG_0_WATCHDOG_500MS  0x40
#define BUCK19_CONFIG_0_WATCHDOG_1S     0x80
#define BUCK19_CONFIG_0_WATCHDOG_5S     0xC0
#define BUCK19_CONFIG_0_CDC_OFF         0x00
#define BUCK19_CONFIG_0_CDC_FULL        0x10
#define BUCK19_CONFIG_0_SW_FREQ_500KHZ  0x00
#define BUCK19_CONFIG_0_SW_FREQ_750KHZ  0x04
#define BUCK19_CONFIG_0_DITHERING_OFF   0x00
#define BUCK19_CONFIG_0_DITHERING_ON    0x02
#define BUCK19_CONFIG_0_DISCHARGE_OFF   0x00
#define BUCK19_CONFIG_0_DISCHARGE_ON    0x01
 
#define BUCK19_CONFIG_1_WATCHDOG_EN_OFF 0x00
#define BUCK19_CONFIG_1_WATCHDOG_EN_ON  0x02
#define BUCK19_CONFIG_1_DIG_EN_OFF      0x00
#define BUCK19_CONFIG_1_DIG_EN_ON       0x01
 
#define BUCK19_DEVICE_ADDRESS_VCC       0x04
#define BUCK19_DEVICE_ADDRESS_GND       0x05
#define BUCK19_DEVICE_ADDRESS_SDA       0x06
#define BUCK19_DEVICE_ADDRESS_SCL       0x07
 
 // buck19_set
 
#define BUCK19_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.pon = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // buck19_map
 // buck19
 
typedef struct
{
    // Output pins
    digital_out_t en;           
    // Input pins
    digital_in_t pon;           
    digital_in_t int_pin;       
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} buck19_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t pon;             
    pin_name_t en;              
    pin_name_t int_pin;         
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} buck19_cfg_t;
 
typedef enum
{
    BUCK19_OK = 0,
    BUCK19_ERROR = -1
 
} buck19_return_value_t;
 
void buck19_cfg_setup ( buck19_cfg_t *cfg );
 
err_t buck19_init ( buck19_t *ctx, buck19_cfg_t *cfg );
 
err_t buck19_default_cfg ( buck19_t *ctx );
 
err_t buck19_write_register ( buck19_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t buck19_read_register ( buck19_t *ctx, uint8_t reg, uint8_t *data_out );
 
void buck19_enable_device ( buck19_t *ctx );
 
void buck19_disable_device ( buck19_t *ctx );
 
uint8_t buck19_get_pon_pin ( buck19_t *ctx );
 
uint8_t buck19_get_int_pin ( buck19_t *ctx );
 
err_t buck19_set_vout ( buck19_t *ctx, float vout );
 
err_t buck19_set_ilimit ( buck19_t *ctx, uint16_t ilimit );
 
#ifdef __cplusplus
}
#endif
#endif // BUCK19_H
 
 // buck19
 
// ------------------------------------------------------------------------ END