drivers: gpio: nrfx: impl pm device runtime

Implement PM_DEVICE_RUNTIME for gpio_nrfx.c

PM is required to request/release the GPD domain if such exists
for a given GPIO instance. Without this, every single API call
will result in a requesting the GPD domain, which makes it slow
and unusable from ISRs, given GPD requires IPC. Now, user can
simply get the GPIO before using it, and put it once done,
calling the APIs from ISR while resumed.

Signed-off-by: Bjarki Arge Andreasen <[email protected]>

Author: bjarki-andreasen

drivers/gpio/gpio_nrfx.c

@@ -11,6 +11,8 @@
 #include <zephyr/drivers/gpio.h>
 #include <zephyr/dt-bindings/gpio/nordic-nrf-gpio.h>
 #include <zephyr/irq.h>
+#include <zephyr/pm/device.h>
+#include <zephyr/pm/device_runtime.h>
 
 #include <zephyr/drivers/gpio/gpio_utils.h>
 
@@ -62,53 +64,37 @@ static nrf_gpio_pin_pull_t get_pull(gpio_flags_t flags)
 	return NRF_GPIO_PIN_NOPULL;
 }
 
-static int gpio_nrfx_gpd_retain_set(const struct device *port, uint32_t mask, gpio_flags_t flags)
+static void gpio_nrfx_gpd_retain_set(const struct device *port, uint32_t mask, gpio_flags_t flags)
 {
 #ifdef CONFIG_SOC_NRF54H20_GPD
 	const struct gpio_nrfx_cfg *cfg = get_port_cfg(port);
 
-	if (cfg->pad_pd == NRF_GPD_FAST_ACTIVE1) {
-		int ret;
-
-		if (flags & GPIO_OUTPUT) {
-			nrf_gpio_port_retain_enable(cfg->port, mask);
-		}
-
-		ret = nrf_gpd_release(NRF_GPD_FAST_ACTIVE1);
-		if (ret < 0) {
-			return ret;
-		}
+	if (cfg->pad_pd != NRF_GPD_FAST_ACTIVE1 || !(flags & GPIO_OUTPUT)) {
+		return;
 	}
+
+	nrf_gpio_port_retain_enable(cfg->port, mask);
 #else
 	ARG_UNUSED(port);
 	ARG_UNUSED(mask);
 	ARG_UNUSED(flags);
 #endif
-
-	return 0;
 }
 
-static int gpio_nrfx_gpd_retain_clear(const struct device *port, uint32_t mask)
+static void gpio_nrfx_gpd_retain_clear(const struct device *port, uint32_t mask)
 {
 #ifdef CONFIG_SOC_NRF54H20_GPD
 	const struct gpio_nrfx_cfg *cfg = get_port_cfg(port);
 
-	if (cfg->pad_pd == NRF_GPD_FAST_ACTIVE1) {
-		int ret;
-
-		ret = nrf_gpd_request(NRF_GPD_FAST_ACTIVE1);
-		if (ret < 0) {
-			return ret;
-		}
-
-		nrf_gpio_port_retain_disable(cfg->port, mask);
+	if (cfg->pad_pd != NRF_GPD_FAST_ACTIVE1) {
+		return;
 	}
+
+	nrf_gpio_port_retain_disable(cfg->port, mask);
 #else
 	ARG_UNUSED(port);
 	ARG_UNUSED(mask);
 #endif
-
-	return 0;
 }
 
 static int gpio_nrfx_pin_configure(const struct device *port, gpio_pin_t pin,
@@ -152,11 +138,13 @@ static int gpio_nrfx_pin_configure(const struct device *port, gpio_pin_t pin,
 		return -EINVAL;
 	}
 
-	ret = gpio_nrfx_gpd_retain_clear(port, BIT(pin));
+	ret = pm_device_runtime_get(port);
 	if (ret < 0) {
 		return ret;
 	}
 
+	gpio_nrfx_gpd_retain_clear(port, BIT(pin));
+
 	if (flags & GPIO_OUTPUT_INIT_HIGH) {
 		nrf_gpio_port_out_set(cfg->port, BIT(pin));
 	} else if (flags & GPIO_OUTPUT_INIT_LOW) {
@@ -237,8 +225,8 @@ static int gpio_nrfx_pin_configure(const struct device *port, gpio_pin_t pin,
 	}
 
 end:
-	(void)gpio_nrfx_gpd_retain_set(port, BIT(pin), flags);
-	return ret;
+	gpio_nrfx_gpd_retain_set(port, BIT(pin), flags);
+	return pm_device_runtime_put(port);
 }
 
 static int gpio_nrfx_port_get_raw(const struct device *port,
@@ -261,15 +249,16 @@ static int gpio_nrfx_port_set_masked_raw(const struct device *port,
 	const uint32_t set_mask = value & mask;
 	const uint32_t clear_mask = (~set_mask) & mask;
 
-	ret = gpio_nrfx_gpd_retain_clear(port, mask);
+	ret = pm_device_runtime_get(port);
 	if (ret < 0) {
 		return ret;
 	}
 
+	gpio_nrfx_gpd_retain_clear(port, mask);
 	nrf_gpio_port_out_set(reg, set_mask);
 	nrf_gpio_port_out_clear(reg, clear_mask);
-
-	return gpio_nrfx_gpd_retain_set(port, mask, GPIO_OUTPUT);
+	gpio_nrfx_gpd_retain_set(port, mask, GPIO_OUTPUT);
+	return pm_device_runtime_put(port);
 }
 
 static int gpio_nrfx_port_set_bits_raw(const struct device *port,
@@ -278,14 +267,15 @@ static int gpio_nrfx_port_set_bits_raw(const struct device *port,
 	NRF_GPIO_Type *reg = get_port_cfg(port)->port;
 	int ret;
 
-	ret = gpio_nrfx_gpd_retain_clear(port, mask);
+	ret = pm_device_runtime_get(port);
 	if (ret < 0) {
 		return ret;
 	}
 
+	gpio_nrfx_gpd_retain_clear(port, mask);
 	nrf_gpio_port_out_set(reg, mask);
-
-	return gpio_nrfx_gpd_retain_set(port, mask, GPIO_OUTPUT);
+	gpio_nrfx_gpd_retain_set(port, mask, GPIO_OUTPUT);
+	return pm_device_runtime_put(port);
 }
 
 static int gpio_nrfx_port_clear_bits_raw(const struct device *port,
@@ -294,14 +284,15 @@ static int gpio_nrfx_port_clear_bits_raw(const struct device *port,
 	NRF_GPIO_Type *reg = get_port_cfg(port)->port;
 	int ret;
 
-	ret = gpio_nrfx_gpd_retain_clear(port, mask);
+	ret = pm_device_runtime_get(port);
 	if (ret < 0) {
 		return ret;
 	}
 
+	gpio_nrfx_gpd_retain_clear(port, mask);
 	nrf_gpio_port_out_clear(reg, mask);
-
-	return gpio_nrfx_gpd_retain_set(port, mask, GPIO_OUTPUT);
+	gpio_nrfx_gpd_retain_set(port, mask, GPIO_OUTPUT);
+	return pm_device_runtime_put(port);
 }
 
 static int gpio_nrfx_port_toggle_bits(const struct device *port,
@@ -313,15 +304,16 @@ static int gpio_nrfx_port_toggle_bits(const struct device *port,
 	const uint32_t clear_mask = (~value) & mask;
 	int ret;
 
-	ret = gpio_nrfx_gpd_retain_clear(port, mask);
+	ret = pm_device_runtime_get(port);
 	if (ret < 0) {
 		return ret;
 	}
 
+	gpio_nrfx_gpd_retain_clear(port, mask);
 	nrf_gpio_port_out_set(reg, set_mask);
 	nrf_gpio_port_out_clear(reg, clear_mask);
-
-	return gpio_nrfx_gpd_retain_set(port, mask, GPIO_OUTPUT);
+	gpio_nrfx_gpd_retain_set(port, mask, GPIO_OUTPUT);
+	return pm_device_runtime_put(port);
 }
 
 #ifdef CONFIG_GPIO_NRFX_INTERRUPT
@@ -480,17 +472,68 @@ static void nrfx_gpio_handler(nrfx_gpiote_pin_t abs_pin,
 	IRQ_CONNECT(DT_IRQN(node_id), DT_IRQ(node_id, priority), nrfx_isr, \
 		    NRFX_CONCAT(nrfx_gpiote_, DT_PROP(node_id, instance), _irq_handler), 0);
 
+static int gpio_nrfx_pm_suspend(const struct device *port)
+{
+#ifdef CONFIG_SOC_NRF54H20_GPD
+	const struct gpio_nrfx_cfg *cfg = get_port_cfg(port);
+
+	if (cfg->pad_pd != NRF_GPD_FAST_ACTIVE1) {
+		return 0;
+	}
+
+	return nrf_gpd_release(NRF_GPD_FAST_ACTIVE1);
+#else
+	ARG_UNUSED(port);
+	return 0;
+#endif
+}
+
+static int gpio_nrfx_pm_resume(const struct device *port)
+{
+#ifdef CONFIG_SOC_NRF54H20_GPD
+	const struct gpio_nrfx_cfg *cfg = get_port_cfg(port);
+
+	if (cfg->pad_pd != NRF_GPD_FAST_ACTIVE1) {
+		return 0;
+	}
+
+	return nrf_gpd_request(NRF_GPD_FAST_ACTIVE1);
+#else
+	ARG_UNUSED(port);
+	return 0;
+#endif
+}
+
+static int gpio_nrfx_pm_hook(const struct device *port, enum pm_device_action action)
+{
+	int ret;
+
+	switch (action) {
+	case PM_DEVICE_ACTION_SUSPEND:
+		ret = gpio_nrfx_pm_suspend(port);
+		break;
+	case PM_DEVICE_ACTION_RESUME:
+		ret = gpio_nrfx_pm_resume(port);
+		break;
+	default:
+		ret = -ENOTSUP;
+		break;
+	}
+
+	return ret;
+}
+
 static int gpio_nrfx_init(const struct device *port)
 {
 	const struct gpio_nrfx_cfg *cfg = get_port_cfg(port);
 	nrfx_err_t err;
 
 	if (!has_gpiote(cfg)) {
-		return 0;
+		goto pm_init;
 	}
 
 	if (nrfx_gpiote_init_check(&cfg->gpiote)) {
-		return 0;
+		goto pm_init;
 	}
 
 	err = nrfx_gpiote_init(&cfg->gpiote, 0 /*not used*/);
@@ -503,7 +546,8 @@ static int gpio_nrfx_init(const struct device *port)
 	DT_FOREACH_STATUS_OKAY(nordic_nrf_gpiote, GPIOTE_IRQ_HANDLER_CONNECT);
 #endif /* CONFIG_GPIO_NRFX_INTERRUPT */
 
-	return 0;
+pm_init:
+	return pm_device_driver_init(port, gpio_nrfx_pm_hook);
 }
 
 static DEVICE_API(gpio, gpio_nrfx_drv_api_funcs) = {
@@ -565,8 +609,10 @@ static DEVICE_API(gpio, gpio_nrfx_drv_api_funcs) = {
 									\
 	static struct gpio_nrfx_data gpio_nrfx_p##id##_data;		\
 									\
+	PM_DEVICE_DT_INST_DEFINE(id, gpio_nrfx_pm_hook);		\
+									\
 	DEVICE_DT_INST_DEFINE(id, gpio_nrfx_init,			\
-			 NULL,						\
+			 PM_DEVICE_DT_INST_GET(id),			\
 			 &gpio_nrfx_p##id##_data,			\
 			 &gpio_nrfx_p##id##_cfg,			\
 			 PRE_KERNEL_1,					\