Skip to contentSkip to conversation

Add octal DTR support for Macronix flash

PATCH Superseded JaimeLiao 2 participants 8 messages Sep 13, 2021 – Sep 27, 2021

Subsystems (2)

v3 of 9 Superseded Latest is v9 →

lore
Share & tools
lore

JaimeLiao

author
#0 lore raw

v3 cover Add octal DTR support for Macronix flash

This series add support for Macronix octal DTR flash, add second time Softreset with "INVERT" command extension type and follow linux kernel to enable 4byte opcode when possible.

v3:
Add flag SPI_NOR_CMD_EXT_INVERT to seperate command extension types. replace CONFIG_SPI_FLASH_MACRONIX with SPI_FLASH_MACRONIX_OCTAL for spi_nor_macronix_octal_dtr_enable function.
v2:
add ret checking for write enable in spi_nor_macronix_octal_dtr_enable function.

JaimeLiao (4):
mtd: spi-nor: macronix: add support for Macronix Octal
mtd: spi-nor-core: Adding different type of command extension in Soft
Reset
mtd: spi-nor-core: set 4byte opcode when possible
mtd: spi-nor-core: Add support for Macronix Octal flash

 drivers/mtd/spi/Kconfig        | 13 +++++
 drivers/mtd/spi/spi-nor-core.c | 94 +++++++++++++++++++++++++++++++++-
 drivers/mtd/spi/spi-nor-ids.c  | 22 +++++++-
 include/linux/mtd/spi-nor.h    | 13 ++++-
 4 files changed, 138 insertions(+), 4 deletions(-)
Signature · 1 line
2.17.1
author
#1 lore raw

PATCH v3 1/4 mtd: spi-nor: macronix: add support for Macronix Octal

Follow patch "f6adec1af4b2f5d3012480c6cdce7743b74a6156" for adding Macronix flash in Octal DTR mode.

Enable Octal DTR mode with 20 dummy cycles to allow running at the
maximum supported frequency.
-https://www.mxic.com.tw/Lists/Datasheet/Attachments/7841/MX25LM51245G,%203V,%20512Mb,%20v1.1.pdf

---
 drivers/mtd/spi/Kconfig        |  7 +++
 drivers/mtd/spi/spi-nor-core.c | 83 ++++++++++++++++++++++++++++++++++
 include/linux/mtd/spi-nor.h    | 13 +++++-
 3 files changed, 101 insertions(+), 2 deletions(-)
drivers/mtd/spi/Kconfig +7 -0
index 1b2ef37e92..67599b32c9 100644
@@ -162,6 +162,13 @@ config SPI_FLASH_MACRONIX
 	help
 	  Add support for various Macronix SPI flash chips (MX25Lxxx)
 
+config SPI_FLASH_MACRONIX_OCTAL
+	bool "Macronix octal flash support"
+	depends on SPI_FLASH_MACRONIX
+	help
+	 Add support for the Macronix octal flash. This is a separate config
+	 because the fixup hooks octal enable for this flash.
+
 config SPI_FLASH_SPANSION
 	bool "Spansion SPI flash support"
 	help
drivers/mtd/spi/spi-nor-core.c +83 -0

95 lines not on this page · raw message

include/linux/mtd/spi-nor.h +11 -2
index 7ddc4ba2bf..2ad579f66d 100644
@@ -116,8 +116,17 @@
 #define XSR_RDY			BIT(7)	/* Ready */
 
 /* Used for Macronix and Winbond flashes. */
-#define SPINOR_OP_EN4B		0xb7	/* Enter 4-byte mode */
-#define SPINOR_OP_EX4B		0xe9	/* Exit 4-byte mode */
+#define SPINOR_OP_EN4B			0xb7		/* Enter 4-byte mode */
+#define SPINOR_OP_EX4B			0xe9		/* Exit 4-byte mode */
+#define SPINOR_OP_RD_CR2		0x71		/* Read configuration register 2 */
+#define SPINOR_OP_WR_CR2		0x72		/* Write configuration register 2 */
+#define SPINOR_OP_MXIC_DTR_RD		0xee		/* Fast Read opcode in DTR mode */
+#define SPINOR_REG_MXIC_CR2_MODE	0x00000000	/* For setting octal DTR mode */
+#define SPINOR_REG_MXIC_OPI_DTR_EN	0x2		/* Enable Octal DTR */
+#define SPINOR_REG_MXIC_OPI_DTR_DIS	0x1		/* Disable Octal DTR */
+#define SPINOR_REG_MXIC_CR2_DC		0x00000300	/* For setting dummy cycles */
+#define SPINOR_REG_MXIC_DC_20		0x0		/* Setting dummy cycles to 20 */
+#define MXIC_MAX_DC			20		/* Maximum value of dummy cycles */
 
 /* Used for Spansion flashes only. */
 #define SPINOR_OP_BRWR		0x17	/* Bank register write */
Signature · 1 line
2.17.1
author
#2 lore raw

PATCH v3 2/4 mtd: spi-nor-core: Adding different type of command extension in Soft Reset

In reply to JaimeLiao

Power-on-Reset is a method to restore flash back to 1S-1S-1S mode from 8D-8D-8D in the begging of probe.

Command extension type is not standardized across flash vendors in DTR mode.

For suiting different vendor flash devices, adding a flag to seperate types if nor->cmd_ext_type didn't configure from SFDP.

---
 drivers/mtd/spi/Kconfig        | 6 ++++++
 drivers/mtd/spi/spi-nor-core.c | 7 ++++++-
 2 files changed, 12 insertions(+), 1 deletion(-)
drivers/mtd/spi/Kconfig +6 -0
index 67599b32c9..d850480401 100644
@@ -97,6 +97,12 @@ config SPI_FLASH_SMART_HWCAPS
 	 can support a type of operation in a much more refined way compared
 	 to using flags like SPI_RX_DUAL, SPI_TX_QUAD, etc.
 
+config SPI_NOR_CMD_EXT_INVERT
+	bool "Command extension type is INVERT for SPI NOR flashed"
+	default n
+	help
+	 Define command extension type is INVERT.
+
 config SPI_FLASH_SOFT_RESET
 	bool "Software Reset support for SPI NOR flashes"
 	default n
drivers/mtd/spi/spi-nor-core.c +6 -1
index b8dda02aa7..4bcd58d839 100644
@@ -3661,7 +3661,12 @@ static int spi_nor_soft_reset(struct spi_nor *nor)
 	enum spi_nor_cmd_ext ext;
 
 	ext = nor->cmd_ext_type;
-	nor->cmd_ext_type = SPI_NOR_EXT_REPEAT;
+	if (!nor->cmd_ext_type) {
+		nor->cmd_ext_type = SPI_NOR_EXT_REPEAT;
+#ifdef CONFIG_SPI_NOR_CMD_EXT_INVERT
+		nor->cmd_ext_type = SPI_NOR_EXT_INVERT;
+#endif
+	}
 
 	op = (struct spi_mem_op)SPI_MEM_OP(SPI_MEM_OP_CMD(SPINOR_OP_SRSTEN, 0),
 			SPI_MEM_OP_NO_DUMMY,
Signature · 1 line
2.17.1
#3 lore raw

Re: [PATCH v3 2/4] mtd: spi-nor-core: Adding different type of command extension in Soft Reset

Quoted 2 lines · JaimeLiao

Power-on-Reset is a method to restore flash back to 1S-1S-1S mode from 8D-8D-8D in the begging of probe.

Typo: begging -> beginning

Quoted 5 lines

Command extension type is not standardized across flash vendors in DTR mode.

For suiting different vendor flash devices, adding a flag to seperate types if nor->cmd_ext_type didn't configure from SFDP.

No, the code does not do what the commit message says. The code only sets the extension for soft reset, which is then reset back to the default at the end of the function. Then we read from SFDP and do the usual initialization.

Quoted 12 lines
---
 drivers/mtd/spi/Kconfig        | 6 ++++++
 drivers/mtd/spi/spi-nor-core.c | 7 ++++++-
 2 files changed, 12 insertions(+), 1 deletion(-)
drivers/mtd/spi/Kconfig +0 -0
index 67599b32c9..d850480401 100644

drivers/mtd/spi/Kconfig config SPI_FLASH_SMART_HWCAPS · line 100

Quoted 4 lines
drivers/mtd/spi/Kconfig +1 -0
@@ -97,6 +97,12 @@ config SPI_FLASH_SMART_HWCAPS
 	 can support a type of operation in a much more refined way compared
 	 to using flags like SPI_RX_DUAL, SPI_TX_QUAD, etc.
 
+config SPI_NOR_CMD_EXT_INVERT

Let's only have this extension for the soft reset on boot, and then let the usual initialization process discover it via SFDP. This will make the code a little less complicated IMO.

So I suggest calling it SPI_NOR_BOOT_SOFT_RESET_EXT.

drivers/mtd/spi/Kconfig config SPI_FLASH_SMART_HWCAPS · line 104

Quoted 4 lines
drivers/mtd/spi/Kconfig +4 -0
+	bool "Command extension type is INVERT for SPI NOR flashed"
+	default n
+	help
+	 Define command extension type is INVERT.

And explain here that this only sets the extension for the soft reset on boot since we can't discover it at that point. Then we drop the information and rediscover it as normal via SFDP or flash fixup hooks.

Quoted 9 lines
drivers/mtd/spi/Kconfig +1 -0
+
 config SPI_FLASH_SOFT_RESET
 	bool "Software Reset support for SPI NOR flashes"
 	default n
drivers/mtd/spi/spi-nor-core.c +0 -0
index b8dda02aa7..4bcd58d839 100644

drivers/mtd/spi/spi-nor-core.c static int spi_nor_soft_reset(struct spi_nor *nor) · line 3664

Quoted 5 lines
drivers/mtd/spi/spi-nor-core.c +1 -1
@@ -3661,7 +3661,12 @@ static int spi_nor_soft_reset(struct spi_nor *nor)
 	enum spi_nor_cmd_ext ext;
 
 	ext = nor->cmd_ext_type;
-	nor->cmd_ext_type = SPI_NOR_EXT_REPEAT;
+	if (!nor->cmd_ext_type) {

Use (nor->cmd_ext_type == SPI_NOR_EXT_NONE). Also add a comment explaining here why you do this check.

drivers/mtd/spi/spi-nor-core.c static int spi_nor_soft_reset(struct spi_nor *nor) · line 3668

Quoted 4 lines
drivers/mtd/spi/spi-nor-core.c +4 -0
+		nor->cmd_ext_type = SPI_NOR_EXT_REPEAT;
+#ifdef CONFIG_SPI_NOR_CMD_EXT_INVERT
+		nor->cmd_ext_type = SPI_NOR_EXT_INVERT;
+#endif

Avoid using #ifdef. You can replace it with

  if (CONFIG_IS_ENABLED(SPI_NOR_CMD_EXT_INVERT))
      nor->cmd_ext_type = SPI_NOR_EXT_INVERT;
  else
      nor->cmd_ext_type = SPI_NOR_EXT_REPEAT;
Quoted 7 lines
drivers/mtd/spi/spi-nor-core.c +1 -0
+	}
 
 	op = (struct spi_mem_op)SPI_MEM_OP(SPI_MEM_OP_CMD(SPINOR_OP_SRSTEN, 0),
 			SPI_MEM_OP_NO_DUMMY,
Signature · 1 line
2.17.1
Signature · 3 lines
Regards,
Pratyush Yadav
Texas Instruments Inc.
author
#4 lore raw

PATCH v3 3/4 mtd: spi-nor-core: set 4byte opcode when possible

In reply to JaimeLiao

Following linux kernel to check address width and 4byte flag to enable 4byte opcode setting.

---
 drivers/mtd/spi/spi-nor-core.c | 4 ++++
 1 file changed, 4 insertions(+)
drivers/mtd/spi/spi-nor-core.c +4 -0
index 4bcd58d839..81c61d87bc 100644
@@ -3902,6 +3902,10 @@ int spi_nor_scan(struct spi_nor *nor)
 		return -EINVAL;
 	}
 
+	/* Set 4byte opcodes when possible. */
+	if (nor->addr_width == 4 && info->flags & SPI_NOR_4B_OPCODES)
+		spi_nor_set_4byte_opcodes(nor, info);
+
 	/* Send all the required SPI flash commands to initialize device */
 	ret = spi_nor_init(nor);
 	if (ret)
Signature · 1 line
2.17.1
#5 lore raw

Re: [PATCH v3 3/4] mtd: spi-nor-core: set 4byte opcode when possible

Quoted 13 lines · JaimeLiao

Following linux kernel to check address width and 4byte flag to enable 4byte opcode setting.

---
 drivers/mtd/spi/spi-nor-core.c | 4 ++++
 1 file changed, 4 insertions(+)
drivers/mtd/spi/spi-nor-core.c +0 -0
index 4bcd58d839..81c61d87bc 100644

drivers/mtd/spi/spi-nor-core.c int spi_nor_scan(struct spi_nor *nor) · line 3907

Quoted 6 lines
drivers/mtd/spi/spi-nor-core.c +3 -0
@@ -3902,6 +3902,10 @@ int spi_nor_scan(struct spi_nor *nor)
 		return -EINVAL;
 	}
 
+	/* Set 4byte opcodes when possible. */
+	if (nor->addr_width == 4 && info->flags & SPI_NOR_4B_OPCODES)
+		spi_nor_set_4byte_opcodes(nor, info);

This is already done a few lines above. Why do you need to do it again?

Quoted 7 lines
drivers/mtd/spi/spi-nor-core.c +1 -0
+
 	/* Send all the required SPI flash commands to initialize device */
 	ret = spi_nor_init(nor);
 	if (ret)
Signature · 1 line
2.17.1
Signature · 3 lines
Regards,
Pratyush Yadav
Texas Instruments Inc.
author
#6 lore raw

Re: [PATCH v3 3/4] mtd: spi-nor-core: set 4byte opcode when possible

Quoted 3 lines
if (spi_nor_protocol_is_dtr(nor->read_proto)) {
                /* Always use 4-byte addresses in DTR mode. */
               nor->addr_width = 4;

because of nor->addr_width have been set to 4 when protocol is dtr

Quoted 8 lines
       } else if (nor->addr_width) {
               /* already configured from SFDP */
       } else if (info->addr_width) {
               nor->addr_width = info->addr_width;
       } else {
               nor->addr_width = 3;
       }
Quoted 7 lines
       if (nor->addr_width == 3 && mtd->size > SZ_16M) {
#ifndef CONFIG_SPI_FLASH_BAR
               /* enable 4-byte addressing if the device exceeds 16MiB */
               nor->addr_width = 4;
               if (JEDEC_MFR(info) == SNOR_MFR_SPANSION ||
                   info->flags & SPI_NOR_4B_OPCODES)
                       spi_nor_set_4byte_opcodes(nor, info);

nor->addr_width is equal 4 when protocol is dtr
so we need a judgement to do spi_nor_set_4byte_opcodes(nor, info)

Quoted 8 lines
#else
       /* Configure the BAR - discover bank cmds and read current bank */
       nor->addr_width = 3;
       ret = read_bar(nor, info);
       if (ret < 0)
               return ret;
#endif
       }

Pratyush Yadav <[email protected]> 於 2021年9月25日 週六 上午2:29寫道:

Quoted 37 lines · JaimeLiao

Review

Quoted 9 lines

Following linux kernel to check address width and 4byte flag to enable 4byte opcode setting.

---
 drivers/mtd/spi/spi-nor-core.c | 4 ++++
 1 file changed, 4 insertions(+)
(quoted diff) +0 -0

b/drivers/mtd/spi/spi-nor-core.c

drivers/mtd/spi/spi-nor-core.c int spi_nor_scan(struct spi_nor *nor) · line 3907

Quoted 10 lines

index 4bcd58d839..81c61d87bc 100644

drivers/mtd/spi/spi-nor-core.c +3 -0
@@ -3902,6 +3902,10 @@ int spi_nor_scan(struct spi_nor *nor)
              return -EINVAL;
      }
 
+     /* Set 4byte opcodes when possible. */
+     if (nor->addr_width == 4 && info->flags & SPI_NOR_4B_OPCODES)
+             spi_nor_set_4byte_opcodes(nor, info);

This is already done a few lines above. Why do you need to do it again?

Quoted 7 lines
drivers/mtd/spi/spi-nor-core.c +1 -1
+
      /* Send all the required SPI flash commands to initialize device */
      ret = spi_nor_init(nor);
      if (ret)
--

2.17.1

--
Regards,
Pratyush Yadav
Texas Instruments Inc.

author
#7 lore raw

PATCH v3 4/4 mtd: spi-nor-core: Add support for Macronix Octal flash

In reply to JaimeLiao

Adding Macronix Octal flash for Octal DTR support.

The octaflash series can be divided into the following types:

MX25 series : Serial NOR Flash.
MX66 series : Serial NOR Flash with stacked die.(Size larger than 1Gb) LM/UM series : Up to 250MHz clock frequency with both DTR/STR operation. LW/UW series : Support simultaneous Read-while-Write operation in multiple
bank architecture. Read-while-write feature which means read data one bank while another bank is programing or erasing.

MX25LM : 3.0V Octal I/O
-https://www.mxic.com.tw/Lists/Datasheet/Attachments/7841/MX25LM51245G,%203V,%20512Mb,%20v1.1.pdf

MX25UM : 1.8V Octal I/O
-https://www.mxic.com.tw/Lists/Datasheet/Attachments/7525/MX25UM51245G%20Extreme%20Speed,%201.8V,%20512Mb,%20v1.0.pdf

MX66LM : 3.0V Octal I/O with stacked die
-https://www.mxic.com.tw/Lists/Datasheet/Attachments/7929/MX66LM1G45G,%203V,%201Gb,%20v1.1.pdf

MX66UM : 1.8V Octal I/O with stacked die
-https://www.mxic.com.tw/Lists/Datasheet/Attachments/7721/MX66UM1G45G,%201.8V,%201Gb,%20v1.1.pdf

MX25LW : 3.0V Octal I/O with Read-while-Write MX25UW : 1.8V Octal I/O with Read-while-Write MX66LW : 3.0V Octal I/O with Read-while-Write and stack die MX66UW : 1.8V Octal I/O with Read-while-Write and stack die

About LW/UW series, please contact us freely if you have any questions. For adding Octal NOR Flash IDs, we have validated each Flash on plateform zynq-picozed.

---
 drivers/mtd/spi/spi-nor-ids.c | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)
drivers/mtd/spi/spi-nor-ids.c +21 -1
index cb3a08872d..5c13ea3a78 100644
@@ -169,7 +169,27 @@ const struct flash_info spi_nor_ids[] = {
 	{ INFO("mx66l1g45g",  0xc2201b, 0, 64 * 1024, 2048, SECT_4K | SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ) },
 	{ INFO("mx25l1633e", 0xc22415, 0, 64 * 1024,   32, SPI_NOR_QUAD_READ | SPI_NOR_4B_OPCODES | SECT_4K) },
 	{ INFO("mx25r6435f", 0xc22817, 0, 64 * 1024,   128,  SECT_4K) },
-	{ INFO("mx66uw2g345g", 0xc2943c, 0, 64 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx66uw2g345gx0", 0xc2943c, 0, 64 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx66lm1g45g",    0xc2853b, 0, 32 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx25lm51245g",   0xc2853a, 0, 16 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx25lw51245g",   0xc2863a, 0, 16 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx25lm25645g",   0xc28539, 0, 8 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx66um2g45g",    0xc2803c, 0, 64 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx66uw2g345g",   0xc2843c, 0, 64 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx66um1g45g",    0xc2803b, 0, 32 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx66uw1g45g",    0xc2813b, 0, 32 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx25um51245g",   0xc2803a, 0, 16 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx25uw51245g",   0xc2813a, 0, 16 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx25uw51345g",   0xc2843a, 0, 16 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx25um25645g",   0xc28039, 0, 8 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx25uw25645g",   0xc28139, 0, 8 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx25um25345g",   0xc28339, 0, 8 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx25uw25345g",   0xc28439, 0, 8 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx25uw12845g",   0xc28138, 0, 4 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx25uw12a45g",   0xc28938, 0, 4 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx25uw12345g",   0xc28438, 0, 4 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx25uw6445g",    0xc28137, 0, 2 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
+	{ INFO("mx25uw6345g",    0xc28437, 0, 2 * 1024, 4096, SECT_4K | SPI_NOR_OCTAL_DTR_READ | SPI_NOR_4B_OPCODES) },
 #endif
 
 #ifdef CONFIG_SPI_FLASH_STMICRO		/* STMICRO */
Signature · 1 line
2.17.1