[PATCH v2] ASoC: dt-bindings: Convert eukrea-tlv320.txt to yaml

[PATCH v2] ASoC: dt-bindings: Convert eukrea-tlv320.txt to yaml

[Frank Li via B4 Relay]

From: Frank Li <Frank.Li@nxp.com>

Convert eukrea-tlv320.txt to yaml format.

Signed-off-by: Frank Li <Frank.Li@nxp.com>
---
change in v2
- Add comments about "The AUDMUX port numbering should start at 1"
  v1: https://lore.kernel.org/linux-devicetree/CAEnQRZACes8EptdEgg0i0vzdcxgUJwZAfQHU0DEhMnXtA-g01Q@mail.gmail.com/
---
 .../bindings/sound/eukrea,asoc-tlv320.yaml         | 55 ++++++++++++++++++++++
 .../devicetree/bindings/sound/eukrea-tlv320.txt    | 26 ----------
 2 files changed, 55 insertions(+), 26 deletions(-)

diff --git a/Documentation/devicetree/bindings/sound/eukrea,asoc-tlv320.yaml b/Documentation/devicetree/bindings/sound/eukrea,asoc-tlv320.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..a95cd0323f6e489765deb8c1d1eee966750ac7aa
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/eukrea,asoc-tlv320.yaml
@@ -0,0 +1,55 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/eukrea,asoc-tlv320.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Audio complex for Eukrea boards with tlv320aic23 codec.
+
+maintainers:
+  - Frank Li <Frank.Li@nxp.com>
+
+properties:
+  compatible:
+    const: eukrea,asoc-tlv320
+
+  eukrea,model:
+    $ref: /schemas/types.yaml#/definitions/string
+    description:
+      The user-visible name of this sound complex.
+
+  ssi-controller:
+    $ref: /schemas/types.yaml#/definitions/phandle
+    description:
+      The phandle of the SSI controller.
+
+  fsl,mux-int-port:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+      The internal port of the i.MX audio muxer (AUDMUX).
+      Note: The AUDMUX port numbering should start at 1, which is consistent with
+      hardware manual.
+
+  fsl,mux-ext-port:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+      The external port of the i.MX audio muxer.
+      Note: The AUDMUX port numbering should start at 1, which is consistent with
+      hardware manual.
+
+required:
+  - compatible
+  - eukrea,model
+  - ssi-controller
+
+additionalProperties: false
+
+examples:
+  - |
+    sound {
+        compatible = "eukrea,asoc-tlv320";
+        eukrea,model = "imx51-eukrea-tlv320aic23";
+        ssi-controller = <&ssi2>;
+        fsl,mux-int-port = <2>;
+        fsl,mux-ext-port = <3>;
+    };
diff --git a/Documentation/devicetree/bindings/sound/eukrea-tlv320.txt b/Documentation/devicetree/bindings/sound/eukrea-tlv320.txt
deleted file mode 100644
index 6dfa88c4dc1e8b3aea1e39b79eaa62185e64c240..0000000000000000000000000000000000000000
--- a/Documentation/devicetree/bindings/sound/eukrea-tlv320.txt
+++ /dev/null
@@ -1,26 +0,0 @@
-Audio complex for Eukrea boards with tlv320aic23 codec.
-
-Required properties:
-
-  - compatible		: "eukrea,asoc-tlv320"
-
-  - eukrea,model	: The user-visible name of this sound complex.
-
-  - ssi-controller	: The phandle of the SSI controller.
-
-  - fsl,mux-int-port	: The internal port of the i.MX audio muxer (AUDMUX).
-
-  - fsl,mux-ext-port	: The external port of the i.MX audio muxer.
-
-Note: The AUDMUX port numbering should start at 1, which is consistent with
-hardware manual.
-
-Example:
-
-	sound {
-		compatible = "eukrea,asoc-tlv320";
-		eukrea,model = "imx51-eukrea-tlv320aic23";
-		ssi-controller = <&ssi2>;
-		fsl,mux-int-port = <2>;
-		fsl,mux-ext-port = <3>;
-	};

---
base-commit: b7719f5647f279b131c888e70c77dd9287b322d8
change-id: 20260511-eukrea-e1e4d6df850c

Best regards,
--
Frank Li <Frank.Li@nxp.com>

Re: [PATCH v2] ASoC: dt-bindings: Convert eukrea-tlv320.txt to yaml

[sashiko-bot]

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Medium] The properties `fsl,mux-int-port` and `fsl,mux-ext-port` are omitted from the `required` list in the new YAML binding schema.
--

commit 5251ce7d6c30896b16c3da8622760278420a910b
Author: Frank Li <Frank.Li@nxp.com>

ASoC: dt-bindings: Convert eukrea-tlv320.txt to yaml

This commit converts the eukrea-tlv320 device tree binding documentation
from plain text to the YAML schema format.

> diff --git a/Documentation/devicetree/bindings/sound/eukrea,asoc-tlv320.yaml b/Documentation/devicetree/bindings/sound/eukrea,asoc-tlv320.yaml
> new file mode 100644
> index 0000000000000..a95cd0323f6e4
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/eukrea,asoc-tlv320.yaml

[ ... ]

> +required:
> +  - compatible
> +  - eukrea,model
> +  - ssi-controller
> +
> +additionalProperties: false

Should fsl,mux-int-port and fsl,mux-ext-port be included in this required 
list? 

In the original eukrea-tlv320.txt file being removed, both of these properties 
were explicitly listed under the Required properties section. 

Additionally, the kernel driver sound/soc/fsl/eukrea-tlv320.c appears to 
strictly check for these properties during probe, returning an error if they 
are missing. 

Does this omission introduce a regression where incomplete device tree nodes 
will silently pass dt_binding_check validation but fail at runtime?

[ ... ]

> diff --git a/Documentation/devicetree/bindings/sound/eukrea-tlv320.txt b/Documentation/devicetree/bindings/sound/eukrea-tlv320.txt
> deleted file mode 100644
> index 6dfa88c4dc1e8..0000000000000
> --- a/Documentation/devicetree/bindings/sound/eukrea-tlv320.txt
> +++ /dev/null
> @@ -1,26 +0,0 @@
> -Audio complex for Eukrea boards with tlv320aic23 codec.
> -
> -Required properties:
> -
> -  - compatible		: "eukrea,asoc-tlv320"
> -
> -  - eukrea,model	: The user-visible name of this sound complex.
> -
> -  - ssi-controller	: The phandle of the SSI controller.
> -
> -  - fsl,mux-int-port	: The internal port of the i.MX audio muxer (AUDMUX).
> -
> -  - fsl,mux-ext-port	: The external port of the i.MX audio muxer.

[ ... ]

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20260511-eukrea-v2-1-cac317290978@nxp.com?part=1