stepdown9.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 STEPDOWN9_H
#define STEPDOWN9_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_spi_master.h"
#include "spi_specifics.h"
 
#define STEPDOWN9_VOUT_10V_RESISTANCE           8700 
#define STEPDOWN9_VOUT_9V5_RESISTANCE           11500
#define STEPDOWN9_VOUT_9V_RESISTANCE            11700
#define STEPDOWN9_VOUT_8V5_RESISTANCE           12500
#define STEPDOWN9_VOUT_8V_RESISTANCE            13000
#define STEPDOWN9_VOUT_7V5_RESISTANCE           13700
#define STEPDOWN9_VOUT_7V_RESISTANCE            14700
#define STEPDOWN9_VOUT_6V5_RESISTANCE           15800
#define STEPDOWN9_VOUT_6V_RESISTANCE            17000
#define STEPDOWN9_VOUT_5V5_RESISTANCE           19000
#define STEPDOWN9_VOUT_5V_RESISTANCE            21000 
#define STEPDOWN9_VOUT_4V5_RESISTANCE           23500
#define STEPDOWN9_VOUT_4V_RESISTANCE            27000
#define STEPDOWN9_VOUT_3V5_RESISTANCE           32000
#define STEPDOWN9_VOUT_3V3_RESISTANCE           34000
#define STEPDOWN9_VOUT_3V_RESISTANCE            38000
#define STEPDOWN9_VOUT_2V5_RESISTANCE           50000
#define STEPDOWN9_VOUT_2V_RESISTANCE            70000
#define STEPDOWN9_VOUT_1V6_RESISTANCE           100000 
 
#define STEPDOWN9_VOUT_10V                      0x12
#define STEPDOWN9_VOUT_9V5                      0x11
#define STEPDOWN9_VOUT_9V                       0x10
#define STEPDOWN9_VOUT_8V5                      0x0F
#define STEPDOWN9_VOUT_8V                       0x0E
#define STEPDOWN9_VOUT_7V5                      0x0D
#define STEPDOWN9_VOUT_7V                       0x0C
#define STEPDOWN9_VOUT_6V5                      0x0B
#define STEPDOWN9_VOUT_6V                       0x0A
#define STEPDOWN9_VOUT_5V5                      0x09
#define STEPDOWN9_VOUT_5V                       0x08
#define STEPDOWN9_VOUT_4V5                      0x07
#define STEPDOWN9_VOUT_4V                       0x06
#define STEPDOWN9_VOUT_3V5                      0x05
#define STEPDOWN9_VOUT_3V3                      0x04
#define STEPDOWN9_VOUT_3V                       0x03
#define STEPDOWN9_VOUT_2V5                      0x02
#define STEPDOWN9_VOUT_2V                       0x01
#define STEPDOWN9_VOUT_1V6                      0x00
 
#define STEPDOWN9_PIN_STATE_HIGH                0x01
#define STEPDOWN9_PIN_STATE_LOW                 0x00
 
#define STEPDOWN9_RESISTANCE_MIN                8700
#define STEPDOWN9_FULL_SCALE_RES_100_KOHM       100000
#define STEPDOWN9_WIPER_POS_MAX                 0xFF
#define STEPDOWN9_ROUND_TO_NEAREST_INT          0.5
 
#define STEPDOWN9_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define STEPDOWN9_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // stepdown9_set
 
#define STEPDOWN9_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.pg = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // stepdown9_map
 // stepdown9
 
typedef struct
{
    // Output pins
    digital_out_t en;           
    // Input pins
    digital_in_t pg;            
    // Modules
    spi_master_t spi;           
    pin_name_t   chip_select;   
} stepdown9_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t miso;            
    pin_name_t mosi;            
    pin_name_t sck;             
    pin_name_t cs;              
    // Additional gpio pins
    pin_name_t en;              
    pin_name_t pg;              
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
} stepdown9_cfg_t;
 
typedef enum
{
    STEPDOWN9_OK = 0,
    STEPDOWN9_ERROR = -1
 
} stepdown9_return_value_t;
 
void stepdown9_cfg_setup ( stepdown9_cfg_t *cfg );
 
err_t stepdown9_init ( stepdown9_t *ctx, stepdown9_cfg_t *cfg );
 
err_t stepdown9_default_cfg ( stepdown9_t *ctx );
 
err_t stepdown9_generic_write ( stepdown9_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t stepdown9_generic_read ( stepdown9_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void stepdown9_set_en_pin ( stepdown9_t *ctx, uint8_t pin_state );
 
uint8_t stepdown9_get_pg_pin ( stepdown9_t *ctx );
 
err_t stepdown9_set_wiper_pos ( stepdown9_t *ctx, uint8_t wiper_pos );
 
err_t stepdown9_set_resistance ( stepdown9_t *ctx, uint32_t res_ohm );
 
err_t stepdown9_set_output ( stepdown9_t *ctx, uint8_t voltage );
 
#ifdef __cplusplus
}
#endif
#endif // STEPDOWN9_H
 
 // stepdown9
 
// ------------------------------------------------------------------------ END