stepdown11.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 STEPDOWN11_H
#define STEPDOWN11_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 STEPDOWN11_ADDR_BIT_READ_INPUT_REG              0x00
#define STEPDOWN11_ADDR_BIT_READ_EEPROM                 0x01
#define STEPDOWN11_ADDR_BIT_READ_CTRL_REG               0x02
#define STEPDOWN11_ADDR_BIT_READ_RDAC                   0x03
#define STEPDOWN11_ADDR_BIT_RDAC_DECR                   0x00
#define STEPDOWN11_ADDR_BIT_RDAC_INCR                   0x01
#define STEPDOWN11_ADDR_BIT_COPY_TO_RDAC                0x00
#define STEPDOWN11_ADDR_BIT_COPY_TO_EEPROM              0x01
#define STEPDOWN11_ADDR_BIT_SCALE_MODE_NORMAL           0x80
#define STEPDOWN11_ADDR_BIT_SCALE_MODE_SHDN             0x81
#define STEPDOWN11_ADDR_BIT_SCALE_EXIT                  0x00
#define STEPDOWN11_ADDR_BIT_SCALE_ENTER                 0x01
#define STEPDOWN11_ADDR_BIT_SW_SHDN_MODE_NORMAL         0x00
#define STEPDOWN11_ADDR_BIT_SW_SHDN_MODE_SHDN           0x01
 
 // stepdown11_reg
 
#define STEPDOWN11_CTRL_BIT_NOP                         0x00
#define STEPDOWN11_CTRL_BIT_WRITE_RDAC                  0x10
#define STEPDOWN11_CTRL_BIT_WRITE_SHIFT_REG             0x20
#define STEPDOWN11_CTRL_BIT_READ                        0x30
#define STEPDOWN11_CTRL_BIT_LIN_RDAC                    0x40
#define STEPDOWN11_CTRL_BIT_6_DB_RDAC                   0x50
#define STEPDOWN11_CTRL_BIT_COPY_LRDAC                  0x60
#define STEPDOWN11_CTRL_BIT_COPY_RDAC_EEPROM            0x70
#define STEPDOWN11_CTRL_BIT_WRITE_EEPROM                0x80
#define STEPDOWN11_CTRL_BIT_SCALE                       0x90
#define STEPDOWN11_CTRL_BIT_SW_RST                      0xB0
#define STEPDOWN11_CTRL_BIT_SW_SHDN                     0xC0
#define STEPDOWN11_CTRL_BIT_REG_CTRL                    0xD0
#define STEPDOWN11_CTRL_BIT_MASK                        0xF0
 
#define STEPDOWN11_WIPER_SEL_1                          0x00
#define STEPDOWN11_WIPER_SEL_2                          0x01
#define STEPDOWN11_WIPER_SEL_BOTH                       0x08
 
#define STEPDOWN11_S_CONF_1MHZ_SPREAD_OFF               0
#define STEPDOWN11_S_CONF_2_2MHZ_SPREAD_OFF             4870
#define STEPDOWN11_S_CONF_2_2MHZ_SPREAD_TRIANGLE        6040
#define STEPDOWN11_S_CONF_2_2MHZ_SPREAD_RANDOM          7500
 
#define STEPDOWN11_WIPER_POS_MAX                        255
#define STEPDOWN11_WIPER_POS_MIN                        0
#define STEPDOWN11_WIPER_POS_MIDDLE                     127
#define STEPDOWN11_RES_10_KOHM                          10000
#define STEPDOWN11_RES_0_KOHM                           0
#define STEPDOWN11_R_5_RESISTANCE                       2700
#define STEPDOWN11_R_9_RESISTANCE                       10
#define STEPDOWN11_VFB_VALUE                            0.8f
 
#define STEPDOWN11_ENABLE_OUTPUT                        0x01
#define STEPDOWN11_DISABLE_OUTPUT                       0x00
 
#define STEPDOWN11_DEVICE_ADDRESS_0                     0x2F
#define STEPDOWN11_DEVICE_ADDRESS_1                     0x2C
#define STEPDOWN11_DEVICE_ADDRESS_2                     0x23
#define STEPDOWN11_DEVICE_ADDRESS_3                     0x20
 
 // stepdown11_set
 
#define STEPDOWN11_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.pg = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // stepdown11_map
 // stepdown11
 
typedef struct
{
    // Output pins
    digital_out_t rst;          
    digital_out_t en;           
    // Input pins
    digital_in_t pg;            
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} stepdown11_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t rst;             
    pin_name_t en;              
    pin_name_t pg;              
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} stepdown11_cfg_t;
 
typedef enum
{
    STEPDOWN11_OK = 0,
    STEPDOWN11_ERROR = -1
 
} stepdown11_return_value_t;
 
void stepdown11_cfg_setup ( stepdown11_cfg_t *cfg );
 
err_t stepdown11_init ( stepdown11_t *ctx, stepdown11_cfg_t *cfg );
 
err_t stepdown11_default_cfg ( stepdown11_t *ctx );
 
err_t stepdown11_generic_write ( stepdown11_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t stepdown11_generic_read ( stepdown11_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void stepdown11_set_en_pin ( stepdown11_t *ctx, uint8_t pin_state );
 
uint8_t stepdown11_get_pg_pin ( stepdown11_t *ctx );
 
void stepdown11_reset_digi_pot ( stepdown11_t *ctx );
 
err_t stepdown11_write_data ( stepdown11_t *ctx, uint8_t ctrl, uint8_t addr, uint8_t data_in );
 
err_t stepdown11_read_data ( stepdown11_t *ctx, uint8_t addr, uint8_t mask, uint8_t *data_out );
 
err_t stepdown11_write_rdac ( stepdown11_t *ctx, uint8_t addr, uint8_t data_in );
 
err_t stepdown11_read_rdac ( stepdown11_t *ctx, uint8_t addr, uint8_t *data_out );
 
err_t stepdown11_set_resistance ( stepdown11_t *ctx, uint8_t wiper_sel, float res_kohm );
 
err_t stepdown11_get_resistance ( stepdown11_t *ctx, uint8_t wiper_sel, float *res_kohm );
 
err_t stepdown11_set_voltage ( stepdown11_t *ctx, float v_out );
 
err_t stepdown11_set_mode ( stepdown11_t *ctx, float sconf_mode );
 
#ifdef __cplusplus
}
#endif
#endif // STEPDOWN11_H
 
 // stepdown11
 
// ------------------------------------------------------------------------ END