xref: /linux/Documentation/devicetree/bindings/reserved-memory/qcom,rmtfs-mem.yaml (revision 24168c5e6dfbdd5b414f048f47f75d64533296ca)
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
7title: Qualcomm Remote File System Memory
8
9description: |
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
14maintainers:
15  - Bjorn Andersson <bjorn.andersson@linaro.org>
16
17allOf:
18  - $ref: reserved-memory.yaml
19
20properties:
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,use-guard-pages:
30    type: boolean
31    description: >
32      Indicates that the firmware, or hardware, does not gracefully handle
33      memory protection of this region when placed adjacent to other protected
34      memory regions, and that padding around the used portion of the memory
35      region is necessary.
36
37      When this is set, the first and last page should be left unused, and the
38      effective size of the region will thereby shrink with two pages.
39
40  qcom,vmid:
41    $ref: /schemas/types.yaml#/definitions/uint32-array
42    description: >
43      Array of vmids of the remote processors, to set up memory protection
44    minItems: 1
45    maxItems: 2
46
47required:
48  - qcom,client-id
49
50unevaluatedProperties: false
51
52examples:
53  - |
54    reserved-memory {
55        #address-cells = <1>;
56        #size-cells = <1>;
57        ranges;
58
59        rmtfs@86700000 {
60            compatible = "qcom,rmtfs-mem";
61            reg = <0x86700000 0xe0000>;
62            no-map;
63
64            qcom,client-id = <1>;
65        };
66    };
67