[v2,2/3] ASoC: dt-bindings: maxim,max9867: add clocks property

Message ID 20230302-max9867-v2-2-fd2036d5e825@skidata.com
State New
Headers
Series Add "mclk" support for maxim,max9867 |

Commit Message

Richard Leitner March 3, 2023, 10:04 a.m. UTC
  From: Richard Leitner <richard.leitner@skidata.com>

Add clocks property to require a "mclk" definition for the
maxim,max9867 codec.

Signed-off-by: Richard Leitner <richard.leitner@skidata.com>
---
 Documentation/devicetree/bindings/sound/maxim,max9867.yaml | 11 +++++++++++
 1 file changed, 11 insertions(+)
  

Comments

Richard Leitner March 3, 2023, 10:19 a.m. UTC | #1
Hi Krzysztof,
thanks for the review and quick response!

On Fri, Mar 03, 2023 at 11:09:15AM +0100, Krzysztof Kozlowski wrote:
> On 03/03/2023 11:04, richard.leitner@linux.dev wrote:
> > From: Richard Leitner <richard.leitner@skidata.com>
> > 
> > Add clocks property to require a "mclk" definition for the
> > maxim,max9867 codec.
> 
> But why? You just wrote what the patch does, which is easy to see.
> Commit msgs should explain why you are doing something.

Ok. Will adapt the message in v3.

> 
> > 
> > Signed-off-by: Richard Leitner <richard.leitner@skidata.com>
> > ---
> >  Documentation/devicetree/bindings/sound/maxim,max9867.yaml | 11 +++++++++++
> >  1 file changed, 11 insertions(+)
> > 
> > diff --git a/Documentation/devicetree/bindings/sound/maxim,max9867.yaml b/Documentation/devicetree/bindings/sound/maxim,max9867.yaml
> > index 74cd163546ec..6f27029b137d 100644
> > --- a/Documentation/devicetree/bindings/sound/maxim,max9867.yaml
> > +++ b/Documentation/devicetree/bindings/sound/maxim,max9867.yaml
> > @@ -35,9 +35,13 @@ properties:
> >    reg:
> >      maxItems: 1
> >  
> > +  clocks:
> > +    maxItems: 1
> > +
> >  required:
> >    - compatible
> >    - reg
> > +  - clocks
> >  
> >  additionalProperties: false
> >  
> > @@ -50,6 +54,13 @@ examples:
> >              compatible = "maxim,max9867";
> >              #sound-dai-cells = <0>;
> >              reg = <0x18>;
> > +            clocks = <&codec_clk>;
> >          };
> >      };
> > +
> > +    codec_clk: clock {
> > +        compatible = "fixed-clock";
> > +        #clock-cells = <0>;
> > +        clock-frequency = <12288000>;
> 
> Drop the node, it's entirely common/regular stuff.

True. I thought it is nessecary for
	"make DT_CHECKER_FLAGS=-m dt_binding_check"
to succeed. But I just learned it in fact isn't.
Thanks for the pointer and that eureka moment 😉.

Will fix that in v3.

> 
> Best regards,
> Krzysztof
> 

regards;rl
  

Patch

diff --git a/Documentation/devicetree/bindings/sound/maxim,max9867.yaml b/Documentation/devicetree/bindings/sound/maxim,max9867.yaml
index 74cd163546ec..6f27029b137d 100644
--- a/Documentation/devicetree/bindings/sound/maxim,max9867.yaml
+++ b/Documentation/devicetree/bindings/sound/maxim,max9867.yaml
@@ -35,9 +35,13 @@  properties:
   reg:
     maxItems: 1
 
+  clocks:
+    maxItems: 1
+
 required:
   - compatible
   - reg
+  - clocks
 
 additionalProperties: false
 
@@ -50,6 +54,13 @@  examples:
             compatible = "maxim,max9867";
             #sound-dai-cells = <0>;
             reg = <0x18>;
+            clocks = <&codec_clk>;
         };
     };
+
+    codec_clk: clock {
+        compatible = "fixed-clock";
+        #clock-cells = <0>;
+        clock-frequency = <12288000>;
+    };
 ...