dt-bindings: soc: qcom: convert qcom,smem bindings to yaml
authorDmitry Baryshkov <dmitry.baryshkov@linaro.org>
Tue, 15 Dec 2020 10:45:37 +0000 (13:45 +0300)
committerBjorn Andersson <bjorn.andersson@linaro.org>
Mon, 28 Dec 2020 18:15:14 +0000 (12:15 -0600)
Convert soc/qcom/qcom,smem.txt bindings to YAML format.

Reviewed-by: Bjorn Andersson <bjorn.andersson@linaro.org>
Reviewed-by: Rob Herring <robh@kernel.org>
Signed-off-by: Dmitry Baryshkov <dmitry.baryshkov@linaro.org>
Link: https://lore.kernel.org/r/20201215104537.768914-1-dmitry.baryshkov@linaro.org
Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>
Documentation/devicetree/bindings/soc/qcom/qcom,smem.txt [deleted file]
Documentation/devicetree/bindings/soc/qcom/qcom,smem.yaml [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/soc/qcom/qcom,smem.txt b/Documentation/devicetree/bindings/soc/qcom/qcom,smem.txt
deleted file mode 100644 (file)
index 9326cdf..0000000
+++ /dev/null
@@ -1,57 +0,0 @@
-Qualcomm Shared Memory Manager binding
-
-This binding describes the Qualcomm Shared Memory Manager, used to share data
-between various subsystems and OSes in Qualcomm platforms.
-
-- compatible:
-       Usage: required
-       Value type: <stringlist>
-       Definition: must be:
-                   "qcom,smem"
-
-- memory-region:
-       Usage: required
-       Value type: <prop-encoded-array>
-       Definition: handle to memory reservation for main SMEM memory region.
-
-- qcom,rpm-msg-ram:
-       Usage: required
-       Value type: <prop-encoded-array>
-       Definition: handle to RPM message memory resource
-
-- hwlocks:
-       Usage: required
-       Value type: <prop-encoded-array>
-       Definition: reference to a hwspinlock used to protect allocations from
-                   the shared memory
-
-= EXAMPLE
-The following example shows the SMEM setup for MSM8974, with a main SMEM region
-at 0xfa00000 and the RPM message ram at 0xfc428000:
-
-       reserved-memory {
-               #address-cells = <1>;
-               #size-cells = <1>;
-               ranges;
-
-               smem_region: smem@fa00000 {
-                       reg = <0xfa00000 0x200000>;
-                       no-map;
-               };
-       };
-
-       smem@fa00000 {
-               compatible = "qcom,smem";
-
-               memory-region = <&smem_region>;
-               qcom,rpm-msg-ram = <&rpm_msg_ram>;
-
-               hwlocks = <&tcsr_mutex 3>;
-       };
-
-       soc {
-               rpm_msg_ram: memory@fc428000 {
-                       compatible = "qcom,rpm-msg-ram";
-                       reg = <0xfc428000 0x4000>;
-               };
-       };
diff --git a/Documentation/devicetree/bindings/soc/qcom/qcom,smem.yaml b/Documentation/devicetree/bindings/soc/qcom/qcom,smem.yaml
new file mode 100644 (file)
index 0000000..f7e1771
--- /dev/null
@@ -0,0 +1,72 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/soc/qcom/qcom,smem.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Qualcomm Shared Memory Manager binding
+
+maintainers:
+  - Andy Gross <agross@kernel.org>
+  - Bjorn Andersson <bjorn.andersson@linaro.org>
+
+description: |
+  This binding describes the Qualcomm Shared Memory Manager, used to share data
+  between various subsystems and OSes in Qualcomm platforms.
+
+properties:
+  compatible:
+    const: qcom,smem
+
+  memory-region:
+    maxItems: 1
+    description: handle to memory reservation for main SMEM memory region.
+
+  hwlocks:
+    maxItems: 1
+
+  qcom,rpm-msg-ram:
+    $ref: /schemas/types.yaml#/definitions/phandle
+    description: handle to RPM message memory resource
+
+required:
+  - compatible
+  - memory-region
+  - hwlocks
+
+additionalProperties: false
+
+examples:
+  - |
+    reserved-memory {
+        #address-cells = <1>;
+        #size-cells = <1>;
+        ranges;
+
+        smem_region: smem@fa00000 {
+            reg = <0xfa00000 0x200000>;
+            no-map;
+        };
+    };
+
+    smem {
+        compatible = "qcom,smem";
+
+        memory-region = <&smem_region>;
+        qcom,rpm-msg-ram = <&rpm_msg_ram>;
+
+        hwlocks = <&tcsr_mutex 3>;
+    };
+
+    soc {
+        #address-cells = <1>;
+        #size-cells = <1>;
+        ranges;
+
+        rpm_msg_ram: sram@fc428000 {
+            compatible = "qcom,rpm-msg-ram";
+            reg = <0xfc428000 0x4000>;
+        };
+    };
+
+...