OSDN Git Service

dt-bindings: PCI: uniphier: Convert uniphier-pcie.txt to json-schema
authorKunihiko Hayashi <hayashi.kunihiko@socionext.com>
Wed, 30 Mar 2022 05:23:33 +0000 (14:23 +0900)
committerRob Herring <robh@kernel.org>
Tue, 5 Apr 2022 00:55:02 +0000 (19:55 -0500)
Convert the file into a JSON description at the yaml format.

Signed-off-by: Kunihiko Hayashi <hayashi.kunihiko@socionext.com>
Signed-off-by: Rob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/1648617814-9217-2-git-send-email-hayashi.kunihiko@socionext.com
Documentation/devicetree/bindings/pci/socionext,uniphier-pcie.yaml [new file with mode: 0644]
Documentation/devicetree/bindings/pci/uniphier-pcie.txt [deleted file]
MAINTAINERS

diff --git a/Documentation/devicetree/bindings/pci/socionext,uniphier-pcie.yaml b/Documentation/devicetree/bindings/pci/socionext,uniphier-pcie.yaml
new file mode 100644 (file)
index 0000000..f5926d0
--- /dev/null
@@ -0,0 +1,96 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/pci/socionext,uniphier-pcie.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Socionext UniPhier PCIe host controller
+
+description: |
+  UniPhier PCIe host controller is based on the Synopsys DesignWare
+  PCI core. It shares common features with the PCIe DesignWare core and
+  inherits common properties defined in
+  Documentation/devicetree/bindings/pci/snps,dw-pcie.yaml.
+
+maintainers:
+  - Kunihiko Hayashi <hayashi.kunihiko@socionext.com>
+
+allOf:
+  - $ref: /schemas/pci/snps,dw-pcie.yaml#
+
+properties:
+  compatible:
+    enum:
+      - socionext,uniphier-pcie
+
+  reg:
+    minItems: 3
+    maxItems: 4
+
+  reg-names:
+    minItems: 3
+    items:
+      - const: dbi
+      - const: link
+      - const: config
+      - const: atu
+
+  clocks:
+    maxItems: 1
+
+  resets:
+    maxItems: 1
+
+  num-viewport: true
+
+  num-lanes: true
+
+  phys:
+    maxItems: 1
+
+  phy-names:
+    const: pcie-phy
+
+required:
+  - compatible
+  - reg
+  - reg-names
+  - clocks
+  - resets
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    pcie: pcie@66000000 {
+        compatible = "socionext,uniphier-pcie";
+        reg-names = "dbi", "link", "config";
+        reg = <0x66000000 0x1000>, <0x66010000 0x10000>, <0x2fff0000 0x10000>;
+        #address-cells = <3>;
+        #size-cells = <2>;
+        clocks = <&sys_clk 24>;
+        resets = <&sys_rst 24>;
+        num-lanes = <1>;
+        num-viewport = <1>;
+        bus-range = <0x0 0xff>;
+        device_type = "pci";
+        ranges = <0x81000000 0 0x00000000  0x2ffe0000  0 0x00010000>,
+                 <0x82000000 0 0x00000000  0x20000000  0 0x0ffe0000>;
+        phy-names = "pcie-phy";
+        phys = <&pcie_phy>;
+        #interrupt-cells = <1>;
+        interrupt-names = "dma", "msi";
+        interrupts = <0 224 4>, <0 225 4>;
+        interrupt-map-mask = <0 0 0  7>;
+        interrupt-map = <0 0 0  1  &pcie_intc 0>,
+                        <0 0 0  2  &pcie_intc 1>,
+                        <0 0 0  3  &pcie_intc 2>,
+                        <0 0 0  4  &pcie_intc 3>;
+
+        pcie_intc: legacy-interrupt-controller {
+            interrupt-controller;
+            #interrupt-cells = <1>;
+            interrupt-parent = <&gic>;
+            interrupts = <0 226 4>;
+        };
+    };
diff --git a/Documentation/devicetree/bindings/pci/uniphier-pcie.txt b/Documentation/devicetree/bindings/pci/uniphier-pcie.txt
deleted file mode 100644 (file)
index 359585d..0000000
+++ /dev/null
@@ -1,82 +0,0 @@
-Socionext UniPhier PCIe host controller bindings
-
-This describes the devicetree bindings for PCIe host controller implemented
-on Socionext UniPhier SoCs.
-
-UniPhier PCIe host controller is based on the Synopsys DesignWare PCI core.
-It shares common functions with the PCIe DesignWare core driver and inherits
-common properties defined in
-Documentation/devicetree/bindings/pci/snps,dw-pcie.yaml.
-
-Required properties:
-- compatible: Should be "socionext,uniphier-pcie".
-- reg: Specifies offset and length of the register set for the device.
-       According to the reg-names, appropriate register sets are required.
-- reg-names: Must include the following entries:
-    "dbi"    - controller configuration registers
-    "link"   - SoC-specific glue layer registers
-    "config" - PCIe configuration space
-    "atu"    - iATU registers for DWC version 4.80 or later
-- clocks: A phandle to the clock gate for PCIe glue layer including
-       the host controller.
-- resets: A phandle to the reset line for PCIe glue layer including
-       the host controller.
-- interrupts: A list of interrupt specifiers. According to the
-       interrupt-names, appropriate interrupts are required.
-- interrupt-names: Must include the following entries:
-    "dma" - DMA interrupt
-    "msi" - MSI interrupt
-
-Optional properties:
-- phys: A phandle to generic PCIe PHY. According to the phy-names, appropriate
-       phys are required.
-- phy-names: Must be "pcie-phy".
-
-Required sub-node:
-- legacy-interrupt-controller: Specifies interrupt controller for legacy PCI
-       interrupts.
-
-Required properties for legacy-interrupt-controller:
-- interrupt-controller: identifies the node as an interrupt controller.
-- #interrupt-cells: specifies the number of cells needed to encode an
-       interrupt source. The value must be 1.
-- interrupt-parent: Phandle to the parent interrupt controller.
-- interrupts: An interrupt specifier for legacy interrupt.
-
-Example:
-
-       pcie: pcie@66000000 {
-               compatible = "socionext,uniphier-pcie", "snps,dw-pcie";
-               status = "disabled";
-               reg-names = "dbi", "link", "config";
-               reg = <0x66000000 0x1000>, <0x66010000 0x10000>,
-                     <0x2fff0000 0x10000>;
-               #address-cells = <3>;
-               #size-cells = <2>;
-               clocks = <&sys_clk 24>;
-               resets = <&sys_rst 24>;
-               num-lanes = <1>;
-               num-viewport = <1>;
-               bus-range = <0x0 0xff>;
-               device_type = "pci";
-               ranges =
-               /* downstream I/O */
-                       <0x81000000 0 0x00000000  0x2ffe0000  0 0x00010000
-               /* non-prefetchable memory */
-                        0x82000000 0 0x00000000  0x20000000  0 0x0ffe0000>;
-               #interrupt-cells = <1>;
-               interrupt-names = "dma", "msi";
-               interrupts = <0 224 4>, <0 225 4>;
-               interrupt-map-mask = <0 0 0  7>;
-               interrupt-map = <0 0 0  1  &pcie_intc 0>,       /* INTA */
-                               <0 0 0  2  &pcie_intc 1>,       /* INTB */
-                               <0 0 0  3  &pcie_intc 2>,       /* INTC */
-                               <0 0 0  4  &pcie_intc 3>;       /* INTD */
-
-               pcie_intc: legacy-interrupt-controller {
-                       interrupt-controller;
-                       #interrupt-cells = <1>;
-                       interrupt-parent = <&gic>;
-                       interrupts = <0 226 4>;
-               };
-       };
index fd768d4..4beb200 100644 (file)
@@ -15357,7 +15357,7 @@ PCIE DRIVER FOR SOCIONEXT UNIPHIER
 M:     Kunihiko Hayashi <hayashi.kunihiko@socionext.com>
 L:     linux-pci@vger.kernel.org
 S:     Maintained
-F:     Documentation/devicetree/bindings/pci/uniphier-pcie*
+F:     Documentation/devicetree/bindings/pci/socionext,uniphier-pcie*
 F:     drivers/pci/controller/dwc/pcie-uniphier*
 
 PCIE DRIVER FOR ST SPEAR13XX