xref: /rk3399_rockchip-uboot/drivers/mtd/nand/spi/kingston.c (revision 534e5d47c0a0fbcbd4683ec669edb0108801e0fc)
1*534e5d47SJon Lin // SPDX-License-Identifier: GPL-2.0
2*534e5d47SJon Lin /*
3*534e5d47SJon Lin  * Copyright (c) 2025 Rockchip Electronics Co., Ltd
4*534e5d47SJon Lin  *
5*534e5d47SJon Lin  * Authors:
6*534e5d47SJon Lin  *	Dingqiang Lin <jon.lin@rock-chips.com>
7*534e5d47SJon Lin  */
8*534e5d47SJon Lin 
9*534e5d47SJon Lin #ifndef __UBOOT__
10*534e5d47SJon Lin #include <linux/device.h>
11*534e5d47SJon Lin #include <linux/kernel.h>
12*534e5d47SJon Lin #endif
13*534e5d47SJon Lin #include <linux/mtd/spinand.h>
14*534e5d47SJon Lin 
15*534e5d47SJon Lin #define SPINAND_MFR_KINGSTON		0x98
16*534e5d47SJon Lin 
17*534e5d47SJon Lin static SPINAND_OP_VARIANTS(read_cache_variants,
18*534e5d47SJon Lin 		SPINAND_PAGE_READ_FROM_CACHE_QUADIO_OP(0, 2, NULL, 0),
19*534e5d47SJon Lin 		SPINAND_PAGE_READ_FROM_CACHE_X4_OP(0, 1, NULL, 0),
20*534e5d47SJon Lin 		SPINAND_PAGE_READ_FROM_CACHE_DUALIO_OP(0, 1, NULL, 0),
21*534e5d47SJon Lin 		SPINAND_PAGE_READ_FROM_CACHE_X2_OP(0, 1, NULL, 0),
22*534e5d47SJon Lin 		SPINAND_PAGE_READ_FROM_CACHE_OP(true, 0, 1, NULL, 0),
23*534e5d47SJon Lin 		SPINAND_PAGE_READ_FROM_CACHE_OP(false, 0, 1, NULL, 0));
24*534e5d47SJon Lin 
25*534e5d47SJon Lin static SPINAND_OP_VARIANTS(write_cache_variants,
26*534e5d47SJon Lin 		SPINAND_PROG_LOAD_X4(true, 0, NULL, 0),
27*534e5d47SJon Lin 		SPINAND_PROG_LOAD(true, 0, NULL, 0));
28*534e5d47SJon Lin 
29*534e5d47SJon Lin static SPINAND_OP_VARIANTS(update_cache_variants,
30*534e5d47SJon Lin 		SPINAND_PROG_LOAD_X4(false, 0, NULL, 0),
31*534e5d47SJon Lin 		SPINAND_PROG_LOAD(false, 0, NULL, 0));
32*534e5d47SJon Lin 
spi004_sdeg_ooblayout_ecc(struct mtd_info * mtd,int section,struct mtd_oob_region * region)33*534e5d47SJon Lin static int spi004_sdeg_ooblayout_ecc(struct mtd_info *mtd, int section,
34*534e5d47SJon Lin 				     struct mtd_oob_region *region)
35*534e5d47SJon Lin {
36*534e5d47SJon Lin 	if (section > 0)
37*534e5d47SJon Lin 		return -ERANGE;
38*534e5d47SJon Lin 
39*534e5d47SJon Lin 	region->offset = mtd->oobsize / 2;
40*534e5d47SJon Lin 	region->length = mtd->oobsize / 2;
41*534e5d47SJon Lin 
42*534e5d47SJon Lin 	return 0;
43*534e5d47SJon Lin }
44*534e5d47SJon Lin 
spi004_sdeg_ooblayout_free(struct mtd_info * mtd,int section,struct mtd_oob_region * region)45*534e5d47SJon Lin static int spi004_sdeg_ooblayout_free(struct mtd_info *mtd, int section,
46*534e5d47SJon Lin 				      struct mtd_oob_region *region)
47*534e5d47SJon Lin {
48*534e5d47SJon Lin 	if (section)
49*534e5d47SJon Lin 		return -ERANGE;
50*534e5d47SJon Lin 
51*534e5d47SJon Lin 	/* 2 bytes reserved for BBM */
52*534e5d47SJon Lin 	region->offset = 2;
53*534e5d47SJon Lin 	region->length = mtd->oobsize / 2 - 2;
54*534e5d47SJon Lin 
55*534e5d47SJon Lin 	return 0;
56*534e5d47SJon Lin }
57*534e5d47SJon Lin 
58*534e5d47SJon Lin static const struct mtd_ooblayout_ops spi004_sdeg_ooblayout = {
59*534e5d47SJon Lin 	.ecc = spi004_sdeg_ooblayout_ecc,
60*534e5d47SJon Lin 	.rfree = spi004_sdeg_ooblayout_free,
61*534e5d47SJon Lin };
62*534e5d47SJon Lin 
63*534e5d47SJon Lin /*
64*534e5d47SJon Lin  * ecc bits: 0xC0[4,6]
65*534e5d47SJon Lin  * [0b000], No bit errors were detected;
66*534e5d47SJon Lin  * [0b001, 0b101], 3~7 Bit errors were detected and corrected. Not
67*534e5d47SJon Lin  *	reach Flipping Bits;
68*534e5d47SJon Lin  * [0b110], Bit error count equals the bit flip detection threshold
69*534e5d47SJon Lin  * [0b111], Bit errors greater than ECC capability(8 bits) and not corrected;
70*534e5d47SJon Lin  */
spi004_sdeg_ecc_get_status(struct spinand_device * spinand,u8 status)71*534e5d47SJon Lin static int spi004_sdeg_ecc_get_status(struct spinand_device *spinand, u8 status)
72*534e5d47SJon Lin {
73*534e5d47SJon Lin 	struct nand_device *nand = spinand_to_nand(spinand);
74*534e5d47SJon Lin 	u8 eccsr = (status & GENMASK(6, 4)) >> 4;
75*534e5d47SJon Lin 
76*534e5d47SJon Lin 	if (eccsr == 0)
77*534e5d47SJon Lin 		return 0;
78*534e5d47SJon Lin 	else if (eccsr < 6)
79*534e5d47SJon Lin 		return eccsr + 2;
80*534e5d47SJon Lin 	else if (eccsr == 6)
81*534e5d47SJon Lin 		return nand->eccreq.strength;
82*534e5d47SJon Lin 	else
83*534e5d47SJon Lin 		return -EBADMSG;
84*534e5d47SJon Lin }
85*534e5d47SJon Lin 
86*534e5d47SJon Lin static const struct spinand_info kingston_spinand_table[] = {
87*534e5d47SJon Lin 	SPINAND_INFO("SPI004-SDEG",
88*534e5d47SJon Lin 		     SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0x53),
89*534e5d47SJon Lin 		     NAND_MEMORG(1, 4096, 256, 64, 2048, 1, 1, 1),
90*534e5d47SJon Lin 		     NAND_ECCREQ(8, 512),
91*534e5d47SJon Lin 		     SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
92*534e5d47SJon Lin 					      &write_cache_variants,
93*534e5d47SJon Lin 					      &update_cache_variants),
94*534e5d47SJon Lin 		     SPINAND_HAS_QE_BIT,
95*534e5d47SJon Lin 		     SPINAND_ECCINFO(&spi004_sdeg_ooblayout, spi004_sdeg_ecc_get_status)),
96*534e5d47SJon Lin };
97*534e5d47SJon Lin 
98*534e5d47SJon Lin static const struct spinand_manufacturer_ops kingston_spinand_manuf_ops = {
99*534e5d47SJon Lin };
100*534e5d47SJon Lin 
101*534e5d47SJon Lin const struct spinand_manufacturer kingston_spinand_manufacturer = {
102*534e5d47SJon Lin 	.id = SPINAND_MFR_KINGSTON,
103*534e5d47SJon Lin 	.name = "kingston",
104*534e5d47SJon Lin 	.chips = kingston_spinand_table,
105*534e5d47SJon Lin 	.nchips = ARRAY_SIZE(kingston_spinand_table),
106*534e5d47SJon Lin 	.ops = &kingston_spinand_manuf_ops,
107*534e5d47SJon Lin };
108