Re: [PATCH v2] dt-bindings: display: dw_mipi_dsi.txt: convert to yaml

From: Laurent Pinchart
Date: Tue Apr 21 2020 - 21:11:53 EST


Hi Adrian,

Thank you for the patch.

On Tue, Apr 21, 2020 at 01:58:14PM +0300, Adrian Ratiu wrote:
> This converts the Synopsis MIPI DSI binding documentation to yaml and
> should be quite straightforward. I've added a missing ref clk and also
> added Philippe as maintainer b/c he's the original txt author following
> the algorithm provided in Message-ID 20200420175909.GA5810@xxxxxxxxxxxxx
>
> Cc: Rob Herring <robh@xxxxxxxxxx>
> Cc: Philippe CORNU <philippe.cornu@xxxxxx>
> Cc: devicetree@xxxxxxxxxxxxxxx
> Suggested-by: Laurent Pinchart <laurent.pinchart@xxxxxxxxxxxxxxxx>
> Signed-off-by: Adrian Ratiu <adrian.ratiu@xxxxxxxxxxxxx>
> ---
> Changes in v2:
> - Removed unnecessary descriptions and maxItems (Rob)
> - Changed maintainers entry / dropped Mark (Rob)
> - Added dsi-controller.yaml ref (Rob)
> ---
> .../bindings/display/bridge/dw_mipi_dsi.txt | 32 -----------
> .../display/bridge/snps,dw-mipi-dsi.yaml | 56 +++++++++++++++++++
> 2 files changed, 56 insertions(+), 32 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/display/bridge/dw_mipi_dsi.txt
> create mode 100644 Documentation/devicetree/bindings/display/bridge/snps,dw-mipi-dsi.yaml
>
> diff --git a/Documentation/devicetree/bindings/display/bridge/dw_mipi_dsi.txt b/Documentation/devicetree/bindings/display/bridge/dw_mipi_dsi.txt
> deleted file mode 100644
> index b13adf30b8d3b..0000000000000
> --- a/Documentation/devicetree/bindings/display/bridge/dw_mipi_dsi.txt
> +++ /dev/null
> @@ -1,32 +0,0 @@
> -Synopsys DesignWare MIPI DSI host controller
> -============================================
> -
> -This document defines device tree properties for the Synopsys DesignWare MIPI
> -DSI host controller. It doesn't constitue a device tree binding specification
> -by itself but is meant to be referenced by platform-specific device tree
> -bindings.
> -
> -When referenced from platform device tree bindings the properties defined in
> -this document are defined as follows. The platform device tree bindings are
> -responsible for defining whether each optional property is used or not.
> -
> -- reg: Memory mapped base address and length of the DesignWare MIPI DSI
> - host controller registers. (mandatory)
> -
> -- clocks: References to all the clocks specified in the clock-names property
> - as specified in [1]. (mandatory)
> -
> -- clock-names:
> - - "pclk" is the peripheral clock for either AHB and APB. (mandatory)
> - - "px_clk" is the pixel clock for the DPI/RGB input. (optional)
> -
> -- resets: References to all the resets specified in the reset-names property
> - as specified in [2]. (optional)
> -
> -- reset-names: string reset name, must be "apb" if used. (optional)
> -
> -- panel or bridge node: see [3]. (mandatory)
> -
> -[1] Documentation/devicetree/bindings/clock/clock-bindings.txt
> -[2] Documentation/devicetree/bindings/reset/reset.txt
> -[3] Documentation/devicetree/bindings/display/mipi-dsi-bus.txt
> diff --git a/Documentation/devicetree/bindings/display/bridge/snps,dw-mipi-dsi.yaml b/Documentation/devicetree/bindings/display/bridge/snps,dw-mipi-dsi.yaml
> new file mode 100644
> index 0000000000000..d9ab464f79ff4
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/display/bridge/snps,dw-mipi-dsi.yaml
> @@ -0,0 +1,56 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/display/bridge/snps,dw-mipi-dsi.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Synopsys DesignWare MIPI DSI host controller
> +
> +maintainers:
> + - Philippe CORNU <philippe.cornu@xxxxxx>
> +
> +description: |
> + This document defines device tree properties for the Synopsys DesignWare MIPI
> + DSI host controller. It doesn't constitue a device tree binding specification
> + by itself but is meant to be referenced by platform-specific device tree
> + bindings.
> +
> + When referenced from platform device tree bindings the properties defined in
> + this document are defined as follows. The platform device tree bindings are
> + responsible for defining whether each property is required or optional.
> +
> +allOf:
> + - $ref: ../dsi-controller.yaml#
> +
> +properties:
> + reg:
> + maxItems: 1
> +
> + clocks:
> + items:
> + - description: Module clock
> + - description: DSI bus clock for either AHB and APB
> + - description: Pixel clock for the DPI/RGB input
> + minItems: 2
> +
> + clock-names:
> + items:
> + - const: ref
> + - const: pclk
> + - const: px_clk
> + minItems: 2
> +
> + resets:
> + maxItems: 1
> +
> + reset-names:
> + const: apb

I think you can also add the ports property and its child port@0 and
port@1, as they're required in all cases.

> +
> +patternProperties:
> + "^panel@[0-3]$":
> + type: object
> +
> +required:
> + - reg
> + - clocks
> + - clock-names

--
Regards,

Laurent Pinchart