efuse5.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 EFUSE5_H
#define EFUSE5_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 EFUSE5_WRITE_TO_RDAC          0x00
#define EFUSE5_ONE_TIME_PROG          0x80
 
 
 // efuse5_inst
 
#define EFUSE5_OTP_V_READY            0x00
#define EFUSE5_OTP_V_TEST_FUSE_OK     0x40
#define EFUSE5_OTP_V_ERROR            0x80
#define EFUSE5_OTP_V_PROG_SUCCESS     0xC0
 
#define EFUSE5_DEVICE_ADDRESS         0x2C
 
 // efuse5_set
 
#define EFUSE5_MAP_MIKROBUS( cfg, mikrobus )      \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.mon = MIKROBUS( mikrobus, MIKROBUS_AN );  \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST );  \
    cfg.pgd = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // efuse5_map
 // efuse5
 
typedef struct
{
    // Output pins
    digital_out_t en;    
    // Input pins
    digital_in_t mon;    
    digital_in_t pgd;    
    digital_in_t flt;    
    // Modules
    i2c_master_t i2c;    
    // I2C slave address
    uint8_t slave_address;    
} efuse5_t;
 
typedef struct
{
    pin_name_t scl;    
    pin_name_t sda;    
    pin_name_t mon;    
    pin_name_t en;     
    pin_name_t pgd;    
    pin_name_t flt;    
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} efuse5_cfg_t;
 
typedef enum
{
    EFUSE5_CURRENT_LIMIT_600_mA = 600,
    EFUSE5_CURRENT_LIMIT_720_mA = 720,
    EFUSE5_CURRENT_LIMIT_865_mA = 865,
    EFUSE5_CURRENT_LIMIT_900_mA = 900,
    EFUSE5_CURRENT_LIMIT_1030_mA = 1030,
    EFUSE5_CURRENT_LIMIT_1200_mA = 1200,
    EFUSE5_CURRENT_LIMIT_1445_mA = 1445,
    EFUSE5_CURRENT_LIMIT_1550_mA = 1550,
    EFUSE5_CURRENT_LIMIT_2000_mA = 2000,
    EFUSE5_CURRENT_LIMIT_4500_mA = 4500
 
} efuse5_current_limit_t;
 
typedef enum
{
    EFUSE5_OK = 0,
    EFUSE5_ERROR = -1
 
} efuse5_return_value_t;
 
void efuse5_cfg_setup ( efuse5_cfg_t *cfg );
 
err_t efuse5_init ( efuse5_t *ctx, efuse5_cfg_t *cfg );
 
err_t efuse5_default_cfg ( efuse5_t *ctx );
 
err_t efuse5_write_byte ( efuse5_t *ctx, uint8_t inst, uint8_t data_in );
 
err_t efuse5_generic_read ( efuse5_t *ctx, uint8_t *data_out );
 
err_t efuse5_write_rdac ( efuse5_t *ctx, uint8_t rdac_data );
 
err_t efuse5_read_rdac ( efuse5_t *ctx, uint8_t *rdac_data );
 
err_t efuse5_set_digi_pot ( efuse5_t *ctx, uint8_t wiper_pos );
 
err_t efuse5_set_resistance ( efuse5_t *ctx, uint16_t res_ohm );
 
err_t efuse5_set_current_limit ( efuse5_t *ctx, efuse5_current_limit_t current_limit );
 
void efuse5_enable_device ( efuse5_t *ctx );
 
void efuse5_shutdown ( efuse5_t *ctx );
 
uint8_t efuse5_get_imon ( efuse5_t *ctx );
 
uint8_t efuse5_get_pgood ( efuse5_t *ctx );
 
uint8_t efuse5_get_fault ( efuse5_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // EFUSE5_H
 
 // efuse5
 
// ------------------------------------------------------------------------ END