digipot8.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 DIGIPOT8_H
#define DIGIPOT8_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 "drv_analog_in.h"
 
#define DIGIPOT8_REG_RDAC1 0x00
#define DIGIPOT8_REG_RDAC2 0x01
#define DIGIPOT8_REG_RDAC3 0x02
#define DIGIPOT8_REG_RDAC4 0x03
#define DIGIPOT8_REG_RDAC5 0x04
#define DIGIPOT8_REG_RDAC6 0x05
 
 // digipot8_reg
 
#define DIGIPOT8_WIPER_POSITION_MIN 0x00
#define DIGIPOT8_WIPER_POSITION_MAX 0xFF
 
 // digipot8_set
 
#define DIGIPOT8_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.an_pin  = MIKROBUS( mikrobus, MIKROBUS_AN ); \
 
 // digipot8_map
 // digipot8
 
typedef struct
{
    // Modules
    analog_in_t   adc;                               
    spi_master_t  spi;                               
    float        vref;                               
    pin_name_t  chip_select;                         
} digipot8_t;
 
typedef struct
{
    // Additional gpio pins 
 
    pin_name_t an_pin;                                   
    // Communication gpio pins
 
    pin_name_t  miso;                                    
    pin_name_t  mosi;                                    
    pin_name_t  sck;                                     
    pin_name_t  cs;                                      
    // static variable
 
    analog_in_resolution_t             resolution;       
    float                              vref;             
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} digipot8_cfg_t;
 
typedef enum
{
    DIGIPOT8_OK = 0,
    DIGIPOT8_ERROR = -1
 
} digipot8_return_value_t;
 
void digipot8_cfg_setup ( digipot8_cfg_t *cfg );
 
err_t digipot8_init ( digipot8_t *ctx, digipot8_cfg_t *cfg );
 
err_t digipot8_write_data ( digipot8_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t digipot8_set_wiper_1 ( digipot8_t *ctx, uint8_t data_in );
 
err_t digipot8_set_wiper_2 ( digipot8_t *ctx, uint8_t data_in );
 
err_t digipot8_set_wiper_3 ( digipot8_t *ctx, uint8_t data_in );
 
err_t digipot8_set_wiper_4 ( digipot8_t *ctx, uint8_t data_in );
 
err_t digipot8_set_wiper_5 ( digipot8_t *ctx, uint8_t data_in );
 
err_t digipot8_set_wiper_6 ( digipot8_t *ctx, uint8_t data_in );
 
uint16_t digipot8_generic_read ( digipot8_t *ctx );
 
float digipot8_read_voltage ( digipot8_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // DIGIPOT8_H
 
 // digipot8
 
// ------------------------------------------------------------------------ END