efuse3.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 EFUSE3_H
#define EFUSE3_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_spi_master.h"
 
#define EFUSE3_OVERFLOW_LOW             2
#define EFUSE3_OVERFLOW_HIGH            1
#define EFUSE3_NO_OVERFLOW              0
 
 // efuse3_set
 
#define EFUSE3_VC_SEL_6_1_V             0
#define EFUSE3_VC_SEL_6_9_V             1
 
 // vc_sel
 
#define EFUSE3_FLAG_NORMAL_OPERATION    0
#define EFUSE3_FLAG_DEVICE_OFF          1
 
 // efuse3_get
 
#define EFUSE3_MAP_MIKROBUS( cfg, mikrobus )        \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK );  \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS );   \
    cfg.vsel = MIKROBUS( mikrobus, MIKROBUS_RST );  \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM );    \
    cfg.flag = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // efuse3_map
 // efuse3
 
typedef struct
{
    // Output pins
 
    digital_out_t  vsel;      
    digital_out_t  en;        
    // Input pins             
                              
    digital_in_t  flag;       
    // Modules
 
    spi_master_t  spi;        
    pin_name_t  chip_select;  
} efuse3_t;
 
typedef struct
{
    // Communication gpio pins
 
    pin_name_t  miso;         
    pin_name_t  mosi;         
    pin_name_t  sck;          
    pin_name_t  cs;           
    // Additional gpio pins
 
    pin_name_t  vsel;         
    pin_name_t  en;           
    pin_name_t  flag;         
    // static variable
 
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} efuse3_cfg_t;
 
typedef enum
{
    EFUSE3_OK = 0,
    EFUSE3_ERROR = -1
 
} efuse3_return_value_t;
 
void efuse3_cfg_setup ( efuse3_cfg_t *cfg );
 
err_t efuse3_init ( efuse3_t *ctx, efuse3_cfg_t *cfg );
 
void efuse3_default_cfg ( efuse3_t *ctx );
 
err_t efuse3_generic_read ( efuse3_t *ctx, uint8_t *data_out, uint8_t len );
 
err_t efuse3_get_monitor_output ( efuse3_t *ctx, float *voltage, uint8_t *overflow );
 
err_t efuse3_get_current ( efuse3_t *ctx, float *current );
 
void efuse3_enable_device ( efuse3_t *ctx );
 
void efuse3_reset ( efuse3_t *ctx );
 
void efuse3_disable_device ( efuse3_t *ctx );
 
void efuse3_set_overvoltage_clamp ( efuse3_t *ctx, uint8_t vc_sel );
 
uint8_t efuse3_get_flag ( efuse3_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // EFUSE3_H
 
 // efuse3
 
// ------------------------------------------------------------------------ END