[PATCH linux dev-5.4 1/6] dt-bindings: soc: aspeed: xdma: Update to v11 upstream

[Eddie James]

Switch the documentation to schema and update to the latest on the
upstream lists.

Signed-off-by: Eddie James <eajames at linux.ibm.com>
---
 .../devicetree/bindings/soc/aspeed/xdma.txt        |  40 --------
 .../devicetree/bindings/soc/aspeed/xdma.yaml       | 103 +++++++++++++++++++++
 2 files changed, 103 insertions(+), 40 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/soc/aspeed/xdma.txt
 create mode 100644 Documentation/devicetree/bindings/soc/aspeed/xdma.yaml

diff --git a/Documentation/devicetree/bindings/soc/aspeed/xdma.txt b/Documentation/devicetree/bindings/soc/aspeed/xdma.txt
deleted file mode 100644
index da62975..0000000
--- a/Documentation/devicetree/bindings/soc/aspeed/xdma.txt
+++ /dev/null
@@ -1,40 +0,0 @@
-Aspeed AST25XX and AST26XX XDMA Engine
-
-The XDMA Engine embedded in the AST2500 and AST2600 SOCs can perform automatic
-DMA operations over PCI between the SOC (acting as a BMC) and a host processor.
-
-Required properties:
- - compatible		: must be "aspeed,ast2500-xdma" or
-			  "aspeed,ast2600-xdma"
- - reg			: contains the address and size of the memory region
-			  associated with the XDMA engine registers
- - clocks		: clock specifier for the clock associated with the
-			  XDMA engine
- - resets		: reset specifier for the syscon reset associated with
-			  the XDMA engine
- - interrupts-extended	: two interrupt cells; the first specifies the global
-			  interrupt for the XDMA engine and the second
-			  specifies the PCI-E reset or PERST interrupt.
- - aspeed,scu		: a phandle to the syscon node for the system control
-			  unit of the SOC
- - memory-region	: a phandle to the reserved memory region to be used by
-			  the XDMA engine for DMA operations
-
-Optional properties:
- - pcie-device		: should be either "bmc" or "vga", corresponding to
-			  which device should be used by the XDMA engine for
-			  DMA operations. If this property is not set, the XDMA
-			  engine will use the BMC PCI-E device.
-
-Example:
-
-    xdma at 1e6e7000 {
-        compatible = "aspeed,ast2500-xdma";
-        reg = <0x1e6e7000 0x100>;
-        clocks = <&syscon ASPEED_CLK_GATE_BCLK>;
-        resets = <&syscon ASPEED_RESET_XDMA>;
-        interrupts-extended = <&vic 6>, <&scu_ic ASPEED_AST2500_SCU_IC_PCIE_RESET_LO_TO_HI>;
-        aspeed,scu = <&syscon>;
-        pcie-device = "bmc";
-        memory-region = <&vga_memory>;
-    };
diff --git a/Documentation/devicetree/bindings/soc/aspeed/xdma.yaml b/Documentation/devicetree/bindings/soc/aspeed/xdma.yaml
new file mode 100644
index 0000000..4957435
--- /dev/null
+++ b/Documentation/devicetree/bindings/soc/aspeed/xdma.yaml
@@ -0,0 +1,103 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/soc/aspeed/xdma.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Aspeed AST25XX and AST26XX XDMA Engine
+
+maintainers:
+ - Eddie James <eajames at linux.ibm.com>
+
+description: |
+  This binding describes the XDMA Engine embedded in the AST2500 and AST2600
+  SOCs. The XDMA engine can perform automatic DMA operations over PCI between
+  the SOC (acting as a BMC) and a host processor.
+
+properties:
+  compatible:
+    enum:
+      - aspeed,ast2500-xdma
+      - aspeed,ast2600-xdma
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  resets:
+    minItems: 1
+    maxItems: 2
+
+  reset-names:
+    maxItems: 2
+    items:
+      - const: device
+      - const: root-complex
+
+  interrupts:
+    maxItems: 2
+    items:
+      - description: global interrupt for the XDMA engine
+      - description: PCI-E reset or PERST interrupt
+
+  aspeed,scu:
+    description: a reference to the System Control Unit node of the Aspeed SOC.
+    allOf:
+      - $ref: /schemas/types.yaml#/definitions/phandle
+
+  aspeed,pcie-device:
+    description: describes which PCI-E device the XDMA engine should use
+    allOf:
+      - $ref: /schemas/types.yaml#/definitions/string
+      - enum: [ bmc, vga ]
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - resets
+  - interrupts-extended
+  - aspeed,scu
+  - memory-region
+
+if:
+  properties:
+    compatible:
+      contains:
+        const: aspeed,ast2600-xdma
+then:
+  required:
+    - reset-names
+
+examples:
+  - |
+    #include <dt-bindings/clock/ast2600-clock.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/interrupt-controller/aspeed-scu-ic.h>
+    syscon: syscon at 1e6e2000 {
+        reg = <0x1e6e2000 0x1000>;
+        ranges = <0 0x1e6e2000 0x1000>;
+        #address-cells = <1>;
+        #size-cells = <1>;
+        #clock-cells = <1>;
+        #reset-cells = <1>;
+        scu_ic0: interrupt-controller at 560 {
+            reg = <0x560 0x4>;
+            interrupt-controller;
+            #interrupt-cells = <1>;
+        };
+    };
+    xdma at 1e6e7000 {
+        compatible = "aspeed,ast2600-xdma";
+        reg = <0x1e6e7000 0x100>;
+        clocks = <&syscon ASPEED_CLK_GATE_BCLK>;
+        resets = <&syscon ASPEED_RESET_DEV_XDMA>, <&syscon ASPEED_RESET_RC_XDMA>;
+        reset-names = "device", "root-complex";
+        interrupts-extended = <&gic GIC_SPI 6 IRQ_TYPE_LEVEL_HIGH>,
+                              <&scu_ic0 ASPEED_AST2600_SCU_IC0_PCIE_PERST_LO_TO_HI>;
+        aspeed,scu = <&syscon>;
+        aspeed,pcie-device = "bmc";
+        memory-region = <&vga_memory>;
+    };
-- 
1.8.3.1