Device driver interface for Texas Instruments INA3221 three-channel ,high-side current and bus voltage monitor. More...

Detailed Description

Device driver interface for Texas Instruments INA3221 three-channel ,high-side current and bus voltage monitor.

The alert pins WRN, CRT, TC, PV are open drain output pins, so they should be pulled high with internal or external pull-ups. They pull low, if the alert condition becomes true. If they become pulled low, the configured input pins in

See also
ina3221_params_t will read a low flank and the related interrupt callback will be executed, if configured with
ina3221_enable_alert. WRN condition: Any channel´s measured shunt voltage drop was higher than the configured value in INA3221_REG_CHx_WARN_ALERT_LIMIT, CRT condition: Any channel´s measured shunt voltage drop was higher than the configured value in INA3221_REG_CHx_CRIT_ALERT_LIMIT, or the sum of all channel´s voltage drops was higher than the configured value in INA3221_REG_SHUNT_VOLTAGE_SUM_LIMIT. Note that the sum of voltage drops only makes sense, if all channels are using the same shunt resistance value! TC condition: After a 1.2-V level is detected on channel 1, if the INA3221 does not detecta 1.2-V value or greater on the bus voltage measurement following four complete cycles of all three channels, the timing control (TC)alert pin pulls low. PV condition: If any channel´s measured bus voltage was not within the configured values in INA3221_REG_PV_LOWER_LIMIT and INA3221_REG_PV_UPPER_LIMIT, the PV pin is pulled low.

For all enabled channels (1 <= i <= INA3221_NUM_CH), the time to complete a full measurment cycle is:

num_samples * (shunt_conv_time_ch_i + bus_voltage_conv_time_ch_i)

Author
Fabian Hüßler fabia.nosp@m.n.hu.nosp@m.essle.nosp@m.r@ov.nosp@m.gu.de

Definition in file ina3221.h.

#include <stdint.h>
#include "periph/gpio.h"
#include "periph/i2c.h"
+ Include dependency graph for ina3221.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ina3221_params_t
 INA3221 device parameters. More...
 
struct  ina3221_t
 INA3221 device handle struct. More...
 

Macros

#define INA3221_NUM_CH   (3)
 Number of channels.
 
#define INA3221_NUM_ALERTS   (4)
 Number of alerts.
 
#define INA3221_MODE_MASK   (0x0007)
 Device operation mode bit mask.
 
#define INA3221_CONV_TIME_SADC_MASK   (0x0038)
 ADC shunt voltage conversion times bit mask.
 
#define INA3221_CONV_TIME_BADC_MASK   (0x01C0)
 ADC bus voltage conversion times bit mask.
 
#define INA3221_NUM_SAMPLES_MASK   (0x0E00)
 Number of samples to calculate average shunt/bus voltage value bit mask.
 
#define INA3221_ENABLE_CH_MASK
 Enable channel bit mask. More...
 
#define INA3221_ENABLE_SUM_CH_MASK
 Enable shunt voltage sum calculation channel bit mask. More...
 
#define INA3221_ENABLE_LATCH_MASK
 Enable latch bit mask. More...
 
#define INA3221_DEFCONFIG   (0x7127)
 Default configuration register value.
 
#define INA3221_RESET   (0x8000)
 Reset configuration register value.
 
#define INA3221_FLAG_CRIT_ALERT_CH1   (0x0200)
 Critical alert channel 1 flag.
 
#define INA3221_FLAG_CRIT_ALERT_CH2   (0x0100)
 Critical alert channel 2 flag.
 
#define INA3221_FLAG_CRIT_ALERT_CH3   (0x0080)
 Critical alert channel 3 flag.
 
#define INA3221_FLAG_SHUNT_SUM_ALERT   (0x0040)
 Alert channel sum flag.
 
#define INA3221_FLAG_WARN_ALERT_CH1   (0x0020)
 Warning alert channel 1 flag.
 
#define INA3221_FLAG_WARN_ALERT_CH2   (0x0010)
 Warning alert channel 2 flag.
 
#define INA3221_FLAG_WARN_ALERT_CH3   (0x0008)
 Warning alert channel 3 flag.
 
#define INA3221_FLAG_POWER_VALID   (0x0004)
 Power valid flag.
 
#define INA3221_FLAG_TIMING_CONTROL   (0x0002)
 Timing Control flag.
 
#define INA3221_FLAG_CONV_READY   (0x0001)
 Conversion ready flag.
 
#define INA3221_FLAGS_MASK
 Flags bit mask. More...
 
#define INA3221_TRIGGER_SHUNT(dev)   ina3221_set_mode(dev, INA3221_MODE_TRIGGER_SHUNT_ONLY)
 Set operation mode to INA3221_MODE_TRIGGER_SHUNT_ONLY to trigger shunt voltage measurement. More...
 
#define INA3221_TRIGGER_BUS(dev)   ina3221_set_mode(dev, INA3221_MODE_TRIGGER_BUS_ONLY)
 Set operation mode to INA3221_MODE_TRIGGER_BUS_ONLY to trigger bus voltage measurement. More...
 
#define INA3221_TRIGGER_SHUNT_AND_BUS(dev)   ina3221_set_mode(dev, INA3221_MODE_TRIGGER_SHUNT_BUS)
 Set operation mode to INA3221_MODE_TRIGGER_SHUNT_BUS to trigger shunt and bus voltage measurement. More...
 

Typedefs

typedef void(* ina3221_alert_cb_t) (void *arg)
 INA3221 alert callback for alert pins CRT, WRN, TC, PV.
 
typedef enum ina3221_ret_val ina3221_ret_val_t
 Return codes.
 
typedef enum ina3221_dev_addr ina3221_dav_addr_t
 I2C device addresses.
 
typedef enum ina3221_channel ina3221_channel_t
 Channel flags.
 
typedef enum ina3221_alert ina3221_alert_t
 Alert indices.
 
typedef enum ina3221_mode ina3221_mode_t
 Device operation modes.
 
typedef enum ina3221_conv_time_shunt_adc ina3221_conv_time_shunt_adc_t
 ADC shunt voltage conversion times.
 
typedef enum ina3221_conv_time_bus_adc ina3221_conv_time_bus_adc_t
 ADC bus voltage conversion times.
 
typedef enum ina3221_num_samples ina3221_num_samples_t
 Number of samples to calculate average shunt/bus voltage value.
 
typedef enum ina3221_enable_ch ina3221_enable_ch_t
 Enable channel flags.
 
typedef enum ina3221_channel_state ina3221_channel_state_t
 Channel state enabled/disabled.
 
typedef enum ina3221_enable_sum_ch ina3221_enable_sum_ch_t
 Enable shunt voltage sum calculation channel flags.
 
typedef enum ina3221_enable_latch ina3221_enable_latch_t
 Enable latch flags.
 

Enumerations

enum  ina3221_ret_val {
  INA3221_OK, INA3221_I2C_ERROR, INA3221_BAD_MANUF_ID, INA3221_BAD_DIE_ID,
  INA3221_RESET_FAILED, INA3221_CONFIG_FAILED
}
 Return codes. More...
 
enum  ina3221_dev_addr { INA3221_ADDR_00 = 0x40, INA3221_ADDR_01 = 0x41, INA3221_ADDR_10 = 0x42, INA3221_ADDR_11 = 0x43 }
 I2C device addresses. More...
 
enum  ina3221_channel { INA3221_CH1 = (1 << 0), INA3221_CH2 = (1 << 1), INA3221_CH3 = (1 << 2) }
 Channel flags. More...
 
enum  ina3221_alert { INA3221_ALERT_WRN = 0, INA3221_ALERT_CRT = 1, INA3221_ALERT_TC = 2, INA3221_ALERT_PV = 3 }
 Alert indices. More...
 
enum  ina3221_mode {
  INA3221_MODE_POWER_DOWN = 0x0000, INA3221_MODE_TRIGGER_SHUNT_ONLY = 0x0001, INA3221_MODE_TRIGGER_BUS_ONLY = 0x0002, INA3221_MODE_TRIGGER_SHUNT_BUS = 0x0003,
  INA3221_MODE_POWER_DOWN_ = 0x0004, INA3221_MODE_CONTINUOUS_SHUNT_ONLY = 0x0005, INA3221_MODE_CONTINUOUS_BUS_ONLY = 0x0006, INA3221_MODE_CONTINUOUS_SHUNT_BUS = 0x0007
}
 Device operation modes. More...
 
enum  ina3221_conv_time_shunt_adc {
  INA3221_CONV_TIME_SADC_140US = 0x0000, INA3221_CONV_TIME_SADC_204US = 0x0008, INA3221_CONV_TIME_SADC_332US = 0x0010, INA3221_CONV_TIME_SADC_588US = 0x0018,
  INA3221_CONV_TIME_SADC_1100US = 0x0020, INA3221_CONV_TIME_SADC_2116US = 0x0028, INA3221_CONV_TIME_SADC_4156US = 0x0030, INA3221_CONV_TIME_SADC_8244US = 0x0038
}
 ADC shunt voltage conversion times. More...
 
enum  ina3221_conv_time_bus_adc {
  INA3221_CONV_TIME_BADC_140US = 0x0000, INA3221_CONV_TIME_BADC_204US = 0x0040, INA3221_CONV_TIME_BADC_332US = 0x0080, INA3221_CONV_TIME_BADC_588US = 0x00C0,
  INA3221_CONV_TIME_BADC_1100US = 0x0100, INA3221_CONV_TIME_BADC_2116US = 0x0140, INA3221_CONV_TIME_BADC_4156US = 0x0180, INA3221_CONV_TIME_BADC_8244US = 0x01C0
}
 ADC bus voltage conversion times. More...
 
enum  ina3221_num_samples {
  INA3221_NUM_SAMPLES_1 = 0x0000, INA3221_NUM_SAMPLES_4 = 0x0200, INA3221_NUM_SAMPLES_16 = 0x0400, INA3221_NUM_SAMPLES_64 = 0x0600,
  INA3221_NUM_SAMPLES_128 = 0x0800, INA3221_NUM_SAMPLES_256 = 0x0A00, INA3221_NUM_SAMPLES_512 = 0x0C00, INA3221_NUM_SAMPLES_1024 = 0x0E00
}
 Number of samples to calculate average shunt/bus voltage value. More...
 
enum  ina3221_enable_ch { INA3221_ENABLE_CH1 = 0x4000, INA3221_ENABLE_CH2 = 0x2000, INA3221_ENABLE_CH3 = 0x1000 }
 Enable channel flags. More...
 
enum  ina3221_channel_state { INA3221_CH_DISABLE, INA3221_CH_ENABLE }
 Channel state enabled/disabled. More...
 
enum  ina3221_enable_sum_ch { INA3221_ENABLE_SUM_CH1 = 0x4000, INA3221_ENABLE_SUM_CH2 = 0x2000, INA3221_ENABLE_SUM_CH3 = 0x1000 }
 Enable shunt voltage sum calculation channel flags. More...
 
enum  ina3221_enable_latch { INA3221_ENABLE_WARN_LATCH = 0x0800, INA3221_ENABLE_CRIT_LATCH = 0x0400 }
 Enable latch flags. More...
 

Functions

int ina3221_reset (ina3221_t *dev)
 Reset device, i.e. More...
 
int ina3221_init (ina3221_t *dev, const ina3221_params_t *params)
 Initialize device. More...
 
int _ina3221_enable_alert (ina3221_t *dev, ina3221_alert_t alert, ina3221_alert_cb_t cb, void *arg)
 Enable alert callback and argument for alert alert. More...
 
static int ina3221_enable_warning_alert (ina3221_t *dev, ina3221_alert_cb_t cb, void *arg)
 Wrapper around. More...
 
static int ina3221_enable_critical_alert (ina3221_t *dev, ina3221_alert_cb_t cb, void *arg)
 Wrapper around. More...
 
static int ina3221_enable_timing_control_alert (ina3221_t *dev, ina3221_alert_cb_t cb, void *arg)
 Wrapper around. More...
 
static int ina3221_enable_power_valid_alert (ina3221_t *dev, ina3221_alert_cb_t cb, void *arg)
 Wrapper around. More...
 
int _ina3221_disable_alert (ina3221_t *dev, ina3221_alert_t alert)
 Disable alert callback and argument for alert alert. More...
 
static int ina3221_disable_warning_alert (ina3221_t *dev)
 Wrapper around. More...
 
static int ina3221_disable_critical_alert (ina3221_t *dev)
 Wrapper around. More...
 
static int ina3221_disable_timing_control_alert (ina3221_t *dev)
 Wrapper around. More...
 
static int ina3221_disable_power_valid_alert (ina3221_t *dev)
 Wrapper around. More...
 
int _ina3221_set_config (ina3221_t *dev, uint16_t cfg)
 Write configuration register value to configuration register. More...
 
static int ina3221_set_config (ina3221_t *dev, ina3221_enable_ch_t chs, ina3221_num_samples_t ns, ina3221_conv_time_bus_adc_t ctbadc, ina3221_conv_time_shunt_adc_t ctsadc, ina3221_mode_t mode)
 Wrapper around. More...
 
int _ina3221_get_config (const ina3221_t *dev, uint16_t *cfg)
 Read currently saved configuration register value. More...
 
static int ina3221_get_config (const ina3221_t *dev, ina3221_enable_ch_t *chs, ina3221_num_samples_t *ns, ina3221_conv_time_bus_adc_t *ctbadc, ina3221_conv_time_shunt_adc_t *ctsadc, ina3221_mode_t *mode)
 Wrapper around. More...
 
int _ina3221_set_enable_channel (ina3221_t *dev, ina3221_enable_ch_t ech)
 Enable channels. More...
 
static int ina3221_set_channel_state (ina3221_t *dev, ina3221_channel_state_t ch1, ina3221_channel_state_t ch2, ina3221_channel_state_t ch3)
 Wrapper around. More...
 
int _ina3221_get_enable_channel (const ina3221_t *dev, ina3221_enable_ch_t *ech)
 Read which channels are currently enabled. More...
 
static int ina3221_get_channel_state (const ina3221_t *dev, ina3221_channel_state_t *ch1, ina3221_channel_state_t *ch2, ina3221_channel_state_t *ch3)
 Wrapper around _ina3221_get_enable_channel. More...
 
int ina3221_set_num_samples (ina3221_t *dev, ina3221_num_samples_t ns)
 Update number of samples and write to configuration register. More...
 
int ina3221_get_num_samples (const ina3221_t *dev, ina3221_num_samples_t *ns)
 Read currently applied number of samples. More...
 
int ina3221_set_conv_time_bus_adc (ina3221_t *dev, ina3221_conv_time_bus_adc_t ctb)
 Update conversion time of bus voltage ADC and write to configuration register. More...
 
int ina3221_get_conv_time_bus_adc (const ina3221_t *dev, ina3221_conv_time_bus_adc_t *ctb)
 Read currently applied bus voltage ADC conversion time. More...
 
int ina3221_set_conv_time_shunt_adc (ina3221_t *dev, ina3221_conv_time_shunt_adc_t cts)
 Update conversion time of shunt voltage ADC and write to configuration register. More...
 
int ina3221_get_conv_time_shunt_adc (const ina3221_t *dev, ina3221_conv_time_shunt_adc_t *cts)
 Read currently applied shunt voltage ADC conversion time. More...
 
int ina3221_set_mode (ina3221_t *dev, ina3221_mode_t mode)
 Update device operation mode. More...
 
int ina3221_get_mode (const ina3221_t *dev, ina3221_mode_t *mode)
 Read currently applied device operation mode. More...
 
int _ina3221_set_enable_sum_channel (const ina3221_t *dev, ina3221_enable_sum_ch_t esch)
 Enable channels for shunt voltage sum calculation. More...
 
static int ina3221_set_enable_sum_channel (const ina3221_t *dev, ina3221_channel_state_t ch1, ina3221_channel_state_t ch2, ina3221_channel_state_t ch3)
 Wrapper around. More...
 
int _ina3221_get_enable_sum_channel (const ina3221_t *dev, ina3221_enable_sum_ch_t *esch)
 Read enabled channels for shunt voltage sum calculation. More...
 
static int ina3221_get_enable_sum_channel (const ina3221_t *dev, ina3221_channel_state_t *ch1, ina3221_channel_state_t *ch2, ina3221_channel_state_t *ch3)
 Wrapper for. More...
 
int ina3221_set_latch (const ina3221_t *dev, ina3221_enable_latch_t latch)
 Enable latches for critical/warning alert pins. More...
 
int ina3221_get_latch (const ina3221_t *dev, ina3221_enable_latch_t *latch)
 Read enabled latches for critical/warning alert pins. More...
 
int ina3221_set_crit_alert_limit (const ina3221_t *dev, ina3221_channel_t ch, int32_t in_uv)
 Set critical shunt voltage alert limit to in_uv for each channel in ch. More...
 
int ina3221_get_crit_alert_limit (const ina3221_t *dev, ina3221_channel_t ch, int32_t *out_uv)
 Read critical shunt voltage alert limit for each channel in ch. More...
 
int ina3221_set_warn_alert_limit (const ina3221_t *dev, ina3221_channel_t ch, int32_t in_uv)
 Set warning shunt voltage alert limit to in_uv for each channel in ch. More...
 
int ina3221_get_warn_alert_limit (const ina3221_t *dev, ina3221_channel_t ch, int32_t *out_uv)
 Read warning shunt voltage alert limit for each channel in ch. More...
 
int ina3221_set_shunt_voltage_sum_alert_limit (const ina3221_t *dev, int32_t in_uv)
 Set shunt voltage sum alert limit to in_uv. More...
 
int ina3221_get_shunt_voltage_sum_alert_limit (const ina3221_t *dev, int32_t *out_uv)
 Read shunt voltage sum alert limit. More...
 
int ina3221_set_power_valid_upper_limit (const ina3221_t *dev, int32_t in_mv)
 Set bus voltage power valid upper limit to in_mv. More...
 
int ina3221_get_power_valid_upper_limit (const ina3221_t *dev, int32_t *out_mv)
 Read bus voltage power valid upper limit. More...
 
int ina3221_set_power_valid_lower_limit (const ina3221_t *dev, int32_t in_mv)
 Set bus voltage power valid lower limit to in_mv. More...
 
int ina3221_get_power_valid_lower_limit (const ina3221_t *dev, int32_t *out_mv)
 Read bus voltage power valid lower limit. More...
 
int ina3221_read_flags (const ina3221_t *dev, uint16_t *flags)
 Read status flags. More...
 
int ina3221_read_shunt_sum_uv (const ina3221_t *dev, int32_t *out_uv, uint16_t *flags)
 Read sum of shunt voltages. More...
 
int ina3221_read_shunt_uv (const ina3221_t *dev, ina3221_channel_t ch, int32_t *out_uv, uint16_t *flags)
 Read shunt voltages for each channel in ch. More...
 
int ina3221_read_bus_mv (const ina3221_t *dev, ina3221_channel_t ch, int16_t *out_mv, uint16_t *flags)
 Read bus voltages for each channel in ch. More...
 
int ina3221_calculate_current_ua (const ina3221_t *dev, ina3221_channel_t ch, int32_t *in_uv, int32_t *out_ma)
 Calculate current for each channel in ch. More...
 
int ina3221_calculate_power_uw (int16_t *in_mv, int32_t *in_ua, uint8_t num, int32_t *out_mw)
 Calculate power from bus voltage and current values. More...
 
void ina3221_ch_align (ina3221_channel_t ch, const void *in_res, void *out_res, size_t res_val_size)
 Align in_res to the number of channels For example: ch = (INA3221_CH1 | INA3221_CH3) in_res = {value_ch1, value_ch3}, then out_res will be {value_ch1, 0, value_ch3}. More...