diff mbox series

[1/4] ASoC: dt-bindings: wlf,wm8524: Convert to json-schema

Message ID 20230222113945.3390672-1-chancel.liu@nxp.com
State Superseded
Headers show
Series [1/4] ASoC: dt-bindings: wlf,wm8524: Convert to json-schema | expand

Commit Message

Chancel Liu Feb. 22, 2023, 11:39 a.m. UTC
Convert the Wolfson WM8524 24-bit 192KHz Stereo DAC device tree
binding documentation to json-schema.

Signed-off-by: Chancel Liu <chancel.liu@nxp.com>
---
 .../devicetree/bindings/sound/wlf,wm8524.yaml | 37 +++++++++++++++++++
 .../devicetree/bindings/sound/wm8524.txt      | 16 --------
 2 files changed, 37 insertions(+), 16 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/sound/wlf,wm8524.yaml
 delete mode 100644 Documentation/devicetree/bindings/sound/wm8524.txt

Comments

Krzysztof Kozlowski Feb. 22, 2023, 12:42 p.m. UTC | #1
On 22/02/2023 12:39, Chancel Liu wrote:
> This property specifies power up to audio out time. It's necessary
> beacause this device has to wait some time before ready to output audio

typo... run spellcheck, also on the subject

> after MCLK, BCLK and MUTE=1 are enabled. For more details about the
> timing constraints, please refer to WTN0302 on
> https://www.cirrus.com/products/wm8524/
> 
> Signed-off-by: Chancel Liu <chancel.liu@nxp.com>
> ---
>  .../devicetree/bindings/sound/wlf,wm8524.yaml          | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/sound/wlf,wm8524.yaml b/Documentation/devicetree/bindings/sound/wlf,wm8524.yaml
> index 09c54cc7de95..54b4da5470e4 100644
> --- a/Documentation/devicetree/bindings/sound/wlf,wm8524.yaml
> +++ b/Documentation/devicetree/bindings/sound/wlf,wm8524.yaml
> @@ -21,6 +21,15 @@ properties:
>      description:
>        a GPIO spec for the MUTE pin.
>  
> +  wlf,power-up-delay-ms:
> +    maximum: 1500

maximum is 1003. Where do you see 1500?

minimum: 82

> +    default: 100
> +    description:
> +      Power up sequency delay time in millisecond. It specifies power up to

typo: sequence?

> +      audio out time. For more details about the timing constraints of this
> +      device, please refer to WTN0302 on
> +      https://www.cirrus.com/products/wm8524/.

According to WTN0302 this might or might not include regulator
ramp-up-delay. You should clearly indicate which part of it this delay
is to not mix up with ramp up. IOW, mention exactly from where the value
comes (e.g. Δt POWER UP TO AUDIO OUT TIMING table, depending on sampling
clock rate). Otherwise you introduce quite loose property which will be
including regulator ramp up in some cases...

Best regards,
Krzysztof
Mark Brown Feb. 22, 2023, 12:50 p.m. UTC | #2
On Wed, Feb 22, 2023 at 07:39:43PM +0800, Chancel Liu wrote:
> This property specifies power up to audio out time. It's necessary
> beacause this device has to wait some time before ready to output audio
> after MCLK, BCLK and MUTE=1 are enabled. For more details about the
> timing constraints, please refer to WTN0302 on
> https://www.cirrus.com/products/wm8524/

According to that the delay is a property of MCLK and the sample rate
rather than a per board constant, it shouldn't be in DT but rather the
driver should figure out the required delay on each startup.
Chancel Liu Feb. 27, 2023, 9:06 a.m. UTC | #3
> On 24/02/2023 11:54, Chancel Liu wrote:
> >> On 22/02/2023 12:39, Chancel Liu wrote:
> >>> This property specifies power up to audio out time. It's necessary
> >>> beacause this device has to wait some time before ready to output audio
> >>
> >> typo... run spellcheck, also on the subject
> >>
> >>> after MCLK, BCLK and MUTE=1 are enabled. For more details about the
> >>> timing constraints, please refer to WTN0302 on
> >>>
> >>>
> >>> Signed-off-by: Chancel Liu <chancel.liu@nxp.com>
> >>> ---
> >>>  .../devicetree/bindings/sound/wlf,wm8524.yaml          | 10
> >> ++++++++++
> >>>  1 file changed, 10 insertions(+)
> >>>
> >>> diff --git a/Documentation/devicetree/bindings/sound/wlf,wm8524.yaml
> >> b/Documentation/devicetree/bindings/sound/wlf,wm8524.yaml
> >>> index 09c54cc7de95..54b4da5470e4 100644
> >>> --- a/Documentation/devicetree/bindings/sound/wlf,wm8524.yaml
> >>> +++ b/Documentation/devicetree/bindings/sound/wlf,wm8524.yaml
> >>> @@ -21,6 +21,15 @@ properties:
> >>>      description:
> >>>        a GPIO spec for the MUTE pin.
> >>>
> >>> +  wlf,power-up-delay-ms:
> >>> +    maximum: 1500
> >>
> >> maximum is 1003. Where do you see 1500?
> >>
> >> minimum: 82
> >>
> >
> > Yes, you are absolutely right. From the power up to audio out timing table in
> > WTN0302, the minimum number is 82 and the maximum is 1003.
> >
> > Consider the following possibilities:
> > 1. These timings may depend on the system design
> > 2. These timings may be simulated results
> > 3. These timings may be the minimum values
> >
> > I set a larger value trying to extend the time. The larger value of course
> > introduces unwanted time delay but it benefits on avoiding beginning audio
> > lost.
> >
> > I also did some tests on a board. If I want to work on 48KHZ sample rate and
> > 512FS, the recommended value is 143. But the test result showed 143ms is not
> > enough. I increased the value to 500ms and could hear the beginning sound.
> 
> Maybe you miss proper regulator ramp-up?
> 
> >
> > Maybe it's a better choice to let DT set the suitable value? Is there a similar
> > situation before?
> 
> That's not really good argument. DT should describe hardware and if this
> property does not match hardware, it means you mix this with something
> else. Something not for DT.
> 
> 
> Best regards,
> Krzysztof

OK. The patches for adding such property are not really good. I need to find a
better way to address the issue.

I think PATCH 1 and PATCH 3 can be kept. So I will modify them according
comments.

Thank you for your review. That benefits me a lot.

Regards, 
Chancel Liu
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/sound/wlf,wm8524.yaml b/Documentation/devicetree/bindings/sound/wlf,wm8524.yaml
new file mode 100644
index 000000000000..09c54cc7de95
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/wlf,wm8524.yaml
@@ -0,0 +1,37 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/wlf,wm8524.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Wolfson WM8524 24-bit 192KHz Stereo DAC
+
+maintainers:
+  - patches@opensource.cirrus.com
+
+properties:
+  compatible:
+    const: wlf,wm8524
+
+  "#sound-dai-cells":
+    const: 0
+
+  wlf,mute-gpios:
+    maxItems: 1
+    description:
+      a GPIO spec for the MUTE pin.
+
+required:
+  - compatible
+  - wlf,mute-gpios
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+
+    wm8524: codec {
+            compatible = "wlf,wm8524";
+            wlf,mute-gpios = <&gpio1 8 GPIO_ACTIVE_LOW>;
+    };
diff --git a/Documentation/devicetree/bindings/sound/wm8524.txt b/Documentation/devicetree/bindings/sound/wm8524.txt
deleted file mode 100644
index f6c0c263b135..000000000000
--- a/Documentation/devicetree/bindings/sound/wm8524.txt
+++ /dev/null
@@ -1,16 +0,0 @@ 
-WM8524 audio CODEC
-
-This device does not use I2C or SPI but a simple Hardware Control Interface.
-
-Required properties:
-
-  - compatible : "wlf,wm8524"
-
-  - wlf,mute-gpios: a GPIO spec for the MUTE pin.
-
-Example:
-
-wm8524: codec {
-	compatible = "wlf,wm8524";
-	wlf,mute-gpios = <&gpio1 8 GPIO_ACTIVE_LOW>;
-};