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

From: Adrian Ratiu
Date: Thu Apr 16 2020 - 12:29:34 EST

Hi Rob,

Thank you for the review, I will address all your points in v2, however I have a one neclarity below.

On Thu, 16 Apr 2020, Rob Herring <robh@xxxxxxxxxx> wrote:
On Thu, Apr 16, 2020 at 7:51 AM Adrian Ratiu <adrian.ratiu@xxxxxxxxxxxxx> 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 Mark and Rob as maintainers based on 'get_maintainer.pl' results.
Cc: Rob Herring <robh@xxxxxxxxxx> Cc: Mark Rutland <mark.rutland@xxxxxxx> Cc: devicetree@xxxxxxxxxxxxxxx Suggested-by: Laurent Pinchart <laurent.pinchart@xxxxxxxxxxxxxxxx> Signed-off-by: Adrian Ratiu <adrian.ratiu@xxxxxxxxxxxxx> --- .../bindings/display/bridge/dw_mipi_dsi.txt | 32 --------- .../display/bridge/snps,dw-mipi-dsi.yaml | 66 +++++++++++++++++++ 2 files changed, 66 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 b13adf30b8d3..000000000000 --- 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 000000000000..0ab4125eee30 --- /dev/null +++ b/Documentation/devicetree/bindings/display/bridge/snps,dw-mipi-dsi.yaml @@ -0,0 +1,66 @@ +# 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: + - Rob Herring <robh+dt@xxxxxxxxxx>

No thanks, I don't know anything about this hardware. It should be the owner for this binding, not who applies patches.

Sorry about that, I just followed what get_maintainer.pl -f returned.

I'm not sure I understand the owner vs maintainers difference for the "maintainers" entry. How do I find out who is the owner?

Looking at the git log, this file was touched only once when added in 88dd1e6f9ad8 ("dt-bindings: display: Add Synopsys DW MIPI DSI host controller") by Philippe CORNU <philippe.cornu@xxxxxx>.

Is the person who added the file automatically owner?

(cc'd Philippe)

+ - Mark Rutland <mark.rutland@xxxxxxx>

Check current maintainers. Mark is not one anymore.

Yes, I just noticed he got removed in my latest next-20200416 tree, thanks.

+
+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.
+

Need to reference ($ref) dsi-controller.yaml here.

+properties:
+ reg:
+ description: |
+ Memory mapped base address and length of the DesignWare MIPI DSI host
+ controller registers.

Drop the description. That's every 'reg'. You need to say how many
regions (maxItems: 1?).

+
+ clocks:
+ description: |
+ References to all the clocks specified in the clock-names property as
+ specified in Documentation/devicetree/bindings/clock/clock-bindings.txt

Drop

+ items:
+ - description: Module clock
+ - description: DSI bus colck for either AHB and APB

typo

+ - description: Pixel clock for the DPI/RGB input
+ minItems: 2
+ maxItems: 3

You can drop 'maxItems'. It's implied by the length of 'items'.
+
+ clock-names:
+ items:
+ - const: ref
+ - const: pclk
+ - const: px_clk
+ minItems: 2
+ maxItems: 3
+
+ resets:
+ description: |
+ References to all the resets specified in the reset-names property as
+ specified in Documentation/devicetree/bindings/reset/reset.txt

Drop.

You need maxItems to define how many reset entries.

+
+ reset-names:
+ const: apb
+
+patternProperties:
+ "^panel@[0-3]$":
+ type: object
+ description: |
+ A node containing the panel or bridge description as documented in

bridge? But the node name says panel only.

+ Documentation/devicetree/bindings/display/mipi-dsi-bus.txt

Drop description.

+
+required:
+ - reg
+ - clocks
+ - clock-names
--
2.26.0