xref: /linux/Documentation/devicetree/bindings/remoteproc/qcom,glink-edge.yaml (revision 78964fcac47fc1525ecb4c37cd5fbc873c28320b) 
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/remoteproc/qcom,glink-edge.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Qualcomm G-Link Edge communication channel nodes
8
9maintainers:
10  - Bjorn Andersson <bjorn.andersson@linaro.org>
11
12description:
13  Qualcomm G-Link subnode represents communication edge, channels and devices
14  related to the remote processor.
15
16properties:
17  apr:
18    $ref: /schemas/soc/qcom/qcom,apr.yaml#
19    required:
20      - qcom,glink-channels
21    description:
22      Qualcomm APR (Asynchronous Packet Router)
23
24  fastrpc:
25    $ref: /schemas/misc/qcom,fastrpc.yaml#
26    required:
27      - qcom,glink-channels
28    description:
29      Qualcomm FastRPC
30
31  gpr:
32    $ref: /schemas/soc/qcom/qcom,apr.yaml#
33    required:
34      - qcom,glink-channels
35    description:
36      Qualcomm GPR (Generic Packet Router)
37
38  interrupts:
39    maxItems: 1
40
41  label:
42    description:
43      Name of the edge, used for debugging and identification purposes. The
44      node name will be used if this is not present.
45
46  mboxes:
47    maxItems: 1
48
49  qcom,remote-pid:
50    $ref: /schemas/types.yaml#/definitions/uint32
51    description:
52      ID of the shared memory used by GLINK for communication with remote
53      processor.
54
55required:
56  - interrupts
57  - label
58  - mboxes
59  - qcom,remote-pid
60
61allOf:
62  - if:
63      required:
64        - apr
65    then:
66      properties:
67        gpr: false
68
69  - if:
70      required:
71        - gpr
72    then:
73      properties:
74        apr: false
75
76additionalProperties: false
77
78examples:
79  - |
80    #include <dt-bindings/interrupt-controller/arm-gic.h>
81    #include <dt-bindings/mailbox/qcom-ipcc.h>
82
83    remoteproc@8a00000 {
84        reg = <0x08a00000 0x10000>;
85        // ...
86
87        glink-edge {
88            interrupts-extended = <&ipcc IPCC_CLIENT_WPSS
89                                         IPCC_MPROC_SIGNAL_GLINK_QMP
90                                         IRQ_TYPE_EDGE_RISING>;
91            mboxes = <&ipcc IPCC_CLIENT_WPSS
92                            IPCC_MPROC_SIGNAL_GLINK_QMP>;
93
94            label = "wpss";
95            qcom,remote-pid = <13>;
96        };
97    };
98