]> git.dujemihanovic.xyz Git - u-boot.git/commitdiff
mtd: spinand: Add support for XTX SPINAND
authorBruce Suen <bruce_suen@163.com>
Tue, 12 Mar 2024 01:43:14 +0000 (21:43 -0400)
committerDario Binacchi <dario.binacchi@amarulasolutions.com>
Sun, 14 Apr 2024 06:49:40 +0000 (08:49 +0200)
Add support for XTX XT26G0xA and XT26xxxD. The driver is ported from
linux-6.7.1. This driver is tested on Banana BPI-R3 with XT26G01A and
XT26G12D.

Link: https://lore.kernel.org/all/20240312014314.15454-1-bruce_suen@163.com
Signed-off-by: Bruce Suen <bruce_suen@163.com>
Reviewed-by: Frieder Schrempf <frieder.schrempf@kontron.de>
Signed-off-by: Dario Binacchi <dario.binacchi@amarulasolutions.com>
drivers/mtd/nand/spi/Makefile
drivers/mtd/nand/spi/core.c
drivers/mtd/nand/spi/xtx.c [new file with mode: 0644]
include/linux/mtd/spinand.h

index f172f4787f8510ad699bee2a6eb47010c973824a..65b836b34cad90451eefe7d8ffa2829d16e23fcd 100644 (file)
@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: GPL-2.0
 
 spinand-objs := core.o esmt.o gigadevice.o macronix.o micron.o paragon.o
-spinand-objs += toshiba.o winbond.o
+spinand-objs += toshiba.o winbond.o xtx.o
 obj-$(CONFIG_MTD_SPI_NAND) += spinand.o
index 8ca33459f96aa1548a9d351f0f325dcb6bf5a923..62c28aa422d25049593774baf9694597f2e0ac1b 100644 (file)
@@ -829,6 +829,7 @@ static const struct spinand_manufacturer *spinand_manufacturers[] = {
        &toshiba_spinand_manufacturer,
        &winbond_spinand_manufacturer,
        &esmt_c8_spinand_manufacturer,
+       &xtx_spinand_manufacturer,
 };
 
 static int spinand_manufacturer_match(struct spinand_device *spinand,
diff --git a/drivers/mtd/nand/spi/xtx.c b/drivers/mtd/nand/spi/xtx.c
new file mode 100644 (file)
index 0000000..aee1849
--- /dev/null
@@ -0,0 +1,266 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Author:
+ * Felix Matouschek <felix@matouschek.org>
+ */
+
+#include <linux/bitfield.h>
+#ifndef __UBOOT__
+#include <linux/device.h>
+#include <linux/kernel.h>
+#endif
+#include <linux/mtd/spinand.h>
+
+#define SPINAND_MFR_XTX        0x0B
+
+#define XT26G0XA_STATUS_ECC_MASK       GENMASK(5, 2)
+#define XT26G0XA_STATUS_ECC_NO_DETECTED        (0 << 2)
+#define XT26G0XA_STATUS_ECC_8_CORRECTED        (3 << 4)
+#define XT26G0XA_STATUS_ECC_UNCOR_ERROR        (2 << 4)
+
+#define XT26XXXD_STATUS_ECC3_ECC2_MASK     GENMASK(7, 6)
+#define XT26XXXD_STATUS_ECC_NO_DETECTED     (0)
+#define XT26XXXD_STATUS_ECC_1_7_CORRECTED   (1)
+#define XT26XXXD_STATUS_ECC_8_CORRECTED     (3)
+#define XT26XXXD_STATUS_ECC_UNCOR_ERROR     (2)
+
+static SPINAND_OP_VARIANTS(read_cache_variants,
+               SPINAND_PAGE_READ_FROM_CACHE_QUADIO_OP(0, 1, NULL, 0),
+               SPINAND_PAGE_READ_FROM_CACHE_X4_OP(0, 1, NULL, 0),
+               SPINAND_PAGE_READ_FROM_CACHE_DUALIO_OP(0, 1, NULL, 0),
+               SPINAND_PAGE_READ_FROM_CACHE_X2_OP(0, 1, NULL, 0),
+               SPINAND_PAGE_READ_FROM_CACHE_OP(true, 0, 1, NULL, 0),
+               SPINAND_PAGE_READ_FROM_CACHE_OP(false, 0, 1, NULL, 0));
+
+static SPINAND_OP_VARIANTS(write_cache_variants,
+               SPINAND_PROG_LOAD_X4(true, 0, NULL, 0),
+               SPINAND_PROG_LOAD(true, 0, NULL, 0));
+
+static SPINAND_OP_VARIANTS(update_cache_variants,
+               SPINAND_PROG_LOAD_X4(false, 0, NULL, 0),
+               SPINAND_PROG_LOAD(false, 0, NULL, 0));
+
+static int xt26g0xa_ooblayout_ecc(struct mtd_info *mtd, int section,
+                                 struct mtd_oob_region *region)
+{
+       if (section)
+               return -ERANGE;
+
+       region->offset = 48;
+       region->length = 16;
+
+       return 0;
+}
+
+static int xt26g0xa_ooblayout_free(struct mtd_info *mtd, int section,
+                                  struct mtd_oob_region *region)
+{
+       if (section)
+               return -ERANGE;
+
+       region->offset = 1;
+       region->length = 47;
+
+       return 0;
+}
+
+static const struct mtd_ooblayout_ops xt26g0xa_ooblayout = {
+       .ecc = xt26g0xa_ooblayout_ecc,
+       .rfree = xt26g0xa_ooblayout_free,
+};
+
+static int xt26g0xa_ecc_get_status(struct spinand_device *spinand,
+                                  u8 status)
+{
+       status = status & XT26G0XA_STATUS_ECC_MASK;
+
+       switch (status) {
+       case XT26G0XA_STATUS_ECC_NO_DETECTED:
+               return 0;
+       case XT26G0XA_STATUS_ECC_8_CORRECTED:
+               return 8;
+       case XT26G0XA_STATUS_ECC_UNCOR_ERROR:
+               return -EBADMSG;
+       default:
+               break;
+       }
+
+       /* At this point values greater than (2 << 4) are invalid  */
+       if (status > XT26G0XA_STATUS_ECC_UNCOR_ERROR)
+               return -EINVAL;
+
+       /* (1 << 2) through (7 << 2) are 1-7 corrected errors */
+       return status >> 2;
+}
+
+static int xt26xxxd_ooblayout_ecc(struct mtd_info *mtd, int section,
+                                 struct mtd_oob_region *region)
+{
+       if (section)
+               return -ERANGE;
+
+       region->offset = mtd->oobsize / 2;
+       region->length = mtd->oobsize / 2;
+
+       return 0;
+}
+
+static int xt26xxxd_ooblayout_free(struct mtd_info *mtd, int section,
+                                  struct mtd_oob_region *region)
+{
+       if (section)
+               return -ERANGE;
+
+       region->offset = 2;
+       region->length = mtd->oobsize / 2 - 2;
+
+       return 0;
+}
+
+static const struct mtd_ooblayout_ops xt26xxxd_ooblayout = {
+       .ecc = xt26xxxd_ooblayout_ecc,
+       .rfree = xt26xxxd_ooblayout_free,
+};
+
+static int xt26xxxd_ecc_get_status(struct spinand_device *spinand,
+                                  u8 status)
+{
+       switch (FIELD_GET(STATUS_ECC_MASK, status)) {
+       case XT26XXXD_STATUS_ECC_NO_DETECTED:
+               return 0;
+       case XT26XXXD_STATUS_ECC_UNCOR_ERROR:
+               return -EBADMSG;
+       case XT26XXXD_STATUS_ECC_1_7_CORRECTED:
+               return 4 + FIELD_GET(XT26XXXD_STATUS_ECC3_ECC2_MASK, status);
+       case XT26XXXD_STATUS_ECC_8_CORRECTED:
+               return 8;
+       default:
+               break;
+       }
+
+       return -EINVAL;
+}
+
+static const struct spinand_info xtx_spinand_table[] = {
+       SPINAND_INFO("XT26G01A",
+                    SPINAND_ID(SPINAND_READID_METHOD_OPCODE_ADDR, 0xE1),
+                    NAND_MEMORG(1, 2048, 64, 64, 1024, 20, 1, 1, 1),
+                    NAND_ECCREQ(8, 512),
+                    SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
+                                             &write_cache_variants,
+                                             &update_cache_variants),
+                    SPINAND_HAS_QE_BIT,
+                    SPINAND_ECCINFO(&xt26g0xa_ooblayout,
+                                    xt26g0xa_ecc_get_status)),
+       SPINAND_INFO("XT26G02A",
+                    SPINAND_ID(SPINAND_READID_METHOD_OPCODE_ADDR, 0xE2),
+                    NAND_MEMORG(1, 2048, 64, 64, 2048, 40, 1, 1, 1),
+                    NAND_ECCREQ(8, 512),
+                    SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
+                                             &write_cache_variants,
+                                             &update_cache_variants),
+                    SPINAND_HAS_QE_BIT,
+                    SPINAND_ECCINFO(&xt26g0xa_ooblayout,
+                                    xt26g0xa_ecc_get_status)),
+       SPINAND_INFO("XT26G04A",
+                    SPINAND_ID(SPINAND_READID_METHOD_OPCODE_ADDR, 0xE3),
+                    NAND_MEMORG(1, 2048, 64, 128, 2048, 40, 1, 1, 1),
+                    NAND_ECCREQ(8, 512),
+                    SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
+                                             &write_cache_variants,
+                                             &update_cache_variants),
+                    SPINAND_HAS_QE_BIT,
+                    SPINAND_ECCINFO(&xt26g0xa_ooblayout,
+                                    xt26g0xa_ecc_get_status)),
+       SPINAND_INFO("XT26G01D",
+                    SPINAND_ID(SPINAND_READID_METHOD_OPCODE_ADDR, 0x31),
+                    NAND_MEMORG(1, 2048, 128, 64, 1024, 20, 1, 1, 1),
+                    NAND_ECCREQ(8, 512),
+                    SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
+                                             &write_cache_variants,
+                                             &update_cache_variants),
+                    0,
+                    SPINAND_ECCINFO(&xt26xxxd_ooblayout,
+                                    xt26xxxd_ecc_get_status)),
+       SPINAND_INFO("XT26G11D",
+                    SPINAND_ID(SPINAND_READID_METHOD_OPCODE_ADDR, 0x34),
+                    NAND_MEMORG(1, 2048, 128, 64, 1024, 20, 1, 1, 1),
+                    NAND_ECCREQ(8, 512),
+                    SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
+                                             &write_cache_variants,
+                                             &update_cache_variants),
+                    0,
+                    SPINAND_ECCINFO(&xt26xxxd_ooblayout,
+                                    xt26xxxd_ecc_get_status)),
+       SPINAND_INFO("XT26Q01D",
+                    SPINAND_ID(SPINAND_READID_METHOD_OPCODE_ADDR, 0x51),
+                    NAND_MEMORG(1, 2048, 128, 64, 1024, 20, 1, 1, 1),
+                    NAND_ECCREQ(8, 512),
+                    SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
+                                             &write_cache_variants,
+                                             &update_cache_variants),
+                    0,
+                    SPINAND_ECCINFO(&xt26xxxd_ooblayout,
+                                    xt26xxxd_ecc_get_status)),
+       SPINAND_INFO("XT26G02D",
+                    SPINAND_ID(SPINAND_READID_METHOD_OPCODE_ADDR, 0x32),
+                    NAND_MEMORG(1, 2048, 128, 64, 2048, 40, 1, 1, 1),
+                    NAND_ECCREQ(8, 512),
+                    SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
+                                             &write_cache_variants,
+                                             &update_cache_variants),
+                    0,
+                    SPINAND_ECCINFO(&xt26xxxd_ooblayout,
+                                    xt26xxxd_ecc_get_status)),
+       SPINAND_INFO("XT26G12D",
+                    SPINAND_ID(SPINAND_READID_METHOD_OPCODE_ADDR, 0x35),
+                    NAND_MEMORG(1, 2048, 128, 64, 2048, 40, 1, 1, 1),
+                    NAND_ECCREQ(8, 512),
+                    SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
+                                             &write_cache_variants,
+                                             &update_cache_variants),
+                    0,
+                    SPINAND_ECCINFO(&xt26xxxd_ooblayout,
+                                    xt26xxxd_ecc_get_status)),
+       SPINAND_INFO("XT26Q02D",
+                    SPINAND_ID(SPINAND_READID_METHOD_OPCODE_ADDR, 0x52),
+                    NAND_MEMORG(1, 2048, 128, 64, 2048, 40, 1, 1, 1),
+                    NAND_ECCREQ(8, 512),
+                    SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
+                                             &write_cache_variants,
+                                             &update_cache_variants),
+                    0,
+                    SPINAND_ECCINFO(&xt26xxxd_ooblayout,
+                                    xt26xxxd_ecc_get_status)),
+       SPINAND_INFO("XT26G04D",
+                    SPINAND_ID(SPINAND_READID_METHOD_OPCODE_ADDR, 0x33),
+                    NAND_MEMORG(1, 4096, 256, 64, 2048, 40, 1, 1, 1),
+                    NAND_ECCREQ(8, 512),
+                    SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
+                                             &write_cache_variants,
+                                             &update_cache_variants),
+                    0,
+                    SPINAND_ECCINFO(&xt26xxxd_ooblayout,
+                                    xt26xxxd_ecc_get_status)),
+       SPINAND_INFO("XT26Q04D",
+                    SPINAND_ID(SPINAND_READID_METHOD_OPCODE_ADDR, 0x53),
+                    NAND_MEMORG(1, 4096, 256, 64, 2048, 40, 1, 1, 1),
+                    NAND_ECCREQ(8, 512),
+                    SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
+                                             &write_cache_variants,
+                                             &update_cache_variants),
+                    0,
+                    SPINAND_ECCINFO(&xt26xxxd_ooblayout,
+                                    xt26xxxd_ecc_get_status)),
+};
+
+static const struct spinand_manufacturer_ops xtx_spinand_manuf_ops = {
+};
+
+const struct spinand_manufacturer xtx_spinand_manufacturer = {
+       .id = SPINAND_MFR_XTX,
+       .name = "XTX",
+       .chips = xtx_spinand_table,
+       .nchips = ARRAY_SIZE(xtx_spinand_table),
+       .ops = &xtx_spinand_manuf_ops,
+};
index 6f479fa5adc901d60a75449aea3ba207a887a042..13b5a52f8b920f3df5bdfb6285cf958466997a6f 100644 (file)
@@ -251,6 +251,7 @@ extern const struct spinand_manufacturer paragon_spinand_manufacturer;
 extern const struct spinand_manufacturer toshiba_spinand_manufacturer;
 extern const struct spinand_manufacturer winbond_spinand_manufacturer;
 extern const struct spinand_manufacturer esmt_c8_spinand_manufacturer;
+extern const struct spinand_manufacturer xtx_spinand_manufacturer;
 
 /**
  * struct spinand_op_variants - SPI NAND operation variants