digipot12.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 DIGIPOT12_H
#define DIGIPOT12_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_i2c_master.h"
 
#define DIGIPOT12_CTRL_BIT_NOP                       0x00
#define DIGIPOT12_CTRL_BIT_WRITE_RDAC                0x10
#define DIGIPOT12_CTRL_BIT_WRITE_SHIFT_REG           0x20
#define DIGIPOT12_CTRL_BIT_READ                      0x30
#define DIGIPOT12_CTRL_BIT_LIN_RDAC                  0x40
#define DIGIPOT12_CTRL_BIT_6_DB_RDAC                 0x50
#define DIGIPOT12_CTRL_BIT_COPY_LRDAC                0x60
#define DIGIPOT12_CTRL_BIT_COPY_RDAC_EEPROM          0x70
#define DIGIPOT12_CTRL_BIT_WRITE_EEPROM              0x80
#define DIGIPOT12_CTRL_BIT_SCALE                     0x90
#define DIGIPOT12_CTRL_BIT_SW_RST                    0xB0
#define DIGIPOT12_CTRL_BIT_SW_SHDN                   0xC0
#define DIGIPOT12_CTRL_BIT_REG_CTRL                  0xD0
#define DIGIPOT12_CTRL_BIT_MASK                      0xF0
 
 // digipot12_ctrl
 
#define DIGIPOT12_ADDR_BIT_RDAC1                     0x00
#define DIGIPOT12_ADDR_BIT_RDAC2                     0x01
#define DIGIPOT12_ADDR_BIT_ALL_CHANNELS              0x08
 
 // digipot12_addr
 
#define DIGIPOT12_WIPER_SEL_1                        0x00
#define DIGIPOT12_WIPER_SEL_2                        0x01
#define DIGIPOT12_WIPER_SEL_BOTH                     0x08
 
 // digipot12_wiper_sel
 
#define DIGIPOT12_ADDR_BIT_READ_INPUT_REG            0x00
#define DIGIPOT12_ADDR_BIT_READ_EEPROM               0x01
#define DIGIPOT12_ADDR_BIT_READ_CTRL_REG             0x02
#define DIGIPOT12_ADDR_BIT_READ_RDAC                 0x03
#define DIGIPOT12_ADDR_BIT_RDAC_DECR                 0x00
#define DIGIPOT12_ADDR_BIT_RDAC_INCR                 0x01
#define DIGIPOT12_ADDR_BIT_COPY_TO_RDAC              0x00
#define DIGIPOT12_ADDR_BIT_COPY_TO_EEPROM            0x01
#define DIGIPOT12_ADDR_BIT_SCALE_MODE_NORMAL         0x80
#define DIGIPOT12_ADDR_BIT_SCALE_MODE_SHDN           0x81
#define DIGIPOT12_ADDR_BIT_SCALE_EXIT                0x00
#define DIGIPOT12_ADDR_BIT_SCALE_ENTER               0x01
#define DIGIPOT12_ADDR_BIT_SW_SHDN_MODE_NORMAL       0x00
#define DIGIPOT12_ADDR_BIT_SW_SHDN_MODE_SHDN         0x01
 
 
 // digipot12_mask
 
#define DIGIPOT12_CTRL_REG_WIPER_POS_FROZEN          0x00
#define DIGIPOT12_CTRL_REG_UPDATE_WIPER_POS          0x01
#define DIGIPOT12_CTRL_REG_EEPROM_PROGRAM_DISABLE    0x00
#define DIGIPOT12_CTRL_REG_EEPROM_PROGRAM_ENABLE     0x02
#define DIGIPOT12_CTRL_REG_MODE_POTENTIOMETER        0x00
#define DIGIPOT12_CTRL_REG_MODE_LINEAR_GAIN          0x04
#define DIGIPOT12_CTRL_REG_MODE_BURST_DISABLE        0x00
#define DIGIPOT12_CTRL_REG_MODE_BURST_ENABLE         0x08
 
#define DIGIPOT12_WIPER_POS_MAX                      255
#define DIGIPOT12_WIPER_POS_MIN                        0
#define DIGIPOT12_WIPER_POS_MIDDLE                   127
#define DIGIPOT12_RES_10_KOHM                         10
#define DIGIPOT12_RES_0_KOHM                           0
 
#define DIGIPOT12_DEVICE_ADDRESS_0                   0x2F
#define DIGIPOT12_DEVICE_ADDRESS_1                   0x2C
#define DIGIPOT12_DEVICE_ADDRESS_2                   0x23
#define DIGIPOT12_DEVICE_ADDRESS_3                   0x20
 
 // digipot12_set
 
#define DIGIPOT12_MAP_MIKROBUS( cfg, mikrobus )   \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
 
 // digipot12_map
 // digipot12
 
typedef struct
{
    // Output pins
    digital_out_t rst;        
    // Modules
    i2c_master_t i2c;         
    // I2C slave address
    uint8_t slave_address;    
} digipot12_t;
 
typedef struct
{
    pin_name_t scl;    
    pin_name_t sda;    
    pin_name_t rst;    
    uint32_t   i2c_speed;      
    uint8_t    i2c_address;    
} digipot12_cfg_t;
 
typedef enum
{
    DIGIPOT12_OK = 0,
    DIGIPOT12_ERROR = -1
 
} digipot12_return_value_t;
 
void digipot12_cfg_setup ( digipot12_cfg_t *cfg );
 
err_t digipot12_init ( digipot12_t *ctx, digipot12_cfg_t *cfg );
 
err_t digipot12_default_cfg ( digipot12_t *ctx );
 
void digipot12_device_enable ( digipot12_t *ctx );
 
void digipot12_hw_reset ( digipot12_t *ctx );
 
err_t digipot12_write_data ( digipot12_t *ctx, uint8_t ctrl, uint8_t addr, uint8_t data_in );
 
err_t digipot12_read_data ( digipot12_t *ctx, uint8_t addr, uint8_t mask, uint8_t *data_out );
 
err_t digipot12_write_rdac ( digipot12_t *ctx, uint8_t addr, uint8_t data_in );
 
err_t digipot12_read_rdac ( digipot12_t *ctx, uint8_t addr, uint8_t *data_out );
 
err_t digipot12_set_wiper_1 ( digipot12_t *ctx, uint8_t wiper_pos );
 
err_t digipot12_set_wiper_2 ( digipot12_t *ctx, uint8_t wiper_pos );
 
err_t digipot12_set_resistance ( digipot12_t *ctx, uint8_t wiper_sel, float res_kohm );
 
err_t digipot12_get_resistance ( digipot12_t *ctx, uint8_t wiper_sel, float *res_kohm );
 
#ifdef __cplusplus
}
#endif
#endif // DIGIPOT12_H
 
 // digipot12
 
// ------------------------------------------------------------------------ END