xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/hwmon/ina3221.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunTexas Instruments INA3221 Device Tree Bindings
2*4882a593Smuzhiyun
3*4882a593Smuzhiyun1) ina3221 node
4*4882a593Smuzhiyun  Required properties:
5*4882a593Smuzhiyun  - compatible: Must be "ti,ina3221"
6*4882a593Smuzhiyun  - reg: I2C address
7*4882a593Smuzhiyun
8*4882a593Smuzhiyun  Optional properties:
9*4882a593Smuzhiyun  - ti,single-shot: This chip has two power modes: single-shot (chip takes one
10*4882a593Smuzhiyun                    measurement and then shuts itself down) and continuous (
11*4882a593Smuzhiyun                    chip takes continuous measurements). The continuous mode is
12*4882a593Smuzhiyun                    more reliable and suitable for hardware monitor type device,
13*4882a593Smuzhiyun                    but the single-shot mode is more power-friendly and useful
14*4882a593Smuzhiyun                    for battery-powered device which cares power consumptions
15*4882a593Smuzhiyun                    while still needs some measurements occasionally.
16*4882a593Smuzhiyun                    If this property is present, the single-shot mode will be
17*4882a593Smuzhiyun                    used, instead of the default continuous one for monitoring.
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun  = The node contains optional child nodes for three channels =
20*4882a593Smuzhiyun  = Each child node describes the information of input source =
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun  - #address-cells: Required only if a child node is present. Must be 1.
23*4882a593Smuzhiyun  - #size-cells: Required only if a child node is present. Must be 0.
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun2) child nodes
26*4882a593Smuzhiyun  Required properties:
27*4882a593Smuzhiyun  - reg: Must be 0, 1 or 2, corresponding to IN1, IN2 or IN3 port of INA3221
28*4882a593Smuzhiyun
29*4882a593Smuzhiyun  Optional properties:
30*4882a593Smuzhiyun  - label: Name of the input source
31*4882a593Smuzhiyun  - shunt-resistor-micro-ohms: Shunt resistor value in micro-Ohm
32*4882a593Smuzhiyun
33*4882a593SmuzhiyunExample:
34*4882a593Smuzhiyun
35*4882a593Smuzhiyunina3221@40 {
36*4882a593Smuzhiyun	compatible = "ti,ina3221";
37*4882a593Smuzhiyun	reg = <0x40>;
38*4882a593Smuzhiyun	#address-cells = <1>;
39*4882a593Smuzhiyun	#size-cells = <0>;
40*4882a593Smuzhiyun
41*4882a593Smuzhiyun	input@0 {
42*4882a593Smuzhiyun		reg = <0x0>;
43*4882a593Smuzhiyun		status = "disabled";
44*4882a593Smuzhiyun	};
45*4882a593Smuzhiyun	input@1 {
46*4882a593Smuzhiyun		reg = <0x1>;
47*4882a593Smuzhiyun		shunt-resistor-micro-ohms = <5000>;
48*4882a593Smuzhiyun	};
49*4882a593Smuzhiyun	input@2 {
50*4882a593Smuzhiyun		reg = <0x2>;
51*4882a593Smuzhiyun		label = "VDD_5V";
52*4882a593Smuzhiyun		shunt-resistor-micro-ohms = <5000>;
53*4882a593Smuzhiyun	};
54*4882a593Smuzhiyun};
55