bindings/mailbox/xlnx%2Czynqmp-ipi-mailbox.yaml

1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
3 ---
4 $id: http://devicetree.org/schemas/mailbox/xlnx,zynqmp-ipi-mailbox.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
7 title: Xilinx IPI(Inter Processor Interrupt) mailbox controller
10   The Xilinx IPI(Inter Processor Interrupt) mailbox controller is to manage
11   messaging between two Xilinx Zynq UltraScale+ MPSoC IPI agents. Each IPI
14                +-------------------------------------+
15                | Xilinx ZynqMP IPI Controller        |
16                +-------------------------------------+
17     +--------------------------------------------------+
18   TF-A                   |                     |
21     +--------------------------+               |
24     +--------------------------------------------------+
25               +------------------------------------------+
26               |  +----------------+   +----------------+ |
27   Hardware    |  |  IPI Agent     |   |  IPI Buffers   | |
30               |  +----------------+   +----------------+ |
32               | Xilinx IPI Agent Block                   |
33               +------------------------------------------+
36   - Shubhrajyoti Datta <shubhrajyoti.datta@amd.com>
40     const: xlnx,zynqmp-ipi-mailbox
44       The method of calling the PM-API firmware layer.
46       - "smc" : SMC #0, following the SMCCC
47       - "hvc" : HVC #0, following the SMCCC
51       - smc
52       - hvc
55   '#address-cells':
58   '#size-cells':
61   xlnx,ipi-id:
63       Remote Xilinx IPI agent ID of which the mailbox is connected to.
72   '^mailbox@[0-9a-f]+$':
73     description: Internal ipi mailbox node
77       xlnx,ipi-id:
79           Remote Xilinx IPI agent ID of which the mailbox is connected to.
82       '#mbox-cells':
85           It contains tx(0) or rx(1) channel IPI id number.
90       reg-names:
92           - const: local_request_region
93           - const: local_response_region
94           - const: remote_request_region
95           - const: remote_response_region
98       - reg
99       - reg-names
100       - "#mbox-cells"
105   - compatible
106   - interrupts
107   - '#address-cells'
108   - '#size-cells'
109   - xlnx,ipi-id
112   - |
113     #include<dt-bindings/interrupt-controller/arm-gic.h>
116       #address-cells = <0x2>;
117       #size-cells = <0x2>;
118       zynqmp-mailbox {
119         compatible = "xlnx,zynqmp-ipi-mailbox";
121         xlnx,ipi-id = <0>;
122         #address-cells = <2>;
123         #size-cells = <2>;
126         mailbox: mailbox@ff9905c0 {
131           reg-names = "local_request_region",
135           #mbox-cells = <1>;
136           xlnx,ipi-id = <4>;