1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* Freescale Enhanced Local Bus Controller NAND driver
4 * Copyright © 2006-2007, 2010 Freescale Semiconductor
6 * Authors: Nick Spence <nick.spence@freescale.com>,
7 * Scott Wood <scottwood@freescale.com>
8 * Jack Lan <jack.lan@freescale.com>
9 * Roy Zang <tie-fei.zang@freescale.com>
12 #include <linux/module.h>
13 #include <linux/types.h>
14 #include <linux/kernel.h>
15 #include <linux/string.h>
16 #include <linux/ioport.h>
17 #include <linux/of_address.h>
18 #include <linux/of_platform.h>
19 #include <linux/platform_device.h>
20 #include <linux/slab.h>
21 #include <linux/interrupt.h>
23 #include <linux/mtd/mtd.h>
24 #include <linux/mtd/rawnand.h>
25 #include <linux/mtd/nand_ecc.h>
26 #include <linux/mtd/partitions.h>
29 #include <asm/fsl_lbc.h>
32 #define ERR_BYTE 0xFF /* Value returned for read bytes when read failed */
33 #define FCM_TIMEOUT_MSECS 500 /* Maximum number of mSecs to wait for FCM */
35 /* mtd information per set */
38 struct nand_chip chip;
39 struct fsl_lbc_ctrl *ctrl;
42 int bank; /* Chip select bank number */
43 u8 __iomem *vbase; /* Chip select base virtual address */
44 int page_size; /* NAND page size (0=512, 1=2048) */
45 unsigned int fmr; /* FCM Flash Mode Register value */
48 /* Freescale eLBC FCM controller information */
50 struct fsl_elbc_fcm_ctrl {
51 struct nand_controller controller;
52 struct fsl_elbc_mtd *chips[MAX_BANKS];
54 u8 __iomem *addr; /* Address of assigned FCM buffer */
55 unsigned int page; /* Last page written to / read from */
56 unsigned int read_bytes; /* Number of bytes read during command */
57 unsigned int column; /* Saved column from SEQIN */
58 unsigned int index; /* Pointer to next byte to 'read' */
59 unsigned int status; /* status read from LTESR after last op */
60 unsigned int mdr; /* UPM/FCM Data Register value */
61 unsigned int use_mdr; /* Non zero if the MDR is to be set */
62 unsigned int oob; /* Non zero if operating on OOB data */
63 unsigned int counter; /* counter for the initializations */
64 unsigned int max_bitflips; /* Saved during READ0 cmd */
67 /* These map to the positions used by the FCM hardware ECC generator */
69 static int fsl_elbc_ooblayout_ecc(struct mtd_info *mtd, int section,
70 struct mtd_oob_region *oobregion)
72 struct nand_chip *chip = mtd_to_nand(mtd);
73 struct fsl_elbc_mtd *priv = nand_get_controller_data(chip);
75 if (section >= chip->ecc.steps)
78 oobregion->offset = (16 * section) + 6;
79 if (priv->fmr & FMR_ECCM)
80 oobregion->offset += 2;
82 oobregion->length = chip->ecc.bytes;
87 static int fsl_elbc_ooblayout_free(struct mtd_info *mtd, int section,
88 struct mtd_oob_region *oobregion)
90 struct nand_chip *chip = mtd_to_nand(mtd);
91 struct fsl_elbc_mtd *priv = nand_get_controller_data(chip);
93 if (section > chip->ecc.steps)
97 oobregion->offset = 0;
98 if (mtd->writesize > 512)
100 oobregion->length = (priv->fmr & FMR_ECCM) ? 7 : 5;
102 oobregion->offset = (16 * section) -
103 ((priv->fmr & FMR_ECCM) ? 5 : 7);
104 if (section < chip->ecc.steps)
105 oobregion->length = 13;
107 oobregion->length = mtd->oobsize - oobregion->offset;
113 static const struct mtd_ooblayout_ops fsl_elbc_ooblayout_ops = {
114 .ecc = fsl_elbc_ooblayout_ecc,
115 .free = fsl_elbc_ooblayout_free,
119 * ELBC may use HW ECC, so that OOB offsets, that NAND core uses for bbt,
120 * interfere with ECC positions, that's why we implement our own descriptors.
121 * OOB {11, 5}, works for both SP and LP chips, with ECCM = 1 and ECCM = 0.
123 static u8 bbt_pattern[] = {'B', 'b', 't', '0' };
124 static u8 mirror_pattern[] = {'1', 't', 'b', 'B' };
126 static struct nand_bbt_descr bbt_main_descr = {
127 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE |
128 NAND_BBT_2BIT | NAND_BBT_VERSION,
133 .pattern = bbt_pattern,
136 static struct nand_bbt_descr bbt_mirror_descr = {
137 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE |
138 NAND_BBT_2BIT | NAND_BBT_VERSION,
143 .pattern = mirror_pattern,
146 /*=================================*/
149 * Set up the FCM hardware block and page address fields, and the fcm
150 * structure addr field to point to the correct FCM buffer in memory
152 static void set_addr(struct mtd_info *mtd, int column, int page_addr, int oob)
154 struct nand_chip *chip = mtd_to_nand(mtd);
155 struct fsl_elbc_mtd *priv = nand_get_controller_data(chip);
156 struct fsl_lbc_ctrl *ctrl = priv->ctrl;
157 struct fsl_lbc_regs __iomem *lbc = ctrl->regs;
158 struct fsl_elbc_fcm_ctrl *elbc_fcm_ctrl = ctrl->nand;
161 elbc_fcm_ctrl->page = page_addr;
163 if (priv->page_size) {
165 * large page size chip : FPAR[PI] save the lowest 6 bits,
166 * FBAR[BLK] save the other bits.
168 out_be32(&lbc->fbar, page_addr >> 6);
170 ((page_addr << FPAR_LP_PI_SHIFT) & FPAR_LP_PI) |
171 (oob ? FPAR_LP_MS : 0) | column);
172 buf_num = (page_addr & 1) << 2;
175 * small page size chip : FPAR[PI] save the lowest 5 bits,
176 * FBAR[BLK] save the other bits.
178 out_be32(&lbc->fbar, page_addr >> 5);
180 ((page_addr << FPAR_SP_PI_SHIFT) & FPAR_SP_PI) |
181 (oob ? FPAR_SP_MS : 0) | column);
182 buf_num = page_addr & 7;
185 elbc_fcm_ctrl->addr = priv->vbase + buf_num * 1024;
186 elbc_fcm_ctrl->index = column;
188 /* for OOB data point to the second half of the buffer */
190 elbc_fcm_ctrl->index += priv->page_size ? 2048 : 512;
192 dev_vdbg(priv->dev, "set_addr: bank=%d, "
193 "elbc_fcm_ctrl->addr=0x%p (0x%p), "
194 "index %x, pes %d ps %d\n",
195 buf_num, elbc_fcm_ctrl->addr, priv->vbase,
196 elbc_fcm_ctrl->index,
197 chip->phys_erase_shift, chip->page_shift);
201 * execute FCM command and wait for it to complete
203 static int fsl_elbc_run_command(struct mtd_info *mtd)
205 struct nand_chip *chip = mtd_to_nand(mtd);
206 struct fsl_elbc_mtd *priv = nand_get_controller_data(chip);
207 struct fsl_lbc_ctrl *ctrl = priv->ctrl;
208 struct fsl_elbc_fcm_ctrl *elbc_fcm_ctrl = ctrl->nand;
209 struct fsl_lbc_regs __iomem *lbc = ctrl->regs;
211 /* Setup the FMR[OP] to execute without write protection */
212 out_be32(&lbc->fmr, priv->fmr | 3);
213 if (elbc_fcm_ctrl->use_mdr)
214 out_be32(&lbc->mdr, elbc_fcm_ctrl->mdr);
217 "fsl_elbc_run_command: fmr=%08x fir=%08x fcr=%08x\n",
218 in_be32(&lbc->fmr), in_be32(&lbc->fir), in_be32(&lbc->fcr));
220 "fsl_elbc_run_command: fbar=%08x fpar=%08x "
221 "fbcr=%08x bank=%d\n",
222 in_be32(&lbc->fbar), in_be32(&lbc->fpar),
223 in_be32(&lbc->fbcr), priv->bank);
225 ctrl->irq_status = 0;
226 /* execute special operation */
227 out_be32(&lbc->lsor, priv->bank);
229 /* wait for FCM complete flag or timeout */
230 wait_event_timeout(ctrl->irq_wait, ctrl->irq_status,
231 FCM_TIMEOUT_MSECS * HZ/1000);
232 elbc_fcm_ctrl->status = ctrl->irq_status;
233 /* store mdr value in case it was needed */
234 if (elbc_fcm_ctrl->use_mdr)
235 elbc_fcm_ctrl->mdr = in_be32(&lbc->mdr);
237 elbc_fcm_ctrl->use_mdr = 0;
239 if (elbc_fcm_ctrl->status != LTESR_CC) {
241 "command failed: fir %x fcr %x status %x mdr %x\n",
242 in_be32(&lbc->fir), in_be32(&lbc->fcr),
243 elbc_fcm_ctrl->status, elbc_fcm_ctrl->mdr);
247 if (chip->ecc.engine_type != NAND_ECC_ENGINE_TYPE_ON_HOST)
250 elbc_fcm_ctrl->max_bitflips = 0;
252 if (elbc_fcm_ctrl->read_bytes == mtd->writesize + mtd->oobsize) {
253 uint32_t lteccr = in_be32(&lbc->lteccr);
255 * if command was a full page read and the ELBC
256 * has the LTECCR register, then bits 12-15 (ppc order) of
257 * LTECCR indicates which 512 byte sub-pages had fixed errors.
258 * bits 28-31 are uncorrectable errors, marked elsewhere.
259 * for small page nand only 1 bit is used.
260 * if the ELBC doesn't have the lteccr register it reads 0
261 * FIXME: 4 bits can be corrected on NANDs with 2k pages, so
262 * count the number of sub-pages with bitflips and update
263 * ecc_stats.corrected accordingly.
265 if (lteccr & 0x000F000F)
266 out_be32(&lbc->lteccr, 0x000F000F); /* clear lteccr */
267 if (lteccr & 0x000F0000) {
268 mtd->ecc_stats.corrected++;
269 elbc_fcm_ctrl->max_bitflips = 1;
276 static void fsl_elbc_do_read(struct nand_chip *chip, int oob)
278 struct fsl_elbc_mtd *priv = nand_get_controller_data(chip);
279 struct fsl_lbc_ctrl *ctrl = priv->ctrl;
280 struct fsl_lbc_regs __iomem *lbc = ctrl->regs;
282 if (priv->page_size) {
284 (FIR_OP_CM0 << FIR_OP0_SHIFT) |
285 (FIR_OP_CA << FIR_OP1_SHIFT) |
286 (FIR_OP_PA << FIR_OP2_SHIFT) |
287 (FIR_OP_CM1 << FIR_OP3_SHIFT) |
288 (FIR_OP_RBW << FIR_OP4_SHIFT));
290 out_be32(&lbc->fcr, (NAND_CMD_READ0 << FCR_CMD0_SHIFT) |
291 (NAND_CMD_READSTART << FCR_CMD1_SHIFT));
294 (FIR_OP_CM0 << FIR_OP0_SHIFT) |
295 (FIR_OP_CA << FIR_OP1_SHIFT) |
296 (FIR_OP_PA << FIR_OP2_SHIFT) |
297 (FIR_OP_RBW << FIR_OP3_SHIFT));
300 out_be32(&lbc->fcr, NAND_CMD_READOOB << FCR_CMD0_SHIFT);
302 out_be32(&lbc->fcr, NAND_CMD_READ0 << FCR_CMD0_SHIFT);
306 /* cmdfunc send commands to the FCM */
307 static void fsl_elbc_cmdfunc(struct nand_chip *chip, unsigned int command,
308 int column, int page_addr)
310 struct mtd_info *mtd = nand_to_mtd(chip);
311 struct fsl_elbc_mtd *priv = nand_get_controller_data(chip);
312 struct fsl_lbc_ctrl *ctrl = priv->ctrl;
313 struct fsl_elbc_fcm_ctrl *elbc_fcm_ctrl = ctrl->nand;
314 struct fsl_lbc_regs __iomem *lbc = ctrl->regs;
316 elbc_fcm_ctrl->use_mdr = 0;
318 /* clear the read buffer */
319 elbc_fcm_ctrl->read_bytes = 0;
320 if (command != NAND_CMD_PAGEPROG)
321 elbc_fcm_ctrl->index = 0;
324 /* READ0 and READ1 read the entire buffer to use hardware ECC. */
330 "fsl_elbc_cmdfunc: NAND_CMD_READ0, page_addr:"
331 " 0x%x, column: 0x%x.\n", page_addr, column);
334 out_be32(&lbc->fbcr, 0); /* read entire page to enable ECC */
335 set_addr(mtd, 0, page_addr, 0);
337 elbc_fcm_ctrl->read_bytes = mtd->writesize + mtd->oobsize;
338 elbc_fcm_ctrl->index += column;
340 fsl_elbc_do_read(chip, 0);
341 fsl_elbc_run_command(mtd);
344 /* RNDOUT moves the pointer inside the page */
345 case NAND_CMD_RNDOUT:
347 "fsl_elbc_cmdfunc: NAND_CMD_RNDOUT, column: 0x%x.\n",
350 elbc_fcm_ctrl->index = column;
353 /* READOOB reads only the OOB because no ECC is performed. */
354 case NAND_CMD_READOOB:
356 "fsl_elbc_cmdfunc: NAND_CMD_READOOB, page_addr:"
357 " 0x%x, column: 0x%x.\n", page_addr, column);
359 out_be32(&lbc->fbcr, mtd->oobsize - column);
360 set_addr(mtd, column, page_addr, 1);
362 elbc_fcm_ctrl->read_bytes = mtd->writesize + mtd->oobsize;
364 fsl_elbc_do_read(chip, 1);
365 fsl_elbc_run_command(mtd);
368 case NAND_CMD_READID:
370 dev_vdbg(priv->dev, "fsl_elbc_cmdfunc: NAND_CMD %x\n", command);
372 out_be32(&lbc->fir, (FIR_OP_CM0 << FIR_OP0_SHIFT) |
373 (FIR_OP_UA << FIR_OP1_SHIFT) |
374 (FIR_OP_RBW << FIR_OP2_SHIFT));
375 out_be32(&lbc->fcr, command << FCR_CMD0_SHIFT);
377 * although currently it's 8 bytes for READID, we always read
378 * the maximum 256 bytes(for PARAM)
380 out_be32(&lbc->fbcr, 256);
381 elbc_fcm_ctrl->read_bytes = 256;
382 elbc_fcm_ctrl->use_mdr = 1;
383 elbc_fcm_ctrl->mdr = column;
384 set_addr(mtd, 0, 0, 0);
385 fsl_elbc_run_command(mtd);
388 /* ERASE1 stores the block and page address */
389 case NAND_CMD_ERASE1:
391 "fsl_elbc_cmdfunc: NAND_CMD_ERASE1, "
392 "page_addr: 0x%x.\n", page_addr);
393 set_addr(mtd, 0, page_addr, 0);
396 /* ERASE2 uses the block and page address from ERASE1 */
397 case NAND_CMD_ERASE2:
398 dev_vdbg(priv->dev, "fsl_elbc_cmdfunc: NAND_CMD_ERASE2.\n");
401 (FIR_OP_CM0 << FIR_OP0_SHIFT) |
402 (FIR_OP_PA << FIR_OP1_SHIFT) |
403 (FIR_OP_CM2 << FIR_OP2_SHIFT) |
404 (FIR_OP_CW1 << FIR_OP3_SHIFT) |
405 (FIR_OP_RS << FIR_OP4_SHIFT));
408 (NAND_CMD_ERASE1 << FCR_CMD0_SHIFT) |
409 (NAND_CMD_STATUS << FCR_CMD1_SHIFT) |
410 (NAND_CMD_ERASE2 << FCR_CMD2_SHIFT));
412 out_be32(&lbc->fbcr, 0);
413 elbc_fcm_ctrl->read_bytes = 0;
414 elbc_fcm_ctrl->use_mdr = 1;
416 fsl_elbc_run_command(mtd);
419 /* SEQIN sets up the addr buffer and all registers except the length */
420 case NAND_CMD_SEQIN: {
423 "fsl_elbc_cmdfunc: NAND_CMD_SEQIN/PAGE_PROG, "
424 "page_addr: 0x%x, column: 0x%x.\n",
427 elbc_fcm_ctrl->column = column;
428 elbc_fcm_ctrl->use_mdr = 1;
430 if (column >= mtd->writesize) {
432 column -= mtd->writesize;
433 elbc_fcm_ctrl->oob = 1;
435 WARN_ON(column != 0);
436 elbc_fcm_ctrl->oob = 0;
439 fcr = (NAND_CMD_STATUS << FCR_CMD1_SHIFT) |
440 (NAND_CMD_SEQIN << FCR_CMD2_SHIFT) |
441 (NAND_CMD_PAGEPROG << FCR_CMD3_SHIFT);
443 if (priv->page_size) {
445 (FIR_OP_CM2 << FIR_OP0_SHIFT) |
446 (FIR_OP_CA << FIR_OP1_SHIFT) |
447 (FIR_OP_PA << FIR_OP2_SHIFT) |
448 (FIR_OP_WB << FIR_OP3_SHIFT) |
449 (FIR_OP_CM3 << FIR_OP4_SHIFT) |
450 (FIR_OP_CW1 << FIR_OP5_SHIFT) |
451 (FIR_OP_RS << FIR_OP6_SHIFT));
454 (FIR_OP_CM0 << FIR_OP0_SHIFT) |
455 (FIR_OP_CM2 << FIR_OP1_SHIFT) |
456 (FIR_OP_CA << FIR_OP2_SHIFT) |
457 (FIR_OP_PA << FIR_OP3_SHIFT) |
458 (FIR_OP_WB << FIR_OP4_SHIFT) |
459 (FIR_OP_CM3 << FIR_OP5_SHIFT) |
460 (FIR_OP_CW1 << FIR_OP6_SHIFT) |
461 (FIR_OP_RS << FIR_OP7_SHIFT));
463 if (elbc_fcm_ctrl->oob)
464 /* OOB area --> READOOB */
465 fcr |= NAND_CMD_READOOB << FCR_CMD0_SHIFT;
467 /* First 256 bytes --> READ0 */
468 fcr |= NAND_CMD_READ0 << FCR_CMD0_SHIFT;
471 out_be32(&lbc->fcr, fcr);
472 set_addr(mtd, column, page_addr, elbc_fcm_ctrl->oob);
476 /* PAGEPROG reuses all of the setup from SEQIN and adds the length */
477 case NAND_CMD_PAGEPROG: {
479 "fsl_elbc_cmdfunc: NAND_CMD_PAGEPROG "
480 "writing %d bytes.\n", elbc_fcm_ctrl->index);
482 /* if the write did not start at 0 or is not a full page
483 * then set the exact length, otherwise use a full page
484 * write so the HW generates the ECC.
486 if (elbc_fcm_ctrl->oob || elbc_fcm_ctrl->column != 0 ||
487 elbc_fcm_ctrl->index != mtd->writesize + mtd->oobsize)
489 elbc_fcm_ctrl->index - elbc_fcm_ctrl->column);
491 out_be32(&lbc->fbcr, 0);
493 fsl_elbc_run_command(mtd);
497 /* CMD_STATUS must read the status byte while CEB is active */
498 /* Note - it does not wait for the ready line */
499 case NAND_CMD_STATUS:
501 (FIR_OP_CM0 << FIR_OP0_SHIFT) |
502 (FIR_OP_RBW << FIR_OP1_SHIFT));
503 out_be32(&lbc->fcr, NAND_CMD_STATUS << FCR_CMD0_SHIFT);
504 out_be32(&lbc->fbcr, 1);
505 set_addr(mtd, 0, 0, 0);
506 elbc_fcm_ctrl->read_bytes = 1;
508 fsl_elbc_run_command(mtd);
510 /* The chip always seems to report that it is
511 * write-protected, even when it is not.
513 setbits8(elbc_fcm_ctrl->addr, NAND_STATUS_WP);
516 /* RESET without waiting for the ready line */
518 dev_dbg(priv->dev, "fsl_elbc_cmdfunc: NAND_CMD_RESET.\n");
519 out_be32(&lbc->fir, FIR_OP_CM0 << FIR_OP0_SHIFT);
520 out_be32(&lbc->fcr, NAND_CMD_RESET << FCR_CMD0_SHIFT);
521 fsl_elbc_run_command(mtd);
526 "fsl_elbc_cmdfunc: error, unsupported command 0x%x.\n",
531 static void fsl_elbc_select_chip(struct nand_chip *chip, int cs)
533 /* The hardware does not seem to support multiple
539 * Write buf to the FCM Controller Data Buffer
541 static void fsl_elbc_write_buf(struct nand_chip *chip, const u8 *buf, int len)
543 struct mtd_info *mtd = nand_to_mtd(chip);
544 struct fsl_elbc_mtd *priv = nand_get_controller_data(chip);
545 struct fsl_elbc_fcm_ctrl *elbc_fcm_ctrl = priv->ctrl->nand;
546 unsigned int bufsize = mtd->writesize + mtd->oobsize;
549 dev_err(priv->dev, "write_buf of %d bytes", len);
550 elbc_fcm_ctrl->status = 0;
554 if ((unsigned int)len > bufsize - elbc_fcm_ctrl->index) {
556 "write_buf beyond end of buffer "
557 "(%d requested, %u available)\n",
558 len, bufsize - elbc_fcm_ctrl->index);
559 len = bufsize - elbc_fcm_ctrl->index;
562 memcpy_toio(&elbc_fcm_ctrl->addr[elbc_fcm_ctrl->index], buf, len);
564 * This is workaround for the weird elbc hangs during nand write,
565 * Scott Wood says: "...perhaps difference in how long it takes a
566 * write to make it through the localbus compared to a write to IMMR
567 * is causing problems, and sync isn't helping for some reason."
568 * Reading back the last byte helps though.
570 in_8(&elbc_fcm_ctrl->addr[elbc_fcm_ctrl->index] + len - 1);
572 elbc_fcm_ctrl->index += len;
576 * read a byte from either the FCM hardware buffer if it has any data left
577 * otherwise issue a command to read a single byte.
579 static u8 fsl_elbc_read_byte(struct nand_chip *chip)
581 struct fsl_elbc_mtd *priv = nand_get_controller_data(chip);
582 struct fsl_elbc_fcm_ctrl *elbc_fcm_ctrl = priv->ctrl->nand;
584 /* If there are still bytes in the FCM, then use the next byte. */
585 if (elbc_fcm_ctrl->index < elbc_fcm_ctrl->read_bytes)
586 return in_8(&elbc_fcm_ctrl->addr[elbc_fcm_ctrl->index++]);
588 dev_err(priv->dev, "read_byte beyond end of buffer\n");
593 * Read from the FCM Controller Data Buffer
595 static void fsl_elbc_read_buf(struct nand_chip *chip, u8 *buf, int len)
597 struct fsl_elbc_mtd *priv = nand_get_controller_data(chip);
598 struct fsl_elbc_fcm_ctrl *elbc_fcm_ctrl = priv->ctrl->nand;
604 avail = min((unsigned int)len,
605 elbc_fcm_ctrl->read_bytes - elbc_fcm_ctrl->index);
606 memcpy_fromio(buf, &elbc_fcm_ctrl->addr[elbc_fcm_ctrl->index], avail);
607 elbc_fcm_ctrl->index += avail;
611 "read_buf beyond end of buffer "
612 "(%d requested, %d available)\n",
616 /* This function is called after Program and Erase Operations to
617 * check for success or failure.
619 static int fsl_elbc_wait(struct nand_chip *chip)
621 struct fsl_elbc_mtd *priv = nand_get_controller_data(chip);
622 struct fsl_elbc_fcm_ctrl *elbc_fcm_ctrl = priv->ctrl->nand;
624 if (elbc_fcm_ctrl->status != LTESR_CC)
625 return NAND_STATUS_FAIL;
627 /* The chip always seems to report that it is
628 * write-protected, even when it is not.
630 return (elbc_fcm_ctrl->mdr & 0xff) | NAND_STATUS_WP;
633 static int fsl_elbc_read_page(struct nand_chip *chip, uint8_t *buf,
634 int oob_required, int page)
636 struct mtd_info *mtd = nand_to_mtd(chip);
637 struct fsl_elbc_mtd *priv = nand_get_controller_data(chip);
638 struct fsl_lbc_ctrl *ctrl = priv->ctrl;
639 struct fsl_elbc_fcm_ctrl *elbc_fcm_ctrl = ctrl->nand;
641 nand_read_page_op(chip, page, 0, buf, mtd->writesize);
643 fsl_elbc_read_buf(chip, chip->oob_poi, mtd->oobsize);
645 if (fsl_elbc_wait(chip) & NAND_STATUS_FAIL)
646 mtd->ecc_stats.failed++;
648 return elbc_fcm_ctrl->max_bitflips;
651 /* ECC will be calculated automatically, and errors will be detected in
654 static int fsl_elbc_write_page(struct nand_chip *chip, const uint8_t *buf,
655 int oob_required, int page)
657 struct mtd_info *mtd = nand_to_mtd(chip);
659 nand_prog_page_begin_op(chip, page, 0, buf, mtd->writesize);
660 fsl_elbc_write_buf(chip, chip->oob_poi, mtd->oobsize);
662 return nand_prog_page_end_op(chip);
665 /* ECC will be calculated automatically, and errors will be detected in
668 static int fsl_elbc_write_subpage(struct nand_chip *chip, uint32_t offset,
669 uint32_t data_len, const uint8_t *buf,
670 int oob_required, int page)
672 struct mtd_info *mtd = nand_to_mtd(chip);
674 nand_prog_page_begin_op(chip, page, 0, NULL, 0);
675 fsl_elbc_write_buf(chip, buf, mtd->writesize);
676 fsl_elbc_write_buf(chip, chip->oob_poi, mtd->oobsize);
677 return nand_prog_page_end_op(chip);
680 static int fsl_elbc_chip_init(struct fsl_elbc_mtd *priv)
682 struct fsl_lbc_ctrl *ctrl = priv->ctrl;
683 struct fsl_lbc_regs __iomem *lbc = ctrl->regs;
684 struct fsl_elbc_fcm_ctrl *elbc_fcm_ctrl = ctrl->nand;
685 struct nand_chip *chip = &priv->chip;
686 struct mtd_info *mtd = nand_to_mtd(chip);
688 dev_dbg(priv->dev, "eLBC Set Information for bank %d\n", priv->bank);
690 /* Fill in fsl_elbc_mtd structure */
691 mtd->dev.parent = priv->dev;
692 nand_set_flash_node(chip, priv->dev->of_node);
694 /* set timeout to maximum */
695 priv->fmr = 15 << FMR_CWTO_SHIFT;
696 if (in_be32(&lbc->bank[priv->bank].or) & OR_FCM_PGS)
697 priv->fmr |= FMR_ECCM;
699 /* fill in nand_chip structure */
700 /* set up function call table */
701 chip->legacy.read_byte = fsl_elbc_read_byte;
702 chip->legacy.write_buf = fsl_elbc_write_buf;
703 chip->legacy.read_buf = fsl_elbc_read_buf;
704 chip->legacy.select_chip = fsl_elbc_select_chip;
705 chip->legacy.cmdfunc = fsl_elbc_cmdfunc;
706 chip->legacy.waitfunc = fsl_elbc_wait;
707 chip->legacy.set_features = nand_get_set_features_notsupp;
708 chip->legacy.get_features = nand_get_set_features_notsupp;
710 chip->bbt_td = &bbt_main_descr;
711 chip->bbt_md = &bbt_mirror_descr;
713 /* set up nand options */
714 chip->bbt_options = NAND_BBT_USE_FLASH;
716 chip->controller = &elbc_fcm_ctrl->controller;
717 nand_set_controller_data(chip, priv);
722 static int fsl_elbc_attach_chip(struct nand_chip *chip)
724 struct mtd_info *mtd = nand_to_mtd(chip);
725 struct fsl_elbc_mtd *priv = nand_get_controller_data(chip);
726 struct fsl_lbc_ctrl *ctrl = priv->ctrl;
727 struct fsl_lbc_regs __iomem *lbc = ctrl->regs;
731 * if ECC was not chosen in DT, decide whether to use HW or SW ECC from
734 if (chip->ecc.engine_type == NAND_ECC_ENGINE_TYPE_INVALID) {
735 /* If CS Base Register selects full hardware ECC then use it */
736 if ((in_be32(&lbc->bank[priv->bank].br) & BR_DECC) ==
738 chip->ecc.engine_type = NAND_ECC_ENGINE_TYPE_ON_HOST;
740 /* otherwise fall back to default software ECC */
741 chip->ecc.engine_type = NAND_ECC_ENGINE_TYPE_SOFT;
742 chip->ecc.algo = NAND_ECC_ALGO_HAMMING;
746 switch (chip->ecc.engine_type) {
747 /* if HW ECC was chosen, setup ecc and oob layout */
748 case NAND_ECC_ENGINE_TYPE_ON_HOST:
749 chip->ecc.read_page = fsl_elbc_read_page;
750 chip->ecc.write_page = fsl_elbc_write_page;
751 chip->ecc.write_subpage = fsl_elbc_write_subpage;
752 mtd_set_ooblayout(mtd, &fsl_elbc_ooblayout_ops);
753 chip->ecc.size = 512;
755 chip->ecc.strength = 1;
758 /* if none or SW ECC was chosen, we do not need to set anything here */
759 case NAND_ECC_ENGINE_TYPE_NONE:
760 case NAND_ECC_ENGINE_TYPE_SOFT:
761 case NAND_ECC_ENGINE_TYPE_ON_DIE:
768 /* calculate FMR Address Length field */
770 if (chip->pagemask & 0xffff0000)
772 if (chip->pagemask & 0xff000000)
775 priv->fmr |= al << FMR_AL_SHIFT;
777 dev_dbg(priv->dev, "fsl_elbc_init: nand->numchips = %d\n",
778 nanddev_ntargets(&chip->base));
779 dev_dbg(priv->dev, "fsl_elbc_init: nand->chipsize = %lld\n",
780 nanddev_target_size(&chip->base));
781 dev_dbg(priv->dev, "fsl_elbc_init: nand->pagemask = %8x\n",
783 dev_dbg(priv->dev, "fsl_elbc_init: nand->legacy.chip_delay = %d\n",
784 chip->legacy.chip_delay);
785 dev_dbg(priv->dev, "fsl_elbc_init: nand->badblockpos = %d\n",
787 dev_dbg(priv->dev, "fsl_elbc_init: nand->chip_shift = %d\n",
789 dev_dbg(priv->dev, "fsl_elbc_init: nand->page_shift = %d\n",
791 dev_dbg(priv->dev, "fsl_elbc_init: nand->phys_erase_shift = %d\n",
792 chip->phys_erase_shift);
793 dev_dbg(priv->dev, "fsl_elbc_init: nand->ecc.engine_type = %d\n",
794 chip->ecc.engine_type);
795 dev_dbg(priv->dev, "fsl_elbc_init: nand->ecc.steps = %d\n",
797 dev_dbg(priv->dev, "fsl_elbc_init: nand->ecc.bytes = %d\n",
799 dev_dbg(priv->dev, "fsl_elbc_init: nand->ecc.total = %d\n",
801 dev_dbg(priv->dev, "fsl_elbc_init: mtd->ooblayout = %p\n",
803 dev_dbg(priv->dev, "fsl_elbc_init: mtd->flags = %08x\n", mtd->flags);
804 dev_dbg(priv->dev, "fsl_elbc_init: mtd->size = %lld\n", mtd->size);
805 dev_dbg(priv->dev, "fsl_elbc_init: mtd->erasesize = %d\n",
807 dev_dbg(priv->dev, "fsl_elbc_init: mtd->writesize = %d\n",
809 dev_dbg(priv->dev, "fsl_elbc_init: mtd->oobsize = %d\n",
812 /* adjust Option Register and ECC to match Flash page size */
813 if (mtd->writesize == 512) {
815 clrbits32(&lbc->bank[priv->bank].or, OR_FCM_PGS);
816 } else if (mtd->writesize == 2048) {
818 setbits32(&lbc->bank[priv->bank].or, OR_FCM_PGS);
821 "fsl_elbc_init: page size %d is not supported\n",
829 static const struct nand_controller_ops fsl_elbc_controller_ops = {
830 .attach_chip = fsl_elbc_attach_chip,
833 static int fsl_elbc_chip_remove(struct fsl_elbc_mtd *priv)
835 struct fsl_elbc_fcm_ctrl *elbc_fcm_ctrl = priv->ctrl->nand;
836 struct mtd_info *mtd = nand_to_mtd(&priv->chip);
841 iounmap(priv->vbase);
843 elbc_fcm_ctrl->chips[priv->bank] = NULL;
848 static DEFINE_MUTEX(fsl_elbc_nand_mutex);
850 static int fsl_elbc_nand_probe(struct platform_device *pdev)
852 struct fsl_lbc_regs __iomem *lbc;
853 struct fsl_elbc_mtd *priv;
855 struct fsl_elbc_fcm_ctrl *elbc_fcm_ctrl;
856 static const char *part_probe_types[]
857 = { "cmdlinepart", "RedBoot", "ofpart", NULL };
861 struct device_node *node = pdev->dev.of_node;
862 struct mtd_info *mtd;
864 if (!fsl_lbc_ctrl_dev || !fsl_lbc_ctrl_dev->regs)
866 lbc = fsl_lbc_ctrl_dev->regs;
867 dev = fsl_lbc_ctrl_dev->dev;
869 /* get, allocate and map the memory resource */
870 ret = of_address_to_resource(node, 0, &res);
872 dev_err(dev, "failed to get resource\n");
876 /* find which chip select it is connected to */
877 for (bank = 0; bank < MAX_BANKS; bank++)
878 if ((in_be32(&lbc->bank[bank].br) & BR_V) &&
879 (in_be32(&lbc->bank[bank].br) & BR_MSEL) == BR_MS_FCM &&
880 (in_be32(&lbc->bank[bank].br) &
881 in_be32(&lbc->bank[bank].or) & BR_BA)
882 == fsl_lbc_addr(res.start))
885 if (bank >= MAX_BANKS) {
886 dev_err(dev, "address did not match any chip selects\n");
890 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
894 mutex_lock(&fsl_elbc_nand_mutex);
895 if (!fsl_lbc_ctrl_dev->nand) {
896 elbc_fcm_ctrl = kzalloc(sizeof(*elbc_fcm_ctrl), GFP_KERNEL);
897 if (!elbc_fcm_ctrl) {
898 mutex_unlock(&fsl_elbc_nand_mutex);
902 elbc_fcm_ctrl->counter++;
904 nand_controller_init(&elbc_fcm_ctrl->controller);
905 fsl_lbc_ctrl_dev->nand = elbc_fcm_ctrl;
907 elbc_fcm_ctrl = fsl_lbc_ctrl_dev->nand;
909 mutex_unlock(&fsl_elbc_nand_mutex);
911 elbc_fcm_ctrl->chips[bank] = priv;
913 priv->ctrl = fsl_lbc_ctrl_dev;
914 priv->dev = &pdev->dev;
915 dev_set_drvdata(priv->dev, priv);
917 priv->vbase = ioremap(res.start, resource_size(&res));
919 dev_err(dev, "failed to map chip region\n");
924 mtd = nand_to_mtd(&priv->chip);
925 mtd->name = kasprintf(GFP_KERNEL, "%llx.flash", (u64)res.start);
926 if (!nand_to_mtd(&priv->chip)->name) {
931 ret = fsl_elbc_chip_init(priv);
935 priv->chip.controller->ops = &fsl_elbc_controller_ops;
936 ret = nand_scan(&priv->chip, 1);
940 /* First look for RedBoot table or partitions on the command
941 * line, these take precedence over device tree information */
942 ret = mtd_device_parse_register(mtd, part_probe_types, NULL, NULL, 0);
946 pr_info("eLBC NAND device at 0x%llx, bank %d\n",
947 (unsigned long long)res.start, priv->bank);
952 nand_cleanup(&priv->chip);
954 fsl_elbc_chip_remove(priv);
959 static int fsl_elbc_nand_remove(struct platform_device *pdev)
961 struct fsl_elbc_fcm_ctrl *elbc_fcm_ctrl = fsl_lbc_ctrl_dev->nand;
962 struct fsl_elbc_mtd *priv = dev_get_drvdata(&pdev->dev);
963 struct nand_chip *chip = &priv->chip;
966 ret = mtd_device_unregister(nand_to_mtd(chip));
970 fsl_elbc_chip_remove(priv);
972 mutex_lock(&fsl_elbc_nand_mutex);
973 elbc_fcm_ctrl->counter--;
974 if (!elbc_fcm_ctrl->counter) {
975 fsl_lbc_ctrl_dev->nand = NULL;
976 kfree(elbc_fcm_ctrl);
978 mutex_unlock(&fsl_elbc_nand_mutex);
984 static const struct of_device_id fsl_elbc_nand_match[] = {
985 { .compatible = "fsl,elbc-fcm-nand", },
988 MODULE_DEVICE_TABLE(of, fsl_elbc_nand_match);
990 static struct platform_driver fsl_elbc_nand_driver = {
992 .name = "fsl,elbc-fcm-nand",
993 .of_match_table = fsl_elbc_nand_match,
995 .probe = fsl_elbc_nand_probe,
996 .remove = fsl_elbc_nand_remove,
999 module_platform_driver(fsl_elbc_nand_driver);
1001 MODULE_LICENSE("GPL");
1002 MODULE_AUTHOR("Freescale");
1003 MODULE_DESCRIPTION("Freescale Enhanced Local Bus Controller MTD NAND driver");