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.
7 * Basic support for AG-AND chips is provided.
9 * Additional technical information is available on
10 * http://www.linux-mtd.infradead.org/tech/nand.html
12 * Copyright (C) 2000 Steven J. Hill (sjhill@realitydiluted.com)
13 * 2002 Thomas Gleixner (tglx@linutronix.de)
15 * 02-08-2004 tglx: support for strange chips, which cannot auto increment
16 * pages on read / read_oob
18 * 03-17-2004 tglx: Check ready before auto increment check. Simon Bayes
19 * pointed this out, as he marked an auto increment capable chip
20 * as NOAUTOINCR in the board driver.
21 * Make reads over block boundaries work too
23 * 04-14-2004 tglx: first working version for 2k page size chips
25 * 05-19-2004 tglx: Basic support for Renesas AG-AND chips
27 * 09-24-2004 tglx: add support for hardware controllers (e.g. ECC) shared
28 * among multiple independend devices. Suggestions and initial patch
29 * from Ben Dooks <ben-mtd@fluff.org>
31 * 12-05-2004 dmarlin: add workaround for Renesas AG-AND chips "disturb" issue.
32 * Basically, any block not rewritten may lose data when surrounding blocks
33 * are rewritten many times. JFFS2 ensures this doesn't happen for blocks
34 * it uses, but the Bad Block Table(s) may not be rewritten. To ensure they
35 * do not lose data, force them to be rewritten when some of the surrounding
36 * blocks are erased. Rather than tracking a specific nearby block (which
37 * could itself go bad), use a page address 'mask' to select several blocks
38 * in the same area, and rewrite the BBT when any of them are erased.
40 * 01-03-2005 dmarlin: added support for the device recovery command sequence for Renesas
41 * AG-AND chips. If there was a sudden loss of power during an erase operation,
42 * a "device recovery" operation must be performed when power is restored
43 * to ensure correct operation.
45 * 01-20-2005 dmarlin: added support for optional hardware specific callback routine to
46 * perform extra error status checks on erase and write failures. This required
47 * adding a wrapper function for nand_read_ecc.
49 * 08-20-2005 vwool: suspend/resume added
52 * David Woodhouse for adding multichip support
54 * Aleph One Ltd. and Toby Churchill Ltd. for supporting the
55 * rework for 2K page size chips
58 * Enable cached programming for 2k page size chips
59 * Check, if mtd->ecctype should be set to MTD_ECC_HW
60 * if we have HW ecc support.
61 * The AG-AND chips have nice features for speed improvement,
62 * which are not supported yet. Read / program 4 pages in one go.
64 * $Id: nand_base.c,v 1.150 2005/09/15 13:58:48 vwool Exp $
66 * This program is free software; you can redistribute it and/or modify
67 * it under the terms of the GNU General Public License version 2 as
68 * published by the Free Software Foundation.
72 #include <linux/module.h>
73 #include <linux/delay.h>
74 #include <linux/errno.h>
75 #include <linux/sched.h>
76 #include <linux/slab.h>
77 #include <linux/types.h>
78 #include <linux/mtd/mtd.h>
79 #include <linux/mtd/nand.h>
80 #include <linux/mtd/nand_ecc.h>
81 #include <linux/mtd/compatmac.h>
82 #include <linux/interrupt.h>
83 #include <linux/bitops.h>
84 #include <linux/leds.h>
87 #ifdef CONFIG_MTD_PARTITIONS
88 #include <linux/mtd/partitions.h>
91 /* Define default oob placement schemes for large and small page devices */
92 static struct nand_oobinfo nand_oob_8 = {
93 .useecc = MTD_NANDECC_AUTOPLACE,
96 .oobfree = {{3, 2}, {6, 2}}
99 static struct nand_oobinfo nand_oob_16 = {
100 .useecc = MTD_NANDECC_AUTOPLACE,
102 .eccpos = {0, 1, 2, 3, 6, 7},
106 static struct nand_oobinfo nand_oob_64 = {
107 .useecc = MTD_NANDECC_AUTOPLACE,
110 40, 41, 42, 43, 44, 45, 46, 47,
111 48, 49, 50, 51, 52, 53, 54, 55,
112 56, 57, 58, 59, 60, 61, 62, 63},
116 /* This is used for padding purposes in nand_write_oob */
117 static u_char ffchars[] = {
118 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
119 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
120 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
121 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
122 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
123 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
124 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
125 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
129 * NAND low-level MTD interface functions
131 static void nand_write_buf(struct mtd_info *mtd, const u_char *buf, int len);
132 static void nand_read_buf(struct mtd_info *mtd, u_char *buf, int len);
133 static int nand_verify_buf(struct mtd_info *mtd, const u_char *buf, int len);
135 static int nand_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
136 static int nand_read_ecc(struct mtd_info *mtd, loff_t from, size_t len,
137 size_t *retlen, u_char *buf, u_char *eccbuf, struct nand_oobinfo *oobsel);
138 static int nand_read_oob(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf);
139 static int nand_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
140 static int nand_write_ecc(struct mtd_info *mtd, loff_t to, size_t len,
141 size_t *retlen, const u_char *buf, u_char *eccbuf, struct nand_oobinfo *oobsel);
142 static int nand_write_oob(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf);
143 static int nand_writev(struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen);
144 static int nand_writev_ecc(struct mtd_info *mtd, const struct kvec *vecs,
145 unsigned long count, loff_t to, size_t *retlen, u_char *eccbuf,
146 struct nand_oobinfo *oobsel);
147 static int nand_erase(struct mtd_info *mtd, struct erase_info *instr);
148 static void nand_sync(struct mtd_info *mtd);
150 /* Some internal functions */
151 static int nand_write_page(struct mtd_info *mtd, struct nand_chip *this, int page, u_char * oob_buf,
152 struct nand_oobinfo *oobsel, int mode);
153 #ifdef CONFIG_MTD_NAND_VERIFY_WRITE
154 static int nand_verify_pages(struct mtd_info *mtd, struct nand_chip *this, int page, int numpages,
155 u_char *oob_buf, struct nand_oobinfo *oobsel, int chipnr, int oobmode);
157 #define nand_verify_pages(...) (0)
160 static int nand_get_device(struct nand_chip *this, struct mtd_info *mtd, int new_state);
163 * nand_release_device - [GENERIC] release chip
164 * @mtd: MTD device structure
166 * Deselect, release chip lock and wake up anyone waiting on the device
168 static void nand_release_device(struct mtd_info *mtd)
170 struct nand_chip *this = mtd->priv;
172 /* De-select the NAND device */
173 this->select_chip(mtd, -1);
175 /* Release the controller and the chip */
176 spin_lock(&this->controller->lock);
177 this->controller->active = NULL;
178 this->state = FL_READY;
179 wake_up(&this->controller->wq);
180 spin_unlock(&this->controller->lock);
184 * nand_read_byte - [DEFAULT] read one byte from the chip
185 * @mtd: MTD device structure
187 * Default read function for 8bit buswith
189 static u_char nand_read_byte(struct mtd_info *mtd)
191 struct nand_chip *this = mtd->priv;
192 return readb(this->IO_ADDR_R);
196 * nand_write_byte - [DEFAULT] write one byte to the chip
197 * @mtd: MTD device structure
198 * @byte: pointer to data byte to write
200 * Default write function for 8it buswith
202 static void nand_write_byte(struct mtd_info *mtd, u_char byte)
204 struct nand_chip *this = mtd->priv;
205 writeb(byte, this->IO_ADDR_W);
209 * nand_read_byte16 - [DEFAULT] read one byte endianess aware from the chip
210 * @mtd: MTD device structure
212 * Default read function for 16bit buswith with
213 * endianess conversion
215 static u_char nand_read_byte16(struct mtd_info *mtd)
217 struct nand_chip *this = mtd->priv;
218 return (u_char) cpu_to_le16(readw(this->IO_ADDR_R));
222 * nand_write_byte16 - [DEFAULT] write one byte endianess aware to the chip
223 * @mtd: MTD device structure
224 * @byte: pointer to data byte to write
226 * Default write function for 16bit buswith with
227 * endianess conversion
229 static void nand_write_byte16(struct mtd_info *mtd, u_char byte)
231 struct nand_chip *this = mtd->priv;
232 writew(le16_to_cpu((u16) byte), this->IO_ADDR_W);
236 * nand_read_word - [DEFAULT] read one word from the chip
237 * @mtd: MTD device structure
239 * Default read function for 16bit buswith without
240 * endianess conversion
242 static u16 nand_read_word(struct mtd_info *mtd)
244 struct nand_chip *this = mtd->priv;
245 return readw(this->IO_ADDR_R);
249 * nand_write_word - [DEFAULT] write one word to the chip
250 * @mtd: MTD device structure
251 * @word: data word to write
253 * Default write function for 16bit buswith without
254 * endianess conversion
256 static void nand_write_word(struct mtd_info *mtd, u16 word)
258 struct nand_chip *this = mtd->priv;
259 writew(word, this->IO_ADDR_W);
263 * nand_select_chip - [DEFAULT] control CE line
264 * @mtd: MTD device structure
265 * @chip: chipnumber to select, -1 for deselect
267 * Default select function for 1 chip devices.
269 static void nand_select_chip(struct mtd_info *mtd, int chip)
271 struct nand_chip *this = mtd->priv;
274 this->hwcontrol(mtd, NAND_CTL_CLRNCE);
277 this->hwcontrol(mtd, NAND_CTL_SETNCE);
286 * nand_write_buf - [DEFAULT] write buffer to chip
287 * @mtd: MTD device structure
289 * @len: number of bytes to write
291 * Default write function for 8bit buswith
293 static void nand_write_buf(struct mtd_info *mtd, const u_char *buf, int len)
296 struct nand_chip *this = mtd->priv;
298 for (i = 0; i < len; i++)
299 writeb(buf[i], this->IO_ADDR_W);
303 * nand_read_buf - [DEFAULT] read chip data into buffer
304 * @mtd: MTD device structure
305 * @buf: buffer to store date
306 * @len: number of bytes to read
308 * Default read function for 8bit buswith
310 static void nand_read_buf(struct mtd_info *mtd, u_char *buf, int len)
313 struct nand_chip *this = mtd->priv;
315 for (i = 0; i < len; i++)
316 buf[i] = readb(this->IO_ADDR_R);
320 * nand_verify_buf - [DEFAULT] Verify chip data against buffer
321 * @mtd: MTD device structure
322 * @buf: buffer containing the data to compare
323 * @len: number of bytes to compare
325 * Default verify function for 8bit buswith
327 static int nand_verify_buf(struct mtd_info *mtd, const u_char *buf, int len)
330 struct nand_chip *this = mtd->priv;
332 for (i = 0; i < len; i++)
333 if (buf[i] != readb(this->IO_ADDR_R))
340 * nand_write_buf16 - [DEFAULT] write buffer to chip
341 * @mtd: MTD device structure
343 * @len: number of bytes to write
345 * Default write function for 16bit buswith
347 static void nand_write_buf16(struct mtd_info *mtd, const u_char *buf, int len)
350 struct nand_chip *this = mtd->priv;
351 u16 *p = (u16 *) buf;
354 for (i = 0; i < len; i++)
355 writew(p[i], this->IO_ADDR_W);
360 * nand_read_buf16 - [DEFAULT] read chip data into buffer
361 * @mtd: MTD device structure
362 * @buf: buffer to store date
363 * @len: number of bytes to read
365 * Default read function for 16bit buswith
367 static void nand_read_buf16(struct mtd_info *mtd, u_char *buf, int len)
370 struct nand_chip *this = mtd->priv;
371 u16 *p = (u16 *) buf;
374 for (i = 0; i < len; i++)
375 p[i] = readw(this->IO_ADDR_R);
379 * nand_verify_buf16 - [DEFAULT] Verify chip data against buffer
380 * @mtd: MTD device structure
381 * @buf: buffer containing the data to compare
382 * @len: number of bytes to compare
384 * Default verify function for 16bit buswith
386 static int nand_verify_buf16(struct mtd_info *mtd, const u_char *buf, int len)
389 struct nand_chip *this = mtd->priv;
390 u16 *p = (u16 *) buf;
393 for (i = 0; i < len; i++)
394 if (p[i] != readw(this->IO_ADDR_R))
401 * nand_block_bad - [DEFAULT] Read bad block marker from the chip
402 * @mtd: MTD device structure
403 * @ofs: offset from device start
404 * @getchip: 0, if the chip is already selected
406 * Check, if the block is bad.
408 static int nand_block_bad(struct mtd_info *mtd, loff_t ofs, int getchip)
410 int page, chipnr, res = 0;
411 struct nand_chip *this = mtd->priv;
415 page = (int)(ofs >> this->page_shift);
416 chipnr = (int)(ofs >> this->chip_shift);
418 /* Grab the lock and see if the device is available */
419 nand_get_device(this, mtd, FL_READING);
421 /* Select the NAND device */
422 this->select_chip(mtd, chipnr);
426 if (this->options & NAND_BUSWIDTH_16) {
427 this->cmdfunc(mtd, NAND_CMD_READOOB, this->badblockpos & 0xFE, page & this->pagemask);
428 bad = cpu_to_le16(this->read_word(mtd));
429 if (this->badblockpos & 0x1)
431 if ((bad & 0xFF) != 0xff)
434 this->cmdfunc(mtd, NAND_CMD_READOOB, this->badblockpos, page & this->pagemask);
435 if (this->read_byte(mtd) != 0xff)
440 /* Deselect and wake up anyone waiting on the device */
441 nand_release_device(mtd);
448 * nand_default_block_markbad - [DEFAULT] mark a block bad
449 * @mtd: MTD device structure
450 * @ofs: offset from device start
452 * This is the default implementation, which can be overridden by
453 * a hardware specific driver.
455 static int nand_default_block_markbad(struct mtd_info *mtd, loff_t ofs)
457 struct nand_chip *this = mtd->priv;
458 u_char buf[2] = { 0, 0 };
462 /* Get block number */
463 block = ((int)ofs) >> this->bbt_erase_shift;
465 this->bbt[block >> 2] |= 0x01 << ((block & 0x03) << 1);
467 /* Do we have a flash based bad block table ? */
468 if (this->options & NAND_USE_FLASH_BBT)
469 return nand_update_bbt(mtd, ofs);
471 /* We write two bytes, so we dont have to mess with 16 bit access */
472 ofs += mtd->oobsize + (this->badblockpos & ~0x01);
473 return nand_write_oob(mtd, ofs, 2, &retlen, buf);
477 * nand_check_wp - [GENERIC] check if the chip is write protected
478 * @mtd: MTD device structure
479 * Check, if the device is write protected
481 * The function expects, that the device is already selected
483 static int nand_check_wp(struct mtd_info *mtd)
485 struct nand_chip *this = mtd->priv;
486 /* Check the WP bit */
487 this->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
488 return (this->read_byte(mtd) & NAND_STATUS_WP) ? 0 : 1;
492 * nand_block_checkbad - [GENERIC] Check if a block is marked bad
493 * @mtd: MTD device structure
494 * @ofs: offset from device start
495 * @getchip: 0, if the chip is already selected
496 * @allowbbt: 1, if its allowed to access the bbt area
498 * Check, if the block is bad. Either by reading the bad block table or
499 * calling of the scan function.
501 static int nand_block_checkbad(struct mtd_info *mtd, loff_t ofs, int getchip, int allowbbt)
503 struct nand_chip *this = mtd->priv;
506 return this->block_bad(mtd, ofs, getchip);
508 /* Return info from the table */
509 return nand_isbad_bbt(mtd, ofs, allowbbt);
512 DEFINE_LED_TRIGGER(nand_led_trigger);
515 * Wait for the ready pin, after a command
516 * The timeout is catched later.
518 static void nand_wait_ready(struct mtd_info *mtd)
520 struct nand_chip *this = mtd->priv;
521 unsigned long timeo = jiffies + 2;
523 led_trigger_event(nand_led_trigger, LED_FULL);
524 /* wait until command is processed or timeout occures */
526 if (this->dev_ready(mtd))
528 touch_softlockup_watchdog();
529 } while (time_before(jiffies, timeo));
530 led_trigger_event(nand_led_trigger, LED_OFF);
534 * nand_command - [DEFAULT] Send command to NAND device
535 * @mtd: MTD device structure
536 * @command: the command to be sent
537 * @column: the column address for this command, -1 if none
538 * @page_addr: the page address for this command, -1 if none
540 * Send command to NAND device. This function is used for small page
541 * devices (256/512 Bytes per page)
543 static void nand_command(struct mtd_info *mtd, unsigned command, int column, int page_addr)
545 register struct nand_chip *this = mtd->priv;
547 /* Begin command latch cycle */
548 this->hwcontrol(mtd, NAND_CTL_SETCLE);
550 * Write out the command to the device.
552 if (command == NAND_CMD_SEQIN) {
555 if (column >= mtd->oobblock) {
557 column -= mtd->oobblock;
558 readcmd = NAND_CMD_READOOB;
559 } else if (column < 256) {
560 /* First 256 bytes --> READ0 */
561 readcmd = NAND_CMD_READ0;
564 readcmd = NAND_CMD_READ1;
566 this->write_byte(mtd, readcmd);
568 this->write_byte(mtd, command);
570 /* Set ALE and clear CLE to start address cycle */
571 this->hwcontrol(mtd, NAND_CTL_CLRCLE);
573 if (column != -1 || page_addr != -1) {
574 this->hwcontrol(mtd, NAND_CTL_SETALE);
576 /* Serially input address */
578 /* Adjust columns for 16 bit buswidth */
579 if (this->options & NAND_BUSWIDTH_16)
581 this->write_byte(mtd, column);
583 if (page_addr != -1) {
584 this->write_byte(mtd, (unsigned char)(page_addr & 0xff));
585 this->write_byte(mtd, (unsigned char)((page_addr >> 8) & 0xff));
586 /* One more address cycle for devices > 32MiB */
587 if (this->chipsize > (32 << 20))
588 this->write_byte(mtd, (unsigned char)((page_addr >> 16) & 0x0f));
590 /* Latch in address */
591 this->hwcontrol(mtd, NAND_CTL_CLRALE);
595 * program and erase have their own busy handlers
596 * status and sequential in needs no delay
600 case NAND_CMD_PAGEPROG:
601 case NAND_CMD_ERASE1:
602 case NAND_CMD_ERASE2:
604 case NAND_CMD_STATUS:
610 udelay(this->chip_delay);
611 this->hwcontrol(mtd, NAND_CTL_SETCLE);
612 this->write_byte(mtd, NAND_CMD_STATUS);
613 this->hwcontrol(mtd, NAND_CTL_CLRCLE);
614 while (!(this->read_byte(mtd) & NAND_STATUS_READY)) ;
617 /* This applies to read commands */
620 * If we don't have access to the busy pin, we apply the given
623 if (!this->dev_ready) {
624 udelay(this->chip_delay);
628 /* Apply this short delay always to ensure that we do wait tWB in
629 * any case on any machine. */
632 nand_wait_ready(mtd);
636 * nand_command_lp - [DEFAULT] Send command to NAND large page device
637 * @mtd: MTD device structure
638 * @command: the command to be sent
639 * @column: the column address for this command, -1 if none
640 * @page_addr: the page address for this command, -1 if none
642 * Send command to NAND device. This is the version for the new large page devices
643 * We dont have the separate regions as we have in the small page devices.
644 * We must emulate NAND_CMD_READOOB to keep the code compatible.
647 static void nand_command_lp(struct mtd_info *mtd, unsigned command, int column, int page_addr)
649 register struct nand_chip *this = mtd->priv;
651 /* Emulate NAND_CMD_READOOB */
652 if (command == NAND_CMD_READOOB) {
653 column += mtd->oobblock;
654 command = NAND_CMD_READ0;
657 /* Begin command latch cycle */
658 this->hwcontrol(mtd, NAND_CTL_SETCLE);
659 /* Write out the command to the device. */
660 this->write_byte(mtd, (command & 0xff));
661 /* End command latch cycle */
662 this->hwcontrol(mtd, NAND_CTL_CLRCLE);
664 if (column != -1 || page_addr != -1) {
665 this->hwcontrol(mtd, NAND_CTL_SETALE);
667 /* Serially input address */
669 /* Adjust columns for 16 bit buswidth */
670 if (this->options & NAND_BUSWIDTH_16)
672 this->write_byte(mtd, column & 0xff);
673 this->write_byte(mtd, column >> 8);
675 if (page_addr != -1) {
676 this->write_byte(mtd, (unsigned char)(page_addr & 0xff));
677 this->write_byte(mtd, (unsigned char)((page_addr >> 8) & 0xff));
678 /* One more address cycle for devices > 128MiB */
679 if (this->chipsize > (128 << 20))
680 this->write_byte(mtd, (unsigned char)((page_addr >> 16) & 0xff));
682 /* Latch in address */
683 this->hwcontrol(mtd, NAND_CTL_CLRALE);
687 * program and erase have their own busy handlers
688 * status, sequential in, and deplete1 need no delay
692 case NAND_CMD_CACHEDPROG:
693 case NAND_CMD_PAGEPROG:
694 case NAND_CMD_ERASE1:
695 case NAND_CMD_ERASE2:
697 case NAND_CMD_STATUS:
698 case NAND_CMD_DEPLETE1:
702 * read error status commands require only a short delay
704 case NAND_CMD_STATUS_ERROR:
705 case NAND_CMD_STATUS_ERROR0:
706 case NAND_CMD_STATUS_ERROR1:
707 case NAND_CMD_STATUS_ERROR2:
708 case NAND_CMD_STATUS_ERROR3:
709 udelay(this->chip_delay);
715 udelay(this->chip_delay);
716 this->hwcontrol(mtd, NAND_CTL_SETCLE);
717 this->write_byte(mtd, NAND_CMD_STATUS);
718 this->hwcontrol(mtd, NAND_CTL_CLRCLE);
719 while (!(this->read_byte(mtd) & NAND_STATUS_READY)) ;
723 /* Begin command latch cycle */
724 this->hwcontrol(mtd, NAND_CTL_SETCLE);
725 /* Write out the start read command */
726 this->write_byte(mtd, NAND_CMD_READSTART);
727 /* End command latch cycle */
728 this->hwcontrol(mtd, NAND_CTL_CLRCLE);
729 /* Fall through into ready check */
731 /* This applies to read commands */
734 * If we don't have access to the busy pin, we apply the given
737 if (!this->dev_ready) {
738 udelay(this->chip_delay);
743 /* Apply this short delay always to ensure that we do wait tWB in
744 * any case on any machine. */
747 nand_wait_ready(mtd);
751 * nand_get_device - [GENERIC] Get chip for selected access
752 * @this: the nand chip descriptor
753 * @mtd: MTD device structure
754 * @new_state: the state which is requested
756 * Get the device and lock it for exclusive access
758 static int nand_get_device(struct nand_chip *this, struct mtd_info *mtd, int new_state)
760 spinlock_t *lock = &this->controller->lock;
761 wait_queue_head_t *wq = &this->controller->wq;
762 DECLARE_WAITQUEUE(wait, current);
766 /* Hardware controller shared among independend devices */
767 /* Hardware controller shared among independend devices */
768 if (!this->controller->active)
769 this->controller->active = this;
771 if (this->controller->active == this && this->state == FL_READY) {
772 this->state = new_state;
776 if (new_state == FL_PM_SUSPENDED) {
778 return (this->state == FL_PM_SUSPENDED) ? 0 : -EAGAIN;
780 set_current_state(TASK_UNINTERRUPTIBLE);
781 add_wait_queue(wq, &wait);
784 remove_wait_queue(wq, &wait);
789 * nand_wait - [DEFAULT] wait until the command is done
790 * @mtd: MTD device structure
791 * @this: NAND chip structure
792 * @state: state to select the max. timeout value
794 * Wait for command done. This applies to erase and program only
795 * Erase can take up to 400ms and program up to 20ms according to
796 * general NAND and SmartMedia specs
799 static int nand_wait(struct mtd_info *mtd, struct nand_chip *this, int state)
802 unsigned long timeo = jiffies;
805 if (state == FL_ERASING)
806 timeo += (HZ * 400) / 1000;
808 timeo += (HZ * 20) / 1000;
810 led_trigger_event(nand_led_trigger, LED_FULL);
812 /* Apply this short delay always to ensure that we do wait tWB in
813 * any case on any machine. */
816 if ((state == FL_ERASING) && (this->options & NAND_IS_AND))
817 this->cmdfunc(mtd, NAND_CMD_STATUS_MULTI, -1, -1);
819 this->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
821 while (time_before(jiffies, timeo)) {
822 /* Check, if we were interrupted */
823 if (this->state != state)
826 if (this->dev_ready) {
827 if (this->dev_ready(mtd))
830 if (this->read_byte(mtd) & NAND_STATUS_READY)
835 led_trigger_event(nand_led_trigger, LED_OFF);
837 status = (int)this->read_byte(mtd);
842 * nand_write_page - [GENERIC] write one page
843 * @mtd: MTD device structure
844 * @this: NAND chip structure
845 * @page: startpage inside the chip, must be called with (page & this->pagemask)
846 * @oob_buf: out of band data buffer
847 * @oobsel: out of band selecttion structre
848 * @cached: 1 = enable cached programming if supported by chip
850 * Nand_page_program function is used for write and writev !
851 * This function will always program a full page of data
852 * If you call it with a non page aligned buffer, you're lost :)
854 * Cached programming is not supported yet.
856 static int nand_write_page(struct mtd_info *mtd, struct nand_chip *this, int page,
857 u_char *oob_buf, struct nand_oobinfo *oobsel, int cached)
861 int eccmode = oobsel->useecc ? this->eccmode : NAND_ECC_NONE;
862 int *oob_config = oobsel->eccpos;
863 int datidx = 0, eccidx = 0, eccsteps = this->eccsteps;
866 /* FIXME: Enable cached programming */
869 /* Send command to begin auto page programming */
870 this->cmdfunc(mtd, NAND_CMD_SEQIN, 0x00, page);
872 /* Write out complete page of data, take care of eccmode */
874 /* No ecc, write all */
876 printk(KERN_WARNING "Writing data without ECC to NAND-FLASH is not recommended\n");
877 this->write_buf(mtd, this->data_poi, mtd->oobblock);
880 /* Software ecc 3/256, write all */
882 for (; eccsteps; eccsteps--) {
883 this->calculate_ecc(mtd, &this->data_poi[datidx], ecc_code);
884 for (i = 0; i < 3; i++, eccidx++)
885 oob_buf[oob_config[eccidx]] = ecc_code[i];
886 datidx += this->eccsize;
888 this->write_buf(mtd, this->data_poi, mtd->oobblock);
891 eccbytes = this->eccbytes;
892 for (; eccsteps; eccsteps--) {
893 /* enable hardware ecc logic for write */
894 this->enable_hwecc(mtd, NAND_ECC_WRITE);
895 this->write_buf(mtd, &this->data_poi[datidx], this->eccsize);
896 this->calculate_ecc(mtd, &this->data_poi[datidx], ecc_code);
897 for (i = 0; i < eccbytes; i++, eccidx++)
898 oob_buf[oob_config[eccidx]] = ecc_code[i];
899 /* If the hardware ecc provides syndromes then
900 * the ecc code must be written immidiately after
901 * the data bytes (words) */
902 if (this->options & NAND_HWECC_SYNDROME)
903 this->write_buf(mtd, ecc_code, eccbytes);
904 datidx += this->eccsize;
909 /* Write out OOB data */
910 if (this->options & NAND_HWECC_SYNDROME)
911 this->write_buf(mtd, &oob_buf[oobsel->eccbytes], mtd->oobsize - oobsel->eccbytes);
913 this->write_buf(mtd, oob_buf, mtd->oobsize);
915 /* Send command to actually program the data */
916 this->cmdfunc(mtd, cached ? NAND_CMD_CACHEDPROG : NAND_CMD_PAGEPROG, -1, -1);
919 /* call wait ready function */
920 status = this->waitfunc(mtd, this, FL_WRITING);
922 /* See if operation failed and additional status checks are available */
923 if ((status & NAND_STATUS_FAIL) && (this->errstat)) {
924 status = this->errstat(mtd, this, FL_WRITING, status, page);
927 /* See if device thinks it succeeded */
928 if (status & NAND_STATUS_FAIL) {
929 DEBUG(MTD_DEBUG_LEVEL0, "%s: " "Failed write, page 0x%08x, ", __FUNCTION__, page);
933 /* FIXME: Implement cached programming ! */
934 /* wait until cache is ready */
935 // status = this->waitfunc (mtd, this, FL_CACHEDRPG);
940 #ifdef CONFIG_MTD_NAND_VERIFY_WRITE
942 * nand_verify_pages - [GENERIC] verify the chip contents after a write
943 * @mtd: MTD device structure
944 * @this: NAND chip structure
945 * @page: startpage inside the chip, must be called with (page & this->pagemask)
946 * @numpages: number of pages to verify
947 * @oob_buf: out of band data buffer
948 * @oobsel: out of band selecttion structre
949 * @chipnr: number of the current chip
950 * @oobmode: 1 = full buffer verify, 0 = ecc only
952 * The NAND device assumes that it is always writing to a cleanly erased page.
953 * Hence, it performs its internal write verification only on bits that
954 * transitioned from 1 to 0. The device does NOT verify the whole page on a
955 * byte by byte basis. It is possible that the page was not completely erased
956 * or the page is becoming unusable due to wear. The read with ECC would catch
957 * the error later when the ECC page check fails, but we would rather catch
958 * it early in the page write stage. Better to write no data than invalid data.
960 static int nand_verify_pages(struct mtd_info *mtd, struct nand_chip *this, int page, int numpages,
961 u_char *oob_buf, struct nand_oobinfo *oobsel, int chipnr, int oobmode)
963 int i, j, datidx = 0, oobofs = 0, res = -EIO;
964 int eccsteps = this->eccsteps;
968 hweccbytes = (this->options & NAND_HWECC_SYNDROME) ? (oobsel->eccbytes / eccsteps) : 0;
970 /* Send command to read back the first page */
971 this->cmdfunc(mtd, NAND_CMD_READ0, 0, page);
974 for (j = 0; j < eccsteps; j++) {
975 /* Loop through and verify the data */
976 if (this->verify_buf(mtd, &this->data_poi[datidx], mtd->eccsize)) {
977 DEBUG(MTD_DEBUG_LEVEL0, "%s: " "Failed write verify, page 0x%08x ", __FUNCTION__, page);
980 datidx += mtd->eccsize;
981 /* Have we a hw generator layout ? */
984 if (this->verify_buf(mtd, &this->oob_buf[oobofs], hweccbytes)) {
985 DEBUG(MTD_DEBUG_LEVEL0, "%s: " "Failed write verify, page 0x%08x ", __FUNCTION__, page);
988 oobofs += hweccbytes;
991 /* check, if we must compare all data or if we just have to
992 * compare the ecc bytes
995 if (this->verify_buf(mtd, &oob_buf[oobofs], mtd->oobsize - hweccbytes * eccsteps)) {
996 DEBUG(MTD_DEBUG_LEVEL0, "%s: " "Failed write verify, page 0x%08x ", __FUNCTION__, page);
1000 /* Read always, else autoincrement fails */
1001 this->read_buf(mtd, oobdata, mtd->oobsize - hweccbytes * eccsteps);
1003 if (oobsel->useecc != MTD_NANDECC_OFF && !hweccbytes) {
1004 int ecccnt = oobsel->eccbytes;
1006 for (i = 0; i < ecccnt; i++) {
1007 int idx = oobsel->eccpos[i];
1008 if (oobdata[idx] != oob_buf[oobofs + idx]) {
1009 DEBUG(MTD_DEBUG_LEVEL0, "%s: Failed ECC write verify, page 0x%08x, %6i bytes were succesful\n",
1010 __FUNCTION__, page, i);
1016 oobofs += mtd->oobsize - hweccbytes * eccsteps;
1020 /* Apply delay or wait for ready/busy pin
1021 * Do this before the AUTOINCR check, so no problems
1022 * arise if a chip which does auto increment
1023 * is marked as NOAUTOINCR by the board driver.
1024 * Do this also before returning, so the chip is
1025 * ready for the next command.
1027 if (!this->dev_ready)
1028 udelay(this->chip_delay);
1030 nand_wait_ready(mtd);
1032 /* All done, return happy */
1036 /* Check, if the chip supports auto page increment */
1037 if (!NAND_CANAUTOINCR(this))
1038 this->cmdfunc(mtd, NAND_CMD_READ0, 0x00, page);
1041 * Terminate the read command. We come here in case of an error
1042 * So we must issue a reset command.
1045 this->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
1051 * nand_read - [MTD Interface] MTD compability function for nand_do_read_ecc
1052 * @mtd: MTD device structure
1053 * @from: offset to read from
1054 * @len: number of bytes to read
1055 * @retlen: pointer to variable to store the number of read bytes
1056 * @buf: the databuffer to put data
1058 * This function simply calls nand_do_read_ecc with oob buffer and oobsel = NULL
1061 static int nand_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf)
1063 return nand_do_read_ecc(mtd, from, len, retlen, buf, NULL, &mtd->oobinfo, 0xff);
1067 * nand_read_ecc - [MTD Interface] MTD compability function for nand_do_read_ecc
1068 * @mtd: MTD device structure
1069 * @from: offset to read from
1070 * @len: number of bytes to read
1071 * @retlen: pointer to variable to store the number of read bytes
1072 * @buf: the databuffer to put data
1073 * @oob_buf: filesystem supplied oob data buffer
1074 * @oobsel: oob selection structure
1076 * This function simply calls nand_do_read_ecc with flags = 0xff
1078 static int nand_read_ecc(struct mtd_info *mtd, loff_t from, size_t len,
1079 size_t *retlen, u_char *buf, u_char *oob_buf, struct nand_oobinfo *oobsel)
1081 /* use userspace supplied oobinfo, if zero */
1083 oobsel = &mtd->oobinfo;
1084 return nand_do_read_ecc(mtd, from, len, retlen, buf, oob_buf, oobsel, 0xff);
1088 * nand_do_read_ecc - [MTD Interface] Read data with ECC
1089 * @mtd: MTD device structure
1090 * @from: offset to read from
1091 * @len: number of bytes to read
1092 * @retlen: pointer to variable to store the number of read bytes
1093 * @buf: the databuffer to put data
1094 * @oob_buf: filesystem supplied oob data buffer (can be NULL)
1095 * @oobsel: oob selection structure
1096 * @flags: flag to indicate if nand_get_device/nand_release_device should be preformed
1097 * and how many corrected error bits are acceptable:
1098 * bits 0..7 - number of tolerable errors
1099 * bit 8 - 0 == do not get/release chip, 1 == get/release chip
1101 * NAND read with ECC
1103 int nand_do_read_ecc(struct mtd_info *mtd, loff_t from, size_t len,
1104 size_t *retlen, u_char *buf, u_char *oob_buf, struct nand_oobinfo *oobsel, int flags)
1107 int i, j, col, realpage, page, end, ecc, chipnr, sndcmd = 1;
1108 int read = 0, oob = 0, ecc_status = 0, ecc_failed = 0;
1109 struct nand_chip *this = mtd->priv;
1110 u_char *data_poi, *oob_data = oob_buf;
1111 u_char ecc_calc[32];
1112 u_char ecc_code[32];
1113 int eccmode, eccsteps;
1114 int *oob_config, datidx;
1115 int blockcheck = (1 << (this->phys_erase_shift - this->page_shift)) - 1;
1120 DEBUG(MTD_DEBUG_LEVEL3, "nand_read_ecc: from = 0x%08x, len = %i\n", (unsigned int)from, (int)len);
1122 /* Do not allow reads past end of device */
1123 if ((from + len) > mtd->size) {
1124 DEBUG(MTD_DEBUG_LEVEL0, "nand_read_ecc: Attempt read beyond end of device\n");
1129 /* Grab the lock and see if the device is available */
1130 if (flags & NAND_GET_DEVICE)
1131 nand_get_device(this, mtd, FL_READING);
1133 /* Autoplace of oob data ? Use the default placement scheme */
1134 if (oobsel->useecc == MTD_NANDECC_AUTOPLACE)
1135 oobsel = this->autooob;
1137 eccmode = oobsel->useecc ? this->eccmode : NAND_ECC_NONE;
1138 oob_config = oobsel->eccpos;
1140 /* Select the NAND device */
1141 chipnr = (int)(from >> this->chip_shift);
1142 this->select_chip(mtd, chipnr);
1144 /* First we calculate the starting page */
1145 realpage = (int)(from >> this->page_shift);
1146 page = realpage & this->pagemask;
1148 /* Get raw starting column */
1149 col = from & (mtd->oobblock - 1);
1151 end = mtd->oobblock;
1152 ecc = this->eccsize;
1153 eccbytes = this->eccbytes;
1155 if ((eccmode == NAND_ECC_NONE) || (this->options & NAND_HWECC_SYNDROME))
1158 oobreadlen = mtd->oobsize;
1159 if (this->options & NAND_HWECC_SYNDROME)
1160 oobreadlen -= oobsel->eccbytes;
1162 /* Loop until all data read */
1163 while (read < len) {
1165 int aligned = (!col && (len - read) >= end);
1167 * If the read is not page aligned, we have to read into data buffer
1168 * due to ecc, else we read into return buffer direct
1171 data_poi = &buf[read];
1173 data_poi = this->data_buf;
1175 /* Check, if we have this page in the buffer
1177 * FIXME: Make it work when we must provide oob data too,
1178 * check the usage of data_buf oob field
1180 if (realpage == this->pagebuf && !oob_buf) {
1181 /* aligned read ? */
1183 memcpy(data_poi, this->data_buf, end);
1187 /* Check, if we must send the read command */
1189 this->cmdfunc(mtd, NAND_CMD_READ0, 0x00, page);
1193 /* get oob area, if we have no oob buffer from fs-driver */
1194 if (!oob_buf || oobsel->useecc == MTD_NANDECC_AUTOPLACE ||
1195 oobsel->useecc == MTD_NANDECC_AUTOPL_USR)
1196 oob_data = &this->data_buf[end];
1198 eccsteps = this->eccsteps;
1201 case NAND_ECC_NONE:{
1202 /* No ECC, Read in a page */
1203 static unsigned long lastwhinge = 0;
1204 if ((lastwhinge / HZ) != (jiffies / HZ)) {
1206 "Reading data from NAND FLASH without ECC is not recommended\n");
1207 lastwhinge = jiffies;
1209 this->read_buf(mtd, data_poi, end);
1213 case NAND_ECC_SOFT: /* Software ECC 3/256: Read in a page + oob data */
1214 this->read_buf(mtd, data_poi, end);
1215 for (i = 0, datidx = 0; eccsteps; eccsteps--, i += 3, datidx += ecc)
1216 this->calculate_ecc(mtd, &data_poi[datidx], &ecc_calc[i]);
1220 for (i = 0, datidx = 0; eccsteps; eccsteps--, i += eccbytes, datidx += ecc) {
1221 this->enable_hwecc(mtd, NAND_ECC_READ);
1222 this->read_buf(mtd, &data_poi[datidx], ecc);
1224 /* HW ecc with syndrome calculation must read the
1225 * syndrome from flash immidiately after the data */
1227 /* Some hw ecc generators need to know when the
1228 * syndrome is read from flash */
1229 this->enable_hwecc(mtd, NAND_ECC_READSYN);
1230 this->read_buf(mtd, &oob_data[i], eccbytes);
1231 /* We calc error correction directly, it checks the hw
1232 * generator for an error, reads back the syndrome and
1233 * does the error correction on the fly */
1234 ecc_status = this->correct_data(mtd, &data_poi[datidx], &oob_data[i], &ecc_code[i]);
1235 if ((ecc_status == -1) || (ecc_status > (flags && 0xff))) {
1236 DEBUG(MTD_DEBUG_LEVEL0, "nand_read_ecc: "
1237 "Failed ECC read, page 0x%08x on chip %d\n", page, chipnr);
1241 this->calculate_ecc(mtd, &data_poi[datidx], &ecc_calc[i]);
1248 this->read_buf(mtd, &oob_data[mtd->oobsize - oobreadlen], oobreadlen);
1250 /* Skip ECC check, if not requested (ECC_NONE or HW_ECC with syndromes) */
1254 /* Pick the ECC bytes out of the oob data */
1255 for (j = 0; j < oobsel->eccbytes; j++)
1256 ecc_code[j] = oob_data[oob_config[j]];
1258 /* correct data, if necessary */
1259 for (i = 0, j = 0, datidx = 0; i < this->eccsteps; i++, datidx += ecc) {
1260 ecc_status = this->correct_data(mtd, &data_poi[datidx], &ecc_code[j], &ecc_calc[j]);
1262 /* Get next chunk of ecc bytes */
1265 /* Check, if we have a fs supplied oob-buffer,
1266 * This is the legacy mode. Used by YAFFS1
1267 * Should go away some day
1269 if (oob_buf && oobsel->useecc == MTD_NANDECC_PLACE) {
1270 int *p = (int *)(&oob_data[mtd->oobsize]);
1274 if ((ecc_status == -1) || (ecc_status > (flags && 0xff))) {
1275 DEBUG(MTD_DEBUG_LEVEL0, "nand_read_ecc: " "Failed ECC read, page 0x%08x\n", page);
1281 /* check, if we have a fs supplied oob-buffer */
1283 /* without autoplace. Legacy mode used by YAFFS1 */
1284 switch (oobsel->useecc) {
1285 case MTD_NANDECC_AUTOPLACE:
1286 case MTD_NANDECC_AUTOPL_USR:
1287 /* Walk through the autoplace chunks */
1288 for (i = 0; oobsel->oobfree[i][1]; i++) {
1289 int from = oobsel->oobfree[i][0];
1290 int num = oobsel->oobfree[i][1];
1291 memcpy(&oob_buf[oob], &oob_data[from], num);
1295 case MTD_NANDECC_PLACE:
1296 /* YAFFS1 legacy mode */
1297 oob_data += this->eccsteps * sizeof(int);
1299 oob_data += mtd->oobsize;
1303 /* Partial page read, transfer data into fs buffer */
1305 for (j = col; j < end && read < len; j++)
1306 buf[read++] = data_poi[j];
1307 this->pagebuf = realpage;
1309 read += mtd->oobblock;
1311 /* Apply delay or wait for ready/busy pin
1312 * Do this before the AUTOINCR check, so no problems
1313 * arise if a chip which does auto increment
1314 * is marked as NOAUTOINCR by the board driver.
1316 if (!this->dev_ready)
1317 udelay(this->chip_delay);
1319 nand_wait_ready(mtd);
1324 /* For subsequent reads align to page boundary. */
1326 /* Increment page address */
1329 page = realpage & this->pagemask;
1330 /* Check, if we cross a chip boundary */
1333 this->select_chip(mtd, -1);
1334 this->select_chip(mtd, chipnr);
1336 /* Check, if the chip supports auto page increment
1337 * or if we have hit a block boundary.
1339 if (!NAND_CANAUTOINCR(this) || !(page & blockcheck))
1343 /* Deselect and wake up anyone waiting on the device */
1344 if (flags & NAND_GET_DEVICE)
1345 nand_release_device(mtd);
1348 * Return success, if no ECC failures, else -EBADMSG
1349 * fs driver will take care of that, because
1350 * retlen == desired len and result == -EBADMSG
1353 return ecc_failed ? -EBADMSG : 0;
1357 * nand_read_oob - [MTD Interface] NAND read out-of-band
1358 * @mtd: MTD device structure
1359 * @from: offset to read from
1360 * @len: number of bytes to read
1361 * @retlen: pointer to variable to store the number of read bytes
1362 * @buf: the databuffer to put data
1364 * NAND read out-of-band data from the spare area
1366 static int nand_read_oob(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf)
1368 int i, col, page, chipnr;
1369 struct nand_chip *this = mtd->priv;
1370 int blockcheck = (1 << (this->phys_erase_shift - this->page_shift)) - 1;
1372 DEBUG(MTD_DEBUG_LEVEL3, "nand_read_oob: from = 0x%08x, len = %i\n", (unsigned int)from, (int)len);
1374 /* Shift to get page */
1375 page = (int)(from >> this->page_shift);
1376 chipnr = (int)(from >> this->chip_shift);
1378 /* Mask to get column */
1379 col = from & (mtd->oobsize - 1);
1381 /* Initialize return length value */
1384 /* Do not allow reads past end of device */
1385 if ((from + len) > mtd->size) {
1386 DEBUG(MTD_DEBUG_LEVEL0, "nand_read_oob: Attempt read beyond end of device\n");
1391 /* Grab the lock and see if the device is available */
1392 nand_get_device(this, mtd, FL_READING);
1394 /* Select the NAND device */
1395 this->select_chip(mtd, chipnr);
1397 /* Send the read command */
1398 this->cmdfunc(mtd, NAND_CMD_READOOB, col, page & this->pagemask);
1400 * Read the data, if we read more than one page
1401 * oob data, let the device transfer the data !
1405 int thislen = mtd->oobsize - col;
1406 thislen = min_t(int, thislen, len);
1407 this->read_buf(mtd, &buf[i], thislen);
1415 /* Check, if we cross a chip boundary */
1416 if (!(page & this->pagemask)) {
1418 this->select_chip(mtd, -1);
1419 this->select_chip(mtd, chipnr);
1422 /* Apply delay or wait for ready/busy pin
1423 * Do this before the AUTOINCR check, so no problems
1424 * arise if a chip which does auto increment
1425 * is marked as NOAUTOINCR by the board driver.
1427 if (!this->dev_ready)
1428 udelay(this->chip_delay);
1430 nand_wait_ready(mtd);
1432 /* Check, if the chip supports auto page increment
1433 * or if we have hit a block boundary.
1435 if (!NAND_CANAUTOINCR(this) || !(page & blockcheck)) {
1436 /* For subsequent page reads set offset to 0 */
1437 this->cmdfunc(mtd, NAND_CMD_READOOB, 0x0, page & this->pagemask);
1442 /* Deselect and wake up anyone waiting on the device */
1443 nand_release_device(mtd);
1451 * nand_read_raw - [GENERIC] Read raw data including oob into buffer
1452 * @mtd: MTD device structure
1453 * @buf: temporary buffer
1454 * @from: offset to read from
1455 * @len: number of bytes to read
1456 * @ooblen: number of oob data bytes to read
1458 * Read raw data including oob into buffer
1460 int nand_read_raw(struct mtd_info *mtd, uint8_t *buf, loff_t from, size_t len, size_t ooblen)
1462 struct nand_chip *this = mtd->priv;
1463 int page = (int)(from >> this->page_shift);
1464 int chip = (int)(from >> this->chip_shift);
1467 int pagesize = mtd->oobblock + mtd->oobsize;
1468 int blockcheck = (1 << (this->phys_erase_shift - this->page_shift)) - 1;
1470 /* Do not allow reads past end of device */
1471 if ((from + len) > mtd->size) {
1472 DEBUG(MTD_DEBUG_LEVEL0, "nand_read_raw: Attempt read beyond end of device\n");
1476 /* Grab the lock and see if the device is available */
1477 nand_get_device(this, mtd, FL_READING);
1479 this->select_chip(mtd, chip);
1481 /* Add requested oob length */
1486 this->cmdfunc(mtd, NAND_CMD_READ0, 0, page & this->pagemask);
1489 this->read_buf(mtd, &buf[cnt], pagesize);
1495 if (!this->dev_ready)
1496 udelay(this->chip_delay);
1498 nand_wait_ready(mtd);
1500 /* Check, if the chip supports auto page increment */
1501 if (!NAND_CANAUTOINCR(this) || !(page & blockcheck))
1505 /* Deselect and wake up anyone waiting on the device */
1506 nand_release_device(mtd);
1511 * nand_prepare_oobbuf - [GENERIC] Prepare the out of band buffer
1512 * @mtd: MTD device structure
1513 * @fsbuf: buffer given by fs driver
1514 * @oobsel: out of band selection structre
1515 * @autoplace: 1 = place given buffer into the oob bytes
1516 * @numpages: number of pages to prepare
1519 * 1. Filesystem buffer available and autoplacement is off,
1520 * return filesystem buffer
1521 * 2. No filesystem buffer or autoplace is off, return internal
1523 * 3. Filesystem buffer is given and autoplace selected
1524 * put data from fs buffer into internal buffer and
1525 * retrun internal buffer
1527 * Note: The internal buffer is filled with 0xff. This must
1528 * be done only once, when no autoplacement happens
1529 * Autoplacement sets the buffer dirty flag, which
1530 * forces the 0xff fill before using the buffer again.
1533 static u_char *nand_prepare_oobbuf(struct mtd_info *mtd, u_char *fsbuf, struct nand_oobinfo *oobsel,
1534 int autoplace, int numpages)
1536 struct nand_chip *this = mtd->priv;
1539 /* Zero copy fs supplied buffer */
1540 if (fsbuf && !autoplace)
1543 /* Check, if the buffer must be filled with ff again */
1544 if (this->oobdirty) {
1545 memset(this->oob_buf, 0xff, mtd->oobsize << (this->phys_erase_shift - this->page_shift));
1549 /* If we have no autoplacement or no fs buffer use the internal one */
1550 if (!autoplace || !fsbuf)
1551 return this->oob_buf;
1553 /* Walk through the pages and place the data */
1556 while (numpages--) {
1557 for (i = 0, len = 0; len < mtd->oobavail; i++) {
1558 int to = ofs + oobsel->oobfree[i][0];
1559 int num = oobsel->oobfree[i][1];
1560 memcpy(&this->oob_buf[to], fsbuf, num);
1564 ofs += mtd->oobavail;
1566 return this->oob_buf;
1569 #define NOTALIGNED(x) (x & (mtd->oobblock-1)) != 0
1572 * nand_write - [MTD Interface] compability function for nand_write_ecc
1573 * @mtd: MTD device structure
1574 * @to: offset to write to
1575 * @len: number of bytes to write
1576 * @retlen: pointer to variable to store the number of written bytes
1577 * @buf: the data to write
1579 * This function simply calls nand_write_ecc with oob buffer and oobsel = NULL
1582 static int nand_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf)
1584 return (nand_write_ecc(mtd, to, len, retlen, buf, NULL, NULL));
1588 * nand_write_ecc - [MTD Interface] NAND write with ECC
1589 * @mtd: MTD device structure
1590 * @to: offset to write to
1591 * @len: number of bytes to write
1592 * @retlen: pointer to variable to store the number of written bytes
1593 * @buf: the data to write
1594 * @eccbuf: filesystem supplied oob data buffer
1595 * @oobsel: oob selection structure
1597 * NAND write with ECC
1599 static int nand_write_ecc(struct mtd_info *mtd, loff_t to, size_t len,
1600 size_t *retlen, const u_char *buf, u_char *eccbuf,
1601 struct nand_oobinfo *oobsel)
1603 int startpage, page, ret = -EIO, oob = 0, written = 0, chipnr;
1604 int autoplace = 0, numpages, totalpages;
1605 struct nand_chip *this = mtd->priv;
1606 u_char *oobbuf, *bufstart;
1607 int ppblock = (1 << (this->phys_erase_shift - this->page_shift));
1609 DEBUG(MTD_DEBUG_LEVEL3, "nand_write_ecc: to = 0x%08x, len = %i\n", (unsigned int)to, (int)len);
1611 /* Initialize retlen, in case of early exit */
1614 /* Do not allow write past end of device */
1615 if ((to + len) > mtd->size) {
1616 DEBUG(MTD_DEBUG_LEVEL0, "nand_write_ecc: Attempt to write past end of page\n");
1620 /* reject writes, which are not page aligned */
1621 if (NOTALIGNED(to) || NOTALIGNED(len)) {
1622 printk(KERN_NOTICE "nand_write_ecc: Attempt to write not page aligned data\n");
1626 /* Grab the lock and see if the device is available */
1627 nand_get_device(this, mtd, FL_WRITING);
1629 /* Calculate chipnr */
1630 chipnr = (int)(to >> this->chip_shift);
1631 /* Select the NAND device */
1632 this->select_chip(mtd, chipnr);
1634 /* Check, if it is write protected */
1635 if (nand_check_wp(mtd))
1638 /* if oobsel is NULL, use chip defaults */
1640 oobsel = &mtd->oobinfo;
1642 /* Autoplace of oob data ? Use the default placement scheme */
1643 if (oobsel->useecc == MTD_NANDECC_AUTOPLACE) {
1644 oobsel = this->autooob;
1647 if (oobsel->useecc == MTD_NANDECC_AUTOPL_USR)
1650 /* Setup variables and oob buffer */
1651 totalpages = len >> this->page_shift;
1652 page = (int)(to >> this->page_shift);
1653 /* Invalidate the page cache, if we write to the cached page */
1654 if (page <= this->pagebuf && this->pagebuf < (page + totalpages))
1657 /* Set it relative to chip */
1658 page &= this->pagemask;
1660 /* Calc number of pages we can write in one go */
1661 numpages = min(ppblock - (startpage & (ppblock - 1)), totalpages);
1662 oobbuf = nand_prepare_oobbuf(mtd, eccbuf, oobsel, autoplace, numpages);
1663 bufstart = (u_char *) buf;
1665 /* Loop until all data is written */
1666 while (written < len) {
1668 this->data_poi = (u_char *) &buf[written];
1669 /* Write one page. If this is the last page to write
1670 * or the last page in this block, then use the
1671 * real pageprogram command, else select cached programming
1672 * if supported by the chip.
1674 ret = nand_write_page(mtd, this, page, &oobbuf[oob], oobsel, (--numpages > 0));
1676 DEBUG(MTD_DEBUG_LEVEL0, "nand_write_ecc: write_page failed %d\n", ret);
1680 oob += mtd->oobsize;
1681 /* Update written bytes count */
1682 written += mtd->oobblock;
1686 /* Increment page address */
1689 /* Have we hit a block boundary ? Then we have to verify and
1690 * if verify is ok, we have to setup the oob buffer for
1693 if (!(page & (ppblock - 1))) {
1695 this->data_poi = bufstart;
1696 ret = nand_verify_pages(mtd, this, startpage, page - startpage,
1697 oobbuf, oobsel, chipnr, (eccbuf != NULL));
1699 DEBUG(MTD_DEBUG_LEVEL0, "nand_write_ecc: verify_pages failed %d\n", ret);
1704 ofs = autoplace ? mtd->oobavail : mtd->oobsize;
1706 eccbuf += (page - startpage) * ofs;
1707 totalpages -= page - startpage;
1708 numpages = min(totalpages, ppblock);
1709 page &= this->pagemask;
1711 oobbuf = nand_prepare_oobbuf(mtd, eccbuf, oobsel, autoplace, numpages);
1713 /* Check, if we cross a chip boundary */
1716 this->select_chip(mtd, -1);
1717 this->select_chip(mtd, chipnr);
1721 /* Verify the remaining pages */
1723 this->data_poi = bufstart;
1724 ret = nand_verify_pages(mtd, this, startpage, totalpages, oobbuf, oobsel, chipnr, (eccbuf != NULL));
1728 DEBUG(MTD_DEBUG_LEVEL0, "nand_write_ecc: verify_pages failed %d\n", ret);
1731 /* Deselect and wake up anyone waiting on the device */
1732 nand_release_device(mtd);
1738 * nand_write_oob - [MTD Interface] NAND write out-of-band
1739 * @mtd: MTD device structure
1740 * @to: offset to write to
1741 * @len: number of bytes to write
1742 * @retlen: pointer to variable to store the number of written bytes
1743 * @buf: the data to write
1745 * NAND write out-of-band
1747 static int nand_write_oob(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, const u_char *buf)
1749 int column, page, status, ret = -EIO, chipnr;
1750 struct nand_chip *this = mtd->priv;
1752 DEBUG(MTD_DEBUG_LEVEL3, "nand_write_oob: to = 0x%08x, len = %i\n", (unsigned int)to, (int)len);
1754 /* Shift to get page */
1755 page = (int)(to >> this->page_shift);
1756 chipnr = (int)(to >> this->chip_shift);
1758 /* Mask to get column */
1759 column = to & (mtd->oobsize - 1);
1761 /* Initialize return length value */
1764 /* Do not allow write past end of page */
1765 if ((column + len) > mtd->oobsize) {
1766 DEBUG(MTD_DEBUG_LEVEL0, "nand_write_oob: Attempt to write past end of page\n");
1770 /* Grab the lock and see if the device is available */
1771 nand_get_device(this, mtd, FL_WRITING);
1773 /* Select the NAND device */
1774 this->select_chip(mtd, chipnr);
1776 /* Reset the chip. Some chips (like the Toshiba TC5832DC found
1777 in one of my DiskOnChip 2000 test units) will clear the whole
1778 data page too if we don't do this. I have no clue why, but
1779 I seem to have 'fixed' it in the doc2000 driver in
1780 August 1999. dwmw2. */
1781 this->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
1783 /* Check, if it is write protected */
1784 if (nand_check_wp(mtd))
1787 /* Invalidate the page cache, if we write to the cached page */
1788 if (page == this->pagebuf)
1791 if (NAND_MUST_PAD(this)) {
1792 /* Write out desired data */
1793 this->cmdfunc(mtd, NAND_CMD_SEQIN, mtd->oobblock, page & this->pagemask);
1794 /* prepad 0xff for partial programming */
1795 this->write_buf(mtd, ffchars, column);
1797 this->write_buf(mtd, buf, len);
1798 /* postpad 0xff for partial programming */
1799 this->write_buf(mtd, ffchars, mtd->oobsize - (len + column));
1801 /* Write out desired data */
1802 this->cmdfunc(mtd, NAND_CMD_SEQIN, mtd->oobblock + column, page & this->pagemask);
1804 this->write_buf(mtd, buf, len);
1806 /* Send command to program the OOB data */
1807 this->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1809 status = this->waitfunc(mtd, this, FL_WRITING);
1811 /* See if device thinks it succeeded */
1812 if (status & NAND_STATUS_FAIL) {
1813 DEBUG(MTD_DEBUG_LEVEL0, "nand_write_oob: " "Failed write, page 0x%08x\n", page);
1820 #ifdef CONFIG_MTD_NAND_VERIFY_WRITE
1821 /* Send command to read back the data */
1822 this->cmdfunc(mtd, NAND_CMD_READOOB, column, page & this->pagemask);
1824 if (this->verify_buf(mtd, buf, len)) {
1825 DEBUG(MTD_DEBUG_LEVEL0, "nand_write_oob: " "Failed write verify, page 0x%08x\n", page);
1832 /* Deselect and wake up anyone waiting on the device */
1833 nand_release_device(mtd);
1839 * nand_writev - [MTD Interface] compabilty function for nand_writev_ecc
1840 * @mtd: MTD device structure
1841 * @vecs: the iovectors to write
1842 * @count: number of vectors
1843 * @to: offset to write to
1844 * @retlen: pointer to variable to store the number of written bytes
1846 * NAND write with kvec. This just calls the ecc function
1848 static int nand_writev(struct mtd_info *mtd, const struct kvec *vecs, unsigned long count,
1849 loff_t to, size_t *retlen)
1851 return (nand_writev_ecc(mtd, vecs, count, to, retlen, NULL, NULL));
1855 * nand_writev_ecc - [MTD Interface] write with iovec with ecc
1856 * @mtd: MTD device structure
1857 * @vecs: the iovectors to write
1858 * @count: number of vectors
1859 * @to: offset to write to
1860 * @retlen: pointer to variable to store the number of written bytes
1861 * @eccbuf: filesystem supplied oob data buffer
1862 * @oobsel: oob selection structure
1864 * NAND write with iovec with ecc
1866 static int nand_writev_ecc(struct mtd_info *mtd, const struct kvec *vecs, unsigned long count,
1867 loff_t to, size_t *retlen, u_char *eccbuf, struct nand_oobinfo *oobsel)
1869 int i, page, len, total_len, ret = -EIO, written = 0, chipnr;
1870 int oob, numpages, autoplace = 0, startpage;
1871 struct nand_chip *this = mtd->priv;
1872 int ppblock = (1 << (this->phys_erase_shift - this->page_shift));
1873 u_char *oobbuf, *bufstart;
1875 /* Preset written len for early exit */
1878 /* Calculate total length of data */
1880 for (i = 0; i < count; i++)
1881 total_len += (int)vecs[i].iov_len;
1883 DEBUG(MTD_DEBUG_LEVEL3, "nand_writev: to = 0x%08x, len = %i, count = %ld\n", (unsigned int)to, (unsigned int)total_len, count);
1885 /* Do not allow write past end of page */
1886 if ((to + total_len) > mtd->size) {
1887 DEBUG(MTD_DEBUG_LEVEL0, "nand_writev: Attempted write past end of device\n");
1891 /* reject writes, which are not page aligned */
1892 if (NOTALIGNED(to) || NOTALIGNED(total_len)) {
1893 printk(KERN_NOTICE "nand_write_ecc: Attempt to write not page aligned data\n");
1897 /* Grab the lock and see if the device is available */
1898 nand_get_device(this, mtd, FL_WRITING);
1900 /* Get the current chip-nr */
1901 chipnr = (int)(to >> this->chip_shift);
1902 /* Select the NAND device */
1903 this->select_chip(mtd, chipnr);
1905 /* Check, if it is write protected */
1906 if (nand_check_wp(mtd))
1909 /* if oobsel is NULL, use chip defaults */
1911 oobsel = &mtd->oobinfo;
1913 /* Autoplace of oob data ? Use the default placement scheme */
1914 if (oobsel->useecc == MTD_NANDECC_AUTOPLACE) {
1915 oobsel = this->autooob;
1918 if (oobsel->useecc == MTD_NANDECC_AUTOPL_USR)
1921 /* Setup start page */
1922 page = (int)(to >> this->page_shift);
1923 /* Invalidate the page cache, if we write to the cached page */
1924 if (page <= this->pagebuf && this->pagebuf < ((to + total_len) >> this->page_shift))
1927 startpage = page & this->pagemask;
1929 /* Loop until all kvec' data has been written */
1932 /* If the given tuple is >= pagesize then
1933 * write it out from the iov
1935 if ((vecs->iov_len - len) >= mtd->oobblock) {
1936 /* Calc number of pages we can write
1937 * out of this iov in one go */
1938 numpages = (vecs->iov_len - len) >> this->page_shift;
1939 /* Do not cross block boundaries */
1940 numpages = min(ppblock - (startpage & (ppblock - 1)), numpages);
1941 oobbuf = nand_prepare_oobbuf(mtd, NULL, oobsel, autoplace, numpages);
1942 bufstart = (u_char *) vecs->iov_base;
1944 this->data_poi = bufstart;
1946 for (i = 1; i <= numpages; i++) {
1947 /* Write one page. If this is the last page to write
1948 * then use the real pageprogram command, else select
1949 * cached programming if supported by the chip.
1951 ret = nand_write_page(mtd, this, page & this->pagemask,
1952 &oobbuf[oob], oobsel, i != numpages);
1955 this->data_poi += mtd->oobblock;
1956 len += mtd->oobblock;
1957 oob += mtd->oobsize;
1960 /* Check, if we have to switch to the next tuple */
1961 if (len >= (int)vecs->iov_len) {
1967 /* We must use the internal buffer, read data out of each
1968 * tuple until we have a full page to write
1971 while (cnt < mtd->oobblock) {
1972 if (vecs->iov_base != NULL && vecs->iov_len)
1973 this->data_buf[cnt++] = ((u_char *) vecs->iov_base)[len++];
1974 /* Check, if we have to switch to the next tuple */
1975 if (len >= (int)vecs->iov_len) {
1981 this->pagebuf = page;
1982 this->data_poi = this->data_buf;
1983 bufstart = this->data_poi;
1985 oobbuf = nand_prepare_oobbuf(mtd, NULL, oobsel, autoplace, numpages);
1986 ret = nand_write_page(mtd, this, page & this->pagemask, oobbuf, oobsel, 0);
1992 this->data_poi = bufstart;
1993 ret = nand_verify_pages(mtd, this, startpage, numpages, oobbuf, oobsel, chipnr, 0);
1997 written += mtd->oobblock * numpages;
2002 startpage = page & this->pagemask;
2003 /* Check, if we cross a chip boundary */
2006 this->select_chip(mtd, -1);
2007 this->select_chip(mtd, chipnr);
2012 /* Deselect and wake up anyone waiting on the device */
2013 nand_release_device(mtd);
2020 * single_erease_cmd - [GENERIC] NAND standard block erase command function
2021 * @mtd: MTD device structure
2022 * @page: the page address of the block which will be erased
2024 * Standard erase command for NAND chips
2026 static void single_erase_cmd(struct mtd_info *mtd, int page)
2028 struct nand_chip *this = mtd->priv;
2029 /* Send commands to erase a block */
2030 this->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
2031 this->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
2035 * multi_erease_cmd - [GENERIC] AND specific block erase command function
2036 * @mtd: MTD device structure
2037 * @page: the page address of the block which will be erased
2039 * AND multi block erase command function
2040 * Erase 4 consecutive blocks
2042 static void multi_erase_cmd(struct mtd_info *mtd, int page)
2044 struct nand_chip *this = mtd->priv;
2045 /* Send commands to erase a block */
2046 this->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
2047 this->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
2048 this->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
2049 this->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
2050 this->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
2054 * nand_erase - [MTD Interface] erase block(s)
2055 * @mtd: MTD device structure
2056 * @instr: erase instruction
2058 * Erase one ore more blocks
2060 static int nand_erase(struct mtd_info *mtd, struct erase_info *instr)
2062 return nand_erase_nand(mtd, instr, 0);
2065 #define BBT_PAGE_MASK 0xffffff3f
2067 * nand_erase_intern - [NAND Interface] erase block(s)
2068 * @mtd: MTD device structure
2069 * @instr: erase instruction
2070 * @allowbbt: allow erasing the bbt area
2072 * Erase one ore more blocks
2074 int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr, int allowbbt)
2076 int page, len, status, pages_per_block, ret, chipnr;
2077 struct nand_chip *this = mtd->priv;
2078 int rewrite_bbt[NAND_MAX_CHIPS]={0}; /* flags to indicate the page, if bbt needs to be rewritten. */
2079 unsigned int bbt_masked_page; /* bbt mask to compare to page being erased. */
2080 /* It is used to see if the current page is in the same */
2081 /* 256 block group and the same bank as the bbt. */
2083 DEBUG(MTD_DEBUG_LEVEL3, "nand_erase: start = 0x%08x, len = %i\n", (unsigned int)instr->addr, (unsigned int)instr->len);
2085 /* Start address must align on block boundary */
2086 if (instr->addr & ((1 << this->phys_erase_shift) - 1)) {
2087 DEBUG(MTD_DEBUG_LEVEL0, "nand_erase: Unaligned address\n");
2091 /* Length must align on block boundary */
2092 if (instr->len & ((1 << this->phys_erase_shift) - 1)) {
2093 DEBUG(MTD_DEBUG_LEVEL0, "nand_erase: Length not block aligned\n");
2097 /* Do not allow erase past end of device */
2098 if ((instr->len + instr->addr) > mtd->size) {
2099 DEBUG(MTD_DEBUG_LEVEL0, "nand_erase: Erase past end of device\n");
2103 instr->fail_addr = 0xffffffff;
2105 /* Grab the lock and see if the device is available */
2106 nand_get_device(this, mtd, FL_ERASING);
2108 /* Shift to get first page */
2109 page = (int)(instr->addr >> this->page_shift);
2110 chipnr = (int)(instr->addr >> this->chip_shift);
2112 /* Calculate pages in each block */
2113 pages_per_block = 1 << (this->phys_erase_shift - this->page_shift);
2115 /* Select the NAND device */
2116 this->select_chip(mtd, chipnr);
2118 /* Check the WP bit */
2119 /* Check, if it is write protected */
2120 if (nand_check_wp(mtd)) {
2121 DEBUG(MTD_DEBUG_LEVEL0, "nand_erase: Device is write protected!!!\n");
2122 instr->state = MTD_ERASE_FAILED;
2126 /* if BBT requires refresh, set the BBT page mask to see if the BBT should be rewritten */
2127 if (this->options & BBT_AUTO_REFRESH) {
2128 bbt_masked_page = this->bbt_td->pages[chipnr] & BBT_PAGE_MASK;
2130 bbt_masked_page = 0xffffffff; /* should not match anything */
2133 /* Loop through the pages */
2136 instr->state = MTD_ERASING;
2139 /* Check if we have a bad block, we do not erase bad blocks ! */
2140 if (nand_block_checkbad(mtd, ((loff_t) page) << this->page_shift, 0, allowbbt)) {
2141 printk(KERN_WARNING "nand_erase: attempt to erase a bad block at page 0x%08x\n", page);
2142 instr->state = MTD_ERASE_FAILED;
2146 /* Invalidate the page cache, if we erase the block which contains
2147 the current cached page */
2148 if (page <= this->pagebuf && this->pagebuf < (page + pages_per_block))
2151 this->erase_cmd(mtd, page & this->pagemask);
2153 status = this->waitfunc(mtd, this, FL_ERASING);
2155 /* See if operation failed and additional status checks are available */
2156 if ((status & NAND_STATUS_FAIL) && (this->errstat)) {
2157 status = this->errstat(mtd, this, FL_ERASING, status, page);
2160 /* See if block erase succeeded */
2161 if (status & NAND_STATUS_FAIL) {
2162 DEBUG(MTD_DEBUG_LEVEL0, "nand_erase: " "Failed erase, page 0x%08x\n", page);
2163 instr->state = MTD_ERASE_FAILED;
2164 instr->fail_addr = (page << this->page_shift);
2168 /* if BBT requires refresh, set the BBT rewrite flag to the page being erased */
2169 if (this->options & BBT_AUTO_REFRESH) {
2170 if (((page & BBT_PAGE_MASK) == bbt_masked_page) &&
2171 (page != this->bbt_td->pages[chipnr])) {
2172 rewrite_bbt[chipnr] = (page << this->page_shift);
2176 /* Increment page address and decrement length */
2177 len -= (1 << this->phys_erase_shift);
2178 page += pages_per_block;
2180 /* Check, if we cross a chip boundary */
2181 if (len && !(page & this->pagemask)) {
2183 this->select_chip(mtd, -1);
2184 this->select_chip(mtd, chipnr);
2186 /* if BBT requires refresh and BBT-PERCHIP,
2187 * set the BBT page mask to see if this BBT should be rewritten */
2188 if ((this->options & BBT_AUTO_REFRESH) && (this->bbt_td->options & NAND_BBT_PERCHIP)) {
2189 bbt_masked_page = this->bbt_td->pages[chipnr] & BBT_PAGE_MASK;
2194 instr->state = MTD_ERASE_DONE;
2198 ret = instr->state == MTD_ERASE_DONE ? 0 : -EIO;
2199 /* Do call back function */
2201 mtd_erase_callback(instr);
2203 /* Deselect and wake up anyone waiting on the device */
2204 nand_release_device(mtd);
2206 /* if BBT requires refresh and erase was successful, rewrite any selected bad block tables */
2207 if ((this->options & BBT_AUTO_REFRESH) && (!ret)) {
2208 for (chipnr = 0; chipnr < this->numchips; chipnr++) {
2209 if (rewrite_bbt[chipnr]) {
2210 /* update the BBT for chip */
2211 DEBUG(MTD_DEBUG_LEVEL0, "nand_erase_nand: nand_update_bbt (%d:0x%0x 0x%0x)\n",
2212 chipnr, rewrite_bbt[chipnr], this->bbt_td->pages[chipnr]);
2213 nand_update_bbt(mtd, rewrite_bbt[chipnr]);
2218 /* Return more or less happy */
2223 * nand_sync - [MTD Interface] sync
2224 * @mtd: MTD device structure
2226 * Sync is actually a wait for chip ready function
2228 static void nand_sync(struct mtd_info *mtd)
2230 struct nand_chip *this = mtd->priv;
2232 DEBUG(MTD_DEBUG_LEVEL3, "nand_sync: called\n");
2234 /* Grab the lock and see if the device is available */
2235 nand_get_device(this, mtd, FL_SYNCING);
2236 /* Release it and go back */
2237 nand_release_device(mtd);
2241 * nand_block_isbad - [MTD Interface] Check whether the block at the given offset is bad
2242 * @mtd: MTD device structure
2243 * @ofs: offset relative to mtd start
2245 static int nand_block_isbad(struct mtd_info *mtd, loff_t ofs)
2247 /* Check for invalid offset */
2248 if (ofs > mtd->size)
2251 return nand_block_checkbad(mtd, ofs, 1, 0);
2255 * nand_block_markbad - [MTD Interface] Mark the block at the given offset as bad
2256 * @mtd: MTD device structure
2257 * @ofs: offset relative to mtd start
2259 static int nand_block_markbad(struct mtd_info *mtd, loff_t ofs)
2261 struct nand_chip *this = mtd->priv;
2264 if ((ret = nand_block_isbad(mtd, ofs))) {
2265 /* If it was bad already, return success and do nothing. */
2271 return this->block_markbad(mtd, ofs);
2275 * nand_suspend - [MTD Interface] Suspend the NAND flash
2276 * @mtd: MTD device structure
2278 static int nand_suspend(struct mtd_info *mtd)
2280 struct nand_chip *this = mtd->priv;
2282 return nand_get_device(this, mtd, FL_PM_SUSPENDED);
2286 * nand_resume - [MTD Interface] Resume the NAND flash
2287 * @mtd: MTD device structure
2289 static void nand_resume(struct mtd_info *mtd)
2291 struct nand_chip *this = mtd->priv;
2293 if (this->state == FL_PM_SUSPENDED)
2294 nand_release_device(mtd);
2296 printk(KERN_ERR "resume() called for the chip which is not in suspended state\n");
2301 * Free allocated data structures
2303 static void nand_free_kmem(struct nand_chip *this)
2305 /* Buffer allocated by nand_scan ? */
2306 if (this->options & NAND_OOBBUF_ALLOC)
2307 kfree(this->oob_buf);
2308 /* Buffer allocated by nand_scan ? */
2309 if (this->options & NAND_DATABUF_ALLOC)
2310 kfree(this->data_buf);
2311 /* Controller allocated by nand_scan ? */
2312 if (this->options & NAND_CONTROLLER_ALLOC)
2313 kfree(this->controller);
2316 /* module_text_address() isn't exported, and it's mostly a pointless
2317 test if this is a module _anyway_ -- they'd have to try _really_ hard
2318 to call us from in-kernel code if the core NAND support is modular. */
2320 #define caller_is_module() (1)
2322 #define caller_is_module() module_text_address((unsigned long)__builtin_return_address(0))
2326 * nand_scan - [NAND Interface] Scan for the NAND device
2327 * @mtd: MTD device structure
2328 * @maxchips: Number of chips to scan for
2330 * This fills out all the uninitialized function pointers
2331 * with the defaults.
2332 * The flash ID is read and the mtd/chip structures are
2333 * filled with the appropriate values. Buffers are allocated if
2334 * they are not provided by the board driver
2335 * The mtd->owner field must be set to the module of the caller
2338 int nand_scan(struct mtd_info *mtd, int maxchips)
2340 int i, nand_maf_id, nand_dev_id, busw, maf_id;
2341 struct nand_chip *this = mtd->priv;
2343 /* Many callers got this wrong, so check for it for a while... */
2344 if (!mtd->owner && caller_is_module()) {
2345 printk(KERN_CRIT "nand_scan() called with NULL mtd->owner!\n");
2349 /* Get buswidth to select the correct functions */
2350 busw = this->options & NAND_BUSWIDTH_16;
2352 /* check for proper chip_delay setup, set 20us if not */
2353 if (!this->chip_delay)
2354 this->chip_delay = 20;
2356 /* check, if a user supplied command function given */
2357 if (this->cmdfunc == NULL)
2358 this->cmdfunc = nand_command;
2360 /* check, if a user supplied wait function given */
2361 if (this->waitfunc == NULL)
2362 this->waitfunc = nand_wait;
2364 if (!this->select_chip)
2365 this->select_chip = nand_select_chip;
2366 if (!this->write_byte)
2367 this->write_byte = busw ? nand_write_byte16 : nand_write_byte;
2368 if (!this->read_byte)
2369 this->read_byte = busw ? nand_read_byte16 : nand_read_byte;
2370 if (!this->write_word)
2371 this->write_word = nand_write_word;
2372 if (!this->read_word)
2373 this->read_word = nand_read_word;
2374 if (!this->block_bad)
2375 this->block_bad = nand_block_bad;
2376 if (!this->block_markbad)
2377 this->block_markbad = nand_default_block_markbad;
2378 if (!this->write_buf)
2379 this->write_buf = busw ? nand_write_buf16 : nand_write_buf;
2380 if (!this->read_buf)
2381 this->read_buf = busw ? nand_read_buf16 : nand_read_buf;
2382 if (!this->verify_buf)
2383 this->verify_buf = busw ? nand_verify_buf16 : nand_verify_buf;
2384 if (!this->scan_bbt)
2385 this->scan_bbt = nand_default_bbt;
2387 /* Select the device */
2388 this->select_chip(mtd, 0);
2390 /* Send the command for reading device ID */
2391 this->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
2393 /* Read manufacturer and device IDs */
2394 nand_maf_id = this->read_byte(mtd);
2395 nand_dev_id = this->read_byte(mtd);
2397 /* Print and store flash device information */
2398 for (i = 0; nand_flash_ids[i].name != NULL; i++) {
2400 if (nand_dev_id != nand_flash_ids[i].id)
2404 mtd->name = nand_flash_ids[i].name;
2405 this->chipsize = nand_flash_ids[i].chipsize << 20;
2407 /* New devices have all the information in additional id bytes */
2408 if (!nand_flash_ids[i].pagesize) {
2410 /* The 3rd id byte contains non relevant data ATM */
2411 extid = this->read_byte(mtd);
2412 /* The 4th id byte is the important one */
2413 extid = this->read_byte(mtd);
2415 mtd->oobblock = 1024 << (extid & 0x3);
2418 mtd->oobsize = (8 << (extid & 0x01)) * (mtd->oobblock >> 9);
2420 /* Calc blocksize. Blocksize is multiples of 64KiB */
2421 mtd->erasesize = (64 * 1024) << (extid & 0x03);
2423 /* Get buswidth information */
2424 busw = (extid & 0x01) ? NAND_BUSWIDTH_16 : 0;
2427 /* Old devices have this data hardcoded in the
2428 * device id table */
2429 mtd->erasesize = nand_flash_ids[i].erasesize;
2430 mtd->oobblock = nand_flash_ids[i].pagesize;
2431 mtd->oobsize = mtd->oobblock / 32;
2432 busw = nand_flash_ids[i].options & NAND_BUSWIDTH_16;
2435 /* Try to identify manufacturer */
2436 for (maf_id = 0; nand_manuf_ids[maf_id].id != 0x0; maf_id++) {
2437 if (nand_manuf_ids[maf_id].id == nand_maf_id)
2441 /* Check, if buswidth is correct. Hardware drivers should set
2443 if (busw != (this->options & NAND_BUSWIDTH_16)) {
2444 printk(KERN_INFO "NAND device: Manufacturer ID:"
2445 " 0x%02x, Chip ID: 0x%02x (%s %s)\n", nand_maf_id, nand_dev_id,
2446 nand_manuf_ids[maf_id].name, mtd->name);
2448 "NAND bus width %d instead %d bit\n",
2449 (this->options & NAND_BUSWIDTH_16) ? 16 : 8, busw ? 16 : 8);
2450 this->select_chip(mtd, -1);
2454 /* Calculate the address shift from the page size */
2455 this->page_shift = ffs(mtd->oobblock) - 1;
2456 this->bbt_erase_shift = this->phys_erase_shift = ffs(mtd->erasesize) - 1;
2457 this->chip_shift = ffs(this->chipsize) - 1;
2459 /* Set the bad block position */
2460 this->badblockpos = mtd->oobblock > 512 ? NAND_LARGE_BADBLOCK_POS : NAND_SMALL_BADBLOCK_POS;
2462 /* Get chip options, preserve non chip based options */
2463 this->options &= ~NAND_CHIPOPTIONS_MSK;
2464 this->options |= nand_flash_ids[i].options & NAND_CHIPOPTIONS_MSK;
2465 /* Set this as a default. Board drivers can override it, if necessary */
2466 this->options |= NAND_NO_AUTOINCR;
2467 /* Check if this is a not a samsung device. Do not clear the options
2468 * for chips which are not having an extended id.
2470 if (nand_maf_id != NAND_MFR_SAMSUNG && !nand_flash_ids[i].pagesize)
2471 this->options &= ~NAND_SAMSUNG_LP_OPTIONS;
2473 /* Check for AND chips with 4 page planes */
2474 if (this->options & NAND_4PAGE_ARRAY)
2475 this->erase_cmd = multi_erase_cmd;
2477 this->erase_cmd = single_erase_cmd;
2479 /* Do not replace user supplied command function ! */
2480 if (mtd->oobblock > 512 && this->cmdfunc == nand_command)
2481 this->cmdfunc = nand_command_lp;
2483 printk(KERN_INFO "NAND device: Manufacturer ID:"
2484 " 0x%02x, Chip ID: 0x%02x (%s %s)\n", nand_maf_id, nand_dev_id,
2485 nand_manuf_ids[maf_id].name, nand_flash_ids[i].name);
2489 if (!nand_flash_ids[i].name) {
2490 printk(KERN_WARNING "No NAND device found!!!\n");
2491 this->select_chip(mtd, -1);
2495 for (i = 1; i < maxchips; i++) {
2496 this->select_chip(mtd, i);
2498 /* Send the command for reading device ID */
2499 this->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
2501 /* Read manufacturer and device IDs */
2502 if (nand_maf_id != this->read_byte(mtd) ||
2503 nand_dev_id != this->read_byte(mtd))
2507 printk(KERN_INFO "%d NAND chips detected\n", i);
2509 /* Allocate buffers, if necessary */
2510 if (!this->oob_buf) {
2512 len = mtd->oobsize << (this->phys_erase_shift - this->page_shift);
2513 this->oob_buf = kmalloc(len, GFP_KERNEL);
2514 if (!this->oob_buf) {
2515 printk(KERN_ERR "nand_scan(): Cannot allocate oob_buf\n");
2518 this->options |= NAND_OOBBUF_ALLOC;
2521 if (!this->data_buf) {
2523 len = mtd->oobblock + mtd->oobsize;
2524 this->data_buf = kmalloc(len, GFP_KERNEL);
2525 if (!this->data_buf) {
2526 printk(KERN_ERR "nand_scan(): Cannot allocate data_buf\n");
2527 nand_free_kmem(this);
2530 this->options |= NAND_DATABUF_ALLOC;
2533 /* Store the number of chips and calc total size for mtd */
2535 mtd->size = i * this->chipsize;
2536 /* Convert chipsize to number of pages per chip -1. */
2537 this->pagemask = (this->chipsize >> this->page_shift) - 1;
2538 /* Preset the internal oob buffer */
2539 memset(this->oob_buf, 0xff, mtd->oobsize << (this->phys_erase_shift - this->page_shift));
2541 /* If no default placement scheme is given, select an
2542 * appropriate one */
2543 if (!this->autooob) {
2544 /* Select the appropriate default oob placement scheme for
2545 * placement agnostic filesystems */
2546 switch (mtd->oobsize) {
2548 this->autooob = &nand_oob_8;
2551 this->autooob = &nand_oob_16;
2554 this->autooob = &nand_oob_64;
2557 printk(KERN_WARNING "No oob scheme defined for oobsize %d\n", mtd->oobsize);
2562 /* The number of bytes available for the filesystem to place fs dependend
2565 for (i = 0; this->autooob->oobfree[i][1]; i++)
2566 mtd->oobavail += this->autooob->oobfree[i][1];
2569 * check ECC mode, default to software
2570 * if 3byte/512byte hardware ECC is selected and we have 256 byte pagesize
2571 * fallback to software ECC
2573 this->eccsize = 256; /* set default eccsize */
2576 switch (this->eccmode) {
2577 case NAND_ECC_HW12_2048:
2578 if (mtd->oobblock < 2048) {
2579 printk(KERN_WARNING "2048 byte HW ECC not possible on %d byte page size, fallback to SW ECC\n",
2581 this->eccmode = NAND_ECC_SOFT;
2582 this->calculate_ecc = nand_calculate_ecc;
2583 this->correct_data = nand_correct_data;
2585 this->eccsize = 2048;
2588 case NAND_ECC_HW3_512:
2589 case NAND_ECC_HW6_512:
2590 case NAND_ECC_HW8_512:
2591 if (mtd->oobblock == 256) {
2592 printk(KERN_WARNING "512 byte HW ECC not possible on 256 Byte pagesize, fallback to SW ECC \n");
2593 this->eccmode = NAND_ECC_SOFT;
2594 this->calculate_ecc = nand_calculate_ecc;
2595 this->correct_data = nand_correct_data;
2597 this->eccsize = 512; /* set eccsize to 512 */
2600 case NAND_ECC_HW3_256:
2604 printk(KERN_WARNING "NAND_ECC_NONE selected by board driver. This is not recommended !!\n");
2605 this->eccmode = NAND_ECC_NONE;
2609 this->calculate_ecc = nand_calculate_ecc;
2610 this->correct_data = nand_correct_data;
2614 printk(KERN_WARNING "Invalid NAND_ECC_MODE %d\n", this->eccmode);
2618 /* Check hardware ecc function availability and adjust number of ecc bytes per
2621 switch (this->eccmode) {
2622 case NAND_ECC_HW12_2048:
2623 this->eccbytes += 4;
2624 case NAND_ECC_HW8_512:
2625 this->eccbytes += 2;
2626 case NAND_ECC_HW6_512:
2627 this->eccbytes += 3;
2628 case NAND_ECC_HW3_512:
2629 case NAND_ECC_HW3_256:
2630 if (this->calculate_ecc && this->correct_data && this->enable_hwecc)
2632 printk(KERN_WARNING "No ECC functions supplied, Hardware ECC not possible\n");
2636 mtd->eccsize = this->eccsize;
2638 /* Set the number of read / write steps for one page to ensure ECC generation */
2639 switch (this->eccmode) {
2640 case NAND_ECC_HW12_2048:
2641 this->eccsteps = mtd->oobblock / 2048;
2643 case NAND_ECC_HW3_512:
2644 case NAND_ECC_HW6_512:
2645 case NAND_ECC_HW8_512:
2646 this->eccsteps = mtd->oobblock / 512;
2648 case NAND_ECC_HW3_256:
2650 this->eccsteps = mtd->oobblock / 256;
2658 /* Initialize state, waitqueue and spinlock */
2659 this->state = FL_READY;
2660 if (!this->controller) {
2661 this->controller = kzalloc(sizeof(struct nand_hw_control),
2663 if (!this->controller) {
2664 nand_free_kmem(this);
2667 this->options |= NAND_CONTROLLER_ALLOC;
2669 init_waitqueue_head(&this->controller->wq);
2670 spin_lock_init(&this->controller->lock);
2672 /* De-select the device */
2673 this->select_chip(mtd, -1);
2675 /* Invalidate the pagebuffer reference */
2678 /* Fill in remaining MTD driver data */
2679 mtd->type = MTD_NANDFLASH;
2680 mtd->flags = MTD_CAP_NANDFLASH | MTD_ECC;
2681 mtd->ecctype = MTD_ECC_SW;
2682 mtd->erase = nand_erase;
2684 mtd->unpoint = NULL;
2685 mtd->read = nand_read;
2686 mtd->write = nand_write;
2687 mtd->read_ecc = nand_read_ecc;
2688 mtd->write_ecc = nand_write_ecc;
2689 mtd->read_oob = nand_read_oob;
2690 mtd->write_oob = nand_write_oob;
2692 mtd->writev = nand_writev;
2693 mtd->writev_ecc = nand_writev_ecc;
2694 mtd->sync = nand_sync;
2697 mtd->suspend = nand_suspend;
2698 mtd->resume = nand_resume;
2699 mtd->block_isbad = nand_block_isbad;
2700 mtd->block_markbad = nand_block_markbad;
2702 /* and make the autooob the default one */
2703 memcpy(&mtd->oobinfo, this->autooob, sizeof(mtd->oobinfo));
2705 /* Check, if we should skip the bad block table scan */
2706 if (this->options & NAND_SKIP_BBTSCAN)
2709 /* Build bad block table */
2710 return this->scan_bbt(mtd);
2714 * nand_release - [NAND Interface] Free resources held by the NAND device
2715 * @mtd: MTD device structure
2717 void nand_release(struct mtd_info *mtd)
2719 struct nand_chip *this = mtd->priv;
2721 #ifdef CONFIG_MTD_PARTITIONS
2722 /* Deregister partitions */
2723 del_mtd_partitions(mtd);
2725 /* Deregister the device */
2726 del_mtd_device(mtd);
2728 /* Free bad block table memory */
2731 nand_free_kmem(this);
2734 EXPORT_SYMBOL_GPL(nand_scan);
2735 EXPORT_SYMBOL_GPL(nand_release);
2737 static int __init nand_base_init(void)
2739 led_trigger_register_simple("nand-disk", &nand_led_trigger);
2743 static void __exit nand_base_exit(void)
2745 led_trigger_unregister_simple(nand_led_trigger);
2748 module_init(nand_base_init);
2749 module_exit(nand_base_exit);
2751 MODULE_LICENSE("GPL");
2752 MODULE_AUTHOR("Steven J. Hill <sjhill@realitydiluted.com>, Thomas Gleixner <tglx@linutronix.de>");
2753 MODULE_DESCRIPTION("Generic NAND flash driver code");