Documentation/devicetree/bindings/arm/freescale/fsl,scu.txt

   1 NXP i.MX System Controller Firmware (SCFW)
   2 --------------------------------------------------------------------
   3
   4 The System Controller Firmware (SCFW) is a low-level system function
   5 which runs on a dedicated Cortex-M core to provide power, clock, and
   6 resource management. It exists on some i.MX8 processors. e.g. i.MX8QM
   7 (QM, QP), and i.MX8QX (QXP, DX).
   8
   9 The AP communicates with the SC using a multi-ported MU module found
  10 in the LSIO subsystem. The current definition of this MU module provides
  11 5 remote AP connections to the SC to support up to 5 execution environments
  12 (TZ, HV, standard Linux, etc.). The SC side of this MU module interfaces
  13 with the LSIO DSC IP bus. The SC firmware will communicate with this MU
  14 using the MSI bus.
  15
  16 System Controller Device Node:
  17 ============================================================
  18
  19 The scu node with the following properties shall be under the /firmware/ node.
  20
  21 Required properties:
  22 -------------------
  23 - compatible:   should be "fsl,imx-scu".
  24 - mbox-names:   should include "tx0", "tx1", "tx2", "tx3",
  25                                "rx0", "rx1", "rx2", "rx3";
  26                 include "gip3" if want to support general MU interrupt.
  27 - mboxes:       List of phandle of 4 MU channels for tx, 4 MU channels for
  28                 rx, and 1 optional MU channel for general interrupt.
  29                 All MU channels must be in the same MU instance.
  30                 Cross instances are not allowed. The MU instance can only
  31                 be one of LSIO MU0~M4 for imx8qxp and imx8qm. Users need
  32                 to make sure use the one which is not conflict with other
  33                 execution environments. e.g. ATF.
  34                 Note:
  35                 Channel 0 must be "tx0" or "rx0".
  36                 Channel 1 must be "tx1" or "rx1".
  37                 Channel 2 must be "tx2" or "rx2".
  38                 Channel 3 must be "tx3" or "rx3".
  39                 General interrupt rx channel must be "gip3".
  40                 e.g.
  41                 mboxes = <&lsio_mu1 0 0
  42                           &lsio_mu1 0 1
  43                           &lsio_mu1 0 2
  44                           &lsio_mu1 0 3
  45                           &lsio_mu1 1 0
  46                           &lsio_mu1 1 1
  47                           &lsio_mu1 1 2
  48                           &lsio_mu1 1 3
  49                           &lsio_mu1 3 3>;
  50                 See Documentation/devicetree/bindings/mailbox/fsl,mu.yaml
  51                 for detailed mailbox binding.
  52
  53 Note: Each mu which supports general interrupt should have an alias correctly
  54 numbered in "aliases" node.
  55 e.g.
  56 aliases {
  57         mu1 = &lsio_mu1;
  58 };
  59
  60 i.MX SCU Client Device Node:
  61 ============================================================
  62
  63 Client nodes are maintained as children of the relevant IMX-SCU device node.
  64
  65 RTC bindings based on SCU Message Protocol
  66 ------------------------------------------------------------
  67
  68 Required properties:
  69 - compatible: should be "fsl,imx8qxp-sc-rtc";
  70
  71 Watchdog bindings based on SCU Message Protocol
  72 ------------------------------------------------------------
  73
  74 Required properties:
  75 - compatible: should be:
  76               "fsl,imx8qxp-sc-wdt"
  77               followed by "fsl,imx-sc-wdt";
  78 Optional properties:
  79 - timeout-sec: contains the watchdog timeout in seconds.
  80
  81 Thermal bindings based on SCU Message Protocol
  82 ------------------------------------------------------------
  83
  84 Required properties:
  85 - compatible:                   Should be :
  86                                   "fsl,imx8qxp-sc-thermal"
  87                                 followed by "fsl,imx-sc-thermal";
  88
  89 - #thermal-sensor-cells:        See Documentation/devicetree/bindings/thermal/thermal-sensor.yaml
  90                                 for a description.
  91
  92 Example (imx8qxp):
  93 -------------
  94 aliases {
  95         mu1 = &lsio_mu1;
  96 };
  97
  98 lsio_mu1: mailbox@5d1c0000 {
  99         ...
 100         #mbox-cells = <2>;
 101 };
 102
 103 firmware {
 104         scu {
 105                 compatible = "fsl,imx-scu";
 106                 mbox-names = "tx0", "tx1", "tx2", "tx3",
 107                              "rx0", "rx1", "rx2", "rx3",
 108                              "gip3";
 109                 mboxes = <&lsio_mu1 0 0
 110                           &lsio_mu1 0 1
 111                           &lsio_mu1 0 2
 112                           &lsio_mu1 0 3
 113                           &lsio_mu1 1 0
 114                           &lsio_mu1 1 1
 115                           &lsio_mu1 1 2
 116                           &lsio_mu1 1 3
 117                           &lsio_mu1 3 3>;
 118
 119                 rtc: rtc {
 120                         compatible = "fsl,imx8qxp-sc-rtc";
 121                 };
 122
 123                 watchdog {
 124                         compatible = "fsl,imx8qxp-sc-wdt", "fsl,imx-sc-wdt";
 125                         timeout-sec = <60>;
 126                 };
 127
 128                 tsens: thermal-sensor {
 129                         compatible = "fsl,imx8qxp-sc-thermal", "fsl,imx-sc-thermal";
 130                         #thermal-sensor-cells = <1>;
 131                 };
 132         };
 133 };
 134
 135 serial@5a060000 {
 136         ...
 137 };