diff mbox series

[2/2] dt-bindings: iio: temperature: add MAXIM max31865 support

Message ID 20210703095954.221281-1-navin@linumiz.com (mailing list archive)
State Changes Requested
Headers show
Series [1/2] iio: temperature: Add MAX31865 RTD Support | expand

Commit Message

navin July 3, 2021, 9:59 a.m. UTC
Add DT bindings for MAXIM max31865 RTD sensor.

Signed-off-by: Navin Sankar Velliangiri <navin@linumiz.com>
---
 .../iio/temperature/maxim,max31865.yaml       | 52 +++++++++++++++++++
 1 file changed, 52 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/temperature/maxim,max31865.yaml

Comments

Jonathan Cameron July 3, 2021, 2:56 p.m. UTC | #1
On Sat,  3 Jul 2021 15:29:54 +0530
Navin Sankar Velliangiri <navin@linumiz.com> wrote:

> Add DT bindings for MAXIM max31865 RTD sensor.
> 
> Signed-off-by: Navin Sankar Velliangiri <navin@linumiz.com>

Hi Navin,

Welcome to IIO!

A few comments inline.

Thanks,

Jonathan

> ---
>  .../iio/temperature/maxim,max31865.yaml       | 52 +++++++++++++++++++
>  1 file changed, 52 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/temperature/maxim,max31865.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/temperature/maxim,max31865.yaml b/Documentation/devicetree/bindings/iio/temperature/maxim,max31865.yaml
> new file mode 100644
> index 000000000000..9efadea514e1
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/temperature/maxim,max31865.yaml
> @@ -0,0 +1,52 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/temperature/maxim,max31865.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Maxim MAX31865 RTD-to-Digital Converter.

Good to spell out RTD: Restance temperature detector

> +
> +maintainers:
> +  - Navin Sankar Velliangiri <navin@linumiz.com>
> +
> +description: |
> +  https://datasheets.maximintegrated.com/en/ds/MAX31865.pdf
> +
> +properties:
> +  compatible:
> +    const: maxim,max31865
> +
> +  reg:
> +    maxItems: 1
> +
> +  maxim,no-of-wires:
> +    description:
> +      Setting this property enables 3-wire config. Else
> +      2-wire or 4-wire.
> +    type: boolean

Either make this take a the value 2, 3 or 4 (my preference)
or potentially rename it as maxim,3-wire.

Whilst we can expect people to look at the binding docs if they need details, we
still want someone glancing at a dts file to know what the binding means and
that isn't true for this parameter as current defined.

> +
> +  spi-max-frequency: true
> +  spi-cpha: true
> +
> +required:
> +  - compatible
> +  - reg
> +  - spi-cpha
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    spi {
> +	#address-cells = <1>;
> +	#size-cells = <0>;
> +
> +	temp_sensor@0 {
> +		compatible = "maxim,max31865";
> +		reg = <0>;
> +		spi-max-frequency = <400000>;
> +		spi-cpha;
> +		maxim,no-of-wires;
> +	};

Some tabs in here, which means that a dt-schema check would have failed I think.
Please make sure you fix those up and run the tests as described in
Documentation/devicetree/bindings/writing-schema.rst
before sending v2.

> +    };
> +...
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/temperature/maxim,max31865.yaml b/Documentation/devicetree/bindings/iio/temperature/maxim,max31865.yaml
new file mode 100644
index 000000000000..9efadea514e1
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/temperature/maxim,max31865.yaml
@@ -0,0 +1,52 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/temperature/maxim,max31865.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Maxim MAX31865 RTD-to-Digital Converter.
+
+maintainers:
+  - Navin Sankar Velliangiri <navin@linumiz.com>
+
+description: |
+  https://datasheets.maximintegrated.com/en/ds/MAX31865.pdf
+
+properties:
+  compatible:
+    const: maxim,max31865
+
+  reg:
+    maxItems: 1
+
+  maxim,no-of-wires:
+    description:
+      Setting this property enables 3-wire config. Else
+      2-wire or 4-wire.
+    type: boolean
+
+  spi-max-frequency: true
+  spi-cpha: true
+
+required:
+  - compatible
+  - reg
+  - spi-cpha
+
+additionalProperties: false
+
+examples:
+  - |
+    spi {
+	#address-cells = <1>;
+	#size-cells = <0>;
+
+	temp_sensor@0 {
+		compatible = "maxim,max31865";
+		reg = <0>;
+		spi-max-frequency = <400000>;
+		spi-cpha;
+		maxim,no-of-wires;
+	};
+    };
+...