xref: /freebsd/sys/contrib/device-tree/Bindings/hwmon/ti,ina2xx.yaml (revision a03411e84728e9b267056fd31c7d1d9d1dc1b01e) 
1# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2%YAML 1.2
3---
4
5$id: http://devicetree.org/schemas/hwmon/ti,ina2xx.yaml#
6$schema: http://devicetree.org/meta-schemas/core.yaml#
7
8title: Texas Instruments INA209 family of power/voltage monitors
9
10maintainers:
11  - Krzysztof Kozlowski <krzk@kernel.org>
12
13description: |
14  The INA209 is a high-side current shunt and power monitor with
15  an I2C interface.
16
17  Datasheets:
18    https://www.ti.com/product/INA209
19
20properties:
21  compatible:
22    enum:
23      - ti,ina209
24      - ti,ina219
25      - ti,ina220
26      - ti,ina226
27      - ti,ina230
28      - ti,ina231
29      - ti,ina238
30
31  reg:
32    maxItems: 1
33
34  shunt-resistor:
35    description:
36      Shunt resistor value in micro-Ohm.
37    $ref: /schemas/types.yaml#/definitions/uint32
38
39  ti,shunt-gain:
40    description: |
41      Programmable gain divisor for the shunt voltage accuracy and range. This
42      property only applies to devices that have configurable PGA/ADCRANGE. The
43      gain value is used configure the gain and to convert the shunt voltage,
44      current and power register values when reading measurements from the
45      device.
46
47      For devices that have a configurable PGA (e.g. INA209, INA219, INA220),
48      the gain value maps directly with the PG bits of the config register.
49
50      For devices that have ADCRANGE configuration (e.g. INA238) a shunt-gain
51      value of 1 maps to ADCRANGE=1 where no gain divisor is applied to the
52      shunt voltage, and a value of 4 maps to ADCRANGE=0 such that a wider
53      voltage range is used.
54
55      The default value is device dependent, and is defined by the reset value
56      of PGA/ADCRANGE in the respective configuration registers.
57    $ref: /schemas/types.yaml#/definitions/uint32
58    enum: [1, 2, 4, 8]
59
60  vs-supply:
61    description: phandle to the regulator that provides the VS supply typically
62      in range from 2.7 V to 5.5 V.
63
64required:
65  - compatible
66  - reg
67
68additionalProperties: false
69
70examples:
71  - |
72    i2c {
73        #address-cells = <1>;
74        #size-cells = <0>;
75
76        power-sensor@44 {
77            compatible = "ti,ina220";
78            reg = <0x44>;
79            shunt-resistor = <1000>;
80            vs-supply = <&vdd_3v0>;
81        };
82    };
83