]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - Documentation/devicetree/bindings/mailbox/altera-mailbox.txt
alpha: osf_sys.c: use timespec64 where appropriate
[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 - interrupt-parent : interrupt source phandle.
13 - interrupts : interrupt number. The interrupt specifier format
14 depends on the interrupt controller parent.
15
16 Example:
17 mbox_tx: mailbox@0x100 {
18 compatible = "altr,mailbox-1.0";
19 reg = <0x100 0x8>;
20 interrupt-parent = < &gic_0 >;
21 interrupts = <5>;
22 #mbox-cells = <1>;
23 };
24
25 mbox_rx: mailbox@0x200 {
26 compatible = "altr,mailbox-1.0";
27 reg = <0x200 0x8>;
28 interrupt-parent = < &gic_0 >;
29 interrupts = <6>;
30 #mbox-cells = <1>;
31 };
32
33 Mailbox client
34 ===============
35 "mboxes" and the optional "mbox-names" (please see
36 Documentation/devicetree/bindings/mailbox/mailbox.txt for details). Each value
37 of the mboxes property should contain a phandle to the mailbox controller
38 device node and second argument is the channel index. It must be 0 (hardware
39 support only one channel).The equivalent "mbox-names" property value can be
40 used to give a name to the communication channel to be used by the client user.
41
42 Example:
43 mclient0: mclient0@0x400 {
44 compatible = "client-1.0";
45 reg = <0x400 0x10>;
46 mbox-names = "mbox-tx", "mbox-rx";
47 mboxes = <&mbox_tx 0>,
48 <&mbox_rx 0>;
49 };