Linux IIO development
 help / color / mirror / Atom feed
From: Jonathan Cameron <jic23@kernel.org>
To: Navin Sankar Velliangiri <navin@linumiz.com>
Cc: lars@metafoo.de, pmeerw@pmeerw.net, linux-iio@vger.kernel.org
Subject: Re: [PATCH 2/2] dt-bindings: iio: temperature: add MAXIM max31865 support
Date: Sat, 3 Jul 2021 15:56:11 +0100	[thread overview]
Message-ID: <20210703155611.2971eea8@jic23-huawei> (raw)
In-Reply-To: <20210703095954.221281-1-navin@linumiz.com>

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.

> +    };
> +...


      reply	other threads:[~2021-07-03 14:53 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-03  9:59 [PATCH 2/2] dt-bindings: iio: temperature: add MAXIM max31865 support Navin Sankar Velliangiri
2021-07-03 14:56 ` Jonathan Cameron [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210703155611.2971eea8@jic23-huawei \
    --to=jic23@kernel.org \
    --cc=lars@metafoo.de \
    --cc=linux-iio@vger.kernel.org \
    --cc=navin@linumiz.com \
    --cc=pmeerw@pmeerw.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox