Devicetree
 help / color / mirror / Atom feed
From: Krzysztof Kozlowski <krzk@kernel.org>
To: Shrikant Raskar <raskar.shree97@gmail.com>
Cc: jic23@kernel.org, robh@kernel.org, krzk+dt@kernel.org,
	 conor+dt@kernel.org, dlechner@baylibre.com, nuno.sa@analog.com,
	andy@kernel.org,  heiko@sntech.de, neil.armstrong@linaro.org,
	skhan@linuxfoundation.org,  david.hunter.linux@gmail.com,
	linux-iio@vger.kernel.org, devicetree@vger.kernel.org,
	 linux-kernel@vger.kernel.org
Subject: Re: [PATCH 1/3] dt-bindings: iio: proximity: Add YAML binding for RFD77402 ToF sensor
Date: Wed, 26 Nov 2025 10:53:23 +0100	[thread overview]
Message-ID: <20251126-cautious-eagle-from-sirius-83fe52@kuoka> (raw)
In-Reply-To: <20251126031440.30065-2-raskar.shree97@gmail.com>

On Wed, Nov 26, 2025 at 08:44:38AM +0530, Shrikant Raskar wrote:
> The RFD77402 driver has existed without a formal device tree binding
> description. With the recent addition of Device Tree support and
> interrupt handling in the driver, it is now necessary to document
> the DT properties used for configuring the device.

This is all irrelevant here. It does not matter for the bindings if the
driver existed or not.

Please rather document here the hardware.

A nit, subject: drop second/last, redundant "YAML binding for". The
"dt-bindings" prefix is already stating that these are bindings.
See also:
https://elixir.bootlin.com/linux/v6.17-rc3/source/Documentation/devicetree/bindings/submitting-patches.rst#L18
For sure don't use "YAML binding" - there is no such thing.

> 
> Since the binding introduces the compatible string "rfdigital,rfd77402",
> the "rfdigital" vendor prefix is also added to vendor-prefixes.yaml.

Also redundant, we can see the diff.

> 
> Signed-off-by: Shrikant Raskar <raskar.shree97@gmail.com>
> ---
>  .../iio/proximity/rfdigital,rfd77402.yaml     | 55 +++++++++++++++++++
>  .../devicetree/bindings/vendor-prefixes.yaml  |  2 +
>  2 files changed, 57 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/proximity/rfdigital,rfd77402.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/proximity/rfdigital,rfd77402.yaml b/Documentation/devicetree/bindings/iio/proximity/rfdigital,rfd77402.yaml
> new file mode 100644
> index 000000000000..93deaa4e8b7a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/proximity/rfdigital,rfd77402.yaml
> @@ -0,0 +1,55 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/proximity/rfdigital,rfd77402.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: RF Digital RFD77402 ToF sensor
> +
> +maintainers:
> +  - Shrikant Raskar <raskar.shree97@gmail.com>
> +
> +description: |

Do not need '|' unless you need to preserve formatting.

> +  The RF Digital RFD77402 is a Time-of-Flight (ToF) proximity and distance
> +  sensor providing up to 200 mm range measurement over an I2C interface.
> +
> +properties:
> +  compatible:
> +    const: rfdigital,rfd77402
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +    description: |

Same, also a bit odd wrapping of the text below

> +      Generated by the device to announce that a new
> +      measurement data is ready in result register.
> +
> +  vdd-supply:
> +    description: Regulator that provides power to the sensor
> +
> +  vddio-supply:
> +    description: Regulator providing I/O interface voltage
> +
> +required:
> +  - compatible
> +  - reg

supplies should be required, devices rarely work without power. If you
think hardware works without power, this is something unusual thus you
should explain it in the commit msg.

> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +    i2c {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        proximity@4c {
> +            compatible = "rfdigital,rfd77402";
> +            reg = <0x4c>;
> +            interrupt-parent = <&gpio>;
> +            interrupts = <4 IRQ_TYPE_EDGE_FALLING>;

Supplies

Best regards,
Krzysztof


  reply	other threads:[~2025-11-26  9:53 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-26  3:14 [PATCH 0/3] iio: proximity: Add DT and interrupt support for RFD77402 Shrikant Raskar
2025-11-26  3:14 ` [PATCH 1/3] dt-bindings: iio: proximity: Add YAML binding for RFD77402 ToF sensor Shrikant Raskar
2025-11-26  9:53   ` Krzysztof Kozlowski [this message]
2025-11-26 18:09     ` Shrikant
2025-11-26  3:14 ` [PATCH 2/3] iio: proximity: rfd77402: Add Device Tree support Shrikant Raskar
2025-11-26  6:53   ` Andy Shevchenko
2025-11-26  3:14 ` [PATCH 3/3] iio: proximity: rfd77402: Add interrupt handling support Shrikant Raskar
2025-11-26  7:35   ` Andy Shevchenko
2025-11-28 16:06     ` Shrikant
2025-12-07 15:47       ` Jonathan Cameron

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=20251126-cautious-eagle-from-sirius-83fe52@kuoka \
    --to=krzk@kernel.org \
    --cc=andy@kernel.org \
    --cc=conor+dt@kernel.org \
    --cc=david.hunter.linux@gmail.com \
    --cc=devicetree@vger.kernel.org \
    --cc=dlechner@baylibre.com \
    --cc=heiko@sntech.de \
    --cc=jic23@kernel.org \
    --cc=krzk+dt@kernel.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=neil.armstrong@linaro.org \
    --cc=nuno.sa@analog.com \
    --cc=raskar.shree97@gmail.com \
    --cc=robh@kernel.org \
    --cc=skhan@linuxfoundation.org \
    /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