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