[nrf fromtree] drivers: flash_mspi_nor: Get info from dts SFDP arrays

Get parameters for used flash commands and requirements for enabling
Quad and Octal modes from dts uint8-arrays containing data read from
SFDP tables for particular flash chips.
Also introduce `pre_init` quirk that allows alteration of the above
parameters or complementation of them in a specific way for particular
flash chip families.

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

Author: anangl

boards/nordic/nrf54h20dk/nrf54h20dk_nrf54h20_cpuapp.dts

@@ -285,6 +285,13 @@ slot3_partition: &cpurad_slot1_partition {
 			30 b0 30 b0  f4 bd d5 5c  00 00 00 ff  10 10 00 20
 			00 00 00 00  00 00 7c 23  48 00 00 00  00 00 88 88
 		];
+		sfdp-ff05 = [
+			00 ee c0 69  72 72 71 71  00 d8 f7 f6  00 0a 00 00
+			14 45 98 80
+		];
+		sfdp-ff84 = [
+			43 06 0f 00  21 dc ff ff
+		];
 		size = <67108864>;
 		has-dpd;
 		t-enter-dpd = <10000>;

boards/nordic/nrf9280pdk/nrf9280pdk_nrf9280_cpuapp.dts

@@ -265,6 +265,13 @@ ipc0: &cpuapp_cpurad_ipc {
 			30 b0 30 b0  f4 bd d5 5c  00 00 00 ff  10 10 00 20
 			00 00 00 00  00 00 7c 23  48 00 00 00  00 00 88 88
 		];
+		sfdp-ff05 = [
+			00 ee c0 69  72 72 71 71  00 d8 f7 f6  00 0a 00 00
+			14 45 98 80
+		];
+		sfdp-ff84 = [
+			43 06 0f 00  21 dc ff ff
+		];
 		size = <67108864>;
 		has-dpd;
 		t-enter-dpd = <10000>;

drivers/flash/Kconfig.mspi

@@ -39,6 +39,24 @@ menuconfig FLASH_MSPI_NOR
 
 if FLASH_MSPI_NOR
 
+config FLASH_MSPI_NOR_USE_SFDP
+	bool "Use Serial Flash Discoverable Parameters (SFDP)"
+	default $(dt_compat_any_has_prop,$(DT_COMPAT_JEDEC_MSPI_NOR),sfdp-bfp)
+	help
+	  Use information from SFDP for setting up flash command transfers
+	  and for configuring the flash chip.
+
+	  Currently, only build time processing of SFDP structures is supported,
+	  based on dts arrays provided as flash node properties like `sfdp-bfp`,
+	  `sfdp-ff05`, and `sfdp-ff84`. Depending on the IO mode used, some or
+	  all of these properties are required for building the flash driver.
+	  Data for these properties can be obtained with the `drivers/jesd216`
+	  sample. If a given SFDP table is not available in a flash chip,
+	  the related property can be defined as an empty array - this will
+	  prevent a related build assertion from failing and default values
+	  will be assigned to parameters that would otherwise be read from
+	  that SFDP table.
+
 config FLASH_MSPI_NOR_LAYOUT_PAGE_SIZE
 	int "Page size to use for FLASH_LAYOUT feature"
 	depends on FLASH_PAGE_LAYOUT

drivers/flash/flash_mspi_nor.c

@@ -12,10 +12,12 @@
 #include <zephyr/pm/device_runtime.h>
 
 #include "flash_mspi_nor.h"
-#include "flash_mspi_nor_quirks.h"
+#include "flash_mspi_nor_sfdp.h"
 
 LOG_MODULE_REGISTER(flash_mspi_nor, CONFIG_FLASH_LOG_LEVEL);
 
+#include "flash_mspi_nor_quirks.h"
+
 void flash_mspi_command_set(const struct device *dev, const struct flash_mspi_nor_cmd *cmd)
 {
 	struct flash_mspi_nor_data *dev_data = dev->data;
@@ -110,7 +112,9 @@ static inline uint32_t dev_flash_size(const struct device *dev)
 
 static inline uint16_t dev_page_size(const struct device *dev)
 {
-	return SPI_NOR_PAGE_SIZE;
+	const struct flash_mspi_nor_config *dev_config = dev->config;
+
+	return dev_config->page_size;
 }
 
 static int api_read(const struct device *dev, off_t addr, void *dest,
@@ -534,7 +538,7 @@ static int quad_enable_set(const struct device *dev, bool enable)
 		return rc;
 	}
 
-	if (dev_config->dw15_qer == JESD216_DW15_QER_VAL_S1B6) {
+	if (dev_data->switch_info.quad_enable_req == JESD216_DW15_QER_VAL_S1B6) {
 		const struct flash_mspi_nor_cmd cmd_status = {
 			.dir = MSPI_TX,
 			.cmd = SPI_NOR_CMD_WRSR,
@@ -570,10 +574,11 @@ static int quad_enable_set(const struct device *dev, bool enable)
 static int default_io_mode(const struct device *dev)
 {
 	const struct flash_mspi_nor_config *dev_config = dev->config;
+	struct flash_mspi_nor_data *dev_data = dev->data;
 	enum mspi_io_mode io_mode = dev_config->mspi_nor_cfg.io_mode;
 	int rc = 0;
 
-	if (dev_config->dw15_qer != JESD216_DW15_QER_VAL_NONE) {
+	if (dev_data->switch_info.quad_enable_req != JESD216_DW15_QER_VAL_NONE) {
 		/* For Quad 1-1-4 and 1-4-4, entering or leaving mode is defined
 		 * in JEDEC216 BFP DW15 QER
 		 */
@@ -657,7 +662,7 @@ static int flash_chip_init(const struct device *dev)
 	/* Some chips reuse RESET pin for data in Quad modes:
 	 * force single line mode before resetting.
 	 */
-	if (dev_config->dw15_qer != JESD216_DW15_QER_VAL_NONE &&
+	if (dev_data->switch_info.quad_enable_req != JESD216_DW15_QER_VAL_NONE &&
 	    (io_mode == MSPI_IO_MODE_SINGLE ||
 	     io_mode == MSPI_IO_MODE_QUAD_1_1_4 ||
 	     io_mode == MSPI_IO_MODE_QUAD_1_4_4)) {
@@ -685,6 +690,11 @@ static int flash_chip_init(const struct device *dev)
 	}
 #endif
 
+	if (dev_config->quirks != NULL &&
+	    dev_config->quirks->pre_init != NULL) {
+		rc = dev_config->quirks->pre_init(dev);
+	}
+
 	flash_mspi_command_set(dev, &commands_single.id);
 	dev_data->packet.data_buf  = id;
 	dev_data->packet.num_bytes = sizeof(id);
@@ -749,6 +759,11 @@ static int drv_init(const struct device *dev)
 		return -ENODEV;
 	}
 
+	memcpy(dev_data->erase_types, dev_config->default_erase_types,
+	       sizeof(dev_data->erase_types));
+	dev_data->cmd_info = dev_config->default_cmd_info;
+	dev_data->switch_info = dev_config->default_switch_info;
+
 	rc = pm_device_runtime_get(dev_config->bus);
 	if (rc < 0) {
 		LOG_ERR("pm_device_runtime_get() failed: %d", rc);
@@ -800,8 +815,6 @@ static DEVICE_API(flash, drv_api) = {
 	.dqs_enable = false,						\
 }
 
-#define FLASH_SIZE_INST(inst) (DT_INST_PROP(inst, size) / 8)
-
 /* Define copies of mspi_io_mode enum values, so they can be used inside
  * the COND_CODE_1 macros.
  */
@@ -836,23 +849,17 @@ extern const struct flash_mspi_nor_cmds mspi_io_mode_not_supported;
 
 #define FLASH_QUIRKS(inst) FLASH_MSPI_QUIRKS_GET(DT_DRV_INST(inst))
 
-#define FLASH_DW15_QER_VAL(inst) _CONCAT(JESD216_DW15_QER_VAL_, \
-	DT_INST_STRING_TOKEN(inst, quad_enable_requirements))
-#define FLASH_DW15_QER(inst) COND_CODE_1(DT_INST_NODE_HAS_PROP(inst, quad_enable_requirements), \
-	(FLASH_DW15_QER_VAL(inst)), (JESD216_DW15_QER_VAL_NONE))
-
-
 #if defined(CONFIG_FLASH_PAGE_LAYOUT)
 BUILD_ASSERT((CONFIG_FLASH_MSPI_NOR_LAYOUT_PAGE_SIZE % 4096) == 0,
 	"MSPI_NOR_FLASH_LAYOUT_PAGE_SIZE must be multiple of 4096");
 #define FLASH_PAGE_LAYOUT_DEFINE(inst) \
 	.layout = { \
 		.pages_size = CONFIG_FLASH_MSPI_NOR_LAYOUT_PAGE_SIZE, \
-		.pages_count = FLASH_SIZE_INST(inst) \
+		.pages_count = FLASH_SIZE(inst) \
 			     / CONFIG_FLASH_MSPI_NOR_LAYOUT_PAGE_SIZE, \
 	},
 #define FLASH_PAGE_LAYOUT_CHECK(inst) \
-BUILD_ASSERT((FLASH_SIZE_INST(inst) % CONFIG_FLASH_MSPI_NOR_LAYOUT_PAGE_SIZE) == 0, \
+BUILD_ASSERT((FLASH_SIZE(inst) % CONFIG_FLASH_MSPI_NOR_LAYOUT_PAGE_SIZE) == 0, \
 	"MSPI_NOR_FLASH_LAYOUT_PAGE_SIZE incompatible with flash size, instance " #inst);
 #else
 #define FLASH_PAGE_LAYOUT_DEFINE(inst)
@@ -874,11 +881,14 @@ BUILD_ASSERT((FLASH_SIZE_INST(inst) % CONFIG_FLASH_MSPI_NOR_LAYOUT_PAGE_SIZE) ==
 		     (DT_INST_ENUM_IDX(inst, mspi_io_mode) ==			\
 		      MSPI_IO_MODE_OCTAL),					\
 		"Only 1x, 1-4-4 and 8x I/O modes are supported for now");	\
+	SFDP_BUILD_ASSERTS(inst);						\
 	PM_DEVICE_DT_INST_DEFINE(inst, dev_pm_action_cb);			\
+	DEFAULT_ERASE_TYPES_DEFINE(inst);					\
 	static struct flash_mspi_nor_data dev##inst##_data;			\
 	static const struct flash_mspi_nor_config dev##inst##_config = {	\
 		.bus = DEVICE_DT_GET(DT_INST_BUS(inst)),			\
-		.flash_size = FLASH_SIZE_INST(inst),				\
+		.flash_size = FLASH_SIZE(inst),					\
+		.page_size = FLASH_PAGE_SIZE(inst),				\
 		.mspi_id = MSPI_DEVICE_ID_DT_INST(inst),			\
 		.mspi_nor_cfg = MSPI_DEVICE_CONFIG_DT_INST(inst),		\
 		.mspi_nor_init_cfg = FLASH_INITIAL_CONFIG(inst),		\
@@ -899,7 +909,9 @@ BUILD_ASSERT((FLASH_SIZE_INST(inst) % CONFIG_FLASH_MSPI_NOR_LAYOUT_PAGE_SIZE) ==
 		.jedec_id = DT_INST_PROP(inst, jedec_id),			\
 		.jedec_cmds = FLASH_CMDS(inst),					\
 		.quirks = FLASH_QUIRKS(inst),					\
-		.dw15_qer = FLASH_DW15_QER(inst),				\
+		.default_erase_types = DEFAULT_ERASE_TYPES(inst),		\
+		.default_cmd_info = DEFAULT_CMD_INFO(inst),			\
+		.default_switch_info = DEFAULT_SWITCH_INFO(inst),		\
 	};									\
 	FLASH_PAGE_LAYOUT_CHECK(inst)						\
 	DEVICE_DT_INST_DEFINE(inst,						\

drivers/flash/flash_mspi_nor.h

@@ -20,9 +20,52 @@ extern "C" {
 #define WITH_RESET_GPIO 1
 #endif
 
+#define CMD_EXTENSION_NONE    0
+#define CMD_EXTENSION_SAME    1
+#define CMD_EXTENSION_INVERSE 2
+
+#define OCTAL_ENABLE_REQ_NONE 0
+#define OCTAL_ENABLE_REQ_S2B3 1
+
+#define ENTER_4BYTE_ADDR_NONE  0
+#define ENTER_4BYTE_ADDR_B7    1
+#define ENTER_4BYTE_ADDR_06_B7 2
+
+struct flash_mspi_nor_cmd_info {
+	uint8_t read_cmd;
+	uint8_t read_mode_bit_cycles : 3;
+	uint8_t read_dummy_cycles    : 5;
+	uint8_t pp_cmd;
+	bool    uses_4byte_addr : 1;
+	/* BFP, 18th DWORD, bits 30-29 */
+	uint8_t cmd_extension   : 2;
+	/* xSPI Profile 1.0 (ID FF05), 1st DWORD: */
+	/* - Read SFDP command address bytes: 4 (true) or 3 */
+	bool    sfdp_addr_4     : 1;
+	/* - Read SDFP command dummy cycles: 20 (true) or 8 */
+	bool    sfdp_dummy_20   : 1;
+	/* - Read Status Register command address bytes: 4 (true) or 0 */
+	bool    rdsr_addr_4     : 1;
+	/* - Read Status Register command dummy cycles: 0, 4, or 8 */
+	uint8_t rdsr_dummy      : 4;
+	/* - Read JEDEC ID command parameters; not sure where to get their
+	 *   values from, but since for many flash chips they are the same
+	 *   as for RDSR, those are taken as defaults, see DEFAULT_CMD_INFO()
+	 */
+	bool    rdid_addr_4     : 1;
+	uint8_t rdid_dummy      : 4;
+};
+
+struct flash_mspi_nor_switch_info {
+	uint8_t quad_enable_req  : 3;
+	uint8_t octal_enable_req : 3;
+	uint8_t enter_4byte_addr : 2;
+};
+
 struct flash_mspi_nor_config {
 	const struct device *bus;
 	uint32_t flash_size;
+	uint16_t page_size;
 	struct mspi_dev_id mspi_id;
 	struct mspi_dev_cfg mspi_nor_cfg;
 	struct mspi_dev_cfg mspi_nor_init_cfg;
@@ -42,14 +85,19 @@ struct flash_mspi_nor_config {
 	uint8_t jedec_id[SPI_NOR_MAX_ID_LEN];
 	const struct flash_mspi_nor_cmds *jedec_cmds;
 	struct flash_mspi_nor_quirks *quirks;
-	uint8_t dw15_qer;
+	const struct jesd216_erase_type *default_erase_types;
+	struct flash_mspi_nor_cmd_info default_cmd_info;
+	struct flash_mspi_nor_switch_info default_switch_info;
 };
 
 struct flash_mspi_nor_data {
 	struct k_sem acquired;
 	struct mspi_xfer_packet packet;
 	struct mspi_xfer xfer;
 	struct mspi_dev_cfg *curr_cfg;
+	struct jesd216_erase_type erase_types[JESD216_NUM_ERASE_TYPES];
+	struct flash_mspi_nor_cmd_info cmd_info;
+	struct flash_mspi_nor_switch_info switch_info;
 };
 
 struct flash_mspi_nor_cmd {

drivers/flash/flash_mspi_nor_quirks.h

@@ -9,6 +9,13 @@
 
 /* Flash chip specific quirks */
 struct flash_mspi_nor_quirks {
+	/* Called at the beginning of the flash chip initialization,
+	 * right after reset if any is performed. Can be used to alter
+	 * structures that define communication with the chip, like
+	 * `cmd_info`, `switch_info`, and `erase_types`, which are set
+	 * to default values at this point.
+	 */
+	int (*pre_init)(const struct device *dev);
 	/* Called after switching to default IO mode. */
 	int (*post_switch_mode)(const struct device *dev);
 };
@@ -176,7 +183,56 @@ static inline int mxicy_mx25u_post_switch_mode(const struct device *dev)
 	return rc;
 }
 
+static int mxicy_mx25u_pre_init(const struct device *dev)
+{
+	const struct flash_mspi_nor_config *dev_config = dev->config;
+	struct flash_mspi_nor_data *dev_data = dev->data;
+	static const uint8_t dummy_cycles[8] = {
+		20, 18, 16, 14, 12, 10, 8, 6
+	};
+	uint8_t cfg_reg;
+	int rc;
+
+	if (dev_config->mspi_nor_cfg.io_mode != MSPI_IO_MODE_OCTAL) {
+		return 0;
+	}
+
+	if (dev_config->mspi_nor_cfg.data_rate == MSPI_DATA_RATE_SINGLE) {
+		dev_data->cmd_info.cmd_extension = CMD_EXTENSION_INVERSE;
+	}
+
+	/*
+	 * TODO - replace this with a generic routine that uses information
+	 *        from SFDP header FF87 (Status, Control and Configuration
+	 *        Register Map)
+	 */
+
+	/* Read configured number of dummy cycles for memory reading commands. */
+	const struct flash_mspi_nor_cmd cmd_rd_cr2 = {
+		.dir = MSPI_RX,
+		.cmd = SPI_NOR_CMD_RD_CFGREG2,
+		.cmd_length = 1,
+		.addr_length = 4,
+	};
+
+	flash_mspi_command_set(dev, &cmd_rd_cr2);
+	dev_data->packet.address   = 0x300;
+	dev_data->packet.data_buf  = &cfg_reg;
+	dev_data->packet.num_bytes = sizeof(cfg_reg);
+	rc = mspi_transceive(dev_config->bus, &dev_config->mspi_id, &dev_data->xfer);
+	if (rc < 0) {
+		LOG_ERR("Failed to read Dummy Cycle from CFGREG2");
+		return rc;
+	}
+
+	dev_data->cmd_info.read_mode_bit_cycles = 0;
+	dev_data->cmd_info.read_dummy_cycles = dummy_cycles[cfg_reg & 0x7];
+
+	return 0;
+}
+
 struct flash_mspi_nor_quirks flash_quirks_mxicy_mx25u = {
+	.pre_init = mxicy_mx25u_pre_init,
 	.post_switch_mode = mxicy_mx25u_post_switch_mode,
 };