diff mbox series

[V5,2/4] dt-bindings: display: panel: Add Magnachip D53E6EA8966

Message ID 20221214180611.109651-3-macroalpha82@gmail.com
State Changes Requested, archived
Headers show
Series drm/panel: Add Magnachip D53E6EA8966 Panel Controller | expand

Checks

Context Check Description
robh/patch-applied success
robh/checkpatch success
robh/patch-applied success
robh/dt-meta-schema fail build log
robh/checkpatch success
robh/dt-meta-schema fail build log

Commit Message

Chris Morgan Dec. 14, 2022, 6:06 p.m. UTC
From: Chris Morgan <macromorgan@hotmail.com>

Add documentation for Magnachip D53E6EA8966 based panels such as the
Samsung AMS495QA01 panel.

Signed-off-by: Chris Morgan <macromorgan@hotmail.com>
Signed-off-by: Maya Matuszczyk <maccraft123mc@gmail.com>
---
 .../display/panel/magnachip,d53e6ea8966.yaml  | 62 +++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/display/panel/magnachip,d53e6ea8966.yaml

Comments

Rob Herring (Arm) Dec. 14, 2022, 8:54 p.m. UTC | #1
On Wed, 14 Dec 2022 12:06:09 -0600, Chris Morgan wrote:
> From: Chris Morgan <macromorgan@hotmail.com>
> 
> Add documentation for Magnachip D53E6EA8966 based panels such as the
> Samsung AMS495QA01 panel.
> 
> Signed-off-by: Chris Morgan <macromorgan@hotmail.com>
> Signed-off-by: Maya Matuszczyk <maccraft123mc@gmail.com>
> ---
>  .../display/panel/magnachip,d53e6ea8966.yaml  | 62 +++++++++++++++++++
>  1 file changed, 62 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/display/panel/magnachip,d53e6ea8966.yaml
> 

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:
./Documentation/devicetree/bindings/display/panel/magnachip,d53e6ea8966.yaml: $id: relative path/filename doesn't match actual path or filename
	expected: http://devicetree.org/schemas/display/panel/magnachip,d53e6ea8966.yaml#

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20221214180611.109651-3-macroalpha82@gmail.com

The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.

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 after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.
Linus Walleij Dec. 15, 2022, 8:47 a.m. UTC | #2
On Wed, Dec 14, 2022 at 7:06 PM Chris Morgan <macroalpha82@gmail.com> wrote:

> From: Chris Morgan <macromorgan@hotmail.com>
>
> Add documentation for Magnachip D53E6EA8966 based panels such as the
> Samsung AMS495QA01 panel.
>
> Signed-off-by: Chris Morgan <macromorgan@hotmail.com>
> Signed-off-by: Maya Matuszczyk <maccraft123mc@gmail.com>
(...)
>  .../display/panel/magnachip,d53e6ea8966.yaml  | 62 +++++++++++++++++++

It's fine to keep this as samsung,ams495qa01.

Just mention that it uses the magnachip controller in the
description.

That Linux implements this with a generic driver that handles
all (in theory possible) magnachip-based products is a linuxism
and does not need to be in the bindings.

Yours,
Linus Walleij
Chris Morgan Dec. 15, 2022, 2:44 p.m. UTC | #3
On Thu, Dec 15, 2022 at 09:47:19AM +0100, Linus Walleij wrote:
> On Wed, Dec 14, 2022 at 7:06 PM Chris Morgan <macroalpha82@gmail.com> wrote:
> 
> > From: Chris Morgan <macromorgan@hotmail.com>
> >
> > Add documentation for Magnachip D53E6EA8966 based panels such as the
> > Samsung AMS495QA01 panel.
> >
> > Signed-off-by: Chris Morgan <macromorgan@hotmail.com>
> > Signed-off-by: Maya Matuszczyk <maccraft123mc@gmail.com>
> (...)
> >  .../display/panel/magnachip,d53e6ea8966.yaml  | 62 +++++++++++++++++++
> 
> It's fine to keep this as samsung,ams495qa01.
> 

Would the device tree team be okay with that change? The driver name
itself has changed and I fear possible confusion if someone is looking
for docs by driver name.

Otherwise I noticed I had an outdated version of the dt-schema and
missed an error, so I have to resubmit either way to fix it. The
horrors of upgrading your build machine...

Thank you

> Just mention that it uses the magnachip controller in the
> description.
> 
> That Linux implements this with a generic driver that handles
> all (in theory possible) magnachip-based products is a linuxism
> and does not need to be in the bindings.
> 
> Yours,
> Linus Walleij
Rob Herring (Arm) Dec. 15, 2022, 4:16 p.m. UTC | #4
On Thu, Dec 15, 2022 at 08:44:56AM -0600, Chris Morgan wrote:
> On Thu, Dec 15, 2022 at 09:47:19AM +0100, Linus Walleij wrote:
> > On Wed, Dec 14, 2022 at 7:06 PM Chris Morgan <macroalpha82@gmail.com> wrote:
> > 
> > > From: Chris Morgan <macromorgan@hotmail.com>
> > >
> > > Add documentation for Magnachip D53E6EA8966 based panels such as the
> > > Samsung AMS495QA01 panel.
> > >
> > > Signed-off-by: Chris Morgan <macromorgan@hotmail.com>
> > > Signed-off-by: Maya Matuszczyk <maccraft123mc@gmail.com>
> > (...)
> > >  .../display/panel/magnachip,d53e6ea8966.yaml  | 62 +++++++++++++++++++
> > 
> > It's fine to keep this as samsung,ams495qa01.
> > 
> 
> Would the device tree team be okay with that change? The driver name
> itself has changed and I fear possible confusion if someone is looking
> for docs by driver name.

Doesn't matter to me either way.

Rob
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/display/panel/magnachip,d53e6ea8966.yaml b/Documentation/devicetree/bindings/display/panel/magnachip,d53e6ea8966.yaml
new file mode 100644
index 000000000000..0a57a303a758
--- /dev/null
+++ b/Documentation/devicetree/bindings/display/panel/magnachip,d53e6ea8966.yaml
@@ -0,0 +1,62 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/display/panel/samsung,ams495qa01.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Magnachip D53E6EA8966 based display panel
+
+description: |
+  Magnachip D53E6EA8966 based display panels, such as the one found on
+  the Anbernic RG503 that is combined with a 940x544 OLED Samsung
+  AMS495QA01.
+
+maintainers:
+  - Chris Morgan <macromorgan@hotmail.com>
+
+allOf:
+  - $ref: panel-common.yaml#
+
+properties:
+  compatible:
+    const: samsung,ams495qa01
+
+  reg: true
+  reset-gpios:
+    description: reset gpio, must be GPIO_ACTIVE_LOW
+  elvdd-supply:
+    description: regulator that supplies voltage to the panel display
+  enable-gpios: true
+  port: true
+  vdd-supply:
+    description: regulator that supplies voltage to panel logic
+
+required:
+  - compatible
+  - reg
+  - reset-gpios
+  - vdd-supply
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+        panel@0 {
+            compatible = "samsung,ams495qa01";
+            reg = <0>;
+            reset-gpios = <&gpio4 0 GPIO_ACTIVE_LOW>;
+            vdd-supply = <&vcc_3v3>;
+
+            port {
+                mipi_in_panel: endpoint {
+                  remote-endpoint = <&mipi_out_panel>;
+                };
+            };
+        };
+    };
+
+...