stepdown10.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 STEPDOWN10_H
#define STEPDOWN10_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 STEPDOWN10_PFM_PWM_MODE                  0x00
#define STEPDOWN10_FORCED_PWM_MODE               0x01
#define STEPDOWN10_R1_RPROG_ADDRESS              0x00
 
 // stepdown10_reg
 
#define STEPDOWN10_R1_VALUE                      100000ul
#define STEPDOWN10_DIGIPOT_MAX_VALUE             100000ul
#define STEPDOWN10_DIGIPOT_RESOLUTION            257
#define STEPDOWN10_ROUND_TO_NEAREST_INT          0.5
#define STEPDOWN10_R13_VALUE                     1000u
#define STEPDOWN10_MAX_OUTPUT                    20
#define STEPDOWN10_MIN_OUTPUT                    2
 
#define STEPDOWN10_PIN_STATE_HIGH                   0x01
#define STEPDOWN10_PIN_STATE_LOW                    0x00
 
#define STEPDOWN10_ADDR_A2A1A0_000                  0x28
#define STEPDOWN10_ADDR_A2A1A0_001                  0x29
#define STEPDOWN10_ADDR_A2A1A0_010                  0x2A
#define STEPDOWN10_ADDR_A2A1A0_011                  0x2B
#define STEPDOWN10_ADDR_A2A1A0_100                  0x2C
#define STEPDOWN10_ADDR_A2A1A0_101                  0x2D
#define STEPDOWN10_ADDR_A2A1A0_110                  0x2E
#define STEPDOWN10_ADDR_A2A1A0_111                  0x2F
 
 // stepdown10_set
 
#define STEPDOWN10_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.md = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.pg = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // stepdown10_map
 // stepdown10
 
typedef struct
{
    // Output pins
    digital_out_t en;       
    digital_out_t md;       
    // Input pins
    digital_in_t pg;        
    // Modules
    i2c_master_t i2c;       
    // I2C slave address
    uint8_t slave_address;  
} stepdown10_t;
 
typedef struct
{
    pin_name_t scl;         
    pin_name_t sda;         
    pin_name_t en;          
    pin_name_t md;          
    pin_name_t pg;          
    uint32_t   i2c_speed;   
    uint8_t    i2c_address; 
} stepdown10_cfg_t;
 
typedef enum
{
    STEPDOWN10_OK = 0,
    STEPDOWN10_ERROR = -1
 
} stepdown10_return_value_t;
 
void stepdown10_cfg_setup ( stepdown10_cfg_t *cfg );
 
err_t stepdown10_init ( stepdown10_t *ctx, stepdown10_cfg_t *cfg );
 
err_t stepdown10_default_cfg ( stepdown10_t *ctx );
 
err_t stepdown10_generic_write ( stepdown10_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t stepdown10_generic_read ( stepdown10_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void stepdown10_set_en_pin ( stepdown10_t *ctx, uint8_t pin_state );
 
void stepdown10_set_md ( stepdown10_t *ctx, uint8_t mode );
 
uint8_t stepdown10_get_pg_state ( stepdown10_t *ctx );
 
err_t stepdown10_set_wiper_pos ( stepdown10_t *ctx, uint16_t wiper_pos );
 
err_t stepdown10_set_r2_resistance ( stepdown10_t *ctx, uint32_t resistance );
 
err_t stepdown10_set_output ( stepdown10_t *ctx, float voltage );
 
#ifdef __cplusplus
}
#endif
#endif // STEPDOWN10_H
 
 // stepdown10
 
// ------------------------------------------------------------------------ END