1 /* Integrated Flash Controller NAND Machine Driver
3 * Copyright (c) 2012 Freescale Semiconductor, Inc
5 * Authors: Dipen Dudhat <Dipen.Dudhat@freescale.com>
7 * SPDX-License-Identifier: GPL-2.0+
14 #include <linux/mtd/mtd.h>
15 #include <linux/mtd/nand.h>
16 #include <linux/mtd/nand_ecc.h>
19 #include <asm/errno.h>
22 #ifndef CONFIG_SYS_FSL_IFC_BANK_COUNT
23 #define CONFIG_SYS_FSL_IFC_BANK_COUNT 4
26 #define MAX_BANKS CONFIG_SYS_FSL_IFC_BANK_COUNT
27 #define ERR_BYTE 0xFF /* Value returned for read bytes
32 /* mtd information per set */
34 struct nand_chip chip;
35 struct fsl_ifc_ctrl *ctrl;
38 int bank; /* Chip select bank number */
39 unsigned int bufnum_mask; /* bufnum = page & bufnum_mask */
40 u8 __iomem *vbase; /* Chip select base virtual address */
43 /* overview of the fsl ifc controller */
45 struct nand_hw_control controller;
46 struct fsl_ifc_mtd *chips[MAX_BANKS];
50 void __iomem *addr; /* Address of assigned IFC buffer */
51 unsigned int cs_nand; /* On which chipsel NAND is connected */
52 unsigned int page; /* Last page written to / read from */
53 unsigned int read_bytes; /* Number of bytes read during command */
54 unsigned int column; /* Saved column from SEQIN */
55 unsigned int index; /* Pointer to next byte to 'read' */
56 unsigned int status; /* status read from NEESR after last op */
57 unsigned int oob; /* Non zero if operating on OOB data */
58 unsigned int eccread; /* Non zero for a full-page ECC read */
61 static struct fsl_ifc_ctrl *ifc_ctrl;
63 /* 512-byte page with 4-bit ECC, 8-bit */
64 static struct nand_ecclayout oob_512_8bit_ecc4 = {
66 .eccpos = {8, 9, 10, 11, 12, 13, 14, 15},
67 .oobfree = { {0, 5}, {6, 2} },
70 /* 512-byte page with 4-bit ECC, 16-bit */
71 static struct nand_ecclayout oob_512_16bit_ecc4 = {
73 .eccpos = {8, 9, 10, 11, 12, 13, 14, 15},
74 .oobfree = { {2, 6}, },
77 /* 2048-byte page size with 4-bit ECC */
78 static struct nand_ecclayout oob_2048_ecc4 = {
81 8, 9, 10, 11, 12, 13, 14, 15,
82 16, 17, 18, 19, 20, 21, 22, 23,
83 24, 25, 26, 27, 28, 29, 30, 31,
84 32, 33, 34, 35, 36, 37, 38, 39,
86 .oobfree = { {2, 6}, {40, 24} },
89 /* 4096-byte page size with 4-bit ECC */
90 static struct nand_ecclayout oob_4096_ecc4 = {
93 8, 9, 10, 11, 12, 13, 14, 15,
94 16, 17, 18, 19, 20, 21, 22, 23,
95 24, 25, 26, 27, 28, 29, 30, 31,
96 32, 33, 34, 35, 36, 37, 38, 39,
97 40, 41, 42, 43, 44, 45, 46, 47,
98 48, 49, 50, 51, 52, 53, 54, 55,
99 56, 57, 58, 59, 60, 61, 62, 63,
100 64, 65, 66, 67, 68, 69, 70, 71,
102 .oobfree = { {2, 6}, {72, 56} },
105 /* 4096-byte page size with 8-bit ECC -- requires 218-byte OOB */
106 static struct nand_ecclayout oob_4096_ecc8 = {
109 8, 9, 10, 11, 12, 13, 14, 15,
110 16, 17, 18, 19, 20, 21, 22, 23,
111 24, 25, 26, 27, 28, 29, 30, 31,
112 32, 33, 34, 35, 36, 37, 38, 39,
113 40, 41, 42, 43, 44, 45, 46, 47,
114 48, 49, 50, 51, 52, 53, 54, 55,
115 56, 57, 58, 59, 60, 61, 62, 63,
116 64, 65, 66, 67, 68, 69, 70, 71,
117 72, 73, 74, 75, 76, 77, 78, 79,
118 80, 81, 82, 83, 84, 85, 86, 87,
119 88, 89, 90, 91, 92, 93, 94, 95,
120 96, 97, 98, 99, 100, 101, 102, 103,
121 104, 105, 106, 107, 108, 109, 110, 111,
122 112, 113, 114, 115, 116, 117, 118, 119,
123 120, 121, 122, 123, 124, 125, 126, 127,
124 128, 129, 130, 131, 132, 133, 134, 135,
126 .oobfree = { {2, 6}, {136, 82} },
129 /* 8192-byte page size with 4-bit ECC */
130 static struct nand_ecclayout oob_8192_ecc4 = {
133 8, 9, 10, 11, 12, 13, 14, 15,
134 16, 17, 18, 19, 20, 21, 22, 23,
135 24, 25, 26, 27, 28, 29, 30, 31,
136 32, 33, 34, 35, 36, 37, 38, 39,
137 40, 41, 42, 43, 44, 45, 46, 47,
138 48, 49, 50, 51, 52, 53, 54, 55,
139 56, 57, 58, 59, 60, 61, 62, 63,
140 64, 65, 66, 67, 68, 69, 70, 71,
141 72, 73, 74, 75, 76, 77, 78, 79,
142 80, 81, 82, 83, 84, 85, 86, 87,
143 88, 89, 90, 91, 92, 93, 94, 95,
144 96, 97, 98, 99, 100, 101, 102, 103,
145 104, 105, 106, 107, 108, 109, 110, 111,
146 112, 113, 114, 115, 116, 117, 118, 119,
147 120, 121, 122, 123, 124, 125, 126, 127,
148 128, 129, 130, 131, 132, 133, 134, 135,
150 .oobfree = { {2, 6}, {136, 208} },
153 /* 8192-byte page size with 8-bit ECC -- requires 218-byte OOB */
154 static struct nand_ecclayout oob_8192_ecc8 = {
157 8, 9, 10, 11, 12, 13, 14, 15,
158 16, 17, 18, 19, 20, 21, 22, 23,
159 24, 25, 26, 27, 28, 29, 30, 31,
160 32, 33, 34, 35, 36, 37, 38, 39,
161 40, 41, 42, 43, 44, 45, 46, 47,
162 48, 49, 50, 51, 52, 53, 54, 55,
163 56, 57, 58, 59, 60, 61, 62, 63,
164 64, 65, 66, 67, 68, 69, 70, 71,
165 72, 73, 74, 75, 76, 77, 78, 79,
166 80, 81, 82, 83, 84, 85, 86, 87,
167 88, 89, 90, 91, 92, 93, 94, 95,
168 96, 97, 98, 99, 100, 101, 102, 103,
169 104, 105, 106, 107, 108, 109, 110, 111,
170 112, 113, 114, 115, 116, 117, 118, 119,
171 120, 121, 122, 123, 124, 125, 126, 127,
172 128, 129, 130, 131, 132, 133, 134, 135,
173 136, 137, 138, 139, 140, 141, 142, 143,
174 144, 145, 146, 147, 148, 149, 150, 151,
175 152, 153, 154, 155, 156, 157, 158, 159,
176 160, 161, 162, 163, 164, 165, 166, 167,
177 168, 169, 170, 171, 172, 173, 174, 175,
178 176, 177, 178, 179, 180, 181, 182, 183,
179 184, 185, 186, 187, 188, 189, 190, 191,
180 192, 193, 194, 195, 196, 197, 198, 199,
181 200, 201, 202, 203, 204, 205, 206, 207,
182 208, 209, 210, 211, 212, 213, 214, 215,
183 216, 217, 218, 219, 220, 221, 222, 223,
184 224, 225, 226, 227, 228, 229, 230, 231,
185 232, 233, 234, 235, 236, 237, 238, 239,
186 240, 241, 242, 243, 244, 245, 246, 247,
187 248, 249, 250, 251, 252, 253, 254, 255,
188 256, 257, 258, 259, 260, 261, 262, 263,
190 .oobfree = { {2, 6}, {264, 80} },
194 * Generic flash bbt descriptors
196 static u8 bbt_pattern[] = {'B', 'b', 't', '0' };
197 static u8 mirror_pattern[] = {'1', 't', 'b', 'B' };
199 static struct nand_bbt_descr bbt_main_descr = {
200 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE |
201 NAND_BBT_2BIT | NAND_BBT_VERSION,
202 .offs = 2, /* 0 on 8-bit small page */
206 .pattern = bbt_pattern,
209 static struct nand_bbt_descr bbt_mirror_descr = {
210 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE |
211 NAND_BBT_2BIT | NAND_BBT_VERSION,
212 .offs = 2, /* 0 on 8-bit small page */
216 .pattern = mirror_pattern,
220 * Set up the IFC hardware block and page address fields, and the ifc nand
221 * structure addr field to point to the correct IFC buffer in memory
223 static void set_addr(struct mtd_info *mtd, int column, int page_addr, int oob)
225 struct nand_chip *chip = mtd_to_nand(mtd);
226 struct fsl_ifc_mtd *priv = nand_get_controller_data(chip);
227 struct fsl_ifc_ctrl *ctrl = priv->ctrl;
228 struct fsl_ifc_runtime *ifc = ctrl->regs.rregs;
231 ctrl->page = page_addr;
233 /* Program ROW0/COL0 */
234 ifc_out32(&ifc->ifc_nand.row0, page_addr);
235 ifc_out32(&ifc->ifc_nand.col0, (oob ? IFC_NAND_COL_MS : 0) | column);
237 buf_num = page_addr & priv->bufnum_mask;
239 ctrl->addr = priv->vbase + buf_num * (mtd->writesize * 2);
240 ctrl->index = column;
242 /* for OOB data point to the second half of the buffer */
244 ctrl->index += mtd->writesize;
247 static int is_blank(struct mtd_info *mtd, struct fsl_ifc_ctrl *ctrl,
250 struct nand_chip *chip = mtd_to_nand(mtd);
251 struct fsl_ifc_mtd *priv = nand_get_controller_data(chip);
252 u8 __iomem *addr = priv->vbase + bufnum * (mtd->writesize * 2);
253 u32 __iomem *main = (u32 *)addr;
254 u8 __iomem *oob = addr + mtd->writesize;
257 for (i = 0; i < mtd->writesize / 4; i++) {
258 if (__raw_readl(&main[i]) != 0xffffffff)
262 for (i = 0; i < chip->ecc.layout->eccbytes; i++) {
263 int pos = chip->ecc.layout->eccpos[i];
265 if (__raw_readb(&oob[pos]) != 0xff)
272 /* returns nonzero if entire page is blank */
273 static int check_read_ecc(struct mtd_info *mtd, struct fsl_ifc_ctrl *ctrl,
274 u32 *eccstat, unsigned int bufnum)
276 u32 reg = eccstat[bufnum / 4];
279 errors = (reg >> ((3 - bufnum % 4) * 8)) & 15;
285 * execute IFC NAND command and wait for it to complete
287 static int fsl_ifc_run_command(struct mtd_info *mtd)
289 struct nand_chip *chip = mtd_to_nand(mtd);
290 struct fsl_ifc_mtd *priv = nand_get_controller_data(chip);
291 struct fsl_ifc_ctrl *ctrl = priv->ctrl;
292 struct fsl_ifc_runtime *ifc = ctrl->regs.rregs;
293 u32 timeo = (CONFIG_SYS_HZ * 10) / 1000;
295 u32 eccstat[8] = {0};
298 /* set the chip select for NAND Transaction */
299 ifc_out32(&ifc->ifc_nand.nand_csel, ifc_ctrl->cs_nand);
301 /* start read/write seq */
302 ifc_out32(&ifc->ifc_nand.nandseq_strt,
303 IFC_NAND_SEQ_STRT_FIR_STRT);
305 /* wait for NAND Machine complete flag or timeout */
306 time_start = get_timer(0);
308 while (get_timer(time_start) < timeo) {
309 ctrl->status = ifc_in32(&ifc->ifc_nand.nand_evter_stat);
311 if (ctrl->status & IFC_NAND_EVTER_STAT_OPC)
315 ifc_out32(&ifc->ifc_nand.nand_evter_stat, ctrl->status);
317 if (ctrl->status & IFC_NAND_EVTER_STAT_FTOER)
318 printf("%s: Flash Time Out Error\n", __func__);
319 if (ctrl->status & IFC_NAND_EVTER_STAT_WPER)
320 printf("%s: Write Protect Error\n", __func__);
324 int bufnum = ctrl->page & priv->bufnum_mask;
325 int sector = bufnum * chip->ecc.steps;
326 int sector_end = sector + chip->ecc.steps - 1;
328 for (i = sector / 4; i <= sector_end / 4; i++) {
329 if (i >= ARRAY_SIZE(eccstat)) {
330 printf("%s: eccstat too small for %d\n",
335 eccstat[i] = ifc_in32(&ifc->ifc_nand.nand_eccstat[i]);
338 for (i = sector; i <= sector_end; i++) {
339 errors = check_read_ecc(mtd, ctrl, eccstat, i);
343 * Uncorrectable error.
344 * OK only if the whole page is blank.
346 * We disable ECCER reporting due to erratum
347 * IFC-A002770 -- so report it now if we
348 * see an uncorrectable error in ECCSTAT.
350 if (!is_blank(mtd, ctrl, bufnum))
352 IFC_NAND_EVTER_STAT_ECCER;
356 mtd->ecc_stats.corrected += errors;
362 /* returns 0 on success otherwise non-zero) */
363 return ctrl->status == IFC_NAND_EVTER_STAT_OPC ? 0 : -EIO;
366 static void fsl_ifc_do_read(struct nand_chip *chip,
368 struct mtd_info *mtd)
370 struct fsl_ifc_mtd *priv = nand_get_controller_data(chip);
371 struct fsl_ifc_ctrl *ctrl = priv->ctrl;
372 struct fsl_ifc_runtime *ifc = ctrl->regs.rregs;
374 /* Program FIR/IFC_NAND_FCR0 for Small/Large page */
375 if (mtd->writesize > 512) {
376 ifc_out32(&ifc->ifc_nand.nand_fir0,
377 (IFC_FIR_OP_CW0 << IFC_NAND_FIR0_OP0_SHIFT) |
378 (IFC_FIR_OP_CA0 << IFC_NAND_FIR0_OP1_SHIFT) |
379 (IFC_FIR_OP_RA0 << IFC_NAND_FIR0_OP2_SHIFT) |
380 (IFC_FIR_OP_CMD1 << IFC_NAND_FIR0_OP3_SHIFT) |
381 (IFC_FIR_OP_RBCD << IFC_NAND_FIR0_OP4_SHIFT));
382 ifc_out32(&ifc->ifc_nand.nand_fir1, 0x0);
384 ifc_out32(&ifc->ifc_nand.nand_fcr0,
385 (NAND_CMD_READ0 << IFC_NAND_FCR0_CMD0_SHIFT) |
386 (NAND_CMD_READSTART << IFC_NAND_FCR0_CMD1_SHIFT));
388 ifc_out32(&ifc->ifc_nand.nand_fir0,
389 (IFC_FIR_OP_CW0 << IFC_NAND_FIR0_OP0_SHIFT) |
390 (IFC_FIR_OP_CA0 << IFC_NAND_FIR0_OP1_SHIFT) |
391 (IFC_FIR_OP_RA0 << IFC_NAND_FIR0_OP2_SHIFT) |
392 (IFC_FIR_OP_RBCD << IFC_NAND_FIR0_OP3_SHIFT));
395 ifc_out32(&ifc->ifc_nand.nand_fcr0,
396 NAND_CMD_READOOB << IFC_NAND_FCR0_CMD0_SHIFT);
398 ifc_out32(&ifc->ifc_nand.nand_fcr0,
399 NAND_CMD_READ0 << IFC_NAND_FCR0_CMD0_SHIFT);
403 /* cmdfunc send commands to the IFC NAND Machine */
404 static void fsl_ifc_cmdfunc(struct mtd_info *mtd, unsigned int command,
405 int column, int page_addr)
407 struct nand_chip *chip = mtd_to_nand(mtd);
408 struct fsl_ifc_mtd *priv = nand_get_controller_data(chip);
409 struct fsl_ifc_ctrl *ctrl = priv->ctrl;
410 struct fsl_ifc_runtime *ifc = ctrl->regs.rregs;
412 /* clear the read buffer */
413 ctrl->read_bytes = 0;
414 if (command != NAND_CMD_PAGEPROG)
418 /* READ0 read the entire buffer to use hardware ECC. */
419 case NAND_CMD_READ0: {
420 ifc_out32(&ifc->ifc_nand.nand_fbcr, 0);
421 set_addr(mtd, 0, page_addr, 0);
423 ctrl->read_bytes = mtd->writesize + mtd->oobsize;
424 ctrl->index += column;
426 if (chip->ecc.mode == NAND_ECC_HW)
429 fsl_ifc_do_read(chip, 0, mtd);
430 fsl_ifc_run_command(mtd);
434 /* READOOB reads only the OOB because no ECC is performed. */
435 case NAND_CMD_READOOB:
436 ifc_out32(&ifc->ifc_nand.nand_fbcr, mtd->oobsize - column);
437 set_addr(mtd, column, page_addr, 1);
439 ctrl->read_bytes = mtd->writesize + mtd->oobsize;
441 fsl_ifc_do_read(chip, 1, mtd);
442 fsl_ifc_run_command(mtd);
446 /* READID must read all possible bytes while CEB is active */
447 case NAND_CMD_READID:
448 case NAND_CMD_PARAM: {
449 int timing = IFC_FIR_OP_RB;
450 if (command == NAND_CMD_PARAM)
451 timing = IFC_FIR_OP_RBCD;
453 ifc_out32(&ifc->ifc_nand.nand_fir0,
454 (IFC_FIR_OP_CW0 << IFC_NAND_FIR0_OP0_SHIFT) |
455 (IFC_FIR_OP_UA << IFC_NAND_FIR0_OP1_SHIFT) |
456 (timing << IFC_NAND_FIR0_OP2_SHIFT));
457 ifc_out32(&ifc->ifc_nand.nand_fcr0,
458 command << IFC_NAND_FCR0_CMD0_SHIFT);
459 ifc_out32(&ifc->ifc_nand.row3, column);
462 * although currently it's 8 bytes for READID, we always read
463 * the maximum 256 bytes(for PARAM)
465 ifc_out32(&ifc->ifc_nand.nand_fbcr, 256);
466 ctrl->read_bytes = 256;
468 set_addr(mtd, 0, 0, 0);
469 fsl_ifc_run_command(mtd);
473 /* ERASE1 stores the block and page address */
474 case NAND_CMD_ERASE1:
475 set_addr(mtd, 0, page_addr, 0);
478 /* ERASE2 uses the block and page address from ERASE1 */
479 case NAND_CMD_ERASE2:
480 ifc_out32(&ifc->ifc_nand.nand_fir0,
481 (IFC_FIR_OP_CW0 << IFC_NAND_FIR0_OP0_SHIFT) |
482 (IFC_FIR_OP_RA0 << IFC_NAND_FIR0_OP1_SHIFT) |
483 (IFC_FIR_OP_CMD1 << IFC_NAND_FIR0_OP2_SHIFT));
485 ifc_out32(&ifc->ifc_nand.nand_fcr0,
486 (NAND_CMD_ERASE1 << IFC_NAND_FCR0_CMD0_SHIFT) |
487 (NAND_CMD_ERASE2 << IFC_NAND_FCR0_CMD1_SHIFT));
489 ifc_out32(&ifc->ifc_nand.nand_fbcr, 0);
490 ctrl->read_bytes = 0;
491 fsl_ifc_run_command(mtd);
494 /* SEQIN sets up the addr buffer and all registers except the length */
495 case NAND_CMD_SEQIN: {
497 ctrl->column = column;
500 if (mtd->writesize > 512) {
502 (NAND_CMD_SEQIN << IFC_NAND_FCR0_CMD0_SHIFT) |
503 (NAND_CMD_STATUS << IFC_NAND_FCR0_CMD1_SHIFT) |
504 (NAND_CMD_PAGEPROG << IFC_NAND_FCR0_CMD2_SHIFT);
506 ifc_out32(&ifc->ifc_nand.nand_fir0,
507 (IFC_FIR_OP_CW0 << IFC_NAND_FIR0_OP0_SHIFT) |
508 (IFC_FIR_OP_CA0 << IFC_NAND_FIR0_OP1_SHIFT) |
509 (IFC_FIR_OP_RA0 << IFC_NAND_FIR0_OP2_SHIFT) |
511 IFC_NAND_FIR0_OP3_SHIFT) |
512 (IFC_FIR_OP_CMD2 << IFC_NAND_FIR0_OP4_SHIFT));
513 ifc_out32(&ifc->ifc_nand.nand_fir1,
514 (IFC_FIR_OP_CW1 << IFC_NAND_FIR1_OP5_SHIFT) |
515 (IFC_FIR_OP_RDSTAT <<
516 IFC_NAND_FIR1_OP6_SHIFT) |
517 (IFC_FIR_OP_NOP << IFC_NAND_FIR1_OP7_SHIFT));
519 nand_fcr0 = ((NAND_CMD_PAGEPROG <<
520 IFC_NAND_FCR0_CMD1_SHIFT) |
522 IFC_NAND_FCR0_CMD2_SHIFT) |
524 IFC_NAND_FCR0_CMD3_SHIFT));
526 ifc_out32(&ifc->ifc_nand.nand_fir0,
527 (IFC_FIR_OP_CW0 << IFC_NAND_FIR0_OP0_SHIFT) |
528 (IFC_FIR_OP_CMD2 << IFC_NAND_FIR0_OP1_SHIFT) |
529 (IFC_FIR_OP_CA0 << IFC_NAND_FIR0_OP2_SHIFT) |
530 (IFC_FIR_OP_RA0 << IFC_NAND_FIR0_OP3_SHIFT) |
531 (IFC_FIR_OP_WBCD << IFC_NAND_FIR0_OP4_SHIFT));
532 ifc_out32(&ifc->ifc_nand.nand_fir1,
533 (IFC_FIR_OP_CMD1 << IFC_NAND_FIR1_OP5_SHIFT) |
534 (IFC_FIR_OP_CW3 << IFC_NAND_FIR1_OP6_SHIFT) |
535 (IFC_FIR_OP_RDSTAT <<
536 IFC_NAND_FIR1_OP7_SHIFT) |
537 (IFC_FIR_OP_NOP << IFC_NAND_FIR1_OP8_SHIFT));
539 if (column >= mtd->writesize)
541 NAND_CMD_READOOB << IFC_NAND_FCR0_CMD0_SHIFT;
544 NAND_CMD_READ0 << IFC_NAND_FCR0_CMD0_SHIFT;
547 if (column >= mtd->writesize) {
548 /* OOB area --> READOOB */
549 column -= mtd->writesize;
552 ifc_out32(&ifc->ifc_nand.nand_fcr0, nand_fcr0);
553 set_addr(mtd, column, page_addr, ctrl->oob);
557 /* PAGEPROG reuses all of the setup from SEQIN and adds the length */
558 case NAND_CMD_PAGEPROG:
560 ifc_out32(&ifc->ifc_nand.nand_fbcr,
561 ctrl->index - ctrl->column);
563 ifc_out32(&ifc->ifc_nand.nand_fbcr, 0);
565 fsl_ifc_run_command(mtd);
568 case NAND_CMD_STATUS:
569 ifc_out32(&ifc->ifc_nand.nand_fir0,
570 (IFC_FIR_OP_CW0 << IFC_NAND_FIR0_OP0_SHIFT) |
571 (IFC_FIR_OP_RB << IFC_NAND_FIR0_OP1_SHIFT));
572 ifc_out32(&ifc->ifc_nand.nand_fcr0,
573 NAND_CMD_STATUS << IFC_NAND_FCR0_CMD0_SHIFT);
574 ifc_out32(&ifc->ifc_nand.nand_fbcr, 1);
575 set_addr(mtd, 0, 0, 0);
576 ctrl->read_bytes = 1;
578 fsl_ifc_run_command(mtd);
581 * The chip always seems to report that it is
582 * write-protected, even when it is not.
584 if (chip->options & NAND_BUSWIDTH_16)
585 ifc_out16(ctrl->addr,
586 ifc_in16(ctrl->addr) | NAND_STATUS_WP);
588 out_8(ctrl->addr, in_8(ctrl->addr) | NAND_STATUS_WP);
592 ifc_out32(&ifc->ifc_nand.nand_fir0,
593 IFC_FIR_OP_CW0 << IFC_NAND_FIR0_OP0_SHIFT);
594 ifc_out32(&ifc->ifc_nand.nand_fcr0,
595 NAND_CMD_RESET << IFC_NAND_FCR0_CMD0_SHIFT);
596 fsl_ifc_run_command(mtd);
600 printf("%s: error, unsupported command 0x%x.\n",
606 * Write buf to the IFC NAND Controller Data Buffer
608 static void fsl_ifc_write_buf(struct mtd_info *mtd, const u8 *buf, int len)
610 struct nand_chip *chip = mtd_to_nand(mtd);
611 struct fsl_ifc_mtd *priv = nand_get_controller_data(chip);
612 struct fsl_ifc_ctrl *ctrl = priv->ctrl;
613 unsigned int bufsize = mtd->writesize + mtd->oobsize;
616 printf("%s of %d bytes", __func__, len);
621 if ((unsigned int)len > bufsize - ctrl->index) {
622 printf("%s beyond end of buffer "
623 "(%d requested, %u available)\n",
624 __func__, len, bufsize - ctrl->index);
625 len = bufsize - ctrl->index;
628 memcpy_toio(ctrl->addr + ctrl->index, buf, len);
633 * read a byte from either the IFC hardware buffer if it has any data left
634 * otherwise issue a command to read a single byte.
636 static u8 fsl_ifc_read_byte(struct mtd_info *mtd)
638 struct nand_chip *chip = mtd_to_nand(mtd);
639 struct fsl_ifc_mtd *priv = nand_get_controller_data(chip);
640 struct fsl_ifc_ctrl *ctrl = priv->ctrl;
644 * If there are still bytes in the IFC buffer, then use the
647 if (ctrl->index < ctrl->read_bytes) {
648 offset = ctrl->index++;
649 return in_8(ctrl->addr + offset);
652 printf("%s beyond end of buffer\n", __func__);
657 * Read two bytes from the IFC hardware buffer
658 * read function for 16-bit buswith
660 static uint8_t fsl_ifc_read_byte16(struct mtd_info *mtd)
662 struct nand_chip *chip = mtd_to_nand(mtd);
663 struct fsl_ifc_mtd *priv = nand_get_controller_data(chip);
664 struct fsl_ifc_ctrl *ctrl = priv->ctrl;
668 * If there are still bytes in the IFC buffer, then use the
671 if (ctrl->index < ctrl->read_bytes) {
672 data = ifc_in16(ctrl->addr + ctrl->index);
674 return (uint8_t)data;
677 printf("%s beyond end of buffer\n", __func__);
682 * Read from the IFC Controller Data Buffer
684 static void fsl_ifc_read_buf(struct mtd_info *mtd, u8 *buf, int len)
686 struct nand_chip *chip = mtd_to_nand(mtd);
687 struct fsl_ifc_mtd *priv = nand_get_controller_data(chip);
688 struct fsl_ifc_ctrl *ctrl = priv->ctrl;
694 avail = min((unsigned int)len, ctrl->read_bytes - ctrl->index);
695 memcpy_fromio(buf, ctrl->addr + ctrl->index, avail);
696 ctrl->index += avail;
699 printf("%s beyond end of buffer "
700 "(%d requested, %d available)\n",
701 __func__, len, avail);
704 /* This function is called after Program and Erase Operations to
705 * check for success or failure.
707 static int fsl_ifc_wait(struct mtd_info *mtd, struct nand_chip *chip)
709 struct fsl_ifc_mtd *priv = nand_get_controller_data(chip);
710 struct fsl_ifc_ctrl *ctrl = priv->ctrl;
711 struct fsl_ifc_runtime *ifc = ctrl->regs.rregs;
714 if (ctrl->status != IFC_NAND_EVTER_STAT_OPC)
715 return NAND_STATUS_FAIL;
717 /* Use READ_STATUS command, but wait for the device to be ready */
718 ifc_out32(&ifc->ifc_nand.nand_fir0,
719 (IFC_FIR_OP_CW0 << IFC_NAND_FIR0_OP0_SHIFT) |
720 (IFC_FIR_OP_RDSTAT << IFC_NAND_FIR0_OP1_SHIFT));
721 ifc_out32(&ifc->ifc_nand.nand_fcr0, NAND_CMD_STATUS <<
722 IFC_NAND_FCR0_CMD0_SHIFT);
723 ifc_out32(&ifc->ifc_nand.nand_fbcr, 1);
724 set_addr(mtd, 0, 0, 0);
725 ctrl->read_bytes = 1;
727 fsl_ifc_run_command(mtd);
729 if (ctrl->status != IFC_NAND_EVTER_STAT_OPC)
730 return NAND_STATUS_FAIL;
732 nand_fsr = ifc_in32(&ifc->ifc_nand.nand_fsr);
734 /* Chip sometimes reporting write protect even when it's not */
735 nand_fsr = nand_fsr | NAND_STATUS_WP;
739 static int fsl_ifc_read_page(struct mtd_info *mtd, struct nand_chip *chip,
740 uint8_t *buf, int oob_required, int page)
742 struct fsl_ifc_mtd *priv = nand_get_controller_data(chip);
743 struct fsl_ifc_ctrl *ctrl = priv->ctrl;
745 fsl_ifc_read_buf(mtd, buf, mtd->writesize);
746 fsl_ifc_read_buf(mtd, chip->oob_poi, mtd->oobsize);
748 if (ctrl->status != IFC_NAND_EVTER_STAT_OPC)
749 mtd->ecc_stats.failed++;
754 /* ECC will be calculated automatically, and errors will be detected in
757 static int fsl_ifc_write_page(struct mtd_info *mtd, struct nand_chip *chip,
758 const uint8_t *buf, int oob_required)
760 fsl_ifc_write_buf(mtd, buf, mtd->writesize);
761 fsl_ifc_write_buf(mtd, chip->oob_poi, mtd->oobsize);
766 static void fsl_ifc_ctrl_init(void)
769 ifc_ctrl = kzalloc(sizeof(*ifc_ctrl), GFP_KERNEL);
773 ifc_ctrl->regs.gregs = IFC_FCM_BASE_ADDR;
775 ver = ifc_in32(&ifc_ctrl->regs.gregs->ifc_rev);
776 if (ver >= FSL_IFC_V2_0_0)
777 ifc_ctrl->regs.rregs =
778 (void *)CONFIG_SYS_IFC_ADDR + IFC_RREGS_64KOFFSET;
780 ifc_ctrl->regs.rregs =
781 (void *)CONFIG_SYS_IFC_ADDR + IFC_RREGS_4KOFFSET;
783 /* clear event registers */
784 ifc_out32(&ifc_ctrl->regs.rregs->ifc_nand.nand_evter_stat, ~0U);
785 ifc_out32(&ifc_ctrl->regs.rregs->ifc_nand.pgrdcmpl_evt_stat, ~0U);
787 /* Enable error and event for any detected errors */
788 ifc_out32(&ifc_ctrl->regs.rregs->ifc_nand.nand_evter_en,
789 IFC_NAND_EVTER_EN_OPC_EN |
790 IFC_NAND_EVTER_EN_PGRDCMPL_EN |
791 IFC_NAND_EVTER_EN_FTOER_EN |
792 IFC_NAND_EVTER_EN_WPER_EN);
794 ifc_out32(&ifc_ctrl->regs.rregs->ifc_nand.ncfgr, 0x0);
797 static void fsl_ifc_select_chip(struct mtd_info *mtd, int chip)
801 static int fsl_ifc_sram_init(uint32_t ver)
803 struct fsl_ifc_runtime *ifc = ifc_ctrl->regs.rregs;
804 uint32_t cs = 0, csor = 0, csor_8k = 0, csor_ext = 0;
806 u32 timeo = (CONFIG_SYS_HZ * 10) / 1000;
809 if (ver > FSL_IFC_V1_1_0) {
810 ncfgr = ifc_in32(&ifc->ifc_nand.ncfgr);
811 ifc_out32(&ifc->ifc_nand.ncfgr, ncfgr | IFC_NAND_SRAM_INIT_EN);
813 /* wait for SRAM_INIT bit to be clear or timeout */
814 time_start = get_timer(0);
815 while (get_timer(time_start) < timeo) {
817 ifc_in32(&ifc->ifc_nand.nand_evter_stat);
819 if (!(ifc_ctrl->status & IFC_NAND_SRAM_INIT_EN))
822 printf("fsl-ifc: Failed to Initialise SRAM\n");
826 cs = ifc_ctrl->cs_nand >> IFC_NAND_CSEL_SHIFT;
828 /* Save CSOR and CSOR_ext */
829 csor = ifc_in32(&ifc_ctrl->regs.gregs->csor_cs[cs].csor);
830 csor_ext = ifc_in32(&ifc_ctrl->regs.gregs->csor_cs[cs].csor_ext);
832 /* chage PageSize 8K and SpareSize 1K*/
833 csor_8k = (csor & ~(CSOR_NAND_PGS_MASK)) | 0x0018C000;
834 ifc_out32(&ifc_ctrl->regs.gregs->csor_cs[cs].csor, csor_8k);
835 ifc_out32(&ifc_ctrl->regs.gregs->csor_cs[cs].csor_ext, 0x0000400);
838 ifc_out32(&ifc->ifc_nand.nand_fir0,
839 (IFC_FIR_OP_CW0 << IFC_NAND_FIR0_OP0_SHIFT) |
840 (IFC_FIR_OP_UA << IFC_NAND_FIR0_OP1_SHIFT) |
841 (IFC_FIR_OP_RB << IFC_NAND_FIR0_OP2_SHIFT));
842 ifc_out32(&ifc->ifc_nand.nand_fcr0,
843 NAND_CMD_READID << IFC_NAND_FCR0_CMD0_SHIFT);
844 ifc_out32(&ifc->ifc_nand.row3, 0x0);
846 ifc_out32(&ifc->ifc_nand.nand_fbcr, 0x0);
848 /* Program ROW0/COL0 */
849 ifc_out32(&ifc->ifc_nand.row0, 0x0);
850 ifc_out32(&ifc->ifc_nand.col0, 0x0);
852 /* set the chip select for NAND Transaction */
853 ifc_out32(&ifc->ifc_nand.nand_csel, ifc_ctrl->cs_nand);
856 ifc_out32(&ifc->ifc_nand.nandseq_strt, IFC_NAND_SEQ_STRT_FIR_STRT);
858 time_start = get_timer(0);
860 while (get_timer(time_start) < timeo) {
861 ifc_ctrl->status = ifc_in32(&ifc->ifc_nand.nand_evter_stat);
863 if (ifc_ctrl->status & IFC_NAND_EVTER_STAT_OPC)
867 if (ifc_ctrl->status != IFC_NAND_EVTER_STAT_OPC) {
868 printf("fsl-ifc: Failed to Initialise SRAM\n");
872 ifc_out32(&ifc->ifc_nand.nand_evter_stat, ifc_ctrl->status);
874 /* Restore CSOR and CSOR_ext */
875 ifc_out32(&ifc_ctrl->regs.gregs->csor_cs[cs].csor, csor);
876 ifc_out32(&ifc_ctrl->regs.gregs->csor_cs[cs].csor_ext, csor_ext);
881 static int fsl_ifc_chip_init(int devnum, u8 *addr)
883 struct mtd_info *mtd;
884 struct nand_chip *nand;
885 struct fsl_ifc_mtd *priv;
886 struct nand_ecclayout *layout;
887 struct fsl_ifc_fcm *gregs = NULL;
888 uint32_t cspr = 0, csor = 0, ver = 0;
897 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
901 priv->ctrl = ifc_ctrl;
903 gregs = ifc_ctrl->regs.gregs;
905 /* Find which chip select it is connected to.
907 for (priv->bank = 0; priv->bank < MAX_BANKS; priv->bank++) {
908 phys_addr_t phys_addr = virt_to_phys(addr);
910 cspr = ifc_in32(&gregs->cspr_cs[priv->bank].cspr);
911 csor = ifc_in32(&gregs->csor_cs[priv->bank].csor);
913 if ((cspr & CSPR_V) && (cspr & CSPR_MSEL) == CSPR_MSEL_NAND &&
914 (cspr & CSPR_BA) == CSPR_PHYS_ADDR(phys_addr)) {
915 ifc_ctrl->cs_nand = priv->bank << IFC_NAND_CSEL_SHIFT;
920 if (priv->bank >= MAX_BANKS) {
921 printf("%s: address did not match any "
922 "chip selects\n", __func__);
928 mtd = nand_to_mtd(nand);
930 ifc_ctrl->chips[priv->bank] = priv;
932 /* fill in nand_chip structure */
933 /* set up function call table */
935 nand->write_buf = fsl_ifc_write_buf;
936 nand->read_buf = fsl_ifc_read_buf;
937 nand->select_chip = fsl_ifc_select_chip;
938 nand->cmdfunc = fsl_ifc_cmdfunc;
939 nand->waitfunc = fsl_ifc_wait;
941 /* set up nand options */
942 nand->bbt_td = &bbt_main_descr;
943 nand->bbt_md = &bbt_mirror_descr;
945 /* set up nand options */
946 nand->options = NAND_NO_SUBPAGE_WRITE;
947 nand->bbt_options = NAND_BBT_USE_FLASH;
949 if (cspr & CSPR_PORT_SIZE_16) {
950 nand->read_byte = fsl_ifc_read_byte16;
951 nand->options |= NAND_BUSWIDTH_16;
953 nand->read_byte = fsl_ifc_read_byte;
956 nand->controller = &ifc_ctrl->controller;
957 nand_set_controller_data(nand, priv);
959 nand->ecc.read_page = fsl_ifc_read_page;
960 nand->ecc.write_page = fsl_ifc_write_page;
962 /* Hardware generates ECC per 512 Bytes */
963 nand->ecc.size = 512;
966 switch (csor & CSOR_NAND_PGS_MASK) {
967 case CSOR_NAND_PGS_512:
968 if (nand->options & NAND_BUSWIDTH_16) {
969 layout = &oob_512_16bit_ecc4;
971 layout = &oob_512_8bit_ecc4;
973 /* Avoid conflict with bad block marker */
974 bbt_main_descr.offs = 0;
975 bbt_mirror_descr.offs = 0;
978 nand->ecc.strength = 4;
979 priv->bufnum_mask = 15;
982 case CSOR_NAND_PGS_2K:
983 layout = &oob_2048_ecc4;
984 nand->ecc.strength = 4;
985 priv->bufnum_mask = 3;
988 case CSOR_NAND_PGS_4K:
989 if ((csor & CSOR_NAND_ECC_MODE_MASK) ==
990 CSOR_NAND_ECC_MODE_4) {
991 layout = &oob_4096_ecc4;
992 nand->ecc.strength = 4;
994 layout = &oob_4096_ecc8;
995 nand->ecc.strength = 8;
996 nand->ecc.bytes = 16;
999 priv->bufnum_mask = 1;
1002 case CSOR_NAND_PGS_8K:
1003 if ((csor & CSOR_NAND_ECC_MODE_MASK) ==
1004 CSOR_NAND_ECC_MODE_4) {
1005 layout = &oob_8192_ecc4;
1006 nand->ecc.strength = 4;
1008 layout = &oob_8192_ecc8;
1009 nand->ecc.strength = 8;
1010 nand->ecc.bytes = 16;
1013 priv->bufnum_mask = 0;
1018 printf("ifc nand: bad csor %#x: bad page size\n", csor);
1022 /* Must also set CSOR_NAND_ECC_ENC_EN if DEC_EN set */
1023 if (csor & CSOR_NAND_ECC_DEC_EN) {
1024 nand->ecc.mode = NAND_ECC_HW;
1025 nand->ecc.layout = layout;
1027 nand->ecc.mode = NAND_ECC_SOFT;
1030 ver = ifc_in32(&gregs->ifc_rev);
1031 if (ver >= FSL_IFC_V1_1_0)
1032 ret = fsl_ifc_sram_init(ver);
1036 if (ver >= FSL_IFC_V2_0_0)
1037 priv->bufnum_mask = (priv->bufnum_mask * 2) + 1;
1039 ret = nand_scan_ident(mtd, 1, NULL);
1043 ret = nand_scan_tail(mtd);
1047 ret = nand_register(devnum, mtd);
1053 #ifndef CONFIG_SYS_NAND_BASE_LIST
1054 #define CONFIG_SYS_NAND_BASE_LIST { CONFIG_SYS_NAND_BASE }
1057 static unsigned long base_address[CONFIG_SYS_MAX_NAND_DEVICE] =
1058 CONFIG_SYS_NAND_BASE_LIST;
1060 void board_nand_init(void)
1064 for (i = 0; i < CONFIG_SYS_MAX_NAND_DEVICE; i++)
1065 fsl_ifc_chip_init(i, (u8 *)base_address[i]);