dt-bindings: sound: ti, pcm3168a: json-schema conversion and fixes

Convert the Texas Instruments PCM3168A Audio Codec Device Tree binding documentation to json-schema.

Add missing properties.
Drop unneeded pinctrl properties from example.

Documentation/devicetree/bindings/sound/ti,pcm3168a.yaml new file +18 -0

+description:
+  The Texas Instruments PCM3168A is a 24-bit Multi-channel Audio CODEC with
+  96/192kHz sampling rate, supporting both SPI and I2C bus access.
+
+properties:
+  compatible:
+    const: ti,pcm3168a
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    items:
+      - description: System clock input
+
+  clock-names:
+    items:
+      - const: scki

Documentation/devicetree/bindings/sound/ti,pcm3168a.yaml new file +15 -0

+
+  VDD1-supply:
+    description: Digital power supply regulator 1 (+3.3V)
+
+  VDD2-supply:
+    description: Digital power supply regulator 2 (+3.3V)
+
+  VCCAD1-supply:
+    description: ADC power supply regulator 1 (+5V)
+
+  VCCAD2-supply:
+    description: ADC power supply regulator 2 (+5V)
+
+  VCCDA1-supply:
+    description: DAC power supply regulator 1 (+5V)

Documentation/devicetree/bindings/sound/ti,pcm3168a.yaml new file +25 -0

+
+required:
+  - compatible
+  - reg
+  - clocks
+  - clock-names
+  - VDD1-supply
+  - VDD2-supply
+  - VCCAD1-supply
+  - VCCAD2-supply
+  - VCCDA1-supply
+  - VCCDA2-supply
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        pcm3168a: audio-codec@44 {
+            compatible = "ti,pcm3168a";

Quoted 5 lines · Geert Uytterhoeven

Convert the Texas Instruments PCM3168A Audio Codec Device Tree binding documentation to json-schema.

Add missing properties.
Drop unneeded pinctrl properties from example.

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

Quoted 18 lines

Documentation/devicetree/bindings/sound/ti,pcm3168a.yaml new file +18 -0

+description:
+  The Texas Instruments PCM3168A is a 24-bit Multi-channel Audio CODEC with
+  96/192kHz sampling rate, supporting both SPI and I2C bus access.
+
+properties:
+  compatible:
+    const: ti,pcm3168a
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    items:
+      - description: System clock input
+
+  clock-names:
+    items:
+      - const: scki

Documentation/devicetree/bindings/sound/ti,pcm3168a.yaml line 39

Quoted 10 lines

Documentation/devicetree/bindings/sound/ti,pcm3168a.yaml new file +10 -0

+
+  reset-gpios:
+    items:
+      - description: |
+          GPIO line connected to the active-low RST pin of the codec.
+            RST = low: device power-down
+            RST = high: device is enabled
+
+  "#sound-dai-cells":
+    enum: [0, 1]

This is a bit unexpected. Looking at DTSes:
1. I see in ulcb-kf.dtsi with cells==0, but two endpoints. The dai cells seem unused? In such case shall dai-cells be skipped if we have endpoints?

2. in k3-j721e-common-proc-board.dts has cells=1, but user's phandle does not have an argument, so practically it is ==0? The user - sound/soc/ti/j721e-evm.c - just gets the node and does not use cells, right? So even though dai-cells==1, it does not matter, because user gets its own parsing?

3. The pcm3168a driver also does not have any xlate function, but it registers to DAIs, so all uses should be with cells==1 to select proper DAI...

Hi Krzysztof,

Thanks for your comments!

Quoted 48 lines · Krzysztof Kozlowski

Quoted 5 lines · Geert Uytterhoeven

Convert the Texas Instruments PCM3168A Audio Codec Device Tree binding documentation to json-schema.

Add missing properties.
Drop unneeded pinctrl properties from example.

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

Quoted 18 lines

Documentation/devicetree/bindings/sound/ti,pcm3168a.yaml new file +18 -0

+description:
+  The Texas Instruments PCM3168A is a 24-bit Multi-channel Audio CODEC with
+  96/192kHz sampling rate, supporting both SPI and I2C bus access.
+
+properties:
+  compatible:
+    const: ti,pcm3168a
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    items:
+      - description: System clock input
+
+  clock-names:
+    items:
+      - const: scki

Documentation/devicetree/bindings/sound/ti,pcm3168a.yaml line 39

Quoted 10 lines

Documentation/devicetree/bindings/sound/ti,pcm3168a.yaml new file +10 -0

+
+  reset-gpios:
+    items:
+      - description: |
+          GPIO line connected to the active-low RST pin of the codec.
+            RST = low: device power-down
+            RST = high: device is enabled
+
+  "#sound-dai-cells":
+    enum: [0, 1]

This is a bit unexpected. Looking at DTSes:
1. I see in ulcb-kf.dtsi with cells==0, but two endpoints. The dai cells seem unused? In such case shall dai-cells be skipped if we have endpoints?

2. in k3-j721e-common-proc-board.dts has cells=1, but user's phandle does not have an argument, so practically it is ==0? The user - sound/soc/ti/j721e-evm.c - just gets the node and does not use cells, right? So even though dai-cells==1, it does not matter, because user gets its own parsing?

Quoted 3 lines

3. The pcm3168a driver also does not have any xlate function, but it registers to DAIs, so all uses should be with cells==1 to select proper DAI...

I have no idea (DAI is magic to me), and hope the audio experts can provide some input...

arch/arm64/boot/dts/renesas/ulcb-kf.dtsi +1 -2

index 408871c2859d144d..8e46acbe3a203759 100644
@@ -216,19 +216,18 @@ pcm3168a: audio-codec@44 {
 				ports {
 					#address-cells = <1>;
 					#size-cells = <0>;
-					mclk-fs = <512>;
 					port@0 {
 						reg = <0>;
 						pcm3168a_endpoint_p: endpoint {
+							mclk-fs = <512>;
 							remote-endpoint = <&rsnd_for_pcm3168a_play>;
-							clocks = <&clksndsel>;
 						};

arch/arm64/boot/dts/renesas/r8a77951-ulcb-kf.dtb: audio-codec@44: ports: 'mclk-fs' does not match any of the regexes: '^port@[0-9a-f]+$', 'pinctrl-[0-9]+'
From schema: Documentation/devicetree/bindings/sound/ti,pcm3168a.yaml
arch/arm64/boot/dts/renesas/r8a77951-ulcb-kf.dtb: audio-codec@44: ports:port@0:endpoint: Unevaluated properties are not allowed ('clocks' was unexpected)
From schema: Documentation/devicetree/bindings/sound/ti,pcm3168a.yaml
arch/arm64/boot/dts/renesas/r8a77951-ulcb-kf.dtb: audio-codec@44: ports:port@1:endpoint: Unevaluated properties are not allowed ('clocks' was unexpected)
From schema: Documentation/devicetree/bindings/sound/ti,pcm3168a.yaml

I'm not tested, but in my quick check,
we can use "mclk-fs" under "ports", and we need "clocks" under "endpoint". So the issue is not dtsi side, but yaml side.

I will check and fix it, but it will be next week or later.

Quoted 6 lines

arch/arm64/boot/dts/renesas/r8a77951-ulcb-kf.dtb: audio-codec@44: ports: 'mclk-fs' does not match any of the regexes: '^port@[0-9a-f]+$', 'pinctrl-[0-9]+'
From schema: Documentation/devicetree/bindings/sound/ti,pcm3168a.yaml
arch/arm64/boot/dts/renesas/r8a77951-ulcb-kf.dtb: audio-codec@44: ports:port@0:endpoint: Unevaluated properties are not allowed ('clocks' was unexpected)
From schema: Documentation/devicetree/bindings/sound/ti,pcm3168a.yaml
arch/arm64/boot/dts/renesas/r8a77951-ulcb-kf.dtb: audio-codec@44: ports:port@1:endpoint: Unevaluated properties are not allowed ('clocks' was unexpected)
From schema: Documentation/devicetree/bindings/sound/ti,pcm3168a.yaml

(snip)

Quoted 4 lines

I'm not tested, but in my quick check,
we can use "mclk-fs" under "ports", and we need "clocks" under "endpoint". So the issue is not dtsi side, but yaml side.

Quoted 1 line

I will check and fix it, but it will be next week or later.

I have investigated about this patch, and it needs extra patch which I will post if -rc1 was released.
I can merge this patch (with small fixup) into my patch-set. Of course I will keep your name. But is it OK for you ?

Quoted 4 lines

I have investigated about this patch, and it needs extra patch which I will post if -rc1 was released.
I can merge this patch (with small fixup) into my patch-set. Of course I will keep your name. But is it OK for you ?

Thanks, fine for me!

♫ All I want for Christmas is ♫... an error-free "make dtbs_check" ;-)