xref: /linux/Documentation/devicetree/bindings/hwmon/ti,tmp513.yaml (revision e7e86d7697c6ed1dbbde18d7185c35b6967945ed) 
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
23
24properties:
25  compatible:
26    enum:
27      - ti,tmp512
28      - ti,tmp513
29
30  reg:
31    maxItems: 1
32
33  shunt-resistor-micro-ohms:
34    description: |
35      If 0, the calibration process will be skipped and the current and power
36      measurement engine will not work. Temperature and voltage measurement
37      will continue to work. The shunt value also need to respect:
38      rshunt <= pga-gain * 40 * 1000 * 1000.
39      If not, it's not possible to compute a valid calibration value.
40    default: 1000
41
42  ti,pga-gain:
43    description: |
44      The gain value for the PGA function. This is 8, 4, 2 or 1.
45      The PGA gain affect the shunt voltage range.
46      The range will be equal to: pga-gain * 40mV
47    $ref: /schemas/types.yaml#/definitions/uint32
48    enum: [1, 2, 4, 8]
49    default: 8
50
51  ti,bus-range-microvolt:
52    description: |
53      This is the operating range of the bus voltage in microvolt
54    enum: [16000000, 32000000]
55    default: 32000000
56
57  ti,nfactor:
58    description: |
59      Array of three(TMP513) or two(TMP512) n-Factor value for each remote
60      temperature channel.
61      See datasheet Table 11 for n-Factor range list and value interpretation.
62    $ref: /schemas/types.yaml#/definitions/uint32-array
63    minItems: 2
64    maxItems: 3
65    items:
66      default: 0x00
67      minimum: 0x00
68      maximum: 0xFF
69
70required:
71  - compatible
72  - reg
73
74allOf:
75  - $ref: hwmon-common.yaml#
76
77unevaluatedProperties: false
78
79examples:
80  - |
81    i2c {
82        #address-cells = <1>;
83        #size-cells = <0>;
84
85        tmp513@5c {
86            compatible = "ti,tmp513";
87            reg = <0x5c>;
88            shunt-resistor-micro-ohms = <330000>;
89            ti,bus-range-microvolt = <32000000>;
90            ti,pga-gain = <8>;
91            ti,nfactor = <0x1 0xf3 0x00>;
92        };
93    };
94