currentlimit7.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 CURRENTLIMIT7_H
#define CURRENTLIMIT7_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 CURRENTLIMIT7_CMD_NOP                        0x00
#define CURRENTLIMIT7_CMD_WRITE_RDAC                 0x04
#define CURRENTLIMIT7_CMD_READ_RDAC                  0x08
#define CURRENTLIMIT7_CMD_STORE_WIPER                0x0C
#define CURRENTLIMIT7_CMD_SW_RESET                   0x10
#define CURRENTLIMIT7_CMD_READ_CONTENTS              0x14
#define CURRENTLIMIT7_CMD_READ_MEMORY                0x18
#define CURRENTLIMIT7_CMD_WRITE_MEMORY               0x1C
#define CURRENTLIMIT7_CMD_READ_CTRL                  0x20
#define CURRENTLIMIT7_CMD_SW_SHUTDOWN                0x24
 
 // currentlimit7_cmd
 
#define CURRENTLIMIT7_OP_0_CURRENT_LIMIT_260_mA       260
#define CURRENTLIMIT7_OP_0_CURRENT_LIMIT_280_mA       280
#define CURRENTLIMIT7_OP_0_CURRENT_LIMIT_330_mA       330
#define CURRENTLIMIT7_OP_0_CURRENT_LIMIT_450_mA       450
#define CURRENTLIMIT7_OP_0_CURRENT_LIMIT_510_mA       510
#define CURRENTLIMIT7_OP_1_CURRENT_LIMIT_510_mA       510
#define CURRENTLIMIT7_OP_1_CURRENT_LIMIT_625_mA       625
#define CURRENTLIMIT7_OP_1_CURRENT_LIMIT_860_mA       860
#define CURRENTLIMIT7_OP_1_CURRENT_LIMIT_1320_mA     1320
#define CURRENTLIMIT7_OP_1_CURRENT_LIMIT_1450_mA     1450
#define CURRENTLIMIT7_OP_1_CURRENT_LIMIT_1550_mA     1550
#define CURRENTLIMIT7_OP_1_CURRENT_LIMIT_1750_mA     1750
#define CURRENTLIMIT7_OP_1_CURRENT_LIMIT_2020_mA     2020
#define CURRENTLIMIT7_OP_1_CURRENT_LIMIT_2260_mA     2260
#define CURRENTLIMIT7_OP_1_CURRENT_LIMIT_2500_mA     2500
 
#define CURRENTLIMIT7_SET_SHUTDOWN_BIT_MASK          0x01
#define CURRENTLIMIT7_SET_NORMAL_MODE                0x00
#define CURRENTLIMIT7_SET_SHUTDOWN_MODE              0x01
#define CURRENTLIMIT7_SET_ENABLE_WRITE_MEMORY        0x0002
 
#define CURRENTLIMIT7_OP_MODE_500_mA_2500_mA         0x00
#define CURRENTLIMIT7_OP_MODE_250_mA_500_mA          0x01
 
#define CURRENTLIMIT7_SET_DEV_ADDR_0                 0x2E
#define CURRENTLIMIT7_SET_DEV_ADDR_1                 0x2C
 
 // currentlimit7_set
 
#define CURRENTLIMIT7_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL );   \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );   \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS );     \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );   \
    cfg.flg = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // currentlimit7_map
 // currentlimit7
 
typedef struct
{
    // Output pins
    digital_out_t  en;      
    digital_out_t  rst;     
    // Input pins
    digital_in_t  flg;       
    // Modules
    i2c_master_t i2c;        
    // I2C slave address
    uint8_t slave_address;   
} currentlimit7_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  en;         
    pin_name_t  rst;        
    pin_name_t  flg;        
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
} currentlimit7_cfg_t;
 
typedef enum
{
    CURRENTLIMIT7_OK = 0,
    CURRENTLIMIT7_ERROR = -1
 
} currentlimit7_return_value_t;
 
void currentlimit7_cfg_setup ( currentlimit7_cfg_t *cfg );
 
err_t currentlimit7_init ( currentlimit7_t *ctx, currentlimit7_cfg_t *cfg );
 
err_t currentlimit7_default_cfg ( currentlimit7_t *ctx );
 
err_t currentlimit7_set_slave_address ( currentlimit7_t *ctx, uint16_t slave_address );
 
err_t currentlimit7_hw_reset ( currentlimit7_t *ctx );
 
err_t currentlimit7_set_enable ( currentlimit7_t *ctx );
 
err_t currentlimit7_set_disable ( currentlimit7_t *ctx );
 
err_t currentlimit7_generic_write ( currentlimit7_t *ctx, uint8_t cmd, uint16_t data_byte );
 
err_t currentlimit7_generic_read ( currentlimit7_t *ctx, uint8_t cmd, uint16_t data_byte, uint16_t *data_out );
 
err_t currentlimit7_enable_write ( currentlimit7_t *ctx );
 
err_t currentlimit7_write_rdac ( currentlimit7_t *ctx, uint16_t data_in );
 
err_t currentlimit7_read_rdac ( currentlimit7_t *ctx, uint16_t *data_out );
 
err_t currentlimit7_sw_reset ( currentlimit7_t *ctx );
 
err_t currentlimit7_store_wiper ( currentlimit7_t *ctx );
 
err_t currentlimit7_next_frame_read ( currentlimit7_t *ctx, uint8_t wiper_location, uint16_t *data_out );
 
err_t currentlimit7_read_memory ( currentlimit7_t *ctx, uint8_t wiper_location, uint16_t *data_out );
 
err_t currentlimit7_operating_mode ( currentlimit7_t *ctx, uint8_t mode );
 
err_t currentlimit7_set_digi_pot ( currentlimit7_t *ctx, uint16_t wiper_pos );
 
err_t currentlimit7_set_resistance ( currentlimit7_t *ctx, uint32_t res_ohm );
 
err_t currentlimit7_set_current_limit ( currentlimit7_t *ctx, uint8_t op_mode, uint16_t current_limit_ma );
 
uint8_t currentlimit7_get_fault ( currentlimit7_t *ctx );
 
 
 
#ifdef __cplusplus
}
#endif
#endif // CURRENTLIMIT7_H
 
 // currentlimit7
 
// ------------------------------------------------------------------------ END