dt-bindings:iio:temperature:maxim_thermocouple.txt to maxim,max31855k.yaml
authorJonathan Cameron <Jonathan.Cameron@huawei.com>
Sat, 31 Oct 2020 13:41:09 +0000 (13:41 +0000)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Mon, 16 Nov 2020 20:14:42 +0000 (20:14 +0000)
Given we already have another maxim thermocouple driver that isn't
covered by this binding it seems a better idea to chose to name it
after a specific part.

I added an additional example for the maxim,max6755 to illustrate
the need for spi-cpha for that part.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Reviewed-by: Rob Herring <robh@kernel.org>
Acked-by: Matt Ranostay <matt.ranostay@konsulko.com>
Link: https://lore.kernel.org/r/20201031134110.724233-29-jic23@kernel.org
Documentation/devicetree/bindings/iio/temperature/maxim,max31855k.yaml [new file with mode: 0644]
Documentation/devicetree/bindings/iio/temperature/maxim_thermocouple.txt [deleted file]

diff --git a/Documentation/devicetree/bindings/iio/temperature/maxim,max31855k.yaml b/Documentation/devicetree/bindings/iio/temperature/maxim,max31855k.yaml
new file mode 100644 (file)
index 0000000..9969bac
--- /dev/null
@@ -0,0 +1,76 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/temperature/maxim,max31855k.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Maxim MAX31855 and similar thermocouples
+
+maintainers:
+  - Matt Ranostay <matt.ranostay@konsulko.com>
+
+description: |
+  https://datasheets.maximintegrated.com/en/ds/MAX6675.pdf
+  https://datasheets.maximintegrated.com/en/ds/MAX31855.pdf
+
+properties:
+  compatible:
+    description:
+      The generic maxim,max31855 compatible is deprecated in favour of
+      the thermocouple type specific variants.
+    enum:
+      - maxim,max6675
+      - maxim,max31855
+      - maxim,max31855k
+      - maxim,max31855j
+      - maxim,max31855n
+      - maxim,max31855s
+      - maxim,max31855t
+      - maxim,max31855e
+      - maxim,max31855r
+
+  reg:
+    maxItems: 1
+
+  spi-max-frequency: true
+  spi-cpha: true
+
+required:
+  - compatible
+  - reg
+
+allOf:
+  - if:
+      properties:
+        compatible:
+          contains:
+            enum:
+              - maxim,max6675
+    then:
+      required:
+        - spi-cpha
+    else:
+      properties:
+        spi-cpha: false
+
+additionalProperties: false
+
+examples:
+  - |
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        temp-sensor@0 {
+            compatible = "maxim,max31855k";
+            reg = <0>;
+            spi-max-frequency = <4300000>;
+        };
+        temp-sensor@1 {
+            compatible = "maxim,max6675";
+            reg = <1>;
+            spi-max-frequency = <4300000>;
+            spi-cpha;
+        };
+    };
+...
diff --git a/Documentation/devicetree/bindings/iio/temperature/maxim_thermocouple.txt b/Documentation/devicetree/bindings/iio/temperature/maxim_thermocouple.txt
deleted file mode 100644 (file)
index bb85cd0..0000000
+++ /dev/null
@@ -1,24 +0,0 @@
-Maxim thermocouple support
-
-* https://datasheets.maximintegrated.com/en/ds/MAX6675.pdf
-* https://datasheets.maximintegrated.com/en/ds/MAX31855.pdf
-
-Required properties:
-
-       - compatible: must be "maxim,max6675" or one of the following:
-          "maxim,max31855k", "maxim,max31855j", "maxim,max31855n",
-          "maxim,max31855s", "maxim,max31855t", "maxim,max31855e",
-          "maxim,max31855r"; the generic "max,max31855" is deprecated.
-       - reg: SPI chip select number for the device
-       - spi-max-frequency: must be 4300000
-       - spi-cpha: must be defined for max6675 to enable SPI mode 1
-
-       Refer to spi/spi-bus.txt for generic SPI slave bindings.
-
-Example:
-
-       max31855@0 {
-               compatible = "maxim,max31855k";
-               reg = <0>;
-               spi-max-frequency = <4300000>;
-       };