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