xref: /freebsd/sys/contrib/device-tree/Bindings/reserved-memory/qcom,cmd-db.txt (revision 7fdf597e96a02165cfe22ff357b857d5fa15ed8a)
1Command DB
2---------
3
4Command DB is a database that provides a mapping between resource key and the
5resource address for a system resource managed by a remote processor. The data
6is stored in a shared memory region and is loaded by the remote processor.
7
8Some of the Qualcomm Technologies Inc SoC's have hardware accelerators for
9controlling shared resources. Depending on the board configuration the shared
10resource properties may change. These properties are dynamically probed by the
11remote processor and made available in the shared memory.
12
13The bindings for Command DB is specified in the reserved-memory section in
14devicetree. The devicetree representation of the command DB driver should be:
15
16Properties:
17- compatible:
18	Usage: required
19	Value type: <string>
20	Definition: Should be "qcom,cmd-db"
21
22- reg:
23	Usage: required
24	Value type: <prop encoded array>
25	Definition: The register address that points to the actual location of
26		    the Command DB in memory.
27
28Example:
29
30	reserved-memory {
31		[...]
32		reserved-memory@85fe0000 {
33			reg = <0x0 0x85fe0000 0x0 0x20000>;
34			compatible = "qcom,cmd-db";
35			no-map;
36		};
37	};
38