linux-kernel - Re: [RFC PATCH] ASoC: dt-bindings: adi,adau17x1: Convert to DT schema

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <fa6bfc86-23a7-0a2c-8819-ca76d1086238@linaro.org>
Date:   Sun, 12 Mar 2023 11:52:44 +0100
From:   Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>
To:     Vijaya Anand <sunrockers8@...il.com>, lgirdwood@...il.com,
        broonie@...nel.org, robh+dt@...nel.org,
        krzysztof.kozlowski+dt@...aro.org, alsa-devel@...a-project.org,
        devicetree@...r.kernel.org, linux-kernel@...r.kernel.org
Cc:     Daniel Baluta <daniel.baluta@....com>
Subject: Re: [RFC PATCH] ASoC: dt-bindings: adi,adau17x1: Convert to DT schema

On 11/03/2023 21:03, Vijaya Anand wrote:
> Convert the binding document for adi,adau17x1 from txt to yaml
> so one could validate dt-entries correctly and any future additions
> can go into yaml format. Add address and size cells to example to
> prevent errors regarding reg format.
> 
> Signed-off-by: Vijaya Anand <sunrockers8@...il.com>
> Cc: Daniel Baluta <daniel.baluta@....com>

Thank you for your patch. There is something to discuss/improve.

> -Examples:
> -#include <dt-bindings/sound/adau17x1.h>
> -
> -	i2c_bus {
> -		adau1361@38 {
> -			compatible = "adi,adau1761";
> -			reg = <0x38>;
> -
> -			clock-names = "mclk";
> -			clocks = <&audio_clock>;
> -		};
> -	};
> diff --git a/Documentation/devicetree/bindings/sound/adi,adau17x1.yaml b/Documentation/devicetree/bindings/sound/adi,adau17x1.yaml
> new file mode 100644
> index 000000000000..9c1dbf2b4e70
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/adi,adau17x1.yaml
> @@ -0,0 +1,52 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/adi,adau17x1.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Analog Devices ADAU1361/ADAU1461/ADAU1761/ADAU1961/ADAU1381/ADAU1781

But what is this? Codec? Amplifier?

> +
> +maintainers:
> +  - Lars-Peter Clausen <lars@...afoo.de>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - adi,adau1361
> +      - adi,adau1461
> +      - adi,adau1761
> +      - adi,adau1961
> +      - adi,adau1381
> +      - adi,adau1781

Please put them in some order, e.g. alphabetical.

> +
> +  reg:
> +    maxItems: 1
> +    description: The i2c address. Value depends on the state of ADDR0 and ADDR1, as wired in hardware.

This exceeds 80 characters (see coding style).

> +
> +  clock-names:
> +    const: mclk
> +
> +  clocks:
> +    maxItems: 1
> +    description:
> +      phandle + clock-specifiers for the clock that provides the audio master
> +      clock for the device.

Drop "phandle + clock-specifiers for the " and make it simpler, just
items with description:

clocks
  items:
    - description: .......


> +
> +required:
> +  - compatible
> +  - reg
> +
> +unevaluatedProperties: false

Instead:
additionalProperties: false
Unless you plan to reference dai-common or component-common

> +
> +examples:
> +  - |
> +    i2c_bus {

i2c

> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +      adau1361@38 {

Node names should be generic.
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation

> +        compatible = "adi,adau1761";
> +        reg = <0x38>;
> +        clock-names = "mclk";
> +        clocks = <&audio_clock>;


Best regards,
Krzysztof