efuse2.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2021 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 EFUSE2_H
#define EFUSE2_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 EFUSE2_AD5175_SHUTDOWN_BIT_MASK                             0x01
#define EFUSE2_AD5175_NORMAL_MODE                                   0x00
#define EFUSE2_AD5175_SHUTDOWN_MODE                                 0x01                                          
  
#define EFUSE2_AD5175_CTRL_REG_BIT_MASK                             0x0B
#define EFUSE2_AD5175_FUSE_PROGRAM_SUCCESSFUL                       0x00
#define EFUSE2_AD5175_FUSE_PROGRAM_UNSUCCESSFUL                     0x08
#define EFUSE2_AD5175_WIPER_POS_FROZEN                              0x00
#define EFUSE2_AD5175_UPDATE_WIPER_POS                              0x02
#define EFUSE2_AD5175_50T_PROGRAM_DISABLED                          0x00
#define EFUSE2_AD5175_50T_PROGRAM_ENABLE                            0x01
 
#define EFUSE2_AD5175_COMMAND_NOP                                   0x00
#define EFUSE2_AD5175_COMMAND_WRITE_RDAC                            0x04
#define EFUSE2_AD5175_COMMAND_READ_RDAC                             0x08
#define EFUSE2_AD5175_COMMAND_STORE_WIPER                           0x0C
#define EFUSE2_AD5175_COMMAND_SW_RESET                              0x10
#define EFUSE2_AD5175_COMMAND_READ_50TP                             0x14
#define EFUSE2_AD5175_COMMAND_READ_MEMORY                           0x18
#define EFUSE2_AD5175_COMMAND_WRITE_MEMORY                          0x1C
#define EFUSE2_AD5175_COMMAND_READ_CONTROL                          0x20
#define EFUSE2_AD5175_COMMAND_SW_SHUTDOWN                           0x24  
 
#define EFUSE2_AD5241_RDAC0                                         0x00
#define EFUSE2_AD5241_RDAC1                                         0x80
#define EFUSE2_AD5241_NO_RESET                                      0x00
#define EFUSE2_AD5241_RESET                                         0x40
#define EFUSE2_AD5241_NO_SHUTDOWN                                   0x00
#define EFUSE2_AD5241_SHUTDOWN                                      0x20
#define EFUSE2_AD5241_O1_LOW                                        0x00
#define EFUSE2_AD5241_O1_HIGH                                       0x10
#define EFUSE2_AD5241_O2_LOW                                        0x00
#define EFUSE2_AD5241_O2_HIGH                                       0x08 
 
#define EFUSE2_I2C_SLAVE_ADDRESS_AD5241_0                           0x2C
#define EFUSE2_I2C_SLAVE_ADDRESS_AD5241_1                           0x2D
#define EFUSE2_I2C_SLAVE_ADDRESS_AD5241_2                           0x2E
#define EFUSE2_I2C_SLAVE_ADDRESS_AD5241_3                           0x2F
#define EFUSE2_I2C_SLAVE_ADDRESS_AD5175_GND                         0x2F
#define EFUSE2_I2C_SLAVE_ADDRESS_AD5175_VCC                         0x2C
#define EFUSE2_I2C_SLAVE_ADDRESS_AD5175_NC                          0x2E                                                      
 
#define EFUSE2_FAULT                                                0x00
#define EFUSE2_NO_FAULT                                             0x01
 
#define EFUSE2_10_BIT                                             0x03FF
#define EFUSE2_DUMMY                                              0x0000
 
 
 // efuse2_set
 
#define EFUSE2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // efuse2_map
 // efuse2
 
typedef struct
{
    // Output pins
    digital_out_t  rst;             
    // Input pins
    digital_in_t  flt;              
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address_ad5175;   
    uint8_t slave_address_ad5241;   
} efuse2_t;
 
typedef struct
{
    pin_name_t  scl;                
    pin_name_t  sda;                
    pin_name_t  rst;                
    pin_name_t  flt;                
    uint32_t  i2c_speed;            
    uint8_t   i2c_address_ad5175;   
    uint8_t   i2c_address_ad5241;   
} efuse2_cfg_t;
 
typedef struct
{
    uint8_t select_rdac;
    uint8_t midscale_reset;
    uint8_t active_shutdown;
    uint8_t output_logic_pin_1;
    uint8_t output_logic_pin_2;
    
} ad5241_instru_t;
 
typedef enum
{
   EFUSE2_OK = 0,
   EFUSE2_ERROR = -1
 
} efuse2_return_value_t;
 
void efuse2_cfg_setup ( efuse2_cfg_t *cfg );
 
err_t efuse2_init ( efuse2_t *ctx, efuse2_cfg_t *cfg );
 
err_t efuse2_default_cfg ( efuse2_t *ctx );
 
err_t efuse2_write_ad5241 ( efuse2_t *ctx, ad5241_instru_t cmd, uint8_t data_byte );
 
uint8_t efuse2_read_ad5241 ( efuse2_t *ctx );
 
void efuse2_hw_reset ( efuse2_t *ctx );
 
err_t efuse2_set_operating_voltage ( efuse2_t *ctx, float voltage, float *min_voltage, float *max_voltage );
err_t efuse2_write_ad5175 ( efuse2_t *ctx, uint8_t cmd, uint16_t data_byte );
 
uint16_t efuse2_read_ad5175 ( efuse2_t *ctx, uint8_t cmd, uint8_t wiper_location );
 
uint16_t efuse2_read_rdac ( efuse2_t *ctx );
 
err_t efuse2_enable_write ( efuse2_t *ctx );
 
err_t efuse2_write_rdac ( efuse2_t *ctx, uint16_t data_byte );
 
err_t efuse2_set_current_limit ( efuse2_t *ctx, float current );
 
err_t efuse2_sw_reset ( efuse2_t *ctx );
 
err_t efuse2_store_wiper ( efuse2_t *ctx );
 
err_t efuse2_operating_mode ( efuse2_t *ctx, uint8_t mode );
 
uint16_t efuse2_next_frame_read ( efuse2_t *ctx, uint8_t wiper_location );
 
uint16_t efuse2_read_memory ( efuse2_t *ctx );
 
uint8_t efuse2_read_control ( efuse2_t *ctx );
 
uint8_t efuse2_get_fault ( efuse2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // EFUSE2_H
 
 // efuse2
 
// ------------------------------------------------------------------------ END