[PATCH v2 2/2] dt-bindings: one file of all simple DSI panels

[Rob Herring]

On Thu, Jan 2, 2020 at 4:17 AM Sam Ravnborg <sam at ravnborg.org> wrote:
>
> To complement panel-simple.yaml, create panel-simple-dsi.yaml.
> panel-simple-dsi-yaml are for all simple DSP panels with a single
> power-supply and optional backlight / enable GPIO.
>
> Migrate panasonic,vvx10f034n00 over to the new file.
>
> The objectives with one file for all the simple DSI panels are:
>     - Make it simpler to add bindings for simple DSI panels
>     - Keep the number of bindings file lower
>     - Keep the binding documentation for simple DSI panels more consistent
>
> Signed-off-by: Sam Ravnborg <sam at ravnborg.org>
> Cc: Thierry Reding <thierry.reding at gmail.com>
> Cc: Rob Herring <robh at kernel.org>
> Cc: Maxime Ripard <mripard at kernel.org>
> Cc: Yannick Fertre <yannick.fertre at st.com>
> Cc: Mark Rutland <mark.rutland at arm.com>
> Cc: Daniel Vetter <daniel at ffwll.ch>
> Cc: dri-devel at lists.freedesktop.org
> Cc: devicetree at vger.kernel.org
> ---
>  .../display/panel/panasonic,vvx10f034n00.txt  | 20 ------
>  .../display/panel/panel-simple-dsi.yaml       | 67 +++++++++++++++++++
>  2 files changed, 67 insertions(+), 20 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/display/panel/panasonic,vvx10f034n00.txt
>  create mode 100644 Documentation/devicetree/bindings/display/panel/panel-simple-dsi.yaml

Reviewed-by: Rob Herring <robh at kernel.org>

>
> diff --git a/Documentation/devicetree/bindings/display/panel/panasonic,vvx10f034n00.txt b/Documentation/devicetree/bindings/display/panel/panasonic,vvx10f034n00.txt
> deleted file mode 100644
> index 37dedf6a6702..000000000000
> --- a/Documentation/devicetree/bindings/display/panel/panasonic,vvx10f034n00.txt
> +++ /dev/null
> @@ -1,20 +0,0 @@
> -Panasonic 10" WUXGA TFT LCD panel
> -
> -Required properties:
> -- compatible: should be "panasonic,vvx10f034n00"
> -- reg: DSI virtual channel of the peripheral
> -- power-supply: phandle of the regulator that provides the supply voltage
> -
> -Optional properties:
> -- backlight: phandle of the backlight device attached to the panel
> -
> -Example:
> -
> -       mdss_dsi at fd922800 {
> -               panel at 0 {
> -                       compatible = "panasonic,vvx10f034n00";
> -                       reg = <0>;
> -                       power-supply = <&vreg_vsp>;
> -                       backlight = <&lp8566_wled>;
> -               };
> -       };
> diff --git a/Documentation/devicetree/bindings/display/panel/panel-simple-dsi.yaml b/Documentation/devicetree/bindings/display/panel/panel-simple-dsi.yaml
> new file mode 100644
> index 000000000000..05c52390269e
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/display/panel/panel-simple-dsi.yaml
> @@ -0,0 +1,67 @@
> +# SPDX-License-Identifier: (GPL-2.0-only or BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/display/panel/panel-simple-dsi.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Simple DSI panels with a single power-supply
> +
> +maintainers:
> +  - Thierry Reding <thierry.reding at gmail.com>
> +  - Sam Ravnborg <sam at ravnborg.org>
> +
> +description: |
> +  This binding file is a collection of the DSI panels that
> +  requires only a single power-supply.
> +  There are optionally a backlight and an enable GPIO.
> +  The panel may use an OF graph binding for the association to the display,
> +  or it may be a direct child node of the display.
> +
> +  If the panel is more advanced a dedicated binding file is required.
> +
> +allOf:
> +  - $ref: panel-common.yaml#
> +
> +properties:
> +
> +  compatible:
> +    enum:
> +    # compatible must be listed in alphabetical order, ordered by compatible.
> +    # The description in the comment is mandatory for each compatible.

To answer your irc question, this is fine. You could do it like this instead:

oneOf:
  - description: ...
    const: compat-string
  - description: ...
    const: compat-string-2

The advantage is being able to extract 'description' if say you wanted
to generate documentation. Even so, I somewhat prefer how you have it.

> +
> +    # Panasonic 10" WUXGA TFT LCD panel

I'd align the # with the string to keep the list '-' a bit more
visible. IOW, 2 more spaces (before my next comment).

> +    - panasonic,vvx10f034n00

This should be indented 2 more spaces.

BTW, I extracted all the panels from my patch with this:

git show | grep -E '(title|const)' | sed -e 's/\+title:/  #/' -e 's/+
  const:/\-/'

There's a few with more than just 'title'.

Rob