charger11.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 CHARGER11_H
#define CHARGER11_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"
#include "drv_spi_master.h"
#include "spi_specifics.h"
 
#define CHARGER11_SPI_VOLATILE_WIPER_0       0x00
#define CHARGER11_SPI_VOLATILE_WIPER_1       0x01
#define CHARGER11_SPI_NON_VOLATILE_WIPER_0   0x02
#define CHARGER11_SPI_NON_VOLATILE_WIPER_1   0x03
#define CHARGER11_SPI_VOLATILE_TCON          0x04
#define CHARGER11_SPI_STATUS_REGISTER        0x05
#define CHARGER11_SPI_DATA_EEPROM_0          0x06
#define CHARGER11_SPI_DATA_EEPROM_1          0x07
#define CHARGER11_SPI_DATA_EEPROM_2          0x08
#define CHARGER11_SPI_DATA_EEPROM_3          0x09
#define CHARGER11_SPI_DATA_EEPROM_4          0x0A
#define CHARGER11_SPI_DATA_EEPROM_5          0x0B
#define CHARGER11_SPI_DATA_EEPROM_6          0x0C
#define CHARGER11_SPI_DATA_EEPROM_7          0x0D
#define CHARGER11_SPI_DATA_EEPROM_8          0x0E
#define CHARGER11_SPI_DATA_EEPROM_9          0x0F
 
 // charger11_reg
 
#define CHARGER11_PIN_ENABE                  0x01
#define CHARGER11_PIN_DISABLE                0x00
 
#define CHARGER11_SET_DEV_ADDR  0x4D
 
#define CHARGER11_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define CHARGER11_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // charger11_set
 
#define CHARGER11_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    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.lr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.lg = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.st = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // charger11_map
 // charger11
 
typedef struct charger11_s
{
    digital_out_t  lr;          
    digital_out_t  lg;          
    digital_in_t  st;           
    i2c_master_t  i2c;          
    spi_master_t  spi;          
    uint8_t     slave_address;  
    pin_name_t  chip_select;    
} charger11_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  miso;       
    pin_name_t  mosi;       
    pin_name_t  sck;        
    pin_name_t  cs;         
    pin_name_t  lr;         
    pin_name_t  lg;         
    pin_name_t  st;         
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
    uint32_t                           spi_speed;       
    spi_master_mode_t                  spi_mode;        
    spi_master_chip_select_polarity_t  cs_polarity;     
} charger11_cfg_t;
 
typedef enum
{
   CHARGER11_OK = 0,
   CHARGER11_ERROR = -1
 
} charger11_return_value_t;
 
void charger11_cfg_setup ( charger11_cfg_t *cfg );
 
err_t charger11_init ( charger11_t *ctx, charger11_cfg_t *cfg );
 
err_t charger11_i2c_write ( charger11_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t charger11_i2c_read ( charger11_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t charger11_spi_write ( charger11_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t charger11_spi_read ( charger11_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
uint8_t charger11_get_int( charger11_t *ctx );
 
void charger11_lr_set( charger11_t *ctx, uint8_t pin_state );
 
void charger11_lg_set( charger11_t *ctx, uint8_t pin_state );
 
void charger11_spi_transfer( charger11_t *ctx, uint8_t *data_in, uint8_t *data_out, 
                             uint8_t len );
 
void charger11_spi_set_register( charger11_t *ctx, uint8_t register_address, 
                                 uint16_t register_value );
 
void charger11_spi_get_register( charger11_t *ctx, uint8_t register_address, 
                                 uint16_t * register_value );
 
void charger11_spi_increment_wiper( charger11_t *ctx );
 
void charger11_spi_decrement_wiper( charger11_t *ctx );
 
uint8_t charger11_spi_get_wiper_position( charger11_t *ctx );
 
uint16_t charger11_i2c_get_raw_data( charger11_t *ctx );
 
float charger11_i2c_get_volt( charger11_t *ctx, float reference_voltage );
 
#ifdef __cplusplus
}
#endif
#endif // CHARGER11_H
 
 // charger11
 
// ------------------------------------------------------------------------ END