xref: /linux/Documentation/devicetree/bindings/hwmon/ti,tmp513.yaml (revision d30c1683aaecb93d2ab95685dc4300a33d3cea7a) 
1# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/hwmon/ti,tmp513.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: TMP513/512 system monitor sensor
8
9maintainers:
10  - Eric Tremblay <etremblay@distech-controls.com>
11
12description: |
13  The TMP512 (dual-channel) and TMP513 (triple-channel) are system monitors
14  that include remote sensors, a local temperature sensor, and a high-side
15  current shunt monitor. These system monitors have the capability of measuring
16  remote temperatures, on-chip temperatures, and system voltage/power/current
17  consumption.
18
19  Datasheets:
20  https://www.ti.com/lit/gpn/tmp513
21  https://www.ti.com/lit/gpn/tmp512
22
23properties:
24  compatible:
25    enum:
26      - ti,tmp512
27      - ti,tmp513
28
29  reg:
30    maxItems: 1
31
32  shunt-resistor-micro-ohms:
33    description: |
34      If 0, the calibration process will be skipped and the current and power
35      measurement engine will not work. Temperature and voltage measurement
36      will continue to work. The shunt value also need to respect:
37      rshunt <= pga-gain * 40 * 1000 * 1000.
38      If not, it's not possible to compute a valid calibration value.
39    default: 1000
40
41  ti,pga-gain:
42    description: |
43      The gain value for the PGA function. This is 8, 4, 2 or 1.
44      The PGA gain affect the shunt voltage range.
45      The range will be equal to: pga-gain * 40mV
46    $ref: /schemas/types.yaml#/definitions/uint32
47    enum: [1, 2, 4, 8]
48    default: 8
49
50  ti,bus-range-microvolt:
51    description: |
52      This is the operating range of the bus voltage in microvolt
53    enum: [16000000, 32000000]
54    default: 32000000
55
56  ti,nfactor:
57    description: |
58      Array of three(TMP513) or two(TMP512) n-Factor value for each remote
59      temperature channel.
60      See datasheet Table 11 for n-Factor range list and value interpretation.
61    $ref: /schemas/types.yaml#/definitions/uint32-array
62    minItems: 2
63    maxItems: 3
64    items:
65      default: 0x00
66      minimum: 0x00
67      maximum: 0xFF
68
69required:
70  - compatible
71  - reg
72
73allOf:
74  - $ref: hwmon-common.yaml#
75
76unevaluatedProperties: false
77
78examples:
79  - |
80    i2c {
81        #address-cells = <1>;
82        #size-cells = <0>;
83
84        tmp513@5c {
85            compatible = "ti,tmp513";
86            reg = <0x5c>;
87            shunt-resistor-micro-ohms = <330000>;
88            ti,bus-range-microvolt = <32000000>;
89            ti,pga-gain = <8>;
90            ti,nfactor = <0x1 0xf3 0x00>;
91        };
92    };
93