Documentation/devicetree/bindings/reserved-memory/qcom,rmtfs-mem.txt

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