ti,ina237 (on i2c bus)
Vendor: Texas Instruments
Note
An implementation of a driver matching this compatible is available in drivers/sensor/ti/ina23x/ina237.c.
Description
TI INA237 Bidirectional Current and Power Monitor.
The <zephyr/dt-bindings/sensor/ina237.h> file should be included in the
DeviceTree and it provides macros that can be used for initializing the
configuration registers.
Properties
Node specific properties
Properties not inherited from the base binding file.
Name |
Type |
Details |
|---|---|---|
|
|
Diag alert register, default matches the power-on reset value
|
|
|
ADC channel conversion configuration.
Default is the power-on reset value.
Default value: Legal values: |
|
|
Vbus conversion time in microseconds.
Default is the power-on reset value.
Default value: Legal values: |
|
|
Vshunt conversion time in microseconds.
Default is the power-on reset value.
Default value: Legal values: |
|
|
Temperature conversion time in microseconds.
Default is the power-on reset value.
Default value: Legal values: |
|
|
Number of samples to average (applies to all inputs).
Default is the power-on reset value.
Default value: Legal values: |
|
|
Enable high precision mode (4x the resolution).
|
|
|
This value should be selected so that measurement resolution is
maximized, that is:
current-lsb(A) = maximum expected current(A) / 2^15
(sensor has 15 bits). For example, if maximum expected current is 15A:
current-lsb(A) = 15A / 2^15 ~= 457uA
Rounded values may be used for convenience, e.g. 500uA/LSB or 1mA/LSB
while keeping a good measurement resolution. The units are in uA/LSB
so that low maximum currents can be measured with enough resolution.
This property is required. |
|
|
Shunt resistor value in microOhms
This property is required. |
|
|
Alert pin
|
|
|
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).
|
|
|
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.
|
|
|
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.
|
Deprecated node specific properties
Deprecated properties not inherited from the base binding file.
Name |
Type |
Details |
|---|---|---|
|
|
Value of the configuration register
e.g shunt voltage and bus voltage ADC conversion
times and averaging, operating mode for INA230 or
delay for initial ADC conversion, shunt full scale range
for INA237.
Deprecated, please use new properties instead.
|
|
|
Value of the ADC configuration register (ADC conversion times,
averaging, operating mode and etc).
Deprecated, please use new properties instead.
|
Base properties
Properties inherited from the base binding file, which defines common properties that may be set on many nodes. Not all of these may apply to the “ti,ina237” compatible.
Name |
Type |
Details |
|---|---|---|
|
|
indicates the operational status of a device
Legal values: See Important properties for more information. |
|
|
compatible strings
This property is required. See Important properties for more information. |
|
|
register space
This property is required. See Important properties for more information. |
|
|
name of each register space
|
|
|
interrupts for device
See Important properties for more information. |
|
|
extended interrupt specifier for device
|
|
|
name of each interrupt
|
|
|
phandle to interrupt controller node
|
|
|
Human readable string describing the device (used as device_get_binding() argument)
See Important properties for more information. This property is deprecated. |
|
|
Clock gate information
|
|
|
name of each clock
|
|
|
number of address cells in reg property
|
|
|
number of size cells in reg property
|
|
|
DMA channels specifiers
|
|
|
Provided names of DMA channel specifiers
|
|
|
IO channels specifiers
|
|
|
Provided names of IO channel specifiers
|
|
|
mailbox / IPM channels specifiers
|
|
|
Provided names of mailbox / IPM channel specifiers
|
|
|
Power domain specifiers
|
|
|
Provided names of power domain specifiers
|
|
|
Number of cells in power-domains property
|
|
|
Do not initialize device automatically on boot. Device should be manually
initialized using device_init().
|
|
|
Property to identify that a device can be used as wake up source.
When this property is provided a specific flag is set into the
device that tells the system that the device is capable of
wake up the system.
Wake up capable devices are disabled (interruptions will not wake up
the system) by default but they can be enabled at runtime if necessary.
|
|
|
Automatically configure the device for runtime power management after the
init function runs.
|
|
|
List of power states that will disable this device power.
|