diff mbox series

[1/4] dt-bindings: sound: amlogic: t9015: Add missing AVDD-supply property

Message ID 20211023214856.30097-1-alexander.stein@mailbox.org (mailing list archive)
State New, archived
Headers show
Series [1/4] dt-bindings: sound: amlogic: t9015: Add missing AVDD-supply property | expand

Commit Message

Alexander Stein Oct. 23, 2021, 9:48 p.m. UTC
Fixes the schema check warning "audio-controller@32000: 'AVDD-supply'
do not match any of the regexes: 'pinctrl-[0-9]+'"

Fixes: 5c36abcd2621 ("ASoC: meson: add t9015 internal codec binding documentation")
Signed-off-by: Alexander Stein <alexander.stein@mailbox.org>
---
I am aware that adding required properties to bindings is frowned upon. But in
this case it seems acceptable for the following reasons:
* AVDD-supply was used from the very first driver commit
* All DT (g12 and gxl) using t9015 controller provide AVDD-supply
  already
But I'm ok to not add it to required properties as well. The driver uses
it nevertheless though.

 Documentation/devicetree/bindings/sound/amlogic,t9015.yaml | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Rob Herring (Arm) Oct. 24, 2021, 2:27 p.m. UTC | #1
On Sat, 23 Oct 2021 23:48:53 +0200, Alexander Stein wrote:
> Fixes the schema check warning "audio-controller@32000: 'AVDD-supply'
> do not match any of the regexes: 'pinctrl-[0-9]+'"
> 
> Fixes: 5c36abcd2621 ("ASoC: meson: add t9015 internal codec binding documentation")
> Signed-off-by: Alexander Stein <alexander.stein@mailbox.org>
> ---
> I am aware that adding required properties to bindings is frowned upon. But in
> this case it seems acceptable for the following reasons:
> * AVDD-supply was used from the very first driver commit
> * All DT (g12 and gxl) using t9015 controller provide AVDD-supply
>   already
> But I'm ok to not add it to required properties as well. The driver uses
> it nevertheless though.
> 
>  Documentation/devicetree/bindings/sound/amlogic,t9015.yaml | 5 +++++
>  1 file changed, 5 insertions(+)
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/sound/amlogic,t9015.example.dt.yaml: audio-controller@32000: 'AVDD-supply' is a required property
	From schema: /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/sound/amlogic,t9015.yaml

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/patch/1545246

This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit.
Mark Brown Oct. 25, 2021, 9:44 a.m. UTC | #2
On Sat, Oct 23, 2021 at 11:48:53PM +0200, Alexander Stein wrote:
> Fixes the schema check warning "audio-controller@32000: 'AVDD-supply'
> do not match any of the regexes: 'pinctrl-[0-9]+'"

Please submit patches using subject lines reflecting the style for the
subsystem, this makes it easier for people to identify relevant patches.
Look at what existing commits in the area you're changing are doing and
make sure your subject lines visually resemble what they're doing.
There's no need to resubmit to fix this alone.
Jerome Brunet Oct. 25, 2021, 3:53 p.m. UTC | #3
On Sat 23 Oct 2021 at 23:48, Alexander Stein <alexander.stein@mailbox.org> wrote:

> Fixes the schema check warning "audio-controller@32000: 'AVDD-supply'
> do not match any of the regexes: 'pinctrl-[0-9]+'"
>
> Fixes: 5c36abcd2621 ("ASoC: meson: add t9015 internal codec binding documentation")
> Signed-off-by: Alexander Stein <alexander.stein@mailbox.org>

Hey Alexander,

First, thanks for picking this up.

I think Rob's automated reply is because you forgot to update the
example (if the property is required, it should be there)

Also, I believe this change could have been sent separately, to Marc
(instead of Cc) and with the "ASoC" prefix.

With this changed
Reviewed-by: Jerome Brunet <jbrunet@baylibre.com>

> ---
> I am aware that adding required properties to bindings is frowned upon. But in
> this case it seems acceptable for the following reasons:
> * AVDD-supply was used from the very first driver commit
> * All DT (g12 and gxl) using t9015 controller provide AVDD-supply
>   already
> But I'm ok to not add it to required properties as well. The driver uses
> it nevertheless though.
>
>  Documentation/devicetree/bindings/sound/amlogic,t9015.yaml | 5 +++++
>  1 file changed, 5 insertions(+)
>
> diff --git a/Documentation/devicetree/bindings/sound/amlogic,t9015.yaml b/Documentation/devicetree/bindings/sound/amlogic,t9015.yaml
> index c7613ea728d4..5f4e25ab5af6 100644
> --- a/Documentation/devicetree/bindings/sound/amlogic,t9015.yaml
> +++ b/Documentation/devicetree/bindings/sound/amlogic,t9015.yaml
> @@ -34,6 +34,10 @@ properties:
>    resets:
>      maxItems: 1
>  
> +  AVDD-supply:
> +    description:
> +      Analogue power supply.
> +
>  required:
>    - "#sound-dai-cells"
>    - compatible
> @@ -41,6 +45,7 @@ required:
>    - clocks
>    - clock-names
>    - resets
> +  - AVDD-supply
>  
>  additionalProperties: false
Alexander Stein Oct. 26, 2021, 4:30 p.m. UTC | #4
Hello Jerome,

Am Montag, 25. Oktober 2021, 17:53:04 CEST schrieb Jerome Brunet:
> On Sat 23 Oct 2021 at 23:48, Alexander Stein <alexander.stein@mailbox.org> 
wrote:
> > Fixes the schema check warning "audio-controller@32000: 'AVDD-supply'
> > do not match any of the regexes: 'pinctrl-[0-9]+'"
> > 
> > Fixes: 5c36abcd2621 ("ASoC: meson: add t9015 internal codec binding
> > documentation") Signed-off-by: Alexander Stein
> > <alexander.stein@mailbox.org>
> 
> Hey Alexander,
> 
> First, thanks for picking this up.
> 
> I think Rob's automated reply is because you forgot to update the
> example (if the property is required, it should be there)

Thanks for pointing that out, I noticed too that examples are validated as 
well, nice feature.

> Also, I believe this change could have been sent separately, to Marc
> (instead of Cc) and with the "ASoC" prefix.
> 
> With this changed
> Reviewed-by: Jerome Brunet <jbrunet@baylibre.com>

Yeah, I'll split the set during v2. Thanks for the review.

Best regards,
Alexander

> 
> > ---
> > I am aware that adding required properties to bindings is frowned upon.
> > But in this case it seems acceptable for the following reasons:
> > * AVDD-supply was used from the very first driver commit
> > * All DT (g12 and gxl) using t9015 controller provide AVDD-supply
> > 
> >   already
> > 
> > But I'm ok to not add it to required properties as well. The driver uses
> > it nevertheless though.
> > 
> >  Documentation/devicetree/bindings/sound/amlogic,t9015.yaml | 5 +++++
> >  1 file changed, 5 insertions(+)
> > 
> > diff --git a/Documentation/devicetree/bindings/sound/amlogic,t9015.yaml
> > b/Documentation/devicetree/bindings/sound/amlogic,t9015.yaml index
> > c7613ea728d4..5f4e25ab5af6 100644
> > --- a/Documentation/devicetree/bindings/sound/amlogic,t9015.yaml
> > +++ b/Documentation/devicetree/bindings/sound/amlogic,t9015.yaml
> > 
> > @@ -34,6 +34,10 @@ properties:
> >    resets:
> >      maxItems: 1
> > 
> > +  AVDD-supply:
> > +    description:
> > +      Analogue power supply.
> > +
> > 
> >  required:
> >    - "#sound-dai-cells"
> >    - compatible
> > 
> > @@ -41,6 +45,7 @@ required:
> >    - clocks
> >    - clock-names
> >    - resets
> > 
> > +  - AVDD-supply
> > 
> >  additionalProperties: false
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/sound/amlogic,t9015.yaml b/Documentation/devicetree/bindings/sound/amlogic,t9015.yaml
index c7613ea728d4..5f4e25ab5af6 100644
--- a/Documentation/devicetree/bindings/sound/amlogic,t9015.yaml
+++ b/Documentation/devicetree/bindings/sound/amlogic,t9015.yaml
@@ -34,6 +34,10 @@  properties:
   resets:
     maxItems: 1
 
+  AVDD-supply:
+    description:
+      Analogue power supply.
+
 required:
   - "#sound-dai-cells"
   - compatible
@@ -41,6 +45,7 @@  required:
   - clocks
   - clock-names
   - resets
+  - AVDD-supply
 
 additionalProperties: false