Skip to contentSkip to conversation

Add basic support for Foresee SPI NAND

PATCH Superseded Daniel Palmer 2 participants 5 messages Dec 29, 2020 – Jan 5, 2021

Subsystems (2)

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

cover Add basic support for Foresee SPI NAND

This is my very crude attempt at adding support for Longsys' Foresee branded SPI NAND parts that are showing up on some boards.

I fully admit I have no idea what I'm doing here and I basically took one of the existing files, ripped out what I didn't understand and tried to fill in the numbers from the datasheet without really knowing what they mean.

This worked well enough for me to get something that looks like a correct dump of the SPI NAND from a board I'm working with. I need the vendor firmware on the board for reverse engineering so I haven't actually tried to write anything yet.

The datasheet for this chip is linked. If someone that actually knows what they're doing could take a look and point out my mistakes that would be great.

Daniel Palmer (1):
mtd: spinand: add support for Foresee FS35ND01G

 drivers/mtd/nand/spi/Makefile  |  2 +-
 drivers/mtd/nand/spi/core.c    |  1 +
 drivers/mtd/nand/spi/longsys.c | 45 ++++++++++++++++++++++++++++++++++
 include/linux/mtd/spinand.h    |  1 +
 4 files changed, 48 insertions(+), 1 deletion(-)
 create mode 100644 drivers/mtd/nand/spi/longsys.c
Signature · 1 line
2.30.0.rc2
#1 lore raw

PATCH 1/1 mtd: spinand: add support for Foresee FS35ND01G

Add support for the Foresee FS35ND01G manufactured by Longsys.

---
 drivers/mtd/nand/spi/Makefile  |  2 +-
 drivers/mtd/nand/spi/core.c    |  1 +
 drivers/mtd/nand/spi/longsys.c | 45 ++++++++++++++++++++++++++++++++++
 include/linux/mtd/spinand.h    |  1 +
 4 files changed, 48 insertions(+), 1 deletion(-)
 create mode 100644 drivers/mtd/nand/spi/longsys.c
drivers/mtd/nand/spi/Makefile +1 -1
index 9662b9c1d5a9..1d6819022e43 100644
@@ -1,3 +1,3 @@
 # SPDX-License-Identifier: GPL-2.0
-spinand-objs := core.o gigadevice.o macronix.o micron.o paragon.o toshiba.o winbond.o
+spinand-objs := core.o gigadevice.o longsys.o macronix.o micron.o paragon.o toshiba.o winbond.o
 obj-$(CONFIG_MTD_SPI_NAND) += spinand.o
drivers/mtd/nand/spi/core.c +1 -0
index 8ea545bb924d..bdc9cd45d232 100644
@@ -856,6 +856,7 @@ static const struct nand_ops spinand_ops = {
 
 static const struct spinand_manufacturer *spinand_manufacturers[] = {
 	&gigadevice_spinand_manufacturer,
+	&longsys_spinand_manufacturer,
 	&macronix_spinand_manufacturer,
 	&micron_spinand_manufacturer,
 	&paragon_spinand_manufacturer,
drivers/mtd/nand/spi/longsys.c new file +45 -0

45 lines not on this page · raw message

include/linux/mtd/spinand.h +1 -0
index 6bb92f26833e..8651e63a2f8a 100644
@@ -239,6 +239,7 @@ struct spinand_manufacturer {
 
 /* SPI NAND manufacturers */
 extern const struct spinand_manufacturer gigadevice_spinand_manufacturer;
+extern const struct spinand_manufacturer longsys_spinand_manufacturer;
 extern const struct spinand_manufacturer macronix_spinand_manufacturer;
 extern const struct spinand_manufacturer micron_spinand_manufacturer;
 extern const struct spinand_manufacturer paragon_spinand_manufacturer;
Signature · 1 line
2.30.0.rc2
maintainer
#2 lore raw

Re: [PATCH 1/1] mtd: spinand: add support for Foresee FS35ND01G

Hi Daniel,

Daniel Palmer <[email protected]> wrote on Tue, 29 Dec 2020 14:50:59 +0900:

Quoted 1 line

Add support for the Foresee FS35ND01G manufactured by Longsys.

Thanks for contributing this back!

Perhaps giving the link of the datasheet here makes sense.

Quoted 38 lines
---
 drivers/mtd/nand/spi/Makefile  |  2 +-
 drivers/mtd/nand/spi/core.c    |  1 +
 drivers/mtd/nand/spi/longsys.c | 45 ++++++++++++++++++++++++++++++++++
 include/linux/mtd/spinand.h    |  1 +
 4 files changed, 48 insertions(+), 1 deletion(-)
 create mode 100644 drivers/mtd/nand/spi/longsys.c
drivers/mtd/nand/spi/Makefile +1 -1
index 9662b9c1d5a9..1d6819022e43 100644
@@ -1,3 +1,3 @@
 # SPDX-License-Identifier: GPL-2.0
-spinand-objs := core.o gigadevice.o macronix.o micron.o paragon.o toshiba.o winbond.o
+spinand-objs := core.o gigadevice.o longsys.o macronix.o micron.o paragon.o toshiba.o winbond.o
 obj-$(CONFIG_MTD_SPI_NAND) += spinand.o
drivers/mtd/nand/spi/core.c +1 -0
index 8ea545bb924d..bdc9cd45d232 100644
@@ -856,6 +856,7 @@ static const struct nand_ops spinand_ops = {
 
 static const struct spinand_manufacturer *spinand_manufacturers[] = {
 	&gigadevice_spinand_manufacturer,
+	&longsys_spinand_manufacturer,
 	&macronix_spinand_manufacturer,
 	&micron_spinand_manufacturer,
 	&paragon_spinand_manufacturer,
drivers/mtd/nand/spi/longsys.c new file +1 -0
new file mode 100644
index 000000000000..f18271f8e9d2
@@ -0,0 +1,45 @@
+// SPDX-License-Identifier: GPL-2.0

drivers/mtd/nand/spi/longsys.c line 11

Quoted 10 lines
drivers/mtd/nand/spi/longsys.c new file +10 -0
+/*
+ * Copyright (c) 2020 Daniel Palmer <[email protected]>
+ *
+ */
+
+#include <linux/device.h>
+#include <linux/kernel.h>
+#include <linux/mtd/spinand.h>
+
+#define SPINAND_MFR_LONGSYS		0xcd

Nitpick: I personally prefer uppercase hex numbers.

Quoted 4 lines
drivers/mtd/nand/spi/longsys.c new file +4 -0
+
+static SPINAND_OP_VARIANTS(read_cache_variants,
+		SPINAND_PAGE_READ_FROM_CACHE_OP(true, 0, 1, NULL, 0),
+		SPINAND_PAGE_READ_FROM_CACHE_OP(false, 0, 1, NULL, 0));

drivers/mtd/nand/spi/longsys.c line 25

Quoted 10 lines
drivers/mtd/nand/spi/longsys.c new file +10 -0
+
+static SPINAND_OP_VARIANTS(write_cache_variants,
+		SPINAND_PROG_LOAD(true, 0, NULL, 0));
+
+static SPINAND_OP_VARIANTS(update_cache_variants,
+		SPINAND_PROG_LOAD(false, 0, NULL, 0));
+
+static const struct spinand_info longsys_spinand_table[] = {
+	SPINAND_INFO("FS35ND01G",
+		     SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0xea, 0x11),

Ditto

drivers/mtd/nand/spi/longsys.c line 30

Quoted 5 lines
drivers/mtd/nand/spi/longsys.c new file +5 -0
+		     NAND_MEMORG(1, 2048, 64, 64, 1024, 20, 1, 1, 1),
+		     NAND_ECCREQ(4, 512),
+		     SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
+					      &write_cache_variants,
+					      &update_cache_variants),

This device probably supports more variants (especially dual/quad ones) but I guess it's not a problem to not have them here right now.

drivers/mtd/nand/spi/longsys.c line 33

Quoted 3 lines
drivers/mtd/nand/spi/longsys.c new file +3 -0
+		     SPINAND_HAS_QE_BIT,
+		     SPINAND_ECCINFO(NULL,
+				     NULL)),

You should define the ->ecc and ->free hooks of the mtd_ooblayout_ops structure and point to it here. It defines the free OOB bytes and bytes used by the on-die ECC engine. You should find this in the datasheet. You may look at other manufacturer drivers for examples of how it should be implemented. It is the way to tell the upper layers that eg. "byte 2 to 17 are ECC bytes, 18 until the end are free to use".

Quoted 17 lines
drivers/mtd/nand/spi/longsys.c new file +12 -0
+};
+
+static const struct spinand_manufacturer_ops longsys_spinand_manuf_ops = {
+};
+
+const struct spinand_manufacturer longsys_spinand_manufacturer = {
+	.id = SPINAND_MFR_LONGSYS,
+	.name = "Longsys",
+	.chips = longsys_spinand_table,
+	.nchips = ARRAY_SIZE(longsys_spinand_table),
+	.ops = &longsys_spinand_manuf_ops,
+};
include/linux/mtd/spinand.h +0 -0
index 6bb92f26833e..8651e63a2f8a 100644

include/linux/mtd/spinand.h struct spinand_manufacturer { · line 245

Quoted 7 lines
include/linux/mtd/spinand.h +1 -0
@@ -239,6 +239,7 @@ struct spinand_manufacturer {
 
 /* SPI NAND manufacturers */
 extern const struct spinand_manufacturer gigadevice_spinand_manufacturer;
+extern const struct spinand_manufacturer longsys_spinand_manufacturer;
 extern const struct spinand_manufacturer macronix_spinand_manufacturer;
 extern const struct spinand_manufacturer micron_spinand_manufacturer;
 extern const struct spinand_manufacturer paragon_spinand_manufacturer;

Looks fine otherwise :)

Thanks,
Miquèl

#3 lore raw

Re: [PATCH 1/1] mtd: spinand: add support for Foresee FS35ND01G

Hi Miquel,

Quoted 1 line · Miquel Raynal

Perhaps giving the link of the datasheet here makes sense.

Noted. I'll put that into v2.

Quoted 4 lines
Quoted 1 line

+#define SPINAND_MFR_LONGSYS 0xcd

Nitpick: I personally prefer uppercase hex numbers.

Noted.

Quoted 8 lines

drivers/mtd/nand/spi/longsys.c line 30

Quoted 5 lines
drivers/mtd/nand/spi/longsys.c new file +5 -0
+                  NAND_MEMORG(1, 2048, 64, 64, 1024, 20, 1, 1, 1),
+                  NAND_ECCREQ(4, 512),
+                  SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
+                                           &write_cache_variants,
+                                           &update_cache_variants),

This device probably supports more variants (especially dual/quad ones) but I guess it's not a problem to not have them here right now.

Right now I can't really test dual or quad because my SPI driver doesn't know to do dual or quad io.
I plan to add those in once I can validate they work.

Quoted 11 lines

drivers/mtd/nand/spi/longsys.c line 33

Quoted 3 lines
drivers/mtd/nand/spi/longsys.c new file +3 -0
+                  SPINAND_HAS_QE_BIT,
+                  SPINAND_ECCINFO(NULL,
+                                  NULL)),

You should define the ->ecc and ->free hooks of the mtd_ooblayout_ops structure and point to it here. It defines the free OOB bytes and bytes used by the on-die ECC engine. You should find this in the datasheet. You may look at other manufacturer drivers for examples of how it should be implemented. It is the way to tell the upper layers that eg. "byte 2 to 17 are ECC bytes, 18 until the end are free to use".

Ok I'll add those in. Is there a way I can test that my implementation is right? I.e. is writing something, reading it back and checking if the data is correct a good enough test here?
I don't really want to make it look like this flash is supported and break someone's data. :)

Thanks,

Daniel

maintainer
#4 lore raw

Re: [PATCH 1/1] mtd: spinand: add support for Foresee FS35ND01G

Hi Daniel,

Daniel Palmer <[email protected]> wrote on Tue, 5 Jan 2021 21:18:21 +0900:

Quoted 39 lines

Hi Miquel,

Quoted 1 line · Miquel Raynal

Perhaps giving the link of the datasheet here makes sense.

Noted. I'll put that into v2.

Quoted 4 lines
Quoted 1 line

+#define SPINAND_MFR_LONGSYS 0xcd

Nitpick: I personally prefer uppercase hex numbers.

Noted.

Quoted 8 lines

drivers/mtd/nand/spi/longsys.c line 30

Quoted 5 lines
drivers/mtd/nand/spi/longsys.c new file +5 -0
+                  NAND_MEMORG(1, 2048, 64, 64, 1024, 20, 1, 1, 1),
+                  NAND_ECCREQ(4, 512),
+                  SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
+                                           &write_cache_variants,
+                                           &update_cache_variants),  

This device probably supports more variants (especially dual/quad ones) but I guess it's not a problem to not have them here right now.

Right now I can't really test dual or quad because my SPI driver doesn't know to do dual or quad io.
I plan to add those in once I can validate they work.

Quoted 11 lines

drivers/mtd/nand/spi/longsys.c line 33

Quoted 3 lines
drivers/mtd/nand/spi/longsys.c new file +3 -0
+                  SPINAND_HAS_QE_BIT,
+                  SPINAND_ECCINFO(NULL,
+                                  NULL)),  

You should define the ->ecc and ->free hooks of the mtd_ooblayout_ops structure and point to it here. It defines the free OOB bytes and bytes used by the on-die ECC engine. You should find this in the datasheet. You may look at other manufacturer drivers for examples of how it should be implemented. It is the way to tell the upper layers that eg. "byte 2 to 17 are ECC bytes, 18 until the end are free to use".

Quoted 5 lines

Ok I'll add those in. Is there a way I can test that my implementation is right? I.e. is writing something, reading it back and checking if the data is correct a good enough test here?
I don't really want to make it look like this flash is supported and break someone's data. :)

You may try to use flash_erase/nandwrite/nanddump from the mtd-utils package. You may first use a dummy functions and declare the entire zone free (except for the bad block marker at the beginning).

Then, you may write the entire OOB area in regular mode then read it in raw mode (-n). Sometimes the ECC bytes are not visible, in this case it may be worth trying writing the OOB area with known data and read it back and see what you get. But these information probably are in the datasheet.

Good luck,
Miquèl

______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/