linux-kernel - Re: [PATCH v2 1/2] dt-bindings: sound: atmel,classd: Convert to json-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] [thread-next>] [day] [month] [year] [list]

Date:   Tue, 12 Jul 2022 10:12:41 +0200
From:   Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>
To:     Ryan.Wanner@...rochip.com, lgirdwood@...il.com, broonie@...nel.org,
        robh+dt@...nel.org, krzysztof.kozlowski+dt@...aro.org,
        nicolas.ferre@...rochip.com, alexandre.belloni@...tlin.com,
        claudiu.beznea@...rochip.com
Cc:     alsa-devel@...a-project.org, devicetree@...r.kernel.org,
        linux-arm-kernel@...ts.infradead.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2 1/2] dt-bindings: sound: atmel,classd: Convert to
 json-schema

On 11/07/2022 20:30, Ryan.Wanner@...rochip.com wrote:
> From: Ryan Wanner <Ryan.Wanner@...rochip.com>
> 
> Convert atmel CLASSD devicetree binding to json-schema.
> Change file name to match json-schema naming.
> 
> Signed-off-by: Ryan Wanner <Ryan.Wanner@...rochip.com>
> ---
> v1 -> v2:
> - Fix title.

Still wrong subsystem prefix. use git log --oneline --

> - Fix formatting.
> - Removed trivial descriptions.
> - Fix filename.
> 
>  .../bindings/sound/atmel,sama5d2-classd.yaml  | 104 ++++++++++++++++++
>  .../bindings/sound/atmel-classd.txt           |  55 ---------
>  2 files changed, 104 insertions(+), 55 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/sound/atmel,sama5d2-classd.yaml
>  delete mode 100644 Documentation/devicetree/bindings/sound/atmel-classd.txt
> 
> diff --git a/Documentation/devicetree/bindings/sound/atmel,sama5d2-classd.yaml b/Documentation/devicetree/bindings/sound/atmel,sama5d2-classd.yaml
> new file mode 100644
> index 000000000000..9ef8c6dde8a8
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/atmel,sama5d2-classd.yaml
> @@ -0,0 +1,104 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +# Copyright (C) 2022 Microchip Technology, Inc. and its subsidiaries
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/atmel,sama5d2-classd.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Atmel ClassD Amplifier
> +
> +maintainers:
> +  - Nicolas Ferre <nicolas.ferre@...rochip.com>
> +  - Alexandre Belloni <alexandre.belloni@...tlin.com>
> +  - Claudiu Beznea <claudiu.beznea@...rochip.com>
> +
> +description:
> +  The Audio Class D Amplifier (CLASSD) is a digital input, Pulse Width Modulated (PWM)

Wrap at 80, like Linux coding style asks for.

> +  output stereo Class D amplifier.
> +
> +properties:
> +  compatible:
> +    const: atmel,sama5d2-classd
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  dmas:
> +    maxItems: 1
> +
> +  dma-names:
> +    const: tx
> +
> +  clocks:
> +    maxItems: 2
> +
> +  clock-names:
> +    items:
> +      - const: pclk
> +      - const: gclk
> +
> +  assigned-clocks:
> +    maxItems: 1
> +    description: classd_gclk

Usually assigned-clocks are not mentioned (they come from core schema),
so why do you need to add it? Maybe just skip it.

> +
> +  atmel,model:
> +    $ref: /schemas/types.yaml#/definitions/string
> +    description: The user-visible name of this sound complex.
> +    default: CLASSD
> +
> +  atmel,pwm-type:
> +    $ref: /schemas/types.yaml#/definitions/string
> +    enum:
> +      - single
> +      - diff
> +    default: single
> +    description: PWM modulation type, "single" or "diff".

Remove last part - , "single" or "diff" - it duplicates enum.

> +
> +  atmel,non-overlap-time:
> +    description:
> +      Set non-overlapping time, the unit is nanosecond(ns).
> +      Non-overlapping will be disabled if not specified.

Keep description in consistent place, so either as first property or
last. Don't mix.

> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    enum:
> +      - 5
> +      - 10
> +      - 15
> +      - 20
> +    default: 10
> +

Best regards,
Krzysztof