adi,max31827.yaml

  1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
  2%YAML 1.2
  3---
  4$id: http://devicetree.org/schemas/hwmon/adi,max31827.yaml#
  5$schema: http://devicetree.org/meta-schemas/core.yaml#
  6
  7title: Analog Devices MAX31827, MAX31828, MAX31829 Low-Power Temperature Switch
  8
  9maintainers:
 10  - Daniel Matyas <daniel.matyas@analog.com>
 11
 12description: |
 13  Analog Devices MAX31827, MAX31828, MAX31829 Low-Power Temperature Switch with
 14  I2C Interface
 15  https://www.analog.com/media/en/technical-documentation/data-sheets/MAX31827-MAX31829.pdf
 16
 17properties:
 18  compatible:
 19    oneOf:
 20      - const: adi,max31827
 21      - items:
 22          - enum:
 23              - adi,max31828
 24              - adi,max31829
 25          - const: adi,max31827
 26
 27  reg:
 28    maxItems: 1
 29
 30  vref-supply:
 31    description:
 32      Must have values in the interval (1.6V; 3.6V) in order for the device to
 33      function correctly.
 34
 35  adi,comp-int:
 36    description:
 37      If present interrupt mode is used. If not present comparator mode is used
 38      (default).
 39    type: boolean
 40
 41  adi,alarm-pol:
 42    description:
 43      Sets the alarms active state.
 44            - 0 = active low
 45            - 1 = active high
 46    $ref: /schemas/types.yaml#/definitions/uint32
 47    enum: [0, 1]
 48
 49  adi,fault-q:
 50    description:
 51      Select how many consecutive temperature faults must occur before
 52      overtemperature or undertemperature faults are indicated in the
 53      corresponding status bits.
 54    $ref: /schemas/types.yaml#/definitions/uint32
 55    enum: [1, 2, 4, 8]
 56
 57  adi,timeout-enable:
 58    description:
 59      Enables timeout. Bus timeout resets the I2C-compatible interface when SCL
 60      is low for more than 30ms (nominal).
 61    type: boolean
 62
 63allOf:
 64  - if:
 65      properties:
 66        compatible:
 67          contains:
 68            const: adi,max31829
 69
 70    then:
 71      properties:
 72        adi,alarm-pol:
 73          default: 1
 74
 75    else:
 76      properties:
 77        adi,alarm-pol:
 78          default: 0
 79
 80  - if:
 81      properties:
 82        compatible:
 83          contains:
 84            const: adi,max31827
 85
 86    then:
 87      properties:
 88        adi,fault-q:
 89          default: 1
 90
 91    else:
 92      properties:
 93        adi,fault-q:
 94          default: 4
 95
 96required:
 97  - compatible
 98  - reg
 99  - vref-supply
100
101additionalProperties: false
102
103examples:
104  - |
105    i2c {
106        #address-cells = <1>;
107        #size-cells = <0>;
108
109        temperature-sensor@42 {
110            compatible = "adi,max31827";
111            reg = <0x42>;
112            vref-supply = <&reg_vdd>;
113            adi,comp-int;
114            adi,alarm-pol = <0>;
115            adi,fault-q = <1>;
116            adi,timeout-enable;
117        };
118    };
119...