xref: /freebsd/sys/contrib/device-tree/Bindings/reserved-memory/qcom,rmtfs-mem.yaml (revision fac71e4e09885bb2afa3d984a0c239a52e1a7418)
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,vmid:
30    $ref: /schemas/types.yaml#/definitions/uint32-array
31    description: >
32      Array of vmids of the remote processors, to set up memory protection
33    minItems: 1
34    maxItems: 2
35
36required:
37  - qcom,client-id
38
39unevaluatedProperties: false
40
41examples:
42  - |
43    reserved-memory {
44        #address-cells = <1>;
45        #size-cells = <1>;
46        ranges;
47
48        rmtfs@86700000 {
49            compatible = "qcom,rmtfs-mem";
50            reg = <0x86700000 0xe0000>;
51            no-map;
52
53            qcom,client-id = <1>;
54        };
55    };
56