dt-bindings: introduce Command DB for QCOM SoCs
authorMahesh Sivasubramanian <msivasub@codeaurora.org>
Tue, 10 Apr 2018 17:57:24 +0000 (11:57 -0600)
committerAndy Gross <andy.gross@linaro.org>
Wed, 23 May 2018 04:28:54 +0000 (23:28 -0500)
Command DB provides information on shared resources like clocks,
regulators etc., probed at boot by the remote subsytem and made
available in shared memory.

Cc: devicetree@vger.kernel.org
Signed-off-by: Mahesh Sivasubramanian <msivasub@codeaurora.org>
Signed-off-by: Lina Iyer <ilina@codeaurora.org>
Reviewed-by: Bjorn Andersson <bjorn.andersson@linaro.org>
Reviewed-by: Rob Herring <robh@kernel.org>
Reviewed-by: Stephen Boyd <swboyd@chromium.org>
Reviewed-by: Evan Green <evgreen@chromium.org>
Signed-off-by: Andy Gross <andy.gross@linaro.org>
Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.txt [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
new file mode 100644 (file)
index 0000000..6839553
--- /dev/null
@@ -0,0 +1,37 @@
+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;
+               };
+       };