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

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

Posted by Xiaxi Shen 1 year, 9 months ago

Convert ak4104 binding to DT schema

Signed-off-by: Xiaxi Shen <shenxiaxi26@gmail.com>
---
Changes in v2:
 - Remove subsystem maintainers
 - Wrap lines at <80

Signed-off-by: Xiaxi Shen <shenxiaxi26@gmail.com>
---
 .../devicetree/bindings/sound/ak4104.txt      | 25 ----------
 .../bindings/sound/asahi-kasei,ak4104.yaml    | 49 +++++++++++++++++++
 2 files changed, 49 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..91b3a6817a85
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/asahi-kasei,ak4104.yaml
@@ -0,0 +1,49 @@
+# 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:
+  - Daniel Mack <github@zonque.org>
+  - Xiaxi Shen <shenxiaxi26@gmail.com>
+
+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 v2] ASoC: dt-bindings: ak4104: convert to dt schema

Posted by Krzysztof Kozlowski 1 year, 9 months ago

On 14/05/2024 09:11, Xiaxi Shen wrote:
> Convert ak4104 binding to DT schema
> 
> Signed-off-by: Xiaxi Shen <shenxiaxi26@gmail.com>
> ---
> Changes in v2:
>  - Remove subsystem maintainers
>  - Wrap lines at <80
> 
> Signed-off-by: Xiaxi Shen <shenxiaxi26@gmail.com>

Only one SoB.

...

> +title: AK4104 S/PDIF transmitter
> +
> +allOf:
> +  - $ref: dai-common.yaml#
> +
> +maintainers:
> +  - Daniel Mack <github@zonque.org>
> +  - Xiaxi Shen <shenxiaxi26@gmail.com>
> +
> +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

unevaluatedProperties instead, so the dai-cells will be allowed.

> +
> +examples:
> +  - |
> +   i2c {

Indentation looks odd here. It should start with | above. See other files.

Best regards,
Krzysztof

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

Posted by Xiaxi Shen 1 year, 9 months ago

Convert ak4104 binding to DT schema

Changes in v3:
 - Use unevaluatedProperties instead
 - Fix indentations in the example

Signed-off-by: Xiaxi Shen <shenxiaxi26@gmail.com>
---
 .../devicetree/bindings/sound/ak4104.txt      | 25 ----------
 .../bindings/sound/asahi-kasei,ak4104.yaml    | 49 +++++++++++++++++++
 2 files changed, 49 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..86f6061d3c50
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/asahi-kasei,ak4104.yaml
@@ -0,0 +1,49 @@
+# 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:
+  - Daniel Mack <github@zonque.org>
+  - Xiaxi Shen <shenxiaxi26@gmail.com>
+
+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
+
+unevaluatedProperties: 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 v3] ASoC: dt-bindings: ak4104: convert to dt schema

Posted by Krzysztof Kozlowski 1 year, 9 months ago

On 15/05/2024 08:41, Xiaxi Shen wrote:
> Convert ak4104 binding to DT schema
> 
> Changes in v3:
>  - Use unevaluatedProperties instead
>  - Fix indentations in the example

I think you got already feedback about this - changelog goes to
changelog section, so ---.

I really suggest using b4 for contributions. It makes things much
easier. Alternatively patman.

Best regards,
Krzysztof

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

Posted by Xiaxi Shen 1 year, 8 months ago

Hi Krzysztof,

Thanks for your advices, I am gradually adapting to using b4 as my new tool for submitting patches.

Best regards,
Xiaxi