[PATCH 0/2] dt-bindings: sound: ti, pcm3168a: json-schema conversion and fixes
Hi all,
This patch series is an attempt to convert the existing DT binding documentation for the Texas Instruments PCM3168A Audio Codec to json-schema ("another one bites the dust" ;-).
It consists of two parts: 1. The actual DT binding conversion, 2. An RFC patch to fix the impedance mismatch between the bindings and the description in the Shimafuji Kingfisher board DTS.
I'm not super-familiar with the audio details, so I would be very grateful to receive your comments.
Thanks!
Geert Uytterhoeven (2): dt-bindings: sound: ti,pcm3168a: Convert to json-schema [RFC] arm64: dts: renesas: ulcb-kf: Fix pcm3168a audio codec node
.../devicetree/bindings/sound/ti,pcm3168a.txt | 56 ---------- .../bindings/sound/ti,pcm3168a.yaml | 105 ++++++++++++++++++ arch/arm64/boot/dts/renesas/ulcb-kf.dtsi | 5 +- 3 files changed, 107 insertions(+), 59 deletions(-) delete mode 100644 Documentation/devicetree/bindings/sound/ti,pcm3168a.txt create mode 100644 Documentation/devicetree/bindings/sound/ti,pcm3168a.yaml
Convert the Texas Instruments PCM3168A Audio Codec Device Tree binding documentation to json-schema.
Add missing properties. Drop unneeded pinctrl properties from example.
Signed-off-by: Geert Uytterhoeven geert+renesas@glider.be --- .../devicetree/bindings/sound/ti,pcm3168a.txt | 56 ---------- .../bindings/sound/ti,pcm3168a.yaml | 105 ++++++++++++++++++ 2 files changed, 105 insertions(+), 56 deletions(-) delete mode 100644 Documentation/devicetree/bindings/sound/ti,pcm3168a.txt create mode 100644 Documentation/devicetree/bindings/sound/ti,pcm3168a.yaml
diff --git a/Documentation/devicetree/bindings/sound/ti,pcm3168a.txt b/Documentation/devicetree/bindings/sound/ti,pcm3168a.txt deleted file mode 100644 index a02ecaab518327d5..0000000000000000 --- a/Documentation/devicetree/bindings/sound/ti,pcm3168a.txt +++ /dev/null @@ -1,56 +0,0 @@ -Texas Instruments pcm3168a DT bindings - -This driver supports both SPI and I2C bus access for this codec - -Required properties: - - - compatible: "ti,pcm3168a" - - - clocks : Contains an entry for each entry in clock-names - - - clock-names : Includes the following entries: - "scki" The system clock - - - VDD1-supply : Digital power supply regulator 1 (+3.3V) - - - VDD2-supply : Digital power supply regulator 2 (+3.3V) - - - VCCAD1-supply : ADC power supply regulator 1 (+5V) - - - VCCAD2-supply : ADC power supply regulator 2 (+5V) - - - VCCDA1-supply : DAC power supply regulator 1 (+5V) - - - VCCDA2-supply : DAC power supply regulator 2 (+5V) - -For required properties on SPI/I2C, consult SPI/I2C device tree documentation - -Optional properties: - - - reset-gpios : Optional reset gpio line connected to RST pin of the codec. - The RST line is low active: - RST = low: device power-down - RST = high: device is enabled - -Examples: - -i2c0: i2c0@0 { - - ... - - pcm3168a: audio-codec@44 { - compatible = "ti,pcm3168a"; - reg = <0x44>; - reset-gpios = <&gpio0 4 GPIO_ACTIVE_LOW>; - clocks = <&clk_core CLK_AUDIO>; - clock-names = "scki"; - VDD1-supply = <&supply3v3>; - VDD2-supply = <&supply3v3>; - VCCAD1-supply = <&supply5v0>; - VCCAD2-supply = <&supply5v0>; - VCCDA1-supply = <&supply5v0>; - VCCDA2-supply = <&supply5v0>; - pinctrl-names = "default"; - pinctrl-0 = <&dac_clk_pin>; - }; -}; diff --git a/Documentation/devicetree/bindings/sound/ti,pcm3168a.yaml b/Documentation/devicetree/bindings/sound/ti,pcm3168a.yaml new file mode 100644 index 0000000000000000..a977507c52b05aed --- /dev/null +++ b/Documentation/devicetree/bindings/sound/ti,pcm3168a.yaml @@ -0,0 +1,105 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/sound/ti,pcm3168a.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Texas Instruments PCM3168A Audio Codec + +maintainers: + - Damien Horsley Damien.Horsley@imgtec.com + +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 + + 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] + + 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) + + VCCDA2-supply: + description: DAC power supply regulator 2 (+5V) + + ports: + $ref: /schemas/graph.yaml#/properties/ports + properties: + port@0: + $ref: audio-graph-port.yaml# + description: Audio input port. + + port@1: + $ref: audio-graph-port.yaml# + description: Audio output port. + +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"; + reg = <0x44>; + reset-gpios = <&gpio0 4 GPIO_ACTIVE_LOW>; + clocks = <&clk_core 42>; + clock-names = "scki"; + VDD1-supply = <&supply3v3>; + VDD2-supply = <&supply3v3>; + VCCAD1-supply = <&supply5v0>; + VCCAD2-supply = <&supply5v0>; + VCCDA1-supply = <&supply5v0>; + VCCDA2-supply = <&supply5v0>; + }; + };
On 02/12/2022 13:55, Geert Uytterhoeven wrote:
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.
+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- reset-gpios:
- items:
- description: |GPIO line connected to the active-low RST pin of the codec.RST = low: device power-downRST = 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...
- 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)
- VCCDA2-supply:
- description: DAC power supply regulator 2 (+5V)
- ports:
- $ref: /schemas/graph.yaml#/properties/ports
- properties:
port@0:$ref: audio-graph-port.yaml#description: Audio input port.
unevaluatedProperties: false
port@1:$ref: audio-graph-port.yaml#description: Audio output port.
unevaluatedProperties: false
+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";reg = <0x44>;reset-gpios = <&gpio0 4 GPIO_ACTIVE_LOW>;clocks = <&clk_core 42>;clock-names = "scki";VDD1-supply = <&supply3v3>;VDD2-supply = <&supply3v3>;VCCAD1-supply = <&supply5v0>;VCCAD2-supply = <&supply5v0>;VCCDA1-supply = <&supply5v0>;VCCDA2-supply = <&supply5v0>;
Can you extend the example with dai cells or with endpoints (or both, depending on my previous comment...)
};- };
Best regards, Krzysztof
Hi Krzysztof,
Thanks for your comments!
On Sat, Dec 3, 2022 at 1:13 PM Krzysztof Kozlowski krzysztof.kozlowski@linaro.org wrote:
On 02/12/2022 13:55, Geert Uytterhoeven wrote:
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.
+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- reset-gpios:
- items:
- description: |GPIO line connected to the active-low RST pin of the codec.RST = low: device power-downRST = high: device is enabled- "#sound-dai-cells":
- enum: [0, 1]
This is a bit unexpected. Looking at DTSes:
- 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?
- 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?
- 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... Thanks!
Gr{oetje,eeting}s,
Geert
-- Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org
In personal conversations with technical people, I call myself a hacker. But when I'm talking to journalists I just say "programmer" or something like that. -- Linus Torvalds
On 05/12/2022 09:00, Geert Uytterhoeven wrote:
Hi Krzysztof,
Thanks for your comments!
On Sat, Dec 3, 2022 at 1:13 PM Krzysztof Kozlowski krzysztof.kozlowski@linaro.org wrote:
On 02/12/2022 13:55, Geert Uytterhoeven wrote:
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.
+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- reset-gpios:
- items:
- description: |GPIO line connected to the active-low RST pin of the codec.RST = low: device power-downRST = high: device is enabled- "#sound-dai-cells":
- enum: [0, 1]
This is a bit unexpected. Looking at DTSes:
- 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?
- 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?
- 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...
It is a bit of magic to me too. Yet I think the correct usage of this is with dai-cells=1. I think we can skip the choice here between sound-dai-cells and endpoints (to allow only one) and only fix the value here to =1.
This would also require changing arch/arm64/boot/dts/renesas/ulcb-kf.dtsi to dai-cells=1.
Best regards, Krzysztof
"make dtbs_check":
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
Fix this by: 1. Moving the "mclk-fs" property to the endpoint nodes, where it belongs according to .../sound/audio-graph-port.yaml, 2. Dropping the bogus "clocks" properties.
Fixes: 80c07701d5918928 ("arm64: dts: renesas: ulcb-kf: add pcm3168 sound codec") Signed-off-by: Geert Uytterhoeven geert+renesas@glider.be --- Compile-tested only. --- arch/arm64/boot/dts/renesas/ulcb-kf.dtsi | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/arch/arm64/boot/dts/renesas/ulcb-kf.dtsi b/arch/arm64/boot/dts/renesas/ulcb-kf.dtsi index 408871c2859d144d..8e46acbe3a203759 100644 --- a/arch/arm64/boot/dts/renesas/ulcb-kf.dtsi +++ b/arch/arm64/boot/dts/renesas/ulcb-kf.dtsi @@ -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>; }; }; port@1 { reg = <1>; pcm3168a_endpoint_c: endpoint { + mclk-fs = <512>; remote-endpoint = <&rsnd_for_pcm3168a_capture>; - clocks = <&clksndsel>; }; }; };
Hi Geert
Thank you for your patch
diff --git a/arch/arm64/boot/dts/renesas/ulcb-kf.dtsi b/arch/arm64/boot/dts/renesas/ulcb-kf.dtsi index 408871c2859d144d..8e46acbe3a203759 100644 --- a/arch/arm64/boot/dts/renesas/ulcb-kf.dtsi +++ b/arch/arm64/boot/dts/renesas/ulcb-kf.dtsi @@ -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>; }; }; port@1 { reg = <1>; pcm3168a_endpoint_c: endpoint {
mclk-fs = <512>; remote-endpoint = <&rsnd_for_pcm3168a_capture>;
clocks = <&clksndsel>; }; }; };
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.
Thank you for your help !!
Best regards --- Kuninori Morimoto
Hi Geert
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)
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.
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 ?
Thank you for your help !!
Best regards --- Kuninori Morimoto
Hi Morimoto-san,
On Tue, Dec 13, 2022 at 12:49 AM Kuninori Morimoto kuninori.morimoto.gx@renesas.com wrote:
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)
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.
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" ;-)
Gr{oetje,eeting}s,
Geert
-- Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org
In personal conversations with technical people, I call myself a hacker. But when I'm talking to journalists I just say "programmer" or something like that. -- Linus Torvalds
Hi Geert
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" ;-)
I will do my best ;)
Merry Christmas
Thank you for your help !!
Best regards --- Kuninori Morimoto
participants (4)
-
Geert Uytterhoeven -
Geert Uytterhoeven -
Krzysztof Kozlowski -
Kuninori Morimoto