[nrf fromtree] drivers: flash_mspi_nor: Add Soft Reset

Add implementation of the most common Soft Reset routine (sequence of
reset enable instruction 0x66 and reset instruction 0x99).

Signed-off-by: Andrzej Głąbek <[email protected]>
(cherry picked from commit ff13d40)

Author: anangl

drivers/flash/flash_mspi_nor.c

@@ -887,6 +887,77 @@ static int gpio_reset(const struct device *dev)
 }
 #endif
 
+#if defined(WITH_SOFT_RESET)
+static int soft_reset_66_99(const struct device *dev)
+{
+	int rc;
+
+	set_up_xfer(dev, MSPI_TX);
+	rc = perform_xfer(dev, SPI_NOR_CMD_RESET_EN, false);
+	if (rc < 0) {
+		LOG_ERR("CMD_RESET_EN failed: %d", rc);
+		return rc;
+	}
+
+	set_up_xfer(dev, MSPI_TX);
+	rc = perform_xfer(dev, SPI_NOR_CMD_RESET_MEM, false);
+	if (rc < 0) {
+		LOG_ERR("CMD_RESET_MEM failed: %d", rc);
+		return rc;
+	}
+
+	return 0;
+}
+
+static int soft_reset(const struct device *dev)
+{
+	const struct flash_mspi_nor_config *dev_config = dev->config;
+	struct flash_mspi_nor_data *dev_data = dev->data;
+	int rc;
+
+	/* If the flash may expect commands sent in multi-line mode,
+	 * send additionally the reset sequence this way.
+	 */
+	if (dev_config->multi_io_cmd) {
+		rc = mspi_dev_config(dev_config->bus, &dev_config->mspi_id,
+				     MSPI_DEVICE_CONFIG_IO_MODE,
+				     &dev_config->mspi_nor_cfg);
+		if (rc < 0) {
+			LOG_ERR("%s: dev_config() failed: %d", __func__, rc);
+			return rc;
+		}
+
+		dev_data->in_target_io_mode = true;
+
+		rc = soft_reset_66_99(dev);
+		if (rc < 0) {
+			return rc;
+		}
+
+		rc = mspi_dev_config(dev_config->bus, &dev_config->mspi_id,
+				     MSPI_DEVICE_CONFIG_IO_MODE,
+				     &dev_config->mspi_nor_init_cfg);
+		if (rc < 0) {
+			LOG_ERR("%s: dev_config() failed: %d", __func__, rc);
+			return rc;
+		}
+
+		dev_data->in_target_io_mode = false;
+	}
+
+	rc = soft_reset_66_99(dev);
+	if (rc < 0) {
+		return rc;
+	}
+
+	if (dev_config->reset_recovery_us != 0) {
+		k_busy_wait(dev_config->reset_recovery_us);
+	}
+
+	return 0;
+}
+#endif /* WITH_SOFT_RESET */
+
 static int flash_chip_init(const struct device *dev)
 {
 	const struct flash_mspi_nor_config *dev_config = dev->config;
@@ -938,6 +1009,15 @@ static int flash_chip_init(const struct device *dev)
 	}
 #endif
 
+#if defined(WITH_SOFT_RESET)
+	if (dev_config->initial_soft_reset) {
+		rc = soft_reset(dev);
+		if (rc < 0) {
+			return rc;
+		}
+	}
+#endif
+
 	if (dev_config->quirks != NULL &&
 	    dev_config->quirks->pre_init != NULL) {
 		rc = dev_config->quirks->pre_init(dev);
@@ -1212,10 +1292,10 @@ BUILD_ASSERT((FLASH_SIZE(inst) % CONFIG_FLASH_MSPI_NOR_LAYOUT_PAGE_SIZE) == 0, \
 		(.xip_cfg = MSPI_XIP_CONFIG_DT_INST(inst),))			\
 	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)	\
-				/ 1000,						\
+		 .reset_pulse_us = DT_INST_PROP_OR(inst, t_reset_pulse, 0)	\
+				 / 1000,))					\
 		.reset_recovery_us = DT_INST_PROP_OR(inst, t_reset_recovery, 0)	\
-				   / 1000,))					\
+				   / 1000,					\
 		.transfer_timeout = DT_INST_PROP(inst, transfer_timeout),	\
 		FLASH_PAGE_LAYOUT_DEFINE(inst)					\
 		.jedec_id = DT_INST_PROP_OR(inst, jedec_id, {0}),		\
@@ -1228,6 +1308,7 @@ BUILD_ASSERT((FLASH_SIZE(inst) % CONFIG_FLASH_MSPI_NOR_LAYOUT_PAGE_SIZE) == 0, \
 		.multiperipheral_bus = DT_PROP(DT_INST_BUS(inst),		\
 					       software_multiperipheral),	\
 		IO_MODE_FLAGS(DT_INST_ENUM_IDX(inst, mspi_io_mode)),		\
+		.initial_soft_reset = DT_INST_PROP(inst, initial_soft_reset),	\
 	};									\
 	FLASH_PAGE_LAYOUT_CHECK(inst)						\
 	DEVICE_DT_INST_DEFINE(inst,						\

drivers/flash/flash_mspi_nor.h

@@ -19,6 +19,9 @@ extern "C" {
 #if DT_ANY_INST_HAS_PROP_STATUS_OKAY(reset_gpios)
 #define WITH_RESET_GPIO 1
 #endif
+#if DT_ANY_INST_HAS_BOOL_STATUS_OKAY(initial_soft_reset)
+#define WITH_SOFT_RESET 1
+#endif
 
 #define CMD_EXTENSION_NONE    0
 #define CMD_EXTENSION_SAME    1
@@ -75,8 +78,8 @@ struct flash_mspi_nor_config {
 #if defined(WITH_RESET_GPIO)
 	struct gpio_dt_spec reset;
 	uint32_t reset_pulse_us;
-	uint32_t reset_recovery_us;
 #endif
+	uint32_t reset_recovery_us;
 	uint32_t transfer_timeout;
 #if defined(CONFIG_FLASH_PAGE_LAYOUT)
 	struct flash_pages_layout layout;
@@ -91,6 +94,7 @@ struct flash_mspi_nor_config {
 	bool multiperipheral_bus : 1;
 	bool multi_io_cmd        : 1;
 	bool single_io_addr      : 1;
+	bool initial_soft_reset  : 1;
 };
 
 struct flash_mspi_nor_data {

drivers/flash/flash_mspi_nor_sfdp.h

@@ -6,6 +6,8 @@
 
 #ifdef CONFIG_FLASH_MSPI_NOR_USE_SFDP
 
+#define BFP_DW16_SOFT_RESET_66_99 BIT(4)
+
 #define BFP_DW16_4B_ADDR_ENTER_B7    BIT(0)
 #define BFP_DW16_4B_ADDR_ENTER_06_B7 BIT(1)
 #define BFP_DW16_4B_ADDR_PER_CMD     BIT(5)
@@ -359,6 +361,11 @@
 			 BFP_DW16_4B_ADDR_PER_CMD | \
 			 BFP_DW16_4B_ADDR_ALWAYS)), \
 		"No supported method of entering 4-byte addressing mode for " \
+			DT_NODE_FULL_NAME(DT_DRV_INST(inst))); \
+	BUILD_ASSERT(!DT_INST_PROP(inst, initial_soft_reset) || \
+		     (SFDP_FIELD(inst, sfdp_bfp, 16, GENMASK(13, 8)) \
+		      & BFP_DW16_SOFT_RESET_66_99), \
+		"Cannot use 66h/99h soft reset sequence for " \
 			DT_NODE_FULL_NAME(DT_DRV_INST(inst)))
 
 #else

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

@@ -52,3 +52,9 @@ properties:
       codes for commands that require addresses (like Read, Page Program,
       or Erase) if those are supported by the flash chip, or if necessary,
       it will switch the chip to 4-byte addressing mode.
+
+  initial-soft-reset:
+    type: boolean
+    description: |
+      When set, the flash driver performs software reset of the flash chip
+      at initialization.