Skip to contentSkip to conversation

dt-bindings: dma: Drop undocumented examples

PATCH Applied Rob Herring 3 participants 7 messages Nov 22, 2023 – Dec 11, 2023

Subsystems (2)
lore
Share & tools
lore

Rob Herring

author maintainer
#0 lore raw

PATCH 1/1 dt-bindings: dma: Drop undocumented examples

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.

---
 .../devicetree/bindings/dma/dma-controller.yaml   | 15 ---------------
 .../devicetree/bindings/dma/dma-router.yaml       | 11 -----------
 2 files changed, 26 deletions(-)
Documentation/devicetree/bindings/dma/dma-controller.yaml +0 -15
index 04d150d4d15d..e6afca558c2d 100644
@@ -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>;
-    };
-
 ...
Documentation/devicetree/bindings/dma/dma-router.yaml +0 -11
index 346fe0fa4460..5ad2febc581e 100644
@@ -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>;
-    };
-
 ...
Signature · 1 line
2.42.0
Reviewed-by on v1 1/1
#1 lore raw
Quoted 10 lines · 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.

---

Best regards,
Krzysztof

maintainer
#2 lore raw
In reply to Rob Herring
Quoted 5 lines · 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']

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

Adding Peter and TI folks as well

Quoted 54 lines

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

---
 .../devicetree/bindings/dma/dma-controller.yaml   | 15 ---------------
 .../devicetree/bindings/dma/dma-router.yaml       | 11 -----------
 2 files changed, 26 deletions(-)
Documentation/devicetree/bindings/dma/dma-controller.yaml +0 -15
index 04d150d4d15d..e6afca558c2d 100644
@@ -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>;
-    };
-
...
Documentation/devicetree/bindings/dma/dma-router.yaml +0 -11
index 346fe0fa4460..5ad2febc581e 100644
@@ -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>;
-    };
-
...
Signature · 1 line
2.42.0
Signature · 1 line
~Vinod
#3 lore raw
Quoted 8 lines · Vinod Koul
Quoted 5 lines · 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']

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

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

Best regards,
Krzysztof

author maintainer
#4 lore raw
In reply to Rob Herring
Quoted 7 lines · 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']

Quoted 7 lines

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

---
 .../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

maintainer
#5 lore raw
Quoted 16 lines · Rob Herring
Quoted 7 lines · 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']

Quoted 7 lines

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

---
 .../devicetree/bindings/dma/dma-controller.yaml   | 15 ---------------
 .../devicetree/bindings/dma/dma-router.yaml       | 11 -----------
 2 files changed, 26 deletions(-)
Quoted 6 lines

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

Signature · 1 line
~Vinod
maintainer Applied
#6 lore raw
In reply to Rob Herring
Quoted 9 lines · 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.

[...]

Applied, thanks!

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

      commit: 4a8ececbb50f0dd9395ffc4188ae780916df4a9c

Best regards,

Signature · 1 line
~Vinod