stepdown8.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 STEPDOWN8_H
#define STEPDOWN8_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 STEPDOWN8_PFM_PWM_MODE                  0x00
#define STEPDOWN8_FORCED_PWM_MODE               0x01
#define STEPDOWN8_R1_RPROG_ADDRESS              0x00
 
 // stepdown8_reg
 
#define STEPDOWN8_R1_VALUE                      200000ul
#define STEPDOWN8_DIGIPOT_MAX_VALUE             100000ul
#define STEPDOWN8_DIGIPOT_RESOLUTION            257
#define STEPDOWN8_ROUND_TO_NEAREST_INT          0.5
#define STEPDOWN8_R10_VALUE                     10000u
#define STEPDOWN8_MAX_OUTPUT                    18
#define STEPDOWN8_MIN_OUTPUT                    3
 
#define STEPDOWN8_PIN_STATE_HIGH                0x01
#define STEPDOWN8_PIN_STATE_LOW                 0x00
 
#define STEPDOWN8_ADDR_A2A1A0_000               0x28
#define STEPDOWN8_ADDR_A2A1A0_001               0x29
#define STEPDOWN8_ADDR_A2A1A0_010               0x2A
#define STEPDOWN8_ADDR_A2A1A0_011               0x2B
#define STEPDOWN8_ADDR_A2A1A0_100               0x2C
#define STEPDOWN8_ADDR_A2A1A0_101               0x2D
#define STEPDOWN8_ADDR_A2A1A0_110               0x2E
#define STEPDOWN8_ADDR_A2A1A0_111               0x2F
 
 // stepdown8_set
 
#define STEPDOWN8_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.sps = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.pg = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // stepdown8_map
 // stepdown8
 
typedef struct
{
    // Output pins
    digital_out_t en;           
    digital_out_t sps;          
    // Input pins
    digital_in_t pg;            
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} stepdown8_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t en;              
    pin_name_t sps;             
    pin_name_t pg;              
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} stepdown8_cfg_t;
 
typedef enum
{
    STEPDOWN8_OK = 0,
    STEPDOWN8_ERROR = -1
 
} stepdown8_return_value_t;
 
void stepdown8_cfg_setup ( stepdown8_cfg_t *cfg );
 
err_t stepdown8_init ( stepdown8_t *ctx, stepdown8_cfg_t *cfg );
 
err_t stepdown8_default_cfg ( stepdown8_t *ctx );
 
void stepdown8_set_en_pin ( stepdown8_t *ctx, uint8_t pin_state );
 
void stepdown8_set_sps_pin ( stepdown8_t *ctx, uint8_t pin_state );
 
uint8_t stepdown8_get_pg_state ( stepdown8_t *ctx );
 
err_t stepdown8_set_wiper_pos ( stepdown8_t *ctx, uint16_t wiper_pos );
 
err_t stepdown8_set_r2_resistance ( stepdown8_t *ctx, uint32_t resistance );
 
err_t stepdown8_set_output ( stepdown8_t *ctx, float voltage );
 
#ifdef __cplusplus
}
#endif
#endif // STEPDOWN8_H
 
 // stepdown8
 
// ------------------------------------------------------------------------ END