vcpmonitor4.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 vcpmonitor4_H
#define vcpmonitor4_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"
#include "spi_specifics.h"
 
#define VCPMONITOR4_REG_CONFIG          0x00
#define VCPMONITOR4_REG_ADC_CONFIG      0x01
#define VCPMONITOR4_REG_SHUNT_CAL       0x02
#define VCPMONITOR4_REG_VSHUNT          0x04
#define VCPMONITOR4_REG_VBUS            0x05
#define VCPMONITOR4_REG_DIETEMP         0x06
#define VCPMONITOR4_REG_CURRENT         0x07
#define VCPMONITOR4_REG_POWER           0x08
#define VCPMONITOR4_REG_DIAG_ALERT      0x0B
#define VCPMONITOR4_REG_SOVL            0x0C
#define VCPMONITOR4_REG_SUVL            0x0D
#define VCPMONITOR4_REG_BOVL            0x0E
#define VCPMONITOR4_REG_BUVL            0x0F
#define VCPMONITOR4_REG_TEMP_LIMIT      0x10
#define VCPMONITOR4_REG_PWR_LIMIT       0x11
#define VCPMONITOR4_REG_MANUFACTURER_ID 0x3E
#define VCPMONITOR4_REG_DEVICE_ID       0x3F
 
 // vcpmonitor4_reg
 
#define VCPMONITOR4_CURRENT_LSB         0.000305
 
#define VCPMONITOR4_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define VCPMONITOR4_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // vcpmonitor4_set
 
#define VCPMONITOR4_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.alr = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // vcpmonitor4_map
 // vcpmonitor4
 
typedef struct
{
    // Input pins
    digital_in_t  alr;          
    // Modules
    spi_master_t  spi;          
    pin_name_t  chip_select;    
} vcpmonitor4_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  alr;        
    // static variable
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} vcpmonitor4_cfg_t;
 
typedef enum
{
   vcpmonitor4_OK = 0,
   vcpmonitor4_ERROR = -1
 
} vcpmonitor4_return_value_t;
 
void vcpmonitor4_cfg_setup ( vcpmonitor4_cfg_t *cfg );
 
err_t vcpmonitor4_init ( vcpmonitor4_t *ctx, vcpmonitor4_cfg_t *cfg );
 
err_t vcpmonitor4_default_cfg ( vcpmonitor4_t *ctx );
 
err_t vcpmonitor4_generic_write ( vcpmonitor4_t *ctx, uint8_t reg, uint16_t data_in );
 
err_t vcpmonitor4_generic_read ( vcpmonitor4_t *ctx, uint8_t reg, uint32_t *data_out ) ;
 
uint8_t vcpmonitor4_get_alert ( vcpmonitor4_t *ctx );
 
err_t vcpmonitor4_get_temperature ( vcpmonitor4_t *ctx, float *temperature );
 
err_t vcpmonitor4_get_vbus ( vcpmonitor4_t *ctx, float *vbus );
 
err_t vcpmonitor4_get_vshunt ( vcpmonitor4_t *ctx, float *vshunt );
 
err_t vcpmonitor4_get_current ( vcpmonitor4_t *ctx, float *current );
 
err_t vcpmonitor4_get_power ( vcpmonitor4_t *ctx, float *power );
 
#ifdef __cplusplus
}
#endif
#endif // vcpmonitor4_H
 
 // vcpmonitor4
 
// ------------------------------------------------------------------------ END