ina3221.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 {
    INA3221_CONFIG       = 0x00,
    INA3221_SHUNT1       = 0x01,   
    INA3221_BUS1         = 0x02,   
    INA3221_MASK_ENABLE  = 0x0F,
    INA3221_MANUFACTURER = 0xFE,
    INA3221_DIE_ID       = 0xFF,
};

#define INA3221_MAKER_ID  0x5449u   
#define INA3221_DIE       0x3220u   
#define INA3221_ADDR_MIN    0x40u   
#define INA3221_ADDR_MAX    0x43u   
#define INA3221_CHANNELS       3u       

#define INA3221_SHUNT_MIN_UOHM 100u

#define INA3221_CONFIG_RST    0x8000u
#define INA3221_CONFIG_CH1EN  0x4000u
#define INA3221_CONFIG_CH2EN  0x2000u
#define INA3221_CONFIG_CH3EN  0x1000u
#define INA3221_CONFIG_RESET  0x7127u   

enum {
    INA3221_MODE_POWER_DOWN = 0,
    INA3221_MODE_SHUNT_CONT = 5,
    INA3221_MODE_BUS_CONT   = 6,
    INA3221_MODE_CONT       = 7,     
};

#define INA3221_ME_SCC1  0x4000u
#define INA3221_ME_SCC2  0x2000u
#define INA3221_ME_SCC3  0x1000u
#define INA3221_ME_WEN   0x0800u
#define INA3221_ME_CEN   0x0400u
#define INA3221_ME_CF1   0x0200u
#define INA3221_ME_CF2   0x0100u
#define INA3221_ME_CF3   0x0080u
#define INA3221_ME_SF    0x0040u
#define INA3221_ME_WF1   0x0020u
#define INA3221_ME_WF2   0x0010u
#define INA3221_ME_WF3   0x0008u
#define INA3221_ME_PVF   0x0004u
#define INA3221_ME_TCF   0x0002u
#define INA3221_ME_CVRF  0x0001u

#define INA3221_CONFIG_BENCH_CH1 0x4007u
#define INA3221_CONFIG_BENCH_ALL 0x7007u

uint16_t ina3221_config(uint8_t channels, uint8_t avg, uint8_t vbusct,
                        uint8_t vshct, uint8_t mode);

uint8_t ina3221_channels(uint16_t config);

uint32_t ina3221_ct_us(uint8_t code);

uint32_t ina3221_cycle_us(uint16_t config);

bool ina3221_identity_ok(uint16_t maker, uint16_t die);

int32_t ina3221_code13(uint16_t raw);

sense_value_t ina3221_current_ua(uint32_t shunt_uohm, int32_t code);

int32_t ina3221_end_ua(uint32_t shunt_uohm, sense_clip_t end);

int32_t ina3221_bus_mv(int32_t code);
 
/* -------------------------------------------------------------- driver */
 
typedef enum {
    INA3221_SETUP_OK = 0,
    INA3221_SETUP_BAD_ADDR,     
    INA3221_SETUP_NO_SHUNT,     
    INA3221_SETUP_NO_CHANNEL,   
} ina3221_setup_err_t;

typedef struct {
    sense_part_t part;
    uint32_t     shunt_uohm[INA3221_CHANNELS]; 
    uint16_t     config;       
} ina3221_t;

ina3221_setup_err_t ina3221_init(ina3221_t *d, sense_bus_t *bus, uint8_t addr,
                                 uint32_t shunt_uohm, uint16_t config);

ina3221_setup_err_t ina3221_init_shunts(ina3221_t *d, sense_bus_t *bus,
                                        uint8_t addr,
                                        const uint32_t *shunt_uohm,
                                        uint16_t config);

bool ina3221_step(ina3221_t *d, uint32_t now_ms);

sense_state_t ina3221_state(const ina3221_t *d);

sense_err_t ina3221_read_current(ina3221_t *d, uint8_t ch, sense_value_t *ua);

sense_err_t ina3221_read_bus(ina3221_t *d, uint8_t ch, int32_t *mv);

sense_err_t ina3221_read_flags(ina3221_t *d, uint16_t *mask_enable);

sense_err_t ina3221_verify(ina3221_t *d, bool *lost);
 
#ifdef __cplusplus
}
#endif