[PATCH v3 3/9] media: dt-bindings: cadence-csi2rx: Convert to DT schema

Jack Zhu posted 9 patches 2 years, 10 months ago
[PATCH v3 3/9] media: dt-bindings: cadence-csi2rx: Convert to DT schema
Posted by Jack Zhu 2 years, 10 months ago
Convert DT bindings document for Cadence MIPI-CSI2 RX controller
to DT schema format.

Signed-off-by: Jack Zhu <jack.zhu@starfivetech.com>
---
 .../devicetree/bindings/media/cdns,csi2rx.txt | 100 ----------
 .../bindings/media/cdns,csi2rx.yaml           | 174 ++++++++++++++++++
 MAINTAINERS                                   |   1 +
 3 files changed, 175 insertions(+), 100 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/media/cdns,csi2rx.txt
 create mode 100644 Documentation/devicetree/bindings/media/cdns,csi2rx.yaml

diff --git a/Documentation/devicetree/bindings/media/cdns,csi2rx.txt b/Documentation/devicetree/bindings/media/cdns,csi2rx.txt
deleted file mode 100644
index 6b02a0657ad9..000000000000
--- a/Documentation/devicetree/bindings/media/cdns,csi2rx.txt
+++ /dev/null
@@ -1,100 +0,0 @@
-Cadence MIPI-CSI2 RX controller
-===============================
-
-The Cadence MIPI-CSI2 RX controller is a CSI-2 bridge supporting up to 4 CSI
-lanes in input, and 4 different pixel streams in output.
-
-Required properties:
-  - compatible: must be set to "cdns,csi2rx" and an SoC-specific compatible
-  - reg: base address and size of the memory mapped region
-  - clocks: phandles to the clocks driving the controller
-  - clock-names: must contain:
-    * sys_clk: main clock
-    * p_clk: register bank clock
-    * pixel_if[0-3]_clk: pixel stream output clock, one for each stream
-                         implemented in hardware, between 0 and 3
-
-Optional properties:
-  - phys: phandle to the external D-PHY, phy-names must be provided
-  - phy-names: must contain "dphy", if the implementation uses an
-               external D-PHY
-
-Required subnodes:
-  - ports: A ports node with one port child node per device input and output
-           port, in accordance with the video interface bindings defined in
-           Documentation/devicetree/bindings/media/video-interfaces.txt. The
-           port nodes are numbered as follows:
-
-           Port Description
-           -----------------------------
-           0    CSI-2 input
-           1    Stream 0 output
-           2    Stream 1 output
-           3    Stream 2 output
-           4    Stream 3 output
-
-           The stream output port nodes are optional if they are not
-           connected to anything at the hardware level or implemented
-           in the design.Since there is only one endpoint per port,
-           the endpoints are not numbered.
-
-
-Example:
-
-csi2rx: csi-bridge@0d060000 {
-	compatible = "cdns,csi2rx";
-	reg = <0x0d060000 0x1000>;
-	clocks = <&byteclock>, <&byteclock>
-		 <&coreclock>, <&coreclock>,
-		 <&coreclock>, <&coreclock>;
-	clock-names = "sys_clk", "p_clk",
-		      "pixel_if0_clk", "pixel_if1_clk",
-		      "pixel_if2_clk", "pixel_if3_clk";
-
-	ports {
-		#address-cells = <1>;
-		#size-cells = <0>;
-
-		port@0 {
-			reg = <0>;
-
-			csi2rx_in_sensor: endpoint {
-				remote-endpoint = <&sensor_out_csi2rx>;
-				clock-lanes = <0>;
-				data-lanes = <1 2>;
-			};
-		};
-
-		port@1 {
-			reg = <1>;
-
-			csi2rx_out_grabber0: endpoint {
-				remote-endpoint = <&grabber0_in_csi2rx>;
-			};
-		};
-
-		port@2 {
-			reg = <2>;
-
-			csi2rx_out_grabber1: endpoint {
-				remote-endpoint = <&grabber1_in_csi2rx>;
-			};
-		};
-
-		port@3 {
-			reg = <3>;
-
-			csi2rx_out_grabber2: endpoint {
-				remote-endpoint = <&grabber2_in_csi2rx>;
-			};
-		};
-
-		port@4 {
-			reg = <4>;
-
-			csi2rx_out_grabber3: endpoint {
-				remote-endpoint = <&grabber3_in_csi2rx>;
-			};
-		};
-	};
-};
diff --git a/Documentation/devicetree/bindings/media/cdns,csi2rx.yaml b/Documentation/devicetree/bindings/media/cdns,csi2rx.yaml
new file mode 100644
index 000000000000..89f414eeef47
--- /dev/null
+++ b/Documentation/devicetree/bindings/media/cdns,csi2rx.yaml
@@ -0,0 +1,174 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/media/cdns,csi2rx.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Cadence MIPI-CSI2 RX controller
+
+maintainers:
+  - Maxime Ripard <mripard@kernel.org>
+
+description:
+  The Cadence MIPI-CSI2 RX controller is a CSI-2 bridge supporting up to 4 CSI
+  lanes in input, and 4 different pixel streams in output.
+
+properties:
+  compatible:
+    const: cdns,csi2rx
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    items:
+      - description: CSI2Rx system clock
+      - description: Gated Register bank clock for APB interface
+      - description: pixel Clock for Stream interface 0
+      - description: pixel Clock for Stream interface 1
+      - description: pixel Clock for Stream interface 2
+      - description: pixel Clock for Stream interface 3
+
+  clock-names:
+    items:
+      - const: sys_clk
+      - const: p_clk
+      - const: pixel_if0_clk
+      - const: pixel_if1_clk
+      - const: pixel_if2_clk
+      - const: pixel_if3_clk
+
+  phys:
+    maxItems: 1
+    description: MIPI D-PHY
+
+  phy-names:
+    items:
+      - const: dphy
+
+  ports:
+    $ref: /schemas/graph.yaml#/properties/ports
+
+    properties:
+      port@0:
+        $ref: /schemas/graph.yaml#/$defs/port-base
+        unevaluatedProperties: false
+        description:
+          Input port node, single endpoint describing the CSI-2 transmitter.
+
+        properties:
+          endpoint:
+            $ref: video-interfaces.yaml#
+            unevaluatedProperties: false
+
+            properties:
+              bus-type:
+                const: 4
+
+              clock-lanes:
+                const: 0
+
+              data-lanes:
+                minItems: 1
+                maxItems: 4
+                items:
+                  maximum: 4
+
+            required:
+              - data-lanes
+
+      port@1:
+        $ref: /schemas/graph.yaml#/properties/port
+        description:
+          Stream 0 Output port node
+
+      port@2:
+        $ref: /schemas/graph.yaml#/properties/port
+        description:
+          Stream 1 Output port node
+
+      port@3:
+        $ref: /schemas/graph.yaml#/properties/port
+        description:
+          Stream 2 Output port node
+
+      port@4:
+        $ref: /schemas/graph.yaml#/properties/port
+        description:
+          Stream 3 Output port node
+
+    required:
+      - port@0
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - clock-names
+  - ports
+
+additionalProperties: false
+
+examples:
+  - |
+    csi@d060000 {
+        compatible = "cdns,csi2rx";
+        reg = <0x0d060000 0x1000>;
+        clocks = <&byteclock 7>, <&byteclock 6>,
+                 <&coreclock 8>, <&coreclock 9>,
+                 <&coreclock 10>, <&coreclock 11>;
+        clock-names = "sys_clk", "p_clk",
+                      "pixel_if0_clk", "pixel_if1_clk",
+                      "pixel_if2_clk", "pixel_if3_clk";
+        phys = <&csi_phy>;
+        phy-names = "dphy";
+
+        ports {
+                #address-cells = <1>;
+                #size-cells = <0>;
+
+                port@0 {
+                    reg = <0>;
+
+                    csi2rx_in_sensor: endpoint {
+                        remote-endpoint = <&sensor_out_csi2rx>;
+                        clock-lanes = <0>;
+                        data-lanes = <1 2>;
+                    };
+                };
+
+                port@1 {
+                    reg = <1>;
+
+                    csi2rx_out_grabber0: endpoint {
+                        remote-endpoint = <&grabber0_in_csi2rx>;
+                    };
+                };
+
+                port@2 {
+                    reg = <2>;
+
+                    csi2rx_out_grabber1: endpoint {
+                        remote-endpoint = <&grabber1_in_csi2rx>;
+                    };
+                };
+
+                port@3 {
+                    reg = <3>;
+
+                    csi2rx_out_grabber2: endpoint {
+                        remote-endpoint = <&grabber2_in_csi2rx>;
+                    };
+                };
+
+                port@4 {
+                    reg = <4>;
+
+                    csi2rx_out_grabber3: endpoint {
+                        remote-endpoint = <&grabber3_in_csi2rx>;
+                    };
+                };
+        };
+    };
+
+...
diff --git a/MAINTAINERS b/MAINTAINERS
index 8c0a4d80d2bf..3f3ed2a51158 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -4495,6 +4495,7 @@ M:	Maxime Ripard <mripard@kernel.org>
 L:	linux-media@vger.kernel.org
 S:	Maintained
 F:	Documentation/devicetree/bindings/media/cdns,*.txt
+F:	Documentation/devicetree/bindings/media/cdns,csi2rx.yaml
 F:	drivers/media/platform/cadence/cdns-csi2*
 
 CADENCE NAND DRIVER
-- 
2.34.1
Re: [PATCH v3 3/9] media: dt-bindings: cadence-csi2rx: Convert to DT schema
Posted by Krzysztof Kozlowski 2 years, 10 months ago
On 31/03/2023 14:18, Jack Zhu wrote:
> Convert DT bindings document for Cadence MIPI-CSI2 RX controller
> to DT schema format.
> 
> Signed-off-by: Jack Zhu <jack.zhu@starfivetech.com>
> ---
>  .../devicetree/bindings/media/cdns,csi2rx.txt | 100 ----------
>  .../bindings/media/cdns,csi2rx.yaml           | 174 ++++++++++++++++++
>  MAINTAINERS                                   |   1 +
>  3 files changed, 175 insertions(+), 100 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/media/cdns,csi2rx.txt
>  create mode 100644 Documentation/devicetree/bindings/media/cdns,csi2rx.yaml
> 
> diff --git a/Documentation/devicetree/bindings/media/cdns,csi2rx.txt b/Documentation/devicetree/bindings/media/cdns,csi2rx.txt
> deleted file mode 100644
> index 6b02a0657ad9..000000000000
> --- a/Documentation/devicetree/bindings/media/cdns,csi2rx.txt
> +++ /dev/null
> @@ -1,100 +0,0 @@
> -Cadence MIPI-CSI2 RX controller
> -===============================
> -
> -The Cadence MIPI-CSI2 RX controller is a CSI-2 bridge supporting up to 4 CSI
> -lanes in input, and 4 different pixel streams in output.
> -
> -Required properties:
> -  - compatible: must be set to "cdns,csi2rx" and an SoC-specific compatible


...

> +$id: http://devicetree.org/schemas/media/cdns,csi2rx.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Cadence MIPI-CSI2 RX controller
> +
> +maintainers:
> +  - Maxime Ripard <mripard@kernel.org>
> +
> +description:
> +  The Cadence MIPI-CSI2 RX controller is a CSI-2 bridge supporting up to 4 CSI
> +  lanes in input, and 4 different pixel streams in output.
> +
> +properties:
> +  compatible:
> +    const: cdns,csi2rx

That's not equivalent conversion and your commit msg does no mention any
drops in compatibles.

> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    items:
> +      - description: CSI2Rx system clock
> +      - description: Gated Register bank clock for APB interface
> +      - description: pixel Clock for Stream interface 0
> +      - description: pixel Clock for Stream interface 1
> +      - description: pixel Clock for Stream interface 2
> +      - description: pixel Clock for Stream interface 3
> +

Best regards,
Krzysztof

Re: [PATCH v3 3/9] media: dt-bindings: cadence-csi2rx: Convert to DT schema
Posted by Jack Zhu 2 years, 10 months ago

On 2023/4/1 4:12, Krzysztof Kozlowski wrote:
> On 31/03/2023 14:18, Jack Zhu wrote:
>> Convert DT bindings document for Cadence MIPI-CSI2 RX controller
>> to DT schema format.
>> 
>> Signed-off-by: Jack Zhu <jack.zhu@starfivetech.com>
>> ---
>>  .../devicetree/bindings/media/cdns,csi2rx.txt | 100 ----------
>>  .../bindings/media/cdns,csi2rx.yaml           | 174 ++++++++++++++++++
>>  MAINTAINERS                                   |   1 +
>>  3 files changed, 175 insertions(+), 100 deletions(-)
>>  delete mode 100644 Documentation/devicetree/bindings/media/cdns,csi2rx.txt
>>  create mode 100644 Documentation/devicetree/bindings/media/cdns,csi2rx.yaml
>> 
>> diff --git a/Documentation/devicetree/bindings/media/cdns,csi2rx.txt b/Documentation/devicetree/bindings/media/cdns,csi2rx.txt
>> deleted file mode 100644
>> index 6b02a0657ad9..000000000000
>> --- a/Documentation/devicetree/bindings/media/cdns,csi2rx.txt
>> +++ /dev/null
>> @@ -1,100 +0,0 @@
>> -Cadence MIPI-CSI2 RX controller
>> -===============================
>> -
>> -The Cadence MIPI-CSI2 RX controller is a CSI-2 bridge supporting up to 4 CSI
>> -lanes in input, and 4 different pixel streams in output.
>> -
>> -Required properties:
>> -  - compatible: must be set to "cdns,csi2rx" and an SoC-specific compatible
> 
> 
> ...
> 
>> +$id: http://devicetree.org/schemas/media/cdns,csi2rx.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Cadence MIPI-CSI2 RX controller
>> +
>> +maintainers:
>> +  - Maxime Ripard <mripard@kernel.org>
>> +
>> +description:
>> +  The Cadence MIPI-CSI2 RX controller is a CSI-2 bridge supporting up to 4 CSI
>> +  lanes in input, and 4 different pixel streams in output.
>> +
>> +properties:
>> +  compatible:
>> +    const: cdns,csi2rx
> 
> That's not equivalent conversion and your commit msg does no mention any
> drops in compatibles.
> 
The equivalent conversion refers to 'an SoC-specific compatible'?
I'm not sure that, is it enough to add a description (drop an 'SoC-specific compatible')
to my next version commit message?

>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  clocks:
>> +    items:
>> +      - description: CSI2Rx system clock
>> +      - description: Gated Register bank clock for APB interface
>> +      - description: pixel Clock for Stream interface 0
>> +      - description: pixel Clock for Stream interface 1
>> +      - description: pixel Clock for Stream interface 2
>> +      - description: pixel Clock for Stream interface 3
>> +
> 
> Best regards,
> Krzysztof
> 
Re: [PATCH v3 3/9] media: dt-bindings: cadence-csi2rx: Convert to DT schema
Posted by Krzysztof Kozlowski 2 years, 10 months ago
On 03/04/2023 11:48, Jack Zhu wrote:
> 
> 
> On 2023/4/1 4:12, Krzysztof Kozlowski wrote:
>> On 31/03/2023 14:18, Jack Zhu wrote:
>>> Convert DT bindings document for Cadence MIPI-CSI2 RX controller
>>> to DT schema format.
>>>
>>> Signed-off-by: Jack Zhu <jack.zhu@starfivetech.com>
>>> ---
>>>  .../devicetree/bindings/media/cdns,csi2rx.txt | 100 ----------
>>>  .../bindings/media/cdns,csi2rx.yaml           | 174 ++++++++++++++++++
>>>  MAINTAINERS                                   |   1 +
>>>  3 files changed, 175 insertions(+), 100 deletions(-)
>>>  delete mode 100644 Documentation/devicetree/bindings/media/cdns,csi2rx.txt
>>>  create mode 100644 Documentation/devicetree/bindings/media/cdns,csi2rx.yaml
>>>
>>> diff --git a/Documentation/devicetree/bindings/media/cdns,csi2rx.txt b/Documentation/devicetree/bindings/media/cdns,csi2rx.txt
>>> deleted file mode 100644
>>> index 6b02a0657ad9..000000000000
>>> --- a/Documentation/devicetree/bindings/media/cdns,csi2rx.txt
>>> +++ /dev/null
>>> @@ -1,100 +0,0 @@
>>> -Cadence MIPI-CSI2 RX controller
>>> -===============================
>>> -
>>> -The Cadence MIPI-CSI2 RX controller is a CSI-2 bridge supporting up to 4 CSI
>>> -lanes in input, and 4 different pixel streams in output.
>>> -
>>> -Required properties:
>>> -  - compatible: must be set to "cdns,csi2rx" and an SoC-specific compatible
>>
>>
>> ...
>>
>>> +$id: http://devicetree.org/schemas/media/cdns,csi2rx.yaml#
>>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>>> +
>>> +title: Cadence MIPI-CSI2 RX controller
>>> +
>>> +maintainers:
>>> +  - Maxime Ripard <mripard@kernel.org>
>>> +
>>> +description:
>>> +  The Cadence MIPI-CSI2 RX controller is a CSI-2 bridge supporting up to 4 CSI
>>> +  lanes in input, and 4 different pixel streams in output.
>>> +
>>> +properties:
>>> +  compatible:
>>> +    const: cdns,csi2rx
>>
>> That's not equivalent conversion and your commit msg does no mention any
>> drops in compatibles.
>>
> The equivalent conversion refers to 'an SoC-specific compatible'?

Yes.

> I'm not sure that, is it enough to add a description (drop an 'SoC-specific compatible')
> to my next version commit message?

Original binding did not allow csi2rx compatible alone. Your binding
here allows it, thus it is not simple conversion.

I think patch 5 should be squashed here - with proper explanation.
Usually new compatibles should not be messed with conversion, but this
conversion on its own does not make much sense.



Best regards,
Krzysztof

Re: [PATCH v3 3/9] media: dt-bindings: cadence-csi2rx: Convert to DT schema
Posted by Jack Zhu 2 years, 10 months ago

On 2023/4/3 17:53, Krzysztof Kozlowski wrote:
> On 03/04/2023 11:48, Jack Zhu wrote:
>> 
>> 
>> On 2023/4/1 4:12, Krzysztof Kozlowski wrote:
>>> On 31/03/2023 14:18, Jack Zhu wrote:
>>>> Convert DT bindings document for Cadence MIPI-CSI2 RX controller
>>>> to DT schema format.
>>>>
>>>> Signed-off-by: Jack Zhu <jack.zhu@starfivetech.com>
>>>> ---
>>>>  .../devicetree/bindings/media/cdns,csi2rx.txt | 100 ----------
>>>>  .../bindings/media/cdns,csi2rx.yaml           | 174 ++++++++++++++++++
>>>>  MAINTAINERS                                   |   1 +
>>>>  3 files changed, 175 insertions(+), 100 deletions(-)
>>>>  delete mode 100644 Documentation/devicetree/bindings/media/cdns,csi2rx.txt
>>>>  create mode 100644 Documentation/devicetree/bindings/media/cdns,csi2rx.yaml
>>>>
>>>> diff --git a/Documentation/devicetree/bindings/media/cdns,csi2rx.txt b/Documentation/devicetree/bindings/media/cdns,csi2rx.txt
>>>> deleted file mode 100644
>>>> index 6b02a0657ad9..000000000000
>>>> --- a/Documentation/devicetree/bindings/media/cdns,csi2rx.txt
>>>> +++ /dev/null
>>>> @@ -1,100 +0,0 @@
>>>> -Cadence MIPI-CSI2 RX controller
>>>> -===============================
>>>> -
>>>> -The Cadence MIPI-CSI2 RX controller is a CSI-2 bridge supporting up to 4 CSI
>>>> -lanes in input, and 4 different pixel streams in output.
>>>> -
>>>> -Required properties:
>>>> -  - compatible: must be set to "cdns,csi2rx" and an SoC-specific compatible
>>>
>>>
>>> ...
>>>
>>>> +$id: http://devicetree.org/schemas/media/cdns,csi2rx.yaml#
>>>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>>>> +
>>>> +title: Cadence MIPI-CSI2 RX controller
>>>> +
>>>> +maintainers:
>>>> +  - Maxime Ripard <mripard@kernel.org>
>>>> +
>>>> +description:
>>>> +  The Cadence MIPI-CSI2 RX controller is a CSI-2 bridge supporting up to 4 CSI
>>>> +  lanes in input, and 4 different pixel streams in output.
>>>> +
>>>> +properties:
>>>> +  compatible:
>>>> +    const: cdns,csi2rx
>>>
>>> That's not equivalent conversion and your commit msg does no mention any
>>> drops in compatibles.
>>>
>> The equivalent conversion refers to 'an SoC-specific compatible'?
> 
> Yes.
> 
>> I'm not sure that, is it enough to add a description (drop an 'SoC-specific compatible')
>> to my next version commit message?
> 
> Original binding did not allow csi2rx compatible alone. Your binding
> here allows it, thus it is not simple conversion.
> 
> I think patch 5 should be squashed here - with proper explanation.
> Usually new compatibles should not be messed with conversion, but this
> conversion on its own does not make much sense.
> 
Ok, I will merge patch 5 into the patch, and add explanation in my
commit msg.
> 
> 
> Best regards,
> Krzysztof
>