[nrf fromlist] drivers: flash_mspi_nor: Add support for "supply-gpios" property

Add support for supplying power to the flash chip by activation of
a GPIO specified through the "supply-gpios" property. Implementation
of gpio_reset() is also slightly modified so that it is consistent
with soft_reset() and the new power_supply() and so that all these
functions can use a common routine that performs a reset recovery
delay.

Upstream PR #: 93093

Signed-off-by: Andrzej Głąbek <[email protected]>

Author: anangl

drivers/flash/flash_mspi_nor.c

@@ -810,39 +810,54 @@ static int switch_to_target_io_mode(const struct device *dev)
 			       &dev_config->mspi_nor_cfg);
 }
 
+#if defined(WITH_SUPPLY_GPIO)
+static int power_supply(const struct device *dev)
+{
+	const struct flash_mspi_nor_config *dev_config = dev->config;
+	int rc;
+
+	if (!gpio_is_ready_dt(&dev_config->supply)) {
+		LOG_ERR("Device %s is not ready",
+			dev_config->supply.port->name);
+		return -ENODEV;
+	}
+
+	rc = gpio_pin_configure_dt(&dev_config->supply, GPIO_OUTPUT_ACTIVE);
+	if (rc < 0) {
+		LOG_ERR("Failed to activate power supply GPIO: %d", rc);
+		return -EIO;
+	}
+
+	return 0;
+}
+#endif
+
 #if defined(WITH_RESET_GPIO)
 static int gpio_reset(const struct device *dev)
 {
 	const struct flash_mspi_nor_config *dev_config = dev->config;
 	int rc;
 
-	if (dev_config->reset.port) {
-		if (!gpio_is_ready_dt(&dev_config->reset)) {
-			LOG_ERR("Device %s is not ready",
-				dev_config->reset.port->name);
-			return -ENODEV;
-		}
-
-		rc = gpio_pin_configure_dt(&dev_config->reset,
-					   GPIO_OUTPUT_ACTIVE);
-		if (rc < 0) {
-			LOG_ERR("Failed to activate RESET: %d", rc);
-			return -EIO;
-		}
+	if (!gpio_is_ready_dt(&dev_config->reset)) {
+		LOG_ERR("Device %s is not ready",
+			dev_config->reset.port->name);
+		return -ENODEV;
+	}
 
-		if (dev_config->reset_pulse_us != 0) {
-			k_busy_wait(dev_config->reset_pulse_us);
-		}
+	rc = gpio_pin_configure_dt(&dev_config->reset, GPIO_OUTPUT_ACTIVE);
+	if (rc < 0) {
+		LOG_ERR("Failed to activate RESET: %d", rc);
+		return -EIO;
+	}
 
-		rc = gpio_pin_set_dt(&dev_config->reset, 0);
-		if (rc < 0) {
-			LOG_ERR("Failed to deactivate RESET: %d", rc);
-			return -EIO;
-		}
+	if (dev_config->reset_pulse_us != 0) {
+		k_busy_wait(dev_config->reset_pulse_us);
+	}
 
-		if (dev_config->reset_recovery_us != 0) {
-			k_busy_wait(dev_config->reset_recovery_us);
-		}
+	rc = gpio_pin_set_dt(&dev_config->reset, 0);
+	if (rc < 0) {
+		LOG_ERR("Failed to deactivate RESET: %d", rc);
+		return -EIO;
 	}
 
 	return 0;
@@ -912,10 +927,6 @@ static int soft_reset(const struct device *dev)
 		return rc;
 	}
 
-	if (dev_config->reset_recovery_us != 0) {
-		k_busy_wait(dev_config->reset_recovery_us);
-	}
-
 	return 0;
 }
 #endif /* WITH_SOFT_RESET */
@@ -925,6 +936,7 @@ static int flash_chip_init(const struct device *dev)
 	const struct flash_mspi_nor_config *dev_config = dev->config;
 	struct flash_mspi_nor_data *dev_data = dev->data;
 	uint8_t id[JESD216_READ_ID_LEN] = {0};
+	bool flash_reset = false;
 	int rc;
 
 	rc = mspi_dev_config(dev_config->bus, &dev_config->mspi_id,
@@ -936,12 +948,25 @@ static int flash_chip_init(const struct device *dev)
 
 	dev_data->in_target_io_mode = false;
 
+#if defined(WITH_SUPPLY_GPIO)
+	if (dev_config->supply.port) {
+		rc = power_supply(dev);
+		if (rc < 0) {
+			return rc;
+		}
+
+		flash_reset = true;
+	}
+#endif
+
 #if defined(WITH_RESET_GPIO)
-	rc = gpio_reset(dev);
+	if (dev_config->reset.port) {
+		rc = gpio_reset(dev);
+		if (rc < 0) {
+			return rc;
+		}
 
-	if (rc < 0) {
-		LOG_ERR("Failed to reset with GPIO: %d", rc);
-		return rc;
+		flash_reset = true;
 	}
 #endif
 
@@ -951,9 +976,15 @@ static int flash_chip_init(const struct device *dev)
 		if (rc < 0) {
 			return rc;
 		}
+
+		flash_reset = true;
 	}
 #endif
 
+	if (flash_reset && dev_config->reset_recovery_us != 0) {
+		k_busy_wait(dev_config->reset_recovery_us);
+	}
+
 	if (dev_config->quirks != NULL &&
 	    dev_config->quirks->pre_init != NULL) {
 		rc = dev_config->quirks->pre_init(dev);
@@ -1172,6 +1203,8 @@ BUILD_ASSERT((FLASH_SIZE(inst) % CONFIG_FLASH_MSPI_NOR_LAYOUT_PAGE_SIZE) == 0, \
 		.mspi_nor_init_cfg = FLASH_INITIAL_CONFIG(inst),		\
 	IF_ENABLED(CONFIG_MSPI_XIP,						\
 		(.xip_cfg = MSPI_XIP_CONFIG_DT_INST(inst),))			\
+	IF_ENABLED(WITH_SUPPLY_GPIO,						\
+		(.supply = GPIO_DT_SPEC_INST_GET_OR(inst, supply_gpios, {0}),))	\
 	IF_ENABLED(WITH_RESET_GPIO,						\
 		(.reset = GPIO_DT_SPEC_INST_GET_OR(inst, reset_gpios, {0}),	\
 		 .reset_pulse_us = DT_INST_PROP_OR(inst, t_reset_pulse, 0)	\

drivers/flash/flash_mspi_nor.h

@@ -16,6 +16,9 @@ extern "C" {
 #include "jesd216.h"
 #include "spi_nor.h"
 
+#if DT_ANY_INST_HAS_PROP_STATUS_OKAY(supply_gpios)
+#define WITH_SUPPLY_GPIO 1
+#endif
 #if DT_ANY_INST_HAS_PROP_STATUS_OKAY(reset_gpios)
 #define WITH_RESET_GPIO 1
 #endif
@@ -72,6 +75,9 @@ struct flash_mspi_nor_config {
 #if defined(CONFIG_MSPI_XIP)
 	struct mspi_xip_cfg xip_cfg;
 #endif
+#if defined(WITH_SUPPLY_GPIO)
+	struct gpio_dt_spec supply;
+#endif
 #if defined(WITH_RESET_GPIO)
 	struct gpio_dt_spec reset;
 	uint32_t reset_pulse_us;

dts/bindings/mtd/jedec,mspi-nor.yaml

@@ -22,6 +22,8 @@ properties:
     type: int
     description: |
       Minimum time, in nanoseconds, the flash chip needs to recover after reset.
+      Such delay is performed when a GPIO or software reset is done, or after
+      power is supplied to the chip if the "supply-gpios" property is specified.
 
   transfer-timeout:
     type: int