xref: /linux/Documentation/devicetree/bindings/mailbox/brcm,iproc-flexrm-mbox.yaml (revision db4a3f0fbedb0398f77b9047e8b8bb2b49f355bb)
1# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/mailbox/brcm,iproc-flexrm-mbox.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Broadcom FlexRM Ring Manager
8
9maintainers:
10  - Ray Jui <rjui@broadcom.com>
11  - Scott Branden <sbranden@broadcom.com>
12
13description:
14  The Broadcom FlexRM ring manager provides a set of rings which can be used to
15  submit work to offload engines. An SoC may have multiple FlexRM hardware
16  blocks. There is one device tree entry per FlexRM block. The FlexRM driver
17  will create a mailbox-controller instance for given FlexRM hardware block
18  where each mailbox channel is a separate FlexRM ring.
19
20properties:
21  compatible:
22    const: brcm,iproc-flexrm-mbox
23
24  reg:
25    maxItems: 1
26
27  msi-parent:
28    maxItems: 1
29
30  '#mbox-cells':
31    description: >
32      The 1st cell is the mailbox channel number.
33
34      The 2nd cell contains MSI completion threshold. This is the number of
35      completion messages for which FlexRM will inject one MSI interrupt to CPU.
36
37      The 3rd cell contains MSI timer value representing time for which FlexRM
38      will wait to accumulate N completion messages where N is the value
39      specified by 2nd cell above. If FlexRM does not get required number of
40      completion messages in time specified by this cell then it will inject one
41      MSI interrupt to CPU provided at least one completion message is
42      available.
43    const: 3
44
45  dma-coherent: true
46
47required:
48  - compatible
49  - reg
50  - msi-parent
51  - '#mbox-cells'
52
53additionalProperties: false
54
55examples:
56  - |
57    mailbox@67000000 {
58        compatible = "brcm,iproc-flexrm-mbox";
59        reg = <0x67000000 0x200000>;
60        msi-parent = <&gic_its 0x7f00>;
61        #mbox-cells = <3>;
62        dma-coherent;
63    };
64