diff mbox series

[1/9] dt-bindings: media: Add amlogic,c3-mipi-csi2.yaml

Message ID 20240903-c3isp-v1-1-8af0edcc13c8@amlogic.com (mailing list archive)
State New
Headers show
Series Amlogic C3 ISP support | expand

Commit Message

Keke Li via B4 Relay Sept. 3, 2024, 6:57 a.m. UTC 
From: Keke Li <keke.li@amlogic.com>

c3-mipi-csi2 is used to receive mipi data
from image sensor.

Signed-off-by: Keke Li <keke.li@amlogic.com>
---
 .../bindings/media/amlogic,c3-mipi-csi2.yaml       | 130 +++++++++++++++++++++
 1 file changed, 130 insertions(+)

Comments

Krzysztof Kozlowski Sept. 3, 2024, 2:08 p.m. UTC | #1 
On 03/09/2024 08:57, Keke Li via B4 Relay wrote:
> From: Keke Li <keke.li@amlogic.com>
> 
> c3-mipi-csi2 is used to receive mipi data
> from image sensor.

Please wrap commit message according to Linux coding style / submission
process (neither too early nor over the limit):
https://elixir.bootlin.com/linux/v6.4-rc1/source/Documentation/process/submitting-patches.rst#L597

> 
> Signed-off-by: Keke Li <keke.li@amlogic.com>
> ---
>  .../bindings/media/amlogic,c3-mipi-csi2.yaml       | 130 +++++++++++++++++++++
>  1 file changed, 130 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/media/amlogic,c3-mipi-csi2.yaml b/Documentation/devicetree/bindings/media/amlogic,c3-mipi-csi2.yaml
> new file mode 100644
> index 000000000000..85d3088d6f9f
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/media/amlogic,c3-mipi-csi2.yaml
> @@ -0,0 +1,130 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/media/amlogic,c3-mipi-csi2.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Amlogic C3 MIPI CSI-2 receiver
> +
> +maintainers:
> +  - Keke Li <keke.li@amlogic.com>
> +
> +description: |-

Do not need '|-' unless you need to preserve formatting.


> +  MIPI CSI-2 receiver contains CSI-2 RX PHY and host controller.
> +  It receives the MIPI data from the image sensor and sends MIPI data
> +  to MIPI adapter.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - amlogic,c3-mipi-csi2
> +
> +  reg:
> +    minItems: 3

Drop minItems

> +    maxItems: 3
> +
> +  reg-names:
> +    items:
> +      - const: csi_aphy
> +      - const: csi_dphy
> +      - const: csi_host

Drop csi_ everywhere

> +
> +  power-domains:
> +    maxItems: 1
> +
> +  clocks:
> +    minItems: 2

Your code is random... Look how this is different than other list - reg.
Instead maxItems.

> +
> +  clock-names:
> +    items:
> +      - const: vapb
> +      - const: csi_phy0
> +
> +  ports:
> +    $ref: /schemas/graph.yaml#/properties/ports
> +
> +    properties:
> +      port@0:
> +        $ref: /schemas/graph.yaml#/$defs/port-base
> +        unevaluatedProperties: false
> +        description: input port node, connected to sensor.
> +
> +        properties:
> +          endpoint:
> +            $ref: video-interfaces.yaml#
> +            unevaluatedProperties: false
> +
> +            properties:
> +              data-lanes:
> +                minItems: 1
> +                maxItems: 4
> +
> +            required:
> +              - data-lanes
> +
> +      port@1:
> +        $ref: /schemas/graph.yaml#/properties/port
> +        description: output port node
> +
> +    required:
> +      - port@0
> +      - port@1
> +
> +required:
> +  - compatible
> +  - reg
> +  - reg-names
> +  - power-domains
> +  - clocks
> +  - clock-names
> +  - ports
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/clock/amlogic,c3-peripherals-clkc.h>
> +    #include <dt-bindings/power/amlogic,c3-pwrc.h>
> +
> +    soc {
> +        #address-cells = <2>;
> +        #size-cells = <2>;
> +
> +        csi: csi@ff018000 {
> +            compatible = "amlogic,c3-mipi-csi2";
> +

Drop blank line

> +            reg = <0x0 0xff018000 0x0 0x400>,
> +                  <0x0 0xff019000 0x0 0x300>,
> +                  <0x0 0xff01a000 0x0 0x100>;
> +

Drop blank line


> +            reg-names = "csi_aphy", "csi_dphy", "csi_host";
> +
> +            power-domains = <&pwrc PWRC_C3_MIPI_ISP_WRAP_ID>;
> +
> +            clocks =  <&clkc_periphs CLKID_VAPB>,
> +                      <&clkc_periphs CLKID_CSI_PHY0>;
> +

Drop blank line. That's poorly readable code.



Best regards,
Krzysztof
Keke Li Sept. 4, 2024, 8:15 a.m. UTC | #2 
On 2024/9/3 22:08, Krzysztof Kozlowski wrote:
> [You don't often get email from krzk@kernel.org. Learn why this is important at https://aka.ms/LearnAboutSenderIdentification ]
>
> [ EXTERNAL EMAIL ]
>
> On 03/09/2024 08:57, Keke Li via B4 Relay wrote:
>> From: Keke Li <keke.li@amlogic.com>
>>
>> c3-mipi-csi2 is used to receive mipi data
>> from image sensor.
> Please wrap commit message according to Linux coding style / submission
> process (neither too early nor over the limit):
> https://elixir.bootlin.com/linux/v6.4-rc1/source/Documentation/process/submitting-patches.rst#L597
Will modify this issue.
>> Signed-off-by: Keke Li <keke.li@amlogic.com>
>> ---
>>   .../bindings/media/amlogic,c3-mipi-csi2.yaml       | 130 +++++++++++++++++++++
>>   1 file changed, 130 insertions(+)
>>
>> diff --git a/Documentation/devicetree/bindings/media/amlogic,c3-mipi-csi2.yaml b/Documentation/devicetree/bindings/media/amlogic,c3-mipi-csi2.yaml
>> new file mode 100644
>> index 000000000000..85d3088d6f9f
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/media/amlogic,c3-mipi-csi2.yaml
>> @@ -0,0 +1,130 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/media/amlogic,c3-mipi-csi2.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Amlogic C3 MIPI CSI-2 receiver
>> +
>> +maintainers:
>> +  - Keke Li <keke.li@amlogic.com>
>> +
>> +description: |-
> Do not need '|-' unless you need to preserve formatting.
Will delete '| -'
>
>> +  MIPI CSI-2 receiver contains CSI-2 RX PHY and host controller.
>> +  It receives the MIPI data from the image sensor and sends MIPI data
>> +  to MIPI adapter.
>> +
>> +properties:
>> +  compatible:
>> +    enum:
>> +      - amlogic,c3-mipi-csi2
>> +
>> +  reg:
>> +    minItems: 3
> Drop minItems
Will drop minItems
>
>> +    maxItems: 3
>> +
>> +  reg-names:
>> +    items:
>> +      - const: csi_aphy
>> +      - const: csi_dphy
>> +      - const: csi_host
> Drop csi_ everywhere
Will drop csi_ every where
>> +
>> +  power-domains:
>> +    maxItems: 1
>> +
>> +  clocks:
>> +    minItems: 2
> Your code is random... Look how this is different than other list - reg.
> Instead maxItems.
Will modify minItems to maxItems
>> +
>> +  clock-names:
>> +    items:
>> +      - const: vapb
>> +      - const: csi_phy0
>> +
>> +  ports:
>> +    $ref: /schemas/graph.yaml#/properties/ports
>> +
>> +    properties:
>> +      port@0:
>> +        $ref: /schemas/graph.yaml#/$defs/port-base
>> +        unevaluatedProperties: false
>> +        description: input port node, connected to sensor.
>> +
>> +        properties:
>> +          endpoint:
>> +            $ref: video-interfaces.yaml#
>> +            unevaluatedProperties: false
>> +
>> +            properties:
>> +              data-lanes:
>> +                minItems: 1
>> +                maxItems: 4
>> +
>> +            required:
>> +              - data-lanes
>> +
>> +      port@1:
>> +        $ref: /schemas/graph.yaml#/properties/port
>> +        description: output port node
>> +
>> +    required:
>> +      - port@0
>> +      - port@1
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - reg-names
>> +  - power-domains
>> +  - clocks
>> +  - clock-names
>> +  - ports
>> +
>> +additionalProperties: false
>> +
>> +examples:
>> +  - |
>> +    #include <dt-bindings/clock/amlogic,c3-peripherals-clkc.h>
>> +    #include <dt-bindings/power/amlogic,c3-pwrc.h>
>> +
>> +    soc {
>> +        #address-cells = <2>;
>> +        #size-cells = <2>;
>> +
>> +        csi: csi@ff018000 {
>> +            compatible = "amlogic,c3-mipi-csi2";
>> +
> Drop blank line
Will drop blank line.
>> +            reg = <0x0 0xff018000 0x0 0x400>,
>> +                  <0x0 0xff019000 0x0 0x300>,
>> +                  <0x0 0xff01a000 0x0 0x100>;
>> +
> Drop blank line
Will drop blank line.
>
>
>> +            reg-names = "csi_aphy", "csi_dphy", "csi_host";
>> +
>> +            power-domains = <&pwrc PWRC_C3_MIPI_ISP_WRAP_ID>;
>> +
>> +            clocks =  <&clkc_periphs CLKID_VAPB>,
>> +                      <&clkc_periphs CLKID_CSI_PHY0>;
>> +
> Drop blank line. That's poorly readable code.
Will drop blank line.  Thanks again.
>
>
> Best regards,
> Krzysztof
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/media/amlogic,c3-mipi-csi2.yaml b/Documentation/devicetree/bindings/media/amlogic,c3-mipi-csi2.yaml
new file mode 100644
index 000000000000..85d3088d6f9f
--- /dev/null
+++ b/Documentation/devicetree/bindings/media/amlogic,c3-mipi-csi2.yaml
@@ -0,0 +1,130 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/media/amlogic,c3-mipi-csi2.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Amlogic C3 MIPI CSI-2 receiver
+
+maintainers:
+  - Keke Li <keke.li@amlogic.com>
+
+description: |-
+  MIPI CSI-2 receiver contains CSI-2 RX PHY and host controller.
+  It receives the MIPI data from the image sensor and sends MIPI data
+  to MIPI adapter.
+
+properties:
+  compatible:
+    enum:
+      - amlogic,c3-mipi-csi2
+
+  reg:
+    minItems: 3
+    maxItems: 3
+
+  reg-names:
+    items:
+      - const: csi_aphy
+      - const: csi_dphy
+      - const: csi_host
+
+  power-domains:
+    maxItems: 1
+
+  clocks:
+    minItems: 2
+
+  clock-names:
+    items:
+      - const: vapb
+      - const: csi_phy0
+
+  ports:
+    $ref: /schemas/graph.yaml#/properties/ports
+
+    properties:
+      port@0:
+        $ref: /schemas/graph.yaml#/$defs/port-base
+        unevaluatedProperties: false
+        description: input port node, connected to sensor.
+
+        properties:
+          endpoint:
+            $ref: video-interfaces.yaml#
+            unevaluatedProperties: false
+
+            properties:
+              data-lanes:
+                minItems: 1
+                maxItems: 4
+
+            required:
+              - data-lanes
+
+      port@1:
+        $ref: /schemas/graph.yaml#/properties/port
+        description: output port node
+
+    required:
+      - port@0
+      - port@1
+
+required:
+  - compatible
+  - reg
+  - reg-names
+  - power-domains
+  - clocks
+  - clock-names
+  - ports
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/amlogic,c3-peripherals-clkc.h>
+    #include <dt-bindings/power/amlogic,c3-pwrc.h>
+
+    soc {
+        #address-cells = <2>;
+        #size-cells = <2>;
+
+        csi: csi@ff018000 {
+            compatible = "amlogic,c3-mipi-csi2";
+
+            reg = <0x0 0xff018000 0x0 0x400>,
+                  <0x0 0xff019000 0x0 0x300>,
+                  <0x0 0xff01a000 0x0 0x100>;
+
+            reg-names = "csi_aphy", "csi_dphy", "csi_host";
+
+            power-domains = <&pwrc PWRC_C3_MIPI_ISP_WRAP_ID>;
+
+            clocks =  <&clkc_periphs CLKID_VAPB>,
+                      <&clkc_periphs CLKID_CSI_PHY0>;
+
+            clock-names = "vapb", "csi_phy0";
+
+            ports {
+                #address-cells = <1>;
+                #size-cells = <0>;
+
+                port@0 {
+                    reg = <0>;
+                    c3_mipi_csi_in: endpoint {
+                        remote-endpoint = <&imx290_out>;
+                        data-lanes = <1 2 3 4>;
+                    };
+                };
+
+                port@1 {
+                    reg = <1>;
+                    c3_mipi_csi_out: endpoint {
+                        remote-endpoint = <&c3_adap_in>;
+                    };
+                };
+            };
+        };
+    };
+...