Documentation/devicetree/bindings/mailbox/fsl,mu.txt

   1 NXP i.MX Messaging Unit (MU)
   2 --------------------------------------------------------------------
   3
   4 The Messaging Unit module enables two processors within the SoC to
   5 communicate and coordinate by passing messages (e.g. data, status
   6 and control) through the MU interface. The MU also provides the ability
   7 for one processor to signal the other processor using interrupts.
   8
   9 Because the MU manages the messaging between processors, the MU uses
  10 different clocks (from each side of the different peripheral buses).
  11 Therefore, the MU must synchronize the accesses from one side to the
  12 other. The MU accomplishes synchronization using two sets of matching
  13 registers (Processor A-facing, Processor B-facing).
  14
  15 Messaging Unit Device Node:
  16 =============================
  17
  18 Required properties:
  19 -------------------
  20 - compatible :  should be "fsl,<chip>-mu", the supported chips include
  21                 imx6sx, imx7s, imx8qxp, imx8qm.
  22                 The "fsl,imx6sx-mu" compatible is seen as generic and should
  23                 be included together with SoC specific compatible.
  24                 There is a version 1.0 MU on imx7ulp, use "fsl,imx7ulp-mu"
  25                 compatible to support it.
  26                 To communicate with i.MX8 SCU, "fsl,imx8-mu-scu" could be
  27                 used for fast IPC
  28 - reg :         Should contain the registers location and length
  29 - interrupts :  Interrupt number. The interrupt specifier format depends
  30                 on the interrupt controller parent.
  31 - #mbox-cells:  Must be 2.
  32                           <&phandle type channel>
  33                             phandle   : Label name of controller
  34                             type      : Channel type
  35                             channel   : Channel number
  36
  37                 This MU support 4 type of unidirectional channels, each type
  38                 has 4 channels. A total of 16 channels. Following types are
  39                 supported:
  40                 0 - TX channel with 32bit transmit register and IRQ transmit
  41                 acknowledgment support.
  42                 1 - RX channel with 32bit receive register and IRQ support
  43                 2 - TX doorbell channel. Without own register and no ACK support.
  44                 3 - RX doorbell channel.
  45
  46 Optional properties:
  47 -------------------
  48 - clocks :      phandle to the input clock.
  49 - fsl,mu-side-b : Should be set for side B MU.
  50
  51 Examples:
  52 --------
  53 lsio_mu0: mailbox@5d1b0000 {
  54         compatible = "fsl,imx8qxp-mu";
  55         reg = <0x0 0x5d1b0000 0x0 0x10000>;
  56         interrupts = <GIC_SPI 176 IRQ_TYPE_LEVEL_HIGH>;
  57         #mbox-cells = <2>;
  58 };