[V7,2/4] firmware: imx: enable imx scu general irq function
diff mbox series

Message ID 1554785675-8090-2-git-send-email-Anson.Huang@nxp.com
State Not Applicable
Headers show
Series
  • [V7,1/4] dt-bindings: fsl: scu: add general interrupt support
Related show

Checks

Context Check Description
robh/checkpatch success

Commit Message

Anson Huang April 9, 2019, 4:59 a.m. UTC
The System Controller Firmware (SCFW) controls RTC, thermal
and WDOG etc., these resources' interrupt function are managed
by SCU. When any IRQ pending, SCU will notify Linux via MU general
interrupt channel #3, and Linux kernel needs to call SCU APIs
to get IRQ status and notify each module to handle the interrupt.

Since there is no data transmission for SCU IRQ notification, so
doorbell mode is used for this MU channel, and SCU driver will
use notifier mechanism to broadcast to every module which registers
the SCU block notifier.

Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
Reviewed-by: Dong Aisheng <aisheng.dong@nxp.com>
---
Changes since V6:
	- improve imx_scu_irq_enable() function name to imx_scu_irq_group_enable();
	- make imx_scu_irq_group_enable() function return int;
---
 drivers/firmware/imx/Makefile      |   2 +-
 drivers/firmware/imx/imx-scu-irq.c | 168 +++++++++++++++++++++++++++++++++++++
 drivers/firmware/imx/imx-scu.c     |   6 ++
 include/linux/firmware/imx/sci.h   |   5 ++
 4 files changed, 180 insertions(+), 1 deletion(-)
 create mode 100644 drivers/firmware/imx/imx-scu-irq.c

Comments

Shawn Guo April 11, 2019, 7:32 a.m. UTC | #1
On Tue, Apr 09, 2019 at 04:59:55AM +0000, Anson Huang wrote:
> The System Controller Firmware (SCFW) controls RTC, thermal
> and WDOG etc., these resources' interrupt function are managed
> by SCU. When any IRQ pending, SCU will notify Linux via MU general
> interrupt channel #3, and Linux kernel needs to call SCU APIs
> to get IRQ status and notify each module to handle the interrupt.
> 
> Since there is no data transmission for SCU IRQ notification, so
> doorbell mode is used for this MU channel, and SCU driver will
> use notifier mechanism to broadcast to every module which registers
> the SCU block notifier.
> 
> Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
> Reviewed-by: Dong Aisheng <aisheng.dong@nxp.com>

Applied, thanks.
Anson Huang April 12, 2019, 1:05 a.m. UTC | #2
Hello, Alexandre
	As i.MX SCU general irq function is picked up by Shawn, could you please also pick up below i.MX SC RTC alarm support patch ?
	https://patchwork.kernel.org/patch/10890525/ 

Best Regards!
Anson Huang

> -----Original Message-----
> From: Shawn Guo [mailto:shawnguo@kernel.org]
> Sent: 2019年4月11日 15:33
> To: Anson Huang <anson.huang@nxp.com>
> Cc: robh+dt@kernel.org; mark.rutland@arm.com; s.hauer@pengutronix.de;
> kernel@pengutronix.de; festevam@gmail.com; a.zummo@towertech.it;
> alexandre.belloni@bootlin.com; Aisheng Dong <aisheng.dong@nxp.com>;
> ulf.hansson@linaro.org; sboyd@kernel.org; Peng Fan <peng.fan@nxp.com>;
> Daniel Baluta <daniel.baluta@nxp.com>; devicetree@vger.kernel.org; linux-
> kernel@vger.kernel.org; linux-arm-kernel@lists.infradead.org; linux-
> rtc@vger.kernel.org; dl-linux-imx <linux-imx@nxp.com>
> Subject: [EXT] Re: [PATCH V7 2/4] firmware: imx: enable imx scu general irq
> function
> 
> WARNING: This email was created outside of NXP. DO NOT CLICK links or
> attachments unless you recognize the sender and know the content is safe.
> 
> 
> 
> On Tue, Apr 09, 2019 at 04:59:55AM +0000, Anson Huang wrote:
> > The System Controller Firmware (SCFW) controls RTC, thermal and WDOG
> > etc., these resources' interrupt function are managed by SCU. When any
> > IRQ pending, SCU will notify Linux via MU general interrupt channel
> > #3, and Linux kernel needs to call SCU APIs to get IRQ status and
> > notify each module to handle the interrupt.
> >
> > Since there is no data transmission for SCU IRQ notification, so
> > doorbell mode is used for this MU channel, and SCU driver will use
> > notifier mechanism to broadcast to every module which registers the
> > SCU block notifier.
> >
> > Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
> > Reviewed-by: Dong Aisheng <aisheng.dong@nxp.com>
> 
> Applied, thanks.
Dong Aisheng April 12, 2019, 2:25 a.m. UTC | #3
> From: Anson Huang
> Sent: Friday, April 12, 2019 9:06 AM
> 
> Hello, Alexandre
> 	As i.MX SCU general irq function is picked up by Shawn, could you please
> also pick up below i.MX SC RTC alarm support patch ?
> 	https://patchwork.kernel.org/patch/10890525/
> 

No, it can't go through Alexandre's tree due to dependency issue.

Shawn,
Do you think you can pick it up? Alexandre already gave the Ack.

AFAIK there's no other SCU RTC patches since v5.1-rc1 in Alexandre's tree.

Regards
Dong Aisheng

> > On Tue, Apr 09, 2019 at 04:59:55AM +0000, Anson Huang wrote:
> > > The System Controller Firmware (SCFW) controls RTC, thermal and WDOG
> > > etc., these resources' interrupt function are managed by SCU. When
> > > any IRQ pending, SCU will notify Linux via MU general interrupt
> > > channel #3, and Linux kernel needs to call SCU APIs to get IRQ
> > > status and notify each module to handle the interrupt.
> > >
> > > Since there is no data transmission for SCU IRQ notification, so
> > > doorbell mode is used for this MU channel, and SCU driver will use
> > > notifier mechanism to broadcast to every module which registers the
> > > SCU block notifier.
> > >
> > > Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
> > > Reviewed-by: Dong Aisheng <aisheng.dong@nxp.com>
> >
> > Applied, thanks.
Anson Huang April 12, 2019, 2:32 a.m. UTC | #4
Best Regards!
Anson Huang

> -----Original Message-----
> From: Aisheng Dong
> Sent: 2019年4月12日 10:26
> To: Anson Huang <anson.huang@nxp.com>; Shawn Guo
> <shawnguo@kernel.org>; alexandre.belloni@bootlin.com
> Cc: robh+dt@kernel.org; mark.rutland@arm.com; s.hauer@pengutronix.de;
> kernel@pengutronix.de; festevam@gmail.com; a.zummo@towertech.it;
> alexandre.belloni@bootlin.com; ulf.hansson@linaro.org; sboyd@kernel.org;
> Peng Fan <peng.fan@nxp.com>; Daniel Baluta <daniel.baluta@nxp.com>;
> devicetree@vger.kernel.org; linux-kernel@vger.kernel.org; linux-arm-
> kernel@lists.infradead.org; linux-rtc@vger.kernel.org; dl-linux-imx <linux-
> imx@nxp.com>
> Subject: RE: [EXT] Re: [PATCH V7 2/4] firmware: imx: enable imx scu general
> irq function
> 
> > From: Anson Huang
> > Sent: Friday, April 12, 2019 9:06 AM
> >
> > Hello, Alexandre
> > 	As i.MX SCU general irq function is picked up by Shawn, could you
> > please also pick up below i.MX SC RTC alarm support patch ?
> > 	https://patchwork.kernel.org/patch/10890525/
> >
> 
> No, it can't go through Alexandre's tree due to dependency issue.
> 
> Shawn,
> Do you think you can pick it up? Alexandre already gave the Ack.
> 
> AFAIK there's no other SCU RTC patches since v5.1-rc1 in Alexandre's tree.

Yes, need to make sure the dependency is handled, the RTC alarm patch MUST be picked up
ONLY when scu irq patch is ready, NOT sure how to handle this case for such scenario?

Anson.

> 
> Regards
> Dong Aisheng
> 
> > > On Tue, Apr 09, 2019 at 04:59:55AM +0000, Anson Huang wrote:
> > > > The System Controller Firmware (SCFW) controls RTC, thermal and
> > > > WDOG etc., these resources' interrupt function are managed by SCU.
> > > > When any IRQ pending, SCU will notify Linux via MU general
> > > > interrupt channel #3, and Linux kernel needs to call SCU APIs to
> > > > get IRQ status and notify each module to handle the interrupt.
> > > >
> > > > Since there is no data transmission for SCU IRQ notification, so
> > > > doorbell mode is used for this MU channel, and SCU driver will use
> > > > notifier mechanism to broadcast to every module which registers
> > > > the SCU block notifier.
> > > >
> > > > Signed-off-by: Anson Huang <Anson.Huang@nxp.com>
> > > > Reviewed-by: Dong Aisheng <aisheng.dong@nxp.com>
> > >
> > > Applied, thanks.
Alexandre Belloni April 12, 2019, 8:41 a.m. UTC | #5
On 12/04/2019 02:32:54+0000, Anson Huang wrote:
> > > 	As i.MX SCU general irq function is picked up by Shawn, could you
> > > please also pick up below i.MX SC RTC alarm support patch ?
> > > 	https://patchwork.kernel.org/patch/10890525/
> > >
> > 
> > No, it can't go through Alexandre's tree due to dependency issue.
> > 
> > Shawn,
> > Do you think you can pick it up? Alexandre already gave the Ack.
> > 
> > AFAIK there's no other SCU RTC patches since v5.1-rc1 in Alexandre's tree.
> 
> Yes, need to make sure the dependency is handled, the RTC alarm patch MUST be picked up
> ONLY when scu irq patch is ready, NOT sure how to handle this case for such scenario?
> 

Either it goes through arm-soc or if it can wait one release, I pick it
up for 5.3. The other solution involves immutable branch but I don't
think this is necessary.
Shawn Guo April 15, 2019, 9:23 a.m. UTC | #6
On Fri, Apr 12, 2019 at 10:41:16AM +0200, Alexandre Belloni wrote:
> On 12/04/2019 02:32:54+0000, Anson Huang wrote:
> > > > 	As i.MX SCU general irq function is picked up by Shawn, could you
> > > > please also pick up below i.MX SC RTC alarm support patch ?
> > > > 	https://patchwork.kernel.org/patch/10890525/
> > > >
> > > 
> > > No, it can't go through Alexandre's tree due to dependency issue.
> > > 
> > > Shawn,
> > > Do you think you can pick it up? Alexandre already gave the Ack.
> > > 
> > > AFAIK there's no other SCU RTC patches since v5.1-rc1 in Alexandre's tree.
> > 
> > Yes, need to make sure the dependency is handled, the RTC alarm patch MUST be picked up
> > ONLY when scu irq patch is ready, NOT sure how to handle this case for such scenario?
> > 
> 
> Either it goes through arm-soc or if it can wait one release, I pick it
> up for 5.3. The other solution involves immutable branch but I don't
> think this is necessary.

I send other subsystem patch through arm-soc tree only when it's
absolutely necessary. This is not anything either critical or urgent,
so I'm not going to take it.  Wait one release, I'd say.

Shawn

Patch
diff mbox series

diff --git a/drivers/firmware/imx/Makefile b/drivers/firmware/imx/Makefile
index 1b2e15b..802c4ad 100644
--- a/drivers/firmware/imx/Makefile
+++ b/drivers/firmware/imx/Makefile
@@ -1,3 +1,3 @@ 
 # SPDX-License-Identifier: GPL-2.0
-obj-$(CONFIG_IMX_SCU)		+= imx-scu.o misc.o
+obj-$(CONFIG_IMX_SCU)		+= imx-scu.o misc.o imx-scu-irq.o
 obj-$(CONFIG_IMX_SCU_PD)	+= scu-pd.o
diff --git a/drivers/firmware/imx/imx-scu-irq.c b/drivers/firmware/imx/imx-scu-irq.c
new file mode 100644
index 0000000..043833a
--- /dev/null
+++ b/drivers/firmware/imx/imx-scu-irq.c
@@ -0,0 +1,168 @@ 
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * Copyright 2019 NXP
+ *
+ * Implementation of the SCU IRQ functions using MU.
+ *
+ */
+
+#include <dt-bindings/firmware/imx/rsrc.h>
+#include <linux/firmware/imx/ipc.h>
+#include <linux/mailbox_client.h>
+
+#define IMX_SC_IRQ_FUNC_ENABLE	1
+#define IMX_SC_IRQ_FUNC_STATUS	2
+#define IMX_SC_IRQ_NUM_GROUP	4
+
+static u32 mu_resource_id;
+
+struct imx_sc_msg_irq_get_status {
+	struct imx_sc_rpc_msg hdr;
+	union {
+		struct {
+			u16 resource;
+			u8 group;
+			u8 reserved;
+		} __packed req;
+		struct {
+			u32 status;
+		} resp;
+	} data;
+};
+
+struct imx_sc_msg_irq_enable {
+	struct imx_sc_rpc_msg hdr;
+	u32 mask;
+	u16 resource;
+	u8 group;
+	u8 enable;
+} __packed;
+
+static struct imx_sc_ipc *imx_sc_irq_ipc_handle;
+static struct work_struct imx_sc_irq_work;
+static ATOMIC_NOTIFIER_HEAD(imx_scu_irq_notifier_chain);
+
+int imx_scu_irq_register_notifier(struct notifier_block *nb)
+{
+	return atomic_notifier_chain_register(
+		&imx_scu_irq_notifier_chain, nb);
+}
+EXPORT_SYMBOL(imx_scu_irq_register_notifier);
+
+int imx_scu_irq_unregister_notifier(struct notifier_block *nb)
+{
+	return atomic_notifier_chain_unregister(
+		&imx_scu_irq_notifier_chain, nb);
+}
+EXPORT_SYMBOL(imx_scu_irq_unregister_notifier);
+
+static int imx_scu_irq_notifier_call_chain(unsigned long status, u8 *group)
+{
+	return atomic_notifier_call_chain(&imx_scu_irq_notifier_chain,
+		status, (void *)group);
+}
+
+static void imx_scu_irq_work_handler(struct work_struct *work)
+{
+	struct imx_sc_msg_irq_get_status msg;
+	struct imx_sc_rpc_msg *hdr = &msg.hdr;
+	u32 irq_status;
+	int ret;
+	u8 i;
+
+	for (i = 0; i < IMX_SC_IRQ_NUM_GROUP; i++) {
+		hdr->ver = IMX_SC_RPC_VERSION;
+		hdr->svc = IMX_SC_RPC_SVC_IRQ;
+		hdr->func = IMX_SC_IRQ_FUNC_STATUS;
+		hdr->size = 2;
+
+		msg.data.req.resource = mu_resource_id;
+		msg.data.req.group = i;
+
+		ret = imx_scu_call_rpc(imx_sc_irq_ipc_handle, &msg, true);
+		if (ret) {
+			pr_err("get irq group %d status failed, ret %d\n",
+			       i, ret);
+			return;
+		}
+
+		irq_status = msg.data.resp.status;
+		if (!irq_status)
+			continue;
+
+		imx_scu_irq_notifier_call_chain(irq_status, &i);
+	}
+}
+
+int imx_scu_irq_group_enable(u8 group, u32 mask, u8 enable)
+{
+	struct imx_sc_msg_irq_enable msg;
+	struct imx_sc_rpc_msg *hdr = &msg.hdr;
+	int ret;
+
+	hdr->ver = IMX_SC_RPC_VERSION;
+	hdr->svc = IMX_SC_RPC_SVC_IRQ;
+	hdr->func = IMX_SC_IRQ_FUNC_ENABLE;
+	hdr->size = 3;
+
+	msg.resource = mu_resource_id;
+	msg.group = group;
+	msg.mask = mask;
+	msg.enable = enable;
+
+	ret = imx_scu_call_rpc(imx_sc_irq_ipc_handle, &msg, true);
+	if (ret)
+		pr_err("enable irq failed, group %d, mask %d, ret %d\n",
+			group, mask, ret);
+
+	return ret;
+}
+EXPORT_SYMBOL(imx_scu_irq_group_enable);
+
+static void imx_scu_irq_callback(struct mbox_client *c, void *msg)
+{
+	schedule_work(&imx_sc_irq_work);
+}
+
+int imx_scu_enable_general_irq_channel(struct device *dev)
+{
+	struct of_phandle_args spec;
+	struct mbox_client *cl;
+	struct mbox_chan *ch;
+	int ret = 0, i = 0;
+
+	ret = imx_scu_get_handle(&imx_sc_irq_ipc_handle);
+	if (ret)
+		return ret;
+
+	cl = devm_kzalloc(dev, sizeof(*cl), GFP_KERNEL);
+	if (!cl)
+		return -ENOMEM;
+
+	cl->dev = dev;
+	cl->rx_callback = imx_scu_irq_callback;
+
+	/* SCU general IRQ uses general interrupt channel 3 */
+	ch = mbox_request_channel_byname(cl, "gip3");
+	if (IS_ERR(ch)) {
+		ret = PTR_ERR(ch);
+		dev_err(dev, "failed to request mbox chan gip3, ret %d\n", ret);
+		devm_kfree(dev, cl);
+		return ret;
+	}
+
+	INIT_WORK(&imx_sc_irq_work, imx_scu_irq_work_handler);
+
+	if (!of_parse_phandle_with_args(dev->of_node, "mboxes",
+				       "#mbox-cells", 0, &spec))
+		i = of_alias_get_id(spec.np, "mu");
+
+	/* use mu1 as general mu irq channel if failed */
+	if (i < 0)
+		i = 1;
+
+	mu_resource_id = IMX_SC_R_MU_0A + i;
+
+	return ret;
+}
+EXPORT_SYMBOL(imx_scu_enable_general_irq_channel);
diff --git a/drivers/firmware/imx/imx-scu.c b/drivers/firmware/imx/imx-scu.c
index 2bb1a19..04a24a8 100644
--- a/drivers/firmware/imx/imx-scu.c
+++ b/drivers/firmware/imx/imx-scu.c
@@ -10,6 +10,7 @@ 
 #include <linux/err.h>
 #include <linux/firmware/imx/types.h>
 #include <linux/firmware/imx/ipc.h>
+#include <linux/firmware/imx/sci.h>
 #include <linux/interrupt.h>
 #include <linux/irq.h>
 #include <linux/kernel.h>
@@ -246,6 +247,11 @@  static int imx_scu_probe(struct platform_device *pdev)
 
 	imx_sc_ipc_handle = sc_ipc;
 
+	ret = imx_scu_enable_general_irq_channel(dev);
+	if (ret)
+		dev_warn(dev,
+			"failed to enable general irq channel: %d\n", ret);
+
 	dev_info(dev, "NXP i.MX SCU Initialized\n");
 
 	return devm_of_platform_populate(dev);
diff --git a/include/linux/firmware/imx/sci.h b/include/linux/firmware/imx/sci.h
index ebc5509..17ba4e4 100644
--- a/include/linux/firmware/imx/sci.h
+++ b/include/linux/firmware/imx/sci.h
@@ -15,4 +15,9 @@ 
 
 #include <linux/firmware/imx/svc/misc.h>
 #include <linux/firmware/imx/svc/pm.h>
+
+int imx_scu_enable_general_irq_channel(struct device *dev);
+int imx_scu_irq_register_notifier(struct notifier_block *nb);
+int imx_scu_irq_unregister_notifier(struct notifier_block *nb);
+int imx_scu_irq_group_enable(u8 group, u32 mask, u8 enable);
 #endif /* _SC_SCI_H */