Driver configuration parameters for Texas Instruments INA3221 three-channel, high-side current and bus voltage monitor. More...

Detailed Description

Driver configuration parameters for Texas Instruments INA3221 three-channel, high-side current and bus voltage monitor.

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

Definition in file ina3221_params.h.

#include "board.h"
#include "ina3221.h"
#include "saul_reg.h"

Include dependency graph for ina3221_params.h:

Go to the source code of this file.

#define	INA3221_PARAM_I2C (I2C_DEV(0))
	I2C bus index.

#define	INA3221_PARAM_ADDR (INA3221_ADDR_00)
	I2C device address.

#define	INA3221_PARAM_PIN_WRN (GPIO_UNDEF)
	Warning alert pin.

#define	INA3221_PARAM_PIN_CRT (GPIO_UNDEF)
	Critical alert pin.

#define	INA3221_PARAM_PIN_PV (GPIO_UNDEF)
	Power valid alert pin.

#define	INA3221_PARAM_PIN_TC (GPIO_UNDEF)
	Timing control alert pin.

#define	INA3221_PARAM_INT_PU_PIN_WRN (0)
	Enable or disable internal pull up resistor for pin WRN.

#define	INA3221_PARAM_INT_PU_PIN_CRT (0)
	Enable or disable internal pull up resistor for pin CRT.

#define	INA3221_PARAM_INT_PU_PIN_PV (0)
	Enable or disable internal pull up resistor for pin PV.

#define	INA3221_PARAM_INT_PU_PIN_TC (0)
	Enable or disable internal pull up resistor for pin TC.

#define	INA3221_PARAM_CONFIG
	Configuration register value.

#define	INA3221_PARAM_RSHUNT_MOHM_CH1 (100)
	Channel 1 shunt resistance.

#define	INA3221_PARAM_RSHUNT_MOHM_CH2 (100)
	Channel 2 shunt resistance.

#define	INA3221_PARAM_RSHUNT_MOHM_CH3 (100)
	Channel 3 shunt resistance.

#define	INA3221_PARAMS
	Default device initialization parameters.

#define	INA3221_SAUL_INFO
	SAUL driver information.

static const ina3221_params_t	ina3221_params []
	INA3221 array of device configurations.

static const saul_reg_info_t	ina3221_saul_info []
	INA3221 array of SAUL driver information.

Macro Definition Documentation

◆ INA3221_PARAM_ADDR

#define INA3221_PARAM_ADDR (INA3221_ADDR_00)

I2C device address.

Definition at line 36 of file ina3221_params.h.

◆ INA3221_PARAM_CONFIG

#define INA3221_PARAM_CONFIG

Value:

        (          \
        INA3221_ENABLE_CH1 |               \
        INA3221_ENABLE_CH2 |               \
        INA3221_ENABLE_CH3 |               \
        INA3221_NUM_SAMPLES_4 |            \
        INA3221_CONV_TIME_BADC_4156US |    \
        INA3221_CONV_TIME_SADC_4156US |    \
        INA3221_MODE_CONTINUOUS_SHUNT_BUS  \
        )

Configuration register value.

Definition at line 72 of file ina3221_params.h.

◆ INA3221_PARAM_I2C

#define INA3221_PARAM_I2C (I2C_DEV(0))

I2C bus index.

Definition at line 32 of file ina3221_params.h.

◆ INA3221_PARAM_INT_PU_PIN_CRT

#define INA3221_PARAM_INT_PU_PIN_CRT (0)

Enable or disable internal pull up resistor for pin CRT.

Definition at line 60 of file ina3221_params.h.

◆ INA3221_PARAM_INT_PU_PIN_PV

#define INA3221_PARAM_INT_PU_PIN_PV (0)

Enable or disable internal pull up resistor for pin PV.

Definition at line 64 of file ina3221_params.h.

◆ INA3221_PARAM_INT_PU_PIN_TC

#define INA3221_PARAM_INT_PU_PIN_TC (0)

Enable or disable internal pull up resistor for pin TC.

Definition at line 68 of file ina3221_params.h.

◆ INA3221_PARAM_INT_PU_PIN_WRN

#define INA3221_PARAM_INT_PU_PIN_WRN (0)

Enable or disable internal pull up resistor for pin WRN.

Definition at line 56 of file ina3221_params.h.

◆ INA3221_PARAM_PIN_CRT

#define INA3221_PARAM_PIN_CRT (GPIO_UNDEF)

Critical alert pin.

Definition at line 44 of file ina3221_params.h.

◆ INA3221_PARAM_PIN_PV

#define INA3221_PARAM_PIN_PV (GPIO_UNDEF)

Power valid alert pin.

Definition at line 48 of file ina3221_params.h.

◆ INA3221_PARAM_PIN_TC

#define INA3221_PARAM_PIN_TC (GPIO_UNDEF)

Timing control alert pin.

Definition at line 52 of file ina3221_params.h.

◆ INA3221_PARAM_PIN_WRN

#define INA3221_PARAM_PIN_WRN (GPIO_UNDEF)

Warning alert pin.

Definition at line 40 of file ina3221_params.h.

◆ INA3221_PARAM_RSHUNT_MOHM_CH1

#define INA3221_PARAM_RSHUNT_MOHM_CH1 (100)

Channel 1 shunt resistance.

Definition at line 84 of file ina3221_params.h.

◆ INA3221_PARAM_RSHUNT_MOHM_CH2

#define INA3221_PARAM_RSHUNT_MOHM_CH2 (100)

Channel 2 shunt resistance.

Definition at line 88 of file ina3221_params.h.

◆ INA3221_PARAM_RSHUNT_MOHM_CH3

#define INA3221_PARAM_RSHUNT_MOHM_CH3 (100)

Channel 3 shunt resistance.

Definition at line 92 of file ina3221_params.h.

◆ INA3221_PARAMS

#define INA3221_PARAMS

Value:

        {                                                      \
        .i2c = INA3221_PARAM_I2C,                                              \
        .addr = INA3221_PARAM_ADDR,                                            \
        .upins.pins = {                                                        \
            .pin_warn = INA3221_PARAM_PIN_WRN,                                 \
            .pin_crit = INA3221_PARAM_PIN_CRT,                                 \
            .pin_tc = INA3221_PARAM_PIN_TC,                                    \
            .pin_pv = INA3221_PARAM_PIN_PV                                     \
        },                                                                     \
        .gpio_config = (INA3221_PARAM_INT_PU_PIN_WRN << INA3221_ALERT_WRN) |   \
                       (INA3221_PARAM_INT_PU_PIN_CRT << INA3221_ALERT_CRT) |   \
                       (INA3221_PARAM_INT_PU_PIN_TC << INA3221_ALERT_TC)   |   \
                       (INA3221_PARAM_INT_PU_PIN_PV << INA3221_ALERT_PV),      \
        .config = INA3221_PARAM_CONFIG,                                        \
        .rshunt_mohm = {                                                       \
            INA3221_PARAM_RSHUNT_MOHM_CH1,                                     \
            INA3221_PARAM_RSHUNT_MOHM_CH2,                                     \
            INA3221_PARAM_RSHUNT_MOHM_CH3                                      \
        }                                                                      \
}

Default device initialization parameters.

Definition at line 96 of file ina3221_params.h.

◆ INA3221_SAUL_INFO

#define INA3221_SAUL_INFO

Value:

    { .name = "INA3221 bus voltage" }, \
    { .name = "INA3221 current" },                             \
    { .name = "INA3221 power" },                               \
    { .name = "INA3221 shunt voltage sum" }

SAUL driver information.

Definition at line 119 of file ina3221_params.h.

Variable Documentation

◆ ina3221_params

const ina3221_params_t ina3221_params[]

static

Initial value:

= {
    INA3221_PARAMS
}

INA3221 array of device configurations.

Definition at line 128 of file ina3221_params.h.

◆ ina3221_saul_info

const saul_reg_info_t ina3221_saul_info[]

static

Initial value:

= {
    INA3221_SAUL_INFO
}

INA3221 array of SAUL driver information.

Definition at line 135 of file ina3221_params.h.