]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - Documentation/devicetree/bindings/mailbox/altera-mailbox.txt
UBUNTU: Ubuntu-5.15.0-39.42
[mirror_ubuntu-jammy-kernel.git] / Documentation / devicetree / bindings / mailbox / altera-mailbox.txt
1 Altera Mailbox Driver
2 =====================
3
4 Required properties:
5 - compatible : "altr,mailbox-1.0".
6 - reg : physical base address of the mailbox and length of
7 memory mapped region.
8 - #mbox-cells: Common mailbox binding property to identify the number
9 of cells required for the mailbox specifier. Should be 1.
10
11 Optional properties:
12 - interrupts : interrupt number. The interrupt specifier format
13 depends on the interrupt controller parent.
14
15 Example:
16 mbox_tx: mailbox@100 {
17 compatible = "altr,mailbox-1.0";
18 reg = <0x100 0x8>;
19 interrupt-parent = < &gic_0 >;
20 interrupts = <5>;
21 #mbox-cells = <1>;
22 };
23
24 mbox_rx: mailbox@200 {
25 compatible = "altr,mailbox-1.0";
26 reg = <0x200 0x8>;
27 interrupt-parent = < &gic_0 >;
28 interrupts = <6>;
29 #mbox-cells = <1>;
30 };
31
32 Mailbox client
33 ===============
34 "mboxes" and the optional "mbox-names" (please see
35 Documentation/devicetree/bindings/mailbox/mailbox.txt for details). Each value
36 of the mboxes property should contain a phandle to the mailbox controller
37 device node and second argument is the channel index. It must be 0 (hardware
38 support only one channel).The equivalent "mbox-names" property value can be
39 used to give a name to the communication channel to be used by the client user.
40
41 Example:
42 mclient0: mclient0@400 {
43 compatible = "client-1.0";
44 reg = <0x400 0x10>;
45 mbox-names = "mbox-tx", "mbox-rx";
46 mboxes = <&mbox_tx 0>,
47 <&mbox_rx 0>;
48 };