Linux-libre 5.3.12-gnu
[librecmc/linux-libre.git] / Documentation / devicetree / bindings / mailbox / ti,secure-proxy.txt
1 Texas Instruments' Secure Proxy
2 ========================================
3
4 The Texas Instruments' secure proxy is a mailbox controller that has
5 configurable queues selectable at SoC(System on Chip) integration. The
6 Message manager is broken up into different address regions that are
7 called "threads" or "proxies" - each instance is unidirectional and is
8 instantiated at SoC integration level by system controller to indicate
9 receive or transmit path.
10
11 Message Manager Device Node:
12 ===========================
13 Required properties:
14 --------------------
15 - compatible:           Shall be "ti,am654-secure-proxy"
16 - reg-names             target_data - Map the proxy data region
17                         rt - Map the realtime status region
18                         scfg - Map the configuration region
19 - reg:                  Contains the register map per reg-names.
20 - #mbox-cells           Shall be 1 and shall refer to the transfer path
21                         called thread.
22 - interrupt-names:      Contains interrupt names matching the rx transfer path
23                         for a given SoC. Receive interrupts shall be of the
24                         format: "rx_<PID>".
25 - interrupts:           Contains the interrupt information corresponding to
26                         interrupt-names property.
27
28 Example(AM654):
29 ------------
30
31         secure_proxy: mailbox@32c00000 {
32                 compatible = "ti,am654-secure-proxy";
33                 #mbox-cells = <1>;
34                 reg-names = "target_data", "rt", "scfg";
35                 reg = <0x0 0x32c00000 0x0 0x100000>,
36                       <0x0 0x32400000 0x0 0x100000>,
37                       <0x0 0x32800000 0x0 0x100000>;
38                 interrupt-names = "rx_011";
39                 interrupts = <GIC_SPI 32 IRQ_TYPE_LEVEL_HIGH>;
40         };
41
42         dmsc: dmsc {
43                 [...]
44                 mbox-names = "rx", "tx";
45                 # RX Thread ID is 11
46                 # TX Thread ID is 13
47                 mboxes= <&secure_proxy 11>,
48                         <&secure_proxy 13>;
49                 [...]
50         };