[PATCH] dt-bindings: dma: Drop undocumented examples

[PATCH] dt-bindings: dma: Drop undocumented examples

[Rob Herring]

The compatibles "ti,omap-sdma" and "ti,dra7-dma-crossbar" aren't documented
by a schema which causes warnings:

Documentation/devicetree/bindings/dma/dma-controller.example.dtb: /example-0/dma-controller@48000000: failed to match any schema with compatible: ['ti,omap-sdma']
Documentation/devicetree/bindings/dma/dma-router.example.dtb: /example-0/dma-router@4a002b78: failed to match any schema with compatible: ['ti,dra7-dma-crossbar']

As no one has cared to fix them, just drop them.

Signed-off-by: Rob Herring <robh@kernel.org>
---
 .../devicetree/bindings/dma/dma-controller.yaml   | 15 ---------------
 .../devicetree/bindings/dma/dma-router.yaml       | 11 -----------
 2 files changed, 26 deletions(-)

diff --git a/Documentation/devicetree/bindings/dma/dma-controller.yaml b/Documentation/devicetree/bindings/dma/dma-controller.yaml
index 04d150d4d15d..e6afca558c2d 100644
--- a/Documentation/devicetree/bindings/dma/dma-controller.yaml
+++ b/Documentation/devicetree/bindings/dma/dma-controller.yaml
@@ -19,19 +19,4 @@ properties:
 
 additionalProperties: true
 
-examples:
-  - |
-    dma: dma-controller@48000000 {
-        compatible = "ti,omap-sdma";
-        reg = <0x48000000 0x1000>;
-        interrupts = <0 12 0x4>,
-                     <0 13 0x4>,
-                     <0 14 0x4>,
-                     <0 15 0x4>;
-        #dma-cells = <1>;
-        dma-channels = <32>;
-        dma-requests = <127>;
-        dma-channel-mask = <0xfffe>;
-    };
-
 ...
diff --git a/Documentation/devicetree/bindings/dma/dma-router.yaml b/Documentation/devicetree/bindings/dma/dma-router.yaml
index 346fe0fa4460..5ad2febc581e 100644
--- a/Documentation/devicetree/bindings/dma/dma-router.yaml
+++ b/Documentation/devicetree/bindings/dma/dma-router.yaml
@@ -40,15 +40,4 @@ required:
 
 additionalProperties: true
 
-examples:
-  - |
-    sdma_xbar: dma-router@4a002b78 {
-        compatible = "ti,dra7-dma-crossbar";
-        reg = <0x4a002b78 0xfc>;
-        #dma-cells = <1>;
-        dma-requests = <205>;
-        ti,dma-safe-map = <0>;
-        dma-masters = <&sdma>;
-    };
-
 ...
-- 
2.42.0

Re: [PATCH] dt-bindings: dma: Drop undocumented examples

[Krzysztof Kozlowski]

On 23/11/2023 00:50, Rob Herring wrote:
> The compatibles "ti,omap-sdma" and "ti,dra7-dma-crossbar" aren't documented
> by a schema which causes warnings:
> 
> Documentation/devicetree/bindings/dma/dma-controller.example.dtb: /example-0/dma-controller@48000000: failed to match any schema with compatible: ['ti,omap-sdma']
> Documentation/devicetree/bindings/dma/dma-router.example.dtb: /example-0/dma-router@4a002b78: failed to match any schema with compatible: ['ti,dra7-dma-crossbar']
> 
> As no one has cared to fix them, just drop them.
> 
> Signed-off-by: Rob Herring <robh@kernel.org>
> ---


Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

Best regards,
Krzysztof

Re: [PATCH] dt-bindings: dma: Drop undocumented examples

[Vinod Koul]

On 22-11-23, 16:50, Rob Herring wrote:
> The compatibles "ti,omap-sdma" and "ti,dra7-dma-crossbar" aren't documented
> by a schema which causes warnings:
> 
> Documentation/devicetree/bindings/dma/dma-controller.example.dtb: /example-0/dma-controller@48000000: failed to match any schema with compatible: ['ti,omap-sdma']
> Documentation/devicetree/bindings/dma/dma-router.example.dtb: /example-0/dma-router@4a002b78: failed to match any schema with compatible: ['ti,dra7-dma-crossbar']

So instead now we will have undocumented ti-omap-sdma?

Adding Peter and TI folks as well

> As no one has cared to fix them, just drop them.
> 
> Signed-off-by: Rob Herring <robh@kernel.org>
> ---
>  .../devicetree/bindings/dma/dma-controller.yaml   | 15 ---------------
>  .../devicetree/bindings/dma/dma-router.yaml       | 11 -----------
>  2 files changed, 26 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/dma/dma-controller.yaml b/Documentation/devicetree/bindings/dma/dma-controller.yaml
> index 04d150d4d15d..e6afca558c2d 100644
> --- a/Documentation/devicetree/bindings/dma/dma-controller.yaml
> +++ b/Documentation/devicetree/bindings/dma/dma-controller.yaml
> @@ -19,19 +19,4 @@ properties:
>  
>  additionalProperties: true
>  
> -examples:
> -  - |
> -    dma: dma-controller@48000000 {
> -        compatible = "ti,omap-sdma";
> -        reg = <0x48000000 0x1000>;
> -        interrupts = <0 12 0x4>,
> -                     <0 13 0x4>,
> -                     <0 14 0x4>,
> -                     <0 15 0x4>;
> -        #dma-cells = <1>;
> -        dma-channels = <32>;
> -        dma-requests = <127>;
> -        dma-channel-mask = <0xfffe>;
> -    };
> -
>  ...
> diff --git a/Documentation/devicetree/bindings/dma/dma-router.yaml b/Documentation/devicetree/bindings/dma/dma-router.yaml
> index 346fe0fa4460..5ad2febc581e 100644
> --- a/Documentation/devicetree/bindings/dma/dma-router.yaml
> +++ b/Documentation/devicetree/bindings/dma/dma-router.yaml
> @@ -40,15 +40,4 @@ required:
>  
>  additionalProperties: true
>  
> -examples:
> -  - |
> -    sdma_xbar: dma-router@4a002b78 {
> -        compatible = "ti,dra7-dma-crossbar";
> -        reg = <0x4a002b78 0xfc>;
> -        #dma-cells = <1>;
> -        dma-requests = <205>;
> -        ti,dma-safe-map = <0>;
> -        dma-masters = <&sdma>;
> -    };
> -
>  ...
> -- 
> 2.42.0

-- 
~Vinod

Re: [PATCH] dt-bindings: dma: Drop undocumented examples

[Krzysztof Kozlowski]

On 23/11/2023 09:52, Vinod Koul wrote:
> On 22-11-23, 16:50, Rob Herring wrote:
>> The compatibles "ti,omap-sdma" and "ti,dra7-dma-crossbar" aren't documented
>> by a schema which causes warnings:
>>
>> Documentation/devicetree/bindings/dma/dma-controller.example.dtb: /example-0/dma-controller@48000000: failed to match any schema with compatible: ['ti,omap-sdma']
>> Documentation/devicetree/bindings/dma/dma-router.example.dtb: /example-0/dma-router@4a002b78: failed to match any schema with compatible: ['ti,dra7-dma-crossbar']
> 
> So instead now we will have undocumented ti-omap-sdma?

It wasn't documented before. Nothing changes in that matter.

Best regards,
Krzysztof

Re: [PATCH] dt-bindings: dma: Drop undocumented examples

[Rob Herring]

On Wed, Nov 22, 2023 at 5:50 PM Rob Herring <robh@kernel.org> wrote:
>
> The compatibles "ti,omap-sdma" and "ti,dra7-dma-crossbar" aren't documented
> by a schema which causes warnings:
>
> Documentation/devicetree/bindings/dma/dma-controller.example.dtb: /example-0/dma-controller@48000000: failed to match any schema with compatible: ['ti,omap-sdma']
> Documentation/devicetree/bindings/dma/dma-router.example.dtb: /example-0/dma-router@4a002b78: failed to match any schema with compatible: ['ti,dra7-dma-crossbar']
>
> As no one has cared to fix them, just drop them.
>
> Signed-off-by: Rob Herring <robh@kernel.org>
> ---
>  .../devicetree/bindings/dma/dma-controller.yaml   | 15 ---------------
>  .../devicetree/bindings/dma/dma-router.yaml       | 11 -----------
>  2 files changed, 26 deletions(-)

Vinod, Can you pick this up please.

As pointed out, examples don't document anything. "ti,omap-sdma" is
not documented at all (though in use). "ti,dra7-dma-crossbar" is
documented in dma/ti-dma-crossbar.txt and there's still an example
there.

Rob

Re: [PATCH] dt-bindings: dma: Drop undocumented examples

[Vinod Koul]

On 07-12-23, 14:59, Rob Herring wrote:
> On Wed, Nov 22, 2023 at 5:50 PM Rob Herring <robh@kernel.org> wrote:
> >
> > The compatibles "ti,omap-sdma" and "ti,dra7-dma-crossbar" aren't documented
> > by a schema which causes warnings:
> >
> > Documentation/devicetree/bindings/dma/dma-controller.example.dtb: /example-0/dma-controller@48000000: failed to match any schema with compatible: ['ti,omap-sdma']
> > Documentation/devicetree/bindings/dma/dma-router.example.dtb: /example-0/dma-router@4a002b78: failed to match any schema with compatible: ['ti,dra7-dma-crossbar']
> >
> > As no one has cared to fix them, just drop them.
> >
> > Signed-off-by: Rob Herring <robh@kernel.org>
> > ---
> >  .../devicetree/bindings/dma/dma-controller.yaml   | 15 ---------------
> >  .../devicetree/bindings/dma/dma-router.yaml       | 11 -----------
> >  2 files changed, 26 deletions(-)
> 
> Vinod, Can you pick this up please.
> 
> As pointed out, examples don't document anything. "ti,omap-sdma" is
> not documented at all (though in use). "ti,dra7-dma-crossbar" is
> documented in dma/ti-dma-crossbar.txt and there's still an example
> there.

Sure, queued up now

-- 
~Vinod

Re: [PATCH] dt-bindings: dma: Drop undocumented examples

[Vinod Koul]

On Wed, 22 Nov 2023 16:50:50 -0700, Rob Herring wrote:
> The compatibles "ti,omap-sdma" and "ti,dra7-dma-crossbar" aren't documented
> by a schema which causes warnings:
> 
> Documentation/devicetree/bindings/dma/dma-controller.example.dtb: /example-0/dma-controller@48000000: failed to match any schema with compatible: ['ti,omap-sdma']
> Documentation/devicetree/bindings/dma/dma-router.example.dtb: /example-0/dma-router@4a002b78: failed to match any schema with compatible: ['ti,dra7-dma-crossbar']
> 
> As no one has cared to fix them, just drop them.
> 
> [...]

Applied, thanks!

[1/1] dt-bindings: dma: Drop undocumented examples
      commit: 4a8ececbb50f0dd9395ffc4188ae780916df4a9c

Best regards,
-- 
~Vinod