5 * This is the generic MTD driver for NAND flash devices. It should be
6 * capable of working with almost all NAND chips currently available.
8 * Additional technical information is available on
9 * http://www.linux-mtd.infradead.org/doc/nand.html
11 * Copyright (C) 2000 Steven J. Hill (sjhill@realitydiluted.com)
12 * 2002-2006 Thomas Gleixner (tglx@linutronix.de)
15 * David Woodhouse for adding multichip support
17 * Aleph One Ltd. and Toby Churchill Ltd. for supporting the
18 * rework for 2K page size chips
21 * Enable cached programming for 2k page size chips
22 * Check, if mtd->ecctype should be set to MTD_ECC_HW
23 * if we have HW ECC support.
24 * BBT table is not serialized, has to be fixed
26 * This program is free software; you can redistribute it and/or modify
27 * it under the terms of the GNU General Public License version 2 as
28 * published by the Free Software Foundation.
32 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
34 #include <linux/module.h>
35 #include <linux/delay.h>
36 #include <linux/errno.h>
37 #include <linux/err.h>
38 #include <linux/sched.h>
39 #include <linux/slab.h>
41 #include <linux/types.h>
42 #include <linux/mtd/mtd.h>
43 #include <linux/mtd/nand.h>
44 #include <linux/mtd/nand_ecc.h>
45 #include <linux/mtd/nand_bch.h>
46 #include <linux/interrupt.h>
47 #include <linux/bitops.h>
48 #include <linux/leds.h>
50 #include <linux/mtd/partitions.h>
52 /* Define default oob placement schemes for large and small page devices */
53 static struct nand_ecclayout nand_oob_8 = {
63 static struct nand_ecclayout nand_oob_16 = {
65 .eccpos = {0, 1, 2, 3, 6, 7},
71 static struct nand_ecclayout nand_oob_64 = {
74 40, 41, 42, 43, 44, 45, 46, 47,
75 48, 49, 50, 51, 52, 53, 54, 55,
76 56, 57, 58, 59, 60, 61, 62, 63},
82 static struct nand_ecclayout nand_oob_128 = {
85 80, 81, 82, 83, 84, 85, 86, 87,
86 88, 89, 90, 91, 92, 93, 94, 95,
87 96, 97, 98, 99, 100, 101, 102, 103,
88 104, 105, 106, 107, 108, 109, 110, 111,
89 112, 113, 114, 115, 116, 117, 118, 119,
90 120, 121, 122, 123, 124, 125, 126, 127},
96 static int nand_get_device(struct mtd_info *mtd, int new_state);
98 static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
99 struct mtd_oob_ops *ops);
102 * For devices which display every fart in the system on a separate LED. Is
103 * compiled away when LED support is disabled.
105 DEFINE_LED_TRIGGER(nand_led_trigger);
107 static int check_offs_len(struct mtd_info *mtd,
108 loff_t ofs, uint64_t len)
110 struct nand_chip *chip = mtd->priv;
113 /* Start address must align on block boundary */
114 if (ofs & ((1ULL << chip->phys_erase_shift) - 1)) {
115 pr_debug("%s: unaligned address\n", __func__);
119 /* Length must align on block boundary */
120 if (len & ((1ULL << chip->phys_erase_shift) - 1)) {
121 pr_debug("%s: length not block aligned\n", __func__);
129 * nand_release_device - [GENERIC] release chip
130 * @mtd: MTD device structure
132 * Release chip lock and wake up anyone waiting on the device.
134 static void nand_release_device(struct mtd_info *mtd)
136 struct nand_chip *chip = mtd->priv;
138 /* Release the controller and the chip */
139 spin_lock(&chip->controller->lock);
140 chip->controller->active = NULL;
141 chip->state = FL_READY;
142 wake_up(&chip->controller->wq);
143 spin_unlock(&chip->controller->lock);
147 * nand_read_byte - [DEFAULT] read one byte from the chip
148 * @mtd: MTD device structure
150 * Default read function for 8bit buswidth
152 static uint8_t nand_read_byte(struct mtd_info *mtd)
154 struct nand_chip *chip = mtd->priv;
155 return readb(chip->IO_ADDR_R);
159 * nand_read_byte16 - [DEFAULT] read one byte endianness aware from the chip
160 * nand_read_byte16 - [DEFAULT] read one byte endianness aware from the chip
161 * @mtd: MTD device structure
163 * Default read function for 16bit buswidth with endianness conversion.
166 static uint8_t nand_read_byte16(struct mtd_info *mtd)
168 struct nand_chip *chip = mtd->priv;
169 return (uint8_t) cpu_to_le16(readw(chip->IO_ADDR_R));
173 * nand_read_word - [DEFAULT] read one word from the chip
174 * @mtd: MTD device structure
176 * Default read function for 16bit buswidth without endianness conversion.
178 static u16 nand_read_word(struct mtd_info *mtd)
180 struct nand_chip *chip = mtd->priv;
181 return readw(chip->IO_ADDR_R);
185 * nand_select_chip - [DEFAULT] control CE line
186 * @mtd: MTD device structure
187 * @chipnr: chipnumber to select, -1 for deselect
189 * Default select function for 1 chip devices.
191 static void nand_select_chip(struct mtd_info *mtd, int chipnr)
193 struct nand_chip *chip = mtd->priv;
197 chip->cmd_ctrl(mtd, NAND_CMD_NONE, 0 | NAND_CTRL_CHANGE);
208 * nand_write_byte - [DEFAULT] write single byte to chip
209 * @mtd: MTD device structure
210 * @byte: value to write
212 * Default function to write a byte to I/O[7:0]
214 static void nand_write_byte(struct mtd_info *mtd, uint8_t byte)
216 struct nand_chip *chip = mtd->priv;
218 chip->write_buf(mtd, &byte, 1);
222 * nand_write_byte16 - [DEFAULT] write single byte to a chip with width 16
223 * @mtd: MTD device structure
224 * @byte: value to write
226 * Default function to write a byte to I/O[7:0] on a 16-bit wide chip.
228 static void nand_write_byte16(struct mtd_info *mtd, uint8_t byte)
230 struct nand_chip *chip = mtd->priv;
231 uint16_t word = byte;
234 * It's not entirely clear what should happen to I/O[15:8] when writing
235 * a byte. The ONFi spec (Revision 3.1; 2012-09-19, Section 2.16) reads:
237 * When the host supports a 16-bit bus width, only data is
238 * transferred at the 16-bit width. All address and command line
239 * transfers shall use only the lower 8-bits of the data bus. During
240 * command transfers, the host may place any value on the upper
241 * 8-bits of the data bus. During address transfers, the host shall
242 * set the upper 8-bits of the data bus to 00h.
244 * One user of the write_byte callback is nand_onfi_set_features. The
245 * four parameters are specified to be written to I/O[7:0], but this is
246 * neither an address nor a command transfer. Let's assume a 0 on the
247 * upper I/O lines is OK.
249 chip->write_buf(mtd, (uint8_t *)&word, 2);
253 * nand_write_buf - [DEFAULT] write buffer to chip
254 * @mtd: MTD device structure
256 * @len: number of bytes to write
258 * Default write function for 8bit buswidth.
260 static void nand_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
262 struct nand_chip *chip = mtd->priv;
264 iowrite8_rep(chip->IO_ADDR_W, buf, len);
268 * nand_read_buf - [DEFAULT] read chip data into buffer
269 * @mtd: MTD device structure
270 * @buf: buffer to store date
271 * @len: number of bytes to read
273 * Default read function for 8bit buswidth.
275 static void nand_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
277 struct nand_chip *chip = mtd->priv;
279 ioread8_rep(chip->IO_ADDR_R, buf, len);
283 * nand_write_buf16 - [DEFAULT] write buffer to chip
284 * @mtd: MTD device structure
286 * @len: number of bytes to write
288 * Default write function for 16bit buswidth.
290 static void nand_write_buf16(struct mtd_info *mtd, const uint8_t *buf, int len)
292 struct nand_chip *chip = mtd->priv;
293 u16 *p = (u16 *) buf;
295 iowrite16_rep(chip->IO_ADDR_W, p, len >> 1);
299 * nand_read_buf16 - [DEFAULT] read chip data into buffer
300 * @mtd: MTD device structure
301 * @buf: buffer to store date
302 * @len: number of bytes to read
304 * Default read function for 16bit buswidth.
306 static void nand_read_buf16(struct mtd_info *mtd, uint8_t *buf, int len)
308 struct nand_chip *chip = mtd->priv;
309 u16 *p = (u16 *) buf;
311 ioread16_rep(chip->IO_ADDR_R, p, len >> 1);
315 * nand_block_bad - [DEFAULT] Read bad block marker from the chip
316 * @mtd: MTD device structure
317 * @ofs: offset from device start
318 * @getchip: 0, if the chip is already selected
320 * Check, if the block is bad.
322 static int nand_block_bad(struct mtd_info *mtd, loff_t ofs, int getchip)
324 int page, chipnr, res = 0, i = 0;
325 struct nand_chip *chip = mtd->priv;
328 if (chip->bbt_options & NAND_BBT_SCANLASTPAGE)
329 ofs += mtd->erasesize - mtd->writesize;
331 page = (int)(ofs >> chip->page_shift) & chip->pagemask;
334 chipnr = (int)(ofs >> chip->chip_shift);
336 nand_get_device(mtd, FL_READING);
338 /* Select the NAND device */
339 chip->select_chip(mtd, chipnr);
343 if (chip->options & NAND_BUSWIDTH_16) {
344 chip->cmdfunc(mtd, NAND_CMD_READOOB,
345 chip->badblockpos & 0xFE, page);
346 bad = cpu_to_le16(chip->read_word(mtd));
347 if (chip->badblockpos & 0x1)
352 chip->cmdfunc(mtd, NAND_CMD_READOOB, chip->badblockpos,
354 bad = chip->read_byte(mtd);
357 if (likely(chip->badblockbits == 8))
360 res = hweight8(bad) < chip->badblockbits;
361 ofs += mtd->writesize;
362 page = (int)(ofs >> chip->page_shift) & chip->pagemask;
364 } while (!res && i < 2 && (chip->bbt_options & NAND_BBT_SCAN2NDPAGE));
367 chip->select_chip(mtd, -1);
368 nand_release_device(mtd);
375 * nand_default_block_markbad - [DEFAULT] mark a block bad via bad block marker
376 * @mtd: MTD device structure
377 * @ofs: offset from device start
379 * This is the default implementation, which can be overridden by a hardware
380 * specific driver. It provides the details for writing a bad block marker to a
383 static int nand_default_block_markbad(struct mtd_info *mtd, loff_t ofs)
385 struct nand_chip *chip = mtd->priv;
386 struct mtd_oob_ops ops;
387 uint8_t buf[2] = { 0, 0 };
388 int ret = 0, res, i = 0;
392 ops.ooboffs = chip->badblockpos;
393 if (chip->options & NAND_BUSWIDTH_16) {
394 ops.ooboffs &= ~0x01;
395 ops.len = ops.ooblen = 2;
397 ops.len = ops.ooblen = 1;
399 ops.mode = MTD_OPS_PLACE_OOB;
401 /* Write to first/last page(s) if necessary */
402 if (chip->bbt_options & NAND_BBT_SCANLASTPAGE)
403 ofs += mtd->erasesize - mtd->writesize;
405 res = nand_do_write_oob(mtd, ofs, &ops);
410 ofs += mtd->writesize;
411 } while ((chip->bbt_options & NAND_BBT_SCAN2NDPAGE) && i < 2);
417 * nand_block_markbad_lowlevel - mark a block bad
418 * @mtd: MTD device structure
419 * @ofs: offset from device start
421 * This function performs the generic NAND bad block marking steps (i.e., bad
422 * block table(s) and/or marker(s)). We only allow the hardware driver to
423 * specify how to write bad block markers to OOB (chip->block_markbad).
425 * We try operations in the following order:
426 * (1) erase the affected block, to allow OOB marker to be written cleanly
427 * (2) write bad block marker to OOB area of affected block (unless flag
428 * NAND_BBT_NO_OOB_BBM is present)
430 * Note that we retain the first error encountered in (2) or (3), finish the
431 * procedures, and dump the error in the end.
433 static int nand_block_markbad_lowlevel(struct mtd_info *mtd, loff_t ofs)
435 struct nand_chip *chip = mtd->priv;
438 if (!(chip->bbt_options & NAND_BBT_NO_OOB_BBM)) {
439 struct erase_info einfo;
441 /* Attempt erase before marking OOB */
442 memset(&einfo, 0, sizeof(einfo));
445 einfo.len = 1ULL << chip->phys_erase_shift;
446 nand_erase_nand(mtd, &einfo, 0);
448 /* Write bad block marker to OOB */
449 nand_get_device(mtd, FL_WRITING);
450 ret = chip->block_markbad(mtd, ofs);
451 nand_release_device(mtd);
454 /* Mark block bad in BBT */
456 res = nand_markbad_bbt(mtd, ofs);
462 mtd->ecc_stats.badblocks++;
468 * nand_check_wp - [GENERIC] check if the chip is write protected
469 * @mtd: MTD device structure
471 * Check, if the device is write protected. The function expects, that the
472 * device is already selected.
474 static int nand_check_wp(struct mtd_info *mtd)
476 struct nand_chip *chip = mtd->priv;
478 /* Broken xD cards report WP despite being writable */
479 if (chip->options & NAND_BROKEN_XD)
482 /* Check the WP bit */
483 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
484 return (chip->read_byte(mtd) & NAND_STATUS_WP) ? 0 : 1;
488 * nand_block_isreserved - [GENERIC] Check if a block is marked reserved.
489 * @mtd: MTD device structure
490 * @ofs: offset from device start
492 * Check if the block is marked as reserved.
494 static int nand_block_isreserved(struct mtd_info *mtd, loff_t ofs)
496 struct nand_chip *chip = mtd->priv;
500 /* Return info from the table */
501 return nand_isreserved_bbt(mtd, ofs);
505 * nand_block_checkbad - [GENERIC] Check if a block is marked bad
506 * @mtd: MTD device structure
507 * @ofs: offset from device start
508 * @getchip: 0, if the chip is already selected
509 * @allowbbt: 1, if its allowed to access the bbt area
511 * Check, if the block is bad. Either by reading the bad block table or
512 * calling of the scan function.
514 static int nand_block_checkbad(struct mtd_info *mtd, loff_t ofs, int getchip,
517 struct nand_chip *chip = mtd->priv;
520 return chip->block_bad(mtd, ofs, getchip);
522 /* Return info from the table */
523 return nand_isbad_bbt(mtd, ofs, allowbbt);
527 * panic_nand_wait_ready - [GENERIC] Wait for the ready pin after commands.
528 * @mtd: MTD device structure
531 * Helper function for nand_wait_ready used when needing to wait in interrupt
534 static void panic_nand_wait_ready(struct mtd_info *mtd, unsigned long timeo)
536 struct nand_chip *chip = mtd->priv;
539 /* Wait for the device to get ready */
540 for (i = 0; i < timeo; i++) {
541 if (chip->dev_ready(mtd))
543 touch_softlockup_watchdog();
548 /* Wait for the ready pin, after a command. The timeout is caught later. */
549 void nand_wait_ready(struct mtd_info *mtd)
551 struct nand_chip *chip = mtd->priv;
552 unsigned long timeo = jiffies + msecs_to_jiffies(20);
555 if (in_interrupt() || oops_in_progress)
556 return panic_nand_wait_ready(mtd, 400);
558 led_trigger_event(nand_led_trigger, LED_FULL);
559 /* Wait until command is processed or timeout occurs */
561 if (chip->dev_ready(mtd))
563 touch_softlockup_watchdog();
564 } while (time_before(jiffies, timeo));
565 led_trigger_event(nand_led_trigger, LED_OFF);
567 EXPORT_SYMBOL_GPL(nand_wait_ready);
570 * nand_command - [DEFAULT] Send command to NAND device
571 * @mtd: MTD device structure
572 * @command: the command to be sent
573 * @column: the column address for this command, -1 if none
574 * @page_addr: the page address for this command, -1 if none
576 * Send command to NAND device. This function is used for small page devices
577 * (512 Bytes per page).
579 static void nand_command(struct mtd_info *mtd, unsigned int command,
580 int column, int page_addr)
582 register struct nand_chip *chip = mtd->priv;
583 int ctrl = NAND_CTRL_CLE | NAND_CTRL_CHANGE;
585 /* Write out the command to the device */
586 if (command == NAND_CMD_SEQIN) {
589 if (column >= mtd->writesize) {
591 column -= mtd->writesize;
592 readcmd = NAND_CMD_READOOB;
593 } else if (column < 256) {
594 /* First 256 bytes --> READ0 */
595 readcmd = NAND_CMD_READ0;
598 readcmd = NAND_CMD_READ1;
600 chip->cmd_ctrl(mtd, readcmd, ctrl);
601 ctrl &= ~NAND_CTRL_CHANGE;
603 chip->cmd_ctrl(mtd, command, ctrl);
605 /* Address cycle, when necessary */
606 ctrl = NAND_CTRL_ALE | NAND_CTRL_CHANGE;
607 /* Serially input address */
609 /* Adjust columns for 16 bit buswidth */
610 if (chip->options & NAND_BUSWIDTH_16 &&
611 !nand_opcode_8bits(command))
613 chip->cmd_ctrl(mtd, column, ctrl);
614 ctrl &= ~NAND_CTRL_CHANGE;
616 if (page_addr != -1) {
617 chip->cmd_ctrl(mtd, page_addr, ctrl);
618 ctrl &= ~NAND_CTRL_CHANGE;
619 chip->cmd_ctrl(mtd, page_addr >> 8, ctrl);
620 /* One more address cycle for devices > 32MiB */
621 if (chip->chipsize > (32 << 20))
622 chip->cmd_ctrl(mtd, page_addr >> 16, ctrl);
624 chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
627 * Program and erase have their own busy handlers status and sequential
632 case NAND_CMD_PAGEPROG:
633 case NAND_CMD_ERASE1:
634 case NAND_CMD_ERASE2:
636 case NAND_CMD_STATUS:
642 udelay(chip->chip_delay);
643 chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
644 NAND_CTRL_CLE | NAND_CTRL_CHANGE);
646 NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
647 while (!(chip->read_byte(mtd) & NAND_STATUS_READY))
651 /* This applies to read commands */
654 * If we don't have access to the busy pin, we apply the given
657 if (!chip->dev_ready) {
658 udelay(chip->chip_delay);
663 * Apply this short delay always to ensure that we do wait tWB in
664 * any case on any machine.
668 nand_wait_ready(mtd);
672 * nand_command_lp - [DEFAULT] Send command to NAND large page device
673 * @mtd: MTD device structure
674 * @command: the command to be sent
675 * @column: the column address for this command, -1 if none
676 * @page_addr: the page address for this command, -1 if none
678 * Send command to NAND device. This is the version for the new large page
679 * devices. We don't have the separate regions as we have in the small page
680 * devices. We must emulate NAND_CMD_READOOB to keep the code compatible.
682 static void nand_command_lp(struct mtd_info *mtd, unsigned int command,
683 int column, int page_addr)
685 register struct nand_chip *chip = mtd->priv;
687 /* Emulate NAND_CMD_READOOB */
688 if (command == NAND_CMD_READOOB) {
689 column += mtd->writesize;
690 command = NAND_CMD_READ0;
693 /* Command latch cycle */
694 chip->cmd_ctrl(mtd, command, NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
696 if (column != -1 || page_addr != -1) {
697 int ctrl = NAND_CTRL_CHANGE | NAND_NCE | NAND_ALE;
699 /* Serially input address */
701 /* Adjust columns for 16 bit buswidth */
702 if (chip->options & NAND_BUSWIDTH_16 &&
703 !nand_opcode_8bits(command))
705 chip->cmd_ctrl(mtd, column, ctrl);
706 ctrl &= ~NAND_CTRL_CHANGE;
707 chip->cmd_ctrl(mtd, column >> 8, ctrl);
709 if (page_addr != -1) {
710 chip->cmd_ctrl(mtd, page_addr, ctrl);
711 chip->cmd_ctrl(mtd, page_addr >> 8,
712 NAND_NCE | NAND_ALE);
713 /* One more address cycle for devices > 128MiB */
714 if (chip->chipsize > (128 << 20))
715 chip->cmd_ctrl(mtd, page_addr >> 16,
716 NAND_NCE | NAND_ALE);
719 chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
722 * Program and erase have their own busy handlers status, sequential
723 * in and status need no delay.
727 case NAND_CMD_CACHEDPROG:
728 case NAND_CMD_PAGEPROG:
729 case NAND_CMD_ERASE1:
730 case NAND_CMD_ERASE2:
733 case NAND_CMD_STATUS:
739 udelay(chip->chip_delay);
740 chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
741 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
742 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
743 NAND_NCE | NAND_CTRL_CHANGE);
744 while (!(chip->read_byte(mtd) & NAND_STATUS_READY))
748 case NAND_CMD_RNDOUT:
749 /* No ready / busy check necessary */
750 chip->cmd_ctrl(mtd, NAND_CMD_RNDOUTSTART,
751 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
752 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
753 NAND_NCE | NAND_CTRL_CHANGE);
757 chip->cmd_ctrl(mtd, NAND_CMD_READSTART,
758 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
759 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
760 NAND_NCE | NAND_CTRL_CHANGE);
762 /* This applies to read commands */
765 * If we don't have access to the busy pin, we apply the given
768 if (!chip->dev_ready) {
769 udelay(chip->chip_delay);
775 * Apply this short delay always to ensure that we do wait tWB in
776 * any case on any machine.
780 nand_wait_ready(mtd);
784 * panic_nand_get_device - [GENERIC] Get chip for selected access
785 * @chip: the nand chip descriptor
786 * @mtd: MTD device structure
787 * @new_state: the state which is requested
789 * Used when in panic, no locks are taken.
791 static void panic_nand_get_device(struct nand_chip *chip,
792 struct mtd_info *mtd, int new_state)
794 /* Hardware controller shared among independent devices */
795 chip->controller->active = chip;
796 chip->state = new_state;
800 * nand_get_device - [GENERIC] Get chip for selected access
801 * @mtd: MTD device structure
802 * @new_state: the state which is requested
804 * Get the device and lock it for exclusive access
807 nand_get_device(struct mtd_info *mtd, int new_state)
809 struct nand_chip *chip = mtd->priv;
810 spinlock_t *lock = &chip->controller->lock;
811 wait_queue_head_t *wq = &chip->controller->wq;
812 DECLARE_WAITQUEUE(wait, current);
816 /* Hardware controller shared among independent devices */
817 if (!chip->controller->active)
818 chip->controller->active = chip;
820 if (chip->controller->active == chip && chip->state == FL_READY) {
821 chip->state = new_state;
825 if (new_state == FL_PM_SUSPENDED) {
826 if (chip->controller->active->state == FL_PM_SUSPENDED) {
827 chip->state = FL_PM_SUSPENDED;
832 set_current_state(TASK_UNINTERRUPTIBLE);
833 add_wait_queue(wq, &wait);
836 remove_wait_queue(wq, &wait);
841 * panic_nand_wait - [GENERIC] wait until the command is done
842 * @mtd: MTD device structure
843 * @chip: NAND chip structure
846 * Wait for command done. This is a helper function for nand_wait used when
847 * we are in interrupt context. May happen when in panic and trying to write
848 * an oops through mtdoops.
850 static void panic_nand_wait(struct mtd_info *mtd, struct nand_chip *chip,
854 for (i = 0; i < timeo; i++) {
855 if (chip->dev_ready) {
856 if (chip->dev_ready(mtd))
859 if (chip->read_byte(mtd) & NAND_STATUS_READY)
867 * nand_wait - [DEFAULT] wait until the command is done
868 * @mtd: MTD device structure
869 * @chip: NAND chip structure
871 * Wait for command done. This applies to erase and program only. Erase can
872 * take up to 400ms and program up to 20ms according to general NAND and
875 static int nand_wait(struct mtd_info *mtd, struct nand_chip *chip)
878 int status, state = chip->state;
879 unsigned long timeo = (state == FL_ERASING ? 400 : 20);
881 led_trigger_event(nand_led_trigger, LED_FULL);
884 * Apply this short delay always to ensure that we do wait tWB in any
885 * case on any machine.
889 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
891 if (in_interrupt() || oops_in_progress)
892 panic_nand_wait(mtd, chip, timeo);
894 timeo = jiffies + msecs_to_jiffies(timeo);
895 while (time_before(jiffies, timeo)) {
896 if (chip->dev_ready) {
897 if (chip->dev_ready(mtd))
900 if (chip->read_byte(mtd) & NAND_STATUS_READY)
906 led_trigger_event(nand_led_trigger, LED_OFF);
908 status = (int)chip->read_byte(mtd);
909 /* This can happen if in case of timeout or buggy dev_ready */
910 WARN_ON(!(status & NAND_STATUS_READY));
915 * __nand_unlock - [REPLACEABLE] unlocks specified locked blocks
917 * @ofs: offset to start unlock from
918 * @len: length to unlock
919 * @invert: when = 0, unlock the range of blocks within the lower and
920 * upper boundary address
921 * when = 1, unlock the range of blocks outside the boundaries
922 * of the lower and upper boundary address
924 * Returs unlock status.
926 static int __nand_unlock(struct mtd_info *mtd, loff_t ofs,
927 uint64_t len, int invert)
931 struct nand_chip *chip = mtd->priv;
933 /* Submit address of first page to unlock */
934 page = ofs >> chip->page_shift;
935 chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);
937 /* Submit address of last page to unlock */
938 page = (ofs + len) >> chip->page_shift;
939 chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1,
940 (page | invert) & chip->pagemask);
942 /* Call wait ready function */
943 status = chip->waitfunc(mtd, chip);
944 /* See if device thinks it succeeded */
945 if (status & NAND_STATUS_FAIL) {
946 pr_debug("%s: error status = 0x%08x\n",
955 * nand_unlock - [REPLACEABLE] unlocks specified locked blocks
957 * @ofs: offset to start unlock from
958 * @len: length to unlock
960 * Returns unlock status.
962 int nand_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
966 struct nand_chip *chip = mtd->priv;
968 pr_debug("%s: start = 0x%012llx, len = %llu\n",
969 __func__, (unsigned long long)ofs, len);
971 if (check_offs_len(mtd, ofs, len))
974 /* Align to last block address if size addresses end of the device */
975 if (ofs + len == mtd->size)
976 len -= mtd->erasesize;
978 nand_get_device(mtd, FL_UNLOCKING);
980 /* Shift to get chip number */
981 chipnr = ofs >> chip->chip_shift;
983 chip->select_chip(mtd, chipnr);
987 * If we want to check the WP through READ STATUS and check the bit 7
988 * we must reset the chip
989 * some operation can also clear the bit 7 of status register
990 * eg. erase/program a locked block
992 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
994 /* Check, if it is write protected */
995 if (nand_check_wp(mtd)) {
996 pr_debug("%s: device is write protected!\n",
1002 ret = __nand_unlock(mtd, ofs, len, 0);
1005 chip->select_chip(mtd, -1);
1006 nand_release_device(mtd);
1010 EXPORT_SYMBOL(nand_unlock);
1013 * nand_lock - [REPLACEABLE] locks all blocks present in the device
1015 * @ofs: offset to start unlock from
1016 * @len: length to unlock
1018 * This feature is not supported in many NAND parts. 'Micron' NAND parts do
1019 * have this feature, but it allows only to lock all blocks, not for specified
1020 * range for block. Implementing 'lock' feature by making use of 'unlock', for
1023 * Returns lock status.
1025 int nand_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
1028 int chipnr, status, page;
1029 struct nand_chip *chip = mtd->priv;
1031 pr_debug("%s: start = 0x%012llx, len = %llu\n",
1032 __func__, (unsigned long long)ofs, len);
1034 if (check_offs_len(mtd, ofs, len))
1037 nand_get_device(mtd, FL_LOCKING);
1039 /* Shift to get chip number */
1040 chipnr = ofs >> chip->chip_shift;
1042 chip->select_chip(mtd, chipnr);
1046 * If we want to check the WP through READ STATUS and check the bit 7
1047 * we must reset the chip
1048 * some operation can also clear the bit 7 of status register
1049 * eg. erase/program a locked block
1051 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
1053 /* Check, if it is write protected */
1054 if (nand_check_wp(mtd)) {
1055 pr_debug("%s: device is write protected!\n",
1057 status = MTD_ERASE_FAILED;
1062 /* Submit address of first page to lock */
1063 page = ofs >> chip->page_shift;
1064 chip->cmdfunc(mtd, NAND_CMD_LOCK, -1, page & chip->pagemask);
1066 /* Call wait ready function */
1067 status = chip->waitfunc(mtd, chip);
1068 /* See if device thinks it succeeded */
1069 if (status & NAND_STATUS_FAIL) {
1070 pr_debug("%s: error status = 0x%08x\n",
1076 ret = __nand_unlock(mtd, ofs, len, 0x1);
1079 chip->select_chip(mtd, -1);
1080 nand_release_device(mtd);
1084 EXPORT_SYMBOL(nand_lock);
1087 * nand_read_page_raw - [INTERN] read raw page data without ecc
1088 * @mtd: mtd info structure
1089 * @chip: nand chip info structure
1090 * @buf: buffer to store read data
1091 * @oob_required: caller requires OOB data read to chip->oob_poi
1092 * @page: page number to read
1094 * Not for syndrome calculating ECC controllers, which use a special oob layout.
1096 static int nand_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
1097 uint8_t *buf, int oob_required, int page)
1099 chip->read_buf(mtd, buf, mtd->writesize);
1101 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1106 * nand_read_page_raw_syndrome - [INTERN] read raw page data without ecc
1107 * @mtd: mtd info structure
1108 * @chip: nand chip info structure
1109 * @buf: buffer to store read data
1110 * @oob_required: caller requires OOB data read to chip->oob_poi
1111 * @page: page number to read
1113 * We need a special oob layout and handling even when OOB isn't used.
1115 static int nand_read_page_raw_syndrome(struct mtd_info *mtd,
1116 struct nand_chip *chip, uint8_t *buf,
1117 int oob_required, int page)
1119 int eccsize = chip->ecc.size;
1120 int eccbytes = chip->ecc.bytes;
1121 uint8_t *oob = chip->oob_poi;
1124 for (steps = chip->ecc.steps; steps > 0; steps--) {
1125 chip->read_buf(mtd, buf, eccsize);
1128 if (chip->ecc.prepad) {
1129 chip->read_buf(mtd, oob, chip->ecc.prepad);
1130 oob += chip->ecc.prepad;
1133 chip->read_buf(mtd, oob, eccbytes);
1136 if (chip->ecc.postpad) {
1137 chip->read_buf(mtd, oob, chip->ecc.postpad);
1138 oob += chip->ecc.postpad;
1142 size = mtd->oobsize - (oob - chip->oob_poi);
1144 chip->read_buf(mtd, oob, size);
1150 * nand_read_page_swecc - [REPLACEABLE] software ECC based page read function
1151 * @mtd: mtd info structure
1152 * @chip: nand chip info structure
1153 * @buf: buffer to store read data
1154 * @oob_required: caller requires OOB data read to chip->oob_poi
1155 * @page: page number to read
1157 static int nand_read_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
1158 uint8_t *buf, int oob_required, int page)
1160 int i, eccsize = chip->ecc.size;
1161 int eccbytes = chip->ecc.bytes;
1162 int eccsteps = chip->ecc.steps;
1164 uint8_t *ecc_calc = chip->buffers->ecccalc;
1165 uint8_t *ecc_code = chip->buffers->ecccode;
1166 uint32_t *eccpos = chip->ecc.layout->eccpos;
1167 unsigned int max_bitflips = 0;
1169 chip->ecc.read_page_raw(mtd, chip, buf, 1, page);
1171 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
1172 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1174 for (i = 0; i < chip->ecc.total; i++)
1175 ecc_code[i] = chip->oob_poi[eccpos[i]];
1177 eccsteps = chip->ecc.steps;
1180 for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1183 stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
1185 mtd->ecc_stats.failed++;
1187 mtd->ecc_stats.corrected += stat;
1188 max_bitflips = max_t(unsigned int, max_bitflips, stat);
1191 return max_bitflips;
1195 * nand_read_subpage - [REPLACEABLE] ECC based sub-page read function
1196 * @mtd: mtd info structure
1197 * @chip: nand chip info structure
1198 * @data_offs: offset of requested data within the page
1199 * @readlen: data length
1200 * @bufpoi: buffer to store read data
1201 * @page: page number to read
1203 static int nand_read_subpage(struct mtd_info *mtd, struct nand_chip *chip,
1204 uint32_t data_offs, uint32_t readlen, uint8_t *bufpoi,
1207 int start_step, end_step, num_steps;
1208 uint32_t *eccpos = chip->ecc.layout->eccpos;
1210 int data_col_addr, i, gaps = 0;
1211 int datafrag_len, eccfrag_len, aligned_len, aligned_pos;
1212 int busw = (chip->options & NAND_BUSWIDTH_16) ? 2 : 1;
1214 unsigned int max_bitflips = 0;
1216 /* Column address within the page aligned to ECC size (256bytes) */
1217 start_step = data_offs / chip->ecc.size;
1218 end_step = (data_offs + readlen - 1) / chip->ecc.size;
1219 num_steps = end_step - start_step + 1;
1220 index = start_step * chip->ecc.bytes;
1222 /* Data size aligned to ECC ecc.size */
1223 datafrag_len = num_steps * chip->ecc.size;
1224 eccfrag_len = num_steps * chip->ecc.bytes;
1226 data_col_addr = start_step * chip->ecc.size;
1227 /* If we read not a page aligned data */
1228 if (data_col_addr != 0)
1229 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, data_col_addr, -1);
1231 p = bufpoi + data_col_addr;
1232 chip->read_buf(mtd, p, datafrag_len);
1235 for (i = 0; i < eccfrag_len ; i += chip->ecc.bytes, p += chip->ecc.size)
1236 chip->ecc.calculate(mtd, p, &chip->buffers->ecccalc[i]);
1239 * The performance is faster if we position offsets according to
1240 * ecc.pos. Let's make sure that there are no gaps in ECC positions.
1242 for (i = 0; i < eccfrag_len - 1; i++) {
1243 if (eccpos[i + index] + 1 != eccpos[i + index + 1]) {
1249 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, mtd->writesize, -1);
1250 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1253 * Send the command to read the particular ECC bytes take care
1254 * about buswidth alignment in read_buf.
1256 aligned_pos = eccpos[index] & ~(busw - 1);
1257 aligned_len = eccfrag_len;
1258 if (eccpos[index] & (busw - 1))
1260 if (eccpos[index + (num_steps * chip->ecc.bytes)] & (busw - 1))
1263 chip->cmdfunc(mtd, NAND_CMD_RNDOUT,
1264 mtd->writesize + aligned_pos, -1);
1265 chip->read_buf(mtd, &chip->oob_poi[aligned_pos], aligned_len);
1268 for (i = 0; i < eccfrag_len; i++)
1269 chip->buffers->ecccode[i] = chip->oob_poi[eccpos[i + index]];
1271 p = bufpoi + data_col_addr;
1272 for (i = 0; i < eccfrag_len ; i += chip->ecc.bytes, p += chip->ecc.size) {
1275 stat = chip->ecc.correct(mtd, p,
1276 &chip->buffers->ecccode[i], &chip->buffers->ecccalc[i]);
1278 mtd->ecc_stats.failed++;
1280 mtd->ecc_stats.corrected += stat;
1281 max_bitflips = max_t(unsigned int, max_bitflips, stat);
1284 return max_bitflips;
1288 * nand_read_page_hwecc - [REPLACEABLE] hardware ECC based page read function
1289 * @mtd: mtd info structure
1290 * @chip: nand chip info structure
1291 * @buf: buffer to store read data
1292 * @oob_required: caller requires OOB data read to chip->oob_poi
1293 * @page: page number to read
1295 * Not for syndrome calculating ECC controllers which need a special oob layout.
1297 static int nand_read_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
1298 uint8_t *buf, int oob_required, int page)
1300 int i, eccsize = chip->ecc.size;
1301 int eccbytes = chip->ecc.bytes;
1302 int eccsteps = chip->ecc.steps;
1304 uint8_t *ecc_calc = chip->buffers->ecccalc;
1305 uint8_t *ecc_code = chip->buffers->ecccode;
1306 uint32_t *eccpos = chip->ecc.layout->eccpos;
1307 unsigned int max_bitflips = 0;
1309 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1310 chip->ecc.hwctl(mtd, NAND_ECC_READ);
1311 chip->read_buf(mtd, p, eccsize);
1312 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1314 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1316 for (i = 0; i < chip->ecc.total; i++)
1317 ecc_code[i] = chip->oob_poi[eccpos[i]];
1319 eccsteps = chip->ecc.steps;
1322 for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1325 stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
1327 mtd->ecc_stats.failed++;
1329 mtd->ecc_stats.corrected += stat;
1330 max_bitflips = max_t(unsigned int, max_bitflips, stat);
1333 return max_bitflips;
1337 * nand_read_page_hwecc_oob_first - [REPLACEABLE] hw ecc, read oob first
1338 * @mtd: mtd info structure
1339 * @chip: nand chip info structure
1340 * @buf: buffer to store read data
1341 * @oob_required: caller requires OOB data read to chip->oob_poi
1342 * @page: page number to read
1344 * Hardware ECC for large page chips, require OOB to be read first. For this
1345 * ECC mode, the write_page method is re-used from ECC_HW. These methods
1346 * read/write ECC from the OOB area, unlike the ECC_HW_SYNDROME support with
1347 * multiple ECC steps, follows the "infix ECC" scheme and reads/writes ECC from
1348 * the data area, by overwriting the NAND manufacturer bad block markings.
1350 static int nand_read_page_hwecc_oob_first(struct mtd_info *mtd,
1351 struct nand_chip *chip, uint8_t *buf, int oob_required, int page)
1353 int i, eccsize = chip->ecc.size;
1354 int eccbytes = chip->ecc.bytes;
1355 int eccsteps = chip->ecc.steps;
1357 uint8_t *ecc_code = chip->buffers->ecccode;
1358 uint32_t *eccpos = chip->ecc.layout->eccpos;
1359 uint8_t *ecc_calc = chip->buffers->ecccalc;
1360 unsigned int max_bitflips = 0;
1362 /* Read the OOB area first */
1363 chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
1364 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1365 chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);
1367 for (i = 0; i < chip->ecc.total; i++)
1368 ecc_code[i] = chip->oob_poi[eccpos[i]];
1370 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1373 chip->ecc.hwctl(mtd, NAND_ECC_READ);
1374 chip->read_buf(mtd, p, eccsize);
1375 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1377 stat = chip->ecc.correct(mtd, p, &ecc_code[i], NULL);
1379 mtd->ecc_stats.failed++;
1381 mtd->ecc_stats.corrected += stat;
1382 max_bitflips = max_t(unsigned int, max_bitflips, stat);
1385 return max_bitflips;
1389 * nand_read_page_syndrome - [REPLACEABLE] hardware ECC syndrome based page read
1390 * @mtd: mtd info structure
1391 * @chip: nand chip info structure
1392 * @buf: buffer to store read data
1393 * @oob_required: caller requires OOB data read to chip->oob_poi
1394 * @page: page number to read
1396 * The hw generator calculates the error syndrome automatically. Therefore we
1397 * need a special oob layout and handling.
1399 static int nand_read_page_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1400 uint8_t *buf, int oob_required, int page)
1402 int i, eccsize = chip->ecc.size;
1403 int eccbytes = chip->ecc.bytes;
1404 int eccsteps = chip->ecc.steps;
1406 uint8_t *oob = chip->oob_poi;
1407 unsigned int max_bitflips = 0;
1409 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1412 chip->ecc.hwctl(mtd, NAND_ECC_READ);
1413 chip->read_buf(mtd, p, eccsize);
1415 if (chip->ecc.prepad) {
1416 chip->read_buf(mtd, oob, chip->ecc.prepad);
1417 oob += chip->ecc.prepad;
1420 chip->ecc.hwctl(mtd, NAND_ECC_READSYN);
1421 chip->read_buf(mtd, oob, eccbytes);
1422 stat = chip->ecc.correct(mtd, p, oob, NULL);
1425 mtd->ecc_stats.failed++;
1427 mtd->ecc_stats.corrected += stat;
1428 max_bitflips = max_t(unsigned int, max_bitflips, stat);
1433 if (chip->ecc.postpad) {
1434 chip->read_buf(mtd, oob, chip->ecc.postpad);
1435 oob += chip->ecc.postpad;
1439 /* Calculate remaining oob bytes */
1440 i = mtd->oobsize - (oob - chip->oob_poi);
1442 chip->read_buf(mtd, oob, i);
1444 return max_bitflips;
1448 * nand_transfer_oob - [INTERN] Transfer oob to client buffer
1449 * @chip: nand chip structure
1450 * @oob: oob destination address
1451 * @ops: oob ops structure
1452 * @len: size of oob to transfer
1454 static uint8_t *nand_transfer_oob(struct nand_chip *chip, uint8_t *oob,
1455 struct mtd_oob_ops *ops, size_t len)
1457 switch (ops->mode) {
1459 case MTD_OPS_PLACE_OOB:
1461 memcpy(oob, chip->oob_poi + ops->ooboffs, len);
1464 case MTD_OPS_AUTO_OOB: {
1465 struct nand_oobfree *free = chip->ecc.layout->oobfree;
1466 uint32_t boffs = 0, roffs = ops->ooboffs;
1469 for (; free->length && len; free++, len -= bytes) {
1470 /* Read request not from offset 0? */
1471 if (unlikely(roffs)) {
1472 if (roffs >= free->length) {
1473 roffs -= free->length;
1476 boffs = free->offset + roffs;
1477 bytes = min_t(size_t, len,
1478 (free->length - roffs));
1481 bytes = min_t(size_t, len, free->length);
1482 boffs = free->offset;
1484 memcpy(oob, chip->oob_poi + boffs, bytes);
1496 * nand_setup_read_retry - [INTERN] Set the READ RETRY mode
1497 * @mtd: MTD device structure
1498 * @retry_mode: the retry mode to use
1500 * Some vendors supply a special command to shift the Vt threshold, to be used
1501 * when there are too many bitflips in a page (i.e., ECC error). After setting
1502 * a new threshold, the host should retry reading the page.
1504 static int nand_setup_read_retry(struct mtd_info *mtd, int retry_mode)
1506 struct nand_chip *chip = mtd->priv;
1508 pr_debug("setting READ RETRY mode %d\n", retry_mode);
1510 if (retry_mode >= chip->read_retries)
1513 if (!chip->setup_read_retry)
1516 return chip->setup_read_retry(mtd, retry_mode);
1520 * nand_do_read_ops - [INTERN] Read data with ECC
1521 * @mtd: MTD device structure
1522 * @from: offset to read from
1523 * @ops: oob ops structure
1525 * Internal function. Called with chip held.
1527 static int nand_do_read_ops(struct mtd_info *mtd, loff_t from,
1528 struct mtd_oob_ops *ops)
1530 int chipnr, page, realpage, col, bytes, aligned, oob_required;
1531 struct nand_chip *chip = mtd->priv;
1533 uint32_t readlen = ops->len;
1534 uint32_t oobreadlen = ops->ooblen;
1535 uint32_t max_oobsize = ops->mode == MTD_OPS_AUTO_OOB ?
1536 mtd->oobavail : mtd->oobsize;
1538 uint8_t *bufpoi, *oob, *buf;
1540 unsigned int max_bitflips = 0;
1542 bool ecc_fail = false;
1544 chipnr = (int)(from >> chip->chip_shift);
1545 chip->select_chip(mtd, chipnr);
1547 realpage = (int)(from >> chip->page_shift);
1548 page = realpage & chip->pagemask;
1550 col = (int)(from & (mtd->writesize - 1));
1554 oob_required = oob ? 1 : 0;
1557 unsigned int ecc_failures = mtd->ecc_stats.failed;
1559 bytes = min(mtd->writesize - col, readlen);
1560 aligned = (bytes == mtd->writesize);
1564 else if (chip->options & NAND_USE_BOUNCE_BUFFER)
1565 use_bufpoi = !virt_addr_valid(buf);
1569 /* Is the current page in the buffer? */
1570 if (realpage != chip->pagebuf || oob) {
1571 bufpoi = use_bufpoi ? chip->buffers->databuf : buf;
1573 if (use_bufpoi && aligned)
1574 pr_debug("%s: using read bounce buffer for buf@%p\n",
1578 chip->cmdfunc(mtd, NAND_CMD_READ0, 0x00, page);
1581 * Now read the page into the buffer. Absent an error,
1582 * the read methods return max bitflips per ecc step.
1584 if (unlikely(ops->mode == MTD_OPS_RAW))
1585 ret = chip->ecc.read_page_raw(mtd, chip, bufpoi,
1588 else if (!aligned && NAND_HAS_SUBPAGE_READ(chip) &&
1590 ret = chip->ecc.read_subpage(mtd, chip,
1594 ret = chip->ecc.read_page(mtd, chip, bufpoi,
1595 oob_required, page);
1598 /* Invalidate page cache */
1603 max_bitflips = max_t(unsigned int, max_bitflips, ret);
1605 /* Transfer not aligned data */
1607 if (!NAND_HAS_SUBPAGE_READ(chip) && !oob &&
1608 !(mtd->ecc_stats.failed - ecc_failures) &&
1609 (ops->mode != MTD_OPS_RAW)) {
1610 chip->pagebuf = realpage;
1611 chip->pagebuf_bitflips = ret;
1613 /* Invalidate page cache */
1616 memcpy(buf, chip->buffers->databuf + col, bytes);
1619 if (unlikely(oob)) {
1620 int toread = min(oobreadlen, max_oobsize);
1623 oob = nand_transfer_oob(chip,
1625 oobreadlen -= toread;
1629 if (chip->options & NAND_NEED_READRDY) {
1630 /* Apply delay or wait for ready/busy pin */
1631 if (!chip->dev_ready)
1632 udelay(chip->chip_delay);
1634 nand_wait_ready(mtd);
1637 if (mtd->ecc_stats.failed - ecc_failures) {
1638 if (retry_mode + 1 < chip->read_retries) {
1640 ret = nand_setup_read_retry(mtd,
1645 /* Reset failures; retry */
1646 mtd->ecc_stats.failed = ecc_failures;
1649 /* No more retry modes; real failure */
1656 memcpy(buf, chip->buffers->databuf + col, bytes);
1658 max_bitflips = max_t(unsigned int, max_bitflips,
1659 chip->pagebuf_bitflips);
1664 /* Reset to retry mode 0 */
1666 ret = nand_setup_read_retry(mtd, 0);
1675 /* For subsequent reads align to page boundary */
1677 /* Increment page address */
1680 page = realpage & chip->pagemask;
1681 /* Check, if we cross a chip boundary */
1684 chip->select_chip(mtd, -1);
1685 chip->select_chip(mtd, chipnr);
1688 chip->select_chip(mtd, -1);
1690 ops->retlen = ops->len - (size_t) readlen;
1692 ops->oobretlen = ops->ooblen - oobreadlen;
1700 return max_bitflips;
1704 * nand_read - [MTD Interface] MTD compatibility function for nand_do_read_ecc
1705 * @mtd: MTD device structure
1706 * @from: offset to read from
1707 * @len: number of bytes to read
1708 * @retlen: pointer to variable to store the number of read bytes
1709 * @buf: the databuffer to put data
1711 * Get hold of the chip and call nand_do_read.
1713 static int nand_read(struct mtd_info *mtd, loff_t from, size_t len,
1714 size_t *retlen, uint8_t *buf)
1716 struct mtd_oob_ops ops;
1719 nand_get_device(mtd, FL_READING);
1723 ops.mode = MTD_OPS_PLACE_OOB;
1724 ret = nand_do_read_ops(mtd, from, &ops);
1725 *retlen = ops.retlen;
1726 nand_release_device(mtd);
1731 * nand_read_oob_std - [REPLACEABLE] the most common OOB data read function
1732 * @mtd: mtd info structure
1733 * @chip: nand chip info structure
1734 * @page: page number to read
1736 static int nand_read_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
1739 chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
1740 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1745 * nand_read_oob_syndrome - [REPLACEABLE] OOB data read function for HW ECC
1747 * @mtd: mtd info structure
1748 * @chip: nand chip info structure
1749 * @page: page number to read
1751 static int nand_read_oob_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1754 uint8_t *buf = chip->oob_poi;
1755 int length = mtd->oobsize;
1756 int chunk = chip->ecc.bytes + chip->ecc.prepad + chip->ecc.postpad;
1757 int eccsize = chip->ecc.size;
1758 uint8_t *bufpoi = buf;
1759 int i, toread, sndrnd = 0, pos;
1761 chip->cmdfunc(mtd, NAND_CMD_READ0, chip->ecc.size, page);
1762 for (i = 0; i < chip->ecc.steps; i++) {
1764 pos = eccsize + i * (eccsize + chunk);
1765 if (mtd->writesize > 512)
1766 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, pos, -1);
1768 chip->cmdfunc(mtd, NAND_CMD_READ0, pos, page);
1771 toread = min_t(int, length, chunk);
1772 chip->read_buf(mtd, bufpoi, toread);
1777 chip->read_buf(mtd, bufpoi, length);
1783 * nand_write_oob_std - [REPLACEABLE] the most common OOB data write function
1784 * @mtd: mtd info structure
1785 * @chip: nand chip info structure
1786 * @page: page number to write
1788 static int nand_write_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
1792 const uint8_t *buf = chip->oob_poi;
1793 int length = mtd->oobsize;
1795 chip->cmdfunc(mtd, NAND_CMD_SEQIN, mtd->writesize, page);
1796 chip->write_buf(mtd, buf, length);
1797 /* Send command to program the OOB data */
1798 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1800 status = chip->waitfunc(mtd, chip);
1802 return status & NAND_STATUS_FAIL ? -EIO : 0;
1806 * nand_write_oob_syndrome - [REPLACEABLE] OOB data write function for HW ECC
1807 * with syndrome - only for large page flash
1808 * @mtd: mtd info structure
1809 * @chip: nand chip info structure
1810 * @page: page number to write
1812 static int nand_write_oob_syndrome(struct mtd_info *mtd,
1813 struct nand_chip *chip, int page)
1815 int chunk = chip->ecc.bytes + chip->ecc.prepad + chip->ecc.postpad;
1816 int eccsize = chip->ecc.size, length = mtd->oobsize;
1817 int i, len, pos, status = 0, sndcmd = 0, steps = chip->ecc.steps;
1818 const uint8_t *bufpoi = chip->oob_poi;
1821 * data-ecc-data-ecc ... ecc-oob
1823 * data-pad-ecc-pad-data-pad .... ecc-pad-oob
1825 if (!chip->ecc.prepad && !chip->ecc.postpad) {
1826 pos = steps * (eccsize + chunk);
1831 chip->cmdfunc(mtd, NAND_CMD_SEQIN, pos, page);
1832 for (i = 0; i < steps; i++) {
1834 if (mtd->writesize <= 512) {
1835 uint32_t fill = 0xFFFFFFFF;
1839 int num = min_t(int, len, 4);
1840 chip->write_buf(mtd, (uint8_t *)&fill,
1845 pos = eccsize + i * (eccsize + chunk);
1846 chip->cmdfunc(mtd, NAND_CMD_RNDIN, pos, -1);
1850 len = min_t(int, length, chunk);
1851 chip->write_buf(mtd, bufpoi, len);
1856 chip->write_buf(mtd, bufpoi, length);
1858 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1859 status = chip->waitfunc(mtd, chip);
1861 return status & NAND_STATUS_FAIL ? -EIO : 0;
1865 * nand_do_read_oob - [INTERN] NAND read out-of-band
1866 * @mtd: MTD device structure
1867 * @from: offset to read from
1868 * @ops: oob operations description structure
1870 * NAND read out-of-band data from the spare area.
1872 static int nand_do_read_oob(struct mtd_info *mtd, loff_t from,
1873 struct mtd_oob_ops *ops)
1875 int page, realpage, chipnr;
1876 struct nand_chip *chip = mtd->priv;
1877 struct mtd_ecc_stats stats;
1878 int readlen = ops->ooblen;
1880 uint8_t *buf = ops->oobbuf;
1883 pr_debug("%s: from = 0x%08Lx, len = %i\n",
1884 __func__, (unsigned long long)from, readlen);
1886 stats = mtd->ecc_stats;
1888 if (ops->mode == MTD_OPS_AUTO_OOB)
1889 len = chip->ecc.layout->oobavail;
1893 if (unlikely(ops->ooboffs >= len)) {
1894 pr_debug("%s: attempt to start read outside oob\n",
1899 /* Do not allow reads past end of device */
1900 if (unlikely(from >= mtd->size ||
1901 ops->ooboffs + readlen > ((mtd->size >> chip->page_shift) -
1902 (from >> chip->page_shift)) * len)) {
1903 pr_debug("%s: attempt to read beyond end of device\n",
1908 chipnr = (int)(from >> chip->chip_shift);
1909 chip->select_chip(mtd, chipnr);
1911 /* Shift to get page */
1912 realpage = (int)(from >> chip->page_shift);
1913 page = realpage & chip->pagemask;
1916 if (ops->mode == MTD_OPS_RAW)
1917 ret = chip->ecc.read_oob_raw(mtd, chip, page);
1919 ret = chip->ecc.read_oob(mtd, chip, page);
1924 len = min(len, readlen);
1925 buf = nand_transfer_oob(chip, buf, ops, len);
1927 if (chip->options & NAND_NEED_READRDY) {
1928 /* Apply delay or wait for ready/busy pin */
1929 if (!chip->dev_ready)
1930 udelay(chip->chip_delay);
1932 nand_wait_ready(mtd);
1939 /* Increment page address */
1942 page = realpage & chip->pagemask;
1943 /* Check, if we cross a chip boundary */
1946 chip->select_chip(mtd, -1);
1947 chip->select_chip(mtd, chipnr);
1950 chip->select_chip(mtd, -1);
1952 ops->oobretlen = ops->ooblen - readlen;
1957 if (mtd->ecc_stats.failed - stats.failed)
1960 return mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
1964 * nand_read_oob - [MTD Interface] NAND read data and/or out-of-band
1965 * @mtd: MTD device structure
1966 * @from: offset to read from
1967 * @ops: oob operation description structure
1969 * NAND read data and/or out-of-band data.
1971 static int nand_read_oob(struct mtd_info *mtd, loff_t from,
1972 struct mtd_oob_ops *ops)
1974 int ret = -ENOTSUPP;
1978 /* Do not allow reads past end of device */
1979 if (ops->datbuf && (from + ops->len) > mtd->size) {
1980 pr_debug("%s: attempt to read beyond end of device\n",
1985 nand_get_device(mtd, FL_READING);
1987 switch (ops->mode) {
1988 case MTD_OPS_PLACE_OOB:
1989 case MTD_OPS_AUTO_OOB:
1998 ret = nand_do_read_oob(mtd, from, ops);
2000 ret = nand_do_read_ops(mtd, from, ops);
2003 nand_release_device(mtd);
2009 * nand_write_page_raw - [INTERN] raw page write function
2010 * @mtd: mtd info structure
2011 * @chip: nand chip info structure
2013 * @oob_required: must write chip->oob_poi to OOB
2015 * Not for syndrome calculating ECC controllers, which use a special oob layout.
2017 static int nand_write_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
2018 const uint8_t *buf, int oob_required)
2020 chip->write_buf(mtd, buf, mtd->writesize);
2022 chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
2028 * nand_write_page_raw_syndrome - [INTERN] raw page write function
2029 * @mtd: mtd info structure
2030 * @chip: nand chip info structure
2032 * @oob_required: must write chip->oob_poi to OOB
2034 * We need a special oob layout and handling even when ECC isn't checked.
2036 static int nand_write_page_raw_syndrome(struct mtd_info *mtd,
2037 struct nand_chip *chip,
2038 const uint8_t *buf, int oob_required)
2040 int eccsize = chip->ecc.size;
2041 int eccbytes = chip->ecc.bytes;
2042 uint8_t *oob = chip->oob_poi;
2045 for (steps = chip->ecc.steps; steps > 0; steps--) {
2046 chip->write_buf(mtd, buf, eccsize);
2049 if (chip->ecc.prepad) {
2050 chip->write_buf(mtd, oob, chip->ecc.prepad);
2051 oob += chip->ecc.prepad;
2054 chip->write_buf(mtd, oob, eccbytes);
2057 if (chip->ecc.postpad) {
2058 chip->write_buf(mtd, oob, chip->ecc.postpad);
2059 oob += chip->ecc.postpad;
2063 size = mtd->oobsize - (oob - chip->oob_poi);
2065 chip->write_buf(mtd, oob, size);
2070 * nand_write_page_swecc - [REPLACEABLE] software ECC based page write function
2071 * @mtd: mtd info structure
2072 * @chip: nand chip info structure
2074 * @oob_required: must write chip->oob_poi to OOB
2076 static int nand_write_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
2077 const uint8_t *buf, int oob_required)
2079 int i, eccsize = chip->ecc.size;
2080 int eccbytes = chip->ecc.bytes;
2081 int eccsteps = chip->ecc.steps;
2082 uint8_t *ecc_calc = chip->buffers->ecccalc;
2083 const uint8_t *p = buf;
2084 uint32_t *eccpos = chip->ecc.layout->eccpos;
2086 /* Software ECC calculation */
2087 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
2088 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
2090 for (i = 0; i < chip->ecc.total; i++)
2091 chip->oob_poi[eccpos[i]] = ecc_calc[i];
2093 return chip->ecc.write_page_raw(mtd, chip, buf, 1);
2097 * nand_write_page_hwecc - [REPLACEABLE] hardware ECC based page write function
2098 * @mtd: mtd info structure
2099 * @chip: nand chip info structure
2101 * @oob_required: must write chip->oob_poi to OOB
2103 static int nand_write_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
2104 const uint8_t *buf, int oob_required)
2106 int i, eccsize = chip->ecc.size;
2107 int eccbytes = chip->ecc.bytes;
2108 int eccsteps = chip->ecc.steps;
2109 uint8_t *ecc_calc = chip->buffers->ecccalc;
2110 const uint8_t *p = buf;
2111 uint32_t *eccpos = chip->ecc.layout->eccpos;
2113 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
2114 chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
2115 chip->write_buf(mtd, p, eccsize);
2116 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
2119 for (i = 0; i < chip->ecc.total; i++)
2120 chip->oob_poi[eccpos[i]] = ecc_calc[i];
2122 chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
2129 * nand_write_subpage_hwecc - [REPLACABLE] hardware ECC based subpage write
2130 * @mtd: mtd info structure
2131 * @chip: nand chip info structure
2132 * @offset: column address of subpage within the page
2133 * @data_len: data length
2135 * @oob_required: must write chip->oob_poi to OOB
2137 static int nand_write_subpage_hwecc(struct mtd_info *mtd,
2138 struct nand_chip *chip, uint32_t offset,
2139 uint32_t data_len, const uint8_t *buf,
2142 uint8_t *oob_buf = chip->oob_poi;
2143 uint8_t *ecc_calc = chip->buffers->ecccalc;
2144 int ecc_size = chip->ecc.size;
2145 int ecc_bytes = chip->ecc.bytes;
2146 int ecc_steps = chip->ecc.steps;
2147 uint32_t *eccpos = chip->ecc.layout->eccpos;
2148 uint32_t start_step = offset / ecc_size;
2149 uint32_t end_step = (offset + data_len - 1) / ecc_size;
2150 int oob_bytes = mtd->oobsize / ecc_steps;
2153 for (step = 0; step < ecc_steps; step++) {
2154 /* configure controller for WRITE access */
2155 chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
2157 /* write data (untouched subpages already masked by 0xFF) */
2158 chip->write_buf(mtd, buf, ecc_size);
2160 /* mask ECC of un-touched subpages by padding 0xFF */
2161 if ((step < start_step) || (step > end_step))
2162 memset(ecc_calc, 0xff, ecc_bytes);
2164 chip->ecc.calculate(mtd, buf, ecc_calc);
2166 /* mask OOB of un-touched subpages by padding 0xFF */
2167 /* if oob_required, preserve OOB metadata of written subpage */
2168 if (!oob_required || (step < start_step) || (step > end_step))
2169 memset(oob_buf, 0xff, oob_bytes);
2172 ecc_calc += ecc_bytes;
2173 oob_buf += oob_bytes;
2176 /* copy calculated ECC for whole page to chip->buffer->oob */
2177 /* this include masked-value(0xFF) for unwritten subpages */
2178 ecc_calc = chip->buffers->ecccalc;
2179 for (i = 0; i < chip->ecc.total; i++)
2180 chip->oob_poi[eccpos[i]] = ecc_calc[i];
2182 /* write OOB buffer to NAND device */
2183 chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
2190 * nand_write_page_syndrome - [REPLACEABLE] hardware ECC syndrome based page write
2191 * @mtd: mtd info structure
2192 * @chip: nand chip info structure
2194 * @oob_required: must write chip->oob_poi to OOB
2196 * The hw generator calculates the error syndrome automatically. Therefore we
2197 * need a special oob layout and handling.
2199 static int nand_write_page_syndrome(struct mtd_info *mtd,
2200 struct nand_chip *chip,
2201 const uint8_t *buf, int oob_required)
2203 int i, eccsize = chip->ecc.size;
2204 int eccbytes = chip->ecc.bytes;
2205 int eccsteps = chip->ecc.steps;
2206 const uint8_t *p = buf;
2207 uint8_t *oob = chip->oob_poi;
2209 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
2211 chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
2212 chip->write_buf(mtd, p, eccsize);
2214 if (chip->ecc.prepad) {
2215 chip->write_buf(mtd, oob, chip->ecc.prepad);
2216 oob += chip->ecc.prepad;
2219 chip->ecc.calculate(mtd, p, oob);
2220 chip->write_buf(mtd, oob, eccbytes);
2223 if (chip->ecc.postpad) {
2224 chip->write_buf(mtd, oob, chip->ecc.postpad);
2225 oob += chip->ecc.postpad;
2229 /* Calculate remaining oob bytes */
2230 i = mtd->oobsize - (oob - chip->oob_poi);
2232 chip->write_buf(mtd, oob, i);
2238 * nand_write_page - [REPLACEABLE] write one page
2239 * @mtd: MTD device structure
2240 * @chip: NAND chip descriptor
2241 * @offset: address offset within the page
2242 * @data_len: length of actual data to be written
2243 * @buf: the data to write
2244 * @oob_required: must write chip->oob_poi to OOB
2245 * @page: page number to write
2246 * @cached: cached programming
2247 * @raw: use _raw version of write_page
2249 static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,
2250 uint32_t offset, int data_len, const uint8_t *buf,
2251 int oob_required, int page, int cached, int raw)
2253 int status, subpage;
2255 if (!(chip->options & NAND_NO_SUBPAGE_WRITE) &&
2256 chip->ecc.write_subpage)
2257 subpage = offset || (data_len < mtd->writesize);
2261 chip->cmdfunc(mtd, NAND_CMD_SEQIN, 0x00, page);
2264 status = chip->ecc.write_page_raw(mtd, chip, buf,
2267 status = chip->ecc.write_subpage(mtd, chip, offset, data_len,
2270 status = chip->ecc.write_page(mtd, chip, buf, oob_required);
2276 * Cached progamming disabled for now. Not sure if it's worth the
2277 * trouble. The speed gain is not very impressive. (2.3->2.6Mib/s).
2281 if (!cached || !NAND_HAS_CACHEPROG(chip)) {
2283 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
2284 status = chip->waitfunc(mtd, chip);
2286 * See if operation failed and additional status checks are
2289 if ((status & NAND_STATUS_FAIL) && (chip->errstat))
2290 status = chip->errstat(mtd, chip, FL_WRITING, status,
2293 if (status & NAND_STATUS_FAIL)
2296 chip->cmdfunc(mtd, NAND_CMD_CACHEDPROG, -1, -1);
2297 status = chip->waitfunc(mtd, chip);
2304 * nand_fill_oob - [INTERN] Transfer client buffer to oob
2305 * @mtd: MTD device structure
2306 * @oob: oob data buffer
2307 * @len: oob data write length
2308 * @ops: oob ops structure
2310 static uint8_t *nand_fill_oob(struct mtd_info *mtd, uint8_t *oob, size_t len,
2311 struct mtd_oob_ops *ops)
2313 struct nand_chip *chip = mtd->priv;
2316 * Initialise to all 0xFF, to avoid the possibility of left over OOB
2317 * data from a previous OOB read.
2319 memset(chip->oob_poi, 0xff, mtd->oobsize);
2321 switch (ops->mode) {
2323 case MTD_OPS_PLACE_OOB:
2325 memcpy(chip->oob_poi + ops->ooboffs, oob, len);
2328 case MTD_OPS_AUTO_OOB: {
2329 struct nand_oobfree *free = chip->ecc.layout->oobfree;
2330 uint32_t boffs = 0, woffs = ops->ooboffs;
2333 for (; free->length && len; free++, len -= bytes) {
2334 /* Write request not from offset 0? */
2335 if (unlikely(woffs)) {
2336 if (woffs >= free->length) {
2337 woffs -= free->length;
2340 boffs = free->offset + woffs;
2341 bytes = min_t(size_t, len,
2342 (free->length - woffs));
2345 bytes = min_t(size_t, len, free->length);
2346 boffs = free->offset;
2348 memcpy(chip->oob_poi + boffs, oob, bytes);
2359 #define NOTALIGNED(x) ((x & (chip->subpagesize - 1)) != 0)
2362 * nand_do_write_ops - [INTERN] NAND write with ECC
2363 * @mtd: MTD device structure
2364 * @to: offset to write to
2365 * @ops: oob operations description structure
2367 * NAND write with ECC.
2369 static int nand_do_write_ops(struct mtd_info *mtd, loff_t to,
2370 struct mtd_oob_ops *ops)
2372 int chipnr, realpage, page, blockmask, column;
2373 struct nand_chip *chip = mtd->priv;
2374 uint32_t writelen = ops->len;
2376 uint32_t oobwritelen = ops->ooblen;
2377 uint32_t oobmaxlen = ops->mode == MTD_OPS_AUTO_OOB ?
2378 mtd->oobavail : mtd->oobsize;
2380 uint8_t *oob = ops->oobbuf;
2381 uint8_t *buf = ops->datbuf;
2383 int oob_required = oob ? 1 : 0;
2389 /* Reject writes, which are not page aligned */
2390 if (NOTALIGNED(to) || NOTALIGNED(ops->len)) {
2391 pr_notice("%s: attempt to write non page aligned data\n",
2396 column = to & (mtd->writesize - 1);
2398 chipnr = (int)(to >> chip->chip_shift);
2399 chip->select_chip(mtd, chipnr);
2401 /* Check, if it is write protected */
2402 if (nand_check_wp(mtd)) {
2407 realpage = (int)(to >> chip->page_shift);
2408 page = realpage & chip->pagemask;
2409 blockmask = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
2411 /* Invalidate the page cache, when we write to the cached page */
2412 if (to <= ((loff_t)chip->pagebuf << chip->page_shift) &&
2413 ((loff_t)chip->pagebuf << chip->page_shift) < (to + ops->len))
2416 /* Don't allow multipage oob writes with offset */
2417 if (oob && ops->ooboffs && (ops->ooboffs + ops->ooblen > oobmaxlen)) {
2423 int bytes = mtd->writesize;
2424 int cached = writelen > bytes && page != blockmask;
2425 uint8_t *wbuf = buf;
2427 int part_pagewr = (column || writelen < (mtd->writesize - 1));
2431 else if (chip->options & NAND_USE_BOUNCE_BUFFER)
2432 use_bufpoi = !virt_addr_valid(buf);
2436 /* Partial page write?, or need to use bounce buffer */
2438 pr_debug("%s: using write bounce buffer for buf@%p\n",
2442 bytes = min_t(int, bytes - column, writelen);
2444 memset(chip->buffers->databuf, 0xff, mtd->writesize);
2445 memcpy(&chip->buffers->databuf[column], buf, bytes);
2446 wbuf = chip->buffers->databuf;
2449 if (unlikely(oob)) {
2450 size_t len = min(oobwritelen, oobmaxlen);
2451 oob = nand_fill_oob(mtd, oob, len, ops);
2454 /* We still need to erase leftover OOB data */
2455 memset(chip->oob_poi, 0xff, mtd->oobsize);
2457 ret = chip->write_page(mtd, chip, column, bytes, wbuf,
2458 oob_required, page, cached,
2459 (ops->mode == MTD_OPS_RAW));
2471 page = realpage & chip->pagemask;
2472 /* Check, if we cross a chip boundary */
2475 chip->select_chip(mtd, -1);
2476 chip->select_chip(mtd, chipnr);
2480 ops->retlen = ops->len - writelen;
2482 ops->oobretlen = ops->ooblen;
2485 chip->select_chip(mtd, -1);
2490 * panic_nand_write - [MTD Interface] NAND write with ECC
2491 * @mtd: MTD device structure
2492 * @to: offset to write to
2493 * @len: number of bytes to write
2494 * @retlen: pointer to variable to store the number of written bytes
2495 * @buf: the data to write
2497 * NAND write with ECC. Used when performing writes in interrupt context, this
2498 * may for example be called by mtdoops when writing an oops while in panic.
2500 static int panic_nand_write(struct mtd_info *mtd, loff_t to, size_t len,
2501 size_t *retlen, const uint8_t *buf)
2503 struct nand_chip *chip = mtd->priv;
2504 struct mtd_oob_ops ops;
2507 /* Wait for the device to get ready */
2508 panic_nand_wait(mtd, chip, 400);
2510 /* Grab the device */
2511 panic_nand_get_device(chip, mtd, FL_WRITING);
2514 ops.datbuf = (uint8_t *)buf;
2516 ops.mode = MTD_OPS_PLACE_OOB;
2518 ret = nand_do_write_ops(mtd, to, &ops);
2520 *retlen = ops.retlen;
2525 * nand_write - [MTD Interface] NAND write with ECC
2526 * @mtd: MTD device structure
2527 * @to: offset to write to
2528 * @len: number of bytes to write
2529 * @retlen: pointer to variable to store the number of written bytes
2530 * @buf: the data to write
2532 * NAND write with ECC.
2534 static int nand_write(struct mtd_info *mtd, loff_t to, size_t len,
2535 size_t *retlen, const uint8_t *buf)
2537 struct mtd_oob_ops ops;
2540 nand_get_device(mtd, FL_WRITING);
2542 ops.datbuf = (uint8_t *)buf;
2544 ops.mode = MTD_OPS_PLACE_OOB;
2545 ret = nand_do_write_ops(mtd, to, &ops);
2546 *retlen = ops.retlen;
2547 nand_release_device(mtd);
2552 * nand_do_write_oob - [MTD Interface] NAND write out-of-band
2553 * @mtd: MTD device structure
2554 * @to: offset to write to
2555 * @ops: oob operation description structure
2557 * NAND write out-of-band.
2559 static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
2560 struct mtd_oob_ops *ops)
2562 int chipnr, page, status, len;
2563 struct nand_chip *chip = mtd->priv;
2565 pr_debug("%s: to = 0x%08x, len = %i\n",
2566 __func__, (unsigned int)to, (int)ops->ooblen);
2568 if (ops->mode == MTD_OPS_AUTO_OOB)
2569 len = chip->ecc.layout->oobavail;
2573 /* Do not allow write past end of page */
2574 if ((ops->ooboffs + ops->ooblen) > len) {
2575 pr_debug("%s: attempt to write past end of page\n",
2580 if (unlikely(ops->ooboffs >= len)) {
2581 pr_debug("%s: attempt to start write outside oob\n",
2586 /* Do not allow write past end of device */
2587 if (unlikely(to >= mtd->size ||
2588 ops->ooboffs + ops->ooblen >
2589 ((mtd->size >> chip->page_shift) -
2590 (to >> chip->page_shift)) * len)) {
2591 pr_debug("%s: attempt to write beyond end of device\n",
2596 chipnr = (int)(to >> chip->chip_shift);
2597 chip->select_chip(mtd, chipnr);
2599 /* Shift to get page */
2600 page = (int)(to >> chip->page_shift);
2603 * Reset the chip. Some chips (like the Toshiba TC5832DC found in one
2604 * of my DiskOnChip 2000 test units) will clear the whole data page too
2605 * if we don't do this. I have no clue why, but I seem to have 'fixed'
2606 * it in the doc2000 driver in August 1999. dwmw2.
2608 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
2610 /* Check, if it is write protected */
2611 if (nand_check_wp(mtd)) {
2612 chip->select_chip(mtd, -1);
2616 /* Invalidate the page cache, if we write to the cached page */
2617 if (page == chip->pagebuf)
2620 nand_fill_oob(mtd, ops->oobbuf, ops->ooblen, ops);
2622 if (ops->mode == MTD_OPS_RAW)
2623 status = chip->ecc.write_oob_raw(mtd, chip, page & chip->pagemask);
2625 status = chip->ecc.write_oob(mtd, chip, page & chip->pagemask);
2627 chip->select_chip(mtd, -1);
2632 ops->oobretlen = ops->ooblen;
2638 * nand_write_oob - [MTD Interface] NAND write data and/or out-of-band
2639 * @mtd: MTD device structure
2640 * @to: offset to write to
2641 * @ops: oob operation description structure
2643 static int nand_write_oob(struct mtd_info *mtd, loff_t to,
2644 struct mtd_oob_ops *ops)
2646 int ret = -ENOTSUPP;
2650 /* Do not allow writes past end of device */
2651 if (ops->datbuf && (to + ops->len) > mtd->size) {
2652 pr_debug("%s: attempt to write beyond end of device\n",
2657 nand_get_device(mtd, FL_WRITING);
2659 switch (ops->mode) {
2660 case MTD_OPS_PLACE_OOB:
2661 case MTD_OPS_AUTO_OOB:
2670 ret = nand_do_write_oob(mtd, to, ops);
2672 ret = nand_do_write_ops(mtd, to, ops);
2675 nand_release_device(mtd);
2680 * single_erase - [GENERIC] NAND standard block erase command function
2681 * @mtd: MTD device structure
2682 * @page: the page address of the block which will be erased
2684 * Standard erase command for NAND chips. Returns NAND status.
2686 static int single_erase(struct mtd_info *mtd, int page)
2688 struct nand_chip *chip = mtd->priv;
2689 /* Send commands to erase a block */
2690 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
2691 chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
2693 return chip->waitfunc(mtd, chip);
2697 * nand_erase - [MTD Interface] erase block(s)
2698 * @mtd: MTD device structure
2699 * @instr: erase instruction
2701 * Erase one ore more blocks.
2703 static int nand_erase(struct mtd_info *mtd, struct erase_info *instr)
2705 return nand_erase_nand(mtd, instr, 0);
2709 * nand_erase_nand - [INTERN] erase block(s)
2710 * @mtd: MTD device structure
2711 * @instr: erase instruction
2712 * @allowbbt: allow erasing the bbt area
2714 * Erase one ore more blocks.
2716 int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
2719 int page, status, pages_per_block, ret, chipnr;
2720 struct nand_chip *chip = mtd->priv;
2723 pr_debug("%s: start = 0x%012llx, len = %llu\n",
2724 __func__, (unsigned long long)instr->addr,
2725 (unsigned long long)instr->len);
2727 if (check_offs_len(mtd, instr->addr, instr->len))
2730 /* Grab the lock and see if the device is available */
2731 nand_get_device(mtd, FL_ERASING);
2733 /* Shift to get first page */
2734 page = (int)(instr->addr >> chip->page_shift);
2735 chipnr = (int)(instr->addr >> chip->chip_shift);
2737 /* Calculate pages in each block */
2738 pages_per_block = 1 << (chip->phys_erase_shift - chip->page_shift);
2740 /* Select the NAND device */
2741 chip->select_chip(mtd, chipnr);
2743 /* Check, if it is write protected */
2744 if (nand_check_wp(mtd)) {
2745 pr_debug("%s: device is write protected!\n",
2747 instr->state = MTD_ERASE_FAILED;
2751 /* Loop through the pages */
2754 instr->state = MTD_ERASING;
2757 /* Check if we have a bad block, we do not erase bad blocks! */
2758 if (nand_block_checkbad(mtd, ((loff_t) page) <<
2759 chip->page_shift, 0, allowbbt)) {
2760 pr_warn("%s: attempt to erase a bad block at page 0x%08x\n",
2762 instr->state = MTD_ERASE_FAILED;
2767 * Invalidate the page cache, if we erase the block which
2768 * contains the current cached page.
2770 if (page <= chip->pagebuf && chip->pagebuf <
2771 (page + pages_per_block))
2774 status = chip->erase(mtd, page & chip->pagemask);
2777 * See if operation failed and additional status checks are
2780 if ((status & NAND_STATUS_FAIL) && (chip->errstat))
2781 status = chip->errstat(mtd, chip, FL_ERASING,
2784 /* See if block erase succeeded */
2785 if (status & NAND_STATUS_FAIL) {
2786 pr_debug("%s: failed erase, page 0x%08x\n",
2788 instr->state = MTD_ERASE_FAILED;
2790 ((loff_t)page << chip->page_shift);
2794 /* Increment page address and decrement length */
2795 len -= (1ULL << chip->phys_erase_shift);
2796 page += pages_per_block;
2798 /* Check, if we cross a chip boundary */
2799 if (len && !(page & chip->pagemask)) {
2801 chip->select_chip(mtd, -1);
2802 chip->select_chip(mtd, chipnr);
2805 instr->state = MTD_ERASE_DONE;
2809 ret = instr->state == MTD_ERASE_DONE ? 0 : -EIO;
2811 /* Deselect and wake up anyone waiting on the device */
2812 chip->select_chip(mtd, -1);
2813 nand_release_device(mtd);
2815 /* Do call back function */
2817 mtd_erase_callback(instr);
2819 /* Return more or less happy */
2824 * nand_sync - [MTD Interface] sync
2825 * @mtd: MTD device structure
2827 * Sync is actually a wait for chip ready function.
2829 static void nand_sync(struct mtd_info *mtd)
2831 pr_debug("%s: called\n", __func__);
2833 /* Grab the lock and see if the device is available */
2834 nand_get_device(mtd, FL_SYNCING);
2835 /* Release it and go back */
2836 nand_release_device(mtd);
2840 * nand_block_isbad - [MTD Interface] Check if block at offset is bad
2841 * @mtd: MTD device structure
2842 * @offs: offset relative to mtd start
2844 static int nand_block_isbad(struct mtd_info *mtd, loff_t offs)
2846 return nand_block_checkbad(mtd, offs, 1, 0);
2850 * nand_block_markbad - [MTD Interface] Mark block at the given offset as bad
2851 * @mtd: MTD device structure
2852 * @ofs: offset relative to mtd start
2854 static int nand_block_markbad(struct mtd_info *mtd, loff_t ofs)
2858 ret = nand_block_isbad(mtd, ofs);
2860 /* If it was bad already, return success and do nothing */
2866 return nand_block_markbad_lowlevel(mtd, ofs);
2870 * nand_onfi_set_features- [REPLACEABLE] set features for ONFI nand
2871 * @mtd: MTD device structure
2872 * @chip: nand chip info structure
2873 * @addr: feature address.
2874 * @subfeature_param: the subfeature parameters, a four bytes array.
2876 static int nand_onfi_set_features(struct mtd_info *mtd, struct nand_chip *chip,
2877 int addr, uint8_t *subfeature_param)
2882 if (!chip->onfi_version ||
2883 !(le16_to_cpu(chip->onfi_params.opt_cmd)
2884 & ONFI_OPT_CMD_SET_GET_FEATURES))
2887 chip->cmdfunc(mtd, NAND_CMD_SET_FEATURES, addr, -1);
2888 for (i = 0; i < ONFI_SUBFEATURE_PARAM_LEN; ++i)
2889 chip->write_byte(mtd, subfeature_param[i]);
2891 status = chip->waitfunc(mtd, chip);
2892 if (status & NAND_STATUS_FAIL)
2898 * nand_onfi_get_features- [REPLACEABLE] get features for ONFI nand
2899 * @mtd: MTD device structure
2900 * @chip: nand chip info structure
2901 * @addr: feature address.
2902 * @subfeature_param: the subfeature parameters, a four bytes array.
2904 static int nand_onfi_get_features(struct mtd_info *mtd, struct nand_chip *chip,
2905 int addr, uint8_t *subfeature_param)
2909 if (!chip->onfi_version ||
2910 !(le16_to_cpu(chip->onfi_params.opt_cmd)
2911 & ONFI_OPT_CMD_SET_GET_FEATURES))
2914 /* clear the sub feature parameters */
2915 memset(subfeature_param, 0, ONFI_SUBFEATURE_PARAM_LEN);
2917 chip->cmdfunc(mtd, NAND_CMD_GET_FEATURES, addr, -1);
2918 for (i = 0; i < ONFI_SUBFEATURE_PARAM_LEN; ++i)
2919 *subfeature_param++ = chip->read_byte(mtd);
2924 * nand_suspend - [MTD Interface] Suspend the NAND flash
2925 * @mtd: MTD device structure
2927 static int nand_suspend(struct mtd_info *mtd)
2929 return nand_get_device(mtd, FL_PM_SUSPENDED);
2933 * nand_resume - [MTD Interface] Resume the NAND flash
2934 * @mtd: MTD device structure
2936 static void nand_resume(struct mtd_info *mtd)
2938 struct nand_chip *chip = mtd->priv;
2940 if (chip->state == FL_PM_SUSPENDED)
2941 nand_release_device(mtd);
2943 pr_err("%s called for a chip which is not in suspended state\n",
2947 /* Set default functions */
2948 static void nand_set_defaults(struct nand_chip *chip, int busw)
2950 /* check for proper chip_delay setup, set 20us if not */
2951 if (!chip->chip_delay)
2952 chip->chip_delay = 20;
2954 /* check, if a user supplied command function given */
2955 if (chip->cmdfunc == NULL)
2956 chip->cmdfunc = nand_command;
2958 /* check, if a user supplied wait function given */
2959 if (chip->waitfunc == NULL)
2960 chip->waitfunc = nand_wait;
2962 if (!chip->select_chip)
2963 chip->select_chip = nand_select_chip;
2965 /* set for ONFI nand */
2966 if (!chip->onfi_set_features)
2967 chip->onfi_set_features = nand_onfi_set_features;
2968 if (!chip->onfi_get_features)
2969 chip->onfi_get_features = nand_onfi_get_features;
2971 /* If called twice, pointers that depend on busw may need to be reset */
2972 if (!chip->read_byte || chip->read_byte == nand_read_byte)
2973 chip->read_byte = busw ? nand_read_byte16 : nand_read_byte;
2974 if (!chip->read_word)
2975 chip->read_word = nand_read_word;
2976 if (!chip->block_bad)
2977 chip->block_bad = nand_block_bad;
2978 if (!chip->block_markbad)
2979 chip->block_markbad = nand_default_block_markbad;
2980 if (!chip->write_buf || chip->write_buf == nand_write_buf)
2981 chip->write_buf = busw ? nand_write_buf16 : nand_write_buf;
2982 if (!chip->write_byte || chip->write_byte == nand_write_byte)
2983 chip->write_byte = busw ? nand_write_byte16 : nand_write_byte;
2984 if (!chip->read_buf || chip->read_buf == nand_read_buf)
2985 chip->read_buf = busw ? nand_read_buf16 : nand_read_buf;
2986 if (!chip->scan_bbt)
2987 chip->scan_bbt = nand_default_bbt;
2989 if (!chip->controller) {
2990 chip->controller = &chip->hwcontrol;
2991 spin_lock_init(&chip->controller->lock);
2992 init_waitqueue_head(&chip->controller->wq);
2997 /* Sanitize ONFI strings so we can safely print them */
2998 static void sanitize_string(uint8_t *s, size_t len)
3002 /* Null terminate */
3005 /* Remove non printable chars */
3006 for (i = 0; i < len - 1; i++) {
3007 if (s[i] < ' ' || s[i] > 127)
3011 /* Remove trailing spaces */
3015 static u16 onfi_crc16(u16 crc, u8 const *p, size_t len)
3020 for (i = 0; i < 8; i++)
3021 crc = (crc << 1) ^ ((crc & 0x8000) ? 0x8005 : 0);
3027 /* Parse the Extended Parameter Page. */
3028 static int nand_flash_detect_ext_param_page(struct mtd_info *mtd,
3029 struct nand_chip *chip, struct nand_onfi_params *p)
3031 struct onfi_ext_param_page *ep;
3032 struct onfi_ext_section *s;
3033 struct onfi_ext_ecc_info *ecc;
3039 len = le16_to_cpu(p->ext_param_page_length) * 16;
3040 ep = kmalloc(len, GFP_KERNEL);
3044 /* Send our own NAND_CMD_PARAM. */
3045 chip->cmdfunc(mtd, NAND_CMD_PARAM, 0, -1);
3047 /* Use the Change Read Column command to skip the ONFI param pages. */
3048 chip->cmdfunc(mtd, NAND_CMD_RNDOUT,
3049 sizeof(*p) * p->num_of_param_pages , -1);
3051 /* Read out the Extended Parameter Page. */
3052 chip->read_buf(mtd, (uint8_t *)ep, len);
3053 if ((onfi_crc16(ONFI_CRC_BASE, ((uint8_t *)ep) + 2, len - 2)
3054 != le16_to_cpu(ep->crc))) {
3055 pr_debug("fail in the CRC.\n");
3060 * Check the signature.
3061 * Do not strictly follow the ONFI spec, maybe changed in future.
3063 if (strncmp(ep->sig, "EPPS", 4)) {
3064 pr_debug("The signature is invalid.\n");
3068 /* find the ECC section. */
3069 cursor = (uint8_t *)(ep + 1);
3070 for (i = 0; i < ONFI_EXT_SECTION_MAX; i++) {
3071 s = ep->sections + i;
3072 if (s->type == ONFI_SECTION_TYPE_2)
3074 cursor += s->length * 16;
3076 if (i == ONFI_EXT_SECTION_MAX) {
3077 pr_debug("We can not find the ECC section.\n");
3081 /* get the info we want. */
3082 ecc = (struct onfi_ext_ecc_info *)cursor;
3084 if (!ecc->codeword_size) {
3085 pr_debug("Invalid codeword size\n");
3089 chip->ecc_strength_ds = ecc->ecc_bits;
3090 chip->ecc_step_ds = 1 << ecc->codeword_size;
3098 static int nand_setup_read_retry_micron(struct mtd_info *mtd, int retry_mode)
3100 struct nand_chip *chip = mtd->priv;
3101 uint8_t feature[ONFI_SUBFEATURE_PARAM_LEN] = {retry_mode};
3103 return chip->onfi_set_features(mtd, chip, ONFI_FEATURE_ADDR_READ_RETRY,
3108 * Configure chip properties from Micron vendor-specific ONFI table
3110 static void nand_onfi_detect_micron(struct nand_chip *chip,
3111 struct nand_onfi_params *p)
3113 struct nand_onfi_vendor_micron *micron = (void *)p->vendor;
3115 if (le16_to_cpu(p->vendor_revision) < 1)
3118 chip->read_retries = micron->read_retry_options;
3119 chip->setup_read_retry = nand_setup_read_retry_micron;
3123 * Check if the NAND chip is ONFI compliant, returns 1 if it is, 0 otherwise.
3125 static int nand_flash_detect_onfi(struct mtd_info *mtd, struct nand_chip *chip,
3128 struct nand_onfi_params *p = &chip->onfi_params;
3132 /* Try ONFI for unknown chip or LP */
3133 chip->cmdfunc(mtd, NAND_CMD_READID, 0x20, -1);
3134 if (chip->read_byte(mtd) != 'O' || chip->read_byte(mtd) != 'N' ||
3135 chip->read_byte(mtd) != 'F' || chip->read_byte(mtd) != 'I')
3138 chip->cmdfunc(mtd, NAND_CMD_PARAM, 0, -1);
3139 for (i = 0; i < 3; i++) {
3140 for (j = 0; j < sizeof(*p); j++)
3141 ((uint8_t *)p)[j] = chip->read_byte(mtd);
3142 if (onfi_crc16(ONFI_CRC_BASE, (uint8_t *)p, 254) ==
3143 le16_to_cpu(p->crc)) {
3149 pr_err("Could not find valid ONFI parameter page; aborting\n");
3154 val = le16_to_cpu(p->revision);
3156 chip->onfi_version = 23;
3157 else if (val & (1 << 4))
3158 chip->onfi_version = 22;
3159 else if (val & (1 << 3))
3160 chip->onfi_version = 21;
3161 else if (val & (1 << 2))
3162 chip->onfi_version = 20;
3163 else if (val & (1 << 1))
3164 chip->onfi_version = 10;
3166 if (!chip->onfi_version) {
3167 pr_info("unsupported ONFI version: %d\n", val);
3171 sanitize_string(p->manufacturer, sizeof(p->manufacturer));
3172 sanitize_string(p->model, sizeof(p->model));
3174 mtd->name = p->model;
3176 mtd->writesize = le32_to_cpu(p->byte_per_page);
3179 * pages_per_block and blocks_per_lun may not be a power-of-2 size
3180 * (don't ask me who thought of this...). MTD assumes that these
3181 * dimensions will be power-of-2, so just truncate the remaining area.
3183 mtd->erasesize = 1 << (fls(le32_to_cpu(p->pages_per_block)) - 1);
3184 mtd->erasesize *= mtd->writesize;
3186 mtd->oobsize = le16_to_cpu(p->spare_bytes_per_page);
3188 /* See erasesize comment */
3189 chip->chipsize = 1 << (fls(le32_to_cpu(p->blocks_per_lun)) - 1);
3190 chip->chipsize *= (uint64_t)mtd->erasesize * p->lun_count;
3191 chip->bits_per_cell = p->bits_per_cell;
3193 if (onfi_feature(chip) & ONFI_FEATURE_16_BIT_BUS)
3194 *busw = NAND_BUSWIDTH_16;
3198 if (p->ecc_bits != 0xff) {
3199 chip->ecc_strength_ds = p->ecc_bits;
3200 chip->ecc_step_ds = 512;
3201 } else if (chip->onfi_version >= 21 &&
3202 (onfi_feature(chip) & ONFI_FEATURE_EXT_PARAM_PAGE)) {
3205 * The nand_flash_detect_ext_param_page() uses the
3206 * Change Read Column command which maybe not supported
3207 * by the chip->cmdfunc. So try to update the chip->cmdfunc
3208 * now. We do not replace user supplied command function.
3210 if (mtd->writesize > 512 && chip->cmdfunc == nand_command)
3211 chip->cmdfunc = nand_command_lp;
3213 /* The Extended Parameter Page is supported since ONFI 2.1. */
3214 if (nand_flash_detect_ext_param_page(mtd, chip, p))
3215 pr_warn("Failed to detect ONFI extended param page\n");
3217 pr_warn("Could not retrieve ONFI ECC requirements\n");
3220 if (p->jedec_id == NAND_MFR_MICRON)
3221 nand_onfi_detect_micron(chip, p);
3227 * Check if the NAND chip is JEDEC compliant, returns 1 if it is, 0 otherwise.
3229 static int nand_flash_detect_jedec(struct mtd_info *mtd, struct nand_chip *chip,
3232 struct nand_jedec_params *p = &chip->jedec_params;
3233 struct jedec_ecc_info *ecc;
3237 /* Try JEDEC for unknown chip or LP */
3238 chip->cmdfunc(mtd, NAND_CMD_READID, 0x40, -1);
3239 if (chip->read_byte(mtd) != 'J' || chip->read_byte(mtd) != 'E' ||
3240 chip->read_byte(mtd) != 'D' || chip->read_byte(mtd) != 'E' ||
3241 chip->read_byte(mtd) != 'C')
3244 chip->cmdfunc(mtd, NAND_CMD_PARAM, 0x40, -1);
3245 for (i = 0; i < 3; i++) {
3246 for (j = 0; j < sizeof(*p); j++)
3247 ((uint8_t *)p)[j] = chip->read_byte(mtd);
3249 if (onfi_crc16(ONFI_CRC_BASE, (uint8_t *)p, 510) ==
3250 le16_to_cpu(p->crc))
3255 pr_err("Could not find valid JEDEC parameter page; aborting\n");
3260 val = le16_to_cpu(p->revision);
3262 chip->jedec_version = 10;
3263 else if (val & (1 << 1))
3264 chip->jedec_version = 1; /* vendor specific version */
3266 if (!chip->jedec_version) {
3267 pr_info("unsupported JEDEC version: %d\n", val);
3271 sanitize_string(p->manufacturer, sizeof(p->manufacturer));
3272 sanitize_string(p->model, sizeof(p->model));
3274 mtd->name = p->model;
3276 mtd->writesize = le32_to_cpu(p->byte_per_page);
3278 /* Please reference to the comment for nand_flash_detect_onfi. */
3279 mtd->erasesize = 1 << (fls(le32_to_cpu(p->pages_per_block)) - 1);
3280 mtd->erasesize *= mtd->writesize;
3282 mtd->oobsize = le16_to_cpu(p->spare_bytes_per_page);
3284 /* Please reference to the comment for nand_flash_detect_onfi. */
3285 chip->chipsize = 1 << (fls(le32_to_cpu(p->blocks_per_lun)) - 1);
3286 chip->chipsize *= (uint64_t)mtd->erasesize * p->lun_count;
3287 chip->bits_per_cell = p->bits_per_cell;
3289 if (jedec_feature(chip) & JEDEC_FEATURE_16_BIT_BUS)
3290 *busw = NAND_BUSWIDTH_16;
3295 ecc = &p->ecc_info[0];
3297 if (ecc->codeword_size >= 9) {
3298 chip->ecc_strength_ds = ecc->ecc_bits;
3299 chip->ecc_step_ds = 1 << ecc->codeword_size;
3301 pr_warn("Invalid codeword size\n");
3308 * nand_id_has_period - Check if an ID string has a given wraparound period
3309 * @id_data: the ID string
3310 * @arrlen: the length of the @id_data array
3311 * @period: the period of repitition
3313 * Check if an ID string is repeated within a given sequence of bytes at
3314 * specific repetition interval period (e.g., {0x20,0x01,0x7F,0x20} has a
3315 * period of 3). This is a helper function for nand_id_len(). Returns non-zero
3316 * if the repetition has a period of @period; otherwise, returns zero.
3318 static int nand_id_has_period(u8 *id_data, int arrlen, int period)
3321 for (i = 0; i < period; i++)
3322 for (j = i + period; j < arrlen; j += period)
3323 if (id_data[i] != id_data[j])
3329 * nand_id_len - Get the length of an ID string returned by CMD_READID
3330 * @id_data: the ID string
3331 * @arrlen: the length of the @id_data array
3333 * Returns the length of the ID string, according to known wraparound/trailing
3334 * zero patterns. If no pattern exists, returns the length of the array.
3336 static int nand_id_len(u8 *id_data, int arrlen)
3338 int last_nonzero, period;
3340 /* Find last non-zero byte */
3341 for (last_nonzero = arrlen - 1; last_nonzero >= 0; last_nonzero--)
3342 if (id_data[last_nonzero])
3346 if (last_nonzero < 0)
3349 /* Calculate wraparound period */
3350 for (period = 1; period < arrlen; period++)
3351 if (nand_id_has_period(id_data, arrlen, period))
3354 /* There's a repeated pattern */
3355 if (period < arrlen)
3358 /* There are trailing zeros */
3359 if (last_nonzero < arrlen - 1)
3360 return last_nonzero + 1;
3362 /* No pattern detected */
3366 /* Extract the bits of per cell from the 3rd byte of the extended ID */
3367 static int nand_get_bits_per_cell(u8 cellinfo)
3371 bits = cellinfo & NAND_CI_CELLTYPE_MSK;
3372 bits >>= NAND_CI_CELLTYPE_SHIFT;
3377 * Many new NAND share similar device ID codes, which represent the size of the
3378 * chip. The rest of the parameters must be decoded according to generic or
3379 * manufacturer-specific "extended ID" decoding patterns.
3381 static void nand_decode_ext_id(struct mtd_info *mtd, struct nand_chip *chip,
3382 u8 id_data[8], int *busw)
3385 /* The 3rd id byte holds MLC / multichip data */
3386 chip->bits_per_cell = nand_get_bits_per_cell(id_data[2]);
3387 /* The 4th id byte is the important one */
3390 id_len = nand_id_len(id_data, 8);
3393 * Field definitions are in the following datasheets:
3394 * Old style (4,5 byte ID): Samsung K9GAG08U0M (p.32)
3395 * New Samsung (6 byte ID): Samsung K9GAG08U0F (p.44)
3396 * Hynix MLC (6 byte ID): Hynix H27UBG8T2B (p.22)
3398 * Check for ID length, non-zero 6th byte, cell type, and Hynix/Samsung
3399 * ID to decide what to do.
3401 if (id_len == 6 && id_data[0] == NAND_MFR_SAMSUNG &&
3402 !nand_is_slc(chip) && id_data[5] != 0x00) {
3404 mtd->writesize = 2048 << (extid & 0x03);
3407 switch (((extid >> 2) & 0x04) | (extid & 0x03)) {
3427 default: /* Other cases are "reserved" (unknown) */
3428 mtd->oobsize = 1024;
3432 /* Calc blocksize */
3433 mtd->erasesize = (128 * 1024) <<
3434 (((extid >> 1) & 0x04) | (extid & 0x03));
3436 } else if (id_len == 6 && id_data[0] == NAND_MFR_HYNIX &&
3437 !nand_is_slc(chip)) {
3441 mtd->writesize = 2048 << (extid & 0x03);
3444 switch (((extid >> 2) & 0x04) | (extid & 0x03)) {
3468 /* Calc blocksize */
3469 tmp = ((extid >> 1) & 0x04) | (extid & 0x03);
3471 mtd->erasesize = (128 * 1024) << tmp;
3472 else if (tmp == 0x03)
3473 mtd->erasesize = 768 * 1024;
3475 mtd->erasesize = (64 * 1024) << tmp;
3479 mtd->writesize = 1024 << (extid & 0x03);
3482 mtd->oobsize = (8 << (extid & 0x01)) *
3483 (mtd->writesize >> 9);
3485 /* Calc blocksize. Blocksize is multiples of 64KiB */
3486 mtd->erasesize = (64 * 1024) << (extid & 0x03);
3488 /* Get buswidth information */
3489 *busw = (extid & 0x01) ? NAND_BUSWIDTH_16 : 0;
3492 * Toshiba 24nm raw SLC (i.e., not BENAND) have 32B OOB per
3493 * 512B page. For Toshiba SLC, we decode the 5th/6th byte as
3495 * - ID byte 6, bits[2:0]: 100b -> 43nm, 101b -> 32nm,
3497 * - ID byte 5, bit[7]: 1 -> BENAND, 0 -> raw SLC
3499 if (id_len >= 6 && id_data[0] == NAND_MFR_TOSHIBA &&
3500 nand_is_slc(chip) &&
3501 (id_data[5] & 0x7) == 0x6 /* 24nm */ &&
3502 !(id_data[4] & 0x80) /* !BENAND */) {
3503 mtd->oobsize = 32 * mtd->writesize >> 9;
3510 * Old devices have chip data hardcoded in the device ID table. nand_decode_id
3511 * decodes a matching ID table entry and assigns the MTD size parameters for
3514 static void nand_decode_id(struct mtd_info *mtd, struct nand_chip *chip,
3515 struct nand_flash_dev *type, u8 id_data[8],
3518 int maf_id = id_data[0];
3520 mtd->erasesize = type->erasesize;
3521 mtd->writesize = type->pagesize;
3522 mtd->oobsize = mtd->writesize / 32;
3523 *busw = type->options & NAND_BUSWIDTH_16;
3525 /* All legacy ID NAND are small-page, SLC */
3526 chip->bits_per_cell = 1;
3529 * Check for Spansion/AMD ID + repeating 5th, 6th byte since
3530 * some Spansion chips have erasesize that conflicts with size
3531 * listed in nand_ids table.
3532 * Data sheet (5 byte ID): Spansion S30ML-P ORNAND (p.39)
3534 if (maf_id == NAND_MFR_AMD && id_data[4] != 0x00 && id_data[5] == 0x00
3535 && id_data[6] == 0x00 && id_data[7] == 0x00
3536 && mtd->writesize == 512) {
3537 mtd->erasesize = 128 * 1024;
3538 mtd->erasesize <<= ((id_data[3] & 0x03) << 1);
3543 * Set the bad block marker/indicator (BBM/BBI) patterns according to some
3544 * heuristic patterns using various detected parameters (e.g., manufacturer,
3545 * page size, cell-type information).
3547 static void nand_decode_bbm_options(struct mtd_info *mtd,
3548 struct nand_chip *chip, u8 id_data[8])
3550 int maf_id = id_data[0];
3552 /* Set the bad block position */
3553 if (mtd->writesize > 512 || (chip->options & NAND_BUSWIDTH_16))
3554 chip->badblockpos = NAND_LARGE_BADBLOCK_POS;
3556 chip->badblockpos = NAND_SMALL_BADBLOCK_POS;
3559 * Bad block marker is stored in the last page of each block on Samsung
3560 * and Hynix MLC devices; stored in first two pages of each block on
3561 * Micron devices with 2KiB pages and on SLC Samsung, Hynix, Toshiba,
3562 * AMD/Spansion, and Macronix. All others scan only the first page.
3564 if (!nand_is_slc(chip) &&
3565 (maf_id == NAND_MFR_SAMSUNG ||
3566 maf_id == NAND_MFR_HYNIX))
3567 chip->bbt_options |= NAND_BBT_SCANLASTPAGE;
3568 else if ((nand_is_slc(chip) &&
3569 (maf_id == NAND_MFR_SAMSUNG ||
3570 maf_id == NAND_MFR_HYNIX ||
3571 maf_id == NAND_MFR_TOSHIBA ||
3572 maf_id == NAND_MFR_AMD ||
3573 maf_id == NAND_MFR_MACRONIX)) ||
3574 (mtd->writesize == 2048 &&
3575 maf_id == NAND_MFR_MICRON))
3576 chip->bbt_options |= NAND_BBT_SCAN2NDPAGE;
3579 static inline bool is_full_id_nand(struct nand_flash_dev *type)
3581 return type->id_len;
3584 static bool find_full_id_nand(struct mtd_info *mtd, struct nand_chip *chip,
3585 struct nand_flash_dev *type, u8 *id_data, int *busw)
3587 if (!strncmp(type->id, id_data, type->id_len)) {
3588 mtd->writesize = type->pagesize;
3589 mtd->erasesize = type->erasesize;
3590 mtd->oobsize = type->oobsize;
3592 chip->bits_per_cell = nand_get_bits_per_cell(id_data[2]);
3593 chip->chipsize = (uint64_t)type->chipsize << 20;
3594 chip->options |= type->options;
3595 chip->ecc_strength_ds = NAND_ECC_STRENGTH(type);
3596 chip->ecc_step_ds = NAND_ECC_STEP(type);
3597 chip->onfi_timing_mode_default =
3598 type->onfi_timing_mode_default;
3600 *busw = type->options & NAND_BUSWIDTH_16;
3603 mtd->name = type->name;
3611 * Get the flash and manufacturer id and lookup if the type is supported.
3613 static struct nand_flash_dev *nand_get_flash_type(struct mtd_info *mtd,
3614 struct nand_chip *chip,
3615 int *maf_id, int *dev_id,
3616 struct nand_flash_dev *type)
3622 /* Select the device */
3623 chip->select_chip(mtd, 0);
3626 * Reset the chip, required by some chips (e.g. Micron MT29FxGxxxxx)
3629 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
3631 /* Send the command for reading device ID */
3632 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
3634 /* Read manufacturer and device IDs */
3635 *maf_id = chip->read_byte(mtd);
3636 *dev_id = chip->read_byte(mtd);
3639 * Try again to make sure, as some systems the bus-hold or other
3640 * interface concerns can cause random data which looks like a
3641 * possibly credible NAND flash to appear. If the two results do
3642 * not match, ignore the device completely.
3645 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
3647 /* Read entire ID string */
3648 for (i = 0; i < 8; i++)
3649 id_data[i] = chip->read_byte(mtd);
3651 if (id_data[0] != *maf_id || id_data[1] != *dev_id) {
3652 pr_info("second ID read did not match %02x,%02x against %02x,%02x\n",
3653 *maf_id, *dev_id, id_data[0], id_data[1]);
3654 return ERR_PTR(-ENODEV);
3658 type = nand_flash_ids;
3660 for (; type->name != NULL; type++) {
3661 if (is_full_id_nand(type)) {
3662 if (find_full_id_nand(mtd, chip, type, id_data, &busw))
3664 } else if (*dev_id == type->dev_id) {
3669 chip->onfi_version = 0;
3670 if (!type->name || !type->pagesize) {
3671 /* Check if the chip is ONFI compliant */
3672 if (nand_flash_detect_onfi(mtd, chip, &busw))
3675 /* Check if the chip is JEDEC compliant */
3676 if (nand_flash_detect_jedec(mtd, chip, &busw))
3681 return ERR_PTR(-ENODEV);
3684 mtd->name = type->name;
3686 chip->chipsize = (uint64_t)type->chipsize << 20;
3688 if (!type->pagesize && chip->init_size) {
3689 /* Set the pagesize, oobsize, erasesize by the driver */
3690 busw = chip->init_size(mtd, chip, id_data);
3691 } else if (!type->pagesize) {
3692 /* Decode parameters from extended ID */
3693 nand_decode_ext_id(mtd, chip, id_data, &busw);
3695 nand_decode_id(mtd, chip, type, id_data, &busw);
3697 /* Get chip options */
3698 chip->options |= type->options;
3701 * Check if chip is not a Samsung device. Do not clear the
3702 * options for chips which do not have an extended id.
3704 if (*maf_id != NAND_MFR_SAMSUNG && !type->pagesize)
3705 chip->options &= ~NAND_SAMSUNG_LP_OPTIONS;
3708 /* Try to identify manufacturer */
3709 for (maf_idx = 0; nand_manuf_ids[maf_idx].id != 0x0; maf_idx++) {
3710 if (nand_manuf_ids[maf_idx].id == *maf_id)
3714 if (chip->options & NAND_BUSWIDTH_AUTO) {
3715 WARN_ON(chip->options & NAND_BUSWIDTH_16);
3716 chip->options |= busw;
3717 nand_set_defaults(chip, busw);
3718 } else if (busw != (chip->options & NAND_BUSWIDTH_16)) {
3720 * Check, if buswidth is correct. Hardware drivers should set
3723 pr_info("device found, Manufacturer ID: 0x%02x, Chip ID: 0x%02x\n",
3725 pr_info("%s %s\n", nand_manuf_ids[maf_idx].name, mtd->name);
3726 pr_warn("bus width %d instead %d bit\n",
3727 (chip->options & NAND_BUSWIDTH_16) ? 16 : 8,
3729 return ERR_PTR(-EINVAL);
3732 nand_decode_bbm_options(mtd, chip, id_data);
3734 /* Calculate the address shift from the page size */
3735 chip->page_shift = ffs(mtd->writesize) - 1;
3736 /* Convert chipsize to number of pages per chip -1 */
3737 chip->pagemask = (chip->chipsize >> chip->page_shift) - 1;
3739 chip->bbt_erase_shift = chip->phys_erase_shift =
3740 ffs(mtd->erasesize) - 1;
3741 if (chip->chipsize & 0xffffffff)
3742 chip->chip_shift = ffs((unsigned)chip->chipsize) - 1;
3744 chip->chip_shift = ffs((unsigned)(chip->chipsize >> 32));
3745 chip->chip_shift += 32 - 1;
3748 chip->badblockbits = 8;
3749 chip->erase = single_erase;
3751 /* Do not replace user supplied command function! */
3752 if (mtd->writesize > 512 && chip->cmdfunc == nand_command)
3753 chip->cmdfunc = nand_command_lp;
3755 pr_info("device found, Manufacturer ID: 0x%02x, Chip ID: 0x%02x\n",
3758 if (chip->onfi_version)
3759 pr_info("%s %s\n", nand_manuf_ids[maf_idx].name,
3760 chip->onfi_params.model);
3761 else if (chip->jedec_version)
3762 pr_info("%s %s\n", nand_manuf_ids[maf_idx].name,
3763 chip->jedec_params.model);
3765 pr_info("%s %s\n", nand_manuf_ids[maf_idx].name,
3768 pr_info("%d MiB, %s, erase size: %d KiB, page size: %d, OOB size: %d\n",
3769 (int)(chip->chipsize >> 20), nand_is_slc(chip) ? "SLC" : "MLC",
3770 mtd->erasesize >> 10, mtd->writesize, mtd->oobsize);
3775 * nand_scan_ident - [NAND Interface] Scan for the NAND device
3776 * @mtd: MTD device structure
3777 * @maxchips: number of chips to scan for
3778 * @table: alternative NAND ID table
3780 * This is the first phase of the normal nand_scan() function. It reads the
3781 * flash ID and sets up MTD fields accordingly.
3783 * The mtd->owner field must be set to the module of the caller.
3785 int nand_scan_ident(struct mtd_info *mtd, int maxchips,
3786 struct nand_flash_dev *table)
3788 int i, nand_maf_id, nand_dev_id;
3789 struct nand_chip *chip = mtd->priv;
3790 struct nand_flash_dev *type;
3792 /* Set the default functions */
3793 nand_set_defaults(chip, chip->options & NAND_BUSWIDTH_16);
3795 /* Read the flash type */
3796 type = nand_get_flash_type(mtd, chip, &nand_maf_id,
3797 &nand_dev_id, table);
3800 if (!(chip->options & NAND_SCAN_SILENT_NODEV))
3801 pr_warn("No NAND device found\n");
3802 chip->select_chip(mtd, -1);
3803 return PTR_ERR(type);
3806 chip->select_chip(mtd, -1);
3808 /* Check for a chip array */
3809 for (i = 1; i < maxchips; i++) {
3810 chip->select_chip(mtd, i);
3811 /* See comment in nand_get_flash_type for reset */
3812 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
3813 /* Send the command for reading device ID */
3814 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
3815 /* Read manufacturer and device IDs */
3816 if (nand_maf_id != chip->read_byte(mtd) ||
3817 nand_dev_id != chip->read_byte(mtd)) {
3818 chip->select_chip(mtd, -1);
3821 chip->select_chip(mtd, -1);
3824 pr_info("%d chips detected\n", i);
3826 /* Store the number of chips and calc total size for mtd */
3828 mtd->size = i * chip->chipsize;
3832 EXPORT_SYMBOL(nand_scan_ident);
3835 * Check if the chip configuration meet the datasheet requirements.
3837 * If our configuration corrects A bits per B bytes and the minimum
3838 * required correction level is X bits per Y bytes, then we must ensure
3839 * both of the following are true:
3841 * (1) A / B >= X / Y
3844 * Requirement (1) ensures we can correct for the required bitflip density.
3845 * Requirement (2) ensures we can correct even when all bitflips are clumped
3846 * in the same sector.
3848 static bool nand_ecc_strength_good(struct mtd_info *mtd)
3850 struct nand_chip *chip = mtd->priv;
3851 struct nand_ecc_ctrl *ecc = &chip->ecc;
3854 if (ecc->size == 0 || chip->ecc_step_ds == 0)
3855 /* Not enough information */
3859 * We get the number of corrected bits per page to compare
3860 * the correction density.
3862 corr = (mtd->writesize * ecc->strength) / ecc->size;
3863 ds_corr = (mtd->writesize * chip->ecc_strength_ds) / chip->ecc_step_ds;
3865 return corr >= ds_corr && ecc->strength >= chip->ecc_strength_ds;
3869 * nand_scan_tail - [NAND Interface] Scan for the NAND device
3870 * @mtd: MTD device structure
3872 * This is the second phase of the normal nand_scan() function. It fills out
3873 * all the uninitialized function pointers with the defaults and scans for a
3874 * bad block table if appropriate.
3876 int nand_scan_tail(struct mtd_info *mtd)
3879 struct nand_chip *chip = mtd->priv;
3880 struct nand_ecc_ctrl *ecc = &chip->ecc;
3881 struct nand_buffers *nbuf;
3883 /* New bad blocks should be marked in OOB, flash-based BBT, or both */
3884 BUG_ON((chip->bbt_options & NAND_BBT_NO_OOB_BBM) &&
3885 !(chip->bbt_options & NAND_BBT_USE_FLASH));
3887 if (!(chip->options & NAND_OWN_BUFFERS)) {
3888 nbuf = kzalloc(sizeof(*nbuf) + mtd->writesize
3889 + mtd->oobsize * 3, GFP_KERNEL);
3892 nbuf->ecccalc = (uint8_t *)(nbuf + 1);
3893 nbuf->ecccode = nbuf->ecccalc + mtd->oobsize;
3894 nbuf->databuf = nbuf->ecccode + mtd->oobsize;
3896 chip->buffers = nbuf;
3902 /* Set the internal oob buffer location, just after the page data */
3903 chip->oob_poi = chip->buffers->databuf + mtd->writesize;
3906 * If no default placement scheme is given, select an appropriate one.
3908 if (!ecc->layout && (ecc->mode != NAND_ECC_SOFT_BCH)) {
3909 switch (mtd->oobsize) {
3911 ecc->layout = &nand_oob_8;
3914 ecc->layout = &nand_oob_16;
3917 ecc->layout = &nand_oob_64;
3920 ecc->layout = &nand_oob_128;
3923 pr_warn("No oob scheme defined for oobsize %d\n",
3929 if (!chip->write_page)
3930 chip->write_page = nand_write_page;
3933 * Check ECC mode, default to software if 3byte/512byte hardware ECC is
3934 * selected and we have 256 byte pagesize fallback to software ECC
3937 switch (ecc->mode) {
3938 case NAND_ECC_HW_OOB_FIRST:
3939 /* Similar to NAND_ECC_HW, but a separate read_page handle */
3940 if (!ecc->calculate || !ecc->correct || !ecc->hwctl) {
3941 pr_warn("No ECC functions supplied; hardware ECC not possible\n");
3944 if (!ecc->read_page)
3945 ecc->read_page = nand_read_page_hwecc_oob_first;
3948 /* Use standard hwecc read page function? */
3949 if (!ecc->read_page)
3950 ecc->read_page = nand_read_page_hwecc;
3951 if (!ecc->write_page)
3952 ecc->write_page = nand_write_page_hwecc;
3953 if (!ecc->read_page_raw)
3954 ecc->read_page_raw = nand_read_page_raw;
3955 if (!ecc->write_page_raw)
3956 ecc->write_page_raw = nand_write_page_raw;
3958 ecc->read_oob = nand_read_oob_std;
3959 if (!ecc->write_oob)
3960 ecc->write_oob = nand_write_oob_std;
3961 if (!ecc->read_subpage)
3962 ecc->read_subpage = nand_read_subpage;
3963 if (!ecc->write_subpage)
3964 ecc->write_subpage = nand_write_subpage_hwecc;
3966 case NAND_ECC_HW_SYNDROME:
3967 if ((!ecc->calculate || !ecc->correct || !ecc->hwctl) &&
3969 ecc->read_page == nand_read_page_hwecc ||
3971 ecc->write_page == nand_write_page_hwecc)) {
3972 pr_warn("No ECC functions supplied; hardware ECC not possible\n");
3975 /* Use standard syndrome read/write page function? */
3976 if (!ecc->read_page)
3977 ecc->read_page = nand_read_page_syndrome;
3978 if (!ecc->write_page)
3979 ecc->write_page = nand_write_page_syndrome;
3980 if (!ecc->read_page_raw)
3981 ecc->read_page_raw = nand_read_page_raw_syndrome;
3982 if (!ecc->write_page_raw)
3983 ecc->write_page_raw = nand_write_page_raw_syndrome;
3985 ecc->read_oob = nand_read_oob_syndrome;
3986 if (!ecc->write_oob)
3987 ecc->write_oob = nand_write_oob_syndrome;
3989 if (mtd->writesize >= ecc->size) {
3990 if (!ecc->strength) {
3991 pr_warn("Driver must set ecc.strength when using hardware ECC\n");
3996 pr_warn("%d byte HW ECC not possible on %d byte page size, fallback to SW ECC\n",
3997 ecc->size, mtd->writesize);
3998 ecc->mode = NAND_ECC_SOFT;
4001 ecc->calculate = nand_calculate_ecc;
4002 ecc->correct = nand_correct_data;
4003 ecc->read_page = nand_read_page_swecc;
4004 ecc->read_subpage = nand_read_subpage;
4005 ecc->write_page = nand_write_page_swecc;
4006 ecc->read_page_raw = nand_read_page_raw;
4007 ecc->write_page_raw = nand_write_page_raw;
4008 ecc->read_oob = nand_read_oob_std;
4009 ecc->write_oob = nand_write_oob_std;
4016 case NAND_ECC_SOFT_BCH:
4017 if (!mtd_nand_has_bch()) {
4018 pr_warn("CONFIG_MTD_NAND_ECC_BCH not enabled\n");
4021 ecc->calculate = nand_bch_calculate_ecc;
4022 ecc->correct = nand_bch_correct_data;
4023 ecc->read_page = nand_read_page_swecc;
4024 ecc->read_subpage = nand_read_subpage;
4025 ecc->write_page = nand_write_page_swecc;
4026 ecc->read_page_raw = nand_read_page_raw;
4027 ecc->write_page_raw = nand_write_page_raw;
4028 ecc->read_oob = nand_read_oob_std;
4029 ecc->write_oob = nand_write_oob_std;
4031 * Board driver should supply ecc.size and ecc.bytes values to
4032 * select how many bits are correctable; see nand_bch_init()
4033 * for details. Otherwise, default to 4 bits for large page
4036 if (!ecc->size && (mtd->oobsize >= 64)) {
4038 ecc->bytes = DIV_ROUND_UP(13 * ecc->strength, 8);
4040 ecc->priv = nand_bch_init(mtd, ecc->size, ecc->bytes,
4043 pr_warn("BCH ECC initialization failed!\n");
4046 ecc->strength = ecc->bytes * 8 / fls(8 * ecc->size);
4050 pr_warn("NAND_ECC_NONE selected by board driver. This is not recommended!\n");
4051 ecc->read_page = nand_read_page_raw;
4052 ecc->write_page = nand_write_page_raw;
4053 ecc->read_oob = nand_read_oob_std;
4054 ecc->read_page_raw = nand_read_page_raw;
4055 ecc->write_page_raw = nand_write_page_raw;
4056 ecc->write_oob = nand_write_oob_std;
4057 ecc->size = mtd->writesize;
4063 pr_warn("Invalid NAND_ECC_MODE %d\n", ecc->mode);
4067 /* For many systems, the standard OOB write also works for raw */
4068 if (!ecc->read_oob_raw)
4069 ecc->read_oob_raw = ecc->read_oob;
4070 if (!ecc->write_oob_raw)
4071 ecc->write_oob_raw = ecc->write_oob;
4074 * The number of bytes available for a client to place data into
4075 * the out of band area.
4077 ecc->layout->oobavail = 0;
4078 for (i = 0; ecc->layout->oobfree[i].length
4079 && i < ARRAY_SIZE(ecc->layout->oobfree); i++)
4080 ecc->layout->oobavail += ecc->layout->oobfree[i].length;
4081 mtd->oobavail = ecc->layout->oobavail;
4083 /* ECC sanity check: warn if it's too weak */
4084 if (!nand_ecc_strength_good(mtd))
4085 pr_warn("WARNING: %s: the ECC used on your system is too weak compared to the one required by the NAND chip\n",
4089 * Set the number of read / write steps for one page depending on ECC
4092 ecc->steps = mtd->writesize / ecc->size;
4093 if (ecc->steps * ecc->size != mtd->writesize) {
4094 pr_warn("Invalid ECC parameters\n");
4097 ecc->total = ecc->steps * ecc->bytes;
4099 /* Allow subpage writes up to ecc.steps. Not possible for MLC flash */
4100 if (!(chip->options & NAND_NO_SUBPAGE_WRITE) && nand_is_slc(chip)) {
4101 switch (ecc->steps) {
4103 mtd->subpage_sft = 1;
4108 mtd->subpage_sft = 2;
4112 chip->subpagesize = mtd->writesize >> mtd->subpage_sft;
4114 /* Initialize state */
4115 chip->state = FL_READY;
4117 /* Invalidate the pagebuffer reference */
4120 /* Large page NAND with SOFT_ECC should support subpage reads */
4121 switch (ecc->mode) {
4123 case NAND_ECC_SOFT_BCH:
4124 if (chip->page_shift > 9)
4125 chip->options |= NAND_SUBPAGE_READ;
4132 /* Fill in remaining MTD driver data */
4133 mtd->type = nand_is_slc(chip) ? MTD_NANDFLASH : MTD_MLCNANDFLASH;
4134 mtd->flags = (chip->options & NAND_ROM) ? MTD_CAP_ROM :
4136 mtd->_erase = nand_erase;
4138 mtd->_unpoint = NULL;
4139 mtd->_read = nand_read;
4140 mtd->_write = nand_write;
4141 mtd->_panic_write = panic_nand_write;
4142 mtd->_read_oob = nand_read_oob;
4143 mtd->_write_oob = nand_write_oob;
4144 mtd->_sync = nand_sync;
4146 mtd->_unlock = NULL;
4147 mtd->_suspend = nand_suspend;
4148 mtd->_resume = nand_resume;
4149 mtd->_block_isreserved = nand_block_isreserved;
4150 mtd->_block_isbad = nand_block_isbad;
4151 mtd->_block_markbad = nand_block_markbad;
4152 mtd->writebufsize = mtd->writesize;
4154 /* propagate ecc info to mtd_info */
4155 mtd->ecclayout = ecc->layout;
4156 mtd->ecc_strength = ecc->strength;
4157 mtd->ecc_step_size = ecc->size;
4159 * Initialize bitflip_threshold to its default prior scan_bbt() call.
4160 * scan_bbt() might invoke mtd_read(), thus bitflip_threshold must be
4163 if (!mtd->bitflip_threshold)
4164 mtd->bitflip_threshold = mtd->ecc_strength;
4166 /* Check, if we should skip the bad block table scan */
4167 if (chip->options & NAND_SKIP_BBTSCAN)
4170 /* Build bad block table */
4171 return chip->scan_bbt(mtd);
4173 EXPORT_SYMBOL(nand_scan_tail);
4176 * is_module_text_address() isn't exported, and it's mostly a pointless
4177 * test if this is a module _anyway_ -- they'd have to try _really_ hard
4178 * to call us from in-kernel code if the core NAND support is modular.
4181 #define caller_is_module() (1)
4183 #define caller_is_module() \
4184 is_module_text_address((unsigned long)__builtin_return_address(0))
4188 * nand_scan - [NAND Interface] Scan for the NAND device
4189 * @mtd: MTD device structure
4190 * @maxchips: number of chips to scan for
4192 * This fills out all the uninitialized function pointers with the defaults.
4193 * The flash ID is read and the mtd/chip structures are filled with the
4194 * appropriate values. The mtd->owner field must be set to the module of the
4197 int nand_scan(struct mtd_info *mtd, int maxchips)
4201 /* Many callers got this wrong, so check for it for a while... */
4202 if (!mtd->owner && caller_is_module()) {
4203 pr_crit("%s called with NULL mtd->owner!\n", __func__);
4207 ret = nand_scan_ident(mtd, maxchips, NULL);
4209 ret = nand_scan_tail(mtd);
4212 EXPORT_SYMBOL(nand_scan);
4215 * nand_release - [NAND Interface] Free resources held by the NAND device
4216 * @mtd: MTD device structure
4218 void nand_release(struct mtd_info *mtd)
4220 struct nand_chip *chip = mtd->priv;
4222 if (chip->ecc.mode == NAND_ECC_SOFT_BCH)
4223 nand_bch_free((struct nand_bch_control *)chip->ecc.priv);
4225 mtd_device_unregister(mtd);
4227 /* Free bad block table memory */
4229 if (!(chip->options & NAND_OWN_BUFFERS))
4230 kfree(chip->buffers);
4232 /* Free bad block descriptor memory */
4233 if (chip->badblock_pattern && chip->badblock_pattern->options
4234 & NAND_BBT_DYNAMICSTRUCT)
4235 kfree(chip->badblock_pattern);
4237 EXPORT_SYMBOL_GPL(nand_release);
4239 static int __init nand_base_init(void)
4241 led_trigger_register_simple("nand-disk", &nand_led_trigger);
4245 static void __exit nand_base_exit(void)
4247 led_trigger_unregister_simple(nand_led_trigger);
4250 module_init(nand_base_init);
4251 module_exit(nand_base_exit);
4253 MODULE_LICENSE("GPL");
4254 MODULE_AUTHOR("Steven J. Hill <sjhill@realitydiluted.com>");
4255 MODULE_AUTHOR("Thomas Gleixner <tglx@linutronix.de>");
4256 MODULE_DESCRIPTION("Generic NAND flash driver code");