1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * Copyright (c) 2018 Macronix
4 *
5 * Author: Boris Brezillon <boris.brezillon@bootlin.com>
6 */
7
8 #include <linux/device.h>
9 #include <linux/kernel.h>
10 #include <linux/mtd/spinand.h>
11
12 #define SPINAND_MFR_MACRONIX 0xC2
13 #define MACRONIX_ECCSR_MASK 0x0F
14
15 static SPINAND_OP_VARIANTS(read_cache_variants,
16 SPINAND_PAGE_READ_FROM_CACHE_X4_OP(0, 1, NULL, 0),
17 SPINAND_PAGE_READ_FROM_CACHE_X2_OP(0, 1, NULL, 0),
18 SPINAND_PAGE_READ_FROM_CACHE_OP(true, 0, 1, NULL, 0),
19 SPINAND_PAGE_READ_FROM_CACHE_OP(false, 0, 1, NULL, 0));
20
21 static SPINAND_OP_VARIANTS(write_cache_variants,
22 SPINAND_PROG_LOAD_X4(true, 0, NULL, 0),
23 SPINAND_PROG_LOAD(true, 0, NULL, 0));
24
25 static SPINAND_OP_VARIANTS(update_cache_variants,
26 SPINAND_PROG_LOAD_X4(false, 0, NULL, 0),
27 SPINAND_PROG_LOAD(false, 0, NULL, 0));
28
mx35lfxge4ab_ooblayout_ecc(struct mtd_info * mtd,int section,struct mtd_oob_region * region)29 static int mx35lfxge4ab_ooblayout_ecc(struct mtd_info *mtd, int section,
30 struct mtd_oob_region *region)
31 {
32 return -ERANGE;
33 }
34
mx35lfxge4ab_ooblayout_free(struct mtd_info * mtd,int section,struct mtd_oob_region * region)35 static int mx35lfxge4ab_ooblayout_free(struct mtd_info *mtd, int section,
36 struct mtd_oob_region *region)
37 {
38 if (section)
39 return -ERANGE;
40
41 region->offset = 2;
42 region->length = mtd->oobsize - 2;
43
44 return 0;
45 }
46
47 static const struct mtd_ooblayout_ops mx35lfxge4ab_ooblayout = {
48 .ecc = mx35lfxge4ab_ooblayout_ecc,
49 .free = mx35lfxge4ab_ooblayout_free,
50 };
51
mx35ufxge4ad_ooblayout_ecc(struct mtd_info * mtd,int section,struct mtd_oob_region * region)52 static int mx35ufxge4ad_ooblayout_ecc(struct mtd_info *mtd, int section,
53 struct mtd_oob_region *region)
54 {
55 if (section)
56 return -ERANGE;
57
58 region->offset = mtd->oobsize / 2;
59 region->length = mtd->oobsize / 2;
60
61 return 0;
62 }
63
mx35ufxge4ad_ooblayout_free(struct mtd_info * mtd,int section,struct mtd_oob_region * region)64 static int mx35ufxge4ad_ooblayout_free(struct mtd_info *mtd, int section,
65 struct mtd_oob_region *region)
66 {
67 if (section)
68 return -ERANGE;
69
70 region->offset = 2;
71 region->length = mtd->oobsize / 2 - 2;
72
73 return 0;
74 }
75
76 static const struct mtd_ooblayout_ops mx35ufxge4ad_ooblayout = {
77 .ecc = mx35ufxge4ad_ooblayout_ecc,
78 .free = mx35ufxge4ad_ooblayout_free,
79 };
80
mx35lf1ge4ab_get_eccsr(struct spinand_device * spinand,u8 * eccsr)81 static int mx35lf1ge4ab_get_eccsr(struct spinand_device *spinand, u8 *eccsr)
82 {
83 struct spi_mem_op op = SPI_MEM_OP(SPI_MEM_OP_CMD(0x7c, 1),
84 SPI_MEM_OP_NO_ADDR,
85 SPI_MEM_OP_DUMMY(1, 1),
86 SPI_MEM_OP_DATA_IN(1, eccsr, 1));
87
88 int ret = spi_mem_exec_op(spinand->spimem, &op);
89 if (ret)
90 return ret;
91
92 *eccsr &= MACRONIX_ECCSR_MASK;
93 return 0;
94 }
95
mx35lf1ge4ab_ecc_get_status(struct spinand_device * spinand,u8 status)96 static int mx35lf1ge4ab_ecc_get_status(struct spinand_device *spinand,
97 u8 status)
98 {
99 struct nand_device *nand = spinand_to_nand(spinand);
100 u8 eccsr;
101
102 switch (status & STATUS_ECC_MASK) {
103 case STATUS_ECC_NO_BITFLIPS:
104 return 0;
105
106 case STATUS_ECC_UNCOR_ERROR:
107 return -EBADMSG;
108
109 case STATUS_ECC_HAS_BITFLIPS:
110 /*
111 * Let's try to retrieve the real maximum number of bitflips
112 * in order to avoid forcing the wear-leveling layer to move
113 * data around if it's not necessary.
114 */
115 if (mx35lf1ge4ab_get_eccsr(spinand, &eccsr))
116 return nanddev_get_ecc_requirements(nand)->strength;
117
118 if (WARN_ON(eccsr > nanddev_get_ecc_requirements(nand)->strength ||
119 !eccsr))
120 return nanddev_get_ecc_requirements(nand)->strength;
121
122 return eccsr;
123
124 default:
125 break;
126 }
127
128 return -EINVAL;
129 }
130
131 static const struct spinand_info macronix_spinand_table[] = {
132 SPINAND_INFO("MX35LF1GE4AB",
133 SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0x12),
134 NAND_MEMORG(1, 2048, 64, 64, 1024, 20, 1, 1, 1),
135 NAND_ECCREQ(4, 512),
136 SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
137 &write_cache_variants,
138 &update_cache_variants),
139 SPINAND_HAS_QE_BIT,
140 SPINAND_ECCINFO(&mx35lfxge4ab_ooblayout,
141 mx35lf1ge4ab_ecc_get_status)),
142 SPINAND_INFO("MX35LF2GE4AB",
143 SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0x22),
144 NAND_MEMORG(1, 2048, 64, 64, 2048, 40, 2, 1, 1),
145 NAND_ECCREQ(4, 512),
146 SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
147 &write_cache_variants,
148 &update_cache_variants),
149 SPINAND_HAS_QE_BIT,
150 SPINAND_ECCINFO(&mx35lfxge4ab_ooblayout, NULL)),
151 SPINAND_INFO("MX35LF2GE4AD",
152 SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0x26),
153 NAND_MEMORG(1, 2048, 64, 64, 2048, 40, 1, 1, 1),
154 NAND_ECCREQ(8, 512),
155 SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
156 &write_cache_variants,
157 &update_cache_variants),
158 SPINAND_HAS_QE_BIT,
159 SPINAND_ECCINFO(&mx35lfxge4ab_ooblayout,
160 mx35lf1ge4ab_ecc_get_status)),
161 SPINAND_INFO("MX35LF4GE4AD",
162 SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0x37),
163 NAND_MEMORG(1, 4096, 128, 64, 2048, 40, 1, 1, 1),
164 NAND_ECCREQ(8, 512),
165 SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
166 &write_cache_variants,
167 &update_cache_variants),
168 SPINAND_HAS_QE_BIT,
169 SPINAND_ECCINFO(&mx35lfxge4ab_ooblayout,
170 mx35lf1ge4ab_ecc_get_status)),
171 SPINAND_INFO("MX35LF1G24AD",
172 SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0x14),
173 NAND_MEMORG(1, 2048, 128, 64, 1024, 20, 1, 1, 1),
174 NAND_ECCREQ(8, 512),
175 SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
176 &write_cache_variants,
177 &update_cache_variants),
178 SPINAND_HAS_QE_BIT,
179 SPINAND_ECCINFO(&mx35lfxge4ab_ooblayout, NULL)),
180 SPINAND_INFO("MX35LF2G24AD",
181 SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0x24),
182 NAND_MEMORG(1, 2048, 128, 64, 2048, 40, 2, 1, 1),
183 NAND_ECCREQ(8, 512),
184 SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
185 &write_cache_variants,
186 &update_cache_variants),
187 SPINAND_HAS_QE_BIT,
188 SPINAND_ECCINFO(&mx35lfxge4ab_ooblayout, NULL)),
189 SPINAND_INFO("MX35LF4G24AD",
190 SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0x35),
191 NAND_MEMORG(1, 4096, 256, 64, 2048, 40, 2, 1, 1),
192 NAND_ECCREQ(8, 512),
193 SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
194 &write_cache_variants,
195 &update_cache_variants),
196 SPINAND_HAS_QE_BIT,
197 SPINAND_ECCINFO(&mx35lfxge4ab_ooblayout, NULL)),
198 SPINAND_INFO("MX31LF1GE4BC",
199 SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0x1e),
200 NAND_MEMORG(1, 2048, 64, 64, 1024, 20, 1, 1, 1),
201 NAND_ECCREQ(8, 512),
202 SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
203 &write_cache_variants,
204 &update_cache_variants),
205 SPINAND_HAS_QE_BIT,
206 SPINAND_ECCINFO(&mx35lfxge4ab_ooblayout,
207 mx35lf1ge4ab_ecc_get_status)),
208 SPINAND_INFO("MX31UF1GE4BC",
209 SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0x9e),
210 NAND_MEMORG(1, 2048, 64, 64, 1024, 20, 1, 1, 1),
211 NAND_ECCREQ(8, 512),
212 SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
213 &write_cache_variants,
214 &update_cache_variants),
215 SPINAND_HAS_QE_BIT,
216 SPINAND_ECCINFO(&mx35lfxge4ab_ooblayout,
217 mx35lf1ge4ab_ecc_get_status)),
218
219 SPINAND_INFO("MX35LF2G14AC",
220 SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0x20),
221 NAND_MEMORG(1, 2048, 64, 64, 2048, 40, 2, 1, 1),
222 NAND_ECCREQ(4, 512),
223 SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
224 &write_cache_variants,
225 &update_cache_variants),
226 SPINAND_HAS_QE_BIT,
227 SPINAND_ECCINFO(&mx35lfxge4ab_ooblayout,
228 mx35lf1ge4ab_ecc_get_status)),
229 SPINAND_INFO("MX35UF4G24AD",
230 SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0xb5),
231 NAND_MEMORG(1, 4096, 256, 64, 2048, 40, 2, 1, 1),
232 NAND_ECCREQ(8, 512),
233 SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
234 &write_cache_variants,
235 &update_cache_variants),
236 SPINAND_HAS_QE_BIT,
237 SPINAND_ECCINFO(&mx35lfxge4ab_ooblayout,
238 mx35lf1ge4ab_ecc_get_status)),
239 SPINAND_INFO("MX35UF4GE4AD",
240 SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0xb7),
241 NAND_MEMORG(1, 4096, 256, 64, 2048, 40, 1, 1, 1),
242 NAND_ECCREQ(8, 512),
243 SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
244 &write_cache_variants,
245 &update_cache_variants),
246 SPINAND_HAS_QE_BIT,
247 SPINAND_ECCINFO(&mx35ufxge4ad_ooblayout,
248 mx35lf1ge4ab_ecc_get_status)),
249 SPINAND_INFO("MX35UF2G14AC",
250 SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0xa0),
251 NAND_MEMORG(1, 2048, 64, 64, 2048, 40, 2, 1, 1),
252 NAND_ECCREQ(4, 512),
253 SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
254 &write_cache_variants,
255 &update_cache_variants),
256 SPINAND_HAS_QE_BIT,
257 SPINAND_ECCINFO(&mx35lfxge4ab_ooblayout,
258 mx35lf1ge4ab_ecc_get_status)),
259 SPINAND_INFO("MX35UF2G24AD",
260 SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0xa4),
261 NAND_MEMORG(1, 2048, 128, 64, 2048, 40, 2, 1, 1),
262 NAND_ECCREQ(8, 512),
263 SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
264 &write_cache_variants,
265 &update_cache_variants),
266 SPINAND_HAS_QE_BIT,
267 SPINAND_ECCINFO(&mx35lfxge4ab_ooblayout,
268 mx35lf1ge4ab_ecc_get_status)),
269 SPINAND_INFO("MX35UF2GE4AD",
270 SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0xa6),
271 NAND_MEMORG(1, 2048, 128, 64, 2048, 40, 1, 1, 1),
272 NAND_ECCREQ(8, 512),
273 SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
274 &write_cache_variants,
275 &update_cache_variants),
276 SPINAND_HAS_QE_BIT,
277 SPINAND_ECCINFO(&mx35ufxge4ad_ooblayout,
278 mx35lf1ge4ab_ecc_get_status)),
279 SPINAND_INFO("MX35UF2GE4AC",
280 SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0xa2),
281 NAND_MEMORG(1, 2048, 64, 64, 2048, 40, 1, 1, 1),
282 NAND_ECCREQ(4, 512),
283 SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
284 &write_cache_variants,
285 &update_cache_variants),
286 SPINAND_HAS_QE_BIT,
287 SPINAND_ECCINFO(&mx35lfxge4ab_ooblayout,
288 mx35lf1ge4ab_ecc_get_status)),
289 SPINAND_INFO("MX35UF1G14AC",
290 SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0x90),
291 NAND_MEMORG(1, 2048, 64, 64, 1024, 20, 1, 1, 1),
292 NAND_ECCREQ(4, 512),
293 SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
294 &write_cache_variants,
295 &update_cache_variants),
296 SPINAND_HAS_QE_BIT,
297 SPINAND_ECCINFO(&mx35lfxge4ab_ooblayout,
298 mx35lf1ge4ab_ecc_get_status)),
299 SPINAND_INFO("MX35UF1G24AD",
300 SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0x94),
301 NAND_MEMORG(1, 2048, 128, 64, 1024, 20, 1, 1, 1),
302 NAND_ECCREQ(8, 512),
303 SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
304 &write_cache_variants,
305 &update_cache_variants),
306 SPINAND_HAS_QE_BIT,
307 SPINAND_ECCINFO(&mx35lfxge4ab_ooblayout,
308 mx35lf1ge4ab_ecc_get_status)),
309 SPINAND_INFO("MX35UF1GE4AD",
310 SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0x96),
311 NAND_MEMORG(1, 2048, 128, 64, 1024, 20, 1, 1, 1),
312 NAND_ECCREQ(8, 512),
313 SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
314 &write_cache_variants,
315 &update_cache_variants),
316 SPINAND_HAS_QE_BIT,
317 SPINAND_ECCINFO(&mx35ufxge4ad_ooblayout,
318 mx35lf1ge4ab_ecc_get_status)),
319 SPINAND_INFO("MX35UF1GE4AC",
320 SPINAND_ID(SPINAND_READID_METHOD_OPCODE_DUMMY, 0x92),
321 NAND_MEMORG(1, 2048, 64, 64, 1024, 20, 1, 1, 1),
322 NAND_ECCREQ(4, 512),
323 SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
324 &write_cache_variants,
325 &update_cache_variants),
326 SPINAND_HAS_QE_BIT,
327 SPINAND_ECCINFO(&mx35lfxge4ab_ooblayout,
328 mx35lf1ge4ab_ecc_get_status)),
329 };
330
331 static const struct spinand_manufacturer_ops macronix_spinand_manuf_ops = {
332 };
333
334 const struct spinand_manufacturer macronix_spinand_manufacturer = {
335 .id = SPINAND_MFR_MACRONIX,
336 .name = "Macronix",
337 .chips = macronix_spinand_table,
338 .nchips = ARRAY_SIZE(macronix_spinand_table),
339 .ops = ¯onix_spinand_manuf_ops,
340 };
341