Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Frank Li <Frank.Li@nxp.com>
To:     maz@kernel.org, tglx@linutronix.de, robh+dt@kernel.org,
        krzysztof.kozlowski+dt@linaro.org, shawnguo@kernel.org,
        s.hauer@pengutronix.de, kw@linux.com, bhelgaas@google.com
Cc:     linux-kernel@vger.kernel.org, devicetree@vger.kernel.org,
        linux-arm-kernel@lists.infradead.org, linux-pci@vger.kernel.org,
        peng.fan@nxp.com, aisheng.dong@nxp.com, jdmason@kudzu.us,
        kernel@pengutronix.de, festevam@gmail.com, linux-imx@nxp.com,
        kishon@ti.com, lorenzo.pieralisi@arm.com, ntb@lists.linux.dev,
        lznuaa@gmail.com, imx@lists.linux.dev,
        manivannan.sadhasivam@linaro.org
Subject: [PATCH v9 3/4] dt-bindings: irqchip: imx mu work as msi controller
Date:   Tue,  6 Sep 2022 22:48:55 -0500
Message-Id: <20220907034856.3101570-4-Frank.Li@nxp.com>
In-Reply-To: <20220907034856.3101570-1-Frank.Li@nxp.com>
References: <20220907034856.3101570-1-Frank.Li@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?JGWkWoXChQd8iWBh7cXTecVXswlbSCxiv5NIklWJ4H66a2yP54U66fYR/jkI?=
 =?us-ascii?Q?frhpsutoZcVBIX/DILY4w6fr/obwtG+bKH7V4aqSRBamcVD9A/EskBzs3Ftv?=
 =?us-ascii?Q?Lt7A1o97GOfm5U8/AnONut0CHl7+fZLtE16n6KOoOju5bUIcSNPBv5Uu1yuI?=
 =?us-ascii?Q?uK2yIQCB3cad4OaX1eX9g3NoiUwESrxecABC7EUSzvnrvisJz/qJKpvsFgYI?=
 =?us-ascii?Q?mTykeH/1OGncHUnglespa+WuxN14STjZ1QswPwz8e+/22nOqxbAzY3E/5WxV?=
 =?us-ascii?Q?AaRF6PK8srNh5HsgDFptCiyJKAm249BGfsoF+SwITnUqQfEIVHxHQ+YWtnEn?=
 =?us-ascii?Q?rhvMZ/vmgyj5lrAP4PqsoWbwjmH+Rc8IffAhIpgu98l5gI4p5O4MqyfDINRM?=
 =?us-ascii?Q?fBi67LmKGbs6P5WAxqvx2lJk3EjBVDXBK+FxHryPffiL3jqvqFbXEg9W81hy?=
 =?us-ascii?Q?ginY9mbqO1wRXzKiA73HROL7/+76LeM4Ga/kFIpqPzdQOm5jb1IYWtZ26N+5?=
 =?us-ascii?Q?STJvJrzglvQ6JdqMCE88FB0fx7Te5IZBlH95DulWl9sG9SWJTtWIg2qD+ZiP?=
 =?us-ascii?Q?Y/RDBCFZ+Pq+5o8gmRM9zUH1W2BOfHgSLkR2Hj+nsiy4EQKlmuBsLqctlVE5?=
 =?us-ascii?Q?SAB/TyuL4tvY/YmwPXz/treMLa7ljLzrh/wP4M/tHOqYDe1rjFsQ2aE5/Aur?=
 =?us-ascii?Q?s1J5fQiEU31GvurKI340rTbj07Jowa7W9hov9rmUsqWWhDOM9i5TnoGesM2y?=
 =?us-ascii?Q?ZRx/6IMEKeRUD1BiayviISA/vRbQZjbwVhur9ZQsaxB2A9CiL/WAZZl3C+yI?=
 =?us-ascii?Q?oY3VXQW4usM34vZLkMuODIOhYExPAosCAT0sEIbfbakxpZbPBFycsYsFzNgk?=
 =?us-ascii?Q?Njh/kZFtHnaCywM6vgnyIXNXKbe1mje90PoV0vs1VgZk+tKFr28RwY9Ifj8O?=
 =?us-ascii?Q?CQ9Zx/WFSDgt748FCi8xOU0fPDPwS3lH7OcmU94RnudDhc31nt5ha6bf4UnP?=
 =?us-ascii?Q?B59N+rFnbJdurLaYupSinjkq94jGcfT7Kn+AQwA2uwMp3+DCDkzOyN5gPKGC?=
 =?us-ascii?Q?5uJL+gqpHGJeX2UDx+oZ+FGybv+Up3vJixNGym3pMA9DQlSgHO8M23AARLno?=
 =?us-ascii?Q?7ZKUdScaTne3uhE3Uqz44EOJNsZPTYawCKE1/JfS8YXiyurxUiU/IzhSofqK?=
 =?us-ascii?Q?9TBlGJ3/Q9Ytv0rAO6M8uxfxUN+8Wf3jQozaZfwX8Tg3C0JG2dLFX+3f+0jW?=
 =?us-ascii?Q?fRrHoPnIREKg0VvH8ujGzX4P94e6xjt5+7HFXHxS5Ckra+73cN2X5Dl1lt1Y?=
 =?us-ascii?Q?j3c2g7vWU1dV5nfVxHVETpHqDrZrorQI6nUeKCCG8eHo00gVBAEajv93RhqI?=
 =?us-ascii?Q?56+PjHrpltNBnJzJn6D7z4YRoFggVvGWbMpyuhFSxF+eMCcgcnY5x/zpzRYa?=
 =?us-ascii?Q?gws4yaOGtmylOhhkqUcncB2gB90yO5dRJMaEIp2KNzPBxhXCK8aowygQla3u?=
 =?us-ascii?Q?DBQfi6GsrYpmwFihy78ot6BEP1rbkzVSM6+tpzP4cWX46EQalXAs5vN8SRHX?=
 =?us-ascii?Q?AmAb5Z8v7KW3ebO+YUHFyTjUqeIHHiNF+FjYCiZT?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 0264d195-b134-4a70-465d-08da9083f948
X-MS-Exchange-CrossTenant-AuthSource: AM9PR04MB8793.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 07 Sep 2022 03:49:32.5600
 (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: J50EXX7Xdq7Cftl5xmYTe1yTEWa9q1iA8CVaVu3ZVwqVEiR0kUXaC1XvvfADPjrp3wfKmqJQBcLzsD7L1VMH+Q==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: VE1PR04MB7453
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS,T_SCC_BODY_TEXT_LINE
        autolearn=ham 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

I.MX mu support generate irq by write a register. Provide msi controller
support so other driver such as PCI EP can use it by standard msi
interface as doorbell.

Signed-off-by: Frank Li <Frank.Li@nxp.com>
---
 .../interrupt-controller/fsl,mu-msi.yaml      | 99 +++++++++++++++++++
 1 file changed, 99 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/interrupt-controller/fsl,mu-msi.yaml

diff --git a/Documentation/devicetree/bindings/interrupt-controller/fsl,mu-msi.yaml b/Documentation/devicetree/bindings/interrupt-controller/fsl,mu-msi.yaml
new file mode 100644
index 0000000000000..799ae5c3e32ae
--- /dev/null
+++ b/Documentation/devicetree/bindings/interrupt-controller/fsl,mu-msi.yaml
@@ -0,0 +1,99 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/interrupt-controller/fsl,mu-msi.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Freescale/NXP i.MX Messaging Unit (MU) work as msi controller
+
+maintainers:
+  - Frank Li <Frank.Li@nxp.com>
+
+description: |
+  The Messaging Unit module enables two processors within the SoC to
+  communicate and coordinate by passing messages (e.g. data, status
+  and control) through the MU interface. The MU also provides the ability
+  for one processor (A side) to signal the other processor (B side) using
+  interrupts.
+
+  Because the MU manages the messaging between processors, the MU uses
+  different clocks (from each side of the different peripheral buses).
+  Therefore, the MU must synchronize the accesses from one side to the
+  other. The MU accomplishes synchronization using two sets of matching
+  registers (Processor A-side, Processor B-side).
+
+  MU can work as msi interrupt controller to do doorbell
+
+allOf:
+  - $ref: /schemas/interrupt-controller/msi-controller.yaml#
+
+properties:
+  compatible:
+    enum:
+      - fsl,imx6sx-mu-msi
+      - fsl,imx7ulp-mu-msi
+      - fsl,imx8ulp-mu-msi
+      - fsl,imx8ulp-mu-msi-s4
+
+  reg:
+    items:
+      - description: a side register base address
+      - description: b side register base address
+
+  reg-names:
+    items:
+      - const: processor-a-side
+      - const: processor-b-side
+
+  interrupts:
+    description: a side interrupt number.
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  power-domains:
+    items:
+      - description: a side power domain
+      - description: b side power domain
+
+  power-domain-names:
+    items:
+      - const: processor-a-side
+      - const: processor-b-side
+
+  interrupt-controller: true
+
+  msi-controller: true
+
+  "#msi-cells":
+    const: 0
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - interrupt-controller
+  - msi-controller
+  - "#msi-cells"
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/firmware/imx/rsrc.h>
+
+    msi-controller@5d270000 {
+        compatible = "fsl,imx6sx-mu-msi";
+        msi-controller;
+        #msi-cells = <0>;
+        interrupt-controller;
+        reg = <0x5d270000 0x10000>,     /* A side */
+              <0x5d300000 0x10000>;     /* B side */
+        reg-names = "processor-a-side", "processor-b-side";
+        interrupts = <GIC_SPI 191 IRQ_TYPE_LEVEL_HIGH>;
+        power-domains = <&pd IMX_SC_R_MU_12A>,
+                        <&pd IMX_SC_R_MU_12B>;
+        power-domain-names = "processor-a-side", "processor-b-side";
+    };
-- 
2.35.1