diff mbox series

[v1,1/1] dt-bindings: fix simple-framebuffer example

Message ID 20200704143544.789345-2-sam@ravnborg.org
State Changes Requested
Headers show
Series dt-bindings: fix simple-framebuffer warning | expand

Checks

Context Check Description
robh/dt-meta-schema success
robh/checkpatch warning total: 0 errors, 2 warnings, 51 lines checked

Commit Message

Sam Ravnborg July 4, 2020, 2:35 p.m. UTC
Now that dt-extract-example gained support for using root nodes
in examples, update the example for the simple-frambuffer binding to use it.

This gives us a better example and kill a long standing warning:

simple-framebuffer.example.dts:23.16-39.11:
Warning (chosen_node_is_root): /example-0/chosen: chosen node must be at root node

Note: To get the update dt-extract-example execute:
pip3 install git+https://github.com/devicetree-org/dt-schema.git@master --upgrade

Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
Cc: Hans de Goede <hdegoede@redhat.com>
Cc: David Airlie <airlied@linux.ie>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>
Cc: linux-fbdev@vger.kernel.org
---
 .../bindings/display/simple-framebuffer.yaml  | 45 ++++++++++---------
 1 file changed, 23 insertions(+), 22 deletions(-)

Comments

Geert Uytterhoeven July 4, 2020, 9:03 p.m. UTC | #1
Hi Sam,

Thanks for your patch!

On Sat, Jul 4, 2020 at 4:37 PM Sam Ravnborg <sam@ravnborg.org> wrote:
> Now that dt-extract-example gained support for using root nodes
> in examples, update the example for the simple-frambuffer binding to use it.

simple-framebuffer

> This gives us a better example and kill a long standing warning:
>
> simple-framebuffer.example.dts:23.16-39.11:
> Warning (chosen_node_is_root): /example-0/chosen: chosen node must be at root node
>
> Note: To get the update dt-extract-example execute:
> pip3 install git+https://github.com/devicetree-org/dt-schema.git@master --upgrade
>
> Signed-off-by: Sam Ravnborg <sam@ravnborg.org>

> --- a/Documentation/devicetree/bindings/display/simple-framebuffer.yaml
> +++ b/Documentation/devicetree/bindings/display/simple-framebuffer.yaml
> @@ -152,28 +152,29 @@ additionalProperties: false
>
>  examples:
>    - |
> -    aliases {
> -      display0 = &lcdc0;

Why drop the aliases example?

Gr{oetje,eeting}s,

                        Geert
Sam Ravnborg July 4, 2020, 9:26 p.m. UTC | #2
On Sat, Jul 04, 2020 at 11:03:21PM +0200, Geert Uytterhoeven wrote:
> Hi Sam,
> 
> Thanks for your patch!
> 
> On Sat, Jul 4, 2020 at 4:37 PM Sam Ravnborg <sam@ravnborg.org> wrote:
> > Now that dt-extract-example gained support for using root nodes
> > in examples, update the example for the simple-frambuffer binding to use it.
> 
> simple-framebuffer
Thanks, will fix.

> 
> > This gives us a better example and kill a long standing warning:
> >
> > simple-framebuffer.example.dts:23.16-39.11:
> > Warning (chosen_node_is_root): /example-0/chosen: chosen node must be at root node
> >
> > Note: To get the update dt-extract-example execute:
> > pip3 install git+https://github.com/devicetree-org/dt-schema.git@master --upgrade
> >
> > Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
> 
> > --- a/Documentation/devicetree/bindings/display/simple-framebuffer.yaml
> > +++ b/Documentation/devicetree/bindings/display/simple-framebuffer.yaml
> > @@ -152,28 +152,29 @@ additionalProperties: false
> >
> >  examples:
> >    - |
> > -    aliases {
> > -      display0 = &lcdc0;
> 
> Why drop the aliases example?
I did not see it had any value for the binding that the example shall
demonstrate. But it was not somthing I have given much thought of.

	Sam

> 
> 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
Rob Herring July 9, 2020, 4:43 p.m. UTC | #3
On Sat, Jul 4, 2020 at 3:26 PM Sam Ravnborg <sam@ravnborg.org> wrote:
>
> On Sat, Jul 04, 2020 at 11:03:21PM +0200, Geert Uytterhoeven wrote:
> > Hi Sam,
> >
> > Thanks for your patch!
> >
> > On Sat, Jul 4, 2020 at 4:37 PM Sam Ravnborg <sam@ravnborg.org> wrote:
> > > Now that dt-extract-example gained support for using root nodes
> > > in examples, update the example for the simple-frambuffer binding to use it.
> >
> > simple-framebuffer
> Thanks, will fix.
>
> >
> > > This gives us a better example and kill a long standing warning:
> > >
> > > simple-framebuffer.example.dts:23.16-39.11:
> > > Warning (chosen_node_is_root): /example-0/chosen: chosen node must be at root node
> > >
> > > Note: To get the update dt-extract-example execute:
> > > pip3 install git+https://github.com/devicetree-org/dt-schema.git@master --upgrade
> > >
> > > Signed-off-by: Sam Ravnborg <sam@ravnborg.org>
> >
> > > --- a/Documentation/devicetree/bindings/display/simple-framebuffer.yaml
> > > +++ b/Documentation/devicetree/bindings/display/simple-framebuffer.yaml
> > > @@ -152,28 +152,29 @@ additionalProperties: false
> > >
> > >  examples:
> > >    - |
> > > -    aliases {
> > > -      display0 = &lcdc0;
> >
> > Why drop the aliases example?
> I did not see it had any value for the binding that the example shall
> demonstrate. But it was not somthing I have given much thought of.

I don't think anything actually supports 'display' aliases and it is
beyond the scope of this binding, so I'd drop.

stdout-path should be dropped too as it points to this.

Rob
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/display/simple-framebuffer.yaml b/Documentation/devicetree/bindings/display/simple-framebuffer.yaml
index 1db608c9eef5..6f23ea14132b 100644
--- a/Documentation/devicetree/bindings/display/simple-framebuffer.yaml
+++ b/Documentation/devicetree/bindings/display/simple-framebuffer.yaml
@@ -152,28 +152,29 @@  additionalProperties: false
 
 examples:
   - |
-    aliases {
-      display0 = &lcdc0;
+    / {
+        compatible = "foo";
+        model = "foo";
+        #address-cells = <1>;
+        #size-cells = <1>;
+
+        chosen {
+            #address-cells = <1>;
+            #size-cells = <1>;
+            stdout-path = "display0";
+            framebuffer0: framebuffer@1d385000 {
+                compatible = "allwinner,simple-framebuffer", "simple-framebuffer";
+                allwinner,pipeline = "de_be0-lcd0";
+                reg = <0x1d385000 3840000>;
+                width = <1600>;
+                height = <1200>;
+                stride = <3200>;
+                format = "r5g6b5";
+                clocks = <&ahb_gates 36>, <&ahb_gates 43>, <&ahb_gates 44>;
+                lcd-supply = <&reg_dc1sw>;
+                display = <&lcdc0>;
+            };
+        };
     };
 
-    chosen {
-      #address-cells = <1>;
-      #size-cells = <1>;
-      stdout-path = "display0";
-      framebuffer0: framebuffer@1d385000 {
-        compatible = "allwinner,simple-framebuffer", "simple-framebuffer";
-        allwinner,pipeline = "de_be0-lcd0";
-        reg = <0x1d385000 3840000>;
-        width = <1600>;
-        height = <1200>;
-        stride = <3200>;
-        format = "r5g6b5";
-        clocks = <&ahb_gates 36>, <&ahb_gates 43>, <&ahb_gates 44>;
-        lcd-supply = <&reg_dc1sw>;
-        display = <&lcdc0>;
-      };
-    };
-
-    lcdc0: lcdc { };
-
 ...