Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:18 as permitted sender) client-ip=2620:137:e000::1:18;
From:   Abel Vesa <abel.vesa@nxp.com>
To:     Rob Herring <robh@kernel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>,
        Dmitry Torokhov <dmitry.torokhov@gmail.com>,
        Srinivas Kandagatla <srinivas.kandagatla@linaro.org>,
        Dong Aisheng <aisheng.dong@nxp.com>,
        Shawn Guo <shawnguo@kernel.org>,
        Linus Walleij <linus.walleij@linaro.org>,
        Alexandre Belloni <alexandre.belloni@bootlin.com>,
        "Rafael J. Wysocki" <rjw@rjwysocki.net>,
        Guenter Roeck <linux@roeck-us.net>
Cc:     Stephen Boyd <sboyd@kernel.org>,
        Pengutronix Kernel Team <kernel@pengutronix.de>,
        devicetree@vger.kernel.org,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
        NXP Linux Team <linux-imx@nxp.com>,
        linux-clk@vger.kernel.org, linux-input@vger.kernel.org,
        linux-gpio@vger.kernel.org, linux-rtc@vger.kernel.org,
        linux-pm@vger.kernel.org, linux-watchdog@vger.kernel.org
Subject: [PATCH v2 01/10] dt-bindings: firmware: Add fsl,scu yaml file
Date:   Wed,  8 Jun 2022 19:49:19 +0300
Message-Id: <20220608164928.2706697-2-abel.vesa@nxp.com>
In-Reply-To: <20220608164928.2706697-1-abel.vesa@nxp.com>
References: <20220608164928.2706697-1-abel.vesa@nxp.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?9/MSmKtOmPgdc9HaevtVlKDIc+gfWw0KhucihjhqyuBLTftWvqgx/uOp/LfF?=
 =?us-ascii?Q?l3mD+BFE9lfoR0Q2EMFyJcAjcPpa71AH9uKfKtP8hysWoGIia3x1oQGACQ9l?=
 =?us-ascii?Q?kpsZSMRni8D+mUsSAc0SbgNnyOOLIcj5NcLJGbn6nTdTmXY1pvLFiWZfKcAM?=
 =?us-ascii?Q?pOurPz0jx5bcGvf8NiVW4bGsabwE1uGzc8WMXBqqkst/6Swrjfi3ppHrjbgp?=
 =?us-ascii?Q?cEAytGtxAzCimuOJ3+rgciZJWE/nAebcYeglW7iSa5T3oLxQkvrLkQX1ztf7?=
 =?us-ascii?Q?CZCvrCjrcWgfVa1JL37MGVpsE2LC44nvPtN/puerZQH8+LoSWXkMTuLt+fOD?=
 =?us-ascii?Q?G6oSJj3tFUnk5bmrAnDp3XPQTUWVhS2jazS4OHkxKL8ByOm3ZBZu+TJYQTUx?=
 =?us-ascii?Q?pvcY7mUviBUJZUzZF89VRpSUvh0h5zZQnGBYvKpeEU88f8EgVFS73sxdBFYL?=
 =?us-ascii?Q?Ppm5Cv5ceKBGL8CNwA9beR36X6CywFjCGZNjBvIUkl5/4WADH0NxV4DatOXa?=
 =?us-ascii?Q?XFezz2OZXxV+NpUJx1LcwD/cr4CwsLGrpl7mO18C7LqvPcFmaTtHuPiOhNTO?=
 =?us-ascii?Q?U/VTQtuNhtTY3hVnjlZEchwhQmCouV0NgXUbSPxRI/o3jmybWLhkmK2NsFdb?=
 =?us-ascii?Q?2OpZkk7pbA5mzRROWRY+i87y8moSvxFi3raT/HhLaLQhkQjKWS9rWPVsBlb5?=
 =?us-ascii?Q?btoymsScEQ02QcDzbF/Nu++6whs6NiWBwvF/BCkwtBl5Dam3EgAX38pBnUDa?=
 =?us-ascii?Q?Ii928gJAMbergi+RQgI1+kW31RDbIK033TX+x3m6R2oXMm9z4HDXZVbtiUQh?=
 =?us-ascii?Q?gAdmzkiat2IAGbCw8Znn6iwchbBQ9UABu2nJ3eSRGZ9ffISm1aBD9htLdqUg?=
 =?us-ascii?Q?Wui1oFknAwIP7FJ/UdfL+MPgPLSE9TPcte7hHk+ow74h+vcc7Ub9iauc2Qq3?=
 =?us-ascii?Q?xAYMGR71zwup9P+D17djVuz3ejzTyBYIwL+ctFXMFnBn/WbrAG9iCCU8dSEz?=
 =?us-ascii?Q?DnF3lkRASOZJPYDkgX2/hWHhYBDSgntMyERpVZfec8/mu9noZUP1+l0lv3Qf?=
 =?us-ascii?Q?AOowb73MHajIdQJfoaG0+VY6zeQlPecqkFUEWR26WebknII/LRQWSzbAUQzz?=
 =?us-ascii?Q?rfRhWyEH39IEpJXgSgavK7GJP36T5JZdLuzfAtp4pvq0BkpSrITxgpuRjR9L?=
 =?us-ascii?Q?ZHtdV4InZSPAQs6ORFRusgq+g8gEakwqfOYst4pFedezKqND4ElzUhycsbP9?=
 =?us-ascii?Q?nJBXLgGGn2jC+bYdXrQRuI9eYrTQaDesoSmwWKXg5VzaZTAxrbZQs4JGyNtT?=
 =?us-ascii?Q?m/jM7nZc0yUVmEzYGML7OMZ3c54iI4U0PILRplP3/3vt23U/0dTd6rII6IhF?=
 =?us-ascii?Q?RucDzPJXZvuv1rxBiHGnlZUYob1V49DCEihQlP40p18eGoqdWEyzwxsg8dzn?=
 =?us-ascii?Q?ton/ub27bhvf/vhHOR4o5jT7c3c3lLAjB5Um5OA/QIbVQbVs49YkeMr9vTJs?=
 =?us-ascii?Q?6Adp9OZdY6UKE99E+dwOeQ6WRg+kjq2+bfUc/sZ01KC+DfsP+UrQ+sI/xUFq?=
 =?us-ascii?Q?RhwTqHGge4BXZ3JFGF+h0RnyXUS41CnL8g/CwYF1fejvYoJdHjltmOBwFV+l?=
 =?us-ascii?Q?lkSDWRiaPp7j5T2DrBxNZ5jFnJnDhKsDPw6+Gmn6YCW5TU43D2zsGQTq51WJ?=
 =?us-ascii?Q?tvI8jLt4kvxIT3greLUaaZNcPck2yai7dwdH7VXqFVgFwofrTjYmz17/5Twn?=
 =?us-ascii?Q?VqNiyCMzhg=3D=3D?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 243c60d4-e0e6-46ce-32c5-08da496ee371
X-MS-Exchange-CrossTenant-AuthSource: VI1PR04MB4688.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 08 Jun 2022 16:49:43.9610
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: q7H+2PY7sT/ZbPECRNy6LrzGMmbnXBRNeFLCOFQVn1yN3S4mBTPBUYSjCwY4iltOD++glJb4wgTdWFiLjSBcmA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DBAPR04MB7431
X-Spam-Status: No, score=-2.0 required=5.0 tests=BAYES_00,DKIM_SIGNED,
	DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,
	MAILING_LIST_MULTI,RDNS_NONE,SPF_HELO_NONE,T_SCC_BODY_TEXT_LINE
	autolearn=no autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
	lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

In order to replace the fsl,scu txt file from bindings/arm/freescale,
we need to split it between the right subsystems. This patch adds the
fsl,scu.yaml in the firmware bindings folder. This one is only for
the main SCU node. The old txt file will be removed only after all
the child nodes have been properly switch to yaml.

Signed-off-by: Abel Vesa <abel.vesa@nxp.com>
---
 .../devicetree/bindings/firmware/fsl,scu.yaml | 162 ++++++++++++++++++
 1 file changed, 162 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/firmware/fsl,scu.yaml

diff --git a/Documentation/devicetree/bindings/firmware/fsl,scu.yaml b/Documentation/devicetree/bindings/firmware/fsl,scu.yaml
new file mode 100644
index 000000000000..d0610887e80c
--- /dev/null
+++ b/Documentation/devicetree/bindings/firmware/fsl,scu.yaml
@@ -0,0 +1,162 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/firmware/fsl,scu.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: NXP i.MX System Controller Firmware (SCFW)
+
+maintainers:
+  - Shawn Guo <shawnguo@kernel.org>
+
+description: System Controller Device Node
+  The System Controller Firmware (SCFW) is a low-level system function
+  which runs on a dedicated Cortex-M core to provide power, clock, and
+  resource management. It exists on some i.MX8 processors. e.g. i.MX8QM
+  (QM, QP), and i.MX8QX (QXP, DX).
+  The AP communicates with the SC using a multi-ported MU module found
+  in the LSIO subsystem. The current definition of this MU module provides
+  5 remote AP connections to the SC to support up to 5 execution environments
+  (TZ, HV, standard Linux, etc.). The SC side of this MU module interfaces
+  with the LSIO DSC IP bus. The SC firmware will communicate with this MU
+  using the MSI bus.
+
+properties:
+  $nodename:
+    const: 'scu'
+
+  compatible:
+    const: fsl,imx-scu
+
+  clock-controller:
+    description: |
+      Clock controller node that provides the clocks controlled by the SCU
+
+  imx8qx-ocotp:
+    description: |
+      OCOTP controller node provided by the SCU
+
+  keys:
+    description: |
+      Keys provided by the SCU
+
+  mboxes:
+    description: |
+      $ref: /schemas/mailbox/fsl,mu.yaml
+      List of phandle of 4 MU channels for tx, 4 MU channels for
+      rx, and 1 optional MU channel for general interrupt.
+      All MU channels must be in the same MU instance.
+      Cross instances are not allowed. The MU instance can only
+      be one of LSIO MU0~M4 for imx8qxp and imx8qm. Users need
+      to make sure use the one which is not conflict with other
+      execution environments. e.g. ATF.
+    minItems: 1
+    maxItems: 10
+
+  mbox-names:
+    description:
+      include "gip3" if want to support general MU interrupt.
+    minItems: 1
+    maxItems: 10
+
+  pinctrl:
+    description: |
+      Pin controller provided by the SCU
+
+  power-controller:
+    description: |
+      Power domains controller node that provides the power domains
+      controlled by the SCU
+
+  rtc:
+    description: |
+      RTC controller provided by the SCU
+
+  thermal-sensor:
+    description: |
+      Thermal sensor provided by the SCU
+
+  watchdog:
+    description: |
+      Watchdog controller provided by the SCU
+
+required:
+  - compatible
+  - mbox-names
+  - mboxes
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/firmware/imx/rsrc.h>
+    #include <dt-bindings/input/input.h>
+    #include <dt-bindings/pinctrl/pads-imx8qxp.h>
+
+    firmware {
+           scu {
+                   compatible = "fsl,imx-scu";
+                   mbox-names = "tx0", "tx1", "tx2", "tx3",
+                                "rx0", "rx1", "rx2", "rx3",
+                                "gip3";
+                   mboxes = <&lsio_mu1 0 0
+                            &lsio_mu1 0 1
+                            &lsio_mu1 0 2
+                            &lsio_mu1 0 3
+                            &lsio_mu1 1 0
+                            &lsio_mu1 1 1
+                            &lsio_mu1 1 2
+                            &lsio_mu1 1 3
+                            &lsio_mu1 3 3>;
+
+                   clock-controller {
+                            compatible = "fsl,imx8qxp-clk", "fsl,scu-clk";
+                            #clock-cells = <2>;
+                   };
+
+                   pinctrl {
+                            compatible = "fsl,imx8qxp-iomuxc";
+
+                            pinctrl_lpuart0: lpuart0grp {
+                                   fsl,pins = <
+                                           IMX8QXP_UART0_RX_ADMA_UART0_RX   0x06000020
+                                           IMX8QXP_UART0_TX_ADMA_UART0_TX   0x06000020
+                                   >;
+                            };
+                   };
+
+                   imx8qx-ocotp {
+                            compatible = "fsl,imx8qxp-scu-ocotp";
+                            #address-cells = <1>;
+                            #size-cells = <1>;
+
+                            fec_mac0: mac@2c4 {
+                                   reg = <0x2c4 6>;
+                            };
+                   };
+
+                   power-controller {
+                            compatible = "fsl,imx8qxp-scu-pd", "fsl,scu-pd";
+                            #power-domain-cells = <1>;
+                   };
+
+                   rtc {
+                            compatible = "fsl,imx8qxp-sc-rtc";
+                   };
+
+                   keys {
+                            compatible = "fsl,imx8qxp-sc-key", "fsl,imx-sc-key";
+                            linux,keycodes = <KEY_POWER>;
+                   };
+
+                   watchdog {
+                            compatible = "fsl,imx8qxp-sc-wdt", "fsl,imx-sc-wdt";
+                            timeout-sec = <60>;
+                   };
+
+                   thermal-sensor {
+                            compatible = "fsl,imx8qxp-sc-thermal", "fsl,imx-sc-thermal";
+                            #thermal-sensor-cells = <1>;
+                   };
+            };
+    };
-- 
2.34.3