blob: 73fd403886a92e18c2e14e5756c8a238b980c833 [file] [log] [blame]
Sergey Lapin10794322008-10-31 12:28:43 +01001/*
2 * (C) Copyright 2007-2008
Stelian Popc9e798d2011-11-01 00:00:39 +01003 * Stelian Pop <stelian@popies.net>
Sergey Lapin10794322008-10-31 12:28:43 +01004 * Lead Tech Design <www.leadtechdesign.com>
5 *
6 * (C) Copyright 2006 ATMEL Rousset, Lacressonniere Nicolas
7 *
Wu, Joshbdfd59a2012-08-23 00:05:36 +00008 * Add Programmable Multibit ECC support for various AT91 SoC
9 * (C) Copyright 2012 ATMEL, Hong Xu
10 *
Wolfgang Denk1a459662013-07-08 09:37:19 +020011 * SPDX-License-Identifier: GPL-2.0+
Sergey Lapin10794322008-10-31 12:28:43 +010012 */
13
14#include <common.h>
Andreas Bießmannac45bb12013-11-29 12:13:45 +010015#include <asm/gpio.h>
Sergey Lapin10794322008-10-31 12:28:43 +010016#include <asm/arch/gpio.h>
Sergey Lapin10794322008-10-31 12:28:43 +010017
Wu, Joshddd85972013-07-03 11:11:48 +080018#include <malloc.h>
Sergey Lapin10794322008-10-31 12:28:43 +010019#include <nand.h>
Wu, Joshbdfd59a2012-08-23 00:05:36 +000020#include <watchdog.h>
Heiko Schocherc1ec4062014-10-31 08:31:01 +010021#include <linux/mtd/nand_ecc.h>
Sergey Lapin10794322008-10-31 12:28:43 +010022
Nikolay Petukhov7c27b7b2010-03-19 10:49:27 +050023#ifdef CONFIG_ATMEL_NAND_HWECC
24
25/* Register access macros */
26#define ecc_readl(add, reg) \
27 readl(AT91_BASE_SYS + add + ATMEL_ECC_##reg)
28#define ecc_writel(add, reg, value) \
29 writel((value), AT91_BASE_SYS + add + ATMEL_ECC_##reg)
30
31#include "atmel_nand_ecc.h" /* Hardware ECC registers */
32
Wu, Joshbdfd59a2012-08-23 00:05:36 +000033#ifdef CONFIG_ATMEL_NAND_HW_PMECC
34
Bo Shen0b0b4f52014-03-03 14:47:16 +080035#ifdef CONFIG_SPL_BUILD
36#undef CONFIG_SYS_NAND_ONFI_DETECTION
37#endif
38
Wu, Joshbdfd59a2012-08-23 00:05:36 +000039struct atmel_nand_host {
40 struct pmecc_regs __iomem *pmecc;
41 struct pmecc_errloc_regs __iomem *pmerrloc;
42 void __iomem *pmecc_rom_base;
43
44 u8 pmecc_corr_cap;
45 u16 pmecc_sector_size;
46 u32 pmecc_index_table_offset;
Wu, Josh0e48dc52015-01-16 11:54:46 +080047 u32 pmecc_version;
Wu, Joshbdfd59a2012-08-23 00:05:36 +000048
49 int pmecc_bytes_per_sector;
50 int pmecc_sector_number;
51 int pmecc_degree; /* Degree of remainders */
52 int pmecc_cw_len; /* Length of codeword */
53
54 /* lookup table for alpha_to and index_of */
55 void __iomem *pmecc_alpha_to;
56 void __iomem *pmecc_index_of;
57
58 /* data for pmecc computation */
Wu, Joshddd85972013-07-03 11:11:48 +080059 int16_t *pmecc_smu;
60 int16_t *pmecc_partial_syn;
61 int16_t *pmecc_si;
62 int16_t *pmecc_lmu; /* polynomal order */
63 int *pmecc_mu;
64 int *pmecc_dmu;
65 int *pmecc_delta;
Wu, Joshbdfd59a2012-08-23 00:05:36 +000066};
67
68static struct atmel_nand_host pmecc_host;
69static struct nand_ecclayout atmel_pmecc_oobinfo;
70
71/*
72 * Return number of ecc bytes per sector according to sector size and
73 * correction capability
74 *
75 * Following table shows what at91 PMECC supported:
76 * Correction Capability Sector_512_bytes Sector_1024_bytes
77 * ===================== ================ =================
78 * 2-bits 4-bytes 4-bytes
79 * 4-bits 7-bytes 7-bytes
80 * 8-bits 13-bytes 14-bytes
81 * 12-bits 20-bytes 21-bytes
82 * 24-bits 39-bytes 42-bytes
83 */
84static int pmecc_get_ecc_bytes(int cap, int sector_size)
85{
86 int m = 12 + sector_size / 512;
87 return (m * cap + 7) / 8;
88}
89
90static void pmecc_config_ecc_layout(struct nand_ecclayout *layout,
91 int oobsize, int ecc_len)
92{
93 int i;
94
95 layout->eccbytes = ecc_len;
96
97 /* ECC will occupy the last ecc_len bytes continuously */
98 for (i = 0; i < ecc_len; i++)
99 layout->eccpos[i] = oobsize - ecc_len + i;
100
101 layout->oobfree[0].offset = 2;
102 layout->oobfree[0].length =
103 oobsize - ecc_len - layout->oobfree[0].offset;
104}
105
106static void __iomem *pmecc_get_alpha_to(struct atmel_nand_host *host)
107{
108 int table_size;
109
110 table_size = host->pmecc_sector_size == 512 ?
111 PMECC_INDEX_TABLE_SIZE_512 : PMECC_INDEX_TABLE_SIZE_1024;
112
113 /* the ALPHA lookup table is right behind the INDEX lookup table. */
114 return host->pmecc_rom_base + host->pmecc_index_table_offset +
115 table_size * sizeof(int16_t);
116}
117
Wu, Joshddd85972013-07-03 11:11:48 +0800118static void pmecc_data_free(struct atmel_nand_host *host)
119{
120 free(host->pmecc_partial_syn);
121 free(host->pmecc_si);
122 free(host->pmecc_lmu);
123 free(host->pmecc_smu);
124 free(host->pmecc_mu);
125 free(host->pmecc_dmu);
126 free(host->pmecc_delta);
127}
128
129static int pmecc_data_alloc(struct atmel_nand_host *host)
130{
131 const int cap = host->pmecc_corr_cap;
132 int size;
133
134 size = (2 * cap + 1) * sizeof(int16_t);
135 host->pmecc_partial_syn = malloc(size);
136 host->pmecc_si = malloc(size);
137 host->pmecc_lmu = malloc((cap + 1) * sizeof(int16_t));
138 host->pmecc_smu = malloc((cap + 2) * size);
139
140 size = (cap + 1) * sizeof(int);
141 host->pmecc_mu = malloc(size);
142 host->pmecc_dmu = malloc(size);
143 host->pmecc_delta = malloc(size);
144
145 if (host->pmecc_partial_syn &&
146 host->pmecc_si &&
147 host->pmecc_lmu &&
148 host->pmecc_smu &&
149 host->pmecc_mu &&
150 host->pmecc_dmu &&
151 host->pmecc_delta)
152 return 0;
153
154 /* error happened */
155 pmecc_data_free(host);
156 return -ENOMEM;
157
158}
159
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000160static void pmecc_gen_syndrome(struct mtd_info *mtd, int sector)
161{
162 struct nand_chip *nand_chip = mtd->priv;
163 struct atmel_nand_host *host = nand_chip->priv;
164 int i;
165 uint32_t value;
166
167 /* Fill odd syndromes */
168 for (i = 0; i < host->pmecc_corr_cap; i++) {
Wu, Josh14b3b442014-06-24 18:18:06 +0800169 value = pmecc_readl(host->pmecc, rem_port[sector].rem[i / 2]);
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000170 if (i & 1)
171 value >>= 16;
172 value &= 0xffff;
173 host->pmecc_partial_syn[(2 * i) + 1] = (int16_t)value;
174 }
175}
176
177static void pmecc_substitute(struct mtd_info *mtd)
178{
179 struct nand_chip *nand_chip = mtd->priv;
180 struct atmel_nand_host *host = nand_chip->priv;
181 int16_t __iomem *alpha_to = host->pmecc_alpha_to;
182 int16_t __iomem *index_of = host->pmecc_index_of;
183 int16_t *partial_syn = host->pmecc_partial_syn;
184 const int cap = host->pmecc_corr_cap;
185 int16_t *si;
186 int i, j;
187
188 /* si[] is a table that holds the current syndrome value,
189 * an element of that table belongs to the field
190 */
191 si = host->pmecc_si;
192
193 memset(&si[1], 0, sizeof(int16_t) * (2 * cap - 1));
194
195 /* Computation 2t syndromes based on S(x) */
196 /* Odd syndromes */
197 for (i = 1; i < 2 * cap; i += 2) {
198 for (j = 0; j < host->pmecc_degree; j++) {
199 if (partial_syn[i] & (0x1 << j))
200 si[i] = readw(alpha_to + i * j) ^ si[i];
201 }
202 }
203 /* Even syndrome = (Odd syndrome) ** 2 */
204 for (i = 2, j = 1; j <= cap; i = ++j << 1) {
205 if (si[j] == 0) {
206 si[i] = 0;
207 } else {
208 int16_t tmp;
209
210 tmp = readw(index_of + si[j]);
211 tmp = (tmp * 2) % host->pmecc_cw_len;
212 si[i] = readw(alpha_to + tmp);
213 }
214 }
215}
216
217/*
218 * This function defines a Berlekamp iterative procedure for
219 * finding the value of the error location polynomial.
220 * The input is si[], initialize by pmecc_substitute().
221 * The output is smu[][].
222 *
223 * This function is written according to chip datasheet Chapter:
224 * Find the Error Location Polynomial Sigma(x) of Section:
225 * Programmable Multibit ECC Control (PMECC).
226 */
227static void pmecc_get_sigma(struct mtd_info *mtd)
228{
229 struct nand_chip *nand_chip = mtd->priv;
230 struct atmel_nand_host *host = nand_chip->priv;
231
232 int16_t *lmu = host->pmecc_lmu;
233 int16_t *si = host->pmecc_si;
234 int *mu = host->pmecc_mu;
235 int *dmu = host->pmecc_dmu; /* Discrepancy */
236 int *delta = host->pmecc_delta; /* Delta order */
237 int cw_len = host->pmecc_cw_len;
238 const int16_t cap = host->pmecc_corr_cap;
239 const int num = 2 * cap + 1;
240 int16_t __iomem *index_of = host->pmecc_index_of;
241 int16_t __iomem *alpha_to = host->pmecc_alpha_to;
242 int i, j, k;
243 uint32_t dmu_0_count, tmp;
244 int16_t *smu = host->pmecc_smu;
245
246 /* index of largest delta */
247 int ro;
248 int largest;
249 int diff;
250
251 /* Init the Sigma(x) */
252 memset(smu, 0, sizeof(int16_t) * ARRAY_SIZE(smu));
253
254 dmu_0_count = 0;
255
256 /* First Row */
257
258 /* Mu */
259 mu[0] = -1;
260
261 smu[0] = 1;
262
263 /* discrepancy set to 1 */
264 dmu[0] = 1;
265 /* polynom order set to 0 */
266 lmu[0] = 0;
267 /* delta[0] = (mu[0] * 2 - lmu[0]) >> 1; */
268 delta[0] = -1;
269
270 /* Second Row */
271
272 /* Mu */
273 mu[1] = 0;
274 /* Sigma(x) set to 1 */
275 smu[num] = 1;
276
277 /* discrepancy set to S1 */
278 dmu[1] = si[1];
279
280 /* polynom order set to 0 */
281 lmu[1] = 0;
282
283 /* delta[1] = (mu[1] * 2 - lmu[1]) >> 1; */
284 delta[1] = 0;
285
286 for (i = 1; i <= cap; i++) {
287 mu[i + 1] = i << 1;
288 /* Begin Computing Sigma (Mu+1) and L(mu) */
289 /* check if discrepancy is set to 0 */
290 if (dmu[i] == 0) {
291 dmu_0_count++;
292
293 tmp = ((cap - (lmu[i] >> 1) - 1) / 2);
294 if ((cap - (lmu[i] >> 1) - 1) & 0x1)
295 tmp += 2;
296 else
297 tmp += 1;
298
299 if (dmu_0_count == tmp) {
300 for (j = 0; j <= (lmu[i] >> 1) + 1; j++)
301 smu[(cap + 1) * num + j] =
302 smu[i * num + j];
303
304 lmu[cap + 1] = lmu[i];
305 return;
306 }
307
308 /* copy polynom */
309 for (j = 0; j <= lmu[i] >> 1; j++)
310 smu[(i + 1) * num + j] = smu[i * num + j];
311
312 /* copy previous polynom order to the next */
313 lmu[i + 1] = lmu[i];
314 } else {
315 ro = 0;
316 largest = -1;
317 /* find largest delta with dmu != 0 */
318 for (j = 0; j < i; j++) {
319 if ((dmu[j]) && (delta[j] > largest)) {
320 largest = delta[j];
321 ro = j;
322 }
323 }
324
325 /* compute difference */
326 diff = (mu[i] - mu[ro]);
327
328 /* Compute degree of the new smu polynomial */
329 if ((lmu[i] >> 1) > ((lmu[ro] >> 1) + diff))
330 lmu[i + 1] = lmu[i];
331 else
332 lmu[i + 1] = ((lmu[ro] >> 1) + diff) * 2;
333
334 /* Init smu[i+1] with 0 */
335 for (k = 0; k < num; k++)
336 smu[(i + 1) * num + k] = 0;
337
338 /* Compute smu[i+1] */
339 for (k = 0; k <= lmu[ro] >> 1; k++) {
340 int16_t a, b, c;
341
342 if (!(smu[ro * num + k] && dmu[i]))
343 continue;
344 a = readw(index_of + dmu[i]);
345 b = readw(index_of + dmu[ro]);
346 c = readw(index_of + smu[ro * num + k]);
347 tmp = a + (cw_len - b) + c;
348 a = readw(alpha_to + tmp % cw_len);
349 smu[(i + 1) * num + (k + diff)] = a;
350 }
351
352 for (k = 0; k <= lmu[i] >> 1; k++)
353 smu[(i + 1) * num + k] ^= smu[i * num + k];
354 }
355
356 /* End Computing Sigma (Mu+1) and L(mu) */
357 /* In either case compute delta */
358 delta[i + 1] = (mu[i + 1] * 2 - lmu[i + 1]) >> 1;
359
360 /* Do not compute discrepancy for the last iteration */
361 if (i >= cap)
362 continue;
363
364 for (k = 0; k <= (lmu[i + 1] >> 1); k++) {
365 tmp = 2 * (i - 1);
366 if (k == 0) {
367 dmu[i + 1] = si[tmp + 3];
368 } else if (smu[(i + 1) * num + k] && si[tmp + 3 - k]) {
369 int16_t a, b, c;
370 a = readw(index_of +
371 smu[(i + 1) * num + k]);
372 b = si[2 * (i - 1) + 3 - k];
373 c = readw(index_of + b);
374 tmp = a + c;
375 tmp %= cw_len;
376 dmu[i + 1] = readw(alpha_to + tmp) ^
377 dmu[i + 1];
378 }
379 }
380 }
381}
382
383static int pmecc_err_location(struct mtd_info *mtd)
384{
385 struct nand_chip *nand_chip = mtd->priv;
386 struct atmel_nand_host *host = nand_chip->priv;
387 const int cap = host->pmecc_corr_cap;
388 const int num = 2 * cap + 1;
389 int sector_size = host->pmecc_sector_size;
390 int err_nbr = 0; /* number of error */
391 int roots_nbr; /* number of roots */
392 int i;
393 uint32_t val;
394 int16_t *smu = host->pmecc_smu;
395 int timeout = PMECC_MAX_TIMEOUT_US;
396
Wu, Josh14b3b442014-06-24 18:18:06 +0800397 pmecc_writel(host->pmerrloc, eldis, PMERRLOC_DISABLE);
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000398
399 for (i = 0; i <= host->pmecc_lmu[cap + 1] >> 1; i++) {
Wu, Josh14b3b442014-06-24 18:18:06 +0800400 pmecc_writel(host->pmerrloc, sigma[i],
401 smu[(cap + 1) * num + i]);
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000402 err_nbr++;
403 }
404
405 val = PMERRLOC_ELCFG_NUM_ERRORS(err_nbr - 1);
406 if (sector_size == 1024)
407 val |= PMERRLOC_ELCFG_SECTOR_1024;
408
Wu, Josh14b3b442014-06-24 18:18:06 +0800409 pmecc_writel(host->pmerrloc, elcfg, val);
410 pmecc_writel(host->pmerrloc, elen,
411 sector_size * 8 + host->pmecc_degree * cap);
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000412
413 while (--timeout) {
Wu, Josh14b3b442014-06-24 18:18:06 +0800414 if (pmecc_readl(host->pmerrloc, elisr) & PMERRLOC_CALC_DONE)
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000415 break;
416 WATCHDOG_RESET();
417 udelay(1);
418 }
419
420 if (!timeout) {
Wu, Joshc0dc3de2013-10-18 17:46:34 +0800421 dev_err(host->dev, "atmel_nand : Timeout to calculate PMECC error location\n");
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000422 return -1;
423 }
424
Wu, Josh14b3b442014-06-24 18:18:06 +0800425 roots_nbr = (pmecc_readl(host->pmerrloc, elisr) & PMERRLOC_ERR_NUM_MASK)
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000426 >> 8;
427 /* Number of roots == degree of smu hence <= cap */
428 if (roots_nbr == host->pmecc_lmu[cap + 1] >> 1)
429 return err_nbr - 1;
430
431 /* Number of roots does not match the degree of smu
432 * unable to correct error */
433 return -1;
434}
435
436static void pmecc_correct_data(struct mtd_info *mtd, uint8_t *buf, uint8_t *ecc,
437 int sector_num, int extra_bytes, int err_nbr)
438{
439 struct nand_chip *nand_chip = mtd->priv;
440 struct atmel_nand_host *host = nand_chip->priv;
441 int i = 0;
442 int byte_pos, bit_pos, sector_size, pos;
443 uint32_t tmp;
444 uint8_t err_byte;
445
446 sector_size = host->pmecc_sector_size;
447
448 while (err_nbr) {
Wu, Josh14b3b442014-06-24 18:18:06 +0800449 tmp = pmecc_readl(host->pmerrloc, el[i]) - 1;
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000450 byte_pos = tmp / 8;
451 bit_pos = tmp % 8;
452
453 if (byte_pos >= (sector_size + extra_bytes))
454 BUG(); /* should never happen */
455
456 if (byte_pos < sector_size) {
457 err_byte = *(buf + byte_pos);
458 *(buf + byte_pos) ^= (1 << bit_pos);
459
460 pos = sector_num * host->pmecc_sector_size + byte_pos;
Wu, Joshc55cc572013-10-18 17:46:33 +0800461 dev_dbg(host->dev, "Bit flip in data area, byte_pos: %d, bit_pos: %d, 0x%02x -> 0x%02x\n",
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000462 pos, bit_pos, err_byte, *(buf + byte_pos));
463 } else {
464 /* Bit flip in OOB area */
465 tmp = sector_num * host->pmecc_bytes_per_sector
466 + (byte_pos - sector_size);
467 err_byte = ecc[tmp];
468 ecc[tmp] ^= (1 << bit_pos);
469
470 pos = tmp + nand_chip->ecc.layout->eccpos[0];
Wu, Joshc55cc572013-10-18 17:46:33 +0800471 dev_dbg(host->dev, "Bit flip in OOB, oob_byte_pos: %d, bit_pos: %d, 0x%02x -> 0x%02x\n",
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000472 pos, bit_pos, err_byte, ecc[tmp]);
473 }
474
475 i++;
476 err_nbr--;
477 }
478
479 return;
480}
481
482static int pmecc_correction(struct mtd_info *mtd, u32 pmecc_stat, uint8_t *buf,
483 u8 *ecc)
484{
485 struct nand_chip *nand_chip = mtd->priv;
486 struct atmel_nand_host *host = nand_chip->priv;
487 int i, err_nbr, eccbytes;
488 uint8_t *buf_pos;
489
Wu, Josh0e48dc52015-01-16 11:54:46 +0800490 /* SAMA5D4 PMECC IP can correct errors for all 0xff page */
491 if (host->pmecc_version >= PMECC_VERSION_SAMA5D4)
492 goto normal_check;
493
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000494 eccbytes = nand_chip->ecc.bytes;
495 for (i = 0; i < eccbytes; i++)
496 if (ecc[i] != 0xff)
497 goto normal_check;
498 /* Erased page, return OK */
499 return 0;
500
501normal_check:
502 for (i = 0; i < host->pmecc_sector_number; i++) {
503 err_nbr = 0;
504 if (pmecc_stat & 0x1) {
505 buf_pos = buf + i * host->pmecc_sector_size;
506
507 pmecc_gen_syndrome(mtd, i);
508 pmecc_substitute(mtd);
509 pmecc_get_sigma(mtd);
510
511 err_nbr = pmecc_err_location(mtd);
512 if (err_nbr == -1) {
Wu, Joshc0dc3de2013-10-18 17:46:34 +0800513 dev_err(host->dev, "PMECC: Too many errors\n");
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000514 mtd->ecc_stats.failed++;
515 return -EIO;
516 } else {
517 pmecc_correct_data(mtd, buf_pos, ecc, i,
518 host->pmecc_bytes_per_sector, err_nbr);
519 mtd->ecc_stats.corrected += err_nbr;
520 }
521 }
522 pmecc_stat >>= 1;
523 }
524
525 return 0;
526}
527
528static int atmel_nand_pmecc_read_page(struct mtd_info *mtd,
Sergey Lapindfe64e22013-01-14 03:46:50 +0000529 struct nand_chip *chip, uint8_t *buf, int oob_required, int page)
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000530{
531 struct atmel_nand_host *host = chip->priv;
532 int eccsize = chip->ecc.size;
533 uint8_t *oob = chip->oob_poi;
534 uint32_t *eccpos = chip->ecc.layout->eccpos;
535 uint32_t stat;
536 int timeout = PMECC_MAX_TIMEOUT_US;
537
538 pmecc_writel(host->pmecc, ctrl, PMECC_CTRL_RST);
539 pmecc_writel(host->pmecc, ctrl, PMECC_CTRL_DISABLE);
540 pmecc_writel(host->pmecc, cfg, ((pmecc_readl(host->pmecc, cfg))
541 & ~PMECC_CFG_WRITE_OP) | PMECC_CFG_AUTO_ENABLE);
542
543 pmecc_writel(host->pmecc, ctrl, PMECC_CTRL_ENABLE);
544 pmecc_writel(host->pmecc, ctrl, PMECC_CTRL_DATA);
545
546 chip->read_buf(mtd, buf, eccsize);
547 chip->read_buf(mtd, oob, mtd->oobsize);
548
549 while (--timeout) {
550 if (!(pmecc_readl(host->pmecc, sr) & PMECC_SR_BUSY))
551 break;
552 WATCHDOG_RESET();
553 udelay(1);
554 }
555
556 if (!timeout) {
Wu, Joshc0dc3de2013-10-18 17:46:34 +0800557 dev_err(host->dev, "atmel_nand : Timeout to read PMECC page\n");
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000558 return -1;
559 }
560
561 stat = pmecc_readl(host->pmecc, isr);
562 if (stat != 0)
563 if (pmecc_correction(mtd, stat, buf, &oob[eccpos[0]]) != 0)
564 return -EIO;
565
566 return 0;
567}
568
Sergey Lapindfe64e22013-01-14 03:46:50 +0000569static int atmel_nand_pmecc_write_page(struct mtd_info *mtd,
570 struct nand_chip *chip, const uint8_t *buf,
571 int oob_required)
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000572{
573 struct atmel_nand_host *host = chip->priv;
574 uint32_t *eccpos = chip->ecc.layout->eccpos;
575 int i, j;
576 int timeout = PMECC_MAX_TIMEOUT_US;
577
578 pmecc_writel(host->pmecc, ctrl, PMECC_CTRL_RST);
579 pmecc_writel(host->pmecc, ctrl, PMECC_CTRL_DISABLE);
580
581 pmecc_writel(host->pmecc, cfg, (pmecc_readl(host->pmecc, cfg) |
582 PMECC_CFG_WRITE_OP) & ~PMECC_CFG_AUTO_ENABLE);
583
584 pmecc_writel(host->pmecc, ctrl, PMECC_CTRL_ENABLE);
585 pmecc_writel(host->pmecc, ctrl, PMECC_CTRL_DATA);
586
587 chip->write_buf(mtd, (u8 *)buf, mtd->writesize);
588
589 while (--timeout) {
590 if (!(pmecc_readl(host->pmecc, sr) & PMECC_SR_BUSY))
591 break;
592 WATCHDOG_RESET();
593 udelay(1);
594 }
595
596 if (!timeout) {
Wu, Joshc0dc3de2013-10-18 17:46:34 +0800597 dev_err(host->dev, "atmel_nand : Timeout to read PMECC status, fail to write PMECC in oob\n");
Sergey Lapindfe64e22013-01-14 03:46:50 +0000598 goto out;
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000599 }
600
601 for (i = 0; i < host->pmecc_sector_number; i++) {
602 for (j = 0; j < host->pmecc_bytes_per_sector; j++) {
603 int pos;
604
605 pos = i * host->pmecc_bytes_per_sector + j;
606 chip->oob_poi[eccpos[pos]] =
Wu, Josh14b3b442014-06-24 18:18:06 +0800607 pmecc_readb(host->pmecc, ecc_port[i].ecc[j]);
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000608 }
609 }
610 chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
Sergey Lapindfe64e22013-01-14 03:46:50 +0000611out:
612 return 0;
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000613}
614
615static void atmel_pmecc_core_init(struct mtd_info *mtd)
616{
617 struct nand_chip *nand_chip = mtd->priv;
618 struct atmel_nand_host *host = nand_chip->priv;
619 uint32_t val = 0;
620 struct nand_ecclayout *ecc_layout;
621
622 pmecc_writel(host->pmecc, ctrl, PMECC_CTRL_RST);
623 pmecc_writel(host->pmecc, ctrl, PMECC_CTRL_DISABLE);
624
625 switch (host->pmecc_corr_cap) {
626 case 2:
627 val = PMECC_CFG_BCH_ERR2;
628 break;
629 case 4:
630 val = PMECC_CFG_BCH_ERR4;
631 break;
632 case 8:
633 val = PMECC_CFG_BCH_ERR8;
634 break;
635 case 12:
636 val = PMECC_CFG_BCH_ERR12;
637 break;
638 case 24:
639 val = PMECC_CFG_BCH_ERR24;
640 break;
641 }
642
643 if (host->pmecc_sector_size == 512)
644 val |= PMECC_CFG_SECTOR512;
645 else if (host->pmecc_sector_size == 1024)
646 val |= PMECC_CFG_SECTOR1024;
647
648 switch (host->pmecc_sector_number) {
649 case 1:
650 val |= PMECC_CFG_PAGE_1SECTOR;
651 break;
652 case 2:
653 val |= PMECC_CFG_PAGE_2SECTORS;
654 break;
655 case 4:
656 val |= PMECC_CFG_PAGE_4SECTORS;
657 break;
658 case 8:
659 val |= PMECC_CFG_PAGE_8SECTORS;
660 break;
661 }
662
663 val |= (PMECC_CFG_READ_OP | PMECC_CFG_SPARE_DISABLE
664 | PMECC_CFG_AUTO_DISABLE);
665 pmecc_writel(host->pmecc, cfg, val);
666
667 ecc_layout = nand_chip->ecc.layout;
668 pmecc_writel(host->pmecc, sarea, mtd->oobsize - 1);
669 pmecc_writel(host->pmecc, saddr, ecc_layout->eccpos[0]);
670 pmecc_writel(host->pmecc, eaddr,
671 ecc_layout->eccpos[ecc_layout->eccbytes - 1]);
672 /* See datasheet about PMECC Clock Control Register */
673 pmecc_writel(host->pmecc, clk, PMECC_CLK_133MHZ);
674 pmecc_writel(host->pmecc, idr, 0xff);
675 pmecc_writel(host->pmecc, ctrl, PMECC_CTRL_ENABLE);
676}
677
Wu, Josha07d2292013-07-04 15:36:23 +0800678#ifdef CONFIG_SYS_NAND_ONFI_DETECTION
679/*
Wu, Josha07d2292013-07-04 15:36:23 +0800680 * pmecc_choose_ecc - Get ecc requirement from ONFI parameters. If
681 * pmecc_corr_cap or pmecc_sector_size is 0, then set it as
682 * ONFI ECC parameters.
683 * @host: point to an atmel_nand_host structure.
684 * if host->pmecc_corr_cap is 0 then set it as the ONFI ecc_bits.
685 * if host->pmecc_sector_size is 0 then set it as the ONFI sector_size.
686 * @chip: point to an nand_chip structure.
687 * @cap: store the ONFI ECC correct bits capbility
688 * @sector_size: in how many bytes that ONFI require to correct @ecc_bits
689 *
690 * Return 0 if success. otherwise return the error code.
691 */
692static int pmecc_choose_ecc(struct atmel_nand_host *host,
693 struct nand_chip *chip,
694 int *cap, int *sector_size)
695{
696 /* Get ECC requirement from ONFI parameters */
697 *cap = *sector_size = 0;
698 if (chip->onfi_version) {
Josh Wu3a205672016-01-25 14:06:33 +0800699 *cap = chip->ecc_strength_ds;
700 *sector_size = chip->ecc_step_ds;
701 MTDDEBUG(MTD_DEBUG_LEVEL1, "ONFI params, minimum required ECC: %d bits in %d bytes\n",
702 *cap, *sector_size);
Wu, Josha07d2292013-07-04 15:36:23 +0800703 }
Josh Wu3a205672016-01-25 14:06:33 +0800704
Wu, Josha07d2292013-07-04 15:36:23 +0800705 if (*cap == 0 && *sector_size == 0) {
Josh Wu3a205672016-01-25 14:06:33 +0800706 /* Non-ONFI compliant */
707 dev_info(host->dev, "NAND chip is not ONFI compliant, assume ecc_bits is 2 in 512 bytes\n");
Wu, Josha07d2292013-07-04 15:36:23 +0800708 *cap = 2;
709 *sector_size = 512;
710 }
711
712 /* If head file doesn't specify then use the one in ONFI parameters */
713 if (host->pmecc_corr_cap == 0) {
714 /* use the most fitable ecc bits (the near bigger one ) */
715 if (*cap <= 2)
716 host->pmecc_corr_cap = 2;
717 else if (*cap <= 4)
718 host->pmecc_corr_cap = 4;
719 else if (*cap <= 8)
720 host->pmecc_corr_cap = 8;
721 else if (*cap <= 12)
722 host->pmecc_corr_cap = 12;
723 else if (*cap <= 24)
724 host->pmecc_corr_cap = 24;
725 else
726 return -EINVAL;
727 }
728 if (host->pmecc_sector_size == 0) {
729 /* use the most fitable sector size (the near smaller one ) */
730 if (*sector_size >= 1024)
731 host->pmecc_sector_size = 1024;
732 else if (*sector_size >= 512)
733 host->pmecc_sector_size = 512;
734 else
735 return -EINVAL;
736 }
737 return 0;
738}
739#endif
740
Josh Wu7df44862014-11-10 15:24:00 +0800741#if defined(NO_GALOIS_TABLE_IN_ROM)
742static uint16_t *pmecc_galois_table;
743static inline int deg(unsigned int poly)
744{
745 /* polynomial degree is the most-significant bit index */
746 return fls(poly) - 1;
747}
748
749static int build_gf_tables(int mm, unsigned int poly,
750 int16_t *index_of, int16_t *alpha_to)
751{
752 unsigned int i, x = 1;
753 const unsigned int k = 1 << deg(poly);
754 unsigned int nn = (1 << mm) - 1;
755
756 /* primitive polynomial must be of degree m */
757 if (k != (1u << mm))
758 return -EINVAL;
759
760 for (i = 0; i < nn; i++) {
761 alpha_to[i] = x;
762 index_of[x] = i;
763 if (i && (x == 1))
764 /* polynomial is not primitive (a^i=1 with 0<i<2^m-1) */
765 return -EINVAL;
766 x <<= 1;
767 if (x & k)
768 x ^= poly;
769 }
770
771 alpha_to[nn] = 1;
772 index_of[0] = 0;
773
774 return 0;
775}
776
777static uint16_t *create_lookup_table(int sector_size)
778{
779 int degree = (sector_size == 512) ?
780 PMECC_GF_DIMENSION_13 :
781 PMECC_GF_DIMENSION_14;
782 unsigned int poly = (sector_size == 512) ?
783 PMECC_GF_13_PRIMITIVE_POLY :
784 PMECC_GF_14_PRIMITIVE_POLY;
785 int table_size = (sector_size == 512) ?
786 PMECC_INDEX_TABLE_SIZE_512 :
787 PMECC_INDEX_TABLE_SIZE_1024;
788
789 int16_t *addr = kzalloc(2 * table_size * sizeof(uint16_t), GFP_KERNEL);
790 if (addr && build_gf_tables(degree, poly, addr, addr + table_size))
791 return NULL;
792
793 return (uint16_t *)addr;
794}
795#endif
796
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000797static int atmel_pmecc_nand_init_params(struct nand_chip *nand,
798 struct mtd_info *mtd)
799{
800 struct atmel_nand_host *host;
801 int cap, sector_size;
802
803 host = nand->priv = &pmecc_host;
804
805 nand->ecc.mode = NAND_ECC_HW;
806 nand->ecc.calculate = NULL;
807 nand->ecc.correct = NULL;
808 nand->ecc.hwctl = NULL;
809
Wu, Josha07d2292013-07-04 15:36:23 +0800810#ifdef CONFIG_SYS_NAND_ONFI_DETECTION
811 host->pmecc_corr_cap = host->pmecc_sector_size = 0;
812
813#ifdef CONFIG_PMECC_CAP
814 host->pmecc_corr_cap = CONFIG_PMECC_CAP;
815#endif
816#ifdef CONFIG_PMECC_SECTOR_SIZE
817 host->pmecc_sector_size = CONFIG_PMECC_SECTOR_SIZE;
818#endif
819 /* Get ECC requirement of ONFI parameters. And if CONFIG_PMECC_CAP or
820 * CONFIG_PMECC_SECTOR_SIZE not defined, then use ecc_bits, sector_size
821 * from ONFI.
822 */
823 if (pmecc_choose_ecc(host, nand, &cap, &sector_size)) {
Josh Wu4c6a6ea2016-01-25 14:06:34 +0800824 dev_err(host->dev, "Required ECC %d bits in %d bytes not supported!\n",
825 cap, sector_size);
Wu, Josha07d2292013-07-04 15:36:23 +0800826 return -EINVAL;
827 }
828
829 if (cap > host->pmecc_corr_cap)
830 dev_info(host->dev, "WARNING: Using different ecc correct bits(%d bit) from Nand ONFI ECC reqirement (%d bit).\n",
831 host->pmecc_corr_cap, cap);
832 if (sector_size < host->pmecc_sector_size)
833 dev_info(host->dev, "WARNING: Using different ecc correct sector size (%d bytes) from Nand ONFI ECC reqirement (%d bytes).\n",
834 host->pmecc_sector_size, sector_size);
835#else /* CONFIG_SYS_NAND_ONFI_DETECTION */
836 host->pmecc_corr_cap = CONFIG_PMECC_CAP;
837 host->pmecc_sector_size = CONFIG_PMECC_SECTOR_SIZE;
838#endif
839
840 cap = host->pmecc_corr_cap;
841 sector_size = host->pmecc_sector_size;
842
843 /* TODO: need check whether cap & sector_size is validate */
Josh Wu7df44862014-11-10 15:24:00 +0800844#if defined(NO_GALOIS_TABLE_IN_ROM)
845 /*
846 * As pmecc_rom_base is the begin of the gallois field table, So the
847 * index offset just set as 0.
848 */
849 host->pmecc_index_table_offset = 0;
850#else
Wu, Joshb2d96dc2013-07-03 11:11:45 +0800851 if (host->pmecc_sector_size == 512)
852 host->pmecc_index_table_offset = ATMEL_PMECC_INDEX_OFFSET_512;
853 else
854 host->pmecc_index_table_offset = ATMEL_PMECC_INDEX_OFFSET_1024;
Josh Wu7df44862014-11-10 15:24:00 +0800855#endif
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000856
Wu, Joshb9c83c62012-09-09 23:45:49 +0000857 MTDDEBUG(MTD_DEBUG_LEVEL1,
858 "Initialize PMECC params, cap: %d, sector: %d\n",
859 cap, sector_size);
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000860
861 host->pmecc = (struct pmecc_regs __iomem *) ATMEL_BASE_PMECC;
862 host->pmerrloc = (struct pmecc_errloc_regs __iomem *)
863 ATMEL_BASE_PMERRLOC;
Josh Wu7df44862014-11-10 15:24:00 +0800864#if defined(NO_GALOIS_TABLE_IN_ROM)
865 pmecc_galois_table = create_lookup_table(host->pmecc_sector_size);
866 if (!pmecc_galois_table) {
867 dev_err(host->dev, "out of memory\n");
868 return -ENOMEM;
869 }
870
871 host->pmecc_rom_base = (void __iomem *)pmecc_galois_table;
872#else
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000873 host->pmecc_rom_base = (void __iomem *) ATMEL_BASE_ROM;
Josh Wu7df44862014-11-10 15:24:00 +0800874#endif
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000875
876 /* ECC is calculated for the whole page (1 step) */
877 nand->ecc.size = mtd->writesize;
878
879 /* set ECC page size and oob layout */
880 switch (mtd->writesize) {
881 case 2048:
882 case 4096:
Wu, Josh16dddef2013-10-18 17:46:31 +0800883 case 8192:
Wu, Josh1bd3e2a2013-08-23 15:09:05 +0800884 host->pmecc_degree = (sector_size == 512) ?
885 PMECC_GF_DIMENSION_13 : PMECC_GF_DIMENSION_14;
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000886 host->pmecc_cw_len = (1 << host->pmecc_degree) - 1;
887 host->pmecc_sector_number = mtd->writesize / sector_size;
888 host->pmecc_bytes_per_sector = pmecc_get_ecc_bytes(
889 cap, sector_size);
890 host->pmecc_alpha_to = pmecc_get_alpha_to(host);
891 host->pmecc_index_of = host->pmecc_rom_base +
892 host->pmecc_index_table_offset;
893
894 nand->ecc.steps = 1;
895 nand->ecc.bytes = host->pmecc_bytes_per_sector *
896 host->pmecc_sector_number;
Wu, Josh16dddef2013-10-18 17:46:31 +0800897
898 if (nand->ecc.bytes > MTD_MAX_ECCPOS_ENTRIES_LARGE) {
899 dev_err(host->dev, "too large eccpos entries. max support ecc.bytes is %d\n",
900 MTD_MAX_ECCPOS_ENTRIES_LARGE);
901 return -EINVAL;
902 }
903
Josh Wu422b49e2016-01-25 14:06:35 +0800904 if (nand->ecc.bytes > mtd->oobsize - PMECC_OOB_RESERVED_BYTES) {
Wu, Joshc0dc3de2013-10-18 17:46:34 +0800905 dev_err(host->dev, "No room for ECC bytes\n");
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000906 return -EINVAL;
907 }
908 pmecc_config_ecc_layout(&atmel_pmecc_oobinfo,
909 mtd->oobsize,
910 nand->ecc.bytes);
911 nand->ecc.layout = &atmel_pmecc_oobinfo;
912 break;
913 case 512:
914 case 1024:
915 /* TODO */
Wu, Joshc0dc3de2013-10-18 17:46:34 +0800916 dev_err(host->dev, "Unsupported page size for PMECC, use Software ECC\n");
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000917 default:
918 /* page size not handled by HW ECC */
919 /* switching back to soft ECC */
920 nand->ecc.mode = NAND_ECC_SOFT;
921 nand->ecc.read_page = NULL;
922 nand->ecc.postpad = 0;
923 nand->ecc.prepad = 0;
924 nand->ecc.bytes = 0;
925 return 0;
926 }
927
Wu, Joshddd85972013-07-03 11:11:48 +0800928 /* Allocate data for PMECC computation */
929 if (pmecc_data_alloc(host)) {
930 dev_err(host->dev, "Cannot allocate memory for PMECC computation!\n");
931 return -ENOMEM;
932 }
933
Boris BREZILLONd357b942014-09-02 10:23:09 +0200934 nand->options |= NAND_NO_SUBPAGE_WRITE;
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000935 nand->ecc.read_page = atmel_nand_pmecc_read_page;
936 nand->ecc.write_page = atmel_nand_pmecc_write_page;
Sergey Lapindfe64e22013-01-14 03:46:50 +0000937 nand->ecc.strength = cap;
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000938
Wu, Josh0e48dc52015-01-16 11:54:46 +0800939 /* Check the PMECC ip version */
940 host->pmecc_version = pmecc_readl(host->pmerrloc, version);
941 dev_dbg(host->dev, "PMECC IP version is: %x\n", host->pmecc_version);
942
Wu, Joshbdfd59a2012-08-23 00:05:36 +0000943 atmel_pmecc_core_init(mtd);
944
945 return 0;
946}
947
948#else
949
Nikolay Petukhov7c27b7b2010-03-19 10:49:27 +0500950/* oob layout for large page size
951 * bad block info is on bytes 0 and 1
952 * the bytes have to be consecutives to avoid
953 * several NAND_CMD_RNDOUT during read
954 */
955static struct nand_ecclayout atmel_oobinfo_large = {
956 .eccbytes = 4,
957 .eccpos = {60, 61, 62, 63},
958 .oobfree = {
959 {2, 58}
960 },
961};
962
963/* oob layout for small page size
964 * bad block info is on bytes 4 and 5
965 * the bytes have to be consecutives to avoid
966 * several NAND_CMD_RNDOUT during read
967 */
968static struct nand_ecclayout atmel_oobinfo_small = {
969 .eccbytes = 4,
970 .eccpos = {0, 1, 2, 3},
971 .oobfree = {
972 {6, 10}
973 },
974};
975
976/*
977 * Calculate HW ECC
978 *
979 * function called after a write
980 *
981 * mtd: MTD block structure
982 * dat: raw data (unused)
983 * ecc_code: buffer for ECC
984 */
985static int atmel_nand_calculate(struct mtd_info *mtd,
986 const u_char *dat, unsigned char *ecc_code)
987{
Nikolay Petukhov7c27b7b2010-03-19 10:49:27 +0500988 unsigned int ecc_value;
989
990 /* get the first 2 ECC bytes */
991 ecc_value = ecc_readl(CONFIG_SYS_NAND_ECC_BASE, PR);
992
993 ecc_code[0] = ecc_value & 0xFF;
994 ecc_code[1] = (ecc_value >> 8) & 0xFF;
995
996 /* get the last 2 ECC bytes */
997 ecc_value = ecc_readl(CONFIG_SYS_NAND_ECC_BASE, NPR) & ATMEL_ECC_NPARITY;
998
999 ecc_code[2] = ecc_value & 0xFF;
1000 ecc_code[3] = (ecc_value >> 8) & 0xFF;
1001
1002 return 0;
1003}
1004
1005/*
1006 * HW ECC read page function
1007 *
1008 * mtd: mtd info structure
1009 * chip: nand chip info structure
1010 * buf: buffer to store read data
Sergey Lapindfe64e22013-01-14 03:46:50 +00001011 * oob_required: caller expects OOB data read to chip->oob_poi
Nikolay Petukhov7c27b7b2010-03-19 10:49:27 +05001012 */
Sergey Lapindfe64e22013-01-14 03:46:50 +00001013static int atmel_nand_read_page(struct mtd_info *mtd, struct nand_chip *chip,
1014 uint8_t *buf, int oob_required, int page)
Nikolay Petukhov7c27b7b2010-03-19 10:49:27 +05001015{
1016 int eccsize = chip->ecc.size;
1017 int eccbytes = chip->ecc.bytes;
1018 uint32_t *eccpos = chip->ecc.layout->eccpos;
1019 uint8_t *p = buf;
1020 uint8_t *oob = chip->oob_poi;
1021 uint8_t *ecc_pos;
1022 int stat;
1023
1024 /* read the page */
1025 chip->read_buf(mtd, p, eccsize);
1026
1027 /* move to ECC position if needed */
1028 if (eccpos[0] != 0) {
1029 /* This only works on large pages
1030 * because the ECC controller waits for
1031 * NAND_CMD_RNDOUTSTART after the
1032 * NAND_CMD_RNDOUT.
1033 * anyway, for small pages, the eccpos[0] == 0
1034 */
1035 chip->cmdfunc(mtd, NAND_CMD_RNDOUT,
1036 mtd->writesize + eccpos[0], -1);
1037 }
1038
1039 /* the ECC controller needs to read the ECC just after the data */
1040 ecc_pos = oob + eccpos[0];
1041 chip->read_buf(mtd, ecc_pos, eccbytes);
1042
1043 /* check if there's an error */
1044 stat = chip->ecc.correct(mtd, p, oob, NULL);
1045
1046 if (stat < 0)
1047 mtd->ecc_stats.failed++;
1048 else
1049 mtd->ecc_stats.corrected += stat;
1050
1051 /* get back to oob start (end of page) */
1052 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, mtd->writesize, -1);
1053
1054 /* read the oob */
1055 chip->read_buf(mtd, oob, mtd->oobsize);
1056
1057 return 0;
1058}
1059
1060/*
1061 * HW ECC Correction
1062 *
1063 * function called after a read
1064 *
1065 * mtd: MTD block structure
1066 * dat: raw data read from the chip
1067 * read_ecc: ECC from the chip (unused)
1068 * isnull: unused
1069 *
1070 * Detect and correct a 1 bit error for a page
1071 */
1072static int atmel_nand_correct(struct mtd_info *mtd, u_char *dat,
1073 u_char *read_ecc, u_char *isnull)
1074{
1075 struct nand_chip *nand_chip = mtd->priv;
Wu, Joshae797942012-08-23 00:05:35 +00001076 unsigned int ecc_status;
Nikolay Petukhov7c27b7b2010-03-19 10:49:27 +05001077 unsigned int ecc_word, ecc_bit;
1078
1079 /* get the status from the Status Register */
1080 ecc_status = ecc_readl(CONFIG_SYS_NAND_ECC_BASE, SR);
1081
1082 /* if there's no error */
1083 if (likely(!(ecc_status & ATMEL_ECC_RECERR)))
1084 return 0;
1085
1086 /* get error bit offset (4 bits) */
1087 ecc_bit = ecc_readl(CONFIG_SYS_NAND_ECC_BASE, PR) & ATMEL_ECC_BITADDR;
1088 /* get word address (12 bits) */
1089 ecc_word = ecc_readl(CONFIG_SYS_NAND_ECC_BASE, PR) & ATMEL_ECC_WORDADDR;
1090 ecc_word >>= 4;
1091
1092 /* if there are multiple errors */
1093 if (ecc_status & ATMEL_ECC_MULERR) {
1094 /* check if it is a freshly erased block
1095 * (filled with 0xff) */
1096 if ((ecc_bit == ATMEL_ECC_BITADDR)
1097 && (ecc_word == (ATMEL_ECC_WORDADDR >> 4))) {
1098 /* the block has just been erased, return OK */
1099 return 0;
1100 }
1101 /* it doesn't seems to be a freshly
1102 * erased block.
1103 * We can't correct so many errors */
Wu, Joshc0dc3de2013-10-18 17:46:34 +08001104 dev_warn(host->dev, "atmel_nand : multiple errors detected."
Nikolay Petukhov7c27b7b2010-03-19 10:49:27 +05001105 " Unable to correct.\n");
1106 return -EIO;
1107 }
1108
1109 /* if there's a single bit error : we can correct it */
1110 if (ecc_status & ATMEL_ECC_ECCERR) {
1111 /* there's nothing much to do here.
1112 * the bit error is on the ECC itself.
1113 */
Wu, Joshc0dc3de2013-10-18 17:46:34 +08001114 dev_warn(host->dev, "atmel_nand : one bit error on ECC code."
Nikolay Petukhov7c27b7b2010-03-19 10:49:27 +05001115 " Nothing to correct\n");
1116 return 0;
1117 }
1118
Wu, Joshc0dc3de2013-10-18 17:46:34 +08001119 dev_warn(host->dev, "atmel_nand : one bit error on data."
Nikolay Petukhov7c27b7b2010-03-19 10:49:27 +05001120 " (word offset in the page :"
1121 " 0x%x bit offset : 0x%x)\n",
1122 ecc_word, ecc_bit);
1123 /* correct the error */
1124 if (nand_chip->options & NAND_BUSWIDTH_16) {
1125 /* 16 bits words */
1126 ((unsigned short *) dat)[ecc_word] ^= (1 << ecc_bit);
1127 } else {
1128 /* 8 bits words */
1129 dat[ecc_word] ^= (1 << ecc_bit);
1130 }
Wu, Joshc0dc3de2013-10-18 17:46:34 +08001131 dev_warn(host->dev, "atmel_nand : error corrected\n");
Nikolay Petukhov7c27b7b2010-03-19 10:49:27 +05001132 return 1;
1133}
1134
1135/*
1136 * Enable HW ECC : unused on most chips
1137 */
1138static void atmel_nand_hwctl(struct mtd_info *mtd, int mode)
1139{
1140}
Wu, Joshfe2185e2012-08-23 00:05:34 +00001141
1142int atmel_hwecc_nand_init_param(struct nand_chip *nand, struct mtd_info *mtd)
1143{
1144 nand->ecc.mode = NAND_ECC_HW;
1145 nand->ecc.calculate = atmel_nand_calculate;
1146 nand->ecc.correct = atmel_nand_correct;
1147 nand->ecc.hwctl = atmel_nand_hwctl;
1148 nand->ecc.read_page = atmel_nand_read_page;
1149 nand->ecc.bytes = 4;
1150
1151 if (nand->ecc.mode == NAND_ECC_HW) {
1152 /* ECC is calculated for the whole page (1 step) */
1153 nand->ecc.size = mtd->writesize;
1154
1155 /* set ECC page size and oob layout */
1156 switch (mtd->writesize) {
1157 case 512:
1158 nand->ecc.layout = &atmel_oobinfo_small;
1159 ecc_writel(CONFIG_SYS_NAND_ECC_BASE, MR,
1160 ATMEL_ECC_PAGESIZE_528);
1161 break;
1162 case 1024:
1163 nand->ecc.layout = &atmel_oobinfo_large;
1164 ecc_writel(CONFIG_SYS_NAND_ECC_BASE, MR,
1165 ATMEL_ECC_PAGESIZE_1056);
1166 break;
1167 case 2048:
1168 nand->ecc.layout = &atmel_oobinfo_large;
1169 ecc_writel(CONFIG_SYS_NAND_ECC_BASE, MR,
1170 ATMEL_ECC_PAGESIZE_2112);
1171 break;
1172 case 4096:
1173 nand->ecc.layout = &atmel_oobinfo_large;
1174 ecc_writel(CONFIG_SYS_NAND_ECC_BASE, MR,
1175 ATMEL_ECC_PAGESIZE_4224);
1176 break;
1177 default:
1178 /* page size not handled by HW ECC */
1179 /* switching back to soft ECC */
1180 nand->ecc.mode = NAND_ECC_SOFT;
1181 nand->ecc.calculate = NULL;
1182 nand->ecc.correct = NULL;
1183 nand->ecc.hwctl = NULL;
1184 nand->ecc.read_page = NULL;
1185 nand->ecc.postpad = 0;
1186 nand->ecc.prepad = 0;
1187 nand->ecc.bytes = 0;
1188 break;
1189 }
1190 }
1191
1192 return 0;
1193}
1194
Wu, Joshbdfd59a2012-08-23 00:05:36 +00001195#endif /* CONFIG_ATMEL_NAND_HW_PMECC */
1196
1197#endif /* CONFIG_ATMEL_NAND_HWECC */
Nikolay Petukhov7c27b7b2010-03-19 10:49:27 +05001198
Jean-Christophe PLAGNIOL-VILLARD74c076d2009-03-22 10:22:34 +01001199static void at91_nand_hwcontrol(struct mtd_info *mtd,
Sergey Lapin10794322008-10-31 12:28:43 +01001200 int cmd, unsigned int ctrl)
1201{
1202 struct nand_chip *this = mtd->priv;
1203
1204 if (ctrl & NAND_CTRL_CHANGE) {
1205 ulong IO_ADDR_W = (ulong) this->IO_ADDR_W;
Jean-Christophe PLAGNIOL-VILLARD74c076d2009-03-22 10:22:34 +01001206 IO_ADDR_W &= ~(CONFIG_SYS_NAND_MASK_ALE
1207 | CONFIG_SYS_NAND_MASK_CLE);
Sergey Lapin10794322008-10-31 12:28:43 +01001208
1209 if (ctrl & NAND_CLE)
Jean-Christophe PLAGNIOL-VILLARD74c076d2009-03-22 10:22:34 +01001210 IO_ADDR_W |= CONFIG_SYS_NAND_MASK_CLE;
Sergey Lapin10794322008-10-31 12:28:43 +01001211 if (ctrl & NAND_ALE)
Jean-Christophe PLAGNIOL-VILLARD74c076d2009-03-22 10:22:34 +01001212 IO_ADDR_W |= CONFIG_SYS_NAND_MASK_ALE;
Sergey Lapin10794322008-10-31 12:28:43 +01001213
michael67a490d2011-03-14 21:16:38 +00001214#ifdef CONFIG_SYS_NAND_ENABLE_PIN
Andreas Bießmannac45bb12013-11-29 12:13:45 +01001215 gpio_set_value(CONFIG_SYS_NAND_ENABLE_PIN, !(ctrl & NAND_NCE));
michael67a490d2011-03-14 21:16:38 +00001216#endif
Sergey Lapin10794322008-10-31 12:28:43 +01001217 this->IO_ADDR_W = (void *) IO_ADDR_W;
1218 }
1219
1220 if (cmd != NAND_CMD_NONE)
1221 writeb(cmd, this->IO_ADDR_W);
1222}
1223
Jean-Christophe PLAGNIOL-VILLARD74c076d2009-03-22 10:22:34 +01001224#ifdef CONFIG_SYS_NAND_READY_PIN
1225static int at91_nand_ready(struct mtd_info *mtd)
Sergey Lapin10794322008-10-31 12:28:43 +01001226{
Andreas Bießmannac45bb12013-11-29 12:13:45 +01001227 return gpio_get_value(CONFIG_SYS_NAND_READY_PIN);
Sergey Lapin10794322008-10-31 12:28:43 +01001228}
Jean-Christophe PLAGNIOL-VILLARD74c076d2009-03-22 10:22:34 +01001229#endif
Sergey Lapin10794322008-10-31 12:28:43 +01001230
Bo Shen0b0b4f52014-03-03 14:47:16 +08001231#ifdef CONFIG_SPL_BUILD
1232/* The following code is for SPL */
1233static nand_info_t mtd;
1234static struct nand_chip nand_chip;
1235
1236static int nand_command(int block, int page, uint32_t offs, u8 cmd)
1237{
1238 struct nand_chip *this = mtd.priv;
1239 int page_addr = page + block * CONFIG_SYS_NAND_PAGE_COUNT;
1240 void (*hwctrl)(struct mtd_info *mtd, int cmd,
1241 unsigned int ctrl) = this->cmd_ctrl;
1242
Heiko Schocher667af362014-10-31 08:31:03 +01001243 while (!this->dev_ready(&mtd))
Bo Shen0b0b4f52014-03-03 14:47:16 +08001244 ;
1245
1246 if (cmd == NAND_CMD_READOOB) {
1247 offs += CONFIG_SYS_NAND_PAGE_SIZE;
1248 cmd = NAND_CMD_READ0;
1249 }
1250
1251 hwctrl(&mtd, cmd, NAND_CTRL_CLE | NAND_CTRL_CHANGE);
1252
Brian Norris27ce9e42014-05-06 00:46:17 +05301253 if ((this->options & NAND_BUSWIDTH_16) && !nand_opcode_8bits(cmd))
Bo Shen0b0b4f52014-03-03 14:47:16 +08001254 offs >>= 1;
1255
1256 hwctrl(&mtd, offs & 0xff, NAND_CTRL_ALE | NAND_CTRL_CHANGE);
1257 hwctrl(&mtd, (offs >> 8) & 0xff, NAND_CTRL_ALE);
1258 hwctrl(&mtd, (page_addr & 0xff), NAND_CTRL_ALE);
1259 hwctrl(&mtd, ((page_addr >> 8) & 0xff), NAND_CTRL_ALE);
1260#ifdef CONFIG_SYS_NAND_5_ADDR_CYCLE
1261 hwctrl(&mtd, (page_addr >> 16) & 0x0f, NAND_CTRL_ALE);
1262#endif
1263 hwctrl(&mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
1264
1265 hwctrl(&mtd, NAND_CMD_READSTART, NAND_CTRL_CLE | NAND_CTRL_CHANGE);
1266 hwctrl(&mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
1267
Heiko Schocher667af362014-10-31 08:31:03 +01001268 while (!this->dev_ready(&mtd))
Bo Shen0b0b4f52014-03-03 14:47:16 +08001269 ;
1270
1271 return 0;
1272}
1273
1274static int nand_is_bad_block(int block)
1275{
1276 struct nand_chip *this = mtd.priv;
1277
1278 nand_command(block, 0, CONFIG_SYS_NAND_BAD_BLOCK_POS, NAND_CMD_READOOB);
1279
1280 if (this->options & NAND_BUSWIDTH_16) {
1281 if (readw(this->IO_ADDR_R) != 0xffff)
1282 return 1;
1283 } else {
1284 if (readb(this->IO_ADDR_R) != 0xff)
1285 return 1;
1286 }
1287
1288 return 0;
1289}
1290
1291#ifdef CONFIG_SPL_NAND_ECC
1292static int nand_ecc_pos[] = CONFIG_SYS_NAND_ECCPOS;
1293#define ECCSTEPS (CONFIG_SYS_NAND_PAGE_SIZE / \
1294 CONFIG_SYS_NAND_ECCSIZE)
1295#define ECCTOTAL (ECCSTEPS * CONFIG_SYS_NAND_ECCBYTES)
1296
1297static int nand_read_page(int block, int page, void *dst)
1298{
1299 struct nand_chip *this = mtd.priv;
1300 u_char ecc_calc[ECCTOTAL];
1301 u_char ecc_code[ECCTOTAL];
1302 u_char oob_data[CONFIG_SYS_NAND_OOBSIZE];
1303 int eccsize = CONFIG_SYS_NAND_ECCSIZE;
1304 int eccbytes = CONFIG_SYS_NAND_ECCBYTES;
1305 int eccsteps = ECCSTEPS;
1306 int i;
1307 uint8_t *p = dst;
1308 nand_command(block, page, 0, NAND_CMD_READ0);
1309
1310 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1311 if (this->ecc.mode != NAND_ECC_SOFT)
1312 this->ecc.hwctl(&mtd, NAND_ECC_READ);
1313 this->read_buf(&mtd, p, eccsize);
1314 this->ecc.calculate(&mtd, p, &ecc_calc[i]);
1315 }
1316 this->read_buf(&mtd, oob_data, CONFIG_SYS_NAND_OOBSIZE);
1317
1318 for (i = 0; i < ECCTOTAL; i++)
1319 ecc_code[i] = oob_data[nand_ecc_pos[i]];
1320
1321 eccsteps = ECCSTEPS;
1322 p = dst;
1323
1324 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
1325 this->ecc.correct(&mtd, p, &ecc_code[i], &ecc_calc[i]);
1326
1327 return 0;
1328}
Heiko Schocher4dfd3602014-10-31 08:31:02 +01001329
1330int spl_nand_erase_one(int block, int page)
1331{
1332 struct nand_chip *this = mtd.priv;
1333 void (*hwctrl)(struct mtd_info *mtd, int cmd,
1334 unsigned int ctrl) = this->cmd_ctrl;
1335 int page_addr;
1336
1337 if (nand_chip.select_chip)
1338 nand_chip.select_chip(&mtd, 0);
1339
1340 page_addr = page + block * CONFIG_SYS_NAND_PAGE_COUNT;
1341 hwctrl(&mtd, NAND_CMD_ERASE1, NAND_CTRL_CLE | NAND_CTRL_CHANGE);
1342 /* Row address */
1343 hwctrl(&mtd, (page_addr & 0xff), NAND_CTRL_ALE | NAND_CTRL_CHANGE);
1344 hwctrl(&mtd, ((page_addr >> 8) & 0xff),
1345 NAND_CTRL_ALE | NAND_CTRL_CHANGE);
1346#ifdef CONFIG_SYS_NAND_5_ADDR_CYCLE
1347 /* One more address cycle for devices > 128MiB */
1348 hwctrl(&mtd, (page_addr >> 16) & 0x0f,
1349 NAND_CTRL_ALE | NAND_CTRL_CHANGE);
1350#endif
Heiko Schocher4dfd3602014-10-31 08:31:02 +01001351 hwctrl(&mtd, NAND_CMD_ERASE2, NAND_CTRL_CLE | NAND_CTRL_CHANGE);
Heiko Schocher4dfd3602014-10-31 08:31:02 +01001352
1353 while (!this->dev_ready(&mtd))
1354 ;
1355
1356 nand_deselect();
1357
1358 return 0;
1359}
Bo Shen0b0b4f52014-03-03 14:47:16 +08001360#else
1361static int nand_read_page(int block, int page, void *dst)
1362{
1363 struct nand_chip *this = mtd.priv;
1364
1365 nand_command(block, page, 0, NAND_CMD_READ0);
1366 atmel_nand_pmecc_read_page(&mtd, this, dst, 0, page);
1367
1368 return 0;
1369}
1370#endif /* CONFIG_SPL_NAND_ECC */
1371
1372int nand_spl_load_image(uint32_t offs, unsigned int size, void *dst)
1373{
1374 unsigned int block, lastblock;
1375 unsigned int page;
1376
1377 block = offs / CONFIG_SYS_NAND_BLOCK_SIZE;
1378 lastblock = (offs + size - 1) / CONFIG_SYS_NAND_BLOCK_SIZE;
1379 page = (offs % CONFIG_SYS_NAND_BLOCK_SIZE) / CONFIG_SYS_NAND_PAGE_SIZE;
1380
1381 while (block <= lastblock) {
1382 if (!nand_is_bad_block(block)) {
1383 while (page < CONFIG_SYS_NAND_PAGE_COUNT) {
1384 nand_read_page(block, page, dst);
1385 dst += CONFIG_SYS_NAND_PAGE_SIZE;
1386 page++;
1387 }
1388
1389 page = 0;
1390 } else {
1391 lastblock++;
1392 }
1393
1394 block++;
1395 }
1396
1397 return 0;
1398}
1399
1400int at91_nand_wait_ready(struct mtd_info *mtd)
1401{
1402 struct nand_chip *this = mtd->priv;
1403
1404 udelay(this->chip_delay);
1405
Heiko Schocher667af362014-10-31 08:31:03 +01001406 return 1;
Bo Shen0b0b4f52014-03-03 14:47:16 +08001407}
1408
1409int board_nand_init(struct nand_chip *nand)
1410{
1411 int ret = 0;
1412
1413 nand->ecc.mode = NAND_ECC_SOFT;
1414#ifdef CONFIG_SYS_NAND_DBW_16
1415 nand->options = NAND_BUSWIDTH_16;
1416 nand->read_buf = nand_read_buf16;
1417#else
1418 nand->read_buf = nand_read_buf;
1419#endif
1420 nand->cmd_ctrl = at91_nand_hwcontrol;
1421#ifdef CONFIG_SYS_NAND_READY_PIN
1422 nand->dev_ready = at91_nand_ready;
1423#else
1424 nand->dev_ready = at91_nand_wait_ready;
1425#endif
1426 nand->chip_delay = 20;
David Dueckda78fb52015-03-20 10:52:49 +01001427#ifdef CONFIG_SYS_NAND_USE_FLASH_BBT
1428 nand->bbt_options |= NAND_BBT_USE_FLASH;
1429#endif
Bo Shen0b0b4f52014-03-03 14:47:16 +08001430
1431#ifdef CONFIG_ATMEL_NAND_HWECC
1432#ifdef CONFIG_ATMEL_NAND_HW_PMECC
1433 ret = atmel_pmecc_nand_init_params(nand, &mtd);
1434#endif
1435#endif
1436
1437 return ret;
1438}
1439
1440void nand_init(void)
1441{
1442 mtd.writesize = CONFIG_SYS_NAND_PAGE_SIZE;
1443 mtd.oobsize = CONFIG_SYS_NAND_OOBSIZE;
1444 mtd.priv = &nand_chip;
1445 nand_chip.IO_ADDR_R = (void __iomem *)CONFIG_SYS_NAND_BASE;
1446 nand_chip.IO_ADDR_W = (void __iomem *)CONFIG_SYS_NAND_BASE;
1447 board_nand_init(&nand_chip);
1448
1449#ifdef CONFIG_SPL_NAND_ECC
1450 if (nand_chip.ecc.mode == NAND_ECC_SOFT) {
1451 nand_chip.ecc.calculate = nand_calculate_ecc;
1452 nand_chip.ecc.correct = nand_correct_data;
1453 }
1454#endif
1455
1456 if (nand_chip.select_chip)
1457 nand_chip.select_chip(&mtd, 0);
1458}
1459
1460void nand_deselect(void)
1461{
1462 if (nand_chip.select_chip)
1463 nand_chip.select_chip(&mtd, -1);
1464}
1465
1466#else
1467
Wu, Joshfe2185e2012-08-23 00:05:34 +00001468#ifndef CONFIG_SYS_NAND_BASE_LIST
1469#define CONFIG_SYS_NAND_BASE_LIST { CONFIG_SYS_NAND_BASE }
Nikolay Petukhov7c27b7b2010-03-19 10:49:27 +05001470#endif
Wu, Joshfe2185e2012-08-23 00:05:34 +00001471static struct nand_chip nand_chip[CONFIG_SYS_MAX_NAND_DEVICE];
1472static ulong base_addr[CONFIG_SYS_MAX_NAND_DEVICE] = CONFIG_SYS_NAND_BASE_LIST;
1473
1474int atmel_nand_chip_init(int devnum, ulong base_addr)
1475{
1476 int ret;
1477 struct mtd_info *mtd = &nand_info[devnum];
1478 struct nand_chip *nand = &nand_chip[devnum];
1479
1480 mtd->priv = nand;
1481 nand->IO_ADDR_R = nand->IO_ADDR_W = (void __iomem *)base_addr;
Nikolay Petukhov7c27b7b2010-03-19 10:49:27 +05001482
Bo Shen7604a3f2013-08-28 14:54:26 +00001483#ifdef CONFIG_NAND_ECC_BCH
1484 nand->ecc.mode = NAND_ECC_SOFT_BCH;
1485#else
Sergey Lapin10794322008-10-31 12:28:43 +01001486 nand->ecc.mode = NAND_ECC_SOFT;
Bo Shen7604a3f2013-08-28 14:54:26 +00001487#endif
Sergey Lapin10794322008-10-31 12:28:43 +01001488#ifdef CONFIG_SYS_NAND_DBW_16
1489 nand->options = NAND_BUSWIDTH_16;
1490#endif
Jean-Christophe PLAGNIOL-VILLARD74c076d2009-03-22 10:22:34 +01001491 nand->cmd_ctrl = at91_nand_hwcontrol;
1492#ifdef CONFIG_SYS_NAND_READY_PIN
1493 nand->dev_ready = at91_nand_ready;
1494#endif
Wu, Josh16dddef2013-10-18 17:46:31 +08001495 nand->chip_delay = 75;
David Dueckda78fb52015-03-20 10:52:49 +01001496#ifdef CONFIG_SYS_NAND_USE_FLASH_BBT
1497 nand->bbt_options |= NAND_BBT_USE_FLASH;
1498#endif
Sergey Lapin10794322008-10-31 12:28:43 +01001499
Wu, Joshfe2185e2012-08-23 00:05:34 +00001500 ret = nand_scan_ident(mtd, CONFIG_SYS_NAND_MAX_CHIPS, NULL);
1501 if (ret)
1502 return ret;
Nikolay Petukhov7c27b7b2010-03-19 10:49:27 +05001503
1504#ifdef CONFIG_ATMEL_NAND_HWECC
Wu, Joshbdfd59a2012-08-23 00:05:36 +00001505#ifdef CONFIG_ATMEL_NAND_HW_PMECC
1506 ret = atmel_pmecc_nand_init_params(nand, mtd);
1507#else
Wu, Joshfe2185e2012-08-23 00:05:34 +00001508 ret = atmel_hwecc_nand_init_param(nand, mtd);
Wu, Joshbdfd59a2012-08-23 00:05:36 +00001509#endif
Wu, Joshfe2185e2012-08-23 00:05:34 +00001510 if (ret)
1511 return ret;
Nikolay Petukhov7c27b7b2010-03-19 10:49:27 +05001512#endif
1513
Wu, Joshfe2185e2012-08-23 00:05:34 +00001514 ret = nand_scan_tail(mtd);
1515 if (!ret)
1516 nand_register(devnum);
1517
1518 return ret;
1519}
1520
1521void board_nand_init(void)
1522{
1523 int i;
1524 for (i = 0; i < CONFIG_SYS_MAX_NAND_DEVICE; i++)
1525 if (atmel_nand_chip_init(i, base_addr[i]))
Wu, Joshc0dc3de2013-10-18 17:46:34 +08001526 dev_err(host->dev, "atmel_nand: Fail to initialize #%d chip",
Wu, Joshfe2185e2012-08-23 00:05:34 +00001527 i);
Sergey Lapin10794322008-10-31 12:28:43 +01001528}
Bo Shen0b0b4f52014-03-03 14:47:16 +08001529#endif /* CONFIG_SPL_BUILD */