Skip to contentSkip to conversation

ASoC: dt-bindings: alc5632: Convert to dtschema

PATCH Superseded Saalim Quadri 3 participants 13 messages Mar 23, 2023 – Mar 26, 2023

Subsystems (2)

v1 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 ASoC: dt-bindings: alc5632: Convert to dtschema

Convert the ALC5632 audio codec bindings to DT schema.

---
 .../devicetree/bindings/sound/alc5632.txt     | 43 -------------
 .../bindings/sound/realtek,alc5632.yaml       | 63 +++++++++++++++++++
 2 files changed, 63 insertions(+), 43 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/sound/alc5632.txt
 create mode 100644 Documentation/devicetree/bindings/sound/realtek,alc5632.yaml
Documentation/devicetree/bindings/sound/alc5632.txt deleted +0 -43
deleted file mode 100644
index ffd886d110bd..000000000000
@@ -1,43 +0,0 @@
-ALC5632 audio CODEC
-
-This device supports I2C only.
-
-Required properties:
-
-  - compatible : "realtek,alc5632"
-
-  - reg : the I2C address of the device.
-
-  - gpio-controller : Indicates this device is a GPIO controller.
-
-  - #gpio-cells : Should be two. The first cell is the pin number and the
-    second cell is used to specify optional parameters (currently unused).
-
-Pins on the device (for linking into audio routes):
-
-  * SPK_OUTP
-  * SPK_OUTN
-  * HP_OUT_L
-  * HP_OUT_R
-  * AUX_OUT_P
-  * AUX_OUT_N
-  * LINE_IN_L
-  * LINE_IN_R
-  * PHONE_P
-  * PHONE_N
-  * MIC1_P
-  * MIC1_N
-  * MIC2_P
-  * MIC2_N
-  * MICBIAS1
-  * DMICDAT
-
-Example:
-
-alc5632: alc5632@1e {
-	compatible = "realtek,alc5632";
-	reg = <0x1a>;
-
-	gpio-controller;
-	#gpio-cells = <2>;
-};
Documentation/devicetree/bindings/sound/realtek,alc5632.yaml new file +63 -0

63 lines not on this page · raw message

Signature · 1 line
2.34.1
#1 lore raw
Quoted 3 lines · Saalim Quadri

Convert the ALC5632 audio codec bindings to DT schema.

Thank you for your patch. There is something to discuss/improve.

Quoted 20 lines
Documentation/devicetree/bindings/sound/realtek,alc5632.yaml new file +19 -0
@@ -0,0 +1,63 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/realtek,alc5632.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ALC5632 audio CODEC
+
+description: |
+  Pins on the device (for linking into audio routes):
+      * SPK_OUTP
+      * SPK_OUTN
+      * HP_OUT_L
+      * HP_OUT_R
+      * AUX_OUT_P
+      * AUX_OUT_N
+      * LINE_IN_L
+      * LINE_IN_R
+      * PHONE_P

Documentation/devicetree/bindings/sound/realtek,alc5632.yaml line 29

Quoted 10 lines
Documentation/devicetree/bindings/sound/realtek,alc5632.yaml new file +10 -0
+      * PHONE_N
+      * MIC1_P
+      * MIC1_N
+      * MIC2_P
+      * MIC2_N
+      * MICBIAS1
+      * DMICDAT
+
+maintainers:
+  - Liam Girdwood <[email protected]>

This should not be subsystem maintainer but someone related to the device. It's maintainer or interested contributor. Unless that's the case here?

Quoted 18 lines
Documentation/devicetree/bindings/sound/realtek,alc5632.yaml new file +18 -0
+
+properties:
+  compatible:
+    const: realtek,alc5632
+
+  reg:
+    maxItems: 1
+
+  '#gpio-cells':
+    const: 2
+
+  gpio-controller: true
+
+required:
+  - compatible
+  - reg
+  - '#gpio-cells'
+  - gpio-controller

Documentation/devicetree/bindings/sound/realtek,alc5632.yaml line 57

Quoted 10 lines
Documentation/devicetree/bindings/sound/realtek,alc5632.yaml new file +10 -0
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+        alc5632: alc5632@1a {

Node name: codec
and drop alc5632 label

Documentation/devicetree/bindings/sound/realtek,alc5632.yaml line 63

Quoted 6 lines
Documentation/devicetree/bindings/sound/realtek,alc5632.yaml new file +6 -0
+            compatible = "realtek,alc5632";
+            reg = <0x1a>;
+            gpio-controller;
+            #gpio-cells = <2>;
+        };
+    };

Best regards,
Krzysztof

#2 lore raw

Hello,

This is my first time using the Linux Kernel Mailing List. I apologise if I commit any mistakes.

Quoted 3 lines

This should not be subsystem maintainer but someone related to the device. It's maintainer or interested contributor. Unless that's the case here?

yes it is wrong, he is not the subsystem maintainer. I will send the updated patch.

I have a doubt, for the maintainers list, is it required to include all the names of the subsystem maintainer in the yaml too? As for this codec, there are 4, shall I include the names of all of them or the one to whom the module is authored to?

Apologies,

Saalim

#3 lore raw
Quoted 8 lines · Saalim Quadri

Hello,

This is my first time using the Linux Kernel Mailing List. I apologise if I commit any mistakes.

Quoted 3 lines

This should not be subsystem maintainer but someone related to the device. It's maintainer or interested contributor. Unless that's the case here?

Quoted 5 lines

yes it is wrong, he is not the subsystem maintainer. I will send the updated patch.

I have a doubt, for the maintainers list, is it required to include all the names of the subsystem maintainer in the yaml too? As for this codec, there are 4, shall I include the names of all of them or the one to whom the module is authored to?

Depends, choose one or two names, maybe the most active.

Best regards,
Krzysztof

maintainer
#4 lore raw
Quoted 6 lines · Krzysztof Kozlowski
Quoted 2 lines · Saalim Quadri

I have a doubt, for the maintainers list, is it required to include all the names of the subsystem maintainer in the yaml too? As for this codec, there are 4, shall I include the names of all of them or the one to whom the

Depends, choose one or two names, maybe the most active.

Note that the binding should have maintainers for the specific binding, not the kernel subsystem.

#5 lore raw

PATCH v2 1/1 ASoC: dt-bindings: alc5632: Convert to dtschema

Convert the ALC5632 audio codec bindings to DT schema.

---
 .../devicetree/bindings/sound/alc5632.txt     | 43 -------------
 .../bindings/sound/realtek,alc5632.yaml       | 64 +++++++++++++++++++
 2 files changed, 64 insertions(+), 43 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/sound/alc5632.txt
 create mode 100644 Documentation/devicetree/bindings/sound/realtek,alc5632.yaml
Documentation/devicetree/bindings/sound/alc5632.txt deleted +0 -43
deleted file mode 100644
index ffd886d110bd..000000000000
@@ -1,43 +0,0 @@
-ALC5632 audio CODEC
-
-This device supports I2C only.
-
-Required properties:
-
-  - compatible : "realtek,alc5632"
-
-  - reg : the I2C address of the device.
-
-  - gpio-controller : Indicates this device is a GPIO controller.
-
-  - #gpio-cells : Should be two. The first cell is the pin number and the
-    second cell is used to specify optional parameters (currently unused).
-
-Pins on the device (for linking into audio routes):
-
-  * SPK_OUTP
-  * SPK_OUTN
-  * HP_OUT_L
-  * HP_OUT_R
-  * AUX_OUT_P
-  * AUX_OUT_N
-  * LINE_IN_L
-  * LINE_IN_R
-  * PHONE_P
-  * PHONE_N
-  * MIC1_P
-  * MIC1_N
-  * MIC2_P
-  * MIC2_N
-  * MICBIAS1
-  * DMICDAT
-
-Example:
-
-alc5632: alc5632@1e {
-	compatible = "realtek,alc5632";
-	reg = <0x1a>;
-
-	gpio-controller;
-	#gpio-cells = <2>;
-};
Documentation/devicetree/bindings/sound/realtek,alc5632.yaml new file +64 -0

64 lines not on this page · raw message

Signature · 1 line
2.34.1
maintainer
#6 lore raw

Documentation/devicetree/bindings/sound/realtek,alc5632.yaml line 30

Quoted 3 lines · Saalim Quadri
Documentation/devicetree/bindings/sound/realtek,alc5632.yaml new file +3 -0
+maintainers:
+  - Leon Romanovsky <[email protected]>
+  - Mark Brown <[email protected]>

I know nothing specific about this device so shouldn't be listed. CCing Leon for him to confirm.

#7 lore raw
In reply to Saalim Quadri

Documentation/devicetree/bindings/sound/realtek,alc5632.yaml line 29

Quoted 9 lines · Saalim Quadri

Convert the ALC5632 audio codec bindings to DT schema.

---

Documentation/devicetree/bindings/sound/realtek,alc5632.yaml new file +3 -0
+
+maintainers:
+  - Leon Romanovsky <[email protected]>

Please use scripts/get_maintainers.pl to get a list of necessary people and lists to CC. It might happen, that command when run on an older kernel, gives you outdated entries. Therefore please be sure you base your patches on recent Linux kernel.

Quoted 19 lines
Documentation/devicetree/bindings/sound/realtek,alc5632.yaml new file +19 -0
+  - Mark Brown <[email protected]>
+
+properties:
+  compatible:
+    const: realtek,alc5632
+
+  reg:
+    maxItems: 1
+
+  '#gpio-cells':
+    const: 2
+
+  gpio-controller: true
+
+required:
+  - compatible
+  - reg
+  - '#gpio-cells'
+  - gpio-controller

Documentation/devicetree/bindings/sound/realtek,alc5632.yaml line 58

Quoted 10 lines
Documentation/devicetree/bindings/sound/realtek,alc5632.yaml new file +10 -0
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+        alc5632: codec@1a {

Drop label "alc5632".

Best regards,
Krzysztof

#9 lore raw
In reply to Mark Brown
Quoted 10 lines · Mark Brown
Quoted 6 lines · Krzysztof Kozlowski
Quoted 2 lines · Saalim Quadri

I have a doubt, for the maintainers list, is it required to include all the names of the subsystem maintainer in the yaml too? As for this codec, there are 4, shall I include the names of all of them or the one to whom the

Depends, choose one or two names, maybe the most active.

Note that the binding should have maintainers for the specific binding, not the kernel subsystem.

Yes. That's what I also said in the beginning, but for some reason Saalim cut this part... and re-added subsystem maintainers.

Best regards,
Krzysztof

#8 lore raw
In reply to Saalim Quadri
Quoted 8 lines · Saalim Quadri

Convert the ALC5632 audio codec bindings to DT schema.

---
 .../devicetree/bindings/sound/alc5632.txt     | 43 -------------
 .../bindings/sound/realtek,alc5632.yaml       | 64 +++++++++++++++++++
 2 files changed, 64 insertions(+), 43 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/sound/alc5632.txt

Also, do not attach your new patches to some other threads. Each patchset version is new submission and new thread.

Best regards,
Krzysztof

#10 lore raw
In reply to Krzysztof Kozlowski
Quoted 3 lines

Yes. That's what I also said in the beginning, but for some reason Saalim cut this part... and re-added subsystem maintainers.

The file was last updated a few years back and it was by Mark, so I added him as well, while the original binding was written by Leon only, so I added him as well.

Regards,

Saalim

#11 lore raw

PATCH v3 1/1 ASoC: dt-bindings: alc5632: Convert to dtschema

In reply to Saalim Quadri

Convert the ALC5632 audio codec bindings to DT schema.

---
 .../devicetree/bindings/sound/alc5632.txt     | 43 -------------
 .../bindings/sound/realtek,alc5632.yaml       | 63 +++++++++++++++++++
 2 files changed, 63 insertions(+), 43 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/sound/alc5632.txt
 create mode 100644 Documentation/devicetree/bindings/sound/realtek,alc5632.yaml
Documentation/devicetree/bindings/sound/alc5632.txt deleted +0 -43
deleted file mode 100644
index ffd886d110bd..000000000000
@@ -1,43 +0,0 @@
-ALC5632 audio CODEC
-
-This device supports I2C only.
-
-Required properties:
-
-  - compatible : "realtek,alc5632"
-
-  - reg : the I2C address of the device.
-
-  - gpio-controller : Indicates this device is a GPIO controller.
-
-  - #gpio-cells : Should be two. The first cell is the pin number and the
-    second cell is used to specify optional parameters (currently unused).
-
-Pins on the device (for linking into audio routes):
-
-  * SPK_OUTP
-  * SPK_OUTN
-  * HP_OUT_L
-  * HP_OUT_R
-  * AUX_OUT_P
-  * AUX_OUT_N
-  * LINE_IN_L
-  * LINE_IN_R
-  * PHONE_P
-  * PHONE_N
-  * MIC1_P
-  * MIC1_N
-  * MIC2_P
-  * MIC2_N
-  * MICBIAS1
-  * DMICDAT
-
-Example:
-
-alc5632: alc5632@1e {
-	compatible = "realtek,alc5632";
-	reg = <0x1a>;
-
-	gpio-controller;
-	#gpio-cells = <2>;
-};
Documentation/devicetree/bindings/sound/realtek,alc5632.yaml new file +63 -0

63 lines not on this page · raw message

Signature · 1 line
2.34.1
#12 lore raw
Quoted 1 line · Saalim Quadri

Convert the ALC5632 audio codec bindings to DT schema.

You got comment about threading. Do not ignore it.

Quoted 3 lines

---

Where is the changelog? What happened here?

Documentation/devicetree/bindings/sound/realtek,alc5632.yaml line 57

Quoted 11 lines
 .../devicetree/bindings/sound/alc5632.txt     | 43 -------------
Documentation/devicetree/bindings/sound/realtek,alc5632.yaml new file +8 -0
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+        alc5632: codec@1a {

No improvements here.

Documentation/devicetree/bindings/sound/realtek,alc5632.yaml line 63

Quoted 6 lines
Documentation/devicetree/bindings/sound/realtek,alc5632.yaml new file +6 -0
+            compatible = "realtek,alc5632";
+            reg = <0x1a>;
+            gpio-controller;
+            #gpio-cells = <2>;
+        };
+    };

Best regards,
Krzysztof