ti,ina219 (on i2c bus)

Vendor: Texas Instruments

Note

An implementation of a driver matching this compatible is available in drivers/sensor/ti/ina219/ina219.c.

Description

Texas Instruments Bidirectional Current/Power Sensor

Properties

Properties not inherited from the base binding file.

Name

Type

Details

lsb-microamp

int

 
Current LSB in microAmpere
Current LSB = max expected current [A] / 2^15
example: 100 -> ~3A

This property is required.

shunt-milliohm

int

 
Value of the shunt resistor in milliOhm

This property is required.

brng

int

 
Bus Voltage Range
0 = 16 V FSR
1 = 32 V FSR

The default of 32V is the power-on reset value of the device.

Should the expected bus voltage be below 16V set this to 0.

Default value: 1

Legal values: 0, 1

pg

int

 
Programmable Gain
0 = 1  -> ±40 mV
1 = /2 -> ±80 mV
2 = /4 -> ±160 mV
3 = /8 -> ±320 mV

The default of ±320 mV is the power-on reset value of the device.

In case the expected voltage drop across the shunt resistor is lower
one can adjust this to get more accurate readings.

Default value: 3

Legal values: 0, 1, 2, 3

badc

int

 
Bus ADC configuration
0  = 9 bit -> 84 µs
1  = 10 bit -> 148 µs
2  = 11 bit -> 276 µs
3  = 12 bit -> 532 µs
9  = 12 bit - 2 sample averaging -> 1.06 ms
10 = 12 bit - 4 sample averaging -> 2.13 ms
11 = 12 bit - 8 sample averaging -> 4.26 ms
12 = 12 bit - 16 sample averaging -> 8.51 ms
13 = 12 bit - 32 sample averaging -> 17.02 ms
14 = 12 bit - 64 sample averaging -> 34.05 ms
15 = 12 bit - 128 sample averaging -> 68.10 ms

The default of 12 bit is the power-on reset value of the device.

Lowering the resolution of the ADC gives less accurate readings but
cuts down on conversion times.

Averaging over multiple samples gives more stable readings but adds
to overall conversion time.

Default value: 3

Legal values: 0, 1, 2, 3, 9, 10, 11, 12, 13, 14, 15

sadc

int

 
Shunt ADC configuration
0  = 9 bit -> 84 µs
1  = 10 bit -> 148 µs
2  = 11 bit -> 276 µs
3  = 12 bit -> 532 µs
9  = 12 bit - 2 sample averaging -> 1.06 ms
10 = 12 bit - 4 sample averaging -> 2.13 ms
11 = 12 bit - 8 sample averaging -> 4.26 ms
12 = 12 bit - 16 sample averaging -> 8.51 ms
13 = 12 bit - 32 sample averaging -> 17.02 ms
14 = 12 bit - 64 sample averaging -> 34.05 ms
15 = 12 bit - 128 sample averaging -> 68.10 ms

The default of 12 bit is the power-on reset value of the device.

Lowering the resolution of the ADC gives less accurate readings but
cuts down on conversion times.

Averaging over multiple samples gives more stable readings but adds
to overall conversion time.

Default value: 3

Legal values: 0, 1, 2, 3, 9, 10, 11, 12, 13, 14, 15

friendly-name

string

 
Human readable string describing the sensor. It can be used to
distinguish multiple instances of the same model (e.g., lid accelerometer
vs. base accelerometer in a laptop) to a host operating system.

This property is defined in the Generic Sensor Property Usages of the HID
Usage Tables specification
(https://usb.org/sites/default/files/hut1_3_0.pdf, section 22.5).

supply-gpios

phandle-array

 
GPIO specifier that controls power to the device.

This property should be provided when the device has a dedicated
switch that controls power to the device.  The supply state is
entirely the responsibility of the device driver.

Contrast with vin-supply.

vin-supply

phandle

 
Reference to the regulator that controls power to the device.
The referenced devicetree node must have a regulator compatible.

This property should be provided when device power is supplied
by a shared regulator.  The supply state is dependent on the
request status of all devices fed by the regulator.

Contrast with supply-gpios.  If both properties are provided
then the regulator must be requested before the supply GPIOS is
set to an active state, and the supply GPIOS must be set to an
inactive state before releasing the regulator.