xref: /freebsd/sys/contrib/device-tree/Bindings/remoteproc/qcom,smd-edge.yaml (revision e32fecd0c2c3ee37c47ee100f169e7eb0282a873) 
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,smd-edge.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Qualcomm SMD Edge communication channel nodes
8
9maintainers:
10  - Bjorn Andersson <bjorn.andersson@linaro.org>
11
12description:
13  Qualcomm SMD subnode represents a remote subsystem or a remote processor of
14  some sort - or in SMD language an "edge". The name of the edges are not
15  important.
16  See also Documentation/devicetree/bindings/soc/qcom/qcom,smd.yaml
17
18properties:
19  $nodename:
20    const: "smd-edge"
21
22  interrupts:
23    maxItems: 1
24
25  label:
26    description:
27      Name of the edge, used for debugging and identification purposes. The
28      node name will be used if this is not present.
29
30  mboxes:
31    maxItems: 1
32    description:
33      Reference to the mailbox representing the outgoing doorbell in APCS for
34      this client.
35
36  qcom,ipc:
37    $ref: /schemas/types.yaml#/definitions/phandle-array
38    items:
39      - items:
40          - description: phandle to a syscon node representing the APCS registers
41          - description: u32 representing offset to the register within the syscon
42          - description: u32 representing the ipc bit within the register
43    description:
44      Three entries specifying the outgoing ipc bit used for signaling the
45      remote processor.
46
47  qcom,smd-edge:
48    $ref: /schemas/types.yaml#/definitions/uint32
49    description:
50      The identifier of the remote processor in the smd channel allocation
51      table.
52
53  qcom,remote-pid:
54    $ref: /schemas/types.yaml#/definitions/uint32
55    description:
56      The identifier for the remote processor as known by the rest of the
57      system.
58
59required:
60  - interrupts
61  - qcom,smd-edge
62
63oneOf:
64  - required:
65      - mboxes
66  - required:
67      - qcom,ipc
68
69additionalProperties: true
70
71examples:
72  - |
73    #include <dt-bindings/interrupt-controller/arm-gic.h>
74    #include <dt-bindings/mailbox/qcom-ipcc.h>
75
76    remoteproc {
77        // ...
78
79        smd-edge {
80            interrupts = <GIC_SPI 156 IRQ_TYPE_EDGE_RISING>;
81
82            qcom,ipc = <&apcs 8 8>;
83            qcom,smd-edge = <1>;
84        };
85    };
86