summaryrefslogtreecommitdiff
path: root/Documentation/devicetree/bindings/hwmon/ti,ina2xx.yaml
blob: 009d78b308596ca795bebdd160431bd718b127e0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/hwmon/ti,ina2xx.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Texas Instruments INA209 family of power/voltage monitors

maintainers:
  - Krzysztof Kozlowski <krzk@kernel.org>

description: |
  The INA209 is a high-side current shunt and power monitor with
  an I2C interface.

  Datasheets:
    https://www.ti.com/product/INA209

properties:
  compatible:
    enum:
      - silergy,sq52206
      - silergy,sy24655
      - ti,ina209
      - ti,ina219
      - ti,ina220
      - ti,ina226
      - ti,ina228
      - ti,ina230
      - ti,ina231
      - ti,ina233
      - ti,ina234
      - ti,ina237
      - ti,ina238
      - ti,ina260
      - ti,ina700
      - ti,ina780

  reg:
    maxItems: 1

  "#io-channel-cells":
    const: 1

  shunt-resistor:
    description:
      Shunt resistor value in micro-Ohm.
    $ref: /schemas/types.yaml#/definitions/uint32

  ti,shunt-gain:
    description: |
      Programmable gain divisor for the shunt voltage accuracy and range. This
      property only applies to devices that have configurable PGA/ADCRANGE. The
      gain value is used configure the gain and to convert the shunt voltage,
      current and power register values when reading measurements from the
      device.

      For devices that have a configurable PGA (e.g. INA209, INA219, INA220),
      the gain value maps directly with the PG bits of the config register.

      For devices that have ADCRANGE configuration (e.g. INA238) a shunt-gain
      value of 1 maps to ADCRANGE=1 where no gain divisor is applied to the
      shunt voltage, and a value of 4 maps to ADCRANGE=0 such that a wider
      voltage range is used.

      For SQ52206,the shunt-gain value 1 mapps to ADCRANGE=10/11, the value 2
      mapps to ADCRANGE=01, and the value 4 mapps to ADCRANGE=00.

      The default value is device dependent, and is defined by the reset value
      of PGA/ADCRANGE in the respective configuration registers.
    $ref: /schemas/types.yaml#/definitions/uint32
    enum: [1, 2, 4, 8]

  vs-supply:
    description: phandle to the regulator that provides the VS supply typically
      in range from 2.7 V to 5.5 V.

  ti,alert-polarity-active-high:
    description: Alert pin is asserted based on the value of Alert polarity Bit
      of Mask/Enable register. Default value is Normal (0 which maps to
      active-low open collector). The other value is Inverted
      (1 which maps to active-high open collector). Specify this property to set
      the alert polarity to active-high.
    $ref: /schemas/types.yaml#/definitions/flag

  ti,maximum-expected-current-microamp:
    description: |
      This value indicates the maximum current in microamps that you can
      expect to measure with ina233 in your circuit.

      This value will be used to calculate the Current_LSB and current/power
      coefficient for the pmbus and to calibrate the IC.
    minimum: 32768
    maximum: 4294967295
    default: 32768000

required:
  - compatible
  - reg

allOf:
  - $ref: hwmon-common.yaml#
  - if:
      properties:
        compatible:
          contains:
            enum:
              - silergy,sq52206
              - silergy,sy24655
              - ti,ina209
              - ti,ina219
              - ti,ina220
              - ti,ina226
              - ti,ina228
              - ti,ina230
              - ti,ina231
              - ti,ina234
              - ti,ina237
              - ti,ina238
              - ti,ina260
              - ti,ina700
              - ti,ina780
    then:
      properties:
        ti,maximum-expected-current-microamp: false

  - if:
      properties:
        compatible:
          contains:
            enum:
              - silergy,sy24655
              - ti,ina209
              - ti,ina219
              - ti,ina220
              - ti,ina226
              - ti,ina230
              - ti,ina231
              - ti,ina234
              - ti,ina260
              - ti,ina700
              - ti,ina780
    then:
      properties:
        ti,shunt-gain: false

  - if:
      properties:
        compatible:
          contains:
            enum:
              - ti,ina700
              - ti,ina780
    then:
      properties:
        shunt-resistor: false

unevaluatedProperties: false

examples:
  - |
    i2c {
        #address-cells = <1>;
        #size-cells = <0>;

        power-sensor@44 {
            compatible = "ti,ina220";
            reg = <0x44>;
            #io-channel-cells = <1>;
            label = "vdd_3v0";
            shunt-resistor = <1000>;
            vs-supply = <&vdd_3v0>;
            ti,alert-polarity-active-high;
        };
    };