linux-kernel - Re: [PATCH] ASoC: dt-bindings: Add dt bindings definition file for imx28 saif

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: <mzlrm7zkzuue4xsxehz32ffiesigy2dzbos2osirzfoi525q6q@7klbgtmht74a>
Date: Wed, 28 Aug 2024 08:18:10 +0200
From: Krzysztof Kozlowski <krzk@...nel.org>
To: Lukasz Majewski <lukma@...x.de>
Cc: Rob Herring <robh@...nel.org>, 
	Krzysztof Kozlowski <krzk+dt@...nel.org>, Liam Girdwood <lgirdwood@...il.com>, 
	Mark Brown <broonie@...nel.org>, Fabio Estevam <festevam@...il.com>, 
	Conor Dooley <conor+dt@...nel.org>, devicetree@...r.kernel.org, linux-sound@...r.kernel.org, 
	linux-kernel@...r.kernel.org
Subject: Re: [PATCH] ASoC: dt-bindings: Add dt bindings definition file for
 imx28 saif

On Tue, Aug 27, 2024 at 08:05:28PM +0200, Lukasz Majewski wrote:
> This file allows correct check of DTS node for imx287 based
> "fsl,imx28-saif" compatible device.
> 
> It corresponds to Documentation/devicetree/bindings/fsl,imx28-saif
> 
> Signed-off-by: Lukasz Majewski <lukma@...x.de>
> ---
>  .../devicetree/bindings/sound/fsl,saif.yaml   | 79 +++++++++++++++++++
>  1 file changed, 79 insertions(+)

There is a binding. Please perform conversion from TXT to DT schema,
mentioning in commit msg any changes from pure conversion (e.g. new
properties to match DTS).

Few more comments below.

>  create mode 100644 Documentation/devicetree/bindings/sound/fsl,saif.yaml
> 
> diff --git a/Documentation/devicetree/bindings/sound/fsl,saif.yaml b/Documentation/devicetree/bindings/sound/fsl,saif.yaml
> new file mode 100644
> index 000000000000..747faa411a50
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/fsl,saif.yaml
> @@ -0,0 +1,79 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/fsl,saif.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Freescale MXS Serial Audio Interface (SAIF)
> +
> +maintainers:
> +  - Lukasz Majewski <lukma@...x.de>
> +
> +description: |

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

> +  The SAIF is based on I2S module that is used to communicate with audio codecs,
> +  but only with half-duplex manner (i.e. it can either transmit or receive PCM
> +  audio).
> +
> +properties:
> +  compatible:
> +    const: fsl,imx28-saif
> +
> +  reg:
> +    maxItems: 1
> +
> +  "#sound-dai-cells":
> +    const: 0
> +
> +  assigned-clock-parents: true
> +  assigned-clock-rates: true
> +  assigned-clocks: true

These three should be dropped, redundant.

> +
> +  interrupts:
> +    maxItems: 1
> +
> +  dmas:
> +    maxItems: 1
> +
> +  dma-names:
> +    const: rx-tx
> +
> +  clocks:
> +    maxItems: 1
> +
> +  fsl,saif-master:
> +    description: Indicate that saif is a slave and its phandle points to master
> +    $ref: /schemas/types.yaml#/definitions/phandle
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - clocks
> +  - dmas
> +  - dma-names
> +  - "#sound-dai-cells"

Keep the same order as in "properties:" block.

and here allOf: with $ref to dai-common.yaml

> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    saif0: saif@...42000 {
> +        #sound-dai-cells = <0>;
> +        compatible = "fsl,imx28-saif";
> +        reg = <0x80042000 2000>;
> +        interrupts = <59>;
> +        clocks = <&clks 53>;
> +        dmas = <&dma_apbx 4>;
> +        dma-names = "rx-tx";
> +    };
> +  - |
> +    saif1: saif@...46000 {

Just one example, could be this one as more complete.

> +        #sound-dai-cells = <0>;

Keep it after "reg" (compatible and reg are always first).

Best regards,
Krzysztof