xref: /openbmc/linux/Documentation/devicetree/bindings/hwmon/ina3221.txt (revision 597473720f4dc69749542bfcfed4a927a43d935e)
18b949c64SNicolin ChenTexas Instruments INA3221 Device Tree Bindings
28b949c64SNicolin Chen
38b949c64SNicolin Chen1) ina3221 node
48b949c64SNicolin Chen  Required properties:
58b949c64SNicolin Chen  - compatible: Must be "ti,ina3221"
68b949c64SNicolin Chen  - reg: I2C address
78b949c64SNicolin Chen
88b949c64SNicolin Chen  Optional properties:
9*2e1ce201SNicolin Chen  - ti,single-shot: This chip has two power modes: single-shot (chip takes one
10*2e1ce201SNicolin Chen                    measurement and then shuts itself down) and continuous (
11*2e1ce201SNicolin Chen                    chip takes continuous measurements). The continuous mode is
12*2e1ce201SNicolin Chen                    more reliable and suitable for hardware monitor type device,
13*2e1ce201SNicolin Chen                    but the single-shot mode is more power-friendly and useful
14*2e1ce201SNicolin Chen                    for battery-powered device which cares power consumptions
15*2e1ce201SNicolin Chen                    while still needs some measurements occasionally.
16*2e1ce201SNicolin Chen                    If this property is present, the single-shot mode will be
17*2e1ce201SNicolin Chen                    used, instead of the default continuous one for monitoring.
18*2e1ce201SNicolin Chen
198b949c64SNicolin Chen  = The node contains optional child nodes for three channels =
208b949c64SNicolin Chen  = Each child node describes the information of input source =
218b949c64SNicolin Chen
228b949c64SNicolin Chen  - #address-cells: Required only if a child node is present. Must be 1.
238b949c64SNicolin Chen  - #size-cells: Required only if a child node is present. Must be 0.
248b949c64SNicolin Chen
258b949c64SNicolin Chen2) child nodes
268b949c64SNicolin Chen  Required properties:
278b949c64SNicolin Chen  - reg: Must be 0, 1 or 2, corresponding to IN1, IN2 or IN3 port of INA3221
288b949c64SNicolin Chen
298b949c64SNicolin Chen  Optional properties:
308b949c64SNicolin Chen  - label: Name of the input source
318b949c64SNicolin Chen  - shunt-resistor-micro-ohms: Shunt resistor value in micro-Ohm
328b949c64SNicolin Chen
338b949c64SNicolin ChenExample:
348b949c64SNicolin Chen
358b949c64SNicolin Chenina3221@40 {
368b949c64SNicolin Chen	compatible = "ti,ina3221";
378b949c64SNicolin Chen	reg = <0x40>;
388b949c64SNicolin Chen	#address-cells = <1>;
398b949c64SNicolin Chen	#size-cells = <0>;
408b949c64SNicolin Chen
418b949c64SNicolin Chen	input@0 {
428b949c64SNicolin Chen		reg = <0x0>;
438b949c64SNicolin Chen		status = "disabled";
448b949c64SNicolin Chen	};
458b949c64SNicolin Chen	input@1 {
468b949c64SNicolin Chen		reg = <0x1>;
478b949c64SNicolin Chen		shunt-resistor-micro-ohms = <5000>;
488b949c64SNicolin Chen	};
498b949c64SNicolin Chen	input@2 {
508b949c64SNicolin Chen		reg = <0x2>;
518b949c64SNicolin Chen		label = "VDD_5V";
528b949c64SNicolin Chen		shunt-resistor-micro-ohms = <5000>;
538b949c64SNicolin Chen	};
548b949c64SNicolin Chen};
55