dt-bindings: mailbox: Add the Spreadtrum mailbox documentation
[linux-2.6-microblaze.git] / Documentation / devicetree / bindings / mailbox / sprd-mailbox.yaml
1 # SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2 %YAML 1.2
3 ---
4 $id: "http://devicetree.org/schemas/mailbox/sprd-mailbox.yaml#"
5 $schema: "http://devicetree.org/meta-schemas/core.yaml#"
6
7 title: Spreadtrum mailbox controller bindings
8
9 maintainers:
10   - Orson Zhai <orsonzhai@gmail.com>
11   - Baolin Wang <baolin.wang7@gmail.com>
12   - Chunyan Zhang <zhang.lyra@gmail.com>
13
14 properties:
15   compatible:
16     enum:
17       - sprd,sc9860-mailbox
18
19   reg:
20     items:
21       - description: inbox registers' base address
22       - description: outbox registers' base address
23
24   interrupts:
25     items:
26       - description: inbox interrupt
27       - description: outbox interrupt
28
29   clocks:
30     maxItems: 1
31
32   clock-names:
33     items:
34       - const: enable
35
36   "#mbox-cells":
37     const: 1
38
39 required:
40   - compatible
41   - reg
42   - interrupts
43   - "#mbox-cells"
44   - clocks
45   - clock-names
46
47 additionalProperties: false
48
49 examples:
50   - |
51     #include <dt-bindings/interrupt-controller/arm-gic.h>
52     mailbox: mailbox@400a0000 {
53       compatible = "sprd,sc9860-mailbox";
54       reg = <0 0x400a0000 0 0x8000>, <0 0x400a8000 0 0x8000>;
55       #mbox-cells = <1>;
56       clock-names = "enable";
57       clocks = <&aon_gate 53>;
58       interrupts = <GIC_SPI 28 IRQ_TYPE_LEVEL_HIGH>, <GIC_SPI 29 IRQ_TYPE_LEVEL_HIGH>;
59     };
60 ...