dt-bindings: hwlock: qcom: Migrate binding to YAML
authorBjorn Andersson <bjorn.andersson@linaro.org>
Mon, 22 Jun 2020 07:59:53 +0000 (00:59 -0700)
committerBjorn Andersson <bjorn.andersson@linaro.org>
Tue, 14 Jul 2020 05:29:18 +0000 (22:29 -0700)
Migrate the Qualcomm TCSR mutex binding to YAML to allow validation.

Reviewed-by: Vinod Koul <vkoul@kernel.org>
Reviewed-by: Rob Herring <robh@kernel.org>
Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>
Link: https://lore.kernel.org/r/20200622075956.171058-2-bjorn.andersson@linaro.org
Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>
Documentation/devicetree/bindings/hwlock/qcom-hwspinlock.txt [deleted file]
Documentation/devicetree/bindings/hwlock/qcom-hwspinlock.yaml [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/hwlock/qcom-hwspinlock.txt b/Documentation/devicetree/bindings/hwlock/qcom-hwspinlock.txt
deleted file mode 100644 (file)
index 4563f52..0000000
+++ /dev/null
@@ -1,39 +0,0 @@
-Qualcomm Hardware Mutex Block:
-
-The hardware block provides mutexes utilized between different processors on
-the SoC as part of the communication protocol used by these processors.
-
-- compatible:
-       Usage: required
-       Value type: <string>
-       Definition: must be one of:
-                   "qcom,sfpb-mutex",
-                   "qcom,tcsr-mutex"
-
-- syscon:
-       Usage: required
-       Value type: <prop-encoded-array>
-       Definition: one cell containing:
-                   syscon phandle
-                   offset of the hwmutex block within the syscon
-                   stride of the hwmutex registers
-
-- #hwlock-cells:
-       Usage: required
-       Value type: <u32>
-       Definition: must be 1, the specified cell represent the lock id
-                   (hwlock standard property, see hwlock.txt)
-
-Example:
-
-       tcsr_mutex_block: syscon@fd484000 {
-               compatible = "syscon";
-               reg = <0xfd484000 0x2000>;
-       };
-
-       hwlock@fd484000 {
-               compatible = "qcom,tcsr-mutex";
-               syscon = <&tcsr_mutex_block 0 0x80>;
-
-               #hwlock-cells = <1>;
-       };
diff --git a/Documentation/devicetree/bindings/hwlock/qcom-hwspinlock.yaml b/Documentation/devicetree/bindings/hwlock/qcom-hwspinlock.yaml
new file mode 100644 (file)
index 0000000..71e63b5
--- /dev/null
@@ -0,0 +1,51 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/hwlock/qcom-hwspinlock.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Qualcomm Hardware Mutex Block
+
+maintainers:
+  - Bjorn Andersson <bjorn.andersson@linaro.org>
+
+description:
+  The hardware block provides mutexes utilized between different processors on
+  the SoC as part of the communication protocol used by these processors.
+
+properties:
+  compatible:
+    enum:
+      - qcom,sfpb-mutex
+      - qcom,tcsr-mutex
+
+  '#hwlock-cells':
+    const: 1
+
+  syscon:
+    $ref: "/schemas/types.yaml#/definitions/phandle-array"
+    description:
+      Should be a triple of phandle referencing the TCSR mutex syscon, offset
+      of first mutex within the syscon and stride between each mutex.
+
+required:
+  - compatible
+  - '#hwlock-cells'
+  - syscon
+
+additionalProperties: false
+
+examples:
+  - |
+        tcsr_mutex_block: syscon@fd484000 {
+                compatible = "syscon";
+                reg = <0xfd484000 0x2000>;
+        };
+
+        hwlock {
+                compatible = "qcom,tcsr-mutex";
+                syscon = <&tcsr_mutex_block 0 0x80>;
+
+                #hwlock-cells = <1>;
+        };
+...