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

   1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
   2 %YAML 1.2
   3 ---
   4 $id: "http://devicetree.org/schemas/reserved-memory/qcom,rmtfs-mem.yaml#"
   5 $schema: "http://devicetree.org/meta-schemas/core.yaml#"
   6
   7 title: Qualcomm Remote File System Memory
   8
   9 description: |
  10   This binding describes the Qualcomm remote filesystem memory, which serves the
  11   purpose of describing the shared memory region used for remote processors to
  12   access block device data using the Remote Filesystem protocol.
  13
  14 maintainers:
  15   - Bjorn Andersson <bjorn.andersson@linaro.org>
  16
  17 allOf:
  18   - $ref: "reserved-memory.yaml"
  19
  20 properties:
  21   compatible:
  22     const: qcom,rmtfs-mem
  23
  24   qcom,client-id:
  25     $ref: /schemas/types.yaml#/definitions/uint32
  26     description: >
  27       identifier of the client to use this region for buffers
  28
  29   qcom,vmid:
  30     $ref: /schemas/types.yaml#/definitions/uint32
  31     description: >
  32       vmid of the remote processor, to set up memory protection
  33
  34 required:
  35   - qcom,client-id
  36
  37 unevaluatedProperties: false
  38
  39 examples:
  40   - |
  41     reserved-memory {
  42         #address-cells = <1>;
  43         #size-cells = <1>;
  44         ranges;
  45
  46         rmtfs@86700000 {
  47             compatible = "qcom,rmtfs-mem";
  48             reg = <0x86700000 0xe0000>;
  49             no-map;
  50
  51             qcom,client-id = <1>;
  52         };
  53     };