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

   1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/mailbox/fsl,mu.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: NXP i.MX Messaging Unit (MU)
   8
   9 maintainers:
  10   - Dong Aisheng <aisheng.dong@nxp.com>
  11
  12 description: |
  13   The Messaging Unit module enables two processors within the SoC to
  14   communicate and coordinate by passing messages (e.g. data, status
  15   and control) through the MU interface. The MU also provides the ability
  16   for one processor to signal the other processor using interrupts.
  17
  18   Because the MU manages the messaging between processors, the MU uses
  19   different clocks (from each side of the different peripheral buses).
  20   Therefore, the MU must synchronize the accesses from one side to the
  21   other. The MU accomplishes synchronization using two sets of matching
  22   registers (Processor A-facing, Processor B-facing).
  23
  24 properties:
  25   compatible:
  26     oneOf:
  27       - const: fsl,imx6sx-mu
  28       - const: fsl,imx7ulp-mu
  29       - const: fsl,imx8ulp-mu
  30       - const: fsl,imx8-mu-scu
  31       - items:
  32           - enum:
  33               - fsl,imx7s-mu
  34               - fsl,imx8mq-mu
  35               - fsl,imx8mm-mu
  36               - fsl,imx8mn-mu
  37               - fsl,imx8mp-mu
  38               - fsl,imx8qm-mu
  39               - fsl,imx8qxp-mu
  40           - const: fsl,imx6sx-mu
  41       - description: To communicate with i.MX8 SCU with fast IPC
  42         items:
  43           - const: fsl,imx8-mu-scu
  44           - enum:
  45               - fsl,imx8qm-mu
  46               - fsl,imx8qxp-mu
  47           - const: fsl,imx6sx-mu
  48
  49   reg:
  50     maxItems: 1
  51
  52   interrupts:
  53     maxItems: 1
  54
  55   "#mbox-cells":
  56     description: |
  57       <&phandle type channel>
  58       phandle   : Label name of controller
  59       type      : Channel type
  60       channel   : Channel number
  61
  62       This MU support 4 type of unidirectional channels, each type
  63       has 4 channels. A total of 16 channels. Following types are
  64       supported:
  65       0 - TX channel with 32bit transmit register and IRQ transmit
  66           acknowledgment support.
  67       1 - RX channel with 32bit receive register and IRQ support
  68       2 - TX doorbell channel. Without own register and no ACK support.
  69       3 - RX doorbell channel.
  70     const: 2
  71
  72   clocks:
  73     maxItems: 1
  74
  75   fsl,mu-side-b:
  76     description: boolean, if present, means it is for side B MU.
  77     type: boolean
  78
  79   power-domains:
  80     maxItems: 1
  81
  82 required:
  83   - compatible
  84   - reg
  85   - interrupts
  86   - "#mbox-cells"
  87
  88 additionalProperties: false
  89
  90 examples:
  91   - |
  92     #include <dt-bindings/interrupt-controller/arm-gic.h>
  93
  94     mailbox@5d1b0000 {
  95         compatible = "fsl,imx8qxp-mu", "fsl,imx6sx-mu";
  96         reg = <0x5d1b0000 0x10000>;
  97         interrupts = <GIC_SPI 176 IRQ_TYPE_LEVEL_HIGH>;
  98         #mbox-cells = <2>;
  99     };