GNU Linux-libre 6.1.90-gnu
[releases.git] / Documentation / devicetree / bindings / hwmon / ti,tmp401.yaml
1 # SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/hwmon/ti,tmp401.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: TMP401, TPM411 and TMP43x temperature sensor
8
9 maintainers:
10   - Guenter Roeck <linux@roeck-us.net>
11
12 description: |
13   ±1°C Remote and Local temperature sensor
14
15   Datasheets:
16   https://www.ti.com/lit/ds/symlink/tmp401.pdf
17   https://www.ti.com/lit/ds/symlink/tmp411.pdf
18   https://www.ti.com/lit/ds/symlink/tmp431.pdf
19   https://www.ti.com/lit/ds/symlink/tmp435.pdf
20
21 properties:
22   compatible:
23     enum:
24       - ti,tmp401
25       - ti,tmp411
26       - ti,tmp431
27       - ti,tmp432
28       - ti,tmp435
29
30   reg:
31     maxItems: 1
32
33   ti,extended-range-enable:
34     description:
35       When set, this sensor measures over extended temperature range.
36     type: boolean
37
38   ti,n-factor:
39     description:
40       value to be used for converting remote channel measurements to
41       temperature.
42     $ref: /schemas/types.yaml#/definitions/int32
43     minimum: -128
44     maximum: 127
45
46   ti,beta-compensation:
47     description:
48       value to select beta correction range.
49     $ref: /schemas/types.yaml#/definitions/uint32
50     minimum: 0
51     maximum: 15
52
53 allOf:
54   - if:
55       properties:
56         compatible:
57           contains:
58             enum:
59               - ti,tmp401
60     then:
61       properties:
62         ti,n-factor: false
63
64   - if:
65       properties:
66         compatible:
67           contains:
68             enum:
69               - ti,tmp401
70               - ti,tmp411
71     then:
72       properties:
73         ti,beta-compensation: false
74
75 required:
76   - compatible
77   - reg
78
79 additionalProperties: false
80
81 examples:
82   - |
83     i2c {
84       #address-cells = <1>;
85       #size-cells = <0>;
86
87       sensor@4c {
88         compatible = "ti,tmp401";
89         reg = <0x4c>;
90       };
91     };
92   - |
93     i2c {
94       #address-cells = <1>;
95       #size-cells = <0>;
96
97       sensor@4c {
98         compatible = "ti,tmp431";
99         reg = <0x4c>;
100         ti,extended-range-enable;
101         ti,n-factor = <0x3b>;
102         ti,beta-compensation = <0x7>;
103       };
104     };