ti,ina226 (on i2c bus)

Vendor: Texas Instruments

Description

TI INA226 Bidirectional Current and Power Monitor.
The <zephyr/dt-bindings/sensor/ina226.h> file should be included in the
DeviceTree as it provides macros that can be used for initializing the
configuration registers.

Properties

Properties not inherited from the base binding file.

Name

Type

Details

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.

avg-count

int

 
Number of samples to average (applies to all inputs).
Default is the power-on reset value.

Default value: 1

Legal values: 1, 4, 16, 64, 128, 256, 512, 1024

vbus-conversion-time-us

int

 
Vbus conversion time in microseconds.
Default is the power-on reset value.

Default value: 1100

Legal values: 140, 204, 332, 588, 1100, 2116, 4156, 8244

vshunt-conversion-time-us

int

 
Vshunt conversion time in microseconds.
Default is the power-on reset value.

Default value: 1100

Legal values: 140, 204, 332, 588, 1100, 2116, 4156, 8244

operating-mode

string

 
Selects mode of operation.
Default is the power-on reset value.

Default value: Shunt and Bus, Continuous

Legal values: 'Power-Down (or Shutdown)', 'Shunt Voltage, Triggered', 'Bus Voltage, Triggered', 'Shunt and Bus, Triggered', 'Power-Down (or Shutdown)', 'Shunt Voltage, Continuous', 'Bus Voltage, Continuous', 'Shunt and Bus, Continuous'

current-lsb-microamps

int

 
Current LSB value in microAmpere.
This value gives the measurement resolution for current measurement.
Formula: current-lsb [μA] = maximum expected current [μA] / 2^15
Higher resolution means lower range of current measurement, vice versa.

For example, if maximum expected current is 15 [A]:
  then, current-lsb [μA] = 15000000 [μA] / 2^15 ~= 457.763 [μA].

Note: rounded values may be used for convenience, e.g. 500uA/LSB.

This property is required.

rshunt-micro-ohms

int

 
Shunt resistor value in micro-ohms.

This property is required.