charger3.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 CHARGER3_H
#define CHARGER3_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 CHARGER3_COMMAND_NOP                                         0x00
#define CHARGER3_COMMAND_WRITE_RDAC                                  0x04
#define CHARGER3_COMMAND_READ_RDAC                                   0x08
#define CHARGER3_COMMAND_STORE_WIPER                                 0x0C
#define CHARGER3_COMMAND_SW_RESET                                    0x10
#define CHARGER3_COMMAND_READ_50TP                                   0x14
#define CHARGER3_COMMAND_READ_MEMORY                                 0x18
#define CHARGER3_COMMAND_WRITE_MEMORY                                0x1C
#define CHARGER3_COMMAND_READ_CONTROL                                0x20
#define CHARGER3_COMMAND_SW_SHUTDOWN                                 0x24
 
 // charger3_command
 
#define CHARGER3_CTRL_REG_BIT_MASK                                   0x0B
#define CHARGER3_FUSE_PROGRAM_SUCCESSFUL                             0x00
#define CHARGER3_FUSE_PROGRAM_UNSUCCESSFUL                           0x08
#define CHARGER3_WIPER_POS_FROZEN                                    0x00
#define CHARGER3_UPDATE_WIPER_POS                                    0x02
#define CHARGER3_50T_PROGRAM_DISABLED                                0x00
#define CHARGER3_50T_PROGRAM_ENABLE                                  0x01
 
#define CHARGER3_SET_DEV_ADDR  0x2F
 
 // charger3_set
 
#define CHARGER3_ENABLE_CHARGING                                     0x00
#define CHARGER3_DISABLE_CHARGING                                    0x01
 
 // mode
 
#define CHARGER3_STATUS_ERROR_SUCCESS                                0x00
#define CHARGER3_STATUS_ERROR_FAILURE                                0x01
 
 // status
 
#define CHARGER3_DUMMY                                               0x00
 
 // charger3_dummy
 
#define CHARGER3_MAP_MIKROBUS( cfg, mikrobus )    \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // charger3_map
 // charger3
 
typedef struct
{
    // Modules
 
    i2c_master_t i2c;                                
    // I2C slave address
 
    uint8_t slave_address;                           
} charger3_t;
 
typedef struct
{
    pin_name_t  scl;                                 
    pin_name_t  sda;                                 
    uint32_t  i2c_speed;                             
    uint8_t   i2c_address;                           
} charger3_cfg_t;
 
void charger3_cfg_setup ( charger3_cfg_t *cfg );
 
err_t charger3_init ( charger3_t *ctx, charger3_cfg_t *cfg );
 
void charger3_default_cfg ( charger3_t *ctx );
 
err_t charger3_generic_write ( charger3_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t charger3_generic_read ( charger3_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
void charger3_enable_write ( charger3_t *ctx );
 
void charger3_operating_mode ( charger3_t *ctx, uint8_t mode );
 
void charger3_write_rdac ( charger3_t *ctx, uint16_t rdac_data );
 
uint8_t charger3_set_digipot_res ( charger3_t *ctx, uint16_t res_ohm );
 
uint8_t charger3_set_current ( charger3_t *ctx, float curr_value );
 
uint16_t charger3_read_rdac ( charger3_t *ctx );
 
float charger3_calc_digipot_res ( charger3_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // CHARGER3_H
 
 // charger3
 
// ------------------------------------------------------------------------ END