pac1944.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 PAC1944_H
#define PAC1944_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 PAC1944_REG_REFRESH                           0x00
#define PAC1944_REG_CTRL                              0x01
#define PAC1944_REG_ACC_COUNT                         0x02
#define PAC1944_REG_VACC_CH1                          0x03
#define PAC1944_REG_VACC_CH2                          0x04
#define PAC1944_REG_VACC_CH3                          0x05
#define PAC1944_REG_VACC_CH4                          0x06
#define PAC1944_REG_VBUS_CH1                          0x07
#define PAC1944_REG_VBUS_CH2                          0x08
#define PAC1944_REG_VBUS_CH3                          0x09
#define PAC1944_REG_VBUS_CH4                          0x0A
#define PAC1944_REG_VSENSE_CH1                        0x0B
#define PAC1944_REG_VSENSE_CH2                        0x0C
#define PAC1944_REG_VSENSE_CH3                        0x0D
#define PAC1944_REG_VSENSE_CH4                        0x0E
#define PAC1944_REG_VBUS_CH1_AVG                      0x0F
#define PAC1944_REG_VBUS_CH2_AVG                      0x10
#define PAC1944_REG_VBUS_CH3_AVG                      0x11
#define PAC1944_REG_VBUS_CH4_AVG                      0x12
#define PAC1944_REG_VSENSE_CH1_AVG                    0x13
#define PAC1944_REG_VSENSE_CH2_AVG                    0x14
#define PAC1944_REG_VSENSE_CH3_AVG                    0x15
#define PAC1944_REG_VSENSE_CH4_AVG                    0x16
#define PAC1944_REG_VPOWER_CH1                        0x17
#define PAC1944_REG_VPOWER_CH2                        0x18
#define PAC1944_REG_VPOWER_CH3                        0x19
#define PAC1944_REG_VPOWER_CH4                        0x1A
#define PAC1944_REG_SMBUS_CFG                         0x1C
#define PAC1944_REG_NEG_PWR_FSR                       0x1D
#define PAC1944_REG_REFRESH_G                         0x1E
#define PAC1944_REG_REFRESH_V                         0x1F
#define PAC1944_REG_SLOW                              0x20
#define PAC1944_REG_CTRL_ACT                          0x21
#define PAC1944_REG_NEG_PWR_FSR_ACT                   0x22
#define PAC1944_REG_CTRL_LAT                          0x23
#define PAC1944_REG_NEG_PWR_FSR_LAT                   0x24
#define PAC1944_REG_ACC_CFG                           0x25
#define PAC1944_REG_ALERT_STATUS                      0x26
#define PAC1944_REG_SLOW_ALERT1                       0x27
#define PAC1944_REG_GPIO_ALERT2                       0x28
#define PAC1944_REG_ACC_FULLNESS_LIM                  0x29
#define PAC1944_REG_OC_LIM_CH1                        0x30
#define PAC1944_REG_OC_LIM_CH2                        0x31
#define PAC1944_REG_OC_LIM_CH3                        0x32
#define PAC1944_REG_OC_LIM_CH4                        0x33
#define PAC1944_REG_UC_LIM_CH1                        0x34
#define PAC1944_REG_UC_LIM_CH2                        0x35
#define PAC1944_REG_UC_LIM_CH3                        0x36
#define PAC1944_REG_UC_LIM_CH4                        0x37
#define PAC1944_REG_OP_LIM_CH1                        0x38
#define PAC1944_REG_OP_LIM_CH2                        0x39
#define PAC1944_REG_OP_LIM_CH3                        0x3A
#define PAC1944_REG_OP_LIM_CH4                        0x3B
#define PAC1944_REG_OV_LIM_CH1                        0x3C
#define PAC1944_REG_OV_LIM_CH2                        0x3D
#define PAC1944_REG_OV_LIM_CH3                        0x3E
#define PAC1944_REG_OV_LIM_CH4                        0x3F
#define PAC1944_REG_UV_LIM_CH1                        0x40
#define PAC1944_REG_UV_LIM_CH2                        0x41
#define PAC1944_REG_UV_LIM_CH3                        0x42
#define PAC1944_REG_UV_LIM_CH4                        0x43
#define PAC1944_REG_OC_LIM_NSAMPLES                   0x44
#define PAC1944_REG_UC_LIM_NSAMPLES                   0x45
#define PAC1944_REG_OP_LIM_NSAMPLES                   0x46
#define PAC1944_REG_OV_LIM_NSAMPLES                   0x47
#define PAC1944_REG_UV_LIM_NSAMPLES                   0x48
#define PAC1944_REG_ALERT_ENABLE                      0x49
#define PAC1944_REG_ACC_CFG_ACT                       0x4A
#define PAC1944_REG_ACC_CFG_LAT                       0x4B
#define PAC1944_REG_ID_PRODUCT                        0xFD
#define PAC1944_REG_ID_MANUFACTURER                   0xFE
#define PAC1944_REG_ID_REVISION                       0xFF
 
 // pac1944_reg
 
#define PAC1944_MEAS_SEL_V_SOURCE                     0
#define PAC1944_MEAS_SEL_I_SENSE                      1
#define PAC1944_MEAS_SEL_P_SENSE                      2
 
 // meas_sel
 
#define PAC1944_CH_SEL_CH_1                           1
#define PAC1944_CH_SEL_CH_2                           2
#define PAC1944_CH_SEL_CH_3                           3
#define PAC1944_CH_SEL_CH_4                           4
 
 // ch_sel
 
#define PAC1944_AVG_SEL_DISABLE                       0
#define PAC1944_AVG_SEL_ENABLE                        1
 
 // avg_sel
 
#define PAC1944_MEAS_MODE_UNIPOLAR_FSR                0
#define PAC1944_MEAS_MODE_BIPOLAR_FSR                 1
#define PAC1944_MEAS_MODE_BIPOLAR_HALF_FSR            2
 
 // meas_mode
 
#define PAC1944_SLOW_STATE_ON                         1
#define PAC1944_SLOW_STATE_OFF                        0
 
#define PAC1944_DEV_ENABLE                            1
#define PAC1944_DEV_PWR_DWN                           0
 
#define PAC1944_ALERT_ACTIVE                          0
#define PAC1944_ALERT_INACTIVE                        1
 
 // state
 
#define PAC1944_CTRLH_SPS_1024_ADAPT_ACC              0x00
#define PAC1944_CTRLH_SPS_256_ADAPT_ACC               0x10
#define PAC1944_CTRLH_SPS_64_ADAPT_ACC                0x20
#define PAC1944_CTRLH_SPS_8_ADAPT_ACC                 0x30
#define PAC1944_CTRLH_SPS_1024                        0x40
#define PAC1944_CTRLH_SPS_256                         0x50
#define PAC1944_CTRLH_SPS_64                          0x60
#define PAC1944_CTRLH_SPS_8                           0x70
#define PAC1944_CTRLH_SINGLE_SHOT_MODE                0x80
#define PAC1944_CTRLH_SINGLE_SHOT_8X                  0x90
#define PAC1944_CTRLH_FAST_MODE                       0xA0
#define PAC1944_CTRLH_BURST_MODE                      0xB0
#define PAC1944_CTRLH_SLEEP                           0xF0
    
#define PAC1944_CTRLH_INT_PIN_ALERT                   0x00
#define PAC1944_CTRLH_INT_PIN_DIG_IN                  0x04
#define PAC1944_CTRLH_INT_PIN_DIG_OUT                 0x08
#define PAC1944_CTRLH_INT_PIN_SLOW                    0x0C
    
#define PAC1944_CTRLH_SLW_PIN_ALERT                   0x00
#define PAC1944_CTRLH_SLW_PIN_DIG_IN                  0x01
#define PAC1944_CTRLH_SLW_PIN_DIG_OUT                 0x02
#define PAC1944_CTRLH_SLW_PIN_SLOW                    0x03
 
#define PAC1944_CTRLL_CH1_OFF                         0x80
#define PAC1944_CTRLL_CH2_OFF                         0x40
#define PAC1944_CTRLL_CH3_OFF                         0x20
#define PAC1944_CTRLL_CH4_OFF                         0x10
#define PAC1944_CTRLL_ALL_CH_OFF                      0xF0
#define PAC1944_CTRLL_ALL_CH_ON                       0x00
 
#define PAC1944_SMBUS_INT_PIN_MASK                    0x80
#define PAC1944_SMBUS_SLW_PIN_MASK                    0x40
#define PAC1944_SMBUS_ALERT_MASK                      0x20
#define PAC1944_SMBUS_POR_MASK                        0x10
#define PAC1944_SMBUS_TIMEOUT_OFF                     0x00
#define PAC1944_SMBUS_TIMEOUT_ON                      0x08
#define PAC1944_SMBUS_BYTE_COUNT_OFF                  0x00
#define PAC1944_SMBUS_BYTE_COUNT_ON                   0x04
#define PAC1944_SMBUS_AUTO_INC_SKIP_ON                0x00
#define PAC1944_SMBUS_AUTO_INC_SKIP_OFF               0x02
#define PAC1944_SMBUS_I2C_HIGH_SPEED                  0x01
 
#define PAC1944_DEVICE_ADDR_GND                       0x10
#define PAC1944_DEVICE_ADDR_499_OHM                   0x11
#define PAC1944_DEVICE_ADDR_806_OHM                   0x12
#define PAC1944_DEVICE_ADDR_1270_OHM                  0x13
#define PAC1944_DEVICE_ADDR_2050_OHM                  0x14
#define PAC1944_DEVICE_ADDR_3240_OHM                  0x15
#define PAC1944_DEVICE_ADDR_5230_OHM                  0x16
#define PAC1944_DEVICE_ADDR_8450_OHM                  0x17
#define PAC1944_DEVICE_ADDR_13K3_OHM                  0x18
#define PAC1944_DEVICE_ADDR_21K5_OHM                  0x19
#define PAC1944_DEVICE_ADDR_34K_OHM                   0x1A
#define PAC1944_DEVICE_ADDR_54K9_OHM                  0x1B
#define PAC1944_DEVICE_ADDR_88K7_OHM                  0x1C
#define PAC1944_DEVICE_ADDR_140K_OHM                  0x1D
#define PAC1944_DEVICE_ADDR_226K_OHM                  0x1E
#define PAC1944_DEVICE_ADDR_VCC                       0x1F
 
 // pac1944_set
 
#define PAC1944_MAP_MIKROBUS( cfg, mikrobus )     \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_CS );   \
    cfg.slw = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // pac1944_map
 // pac1944
 
typedef struct
{
    // Output pins
 
    digital_out_t  en;                               
    digital_out_t  slw;                              
    // Input pins
 
    digital_in_t   int_pin;                          
    // Modules
 
    i2c_master_t   i2c;                              
    // I2C slave address
 
    uint8_t slave_address;                           
} pac1944_t;
 
typedef struct
{
    pin_name_t  scl;                                 
    pin_name_t  sda;                                 
    pin_name_t  en;                                  
    pin_name_t  slw;                                 
    pin_name_t  int_pin;                             
    uint32_t  i2c_speed;                             
    uint8_t   i2c_address;                           
} pac1944_cfg_t;
 
typedef struct
{
    uint8_t sample_mode;                             
    uint8_t gpio_alert2;                             
    uint8_t slow_alert1;                             
    uint8_t channels_state;                          
    uint8_t cfg_vsense1;                             
    uint8_t cfg_vsense2;                             
    uint8_t cfg_vsense3;                             
    uint8_t cfg_vsense4;                             
    uint8_t cfg_vbus1;                               
    uint8_t cfg_vbus2;                               
    uint8_t cfg_vbus3;                               
    uint8_t cfg_vbus4;                               
} pac1944_setup_t;
 
void pac1944_cfg_setup ( pac1944_cfg_t *cfg );
 
err_t pac1944_init ( pac1944_t *ctx, pac1944_cfg_t *cfg );
 
void pac1944_default_cfg ( pac1944_t *ctx );
 
void pac1944_set_slow_state ( pac1944_t *ctx, uint8_t state );
 
void pac1944_device_state ( pac1944_t *ctx, uint8_t state );
 
uint8_t pac1944_get_alert_state ( pac1944_t *ctx );
 
err_t pac1944_generic_write ( pac1944_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t pac1944_generic_read ( pac1944_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
void pac1944_setup_config ( pac1944_t *ctx, pac1944_setup_t cfg_data );
 
void pac1944_set_address_pointer ( pac1944_t *ctx, uint8_t reg_addr );
 
uint8_t pac1944_read_last_accessed_register ( pac1944_t *ctx );
 
void pac1944_general_refresh_cmd ( pac1944_t *ctx );
 
void pac1944_refresh_cmd ( pac1944_t *ctx );
 
void pac1944_volatile_refresh_cmd ( pac1944_t *ctx );
 
uint32_t pac1944_get_accumulator_count( pac1944_t *ctx );
 
void pac1944_get_accumulator_output( pac1944_t *ctx, uint8_t ch_sel, uint8_t *acc_out );
 
uint32_t pac1944_get_measurement ( pac1944_t *ctx, uint8_t meas_sel, uint8_t ch_sel, uint8_t avg_sel );
 
float pac1944_get_calc_measurement ( pac1944_t *ctx, uint8_t meas_sel, uint8_t ch_sel, uint8_t avg_sel, uint8_t meas_mode );
 
#ifdef __cplusplus
}
#endif
#endif // PAC1944_H
 
 // pac1944
 
// ------------------------------------------------------------------------ END