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

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

[Xiaxi Shen]

Convert ak4104 binding to DT schema

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

diff --git a/Documentation/devicetree/bindings/sound/ak4104.txt b/Documentation/devicetree/bindings/sound/ak4104.txt
deleted file mode 100644
index ae5f7f057dc3..000000000000
--- a/Documentation/devicetree/bindings/sound/ak4104.txt
+++ /dev/null
@@ -1,25 +0,0 @@
-AK4104 S/PDIF transmitter
-
-This device supports SPI mode only.
-
-Required properties:
-
-  - compatible : "asahi-kasei,ak4104"
-
-  - reg : The chip select number on the SPI bus
-
-  - vdd-supply : A regulator node, providing 2.7V - 3.6V
-
-Optional properties:
-
-  - reset-gpios : a GPIO spec for the reset pin. If specified, it will be
-		  deasserted before communication to the device starts.
-
-Example:
-
-spdif: ak4104@0 {
-	compatible = "asahi-kasei,ak4104";
-	reg = <0>;
-	spi-max-frequency = <5000000>;
-	vdd-supply = <&vdd_3v3_reg>;
-};
diff --git a/Documentation/devicetree/bindings/sound/asahi-kasei,ak4104.yaml b/Documentation/devicetree/bindings/sound/asahi-kasei,ak4104.yaml
new file mode 100644
index 000000000000..88daa0c7c74f
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/asahi-kasei,ak4104.yaml
@@ -0,0 +1,51 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/asahi-kasei,ak4104.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: AK4104 S/PDIF transmitter
+
+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,ak4104
+
+  reg:
+    description: Chip select number on the SPI bus 
+    maxItems: 1
+
+  vdd-supply:
+    description: A regulator node providing between 2.7V and 3.6V.
+
+  reset-gpios:
+    maxItems: 1
+    description: Optional GPIO spec for the reset pin, deasserted before communication starts.
+    
+required:
+  - compatible
+  - reg
+  - vdd-supply
+
+additionalProperties: false
+
+examples:
+  - |
+   i2c {
+     #address-cells = <1>;
+     #size-cells = <0>;
+     codec@0 {
+       compatible = "asahi-kasei,ak4104";
+       reg = <0>;
+       vdd-supply = <&vdd_3v3_reg>;
+     };
+   };
-- 
2.34.1

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

[Rob Herring]

On Fri, May 10, 2024 at 10:56:06PM -0700, Xiaxi Shen wrote:
> Convert ak4104 binding to DT schema
> 
> Signed-off-by: Xiaxi Shen <shenxiaxi26@gmail.com>
> ---
>  .../devicetree/bindings/sound/ak4104.txt      | 25 ---------
>  .../bindings/sound/asahi-kasei,ak4104.yaml    | 51 +++++++++++++++++++
>  2 files changed, 51 insertions(+), 25 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/sound/ak4104.txt
>  create mode 100644 Documentation/devicetree/bindings/sound/asahi-kasei,ak4104.yaml
> 
> diff --git a/Documentation/devicetree/bindings/sound/ak4104.txt b/Documentation/devicetree/bindings/sound/ak4104.txt
> deleted file mode 100644
> index ae5f7f057dc3..000000000000
> --- a/Documentation/devicetree/bindings/sound/ak4104.txt
> +++ /dev/null
> @@ -1,25 +0,0 @@
> -AK4104 S/PDIF transmitter
> -
> -This device supports SPI mode only.
> -
> -Required properties:
> -
> -  - compatible : "asahi-kasei,ak4104"
> -
> -  - reg : The chip select number on the SPI bus
> -
> -  - vdd-supply : A regulator node, providing 2.7V - 3.6V
> -
> -Optional properties:
> -
> -  - reset-gpios : a GPIO spec for the reset pin. If specified, it will be
> -		  deasserted before communication to the device starts.
> -
> -Example:
> -
> -spdif: ak4104@0 {
> -	compatible = "asahi-kasei,ak4104";
> -	reg = <0>;
> -	spi-max-frequency = <5000000>;
> -	vdd-supply = <&vdd_3v3_reg>;
> -};
> diff --git a/Documentation/devicetree/bindings/sound/asahi-kasei,ak4104.yaml b/Documentation/devicetree/bindings/sound/asahi-kasei,ak4104.yaml
> new file mode 100644
> index 000000000000..88daa0c7c74f
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/asahi-kasei,ak4104.yaml
> @@ -0,0 +1,51 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/asahi-kasei,ak4104.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: AK4104 S/PDIF transmitter
> +
> +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>

This should be someone with the h/w, not subsystem maintainers.

> +
> +properties:
> +  compatible:
> +    const: asahi-kasei,ak4104
> +
> +  reg:
> +    description: Chip select number on the SPI bus 
> +    maxItems: 1
> +
> +  vdd-supply:
> +    description: A regulator node providing between 2.7V and 3.6V.
> +
> +  reset-gpios:
> +    maxItems: 1
> +    description: Optional GPIO spec for the reset pin, deasserted before communication starts.

Wrap lines at <80.

> +    
> +required:
> +  - compatible
> +  - reg
> +  - vdd-supply
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +   i2c {
> +     #address-cells = <1>;
> +     #size-cells = <0>;
> +     codec@0 {
> +       compatible = "asahi-kasei,ak4104";
> +       reg = <0>;
> +       vdd-supply = <&vdd_3v3_reg>;
> +     };
> +   };
> -- 
> 2.34.1
> 

Re: Your Feedback on AK4104 Dt-bindings

[Xiaxi Shen]

Hi Rob,

Thanks for your advices, I will follow what you suggested in my following patches.

Best regards,
Xiaxi Shen