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:   Shenwei Wang <shenwei.wang@nxp.com>
To:     Rob Herring <robh+dt@kernel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
        Shawn Guo <shawnguo@kernel.org>,
        Sascha Hauer <s.hauer@pengutronix.de>,
        Linus Walleij <linus.walleij@linaro.org>,
        Bartosz Golaszewski <brgl@bgdev.pl>,
        Dong Aisheng <aisheng.dong@nxp.com>,
        Jacky Bai <ping.bai@nxp.com>
Cc:     Pengutronix Kernel Team <kernel@pengutronix.de>,
        Fabio Estevam <festevam@gmail.com>,
        NXP Linux Team <linux-imx@nxp.com>,
        Shenwei Wang <shenwei.wang@nxp.com>,
        Peng Fan <peng.fan@nxp.com>, devicetree@vger.kernel.org,
        linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org,
        imx@lists.linux.dev
Subject: [PATCH v3 5/5] gpio: mxc: enable pad wakeup on i.MX8x platforms
Date:   Tue, 25 Oct 2022 13:32:44 -0500
Message-Id: <20221025183244.615318-6-shenwei.wang@nxp.com>
In-Reply-To: <20221025183244.615318-1-shenwei.wang@nxp.com>
References: <20221025183244.615318-1-shenwei.wang@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?nMBIrvdGRmZEPorIdq0XEqszecXNk2DnDMer/liXnO384+d2Ilfqdzo/HBld?=
 =?us-ascii?Q?0ktAum8JpEbxDCyiivuBtjpw/FW5hSk2a8BvCUp4aLUK0nttHxjD9qIGfwEU?=
 =?us-ascii?Q?eqKY+toWkDM1KpkBKwpH2JoBsnj55AUZLHmWEaKGp4pWckdRAPoktYWDfuU2?=
 =?us-ascii?Q?UAvy+87X6pq4DWu5F8za5icKF37ZneMV5seXTy6hc4mcds5r1z+JTB68JjOc?=
 =?us-ascii?Q?UHANo3Ud7HznU1taAg9DSmZhymggTdYoOIFicMP15jINYxTPre9woyxU4AFe?=
 =?us-ascii?Q?gIG5A04mEVZT46ii3aAXl7SmxOptsipwI1Asc/vzX/2cRCXAMGKh76JS8map?=
 =?us-ascii?Q?/71QhlpoNlS2QMqymhUL5D0Kz57m4qEEat/9Cv7vjiMb6xnWZTy2+VzpH438?=
 =?us-ascii?Q?Xar+nimxIKAx5MyLpekLcZv7Ro0aJUHoiiZaPGR3k/inc1PiUmTbVykoh5l+?=
 =?us-ascii?Q?uRtEAD713x33dTcpEnUBaYnyN2iBhKVgsf2JiMKRtw0GJxcKiru1VT5YRMHX?=
 =?us-ascii?Q?2Seps6Jukp+/Dz3fvMyVkPnEd//YuHKkCjVafxfI2tD5qIvNrBOIJwrSBm4y?=
 =?us-ascii?Q?TAymky2Mpjdtvhi21CJyXNqnChuvRoPC1T8JmrHxKJio08Jz6EAPus4f5gCz?=
 =?us-ascii?Q?bJwVJ5r6/qw+yT2McMzMrpYLetXqgG3fo+e9on88Honl+uyBXRG+ZbZllEe8?=
 =?us-ascii?Q?N7TQR3mUjR+o/4jjVpft2ez0cKjaI8JpCafgFEbFJXBFQJQfp06aKiAw4v8R?=
 =?us-ascii?Q?qL3TLzbru4Xs/ye/ynJJxM1P/SjjO72/sIqoZJbxEVypLQ8ppVaMSlfDSNiC?=
 =?us-ascii?Q?QPWIAhk9wQCcihL7q7X4030v7+CXnvRtS16/JiPYoKwbwOKnWlOk6ZNk1FHY?=
 =?us-ascii?Q?QYuBjBCJNlmeLQpeT220C8MB6e2/ILHdSmbBzh3Bj20PanQhBOJwCxLMu3jV?=
 =?us-ascii?Q?WSiaOAkKu9llqKF4a+jIQbnL7Kha/+Vgl8TYS7NnVCKzbvp3twW496cEKHqh?=
 =?us-ascii?Q?4HvlXFg/a+mEuVU9Un5g6AOvtKeNiLW4bnqj3mAbdXp2Y/ixHKSoVc0xLSFZ?=
 =?us-ascii?Q?4iPFr66PoKJzDepoMnxAMTWh3Gd49wP5nFaeDXZ//Wfga9UVWIILHCd5/nrN?=
 =?us-ascii?Q?Ti6FJl9NF4PL+vnLj9K5wKaP/y3J2eE+CYUuTW0uImwaxvWd74htX0Xx4sue?=
 =?us-ascii?Q?0Al0FyviUiVAWVUfzAIfptRJrmy/hObq4X6i1sdqEMkc0nud2uV6iWwMd4P+?=
 =?us-ascii?Q?64laOS0WFX8bmjARaU4WWt+fbIkwQVOPSIsJfu7cu5l4RIF71t/6J1xVUjXS?=
 =?us-ascii?Q?EWp2BhZ7rllm1I0bLLpAAoC3VJm+JFFXXDl3Ac3J/U1pGoE8EgbvOT9/XNep?=
 =?us-ascii?Q?egG9i+4UlVba3gYQeMUlLiKuk5qWeaGJ5G/Zq6Rdw04WgAugnpgMQohfVSGO?=
 =?us-ascii?Q?KTmEYDsjpbzqq7/qaPF3GqvpYE1OrMiX408hzSMw5m0CPHlN1J8tCxhP10i5?=
 =?us-ascii?Q?v2EKyynXMqAT+9veO7fqyatYyBHn+uGUb09duElJU42XoVnrYNbEaQ9IZzZW?=
 =?us-ascii?Q?GJfY4ZqRc0S01xa+Uo6wrle+Lb6TTrBR59iO6zyp?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 1dbaaf33-c275-4241-bf41-08dab6b76d54
X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB9185.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 25 Oct 2022 18:33:35.8230
 (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: ooWSnz/BuCVYXtHO1WjYeH0x+zxgEsCgUmyOiX3VrwRXd9J6xavmgZOCHDB2Y5IJk1f+YTTRAtK+D5x4adfWZg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AS1PR04MB9581
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,URIBL_BLOCKED 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

On i.MX8QM/QXP/DXL SoCs, even a GPIO is selected as the wakeup source,
the GPIO block will be powered off when system enters into suspend
state. This can greatly reduce the power consumption of suspend state
because the whole partition can be shutdown. This is called PAD wakeup
feature on i.MX8x platform.

This patch adds the noirq suspend/resume hooks and uses the pad wakeup
feature as the default wakeup method for GPIO modules on
i.MX8QM/QXP/DXL platforms.

Signed-off-by: Shenwei Wang <shenwei.wang@nxp.com>
---
 drivers/gpio/gpio-mxc.c | 91 ++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 90 insertions(+), 1 deletion(-)

diff --git a/drivers/gpio/gpio-mxc.c b/drivers/gpio/gpio-mxc.c
index c871602fc5ba..a6fe5ed3d320 100644
--- a/drivers/gpio/gpio-mxc.c
+++ b/drivers/gpio/gpio-mxc.c
@@ -24,6 +24,12 @@
 #include <linux/of_device.h>
 #include <linux/bug.h>
 
+#define IMX_SCU_WAKEUP_OFF		0
+#define IMX_SCU_WAKEUP_LOW_LVL		4
+#define IMX_SCU_WAKEUP_FALL_EDGE	5
+#define IMX_SCU_WAKEUP_RISE_EDGE	6
+#define IMX_SCU_WAKEUP_HIGH_LVL		7
+
 /* device type dependent stuff */
 struct mxc_gpio_hwdata {
 	unsigned dr_reg;
@@ -61,6 +67,9 @@ struct mxc_gpio_port {
 	u32 both_edges;
 	struct mxc_gpio_reg_saved gpio_saved_reg;
 	bool power_off;
+	u32 wakeup_pads;
+	bool is_pad_wakeup;
+	u32 pad_type[32];
 	const struct mxc_gpio_hwdata *hwdata;
 };
 
@@ -130,6 +139,9 @@ static const struct of_device_id mxc_gpio_dt_ids[] = {
 	{ .compatible = "fsl,imx31-gpio", .data = &imx31_gpio_hwdata },
 	{ .compatible = "fsl,imx35-gpio", .data = &imx35_gpio_hwdata },
 	{ .compatible = "fsl,imx7d-gpio", .data = &imx35_gpio_hwdata },
+	{ .compatible = "fsl,imx8dxl-gpio", .data = &imx35_gpio_hwdata },
+	{ .compatible = "fsl,imx8qm-gpio", .data = &imx35_gpio_hwdata },
+	{ .compatible = "fsl,imx8qxp-gpio", .data = &imx35_gpio_hwdata },
 	{ /* sentinel */ }
 };
 MODULE_DEVICE_TABLE(of, mxc_gpio_dt_ids);
@@ -203,6 +215,7 @@ static int gpio_set_irq_type(struct irq_data *d, u32 type)
 	}
 
 	writel(1 << gpio_idx, port->base + GPIO_ISR);
+	port->pad_type[gpio_idx] = type;
 
 	return 0;
 }
@@ -254,6 +267,9 @@ static void mx3_gpio_irq_handler(struct irq_desc *desc)
 	struct mxc_gpio_port *port = irq_desc_get_handler_data(desc);
 	struct irq_chip *chip = irq_desc_get_chip(desc);
 
+	if (port->is_pad_wakeup)
+		return;
+
 	chained_irq_enter(chip, desc);
 
 	irq_stat = readl(port->base + GPIO_ISR) & readl(port->base + GPIO_IMR);
@@ -306,11 +322,13 @@ static int gpio_set_wake_irq(struct irq_data *d, u32 enable)
 			ret = enable_irq_wake(port->irq_high);
 		else
 			ret = enable_irq_wake(port->irq);
+		port->wakeup_pads |= (1<<gpio_idx);
 	} else {
 		if (port->irq_high && (gpio_idx >= 16))
 			ret = disable_irq_wake(port->irq_high);
 		else
 			ret = disable_irq_wake(port->irq);
+		port->wakeup_pads &= ~(1<<gpio_idx);
 	}
 
 	return ret;
@@ -365,7 +383,6 @@ static int mxc_gpio_probe(struct platform_device *pdev)
 		return -ENOMEM;
 
 	port->dev = &pdev->dev;
-
 	port->hwdata = device_get_match_data(&pdev->dev);
 
 	port->base = devm_platform_ioremap_resource(pdev, 0);
@@ -498,6 +515,77 @@ static void mxc_gpio_restore_regs(struct mxc_gpio_port *port)
 	writel(port->gpio_saved_reg.dr, port->base + GPIO_DR);
 }
 
+static int mxc_gpio_generic_config(struct mxc_gpio_port *port,
+		unsigned int offset, unsigned long config)
+{
+	struct device_node *np = port->dev->of_node;
+
+	if (of_device_is_compatible(np, "fsl,imx8dxl-gpio") ||
+		of_device_is_compatible(np, "fsl,imx8qxp-gpio") ||
+		of_device_is_compatible(np, "fsl,imx8qm-gpio"))
+		return gpiochip_generic_config(&port->gc, offset, config);
+
+	return 0;
+}
+
+static void mxc_gpio_set_pad_wakeup(struct mxc_gpio_port *port, bool enable)
+{
+	unsigned long config;
+	int i, type;
+
+	static const u32 pad_type_map[] = {
+		IMX_SCU_WAKEUP_OFF,		/* 0 */
+		IMX_SCU_WAKEUP_RISE_EDGE,	/* IRQ_TYPE_EDGE_RISING */
+		IMX_SCU_WAKEUP_FALL_EDGE,	/* IRQ_TYPE_EDGE_FALLING */
+		IMX_SCU_WAKEUP_FALL_EDGE,	/* IRQ_TYPE_EDGE_BOTH */
+		IMX_SCU_WAKEUP_HIGH_LVL,	/* IRQ_TYPE_LEVEL_HIGH */
+		IMX_SCU_WAKEUP_OFF,		/* 5 */
+		IMX_SCU_WAKEUP_OFF,		/* 6 */
+		IMX_SCU_WAKEUP_OFF,		/* 7 */
+		IMX_SCU_WAKEUP_LOW_LVL,		/* IRQ_TYPE_LEVEL_LOW */
+	};
+
+	for (i = 0; i < 32; i++) {
+		if ((port->wakeup_pads & (1<<i))) {
+			type = port->pad_type[i];
+			if (enable)
+				config = pad_type_map[type];
+			else
+				config = IMX_SCU_WAKEUP_OFF;
+			mxc_gpio_generic_config(port, i, config);
+		}
+	}
+}
+
+static int __maybe_unused mxc_gpio_noirq_suspend(struct device *dev)
+{
+	struct platform_device *pdev = to_platform_device(dev);
+	struct mxc_gpio_port *port = platform_get_drvdata(pdev);
+
+	if (port->wakeup_pads > 0) {
+		mxc_gpio_set_pad_wakeup(port, true);
+		port->is_pad_wakeup = true;
+	}
+
+	return 0;
+}
+
+static int __maybe_unused mxc_gpio_noirq_resume(struct device *dev)
+{
+	struct platform_device *pdev = to_platform_device(dev);
+	struct mxc_gpio_port *port = platform_get_drvdata(pdev);
+
+	if (port->wakeup_pads > 0)
+		mxc_gpio_set_pad_wakeup(port, false);
+	port->is_pad_wakeup = false;
+
+	return 0;
+}
+
+static const struct dev_pm_ops mxc_gpio_dev_pm_ops = {
+	SET_NOIRQ_SYSTEM_SLEEP_PM_OPS(mxc_gpio_noirq_suspend, mxc_gpio_noirq_resume)
+};
+
 static int mxc_gpio_syscore_suspend(void)
 {
 	struct mxc_gpio_port *port;
@@ -537,6 +625,7 @@ static struct platform_driver mxc_gpio_driver = {
 		.name	= "gpio-mxc",
 		.of_match_table = mxc_gpio_dt_ids,
 		.suppress_bind_attrs = true,
+		.pm = &mxc_gpio_dev_pm_ops,
 	},
 	.probe		= mxc_gpio_probe,
 };
-- 
2.34.1