efuse4.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 EFUSE4_H
#define EFUSE4_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 EFUSE4_CMD_NOP                        0x00
#define EFUSE4_CMD_WRITE_RDAC                 0x04
#define EFUSE4_CMD_READ_RDAC                  0x08
#define EFUSE4_CMD_STORE_WIPER                0x0C
#define EFUSE4_CMD_SW_RESET                   0x10
#define EFUSE4_CMD_READ_CONTENTS              0x14
#define EFUSE4_CMD_READ_MEMORY                0x18
#define EFUSE4_CMD_WRITE_MEMORY               0x1C
#define EFUSE4_CMD_READ_CTRL                  0x20
#define EFUSE4_CMD_SW_SHUTDOWN                0x24
 
 // efuse4_com
 
#define EFUSE4_SET_SHUTDOWN_BIT_MASK          0x01
#define EFUSE4_SET_NORMAL_MODE                0x00
#define EFUSE4_SET_SHUTDOWN_MODE              0x01
#define EFUSE4_SET_ENABLE_WRITE_MEMORY        0x0002
 
#define EFUSE4_DEVICE_ADDRESS                  0x2F
 
 // efuse4_set
 
#define EFUSE4_MAP_MIKROBUS( cfg, mikrobus )      \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.pgd = MIKROBUS( mikrobus, MIKROBUS_AN );  \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.dsv = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // efuse4_map
 // efuse4
 
typedef struct
{
    // Output pins
    digital_out_t rst;        
    digital_out_t dsv;        
    // Input pins
    digital_in_t pgd;         
    digital_in_t flt;         
    // Modules
    i2c_master_t i2c;         
    // I2C slave address
    uint8_t slave_address;    
} efuse4_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t pgd;             
    pin_name_t rst;             
    pin_name_t dsv;             
    pin_name_t flt;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} efuse4_cfg_t;
 
typedef enum
{
    EFUSE4_OK = 0,
    EFUSE4_ERROR = -1
 
} efuse4_return_value_t;
 
typedef enum
{
    EFUSE4_CURRENT_LIMIT_670_mA = 670,
    EFUSE4_CURRENT_LIMIT_750_mA = 750,
    EFUSE4_CURRENT_LIMIT_990_mA = 990,
    EFUSE4_CURRENT_LIMIT_2080_mA = 2080,
    EFUSE4_CURRENT_LIMIT_3530_mA = 3530,
    EFUSE4_CURRENT_LIMIT_4450_mA = 4450,
    EFUSE4_CURRENT_LIMIT_5200_mA = 5200
 
} efuse4_current_limit_t;
 
void efuse4_cfg_setup ( efuse4_cfg_t *cfg );
 
err_t efuse4_init ( efuse4_t *ctx, efuse4_cfg_t *cfg );
 
err_t efuse4_default_cfg ( efuse4_t *ctx );
 
err_t efuse4_generic_write ( efuse4_t *ctx, uint8_t cmd, uint16_t data_in );
 
err_t efuse4_generic_read ( efuse4_t *ctx, uint8_t cmd, uint16_t data_in, uint16_t *data_out );
 
void efuse4_set_enable ( efuse4_t *ctx );
 
void efuse4_set_disable ( efuse4_t *ctx );
 
void efuse4_set_low_power_mode ( efuse4_t *ctx );
 
void efuse4_set_normal_mode ( efuse4_t *ctx );
 
err_t efuse4_sw_reset ( efuse4_t *ctx );
 
err_t efuse4_enable_write ( efuse4_t *ctx );
 
err_t efuse4_write_rdac ( efuse4_t *ctx, uint16_t data_in );
 
err_t efuse4_read_rdac ( efuse4_t *ctx, uint16_t *data_out );
 
err_t efuse4_digi_pot_op_mode ( efuse4_t *ctx, uint8_t mode );
 
err_t efuse4_store_wiper_pos ( efuse4_t *ctx );
 
err_t efuse4_next_frame_read ( efuse4_t *ctx, uint8_t wiper_location, uint16_t *data_out );
 
err_t efuse4_read_memory ( efuse4_t *ctx, uint16_t *data_out );
 
err_t efuse4_set_digi_pot ( efuse4_t *ctx, uint16_t wiper_pos );
 
err_t efuse4_set_resistance ( efuse4_t *ctx, uint32_t res_ohm );
 
err_t efuse4_set_current_limit ( efuse4_t *ctx, efuse4_current_limit_t current_limit );
 
uint8_t efuse4_fault_state ( efuse4_t *ctx );
 
uint8_t efuse4_pwr_good_state ( efuse4_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // EFUSE4_H
 
 // efuse4
 
// ------------------------------------------------------------------------ END