dt-bindings: power: reset: convert Xilinx Zynq MPSoC bindings to YAML
authorNobuhiro Iwamatsu <iwamatsu@nigauri.org>
Thu, 15 Jul 2021 09:56:27 +0000 (18:56 +0900)
committerRob Herring <robh@kernel.org>
Thu, 29 Jul 2021 18:04:43 +0000 (12:04 -0600)
Convert power managemnet for Xilinx Zynq MPSoC bindings documentation to
YAML.

Signed-off-by: Nobuhiro Iwamatsu <iwamatsu@nigauri.org>
Link: https://lore.kernel.org/r/20210715095627.228176-1-iwamatsu@nigauri.org
Signed-off-by: Rob Herring <robh@kernel.org>
Documentation/devicetree/bindings/power/reset/xlnx,zynqmp-power.txt [deleted file]
Documentation/devicetree/bindings/power/reset/xlnx,zynqmp-power.yaml [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/power/reset/xlnx,zynqmp-power.txt b/Documentation/devicetree/bindings/power/reset/xlnx,zynqmp-power.txt
deleted file mode 100644 (file)
index bb529ec..0000000
+++ /dev/null
@@ -1,61 +0,0 @@
---------------------------------------------------------------------
-Device Tree Bindings for the Xilinx Zynq MPSoC Power Management
---------------------------------------------------------------------
-The zynqmp-power node describes the power management configurations.
-It will control remote suspend/shutdown interfaces.
-
-Required properties:
- - compatible:         Must contain:   "xlnx,zynqmp-power"
- - interrupts:         Interrupt specifier
-
-Optional properties:
- - mbox-names  : Name given to channels seen in the 'mboxes' property.
-                 "tx" - Mailbox corresponding to transmit path
-                 "rx" - Mailbox corresponding to receive path
- - mboxes      : Standard property to specify a Mailbox. Each value of
-                 the mboxes property should contain a phandle to the
-                 mailbox controller device node and an args specifier
-                 that will be the phandle to the intended sub-mailbox
-                 child node to be used for communication. See
-                 Documentation/devicetree/bindings/mailbox/mailbox.txt
-                 for more details about the generic mailbox controller
-                 and client driver bindings. Also see
-                 Documentation/devicetree/bindings/mailbox/ \
-                 xlnx,zynqmp-ipi-mailbox.txt for typical controller that
-                 is used to communicate with this System controllers.
-
---------
-Examples
---------
-
-Example with interrupt method:
-
-firmware {
-       zynqmp_firmware: zynqmp-firmware {
-               compatible = "xlnx,zynqmp-firmware";
-               method = "smc";
-
-               zynqmp_power: zynqmp-power {
-                       compatible = "xlnx,zynqmp-power";
-                       interrupts = <0 35 4>;
-               };
-       };
-};
-
-Example with IPI mailbox method:
-
-firmware {
-       zynqmp_firmware: zynqmp-firmware {
-               compatible = "xlnx,zynqmp-firmware";
-               method = "smc";
-
-               zynqmp_power: zynqmp-power {
-                       compatible = "xlnx,zynqmp-power";
-                       interrupt-parent = <&gic>;
-                       interrupts = <0 35 4>;
-                       mboxes = <&ipi_mailbox_pmu0 0>,
-                                <&ipi_mailbox_pmu0 1>;
-                       mbox-names = "tx", "rx";
-               };
-       };
-};
diff --git a/Documentation/devicetree/bindings/power/reset/xlnx,zynqmp-power.yaml b/Documentation/devicetree/bindings/power/reset/xlnx,zynqmp-power.yaml
new file mode 100644 (file)
index 0000000..68d7c14
--- /dev/null
@@ -0,0 +1,83 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/power/reset/xlnx,zynqmp-power.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Xilinx Zynq MPSoC Power Management Device Tree Bindings
+
+maintainers:
+  - Michal Simek <michal.simek@xilinx.com>
+
+description: |
+  The zynqmp-power node describes the power management configurations.
+  It will control remote suspend/shutdown interfaces.
+
+properties:
+  compatible:
+    const: "xlnx,zynqmp-power"
+
+  interrupts:
+    maxItems: 1
+
+  mboxes:
+    description: |
+      Standard property to specify a Mailbox. Each value of
+      the mboxes property should contain a phandle to the
+      mailbox controller device node and an args specifier
+      that will be the phandle to the intended sub-mailbox
+      child node to be used for communication. See
+      Documentation/devicetree/bindings/mailbox/mailbox.txt
+      for more details about the generic mailbox controller
+      and client driver bindings. Also see
+      Documentation/devicetree/bindings/mailbox/ \
+      xlnx,zynqmp-ipi-mailbox.txt for typical controller that
+      is used to communicate with this System controllers.
+    items:
+      - description: tx channel
+      - description: rx channel
+
+  mbox-names:
+    description:
+      Name given to channels seen in the 'mboxes' property.
+    items:
+      - const: tx
+      - const: rx
+
+required:
+  - compatible
+  - interrupts
+
+additionalProperties: false
+
+examples:
+  - |+
+
+    // Example with interrupt method:
+
+    firmware {
+      zynqmp-firmware {
+        zynqmp-power {
+          compatible = "xlnx,zynqmp-power";
+          interrupts = <0 35 4>;
+        };
+      };
+    };
+
+  - |+
+
+    // Example with IPI mailbox method:
+
+    firmware {
+      zynqmp-firmware {
+        zynqmp-power {
+          compatible = "xlnx,zynqmp-power";
+          interrupt-parent = <&gic>;
+          interrupts = <0 35 4>;
+          mboxes = <&ipi_mailbox_pmu1 0>,
+                   <&ipi_mailbox_pmu1 1>;
+          mbox-names = "tx", "rx";
+        };
+      };
+    };
+...