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:     robh+dt@kernel.org, krzysztof.kozlowski+dt@linaro.org,
        linus.walleij@linaro.org, brgl@bgdev.pl, shawnguo@kernel.org,
        s.hauer@pengutronix.de, kernel@pengutronix.de, festevam@gmail.com,
        linux-imx@nxp.com
Cc:     devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
        linux-gpio@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
        Shenwei Wang <shenwei.wang@nxp.com>
Subject: [PATCH v1 3/3] firmware: imx: add imx-scu GPIO driver
Date:   Thu,  4 Aug 2022 13:49:08 -0500
Message-Id: <20220804184908.470216-4-shenwei.wang@nxp.com>
In-Reply-To: <20220804184908.470216-1-shenwei.wang@nxp.com>
References: <20220804184908.470216-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?eE7qzfHdH7pnlMx1eSJb06ebrXQyJENCE+fj82Q+tnWWkRWoYTk4OrBxZMyi?=
 =?us-ascii?Q?k2rIZoteQ84DcRscQ6ktPLEl9yYmN80Qbb7+jizTkkltCh5YXIMOsmoZZQeW?=
 =?us-ascii?Q?khucBU7GffBA++Nw3GWc0iEUkKe/xh1DTbnszg9rk6SYXyyOYDIJRpQcuAzZ?=
 =?us-ascii?Q?ndQu+AAK1Z30pYtnRQPhKyz+83FzJI9rmf352OCJGyYe7xkuAPmcnJ9MRJrl?=
 =?us-ascii?Q?czHTOIb4CggFv8mPg+EiaKegVN2kpOUStvw0JwAjLYDvBxSnNO8yNcW865TY?=
 =?us-ascii?Q?BwUIbecmHr27HSyywii4BpKYsOWTAM3L48eAEvcLm6X6xvu3I4UNHDCeMNQp?=
 =?us-ascii?Q?YiO9w5gdZbtbXpKuRbk8LdcFsOyblrtSgxgbsZRzANw37bElp4emm+/hGzWr?=
 =?us-ascii?Q?fdzKwGNI6RV1f0tkcgi9/+qwBO74BJvqapju/jJOIJXs2xol9yrDR7CIOxYm?=
 =?us-ascii?Q?vbRTt9VzKVVoqJsJILefnyMa+lA9nATd/xtJ4gzPJgBnWYdNcPCKBU3fi9lC?=
 =?us-ascii?Q?RhX3IafuRcElEKTfQ0PJ7Nykd27Hwe5lCgA0f94MtVNBMqC66YSf1fyFmAt2?=
 =?us-ascii?Q?8lFCLVokIbl7XkqsukDAZknQ/w2Erl7uPYFpCcs3TTmK+UcayDmZPtA1bkqy?=
 =?us-ascii?Q?PxpJaKlxzQ8T44AfeXMb2MESwYIYWpJk8FJs9aG6vhlWey7eS6EDNKVyBq3h?=
 =?us-ascii?Q?NmvusgrJmPNvoYErS3ABe0YpS4vZGjfGQ2y6rAlEnTcIeH0tJZxIDyhFhSez?=
 =?us-ascii?Q?Zh3n7aLGfA7auJgRBQU0b9Dc48e4TAdxiDXnR/gZRksTqzmQ0yiVWN9D3G8D?=
 =?us-ascii?Q?z09snI0X6cVG7QGAilltzZAgNcYZQxscCai0kQHpjNjcP4Jn0MP0VB7eXIxg?=
 =?us-ascii?Q?CvQtmtkDtAVHcOWD/K0fCZmRH96utzvaDtMFl+qjXkdbLOSFBHAUIrmX3zTp?=
 =?us-ascii?Q?9/Y28OT5r4eFXqd/saU07+d3on3yDZr17KoGt92syYIQMpWcPcFvA/xPJ8rs?=
 =?us-ascii?Q?qUXlwNHsbSrGBWS+n/Gabdctis+m3uFq1zGKe+AoMLCyadApuaH3csAz3zmx?=
 =?us-ascii?Q?DCE6LVwfMaLarobcMF5WrRYJNzmf5nxNfiM/3Y4lGELAUikxE+FLjjjpC8c7?=
 =?us-ascii?Q?q4EX+SssK+EGuBEAu8KQ1qb4eDLhEIScyqMulVafpDQJ3jXBukzN16vBu2mG?=
 =?us-ascii?Q?OM9nBuaJZye3ALAfxMAZzwL6XwuBAQZif4BMeht87SKnzqe0Khsk4hxeiatp?=
 =?us-ascii?Q?CfWbONNfRrYN2YfA3zs+SdWn28gZXbj5dO3wD2doplu2MOX7bwZeabVsYfob?=
 =?us-ascii?Q?QdApCRwgEClcrHHTkEo/h+VNONJMcIAc9Rwd8ZoWoWfNC4/naxw70uyL5Uvl?=
 =?us-ascii?Q?yF9D0IXGWkUlCTQ/V2a8PCwm/IPhVib0K16ZHLlce3F3/j1fe2iAGouNzCqL?=
 =?us-ascii?Q?A2PCllCr/bQ0FP1Wt8xDKiXoH54yTUz5jeOLEJp19/+ggOjNULJUPctARnzk?=
 =?us-ascii?Q?JGkGCHrM0cuObk/wJdBy9SNZKxgspb4ba7pV1G5d7SGfq2Yjphn5GufY1wMJ?=
 =?us-ascii?Q?lguahuJcSgmzqFfBnws+R/SPaLHVAFCEcpXnu1mH?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: ebc9bde4-dd0f-479a-a5a4-08da764a2eb3
X-MS-Exchange-CrossTenant-AuthSource: AM9PR04MB8274.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 04 Aug 2022 18:50:21.0466
 (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: fBhUKRSmrjH432Z5msc4yxRMEml1aM1G/BwgztSilYmPAm3rW6DdHh2w8x/yA8SY8fW0ZxUroC96y6xGEExCzw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AM6PR04MB3992
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 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

The SCU firmware on i.MX8 platforms provides a set of APIs to
control the GPIO PINs on the SCU domain. This patch implements the
standard GPIO driver interface to access those PINs on the
SCU domain over the SCU APIs.

Signed-off-by: Shenwei Wang <shenwei.wang@nxp.com>
---
 drivers/firmware/imx/Kconfig        |   6 ++
 drivers/firmware/imx/Makefile       |   1 +
 drivers/firmware/imx/imx-scu-gpio.c | 139 ++++++++++++++++++++++++++++
 3 files changed, 146 insertions(+)
 create mode 100644 drivers/firmware/imx/imx-scu-gpio.c

diff --git a/drivers/firmware/imx/Kconfig b/drivers/firmware/imx/Kconfig
index c027d99f2a59..484c13f3149a 100644
--- a/drivers/firmware/imx/Kconfig
+++ b/drivers/firmware/imx/Kconfig
@@ -28,3 +28,9 @@ config IMX_SCU_PD
 	depends on IMX_SCU
 	help
 	  The System Controller Firmware (SCFW) based power domain driver.
+
+config IMX_SCU_GPIO
+       def_bool y
+       depends on IMX_SCU
+       help
+         Say Y here to enable the imx8 gpio over SCFW MISC API
diff --git a/drivers/firmware/imx/Makefile b/drivers/firmware/imx/Makefile
index b76acbade2a0..436476502bd8 100644
--- a/drivers/firmware/imx/Makefile
+++ b/drivers/firmware/imx/Makefile
@@ -1,4 +1,5 @@
 # SPDX-License-Identifier: GPL-2.0
 obj-$(CONFIG_IMX_DSP)		+= imx-dsp.o
 obj-$(CONFIG_IMX_SCU)		+= imx-scu.o misc.o imx-scu-irq.o rm.o imx-scu-soc.o
+obj-$(CONFIG_IMX_SCU_GPIO)	+= imx-scu-gpio.o
 obj-$(CONFIG_IMX_SCU_PD)	+= scu-pd.o
diff --git a/drivers/firmware/imx/imx-scu-gpio.c b/drivers/firmware/imx/imx-scu-gpio.c
new file mode 100644
index 000000000000..2f4a991a9ad6
--- /dev/null
+++ b/drivers/firmware/imx/imx-scu-gpio.c
@@ -0,0 +1,139 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * Copyright 2021~2022 NXP
+ *
+ * The driver exports a standard gpiochip interface
+ * to control the PIN resources on SCU domain.
+ */
+
+#include <linux/module.h>
+#include <linux/gpio/driver.h>
+#include <linux/platform_device.h>
+#include <linux/firmware/imx/svc/rm.h>
+#include <dt-bindings/firmware/imx/rsrc.h>
+
+struct scu_gpio_priv {
+	struct gpio_chip	chip;
+	struct mutex		lock;
+	struct device		*dev;
+	struct imx_sc_ipc	*handle;
+};
+
+static unsigned int scu_rsrc_arr[] = {
+	IMX_SC_R_BOARD_R0,
+	IMX_SC_R_BOARD_R1,
+	IMX_SC_R_BOARD_R2,
+	IMX_SC_R_BOARD_R3,
+	IMX_SC_R_BOARD_R4,
+	IMX_SC_R_BOARD_R5,
+	IMX_SC_R_BOARD_R6,
+	IMX_SC_R_BOARD_R7,
+};
+
+static int imx_scu_gpio_get(struct gpio_chip *chip, unsigned int offset)
+{
+	struct scu_gpio_priv *priv = gpiochip_get_data(chip);
+	int level;
+	int err;
+
+	if (offset >= chip->ngpio)
+		return -EINVAL;
+
+	mutex_lock(&priv->lock);
+
+	/* to read PIN state via scu api */
+	err = imx_sc_misc_get_control(priv->handle,
+			scu_rsrc_arr[offset], 0, &level);
+	mutex_unlock(&priv->lock);
+
+	if (err) {
+		dev_err(priv->dev, "SCU get failed: %d\n", err);
+		return err;
+	}
+
+	return level;
+}
+
+static void imx_scu_gpio_set(struct gpio_chip *chip, unsigned int offset, int value)
+{
+	struct scu_gpio_priv *priv = gpiochip_get_data(chip);
+	int err;
+
+	if (offset >= chip->ngpio)
+		return;
+
+	mutex_lock(&priv->lock);
+
+	/* to set PIN output level via scu api */
+	err = imx_sc_misc_set_control(priv->handle,
+			scu_rsrc_arr[offset], 0, value);
+	mutex_unlock(&priv->lock);
+
+	if (err)
+		dev_err(priv->dev, "SCU set (%d) failed: %d\n",
+				scu_rsrc_arr[offset], err);
+}
+
+static int imx_scu_gpio_get_direction(struct gpio_chip *chip, unsigned int offset)
+{
+	if (offset >= chip->ngpio)
+		return -EINVAL;
+
+	return GPIO_LINE_DIRECTION_OUT;
+}
+
+static int imx_scu_gpio_probe(struct platform_device *pdev)
+{
+	struct device *dev = &pdev->dev;
+	struct scu_gpio_priv *priv;
+	struct gpio_chip *gc;
+	int ret;
+
+	priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
+	if (!priv)
+		return -ENOMEM;
+
+	ret = imx_scu_get_handle(&priv->handle);
+	if (ret)
+		return ret;
+
+	priv->dev = dev;
+	mutex_init(&priv->lock);
+
+	gc = &priv->chip;
+	gc->base = -1;
+	gc->parent = dev;
+	gc->ngpio = sizeof(scu_rsrc_arr)/sizeof(unsigned int);
+	gc->label = dev_name(dev);
+	gc->get = imx_scu_gpio_get;
+	gc->set = imx_scu_gpio_set;
+	gc->get_direction = imx_scu_gpio_get_direction;
+
+	platform_set_drvdata(pdev, priv);
+
+	return devm_gpiochip_add_data(dev, gc, priv);
+}
+
+static const struct of_device_id imx_scu_gpio_dt_ids[] = {
+	{ .compatible = "fsl,imx8-scu-gpio" },
+	{ /* sentinel */ }
+};
+
+static struct platform_driver imx_scu_gpio_driver = {
+	.driver	= {
+		.name = "gpio-imx-scu",
+		.of_match_table = imx_scu_gpio_dt_ids,
+	},
+	.probe = imx_scu_gpio_probe,
+};
+
+static int __init _imx_scu_gpio_init(void)
+{
+	return platform_driver_register(&imx_scu_gpio_driver);
+}
+
+subsys_initcall_sync(_imx_scu_gpio_init);
+
+MODULE_AUTHOR("Shenwei Wang <shenwei.wang@nxp.com>");
+MODULE_DESCRIPTION("NXP GPIO over IMX SCU API");
+MODULE_LICENSE("GPL");
-- 
2.25.1