public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Krzysztof Kozlowski <krzk@kernel.org>
To: Robert Budai <robert.budai@analog.com>,
	Lars-Peter Clausen <lars@metafoo.de>,
	Michael Hennerich <Michael.Hennerich@analog.com>,
	Nuno Sa <nuno.sa@analog.com>,
	Ramona Gradinariu <ramona.gradinariu@analog.com>,
	Antoniu Miclaus <antoniu.miclaus@analog.com>,
	Jonathan Cameron <jic23@kernel.org>,
	Rob Herring <robh@kernel.org>,
	Krzysztof Kozlowski <krzk+dt@kernel.org>,
	Conor Dooley <conor+dt@kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-iio@vger.kernel.org, devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH 5/7] dt-bindings: iio: Add adis16550 bindings
Date: Mon, 25 Nov 2024 14:46:06 +0100	[thread overview]
Message-ID: <9eeae001-92b2-40da-ba75-b03c95eb7139@kernel.org> (raw)
In-Reply-To: <20241125133520.24328-6-robert.budai@analog.com>

On 25/11/2024 14:35, Robert Budai wrote:
> Document the ADIS16550 device devicetree bindings.
> 
> Co-developed-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
> Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
> Signed-off-by: Ramona Gradinariu <ramona.gradinariu@analog.com>
> Signed-off-by: Robert Budai <robert.budai@analog.com>
> ---
> 
> v2:
> - signed of by submitter
> 
>  .../bindings/iio/imu/adi,adis16550.yaml       | 97 +++++++++++++++++++
>  MAINTAINERS                                   |  9 ++
>  2 files changed, 106 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/imu/adi,adis16550.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/imu/adi,adis16550.yaml b/Documentation/devicetree/bindings/iio/imu/adi,adis16550.yaml
> new file mode 100644
> index 000000000000..767b500afbaa
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/imu/adi,adis16550.yaml
> @@ -0,0 +1,97 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/imu/adi,adis16550.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Analog Devices ADIS16550 and similar IMUs
> +
> +maintainers:
> +  - Nuno Sa <nuno.sa@analog.com>
> +  - Ramona Gradinariu <ramona.gradinariu@analog.com>
> +  - Antoniu Miclaus <antoniu.miclaus@analog.com>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - adi,adis16550
> +      - adi,adis16550w


What is the difference between them? You have description and commit msg
for this.

> +
> +  reg:
> +    maxItems: 1
> +
> +  spi-cpha: true
> +
> +  spi-cpol: true
> +
> +  spi-max-frequency:
> +    maximum: 15000000
> +
> +  vdd-supply: true
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  reset-gpios:
> +    description:
> +      Must be the device tree identifier of the RESET pin. If specified,

Do not describe DT syntax.
s/Must be the device tree identifier of the//
Instead something like "RESET active low pin".


> +      it will be asserted during driver probe. As the line is active low,
> +      it should be marked GPIO_ACTIVE_LOW.

This is false. It should not. Instead, it should be marked according to
the board design. You can have there inverter.

> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +    description: If not provided, then the internal clock is used.
> +
> +  adi,sync-mode:
> +    $ref: /schemas/types.yaml#/definitions/string

Do not redefine properties. You are stuck with what is there already :/

> +    description: |
> +      Configures the device SYNC pin.
> +      scaled_sync:  Device handles internally custom scaled
> +                    sync mode. It is stored in a designated register.
> +    enum:
> +      - direct_sync
> +      - scaled_sync
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - spi-cpha
> +  - spi-cpol
> +  - spi-max-frequency
> +  - vdd-supply
> +
> +allOf:
> +  - if:
> +      properties:
> +        adi,sync-mode:
> +          enum: [direct_sync, scaled_sync]

This does not make sense. There is no other option in this enum. Not
sure what you wanted to achieve here. If dependency on property then
required, see example-schema.

> +
> +    then:
> +      dependencies:
> +        adi,sync-mode: [ clocks ]
> +
> +  - $ref: /schemas/spi/spi-peripheral-props.yaml#
> +
> +additionalProperties: false

unevaluatedProperties false



Best regards,
Krzysztof

  reply	other threads:[~2024-11-25 13:46 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-11-25 13:35 [PATCH 0/7] adis16550-v2 Robert Budai
2024-11-25 13:35 ` [PATCH 1/7] iio: imu: adis: Remove documented not used elements Robert Budai
2024-11-30 17:08   ` Jonathan Cameron
2024-11-25 13:35 ` [PATCH 2/7] iio: imu: adis: Add custom ops struct Robert Budai
2024-11-30 17:13   ` Jonathan Cameron
2024-11-25 13:35 ` [PATCH 3/7] iio: imu: adis: Add reset to custom ops Robert Budai
2024-11-30 17:12   ` Jonathan Cameron
2024-11-25 13:35 ` [PATCH 4/7] iio: imu: adis: Add DIAG_STAT register size Robert Budai
2024-11-25 13:35 ` [PATCH 5/7] dt-bindings: iio: Add adis16550 bindings Robert Budai
2024-11-25 13:46   ` Krzysztof Kozlowski [this message]
2024-11-25 13:35 ` [PATCH 6/7] iio: imu: adis16550: add adis16550 support Robert Budai
2024-11-25 13:47   ` Krzysztof Kozlowski
2024-11-30 17:31   ` Jonathan Cameron
2024-11-25 13:35 ` [PATCH 7/7] docs: iio: add documentation for adis16550 driver Robert Budai
2024-11-25 14:22 ` [PATCH 0/7] adis16550-v2 Budai, Robert

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=9eeae001-92b2-40da-ba75-b03c95eb7139@kernel.org \
    --to=krzk@kernel.org \
    --cc=Michael.Hennerich@analog.com \
    --cc=antoniu.miclaus@analog.com \
    --cc=conor+dt@kernel.org \
    --cc=corbet@lwn.net \
    --cc=devicetree@vger.kernel.org \
    --cc=jic23@kernel.org \
    --cc=krzk+dt@kernel.org \
    --cc=lars@metafoo.de \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=nuno.sa@analog.com \
    --cc=ramona.gradinariu@analog.com \
    --cc=robert.budai@analog.com \
    --cc=robh@kernel.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