[PATCH] dt-bindings: dma: fsl,imx-dma: Document the DMA clocks

[PATCH] dt-bindings: dma: fsl,imx-dma: Document the DMA clocks

[Fabio Estevam]

From: Fabio Estevam <festevam@denx.de>

Document the IPG and AHB clocks that are needed by the DMA hardware.

Signed-off-by: Fabio Estevam <festevam@denx.de>
---
 .../devicetree/bindings/dma/fsl,imx-dma.yaml         | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/Documentation/devicetree/bindings/dma/fsl,imx-dma.yaml b/Documentation/devicetree/bindings/dma/fsl,imx-dma.yaml
index 902a11f65be2..5cf80040565f 100644
--- a/Documentation/devicetree/bindings/dma/fsl,imx-dma.yaml
+++ b/Documentation/devicetree/bindings/dma/fsl,imx-dma.yaml
@@ -28,6 +28,14 @@ properties:
       - description: DMA Error interrupt
     minItems: 1
 
+  clocks:
+    maxItems: 2
+
+  clock-names:
+    items:
+      - const: ipg
+      - const: ahb
+
   "#dma-cells":
     const: 1
 
@@ -47,10 +55,14 @@ additionalProperties: false
 
 examples:
   - |
+    #include <dt-bindings/clock/imx27-clock.h>
+
     dma-controller@10001000 {
       compatible = "fsl,imx27-dma";
       reg = <0x10001000 0x1000>;
       interrupts = <32 33>;
       #dma-cells = <1>;
       dma-channels = <16>;
+      clocks = <&clks IMX27_CLK_DMA_IPG_GATE>, <&clks IMX27_CLK_DMA_AHB_GATE>;
+      clock-names = "ipg", "ahb";
     };
-- 
2.34.1

Re: [PATCH] dt-bindings: dma: fsl,imx-dma: Document the DMA clocks

[Conor Dooley]

[-- Attachment #1: Type: text/plain, Size: 1587 bytes --]

On Wed, Aug 07, 2024 at 01:46:54PM -0300, Fabio Estevam wrote:
> From: Fabio Estevam <festevam@denx.de>
> 
> Document the IPG and AHB clocks that are needed by the DMA hardware.

Sure it is an ABI break, but these clocks should be required if they are
"needed" by the hardware, no? Obviously the driver would need to
tolerate the absence.

> 
> Signed-off-by: Fabio Estevam <festevam@denx.de>
> ---
>  .../devicetree/bindings/dma/fsl,imx-dma.yaml         | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/dma/fsl,imx-dma.yaml b/Documentation/devicetree/bindings/dma/fsl,imx-dma.yaml
> index 902a11f65be2..5cf80040565f 100644
> --- a/Documentation/devicetree/bindings/dma/fsl,imx-dma.yaml
> +++ b/Documentation/devicetree/bindings/dma/fsl,imx-dma.yaml
> @@ -28,6 +28,14 @@ properties:
>        - description: DMA Error interrupt
>      minItems: 1
>  
> +  clocks:
> +    maxItems: 2
> +
> +  clock-names:
> +    items:
> +      - const: ipg
> +      - const: ahb
> +
>    "#dma-cells":
>      const: 1
>  
> @@ -47,10 +55,14 @@ additionalProperties: false
>  
>  examples:
>    - |
> +    #include <dt-bindings/clock/imx27-clock.h>
> +
>      dma-controller@10001000 {
>        compatible = "fsl,imx27-dma";
>        reg = <0x10001000 0x1000>;
>        interrupts = <32 33>;
>        #dma-cells = <1>;
>        dma-channels = <16>;
> +      clocks = <&clks IMX27_CLK_DMA_IPG_GATE>, <&clks IMX27_CLK_DMA_AHB_GATE>;
> +      clock-names = "ipg", "ahb";
>      };
> -- 
> 2.34.1
> 

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]