[v3] ASoC: dt-bindings: realtek,alc5623: convert to DT schema

[PATCH v3] ASoC: dt-bindings: realtek,alc5623: convert to DT schema

Posted by Mahdi Khosravi 1 month, 4 weeks ago

I converted the alc5623 audio codec binding from text to DT schema.
This is my first try and I used make dt_binding_check & make dtbs_check to verify
without getting any errors.

Signed-off-by: Mahdi Khosravi <mmk1776@gmail.com>
---
Changes in v3:
- Drop allOf, just use $ref for uint32
- Remove stray '>' in descriptions
- Fix subject to "to DT schema"

Changes in v2:
- Add dai-common ref
- Switch add-ctrl/jack-det-ctrl to allOf uint32
- Use unevaluatedProperties
- Fix example compatible
---
 .../devicetree/bindings/sound/alc5623.txt     | 25 ---------
 .../bindings/sound/realtek,alc5623.yaml       | 52 +++++++++++++++++++
 2 files changed, 52 insertions(+), 25 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/sound/alc5623.txt
 create mode 100644 Documentation/devicetree/bindings/sound/realtek,alc5623.yaml

diff --git a/Documentation/devicetree/bindings/sound/alc5623.txt b/Documentation/devicetree/bindings/sound/alc5623.txt
deleted file mode 100644
index 26c86c98d671..000000000000
--- a/Documentation/devicetree/bindings/sound/alc5623.txt
+++ /dev/null
@@ -1,25 +0,0 @@
-ALC5621/ALC5622/ALC5623 audio Codec
-
-Required properties:
-
- - compatible:	"realtek,alc5623"
- - reg:		the I2C address of the device.
-
-Optional properties:
-
- - add-ctrl:	  Default register value for Reg-40h, Additional Control
-		  Register. If absent or has the value of 0, the
-		  register is untouched.
-
- - jack-det-ctrl: Default register value for Reg-5Ah, Jack Detect
-		  Control Register. If absent or has value 0, the
-		  register is untouched.
-
-Example:
-
-	alc5621: alc5621@1a {
-		compatible = "alc5621";
-		reg = <0x1a>;
-		add-ctrl = <0x3700>;
-		jack-det-ctrl = <0x4810>;
-	};
diff --git a/Documentation/devicetree/bindings/sound/realtek,alc5623.yaml b/Documentation/devicetree/bindings/sound/realtek,alc5623.yaml
new file mode 100644
index 000000000000..2a389ca95b0d
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/realtek,alc5623.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/realtek,alc5623.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ALC5621/ALC5622/ALC5623 Audio Codec
+
+maintainers:
+  - Mahdi Khosravi <mmk1776@gmail.com>
+
+allOf:
+  - $ref: dai-common.yaml#
+
+properties:
+  compatible:
+    const: realtek,alc5623
+
+  reg:
+    maxItems: 1
+
+  add-ctrl:
+    description:
+      Default register value for Reg-40h, Additional Control Register.
+      If absent or zero, the register is left untouched.
+    $ref: /schemas/types.yaml#/definitions/uint32
+
+  jack-det-ctrl:
+    description:
+      Default register value for Reg-5Ah, Jack Detect Control Register.
+      If absent or zero, the register is left untouched.
+    $ref: /schemas/types.yaml#/definitions/uint32
+
+required:
+  - compatible
+  - reg
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        codec@1a {
+            compatible = "realtek,alc5623";
+            reg = <0x1a>;
+            add-ctrl = <0x3700>;
+            jack-det-ctrl = <0x4810>;
+        };
+    };
-- 
2.50.1

Re: [PATCH v3] ASoC: dt-bindings: realtek,alc5623: convert to DT schema

Posted by Rob Herring 1 month, 4 weeks ago

On Wed, Aug 06, 2025 at 04:18:18PM +0300, Mahdi Khosravi wrote:
> I converted the alc5623 audio codec binding from text to DT schema.

Convert the alc5623...

> This is my first try and I used make dt_binding_check & make dtbs_check to verify
> without getting any errors.

Drop this. Passing is assumed. Actually, 'make dtbs_check' warnings are 
fine if you think the .dts has a mistake.

> 
> Signed-off-by: Mahdi Khosravi <mmk1776@gmail.com>
> ---
> Changes in v3:
> - Drop allOf, just use $ref for uint32
> - Remove stray '>' in descriptions
> - Fix subject to "to DT schema"
> 
> Changes in v2:
> - Add dai-common ref
> - Switch add-ctrl/jack-det-ctrl to allOf uint32
> - Use unevaluatedProperties
> - Fix example compatible
> ---
>  .../devicetree/bindings/sound/alc5623.txt     | 25 ---------
>  .../bindings/sound/realtek,alc5623.yaml       | 52 +++++++++++++++++++
>  2 files changed, 52 insertions(+), 25 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/sound/alc5623.txt
>  create mode 100644 Documentation/devicetree/bindings/sound/realtek,alc5623.yaml
> 
> diff --git a/Documentation/devicetree/bindings/sound/alc5623.txt b/Documentation/devicetree/bindings/sound/alc5623.txt
> deleted file mode 100644
> index 26c86c98d671..000000000000
> --- a/Documentation/devicetree/bindings/sound/alc5623.txt
> +++ /dev/null
> @@ -1,25 +0,0 @@
> -ALC5621/ALC5622/ALC5623 audio Codec
> -
> -Required properties:
> -
> - - compatible:	"realtek,alc5623"
> - - reg:		the I2C address of the device.
> -
> -Optional properties:
> -
> - - add-ctrl:	  Default register value for Reg-40h, Additional Control
> -		  Register. If absent or has the value of 0, the
> -		  register is untouched.
> -
> - - jack-det-ctrl: Default register value for Reg-5Ah, Jack Detect
> -		  Control Register. If absent or has value 0, the
> -		  register is untouched.
> -
> -Example:
> -
> -	alc5621: alc5621@1a {
> -		compatible = "alc5621";
> -		reg = <0x1a>;
> -		add-ctrl = <0x3700>;
> -		jack-det-ctrl = <0x4810>;
> -	};
> diff --git a/Documentation/devicetree/bindings/sound/realtek,alc5623.yaml b/Documentation/devicetree/bindings/sound/realtek,alc5623.yaml
> new file mode 100644
> index 000000000000..2a389ca95b0d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/realtek,alc5623.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/realtek,alc5623.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: ALC5621/ALC5622/ALC5623 Audio Codec
> +
> +maintainers:
> +  - Mahdi Khosravi <mmk1776@gmail.com>
> +
> +allOf:
> +  - $ref: dai-common.yaml#
> +
> +properties:
> +  compatible:
> +    const: realtek,alc5623

What about alc5621/22? At least 21 is in use:

arch/arm/boot/dts/marvell/kirkwood-t5325.dts:                           compatible = "realtek,alc5621";

> +
> +  reg:
> +    maxItems: 1
> +
> +  add-ctrl:
> +    description:
> +      Default register value for Reg-40h, Additional Control Register.
> +      If absent or zero, the register is left untouched.
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +
> +  jack-det-ctrl:
> +    description:
> +      Default register value for Reg-5Ah, Jack Detect Control Register.
> +      If absent or zero, the register is left untouched.
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +
> +required:
> +  - compatible
> +  - reg
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    i2c {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        codec@1a {
> +            compatible = "realtek,alc5623";
> +            reg = <0x1a>;
> +            add-ctrl = <0x3700>;
> +            jack-det-ctrl = <0x4810>;
> +        };
> +    };
> -- 
> 2.50.1
>