buck20.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 BUCK20_H
#define BUCK20_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 BUCK20_CMD_NOP                      0
#define BUCK20_CMD_RESTORE_EEMEM            1
#define BUCK20_CMD_STORE_RDAC               2
#define BUCK20_CMD_STORE_USER_DATA          3
#define BUCK20_CMD_DECREMENT_6DB            4
#define BUCK20_CMD_DECREMENT_ALL_6DB        5
#define BUCK20_CMD_DECREMENT_ONE_STEP       6
#define BUCK20_CMD_DECREMENT_ALL_ONE_STEP   7
#define BUCK20_CMD_RESET_EEMEM              8
#define BUCK20_CMD_READ_EEMEM               9
#define BUCK20_CMD_READ_RDAC                10
#define BUCK20_CMD_WRITE_DATA               11
#define BUCK20_CMD_INCREMENT_6DB            12
#define BUCK20_CMD_INCREMENT_ALL_6DB        13
#define BUCK20_CMD_INCREMENT_ONE_STEP       14
#define BUCK20_CMD_INCREMENT_ALL_ONE_STEP   15
 
#define BUCK20_ADDRESS_RDAC1                0
#define BUCK20_ADDRESS_RDAC2                1
#define BUCK20_ADDRESS_USER_DATA_0          2
#define BUCK20_ADDRESS_USER_DATA_1          3
#define BUCK20_ADDRESS_USER_DATA_2          4
#define BUCK20_ADDRESS_USER_DATA_3          5
#define BUCK20_ADDRESS_USER_DATA_4          6
#define BUCK20_ADDRESS_USER_DATA_5          7
#define BUCK20_ADDRESS_USER_DATA_6          8
#define BUCK20_ADDRESS_USER_DATA_7          9
#define BUCK20_ADDRESS_USER_DATA_8          10
#define BUCK20_ADDRESS_USER_DATA_9          11
#define BUCK20_ADDRESS_USER_DATA_10         12
#define BUCK20_ADDRESS_USER_DATA_11         13
#define BUCK20_ADDRESS_USER_DATA_12         14
#define BUCK20_ADDRESS_FACTORY_USAGE        15
 
 // buck20_cmd
 
#define BUCK20_WIPER_FULL_SCALE             1023
#define BUCK20_WIPER_MID_SCALE              512
#define BUCK20_WIPER_ZERO_SCALE             0
 
#define BUCK20_RESISTOR_R6_KOHM             47.0f
#define BUCK20_DIGIPOT_MAX_KOHM             250.0f
#define BUCK20_BUCK_R2_KOHM                 40.2f
#define BUCK20_BUCK_VREF                    0.6f
 
#define BUCK20_SET_DATA_SAMPLE_EDGE         SET_SPI_DATA_SAMPLE_EDGE
#define BUCK20_SET_DATA_SAMPLE_MIDDLE       SET_SPI_DATA_SAMPLE_MIDDLE
 
 // buck20_set
 
#define BUCK20_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.rst  = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.rdy  = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // buck20_map
 // buck20
 
typedef struct
{
    // Output pins
    digital_out_t rst;              
    // Input pins
    digital_in_t rdy;               
    // Modules
    spi_master_t spi;               
    pin_name_t   chip_select;       
} buck20_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 rst;                 
    pin_name_t rdy;                 
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
} buck20_cfg_t;
 
typedef enum
{
    BUCK20_OK = 0,
    BUCK20_ERROR = -1
 
} buck20_return_value_t;
 
void buck20_cfg_setup ( buck20_cfg_t *cfg );
 
err_t buck20_init ( buck20_t *ctx, buck20_cfg_t *cfg );
 
err_t buck20_generic_write ( buck20_t *ctx, uint8_t command, uint8_t address, uint16_t data_in );
 
err_t buck20_generic_read ( buck20_t *ctx, uint8_t command, uint8_t address, uint16_t *data_out );
 
err_t buck20_set_wiper_1 ( buck20_t *ctx, uint16_t data_in );
 
err_t buck20_write_user_data ( buck20_t *ctx, uint8_t address, uint16_t data_in );
 
err_t buck20_read_user_data ( buck20_t *ctx, uint8_t address, uint16_t *data_out );
 
uint8_t buck20_get_rdy_pin ( buck20_t *ctx );
 
void buck20_enable_device ( buck20_t *ctx );
 
void buck20_disable_device ( buck20_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // BUCK20_H
 
 // buck20
 
// ------------------------------------------------------------------------ END