Re: [PATCH] dt-bindings: display: Convert connectors to DT schema

From: Rob Herring
Date: Thu Jun 18 2020 - 17:36:21 EST

On Thu, Jun 18, 2020 at 2:59 PM Sam Ravnborg <sam@xxxxxxxxxxxx> wrote:
>
> Hi Rob.
>
> On Thu, Jun 18, 2020 at 02:24:47PM -0600, Rob Herring wrote:
> > Convert the analog TV, DVI, HDMI, and VGA connector bindings to DT schema
> > format.
> >
> > Cc: Sam Ravnborg <sam@xxxxxxxxxxxx>
> > Cc: Laurent Pinchart <Laurent.pinchart@xxxxxxxxxxxxxxxx>
> > Cc: Maxime Ripard <mripard@xxxxxxxxxx>
> > Signed-off-by: Rob Herring <robh@xxxxxxxxxx>
> > ---
> > I put myself as maintainer, but would be happy if someone else was like
> > one of the Cc'ed people.
> I nominate Laurent for this....
>
> See some comments in the following.
> Mostly related to required - I may have missed something.
>
> Sam
> >
> > .../display/connector/analog-tv-connector.txt | 31 --------
> > .../connector/analog-tv-connector.yaml | 47 ++++++++++++
> > .../display/connector/dvi-connector.txt | 36 ---------
> > .../display/connector/dvi-connector.yaml | 75 +++++++++++++++++++
> > .../display/connector/hdmi-connector.txt | 31 --------
> > .../display/connector/hdmi-connector.yaml | 63 ++++++++++++++++
> > .../display/connector/vga-connector.txt | 36 ---------
> > .../display/connector/vga-connector.yaml | 42 +++++++++++
> > 8 files changed, 227 insertions(+), 134 deletions(-)
> > delete mode 100644 Documentation/devicetree/bindings/display/connector/analog-tv-connector.txt
> > create mode 100644 Documentation/devicetree/bindings/display/connector/analog-tv-connector.yaml
> > delete mode 100644 Documentation/devicetree/bindings/display/connector/dvi-connector.txt
> > create mode 100644 Documentation/devicetree/bindings/display/connector/dvi-connector.yaml
> > delete mode 100644 Documentation/devicetree/bindings/display/connector/hdmi-connector.txt
> > create mode 100644 Documentation/devicetree/bindings/display/connector/hdmi-connector.yaml
> > delete mode 100644 Documentation/devicetree/bindings/display/connector/vga-connector.txt
> > create mode 100644 Documentation/devicetree/bindings/display/connector/vga-connector.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/display/connector/analog-tv-connector.txt b/Documentation/devicetree/bindings/display/connector/analog-tv-connector.txt
> > deleted file mode 100644
> > index 883bcb2604c7..000000000000
> > --- a/Documentation/devicetree/bindings/display/connector/analog-tv-connector.txt
> > +++ /dev/null
> > @@ -1,31 +0,0 @@
> > -Analog TV Connector
> > -===================
> > -
> > -Required properties:
> > -- compatible: "composite-video-connector" or "svideo-connector"
> > -
> > -Optional properties:
> > -- label: a symbolic name for the connector
> > -- sdtv-standards: limit the supported TV standards on a connector to the given
> > - ones. If not specified all TV standards are allowed.
> > - Possible TV standards are defined in
> > - include/dt-bindings/display/sdtv-standards.h.
> > -
> > -Required nodes:
> > -- Video port for TV input
> > -
> > -Example
> > --------
> > -#include <dt-bindings/display/sdtv-standards.h>
> > -
> > -tv: connector {
> > - compatible = "composite-video-connector";
> > - label = "tv";
> > - sdtv-standards = <(SDTV_STD_PAL | SDTV_STD_NTSC)>;
> > -
> > - port {
> > - tv_connector_in: endpoint {
> > - remote-endpoint = <&venc_out>;
> > - };
> > - };
> > -};
> > diff --git a/Documentation/devicetree/bindings/display/connector/analog-tv-connector.yaml b/Documentation/devicetree/bindings/display/connector/analog-tv-connector.yaml
> > new file mode 100644
> > index 000000000000..d9ac42cb7e04
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/display/connector/analog-tv-connector.yaml
> > @@ -0,0 +1,47 @@
> > +# SPDX-License-Identifier: GPL-2.0-only
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/display/connector/analog-tv-connector.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Analog TV Connector
> > +
> > +maintainers:
> > + - Rob Herring <robh@xxxxxxxxxx>
> > +
> > +properties:
> > + compatible:
> > + enum:
> > + - composite-video-connector
> > + - svideo-connector
> > +
> > + label: true
> > +
> > + sdtv-standards:
> > + description: Limit the supported TV standards on a connector to the given
> > + ones. If not specified all TV standards are allowed. Possible TV
> > + standards are defined in include/dt-bindings/display/sdtv-standards.h.
> > + $ref: /schemas/types.yaml#/definitions/uint32
> > +
> > + port:
> > + description: Connection to controller providing analog TV signals
> required:
> - compatible
> - port
>
> ??

compatible is implicitly required as that has to be there to match on.
So if it was the only thing, I just omitted it. Maybe better to just
list it.

I was thinking port is optional on all these as it could just be the
parent node.

>
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > + - |
> > + #include <dt-bindings/display/sdtv-standards.h>
> > +
> > + connector {
> > + compatible = "composite-video-connector";
> > + label = "tv";
> > + sdtv-standards = <(SDTV_STD_PAL | SDTV_STD_NTSC)>;
> > +
> > + port {
> > + tv_connector_in: endpoint {
> > + remote-endpoint = <&venc_out>;
> > + };
> > + };
> > + };
> My personal preference is 4 space indent.
> Easier to read for me.

Sure.

> But we discussed this before - would be good
> with a recommendation so we know what to expect.

I don't really care until we have a way to automatically check it.
Then it will be the Law.

>
> Oh, and example-schema uses 6 spaces :-(

Humm...

> > +
> > +...
> > diff --git a/Documentation/devicetree/bindings/display/connector/dvi-connector.txt b/Documentation/devicetree/bindings/display/connector/dvi-connector.txt
> > deleted file mode 100644
> > index 207e42e9eba0..000000000000
> > --- a/Documentation/devicetree/bindings/display/connector/dvi-connector.txt
> > +++ /dev/null
> > @@ -1,36 +0,0 @@
> > -DVI Connector
> > -==============
> > -
> > -Required properties:
> > -- compatible: "dvi-connector"
> > -
> > -Optional properties:
> > -- label: a symbolic name for the connector
> > -- ddc-i2c-bus: phandle to the i2c bus that is connected to DVI DDC
> > -- analog: the connector has DVI analog pins
> > -- digital: the connector has DVI digital pins
> > -- dual-link: the connector has pins for DVI dual-link
> > -- hpd-gpios: HPD GPIO number
> > -
> > -Required nodes:
> > -- Video port for DVI input
> > -
> > -Note: One (or both) of 'analog' or 'digital' must be set.
> > -
> > -Example
> > --------
> > -
> > -dvi0: connector@0 {
> > - compatible = "dvi-connector";
> > - label = "dvi";
> > -
> > - digital;
> > -
> > - ddc-i2c-bus = <&i2c3>;
> > -
> > - port {
> > - dvi_connector_in: endpoint {
> > - remote-endpoint = <&tfp410_out>;
> > - };
> > - };
> > -};
> > diff --git a/Documentation/devicetree/bindings/display/connector/dvi-connector.yaml b/Documentation/devicetree/bindings/display/connector/dvi-connector.yaml
> > new file mode 100644
> > index 000000000000..aaf61bce64ca
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/display/connector/dvi-connector.yaml
> > @@ -0,0 +1,75 @@
> > +# SPDX-License-Identifier: GPL-2.0-only
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/display/connector/dvi-connector.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: DVI Connector
> > +
> > +maintainers:
> > + - Rob Herring <robh@xxxxxxxxxx>
> > +
> > +properties:
> > + compatible:
> > + const: dvi-connector
> > +
> > + type:
> > + description: The HDMI connector type
> > + enum:
> > + - a # Standard full size
> > + - b # Never deployed?
> > + - c # Mini
> > + - d # Micro
> > + - e # automotive
> type looks like something that was copied from another binding.
> It is not part of the .txt binding.

Err, copy-n-paste from hdmi...

Rob