diff mbox series

[v2,61/77] dt-bindings: media: nxp,imx7-mipi-csi2: Expand descriptions

Message ID 20210215042741.28850-62-laurent.pinchart@ideasonboard.com (mailing list archive)
State New
Headers show
Series media: imx: Miscellaneous fixes and cleanups for i.MX7 | expand

Commit Message

Laurent Pinchart Feb. 15, 2021, 4:27 a.m. UTC
Expand the description of the binding itself and of individual
properties to include additional information that may not be immediately
appartent from reading the reference manual. Drop the last sentence of
the phy-supply description that refers to the driver's implementation.

While at it, fix the capitalization of MIPI CSI-2 in the title.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 .../bindings/media/nxp,imx7-mipi-csi2.yaml    | 29 +++++++++++--------
 1 file changed, 17 insertions(+), 12 deletions(-)

Comments

Rui Miguel Silva March 1, 2021, 9:35 a.m. UTC | #1
Hi Laurent,
On Mon, Feb 15, 2021 at 06:27:25AM +0200, Laurent Pinchart wrote:
> Expand the description of the binding itself and of individual
> properties to include additional information that may not be immediately
> appartent from reading the reference manual. Drop the last sentence of
> the phy-supply description that refers to the driver's implementation.
> 
> While at it, fix the capitalization of MIPI CSI-2 in the title.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

For the descriptions changes, LGTM.

Reviewed-by: Rui Miguel Silva <rmfrfs@gmail.com>

------
Cheers,
     Rui
> ---
>  .../bindings/media/nxp,imx7-mipi-csi2.yaml    | 29 +++++++++++--------
>  1 file changed, 17 insertions(+), 12 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/media/nxp,imx7-mipi-csi2.yaml b/Documentation/devicetree/bindings/media/nxp,imx7-mipi-csi2.yaml
> index 76fcc8d80ee3..471a5bf7eb76 100644
> --- a/Documentation/devicetree/bindings/media/nxp,imx7-mipi-csi2.yaml
> +++ b/Documentation/devicetree/bindings/media/nxp,imx7-mipi-csi2.yaml
> @@ -4,14 +4,19 @@
>  $id: http://devicetree.org/schemas/media/nxp,imx7-mipi-csi2.yaml#
>  $schema: http://devicetree.org/meta-schemas/core.yaml#
>  
> -title: NXP i.MX7 Mipi CSI2
> +title: NXP i.MX7 MIPI CSI-2 receiver
>  
>  maintainers:
>    - Rui Miguel Silva <rmfrfs@gmail.com>
>  
> -description: |
> -  This is the device node for the MIPI CSI-2 receiver core in i.MX7 soc. It is
> -  compatible with previous version of samsung d-phy.
> +description: |-
> +  The NXP i.MX7 SoC family includes a MIPI CSI-2 receiver IP core, documented
> +  as "CSIS V3.3". The IP core seems to originate from Samsung, and may be
> +  compatible with some of the Exynos4 ad S5P SoCs.
> +
> +  While the CSI-2 receiver is separate from the MIPI D-PHY IP core, the PHY is
> +  completely wrapped by the CSIS and doesn't expose a control interface of its
> +  own. This binding thus covers both IP cores.
>  
>  properties:
>    compatible:
> @@ -24,8 +29,10 @@ properties:
>      maxItems: 1
>  
>    clocks:
> -    minItems: 3
> -    maxItems: 3
> +    items:
> +      - description: The peripheral clock (a.k.a. APB clock)
> +      - description: The external clock (optionally used as the pixel clock)
> +      - description: The MIPI D-PHY clock
>  
>    clock-names:
>      items:
> @@ -37,16 +44,14 @@ properties:
>      maxItems: 1
>  
>    phy-supply:
> -    description:
> -      Phandle to a regulator that provides power to the PHY. This
> -      regulator will be managed during the PHY power on/off sequence.
> +    description: The MIPI D-PHY digital power supply
>  
>    resets:
> -    maxItems: 1
> +    items:
> +      - description: MIPI D-PHY slave reset
>  
>    clock-frequency:
> -    description:
> -      The IP main (system bus) clock frequency in Hertz
> +    description: The desired external clock ("wrap") frequency, in Hz
>      default: 166000000
>  
>    ports:
> -- 
> Regards,
> 
> Laurent Pinchart
>
Rob Herring March 5, 2021, 9:43 p.m. UTC | #2
On Mon, 15 Feb 2021 06:27:25 +0200, Laurent Pinchart wrote:
> Expand the description of the binding itself and of individual
> properties to include additional information that may not be immediately
> appartent from reading the reference manual. Drop the last sentence of
> the phy-supply description that refers to the driver's implementation.
> 
> While at it, fix the capitalization of MIPI CSI-2 in the title.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
>  .../bindings/media/nxp,imx7-mipi-csi2.yaml    | 29 +++++++++++--------
>  1 file changed, 17 insertions(+), 12 deletions(-)
> 

Reviewed-by: Rob Herring <robh@kernel.org>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/media/nxp,imx7-mipi-csi2.yaml b/Documentation/devicetree/bindings/media/nxp,imx7-mipi-csi2.yaml
index 76fcc8d80ee3..471a5bf7eb76 100644
--- a/Documentation/devicetree/bindings/media/nxp,imx7-mipi-csi2.yaml
+++ b/Documentation/devicetree/bindings/media/nxp,imx7-mipi-csi2.yaml
@@ -4,14 +4,19 @@ 
 $id: http://devicetree.org/schemas/media/nxp,imx7-mipi-csi2.yaml#
 $schema: http://devicetree.org/meta-schemas/core.yaml#
 
-title: NXP i.MX7 Mipi CSI2
+title: NXP i.MX7 MIPI CSI-2 receiver
 
 maintainers:
   - Rui Miguel Silva <rmfrfs@gmail.com>
 
-description: |
-  This is the device node for the MIPI CSI-2 receiver core in i.MX7 soc. It is
-  compatible with previous version of samsung d-phy.
+description: |-
+  The NXP i.MX7 SoC family includes a MIPI CSI-2 receiver IP core, documented
+  as "CSIS V3.3". The IP core seems to originate from Samsung, and may be
+  compatible with some of the Exynos4 ad S5P SoCs.
+
+  While the CSI-2 receiver is separate from the MIPI D-PHY IP core, the PHY is
+  completely wrapped by the CSIS and doesn't expose a control interface of its
+  own. This binding thus covers both IP cores.
 
 properties:
   compatible:
@@ -24,8 +29,10 @@  properties:
     maxItems: 1
 
   clocks:
-    minItems: 3
-    maxItems: 3
+    items:
+      - description: The peripheral clock (a.k.a. APB clock)
+      - description: The external clock (optionally used as the pixel clock)
+      - description: The MIPI D-PHY clock
 
   clock-names:
     items:
@@ -37,16 +44,14 @@  properties:
     maxItems: 1
 
   phy-supply:
-    description:
-      Phandle to a regulator that provides power to the PHY. This
-      regulator will be managed during the PHY power on/off sequence.
+    description: The MIPI D-PHY digital power supply
 
   resets:
-    maxItems: 1
+    items:
+      - description: MIPI D-PHY slave reset
 
   clock-frequency:
-    description:
-      The IP main (system bus) clock frequency in Hertz
+    description: The desired external clock ("wrap") frequency, in Hz
     default: 166000000
 
   ports: