dt-binding: soc: qcom: convert Qualcomm Command DB documentation to yaml
authorDavid Heidelberg <david@ixit.cz>
Sat, 18 Dec 2021 18:46:16 +0000 (19:46 +0100)
committerRob Herring <robh@kernel.org>
Thu, 23 Dec 2021 16:01:19 +0000 (12:01 -0400)
Convert Qualcomm Command DB documentation into yaml format.

Signed-off-by: David Heidelberg <david@ixit.cz>
Signed-off-by: Rob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20211218184617.19923-1-david@ixit.cz
Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.txt [deleted file]
Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.yaml [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.txt b/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.txt
deleted file mode 100644 (file)
index 6839553..0000000
+++ /dev/null
@@ -1,37 +0,0 @@
-Command DB
----------
-
-Command DB is a database that provides a mapping between resource key and the
-resource address for a system resource managed by a remote processor. The data
-is stored in a shared memory region and is loaded by the remote processor.
-
-Some of the Qualcomm Technologies Inc SoC's have hardware accelerators for
-controlling shared resources. Depending on the board configuration the shared
-resource properties may change. These properties are dynamically probed by the
-remote processor and made available in the shared memory.
-
-The bindings for Command DB is specified in the reserved-memory section in
-devicetree. The devicetree representation of the command DB driver should be:
-
-Properties:
-- compatible:
-       Usage: required
-       Value type: <string>
-       Definition: Should be "qcom,cmd-db"
-
-- reg:
-       Usage: required
-       Value type: <prop encoded array>
-       Definition: The register address that points to the actual location of
-                   the Command DB in memory.
-
-Example:
-
-       reserved-memory {
-               [...]
-               reserved-memory@85fe0000 {
-                       reg = <0x0 0x85fe0000 0x0 0x20000>;
-                       compatible = "qcom,cmd-db";
-                       no-map;
-               };
-       };
diff --git a/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.yaml b/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.yaml
new file mode 100644 (file)
index 0000000..df1b5e0
--- /dev/null
@@ -0,0 +1,46 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/reserved-memory/qcom,cmd-db.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Qualcomm Command DB
+
+description: |
+  Command DB is a database that provides a mapping between resource key and the
+  resource address for a system resource managed by a remote processor. The data
+  is stored in a shared memory region and is loaded by the remote processor.
+
+  Some of the Qualcomm Technologies Inc SoC's have hardware accelerators for
+  controlling shared resources. Depending on the board configuration the shared
+  resource properties may change. These properties are dynamically probed by the
+  remote processor and made available in the shared memory.
+
+maintainers:
+  - Bjorn Andersson <bjorn.andersson@linaro.org>
+
+allOf:
+  - $ref: "reserved-memory.yaml"
+
+properties:
+  compatible:
+    const: qcom,cmd-db
+
+required:
+  - reg
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    reserved-memory {
+        #address-cells = <1>;
+        #size-cells = <1>;
+        ranges;
+
+        reserved-memory@85fe0000 {
+            reg = <0x85fe0000 0x20000>;
+            compatible = "qcom,cmd-db";
+            no-map;
+        };
+    };