xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/reserved-memory/qcom,rmtfs-mem.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunQualcomm Remote File System Memory binding
2*4882a593Smuzhiyun
3*4882a593SmuzhiyunThis binding describes the Qualcomm remote filesystem memory, which serves the
4*4882a593Smuzhiyunpurpose of describing the shared memory region used for remote processors to
5*4882a593Smuzhiyunaccess block device data using the Remote Filesystem protocol.
6*4882a593Smuzhiyun
7*4882a593Smuzhiyun- compatible:
8*4882a593Smuzhiyun	Usage: required
9*4882a593Smuzhiyun	Value type: <stringlist>
10*4882a593Smuzhiyun	Definition: must be:
11*4882a593Smuzhiyun		    "qcom,rmtfs-mem"
12*4882a593Smuzhiyun
13*4882a593Smuzhiyun- reg:
14*4882a593Smuzhiyun	Usage: required for static allocation
15*4882a593Smuzhiyun	Value type: <prop-encoded-array>
16*4882a593Smuzhiyun	Definition: must specify base address and size of the memory region,
17*4882a593Smuzhiyun		    as described in reserved-memory.txt
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun- size:
20*4882a593Smuzhiyun	Usage: required for dynamic allocation
21*4882a593Smuzhiyun	Value type: <prop-encoded-array>
22*4882a593Smuzhiyun	Definition: must specify a size of the memory region, as described in
23*4882a593Smuzhiyun		    reserved-memory.txt
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun- qcom,client-id:
26*4882a593Smuzhiyun	Usage: required
27*4882a593Smuzhiyun	Value type: <u32>
28*4882a593Smuzhiyun	Definition: identifier of the client to use this region for buffers.
29*4882a593Smuzhiyun
30*4882a593Smuzhiyun- qcom,vmid:
31*4882a593Smuzhiyun	Usage: optional
32*4882a593Smuzhiyun	Value type: <u32>
33*4882a593Smuzhiyun	Definition: vmid of the remote processor, to set up memory protection.
34*4882a593Smuzhiyun
35*4882a593Smuzhiyun= EXAMPLE
36*4882a593SmuzhiyunThe following example shows the remote filesystem memory setup for APQ8016,
37*4882a593Smuzhiyunwith the rmtfs region for the Hexagon DSP (id #1) located at 0x86700000.
38*4882a593Smuzhiyun
39*4882a593Smuzhiyun	reserved-memory {
40*4882a593Smuzhiyun		#address-cells = <2>;
41*4882a593Smuzhiyun		#size-cells = <2>;
42*4882a593Smuzhiyun		ranges;
43*4882a593Smuzhiyun
44*4882a593Smuzhiyun		rmtfs@86700000 {
45*4882a593Smuzhiyun			compatible = "qcom,rmtfs-mem";
46*4882a593Smuzhiyun			reg = <0x0 0x86700000 0x0 0xe0000>;
47*4882a593Smuzhiyun			no-map;
48*4882a593Smuzhiyun
49*4882a593Smuzhiyun			qcom,client-id = <1>;
50*4882a593Smuzhiyun		};
51*4882a593Smuzhiyun	};
52