buck16.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 BUCK16_H
#define BUCK16_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 BUCK16_CMD_VOLATILE_WIPER_0     0x00
#define BUCK16_CMD_NV_WIPER_0           0x20
#define BUCK16_CMD_VOLATILE_TCON        0x40
#define BUCK16_CMD_DATA_EEPROM_1        0x60
#define BUCK16_CMD_DATA_EEPROM_2        0x70
#define BUCK16_CMD_DATA_EEPROM_3        0x80
#define BUCK16_CMD_DATA_EEPROM_4        0x90
#define BUCK16_CMD_DATA_EEPROM_5        0xA0
#define BUCK16_CMD_DATA_EEPROM_6        0xB0
#define BUCK16_CMD_DATA_EEPROM_7        0xC0
#define BUCK16_CMD_DATA_EEPROM_8        0xD0
#define BUCK16_CMD_DATA_EEPROM_9        0xE0
#define BUCK16_CMD_DATA_EEPROM_10       0xF0
 
#define BUCK16_WRITE                    0x00
#define BUCK16_INCREMENT                0x04
#define BUCK16_DECREMENT                0x08
 
 // buck16_reg
 
#define BUCK16_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define BUCK16_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // buck16_set
 
#define BUCK16_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 ); 
 
 // buck16_map
 // buck16
 
typedef struct
{
    // Output pins
    digital_out_t  rst;         
    // Modules
    spi_master_t  spi;          
    pin_name_t  chip_select;    
} buck16_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;    
    // static variable
    uint32_t                           spi_speed;   
    spi_master_mode_t                  spi_mode;    
    spi_master_chip_select_polarity_t  cs_polarity; 
} buck16_cfg_t;
 
typedef enum
{
   BUCK16_OK = 0,
   BUCK16_ERROR = -1
 
} buck16_return_value_t;
 
void buck16_cfg_setup ( buck16_cfg_t *cfg );
 
err_t buck16_init ( buck16_t *ctx, buck16_cfg_t *cfg );
 
err_t buck16_generic_write ( buck16_t *ctx, uint8_t cmd, uint8_t cmd_bits, uint16_t tx_data );
 
void buck16_enable_output ( buck16_t *ctx, uint8_t enable );
 
err_t buck16_set_potentiometer ( buck16_t *ctx, uint16_t rwb );
 
err_t buck16_set_output ( buck16_t *ctx, uint16_t vout );
 
 
#ifdef __cplusplus
}
#endif
#endif // BUCK16_H
 
 // buck16
 
// ------------------------------------------------------------------------ END