linux-kernel - Re: [PATCH] dt-binding: sound: Convert atmel pdmic 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]

Message-ID: <8d71000b-e9d7-3586-5421-36a1fb367b5e@linaro.org>
Date:   Tue, 5 Jul 2022 19:56:28 +0200
From:   Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>
To:     Ryan.Wanner@...rochip.com, Claudiu.Beznea@...rochip.com,
        nicolas.ferre@...rochip.com, alexandre.berna@...rochip.com,
        robh+dt@...nel.org, krzysztof.kozlowski+dt@...aro.org
Cc:     linux-arm-kernel@...ts.infradead.org, linux-kernel@...r.kernel.org,
        devicetree@...r.kernel.org
Subject: Re: [PATCH] dt-binding: sound: Convert atmel pdmic to json-schema

On 05/07/2022 18:21, Ryan.Wanner@...rochip.com wrote:
> From: Ryan Wanner <Ryan.Wanner@...rochip.com>
> 
> Convert Atmel PDMIC devicetree binding to json-schema.
> Change file naming to match json-schema naming.
> 
> Signed-off-by: Ryan Wanner <Ryan.Wanner@...rochip.com>
> ---
>  .../bindings/sound/atmel,sama5d2-pdmic.yaml   | 104 ++++++++++++++++++
>  .../devicetree/bindings/sound/atmel-pdmic.txt |  55 ---------

You need to send the patches to proper folks with proper subject prefix.
Use get_maintainers.pl for the first and `git log --oneline --` for the
second.

>  2 files changed, 104 insertions(+), 55 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml
>  delete mode 100644 Documentation/devicetree/bindings/sound/atmel-pdmic.txt
> 
> diff --git a/Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml b/Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.yaml
> new file mode 100644
> index 000000000000..cb34c0fc4fc8
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/atmel,sama5d2-pdmic.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-pdmic.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Atmel PDMIC driver under ALSA SoC architecture

"driver" and ALSA are Linux specific, so this could be corrected during
conversion to name the hardware.

> +
> +maintainers:
> +  - Claudiu Beznea <claudiu.beznea@...rochip.com>
> +
> +description:
> +  Atmel Pulse Density Modulation Interface Controller
> +  (PDMIC) peripheral is a mono PDM decoder module
> +  that decodes an incoming PDM sample stream.
> +
> +properties:
> +  compatible:
> +    items:

One item, so no need for items.

> +      - const: atmel,sama5d2-pdmic
> +
> +  reg:
> +    description: Should contain PDMIC registers location and length.

Skip description, it's obvious.

> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  clocks:
> +    description:
> +      Must contain an entry for each required entry in clock-names.
> +      Please refer to clock-bindings.txt.

Skip description.

> +
> +    items:
> +      - description: peripheral clock.
> +      - description: generated clock.

Skip trailing dots, since you do not start with capital letter.

> +
> +  clock-names:
> +    items:
> +      - const: pclk
> +      - const: gclk
> +
> +  dmas:
> +    maxItems: 1
> +
> +  dma-names:
> +    const: rx
> +
> +  atmel,mic-min-freq:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    description:
> +      The minimal frequency that the microphone supports.
> +
> +  atmel,mic-max-freq:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    description:
> +      The maximal frequency that the microphone supports.
> +
> +  atmel,model:
> +    description: The user-visible name of this sound card.
> +    $ref: /schemas/types.yaml#/definitions/string
> +    default: PDMIC
> +
> +  atmel,mic-offset:
> +    $ref: /schemas/types.yaml#/definitions/int32
> +    description: The offset that should be added.
> +    default: 0
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - dmas
> +  - dma-names
> +  - clock-names
> +  - clocks
> +  - atmel,mic-min-freq
> +  - atmel,mic-max-freq
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/dma/at91.h>
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +
> +    pdmic: sound@...18000 {
> +              compatible = "atmel,sama5d2-pdmic";

Use four space for DTS indentation.

> +              reg = <0xf8018000 0x124>;
> +              interrupts = <48 IRQ_TYPE_LEVEL_HIGH 7>;
> +              dmas = <&dma0

Best regards,
Krzysztof