[PATCH] ASoC: dt-bindings: ak4118: convert to dt schema

[PATCH] ASoC: dt-bindings: ak4118: convert to dt schema

[Xiaxi Shen]

Convert ak4118 binding to DT schema

It passed dt_binding_check and dtbs_check. Let me know
if you think it should include something else

Signed-off-by: Xiaxi Shen <shenxiaxi26@gmail.com>
---
 .../devicetree/bindings/sound/ak4118.txt      | 22 -------
 .../bindings/sound/asahi-kasei,ak4118.yaml    | 58 +++++++++++++++++++
 2 files changed, 58 insertions(+), 22 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/sound/ak4118.txt
 create mode 100644 Documentation/devicetree/bindings/sound/asahi-kasei,ak4118.yaml

diff --git a/Documentation/devicetree/bindings/sound/ak4118.txt b/Documentation/devicetree/bindings/sound/ak4118.txt
deleted file mode 100644
index 6e11a2f7404c..000000000000
--- a/Documentation/devicetree/bindings/sound/ak4118.txt
+++ /dev/null
@@ -1,22 +0,0 @@
-AK4118 S/PDIF transceiver
-
-This device supports I2C mode.
-
-Required properties:
-
-- compatible : "asahi-kasei,ak4118"
-- reg : The I2C address of the device for I2C
-- reset-gpios: A GPIO specifier for the reset pin
-- irq-gpios: A GPIO specifier for the IRQ pin
-
-Example:
-
-&i2c {
-	ak4118: ak4118@13 {
-		#sound-dai-cells = <0>;
-		compatible = "asahi-kasei,ak4118";
-		reg = <0x13>;
-		reset-gpios = <&gpio 0 GPIO_ACTIVE_LOW>
-		irq-gpios = <&gpio 1 GPIO_ACTIVE_HIGH>;
-	};
-};
diff --git a/Documentation/devicetree/bindings/sound/asahi-kasei,ak4118.yaml b/Documentation/devicetree/bindings/sound/asahi-kasei,ak4118.yaml
new file mode 100644
index 000000000000..abbce999eb30
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/asahi-kasei,ak4118.yaml
@@ -0,0 +1,58 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/asahi-kasei,ak4118.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: AK4118 S/PDIF transceiver
+
+allOf:
+  - $ref: dai-common.yaml#
+
+maintainers:
+  - Liam Girdwood <lgirdwood@gmail.com>
+  - Mark Brown <broonie@kernel.org>
+  - Rob Herring <robh@kernel.org>
+  - Krzysztof Kozlowski <krzk+dt@kernel.org>
+  - Conor Dooley <conor+dt@kernel.org>
+
+properties:
+  compatible:
+    const: asahi-kasei,ak4118
+
+  reg:
+    description: The I2C address of the device for I2C
+    maxItems: 1
+
+  "#sound-dai-cells":
+    const: 0    
+
+  reset-gpios:
+    description: A GPIO specifier for the reset pin
+    maxItems: 1
+
+  irq-gpios:
+    description: A GPIO specifier for the IRQ pin
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - reset-gpios
+  - irq-gpios
+
+additionalProperties: false
+
+examples:
+  - |
+   i2c {
+     #address-cells = <1>;
+     #size-cells = <0>;
+     ak4118@13 {
+       #sound-dai-cells = <0>;
+       compatible = "asahi-kasei,ak4118";
+       reg = <0x13>;
+       reset-gpios = <&gpio 0 0>;
+       irq-gpios = <&gpio 1 1>;
+     };
+   };
-- 
2.34.1

Re: [PATCH] ASoC: dt-bindings: ak4118: convert to dt schema

[Rob Herring]

On Sat, May 11, 2024 at 02:46:24PM -0700, Xiaxi Shen wrote:
> Convert ak4118 binding to DT schema
> 
> It passed dt_binding_check and dtbs_check. Let me know
> if you think it should include something else

This doesn't belong in the commit message.

> 
> Signed-off-by: Xiaxi Shen <shenxiaxi26@gmail.com>
> ---
>  .../devicetree/bindings/sound/ak4118.txt      | 22 -------
>  .../bindings/sound/asahi-kasei,ak4118.yaml    | 58 +++++++++++++++++++
>  2 files changed, 58 insertions(+), 22 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/sound/ak4118.txt
>  create mode 100644 Documentation/devicetree/bindings/sound/asahi-kasei,ak4118.yaml
> 
> diff --git a/Documentation/devicetree/bindings/sound/ak4118.txt b/Documentation/devicetree/bindings/sound/ak4118.txt
> deleted file mode 100644
> index 6e11a2f7404c..000000000000
> --- a/Documentation/devicetree/bindings/sound/ak4118.txt
> +++ /dev/null
> @@ -1,22 +0,0 @@
> -AK4118 S/PDIF transceiver
> -
> -This device supports I2C mode.
> -
> -Required properties:
> -
> -- compatible : "asahi-kasei,ak4118"
> -- reg : The I2C address of the device for I2C
> -- reset-gpios: A GPIO specifier for the reset pin
> -- irq-gpios: A GPIO specifier for the IRQ pin
> -
> -Example:
> -
> -&i2c {
> -	ak4118: ak4118@13 {
> -		#sound-dai-cells = <0>;
> -		compatible = "asahi-kasei,ak4118";
> -		reg = <0x13>;
> -		reset-gpios = <&gpio 0 GPIO_ACTIVE_LOW>
> -		irq-gpios = <&gpio 1 GPIO_ACTIVE_HIGH>;
> -	};
> -};
> diff --git a/Documentation/devicetree/bindings/sound/asahi-kasei,ak4118.yaml b/Documentation/devicetree/bindings/sound/asahi-kasei,ak4118.yaml
> new file mode 100644
> index 000000000000..abbce999eb30
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/asahi-kasei,ak4118.yaml
> @@ -0,0 +1,58 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/asahi-kasei,ak4118.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: AK4118 S/PDIF transceiver
> +
> +allOf:
> +  - $ref: dai-common.yaml#
> +
> +maintainers:
> +  - Liam Girdwood <lgirdwood@gmail.com>
> +  - Mark Brown <broonie@kernel.org>
> +  - Rob Herring <robh@kernel.org>
> +  - Krzysztof Kozlowski <krzk+dt@kernel.org>
> +  - Conor Dooley <conor+dt@kernel.org>

Again, should be someone with the h/w or that cares about it.

(If you are new to bindings (or anything else), it would be best to send 
1 patch out and wait for comments before sending more and repeating the 
same problems on multiple ones.

> +
> +properties:
> +  compatible:
> +    const: asahi-kasei,ak4118
> +
> +  reg:
> +    description: The I2C address of the device for I2C
> +    maxItems: 1
> +
> +  "#sound-dai-cells":
> +    const: 0    
> +
> +  reset-gpios:
> +    description: A GPIO specifier for the reset pin
> +    maxItems: 1
> +
> +  irq-gpios:
> +    description: A GPIO specifier for the IRQ pin
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - reset-gpios
> +  - irq-gpios
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +   i2c {
> +     #address-cells = <1>;
> +     #size-cells = <0>;
> +     ak4118@13 {

Node names should be generic:

spdif@13

> +       #sound-dai-cells = <0>;
> +       compatible = "asahi-kasei,ak4118";
> +       reg = <0x13>;
> +       reset-gpios = <&gpio 0 0>;
> +       irq-gpios = <&gpio 1 1>;
> +     };
> +   };
> -- 
> 2.34.1
>