digipot.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 DIGIPOT_H
#define DIGIPOT_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_spi_master.h"
 
#define DIGIPOT_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 )
 
 // digipot_map
 
#define DIGIPOT_DATA_EEPROM_6                0x06
#define DIGIPOT_DATA_EEPROM_7                0x07
#define DIGIPOT_DATA_EEPROM_8                0x08
#define DIGIPOT_DATA_EEPROM_9                0x09
#define DIGIPOT_DATA_EEPROM_A                0x0A
#define DIGIPOT_DATA_EEPROM_B                0x0B
#define DIGIPOT_DATA_EEPROM_C                0x0C
#define DIGIPOT_DATA_EEPROM_D                0x0D
#define DIGIPOT_DATA_EEPROM_E                0x0E
#define DIGIPOT_DATA_EEPROM_F                0x0F
#define DIGIPOT_DATA_WRITE_CMD               0x20
 
#define DIGIPOT_VOLATILE_WIPER_0             0x00
#define DIGIPOT_VOLATILE_WIPER_1             0x01
#define DIGIPOT_NON_VOLATILE_WIPER_0         0x02
#define DIGIPOT_NON_VOLATILE_WIPER_1         0x03
#define DIGIPOT_VOLATILE_TCON_REGISTER       0x04
#define DIGIPOT_STATUS_REGISTER              0x05
 
 // digipot_macros
 // digipot
 
typedef struct
{
    // Output pins
    
    digital_out_t cs;
    
    // Modules
    spi_master_t  spi;                               
    pin_name_t  chip_select;                         
} digipot_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t  miso;                                    
    pin_name_t  mosi;                                    
    pin_name_t  sck;                                     
    pin_name_t  cs;                                      
    // static variable
    
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} digipot_cfg_t;
 
typedef enum
{
   DIGIPOT_OK = 0,
   DIGIPOT_ERROR = -1
 
} digipot_return_value_t;
 
void digipot_cfg_setup ( digipot_cfg_t *cfg );
 
err_t digipot_init ( digipot_t *ctx, digipot_cfg_t *cfg );
 
void digipot_generic_transfer ( digipot_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
 
void digipot_set_wiper_positions ( digipot_t *ctx, uint8_t wiper_pos );
 
float digipot_convert_output ( uint16_t adc_val, float v_ref );
 
#ifdef __cplusplus
}
#endif
#endif // DIGIPOT_H
 
 // digipot
 
// ------------------------------------------------------------------------ END