ina228.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdbool.h>
#include <stdint.h>
 
#include "sense_bus.h"
 
#ifdef __cplusplus
extern "C" {
#endif

enum {
    INA228_CONFIG       = 0x00,   
    INA228_ADC_CONFIG   = 0x01,   
    INA228_SHUNT_CAL    = 0x02,   
    INA228_SHUNT_TEMPCO = 0x03,   
    INA228_VSHUNT       = 0x04,   
    INA228_VBUS         = 0x05,   
    INA228_DIETEMP      = 0x06,   
    INA228_CURRENT      = 0x07,   
    INA228_POWER        = 0x08,   
    INA228_ENERGY       = 0x09,   
    INA228_CHARGE       = 0x0A,   
    INA228_DIAG_ALRT    = 0x0B,   
    INA228_MANUFACTURER = 0x3E,   
    INA228_DEVICE_ID    = 0x3F,   
};
 
#define INA228_MAKER_ID      0x5449u   
#define INA228_DIE_ID         0x228u   
#define INA228_ADDR_MIN        0x40u   
#define INA228_ADDR_MAX        0x4Fu   
#define INA228_FS_MA_LIMIT 2000000u
#define INA228_SHUNT_CAL_ADC 4096u

#define INA228_CONFIG_RST      0x8000u
#define INA228_CONFIG_RSTACC   0x4000u
#define INA228_CONFIG_TEMPCOMP 0x0020u
#define INA228_CONFIG_ADCRANGE 0x0010u

#define INA228_DIAG_ALATCH    0x8000u   
#define INA228_DIAG_CNVR      0x4000u   
#define INA228_DIAG_SLOWALERT 0x2000u   
#define INA228_DIAG_APOL      0x1000u   
#define INA228_DIAG_ENERGYOF  0x0800u   
#define INA228_DIAG_CHARGEOF  0x0400u   
#define INA228_DIAG_MATHOF    0x0200u   
#define INA228_DIAG_TMPOL     0x0080u   
#define INA228_DIAG_SHNTOL    0x0040u   
#define INA228_DIAG_SHNTUL    0x0020u   
#define INA228_DIAG_BUSOL     0x0010u   
#define INA228_DIAG_BUSUL     0x0008u   
#define INA228_DIAG_POL       0x0004u   
#define INA228_DIAG_CNVRF     0x0002u   
#define INA228_DIAG_MEMSTAT   0x0001u   

enum {
    INA228_MODE_SHUTDOWN   = 0x0,
    INA228_MODE_CONT_BUS   = 0x9,
    INA228_MODE_CONT_SHUNT = 0xA,
    INA228_MODE_CONT_VI    = 0xB,
    INA228_MODE_CONT_ALL   = 0xF,   
};

#define INA228_ADC_BENCH 0xF900u

#define INA228_ADC_RESET 0xFB68u

uint16_t ina228_adc_config(uint8_t mode, uint8_t vbusct, uint8_t vshct,
                           uint8_t vtct, uint8_t avg);

uint32_t ina228_averages(uint8_t code);

uint32_t ina228_cycle_us(uint16_t adc_config);

bool ina228_identity_ok(uint16_t maker, uint16_t device);
 
/* ------------------------------------------------------- calibration */
 
typedef enum {
    INA228_SETUP_OK = 0,
    INA228_SETUP_BAD_ADDR,     
    INA228_SETUP_NO_SHUNT,     
    INA228_SETUP_NO_MAX,       
    INA228_SETUP_OVER_RANGE,   
} ina228_setup_err_t;

typedef struct {
    uint32_t shunt_uohm;   
    uint32_t max_ma;       
    uint16_t shunt_cal;    
    uint8_t  adcrange;     
} ina228_cal_t;

ina228_setup_err_t ina228_calibrate(uint32_t shunt_uohm, uint32_t max_ma,
                                    ina228_cal_t *out);
 
/* ------------------------------------------------------------ decoding */

int32_t ina228_code20(uint32_t raw24);

sense_value_t ina228_current_ua(const ina228_cal_t *cal, int32_t code);

sense_value_t ina228_vshunt_nv(const ina228_cal_t *cal, int32_t code);

int32_t ina228_vbus_uv(int32_t code);

int32_t ina228_dietemp_mdegc(uint16_t raw);

uint64_t ina228_power_uw(const ina228_cal_t *cal, uint32_t raw24);

uint64_t ina228_energy_mj(const ina228_cal_t *cal, uint64_t raw40);

int64_t ina228_charge_uc(const ina228_cal_t *cal, uint64_t raw40);
 
/* -------------------------------------------------------------- driver */
 
typedef struct {
    sense_part_t part;
    ina228_cal_t cal;
    uint16_t     config;       
    uint16_t     adc_config;   
} ina228_t;

ina228_setup_err_t ina228_init(ina228_t *d, sense_bus_t *bus, uint8_t addr,
                               uint32_t shunt_uohm, uint32_t max_ma,
                               uint16_t adc_config);

bool ina228_step(ina228_t *d, uint32_t now_ms);

sense_state_t ina228_state(const ina228_t *d);

sense_err_t ina228_read_current(ina228_t *d, sense_value_t *ua);
sense_err_t ina228_read_vshunt(ina228_t *d, sense_value_t *nv);
sense_err_t ina228_read_vbus(ina228_t *d, int32_t *uv);
sense_err_t ina228_read_power(ina228_t *d, uint64_t *uw);
sense_err_t ina228_read_dietemp(ina228_t *d, int32_t *mdegc);
sense_err_t ina228_read_diag(ina228_t *d, uint16_t *diag);
sense_err_t ina228_read_energy(ina228_t *d, uint64_t *mj);
sense_err_t ina228_read_charge(ina228_t *d, int64_t *uc);

sense_err_t ina228_clear_totals(ina228_t *d);

sense_err_t ina228_verify(ina228_t *d, bool *lost);
 
#ifdef __cplusplus
}
#endif