digipot7.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 DIGIPOT7_H
#define DIGIPOT7_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 DIGIPOT7_COMMAND_NOP                        0x00
#define DIGIPOT7_COMMAND_WRITE_RDAC                 0x04
#define DIGIPOT7_COMMAND_READ_RDAC                  0x08
#define DIGIPOT7_COMMAND_STORE_WIPER                0x0C
#define DIGIPOT7_COMMAND_SW_RESET                   0x10
#define DIGIPOT7_COMMAND_READ_50TP                  0x14
#define DIGIPOT7_COMMAND_READ_MEMORY                0x18
#define DIGIPOT7_COMMAND_WRITE_MEMORY               0x1C
#define DIGIPOT7_COMMAND_READ_CONTROL               0x20
#define DIGIPOT7_COMMAND_SW_SHUTDOWN                0x24
 
#define DIGIPOT7_SHUTDOWN_BIT_MASK                  0x01
#define DIGIPOT7_NORMAL_MODE                        0x00
#define DIGIPOT7_SHUTDOWN_MODE                      0x01
 
#define DIGIPOT7_CTRL_REG_BIT_MASK                  0x0B
#define DIGIPOT7_FUSE_PROGRAM_SUCCESSFUL            0x00
#define DIGIPOT7_FUSE_PROGRAM_UNSUCCESSFUL          0x08
#define DIGIPOT7_WIPER_POS_FROZEN                   0x00
#define DIGIPOT7_UPDATE_WIPER_POS                   0x02
#define DIGIPOT7_50T_PROGRAM_DISABLED               0x00
#define DIGIPOT7_50T_PROGRAM_ENABLE                 0x01
 
#define DIGIPOT7_10_BIT                           0x03FF
#define DIGIPOT7_DUMMY                            0x0000
 
#define DIGIPOT7_I2C_SLAVE_ADDRESS_GND              0x2F
#define DIGIPOT7_I2C_SLAVE_ADDRESS_VCC              0x2C
#define DIGIPOT7_I2C_SLAVE_ADDRESS_NC               0x2E
 
 // digipot7_set
 
#define DIGIPOT7_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
    
 // digipot7_map
 // digipot7
 
typedef struct
{
    // Output pins
    digital_out_t  rst;     
    // Modules
    i2c_master_t i2c;                                
    // I2C slave address
    uint8_t slave_address;                           
} digipot7_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  rst;       
    uint32_t  i2c_speed;                                
    uint8_t   i2c_address;                              
} digipot7_cfg_t;
 
typedef enum
{
   DIGIPOT7_OK = 0,
   DIGIPOT7_ERROR = -1
 
} digipot7_return_value_t;
 
void digipot7_cfg_setup ( digipot7_cfg_t *cfg );
 
err_t digipot7_init ( digipot7_t *ctx, digipot7_cfg_t *cfg );
 
void digipot7_generic_write ( digipot7_t *ctx, uint8_t cmd, uint16_t data_byte );
 
uint16_t digipot7_generic_read ( digipot7_t *ctx, uint8_t cmd, uint8_t wiper_pos );
 
void digipot7_hw_reset ( digipot7_t *ctx );
 
void digipot7_enable_write ( digipot7_t *ctx );
 
uint16_t digipot7_read_rdac ( digipot7_t *ctx );
 
void digipot7_write_rdac ( digipot7_t *ctx, uint16_t rdac_data );
 
err_t digipot7_set_resistance ( digipot7_t *ctx, uint16_t res_ohm );
 
void digipot7_sw_reset ( digipot7_t *ctx );
 
void digipot7_store_wiper ( digipot7_t *ctx );
 
void digipot7_operating_mode ( digipot7_t *ctx, uint8_t mode );
 
uint16_t digipot7_next_frame_read ( digipot7_t *ctx, uint8_t wiper_location );
 
uint16_t digipot7_read_memory ( digipot7_t *ctx );
 
uint8_t digipot7_read_control ( digipot7_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // DIGIPOT7_H
 
 // digipot7
 
// ------------------------------------------------------------------------ END