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/doc/nand.html
12 * Copyright (C) 2000 Steven J. Hill (sjhill@realitydiluted.com)
13 * 2002-2006 Thomas Gleixner (tglx@linutronix.de)
16 * David Woodhouse for adding multichip support
18 * Aleph One Ltd. and Toby Churchill Ltd. for supporting the
19 * rework for 2K page size chips
22 * Enable cached programming for 2k page size chips
23 * Check, if mtd->ecctype should be set to MTD_ECC_HW
24 * if we have HW ecc support.
25 * The AG-AND chips have nice features for speed improvement,
26 * which are not supported yet. Read / program 4 pages in one go.
27 * BBT table is not serialized, has to be fixed
29 * This program is free software; you can redistribute it and/or modify
30 * it under the terms of the GNU General Public License version 2 as
31 * published by the Free Software Foundation.
35 #include <linux/module.h>
36 #include <linux/delay.h>
37 #include <linux/errno.h>
38 #include <linux/err.h>
39 #include <linux/sched.h>
40 #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/compatmac.h>
46 #include <linux/interrupt.h>
47 #include <linux/bitops.h>
48 #include <linux/leds.h>
51 #ifdef CONFIG_MTD_PARTITIONS
52 #include <linux/mtd/partitions.h>
55 /* Define default oob placement schemes for large and small page devices */
56 static struct nand_ecclayout nand_oob_8
= {
66 static struct nand_ecclayout nand_oob_16
= {
68 .eccpos
= {0, 1, 2, 3, 6, 7},
74 static struct nand_ecclayout nand_oob_64
= {
77 40, 41, 42, 43, 44, 45, 46, 47,
78 48, 49, 50, 51, 52, 53, 54, 55,
79 56, 57, 58, 59, 60, 61, 62, 63},
85 static int nand_get_device(struct nand_chip
*chip
, struct mtd_info
*mtd
,
88 static int nand_do_write_oob(struct mtd_info
*mtd
, loff_t to
,
89 struct mtd_oob_ops
*ops
);
92 * For devices which display every fart in the system on a seperate LED. Is
93 * compiled away when LED support is disabled.
95 DEFINE_LED_TRIGGER(nand_led_trigger
);
98 * nand_release_device - [GENERIC] release chip
99 * @mtd: MTD device structure
101 * Deselect, release chip lock and wake up anyone waiting on the device
103 static void nand_release_device(struct mtd_info
*mtd
)
105 struct nand_chip
*chip
= mtd
->priv
;
107 /* De-select the NAND device */
108 chip
->select_chip(mtd
, -1);
110 /* Release the controller and the chip */
111 spin_lock(&chip
->controller
->lock
);
112 chip
->controller
->active
= NULL
;
113 chip
->state
= FL_READY
;
114 wake_up(&chip
->controller
->wq
);
115 spin_unlock(&chip
->controller
->lock
);
119 * nand_read_byte - [DEFAULT] read one byte from the chip
120 * @mtd: MTD device structure
122 * Default read function for 8bit buswith
124 static uint8_t nand_read_byte(struct mtd_info
*mtd
)
126 struct nand_chip
*chip
= mtd
->priv
;
127 return readb(chip
->IO_ADDR_R
);
131 * nand_read_byte16 - [DEFAULT] read one byte endianess aware from the chip
132 * @mtd: MTD device structure
134 * Default read function for 16bit buswith with
135 * endianess conversion
137 static uint8_t nand_read_byte16(struct mtd_info
*mtd
)
139 struct nand_chip
*chip
= mtd
->priv
;
140 return (uint8_t) cpu_to_le16(readw(chip
->IO_ADDR_R
));
144 * nand_read_word - [DEFAULT] read one word from the chip
145 * @mtd: MTD device structure
147 * Default read function for 16bit buswith without
148 * endianess conversion
150 static u16
nand_read_word(struct mtd_info
*mtd
)
152 struct nand_chip
*chip
= mtd
->priv
;
153 return readw(chip
->IO_ADDR_R
);
157 * nand_select_chip - [DEFAULT] control CE line
158 * @mtd: MTD device structure
159 * @chipnr: chipnumber to select, -1 for deselect
161 * Default select function for 1 chip devices.
163 static void nand_select_chip(struct mtd_info
*mtd
, int chipnr
)
165 struct nand_chip
*chip
= mtd
->priv
;
169 chip
->cmd_ctrl(mtd
, NAND_CMD_NONE
, 0 | NAND_CTRL_CHANGE
);
180 * nand_write_buf - [DEFAULT] write buffer to chip
181 * @mtd: MTD device structure
183 * @len: number of bytes to write
185 * Default write function for 8bit buswith
187 static void nand_write_buf(struct mtd_info
*mtd
, const uint8_t *buf
, int len
)
190 struct nand_chip
*chip
= mtd
->priv
;
192 for (i
= 0; i
< len
; i
++)
193 writeb(buf
[i
], chip
->IO_ADDR_W
);
197 * nand_read_buf - [DEFAULT] read chip data into buffer
198 * @mtd: MTD device structure
199 * @buf: buffer to store date
200 * @len: number of bytes to read
202 * Default read function for 8bit buswith
204 static void nand_read_buf(struct mtd_info
*mtd
, uint8_t *buf
, int len
)
207 struct nand_chip
*chip
= mtd
->priv
;
209 for (i
= 0; i
< len
; i
++)
210 buf
[i
] = readb(chip
->IO_ADDR_R
);
214 * nand_verify_buf - [DEFAULT] Verify chip data against buffer
215 * @mtd: MTD device structure
216 * @buf: buffer containing the data to compare
217 * @len: number of bytes to compare
219 * Default verify function for 8bit buswith
221 static int nand_verify_buf(struct mtd_info
*mtd
, const uint8_t *buf
, int len
)
224 struct nand_chip
*chip
= mtd
->priv
;
226 for (i
= 0; i
< len
; i
++)
227 if (buf
[i
] != readb(chip
->IO_ADDR_R
))
233 * nand_write_buf16 - [DEFAULT] write buffer to chip
234 * @mtd: MTD device structure
236 * @len: number of bytes to write
238 * Default write function for 16bit buswith
240 static void nand_write_buf16(struct mtd_info
*mtd
, const uint8_t *buf
, int len
)
243 struct nand_chip
*chip
= mtd
->priv
;
244 u16
*p
= (u16
*) buf
;
247 for (i
= 0; i
< len
; i
++)
248 writew(p
[i
], chip
->IO_ADDR_W
);
253 * nand_read_buf16 - [DEFAULT] read chip data into buffer
254 * @mtd: MTD device structure
255 * @buf: buffer to store date
256 * @len: number of bytes to read
258 * Default read function for 16bit buswith
260 static void nand_read_buf16(struct mtd_info
*mtd
, uint8_t *buf
, int len
)
263 struct nand_chip
*chip
= mtd
->priv
;
264 u16
*p
= (u16
*) buf
;
267 for (i
= 0; i
< len
; i
++)
268 p
[i
] = readw(chip
->IO_ADDR_R
);
272 * nand_verify_buf16 - [DEFAULT] Verify chip data against buffer
273 * @mtd: MTD device structure
274 * @buf: buffer containing the data to compare
275 * @len: number of bytes to compare
277 * Default verify function for 16bit buswith
279 static int nand_verify_buf16(struct mtd_info
*mtd
, const uint8_t *buf
, int len
)
282 struct nand_chip
*chip
= mtd
->priv
;
283 u16
*p
= (u16
*) buf
;
286 for (i
= 0; i
< len
; i
++)
287 if (p
[i
] != readw(chip
->IO_ADDR_R
))
294 * nand_block_bad - [DEFAULT] Read bad block marker from the chip
295 * @mtd: MTD device structure
296 * @ofs: offset from device start
297 * @getchip: 0, if the chip is already selected
299 * Check, if the block is bad.
301 static int nand_block_bad(struct mtd_info
*mtd
, loff_t ofs
, int getchip
)
303 int page
, chipnr
, res
= 0;
304 struct nand_chip
*chip
= mtd
->priv
;
307 page
= (int)(ofs
>> chip
->page_shift
) & chip
->pagemask
;
310 chipnr
= (int)(ofs
>> chip
->chip_shift
);
312 nand_get_device(chip
, mtd
, FL_READING
);
314 /* Select the NAND device */
315 chip
->select_chip(mtd
, chipnr
);
318 if (chip
->options
& NAND_BUSWIDTH_16
) {
319 chip
->cmdfunc(mtd
, NAND_CMD_READOOB
, chip
->badblockpos
& 0xFE,
321 bad
= cpu_to_le16(chip
->read_word(mtd
));
322 if (chip
->badblockpos
& 0x1)
324 if ((bad
& 0xFF) != 0xff)
327 chip
->cmdfunc(mtd
, NAND_CMD_READOOB
, chip
->badblockpos
, page
);
328 if (chip
->read_byte(mtd
) != 0xff)
333 nand_release_device(mtd
);
339 * nand_default_block_markbad - [DEFAULT] mark a block bad
340 * @mtd: MTD device structure
341 * @ofs: offset from device start
343 * This is the default implementation, which can be overridden by
344 * a hardware specific driver.
346 static int nand_default_block_markbad(struct mtd_info
*mtd
, loff_t ofs
)
348 struct nand_chip
*chip
= mtd
->priv
;
349 uint8_t buf
[2] = { 0, 0 };
352 /* Get block number */
353 block
= (int)(ofs
>> chip
->bbt_erase_shift
);
355 chip
->bbt
[block
>> 2] |= 0x01 << ((block
& 0x03) << 1);
357 /* Do we have a flash based bad block table ? */
358 if (chip
->options
& NAND_USE_FLASH_BBT
)
359 ret
= nand_update_bbt(mtd
, ofs
);
361 /* We write two bytes, so we dont have to mess with 16 bit
364 nand_get_device(chip
, mtd
, FL_WRITING
);
366 chip
->ops
.len
= chip
->ops
.ooblen
= 2;
367 chip
->ops
.datbuf
= NULL
;
368 chip
->ops
.oobbuf
= buf
;
369 chip
->ops
.ooboffs
= chip
->badblockpos
& ~0x01;
371 ret
= nand_do_write_oob(mtd
, ofs
, &chip
->ops
);
372 nand_release_device(mtd
);
375 mtd
->ecc_stats
.badblocks
++;
381 * nand_check_wp - [GENERIC] check if the chip is write protected
382 * @mtd: MTD device structure
383 * Check, if the device is write protected
385 * The function expects, that the device is already selected
387 static int nand_check_wp(struct mtd_info
*mtd
)
389 struct nand_chip
*chip
= mtd
->priv
;
390 /* Check the WP bit */
391 chip
->cmdfunc(mtd
, NAND_CMD_STATUS
, -1, -1);
392 return (chip
->read_byte(mtd
) & NAND_STATUS_WP
) ? 0 : 1;
396 * nand_block_checkbad - [GENERIC] Check if a block is marked bad
397 * @mtd: MTD device structure
398 * @ofs: offset from device start
399 * @getchip: 0, if the chip is already selected
400 * @allowbbt: 1, if its allowed to access the bbt area
402 * Check, if the block is bad. Either by reading the bad block table or
403 * calling of the scan function.
405 static int nand_block_checkbad(struct mtd_info
*mtd
, loff_t ofs
, int getchip
,
408 struct nand_chip
*chip
= mtd
->priv
;
411 return chip
->block_bad(mtd
, ofs
, getchip
);
413 /* Return info from the table */
414 return nand_isbad_bbt(mtd
, ofs
, allowbbt
);
418 * Wait for the ready pin, after a command
419 * The timeout is catched later.
421 void nand_wait_ready(struct mtd_info
*mtd
)
423 struct nand_chip
*chip
= mtd
->priv
;
424 unsigned long timeo
= jiffies
+ 2;
426 led_trigger_event(nand_led_trigger
, LED_FULL
);
427 /* wait until command is processed or timeout occures */
429 if (chip
->dev_ready(mtd
))
431 touch_softlockup_watchdog();
432 } while (time_before(jiffies
, timeo
));
433 led_trigger_event(nand_led_trigger
, LED_OFF
);
435 EXPORT_SYMBOL_GPL(nand_wait_ready
);
438 * nand_command - [DEFAULT] Send command to NAND device
439 * @mtd: MTD device structure
440 * @command: the command to be sent
441 * @column: the column address for this command, -1 if none
442 * @page_addr: the page address for this command, -1 if none
444 * Send command to NAND device. This function is used for small page
445 * devices (256/512 Bytes per page)
447 static void nand_command(struct mtd_info
*mtd
, unsigned int command
,
448 int column
, int page_addr
)
450 register struct nand_chip
*chip
= mtd
->priv
;
451 int ctrl
= NAND_CTRL_CLE
| NAND_CTRL_CHANGE
;
454 * Write out the command to the device.
456 if (command
== NAND_CMD_SEQIN
) {
459 if (column
>= mtd
->writesize
) {
461 column
-= mtd
->writesize
;
462 readcmd
= NAND_CMD_READOOB
;
463 } else if (column
< 256) {
464 /* First 256 bytes --> READ0 */
465 readcmd
= NAND_CMD_READ0
;
468 readcmd
= NAND_CMD_READ1
;
470 chip
->cmd_ctrl(mtd
, readcmd
, ctrl
);
471 ctrl
&= ~NAND_CTRL_CHANGE
;
473 chip
->cmd_ctrl(mtd
, command
, ctrl
);
476 * Address cycle, when necessary
478 ctrl
= NAND_CTRL_ALE
| NAND_CTRL_CHANGE
;
479 /* Serially input address */
481 /* Adjust columns for 16 bit buswidth */
482 if (chip
->options
& NAND_BUSWIDTH_16
)
484 chip
->cmd_ctrl(mtd
, column
, ctrl
);
485 ctrl
&= ~NAND_CTRL_CHANGE
;
487 if (page_addr
!= -1) {
488 chip
->cmd_ctrl(mtd
, page_addr
, ctrl
);
489 ctrl
&= ~NAND_CTRL_CHANGE
;
490 chip
->cmd_ctrl(mtd
, page_addr
>> 8, ctrl
);
491 /* One more address cycle for devices > 32MiB */
492 if (chip
->chipsize
> (32 << 20))
493 chip
->cmd_ctrl(mtd
, page_addr
>> 16, ctrl
);
495 chip
->cmd_ctrl(mtd
, NAND_CMD_NONE
, NAND_NCE
| NAND_CTRL_CHANGE
);
498 * program and erase have their own busy handlers
499 * status and sequential in needs no delay
503 case NAND_CMD_PAGEPROG
:
504 case NAND_CMD_ERASE1
:
505 case NAND_CMD_ERASE2
:
507 case NAND_CMD_STATUS
:
513 udelay(chip
->chip_delay
);
514 chip
->cmd_ctrl(mtd
, NAND_CMD_STATUS
,
515 NAND_CTRL_CLE
| NAND_CTRL_CHANGE
);
517 NAND_CMD_NONE
, NAND_NCE
| NAND_CTRL_CHANGE
);
518 while (!(chip
->read_byte(mtd
) & NAND_STATUS_READY
)) ;
521 /* This applies to read commands */
524 * If we don't have access to the busy pin, we apply the given
527 if (!chip
->dev_ready
) {
528 udelay(chip
->chip_delay
);
532 /* Apply this short delay always to ensure that we do wait tWB in
533 * any case on any machine. */
536 nand_wait_ready(mtd
);
540 * nand_command_lp - [DEFAULT] Send command to NAND large page device
541 * @mtd: MTD device structure
542 * @command: the command to be sent
543 * @column: the column address for this command, -1 if none
544 * @page_addr: the page address for this command, -1 if none
546 * Send command to NAND device. This is the version for the new large page
547 * devices We dont have the separate regions as we have in the small page
548 * devices. We must emulate NAND_CMD_READOOB to keep the code compatible.
550 static void nand_command_lp(struct mtd_info
*mtd
, unsigned int command
,
551 int column
, int page_addr
)
553 register struct nand_chip
*chip
= mtd
->priv
;
555 /* Emulate NAND_CMD_READOOB */
556 if (command
== NAND_CMD_READOOB
) {
557 column
+= mtd
->writesize
;
558 command
= NAND_CMD_READ0
;
561 /* Command latch cycle */
562 chip
->cmd_ctrl(mtd
, command
& 0xff,
563 NAND_NCE
| NAND_CLE
| NAND_CTRL_CHANGE
);
565 if (column
!= -1 || page_addr
!= -1) {
566 int ctrl
= NAND_CTRL_CHANGE
| NAND_NCE
| NAND_ALE
;
568 /* Serially input address */
570 /* Adjust columns for 16 bit buswidth */
571 if (chip
->options
& NAND_BUSWIDTH_16
)
573 chip
->cmd_ctrl(mtd
, column
, ctrl
);
574 ctrl
&= ~NAND_CTRL_CHANGE
;
575 chip
->cmd_ctrl(mtd
, column
>> 8, ctrl
);
577 if (page_addr
!= -1) {
578 chip
->cmd_ctrl(mtd
, page_addr
, ctrl
);
579 chip
->cmd_ctrl(mtd
, page_addr
>> 8,
580 NAND_NCE
| NAND_ALE
);
581 /* One more address cycle for devices > 128MiB */
582 if (chip
->chipsize
> (128 << 20))
583 chip
->cmd_ctrl(mtd
, page_addr
>> 16,
584 NAND_NCE
| NAND_ALE
);
587 chip
->cmd_ctrl(mtd
, NAND_CMD_NONE
, NAND_NCE
| NAND_CTRL_CHANGE
);
590 * program and erase have their own busy handlers
591 * status, sequential in, and deplete1 need no delay
595 case NAND_CMD_CACHEDPROG
:
596 case NAND_CMD_PAGEPROG
:
597 case NAND_CMD_ERASE1
:
598 case NAND_CMD_ERASE2
:
601 case NAND_CMD_STATUS
:
602 case NAND_CMD_DEPLETE1
:
606 * read error status commands require only a short delay
608 case NAND_CMD_STATUS_ERROR
:
609 case NAND_CMD_STATUS_ERROR0
:
610 case NAND_CMD_STATUS_ERROR1
:
611 case NAND_CMD_STATUS_ERROR2
:
612 case NAND_CMD_STATUS_ERROR3
:
613 udelay(chip
->chip_delay
);
619 udelay(chip
->chip_delay
);
620 chip
->cmd_ctrl(mtd
, NAND_CMD_STATUS
,
621 NAND_NCE
| NAND_CLE
| NAND_CTRL_CHANGE
);
622 chip
->cmd_ctrl(mtd
, NAND_CMD_NONE
,
623 NAND_NCE
| NAND_CTRL_CHANGE
);
624 while (!(chip
->read_byte(mtd
) & NAND_STATUS_READY
)) ;
627 case NAND_CMD_RNDOUT
:
628 /* No ready / busy check necessary */
629 chip
->cmd_ctrl(mtd
, NAND_CMD_RNDOUTSTART
,
630 NAND_NCE
| NAND_CLE
| NAND_CTRL_CHANGE
);
631 chip
->cmd_ctrl(mtd
, NAND_CMD_NONE
,
632 NAND_NCE
| NAND_CTRL_CHANGE
);
636 chip
->cmd_ctrl(mtd
, NAND_CMD_READSTART
,
637 NAND_NCE
| NAND_CLE
| NAND_CTRL_CHANGE
);
638 chip
->cmd_ctrl(mtd
, NAND_CMD_NONE
,
639 NAND_NCE
| NAND_CTRL_CHANGE
);
641 /* This applies to read commands */
644 * If we don't have access to the busy pin, we apply the given
647 if (!chip
->dev_ready
) {
648 udelay(chip
->chip_delay
);
653 /* Apply this short delay always to ensure that we do wait tWB in
654 * any case on any machine. */
657 nand_wait_ready(mtd
);
661 * nand_get_device - [GENERIC] Get chip for selected access
662 * @chip: the nand chip descriptor
663 * @mtd: MTD device structure
664 * @new_state: the state which is requested
666 * Get the device and lock it for exclusive access
669 nand_get_device(struct nand_chip
*chip
, struct mtd_info
*mtd
, int new_state
)
671 spinlock_t
*lock
= &chip
->controller
->lock
;
672 wait_queue_head_t
*wq
= &chip
->controller
->wq
;
673 DECLARE_WAITQUEUE(wait
, current
);
677 /* Hardware controller shared among independend devices */
678 /* Hardware controller shared among independend devices */
679 if (!chip
->controller
->active
)
680 chip
->controller
->active
= chip
;
682 if (chip
->controller
->active
== chip
&& chip
->state
== FL_READY
) {
683 chip
->state
= new_state
;
687 if (new_state
== FL_PM_SUSPENDED
) {
689 return (chip
->state
== FL_PM_SUSPENDED
) ? 0 : -EAGAIN
;
691 set_current_state(TASK_UNINTERRUPTIBLE
);
692 add_wait_queue(wq
, &wait
);
695 remove_wait_queue(wq
, &wait
);
700 * nand_wait - [DEFAULT] wait until the command is done
701 * @mtd: MTD device structure
702 * @chip: NAND chip structure
704 * Wait for command done. This applies to erase and program only
705 * Erase can take up to 400ms and program up to 20ms according to
706 * general NAND and SmartMedia specs
708 static int nand_wait(struct mtd_info
*mtd
, struct nand_chip
*chip
)
711 unsigned long timeo
= jiffies
;
712 int status
, state
= chip
->state
;
714 if (state
== FL_ERASING
)
715 timeo
+= (HZ
* 400) / 1000;
717 timeo
+= (HZ
* 20) / 1000;
719 led_trigger_event(nand_led_trigger
, LED_FULL
);
721 /* Apply this short delay always to ensure that we do wait tWB in
722 * any case on any machine. */
725 if ((state
== FL_ERASING
) && (chip
->options
& NAND_IS_AND
))
726 chip
->cmdfunc(mtd
, NAND_CMD_STATUS_MULTI
, -1, -1);
728 chip
->cmdfunc(mtd
, NAND_CMD_STATUS
, -1, -1);
730 while (time_before(jiffies
, timeo
)) {
731 if (chip
->dev_ready
) {
732 if (chip
->dev_ready(mtd
))
735 if (chip
->read_byte(mtd
) & NAND_STATUS_READY
)
740 led_trigger_event(nand_led_trigger
, LED_OFF
);
742 status
= (int)chip
->read_byte(mtd
);
747 * nand_read_page_raw - [Intern] read raw page data without ecc
748 * @mtd: mtd info structure
749 * @chip: nand chip info structure
750 * @buf: buffer to store read data
752 static int nand_read_page_raw(struct mtd_info
*mtd
, struct nand_chip
*chip
,
755 chip
->read_buf(mtd
, buf
, mtd
->writesize
);
756 chip
->read_buf(mtd
, chip
->oob_poi
, mtd
->oobsize
);
761 * nand_read_page_swecc - [REPLACABLE] software ecc based page read function
762 * @mtd: mtd info structure
763 * @chip: nand chip info structure
764 * @buf: buffer to store read data
766 static int nand_read_page_swecc(struct mtd_info
*mtd
, struct nand_chip
*chip
,
769 int i
, eccsize
= chip
->ecc
.size
;
770 int eccbytes
= chip
->ecc
.bytes
;
771 int eccsteps
= chip
->ecc
.steps
;
773 uint8_t *ecc_calc
= chip
->buffers
->ecccalc
;
774 uint8_t *ecc_code
= chip
->buffers
->ecccode
;
775 uint32_t *eccpos
= chip
->ecc
.layout
->eccpos
;
777 chip
->ecc
.read_page_raw(mtd
, chip
, buf
);
779 for (i
= 0; eccsteps
; eccsteps
--, i
+= eccbytes
, p
+= eccsize
)
780 chip
->ecc
.calculate(mtd
, p
, &ecc_calc
[i
]);
782 for (i
= 0; i
< chip
->ecc
.total
; i
++)
783 ecc_code
[i
] = chip
->oob_poi
[eccpos
[i
]];
785 eccsteps
= chip
->ecc
.steps
;
788 for (i
= 0 ; eccsteps
; eccsteps
--, i
+= eccbytes
, p
+= eccsize
) {
791 stat
= chip
->ecc
.correct(mtd
, p
, &ecc_code
[i
], &ecc_calc
[i
]);
793 mtd
->ecc_stats
.failed
++;
795 mtd
->ecc_stats
.corrected
+= stat
;
801 * nand_read_page_hwecc - [REPLACABLE] hardware ecc based page read function
802 * @mtd: mtd info structure
803 * @chip: nand chip info structure
804 * @buf: buffer to store read data
806 * Not for syndrome calculating ecc controllers which need a special oob layout
808 static int nand_read_page_hwecc(struct mtd_info
*mtd
, struct nand_chip
*chip
,
811 int i
, eccsize
= chip
->ecc
.size
;
812 int eccbytes
= chip
->ecc
.bytes
;
813 int eccsteps
= chip
->ecc
.steps
;
815 uint8_t *ecc_calc
= chip
->buffers
->ecccalc
;
816 uint8_t *ecc_code
= chip
->buffers
->ecccode
;
817 uint32_t *eccpos
= chip
->ecc
.layout
->eccpos
;
819 for (i
= 0; eccsteps
; eccsteps
--, i
+= eccbytes
, p
+= eccsize
) {
820 chip
->ecc
.hwctl(mtd
, NAND_ECC_READ
);
821 chip
->read_buf(mtd
, p
, eccsize
);
822 chip
->ecc
.calculate(mtd
, p
, &ecc_calc
[i
]);
824 chip
->read_buf(mtd
, chip
->oob_poi
, mtd
->oobsize
);
826 for (i
= 0; i
< chip
->ecc
.total
; i
++)
827 ecc_code
[i
] = chip
->oob_poi
[eccpos
[i
]];
829 eccsteps
= chip
->ecc
.steps
;
832 for (i
= 0 ; eccsteps
; eccsteps
--, i
+= eccbytes
, p
+= eccsize
) {
835 stat
= chip
->ecc
.correct(mtd
, p
, &ecc_code
[i
], &ecc_calc
[i
]);
837 mtd
->ecc_stats
.failed
++;
839 mtd
->ecc_stats
.corrected
+= stat
;
845 * nand_read_page_syndrome - [REPLACABLE] hardware ecc syndrom based page read
846 * @mtd: mtd info structure
847 * @chip: nand chip info structure
848 * @buf: buffer to store read data
850 * The hw generator calculates the error syndrome automatically. Therefor
851 * we need a special oob layout and handling.
853 static int nand_read_page_syndrome(struct mtd_info
*mtd
, struct nand_chip
*chip
,
856 int i
, eccsize
= chip
->ecc
.size
;
857 int eccbytes
= chip
->ecc
.bytes
;
858 int eccsteps
= chip
->ecc
.steps
;
860 uint8_t *oob
= chip
->oob_poi
;
862 for (i
= 0; eccsteps
; eccsteps
--, i
+= eccbytes
, p
+= eccsize
) {
865 chip
->ecc
.hwctl(mtd
, NAND_ECC_READ
);
866 chip
->read_buf(mtd
, p
, eccsize
);
868 if (chip
->ecc
.prepad
) {
869 chip
->read_buf(mtd
, oob
, chip
->ecc
.prepad
);
870 oob
+= chip
->ecc
.prepad
;
873 chip
->ecc
.hwctl(mtd
, NAND_ECC_READSYN
);
874 chip
->read_buf(mtd
, oob
, eccbytes
);
875 stat
= chip
->ecc
.correct(mtd
, p
, oob
, NULL
);
878 mtd
->ecc_stats
.failed
++;
880 mtd
->ecc_stats
.corrected
+= stat
;
884 if (chip
->ecc
.postpad
) {
885 chip
->read_buf(mtd
, oob
, chip
->ecc
.postpad
);
886 oob
+= chip
->ecc
.postpad
;
890 /* Calculate remaining oob bytes */
891 i
= mtd
->oobsize
- (oob
- chip
->oob_poi
);
893 chip
->read_buf(mtd
, oob
, i
);
899 * nand_transfer_oob - [Internal] Transfer oob to client buffer
900 * @chip: nand chip structure
901 * @oob: oob destination address
902 * @ops: oob ops structure
903 * @len: size of oob to transfer
905 static uint8_t *nand_transfer_oob(struct nand_chip
*chip
, uint8_t *oob
,
906 struct mtd_oob_ops
*ops
, size_t len
)
912 memcpy(oob
, chip
->oob_poi
+ ops
->ooboffs
, len
);
916 struct nand_oobfree
*free
= chip
->ecc
.layout
->oobfree
;
917 uint32_t boffs
= 0, roffs
= ops
->ooboffs
;
920 for(; free
->length
&& len
; free
++, len
-= bytes
) {
921 /* Read request not from offset 0 ? */
922 if (unlikely(roffs
)) {
923 if (roffs
>= free
->length
) {
924 roffs
-= free
->length
;
927 boffs
= free
->offset
+ roffs
;
928 bytes
= min_t(size_t, len
,
929 (free
->length
- roffs
));
932 bytes
= min_t(size_t, len
, free
->length
);
933 boffs
= free
->offset
;
935 memcpy(oob
, chip
->oob_poi
+ boffs
, bytes
);
947 * nand_do_read_ops - [Internal] Read data with ECC
949 * @mtd: MTD device structure
950 * @from: offset to read from
951 * @ops: oob ops structure
953 * Internal function. Called with chip held.
955 static int nand_do_read_ops(struct mtd_info
*mtd
, loff_t from
,
956 struct mtd_oob_ops
*ops
)
958 int chipnr
, page
, realpage
, col
, bytes
, aligned
;
959 struct nand_chip
*chip
= mtd
->priv
;
960 struct mtd_ecc_stats stats
;
961 int blkcheck
= (1 << (chip
->phys_erase_shift
- chip
->page_shift
)) - 1;
964 uint32_t readlen
= ops
->len
;
965 uint32_t oobreadlen
= ops
->ooblen
;
966 uint8_t *bufpoi
, *oob
, *buf
;
968 stats
= mtd
->ecc_stats
;
970 chipnr
= (int)(from
>> chip
->chip_shift
);
971 chip
->select_chip(mtd
, chipnr
);
973 realpage
= (int)(from
>> chip
->page_shift
);
974 page
= realpage
& chip
->pagemask
;
976 col
= (int)(from
& (mtd
->writesize
- 1));
982 bytes
= min(mtd
->writesize
- col
, readlen
);
983 aligned
= (bytes
== mtd
->writesize
);
985 /* Is the current page in the buffer ? */
986 if (realpage
!= chip
->pagebuf
|| oob
) {
987 bufpoi
= aligned
? buf
: chip
->buffers
->databuf
;
989 if (likely(sndcmd
)) {
990 chip
->cmdfunc(mtd
, NAND_CMD_READ0
, 0x00, page
);
994 /* Now read the page into the buffer */
995 if (unlikely(ops
->mode
== MTD_OOB_RAW
))
996 ret
= chip
->ecc
.read_page_raw(mtd
, chip
, bufpoi
);
998 ret
= chip
->ecc
.read_page(mtd
, chip
, bufpoi
);
1002 /* Transfer not aligned data */
1004 chip
->pagebuf
= realpage
;
1005 memcpy(buf
, chip
->buffers
->databuf
+ col
, bytes
);
1010 if (unlikely(oob
)) {
1011 /* Raw mode does data:oob:data:oob */
1012 if (ops
->mode
!= MTD_OOB_RAW
) {
1013 int toread
= min(oobreadlen
,
1014 chip
->ecc
.layout
->oobavail
);
1016 oob
= nand_transfer_oob(chip
,
1018 oobreadlen
-= toread
;
1021 buf
= nand_transfer_oob(chip
,
1022 buf
, ops
, mtd
->oobsize
);
1025 if (!(chip
->options
& NAND_NO_READRDY
)) {
1027 * Apply delay or wait for ready/busy pin. Do
1028 * this before the AUTOINCR check, so no
1029 * problems arise if a chip which does auto
1030 * increment is marked as NOAUTOINCR by the
1033 if (!chip
->dev_ready
)
1034 udelay(chip
->chip_delay
);
1036 nand_wait_ready(mtd
);
1039 memcpy(buf
, chip
->buffers
->databuf
+ col
, bytes
);
1048 /* For subsequent reads align to page boundary. */
1050 /* Increment page address */
1053 page
= realpage
& chip
->pagemask
;
1054 /* Check, if we cross a chip boundary */
1057 chip
->select_chip(mtd
, -1);
1058 chip
->select_chip(mtd
, chipnr
);
1061 /* Check, if the chip supports auto page increment
1062 * or if we have hit a block boundary.
1064 if (!NAND_CANAUTOINCR(chip
) || !(page
& blkcheck
))
1068 ops
->retlen
= ops
->len
- (size_t) readlen
;
1070 ops
->oobretlen
= ops
->ooblen
- oobreadlen
;
1075 if (mtd
->ecc_stats
.failed
- stats
.failed
)
1078 return mtd
->ecc_stats
.corrected
- stats
.corrected
? -EUCLEAN
: 0;
1082 * nand_read - [MTD Interface] MTD compability function for nand_do_read_ecc
1083 * @mtd: MTD device structure
1084 * @from: offset to read from
1085 * @len: number of bytes to read
1086 * @retlen: pointer to variable to store the number of read bytes
1087 * @buf: the databuffer to put data
1089 * Get hold of the chip and call nand_do_read
1091 static int nand_read(struct mtd_info
*mtd
, loff_t from
, size_t len
,
1092 size_t *retlen
, uint8_t *buf
)
1094 struct nand_chip
*chip
= mtd
->priv
;
1097 /* Do not allow reads past end of device */
1098 if ((from
+ len
) > mtd
->size
)
1103 nand_get_device(chip
, mtd
, FL_READING
);
1105 chip
->ops
.len
= len
;
1106 chip
->ops
.datbuf
= buf
;
1107 chip
->ops
.oobbuf
= NULL
;
1109 ret
= nand_do_read_ops(mtd
, from
, &chip
->ops
);
1111 *retlen
= chip
->ops
.retlen
;
1113 nand_release_device(mtd
);
1119 * nand_read_oob_std - [REPLACABLE] the most common OOB data read function
1120 * @mtd: mtd info structure
1121 * @chip: nand chip info structure
1122 * @page: page number to read
1123 * @sndcmd: flag whether to issue read command or not
1125 static int nand_read_oob_std(struct mtd_info
*mtd
, struct nand_chip
*chip
,
1126 int page
, int sndcmd
)
1129 chip
->cmdfunc(mtd
, NAND_CMD_READOOB
, 0, page
);
1132 chip
->read_buf(mtd
, chip
->oob_poi
, mtd
->oobsize
);
1137 * nand_read_oob_syndrome - [REPLACABLE] OOB data read function for HW ECC
1139 * @mtd: mtd info structure
1140 * @chip: nand chip info structure
1141 * @page: page number to read
1142 * @sndcmd: flag whether to issue read command or not
1144 static int nand_read_oob_syndrome(struct mtd_info
*mtd
, struct nand_chip
*chip
,
1145 int page
, int sndcmd
)
1147 uint8_t *buf
= chip
->oob_poi
;
1148 int length
= mtd
->oobsize
;
1149 int chunk
= chip
->ecc
.bytes
+ chip
->ecc
.prepad
+ chip
->ecc
.postpad
;
1150 int eccsize
= chip
->ecc
.size
;
1151 uint8_t *bufpoi
= buf
;
1152 int i
, toread
, sndrnd
= 0, pos
;
1154 chip
->cmdfunc(mtd
, NAND_CMD_READ0
, chip
->ecc
.size
, page
);
1155 for (i
= 0; i
< chip
->ecc
.steps
; i
++) {
1157 pos
= eccsize
+ i
* (eccsize
+ chunk
);
1158 if (mtd
->writesize
> 512)
1159 chip
->cmdfunc(mtd
, NAND_CMD_RNDOUT
, pos
, -1);
1161 chip
->cmdfunc(mtd
, NAND_CMD_READ0
, pos
, page
);
1164 toread
= min_t(int, length
, chunk
);
1165 chip
->read_buf(mtd
, bufpoi
, toread
);
1170 chip
->read_buf(mtd
, bufpoi
, length
);
1176 * nand_write_oob_std - [REPLACABLE] the most common OOB data write function
1177 * @mtd: mtd info structure
1178 * @chip: nand chip info structure
1179 * @page: page number to write
1181 static int nand_write_oob_std(struct mtd_info
*mtd
, struct nand_chip
*chip
,
1185 const uint8_t *buf
= chip
->oob_poi
;
1186 int length
= mtd
->oobsize
;
1188 chip
->cmdfunc(mtd
, NAND_CMD_SEQIN
, mtd
->writesize
, page
);
1189 chip
->write_buf(mtd
, buf
, length
);
1190 /* Send command to program the OOB data */
1191 chip
->cmdfunc(mtd
, NAND_CMD_PAGEPROG
, -1, -1);
1193 status
= chip
->waitfunc(mtd
, chip
);
1195 return status
& NAND_STATUS_FAIL
? -EIO
: 0;
1199 * nand_write_oob_syndrome - [REPLACABLE] OOB data write function for HW ECC
1200 * with syndrome - only for large page flash !
1201 * @mtd: mtd info structure
1202 * @chip: nand chip info structure
1203 * @page: page number to write
1205 static int nand_write_oob_syndrome(struct mtd_info
*mtd
,
1206 struct nand_chip
*chip
, int page
)
1208 int chunk
= chip
->ecc
.bytes
+ chip
->ecc
.prepad
+ chip
->ecc
.postpad
;
1209 int eccsize
= chip
->ecc
.size
, length
= mtd
->oobsize
;
1210 int i
, len
, pos
, status
= 0, sndcmd
= 0, steps
= chip
->ecc
.steps
;
1211 const uint8_t *bufpoi
= chip
->oob_poi
;
1214 * data-ecc-data-ecc ... ecc-oob
1216 * data-pad-ecc-pad-data-pad .... ecc-pad-oob
1218 if (!chip
->ecc
.prepad
&& !chip
->ecc
.postpad
) {
1219 pos
= steps
* (eccsize
+ chunk
);
1224 chip
->cmdfunc(mtd
, NAND_CMD_SEQIN
, pos
, page
);
1225 for (i
= 0; i
< steps
; i
++) {
1227 if (mtd
->writesize
<= 512) {
1228 uint32_t fill
= 0xFFFFFFFF;
1232 int num
= min_t(int, len
, 4);
1233 chip
->write_buf(mtd
, (uint8_t *)&fill
,
1238 pos
= eccsize
+ i
* (eccsize
+ chunk
);
1239 chip
->cmdfunc(mtd
, NAND_CMD_RNDIN
, pos
, -1);
1243 len
= min_t(int, length
, chunk
);
1244 chip
->write_buf(mtd
, bufpoi
, len
);
1249 chip
->write_buf(mtd
, bufpoi
, length
);
1251 chip
->cmdfunc(mtd
, NAND_CMD_PAGEPROG
, -1, -1);
1252 status
= chip
->waitfunc(mtd
, chip
);
1254 return status
& NAND_STATUS_FAIL
? -EIO
: 0;
1258 * nand_do_read_oob - [Intern] NAND read out-of-band
1259 * @mtd: MTD device structure
1260 * @from: offset to read from
1261 * @ops: oob operations description structure
1263 * NAND read out-of-band data from the spare area
1265 static int nand_do_read_oob(struct mtd_info
*mtd
, loff_t from
,
1266 struct mtd_oob_ops
*ops
)
1268 int page
, realpage
, chipnr
, sndcmd
= 1;
1269 struct nand_chip
*chip
= mtd
->priv
;
1270 int blkcheck
= (1 << (chip
->phys_erase_shift
- chip
->page_shift
)) - 1;
1271 int readlen
= ops
->ooblen
;
1273 uint8_t *buf
= ops
->oobbuf
;
1275 DEBUG(MTD_DEBUG_LEVEL3
, "nand_read_oob: from = 0x%08Lx, len = %i\n",
1276 (unsigned long long)from
, readlen
);
1278 if (ops
->mode
== MTD_OOB_AUTO
)
1279 len
= chip
->ecc
.layout
->oobavail
;
1283 if (unlikely(ops
->ooboffs
>= len
)) {
1284 DEBUG(MTD_DEBUG_LEVEL0
, "nand_read_oob: "
1285 "Attempt to start read outside oob\n");
1289 /* Do not allow reads past end of device */
1290 if (unlikely(from
>= mtd
->size
||
1291 ops
->ooboffs
+ readlen
> ((mtd
->size
>> chip
->page_shift
) -
1292 (from
>> chip
->page_shift
)) * len
)) {
1293 DEBUG(MTD_DEBUG_LEVEL0
, "nand_read_oob: "
1294 "Attempt read beyond end of device\n");
1298 chipnr
= (int)(from
>> chip
->chip_shift
);
1299 chip
->select_chip(mtd
, chipnr
);
1301 /* Shift to get page */
1302 realpage
= (int)(from
>> chip
->page_shift
);
1303 page
= realpage
& chip
->pagemask
;
1306 sndcmd
= chip
->ecc
.read_oob(mtd
, chip
, page
, sndcmd
);
1308 len
= min(len
, readlen
);
1309 buf
= nand_transfer_oob(chip
, buf
, ops
, len
);
1311 if (!(chip
->options
& NAND_NO_READRDY
)) {
1313 * Apply delay or wait for ready/busy pin. Do this
1314 * before the AUTOINCR check, so no problems arise if a
1315 * chip which does auto increment is marked as
1316 * NOAUTOINCR by the board driver.
1318 if (!chip
->dev_ready
)
1319 udelay(chip
->chip_delay
);
1321 nand_wait_ready(mtd
);
1328 /* Increment page address */
1331 page
= realpage
& chip
->pagemask
;
1332 /* Check, if we cross a chip boundary */
1335 chip
->select_chip(mtd
, -1);
1336 chip
->select_chip(mtd
, chipnr
);
1339 /* Check, if the chip supports auto page increment
1340 * or if we have hit a block boundary.
1342 if (!NAND_CANAUTOINCR(chip
) || !(page
& blkcheck
))
1346 ops
->oobretlen
= ops
->ooblen
;
1351 * nand_read_oob - [MTD Interface] NAND read data and/or out-of-band
1352 * @mtd: MTD device structure
1353 * @from: offset to read from
1354 * @ops: oob operation description structure
1356 * NAND read data and/or out-of-band data
1358 static int nand_read_oob(struct mtd_info
*mtd
, loff_t from
,
1359 struct mtd_oob_ops
*ops
)
1361 struct nand_chip
*chip
= mtd
->priv
;
1362 int ret
= -ENOTSUPP
;
1366 /* Do not allow reads past end of device */
1367 if (ops
->datbuf
&& (from
+ ops
->len
) > mtd
->size
) {
1368 DEBUG(MTD_DEBUG_LEVEL0
, "nand_read_oob: "
1369 "Attempt read beyond end of device\n");
1373 nand_get_device(chip
, mtd
, FL_READING
);
1386 ret
= nand_do_read_oob(mtd
, from
, ops
);
1388 ret
= nand_do_read_ops(mtd
, from
, ops
);
1391 nand_release_device(mtd
);
1397 * nand_write_page_raw - [Intern] raw page write function
1398 * @mtd: mtd info structure
1399 * @chip: nand chip info structure
1402 static void nand_write_page_raw(struct mtd_info
*mtd
, struct nand_chip
*chip
,
1405 chip
->write_buf(mtd
, buf
, mtd
->writesize
);
1406 chip
->write_buf(mtd
, chip
->oob_poi
, mtd
->oobsize
);
1410 * nand_write_page_swecc - [REPLACABLE] software ecc based page write function
1411 * @mtd: mtd info structure
1412 * @chip: nand chip info structure
1415 static void nand_write_page_swecc(struct mtd_info
*mtd
, struct nand_chip
*chip
,
1418 int i
, eccsize
= chip
->ecc
.size
;
1419 int eccbytes
= chip
->ecc
.bytes
;
1420 int eccsteps
= chip
->ecc
.steps
;
1421 uint8_t *ecc_calc
= chip
->buffers
->ecccalc
;
1422 const uint8_t *p
= buf
;
1423 uint32_t *eccpos
= chip
->ecc
.layout
->eccpos
;
1425 /* Software ecc calculation */
1426 for (i
= 0; eccsteps
; eccsteps
--, i
+= eccbytes
, p
+= eccsize
)
1427 chip
->ecc
.calculate(mtd
, p
, &ecc_calc
[i
]);
1429 for (i
= 0; i
< chip
->ecc
.total
; i
++)
1430 chip
->oob_poi
[eccpos
[i
]] = ecc_calc
[i
];
1432 chip
->ecc
.write_page_raw(mtd
, chip
, buf
);
1436 * nand_write_page_hwecc - [REPLACABLE] hardware ecc based page write function
1437 * @mtd: mtd info structure
1438 * @chip: nand chip info structure
1441 static void nand_write_page_hwecc(struct mtd_info
*mtd
, struct nand_chip
*chip
,
1444 int i
, eccsize
= chip
->ecc
.size
;
1445 int eccbytes
= chip
->ecc
.bytes
;
1446 int eccsteps
= chip
->ecc
.steps
;
1447 uint8_t *ecc_calc
= chip
->buffers
->ecccalc
;
1448 const uint8_t *p
= buf
;
1449 uint32_t *eccpos
= chip
->ecc
.layout
->eccpos
;
1451 for (i
= 0; eccsteps
; eccsteps
--, i
+= eccbytes
, p
+= eccsize
) {
1452 chip
->ecc
.hwctl(mtd
, NAND_ECC_WRITE
);
1453 chip
->write_buf(mtd
, p
, eccsize
);
1454 chip
->ecc
.calculate(mtd
, p
, &ecc_calc
[i
]);
1457 for (i
= 0; i
< chip
->ecc
.total
; i
++)
1458 chip
->oob_poi
[eccpos
[i
]] = ecc_calc
[i
];
1460 chip
->write_buf(mtd
, chip
->oob_poi
, mtd
->oobsize
);
1464 * nand_write_page_syndrome - [REPLACABLE] hardware ecc syndrom based page write
1465 * @mtd: mtd info structure
1466 * @chip: nand chip info structure
1469 * The hw generator calculates the error syndrome automatically. Therefor
1470 * we need a special oob layout and handling.
1472 static void nand_write_page_syndrome(struct mtd_info
*mtd
,
1473 struct nand_chip
*chip
, const uint8_t *buf
)
1475 int i
, eccsize
= chip
->ecc
.size
;
1476 int eccbytes
= chip
->ecc
.bytes
;
1477 int eccsteps
= chip
->ecc
.steps
;
1478 const uint8_t *p
= buf
;
1479 uint8_t *oob
= chip
->oob_poi
;
1481 for (i
= 0; eccsteps
; eccsteps
--, i
+= eccbytes
, p
+= eccsize
) {
1483 chip
->ecc
.hwctl(mtd
, NAND_ECC_WRITE
);
1484 chip
->write_buf(mtd
, p
, eccsize
);
1486 if (chip
->ecc
.prepad
) {
1487 chip
->write_buf(mtd
, oob
, chip
->ecc
.prepad
);
1488 oob
+= chip
->ecc
.prepad
;
1491 chip
->ecc
.calculate(mtd
, p
, oob
);
1492 chip
->write_buf(mtd
, oob
, eccbytes
);
1495 if (chip
->ecc
.postpad
) {
1496 chip
->write_buf(mtd
, oob
, chip
->ecc
.postpad
);
1497 oob
+= chip
->ecc
.postpad
;
1501 /* Calculate remaining oob bytes */
1502 i
= mtd
->oobsize
- (oob
- chip
->oob_poi
);
1504 chip
->write_buf(mtd
, oob
, i
);
1508 * nand_write_page - [REPLACEABLE] write one page
1509 * @mtd: MTD device structure
1510 * @chip: NAND chip descriptor
1511 * @buf: the data to write
1512 * @page: page number to write
1513 * @cached: cached programming
1514 * @raw: use _raw version of write_page
1516 static int nand_write_page(struct mtd_info
*mtd
, struct nand_chip
*chip
,
1517 const uint8_t *buf
, int page
, int cached
, int raw
)
1521 chip
->cmdfunc(mtd
, NAND_CMD_SEQIN
, 0x00, page
);
1524 chip
->ecc
.write_page_raw(mtd
, chip
, buf
);
1526 chip
->ecc
.write_page(mtd
, chip
, buf
);
1529 * Cached progamming disabled for now, Not sure if its worth the
1530 * trouble. The speed gain is not very impressive. (2.3->2.6Mib/s)
1534 if (!cached
|| !(chip
->options
& NAND_CACHEPRG
)) {
1536 chip
->cmdfunc(mtd
, NAND_CMD_PAGEPROG
, -1, -1);
1537 status
= chip
->waitfunc(mtd
, chip
);
1539 * See if operation failed and additional status checks are
1542 if ((status
& NAND_STATUS_FAIL
) && (chip
->errstat
))
1543 status
= chip
->errstat(mtd
, chip
, FL_WRITING
, status
,
1546 if (status
& NAND_STATUS_FAIL
)
1549 chip
->cmdfunc(mtd
, NAND_CMD_CACHEDPROG
, -1, -1);
1550 status
= chip
->waitfunc(mtd
, chip
);
1553 #ifdef CONFIG_MTD_NAND_VERIFY_WRITE
1554 /* Send command to read back the data */
1555 chip
->cmdfunc(mtd
, NAND_CMD_READ0
, 0, page
);
1557 if (chip
->verify_buf(mtd
, buf
, mtd
->writesize
))
1564 * nand_fill_oob - [Internal] Transfer client buffer to oob
1565 * @chip: nand chip structure
1566 * @oob: oob data buffer
1567 * @ops: oob ops structure
1569 static uint8_t *nand_fill_oob(struct nand_chip
*chip
, uint8_t *oob
,
1570 struct mtd_oob_ops
*ops
)
1572 size_t len
= ops
->ooblen
;
1578 memcpy(chip
->oob_poi
+ ops
->ooboffs
, oob
, len
);
1581 case MTD_OOB_AUTO
: {
1582 struct nand_oobfree
*free
= chip
->ecc
.layout
->oobfree
;
1583 uint32_t boffs
= 0, woffs
= ops
->ooboffs
;
1586 for(; free
->length
&& len
; free
++, len
-= bytes
) {
1587 /* Write request not from offset 0 ? */
1588 if (unlikely(woffs
)) {
1589 if (woffs
>= free
->length
) {
1590 woffs
-= free
->length
;
1593 boffs
= free
->offset
+ woffs
;
1594 bytes
= min_t(size_t, len
,
1595 (free
->length
- woffs
));
1598 bytes
= min_t(size_t, len
, free
->length
);
1599 boffs
= free
->offset
;
1601 memcpy(chip
->oob_poi
+ boffs
, oob
, bytes
);
1612 #define NOTALIGNED(x) (x & (chip->subpagesize - 1)) != 0
1615 * nand_do_write_ops - [Internal] NAND write with ECC
1616 * @mtd: MTD device structure
1617 * @to: offset to write to
1618 * @ops: oob operations description structure
1620 * NAND write with ECC
1622 static int nand_do_write_ops(struct mtd_info
*mtd
, loff_t to
,
1623 struct mtd_oob_ops
*ops
)
1625 int chipnr
, realpage
, page
, blockmask
, column
;
1626 struct nand_chip
*chip
= mtd
->priv
;
1627 uint32_t writelen
= ops
->len
;
1628 uint8_t *oob
= ops
->oobbuf
;
1629 uint8_t *buf
= ops
->datbuf
;
1636 /* reject writes, which are not page aligned */
1637 if (NOTALIGNED(to
) || NOTALIGNED(ops
->len
)) {
1638 printk(KERN_NOTICE
"nand_write: "
1639 "Attempt to write not page aligned data\n");
1643 column
= to
& (mtd
->writesize
- 1);
1644 subpage
= column
|| (writelen
& (mtd
->writesize
- 1));
1649 chipnr
= (int)(to
>> chip
->chip_shift
);
1650 chip
->select_chip(mtd
, chipnr
);
1652 /* Check, if it is write protected */
1653 if (nand_check_wp(mtd
))
1656 realpage
= (int)(to
>> chip
->page_shift
);
1657 page
= realpage
& chip
->pagemask
;
1658 blockmask
= (1 << (chip
->phys_erase_shift
- chip
->page_shift
)) - 1;
1660 /* Invalidate the page cache, when we write to the cached page */
1661 if (to
<= (chip
->pagebuf
<< chip
->page_shift
) &&
1662 (chip
->pagebuf
<< chip
->page_shift
) < (to
+ ops
->len
))
1665 /* If we're not given explicit OOB data, let it be 0xFF */
1667 memset(chip
->oob_poi
, 0xff, mtd
->oobsize
);
1670 int bytes
= mtd
->writesize
;
1671 int cached
= writelen
> bytes
&& page
!= blockmask
;
1672 uint8_t *wbuf
= buf
;
1674 /* Partial page write ? */
1675 if (unlikely(column
|| writelen
< (mtd
->writesize
- 1))) {
1677 bytes
= min_t(int, bytes
- column
, (int) writelen
);
1679 memset(chip
->buffers
->databuf
, 0xff, mtd
->writesize
);
1680 memcpy(&chip
->buffers
->databuf
[column
], buf
, bytes
);
1681 wbuf
= chip
->buffers
->databuf
;
1685 oob
= nand_fill_oob(chip
, oob
, ops
);
1687 ret
= chip
->write_page(mtd
, chip
, wbuf
, page
, cached
,
1688 (ops
->mode
== MTD_OOB_RAW
));
1700 page
= realpage
& chip
->pagemask
;
1701 /* Check, if we cross a chip boundary */
1704 chip
->select_chip(mtd
, -1);
1705 chip
->select_chip(mtd
, chipnr
);
1709 ops
->retlen
= ops
->len
- writelen
;
1711 ops
->oobretlen
= ops
->ooblen
;
1716 * nand_write - [MTD Interface] NAND write with ECC
1717 * @mtd: MTD device structure
1718 * @to: offset to write to
1719 * @len: number of bytes to write
1720 * @retlen: pointer to variable to store the number of written bytes
1721 * @buf: the data to write
1723 * NAND write with ECC
1725 static int nand_write(struct mtd_info
*mtd
, loff_t to
, size_t len
,
1726 size_t *retlen
, const uint8_t *buf
)
1728 struct nand_chip
*chip
= mtd
->priv
;
1731 /* Do not allow reads past end of device */
1732 if ((to
+ len
) > mtd
->size
)
1737 nand_get_device(chip
, mtd
, FL_WRITING
);
1739 chip
->ops
.len
= len
;
1740 chip
->ops
.datbuf
= (uint8_t *)buf
;
1741 chip
->ops
.oobbuf
= NULL
;
1743 ret
= nand_do_write_ops(mtd
, to
, &chip
->ops
);
1745 *retlen
= chip
->ops
.retlen
;
1747 nand_release_device(mtd
);
1753 * nand_do_write_oob - [MTD Interface] NAND write out-of-band
1754 * @mtd: MTD device structure
1755 * @to: offset to write to
1756 * @ops: oob operation description structure
1758 * NAND write out-of-band
1760 static int nand_do_write_oob(struct mtd_info
*mtd
, loff_t to
,
1761 struct mtd_oob_ops
*ops
)
1763 int chipnr
, page
, status
, len
;
1764 struct nand_chip
*chip
= mtd
->priv
;
1766 DEBUG(MTD_DEBUG_LEVEL3
, "nand_write_oob: to = 0x%08x, len = %i\n",
1767 (unsigned int)to
, (int)ops
->ooblen
);
1769 if (ops
->mode
== MTD_OOB_AUTO
)
1770 len
= chip
->ecc
.layout
->oobavail
;
1774 /* Do not allow write past end of page */
1775 if ((ops
->ooboffs
+ ops
->ooblen
) > len
) {
1776 DEBUG(MTD_DEBUG_LEVEL0
, "nand_write_oob: "
1777 "Attempt to write past end of page\n");
1781 if (unlikely(ops
->ooboffs
>= len
)) {
1782 DEBUG(MTD_DEBUG_LEVEL0
, "nand_read_oob: "
1783 "Attempt to start write outside oob\n");
1787 /* Do not allow reads past end of device */
1788 if (unlikely(to
>= mtd
->size
||
1789 ops
->ooboffs
+ ops
->ooblen
>
1790 ((mtd
->size
>> chip
->page_shift
) -
1791 (to
>> chip
->page_shift
)) * len
)) {
1792 DEBUG(MTD_DEBUG_LEVEL0
, "nand_read_oob: "
1793 "Attempt write beyond end of device\n");
1797 chipnr
= (int)(to
>> chip
->chip_shift
);
1798 chip
->select_chip(mtd
, chipnr
);
1800 /* Shift to get page */
1801 page
= (int)(to
>> chip
->page_shift
);
1804 * Reset the chip. Some chips (like the Toshiba TC5832DC found in one
1805 * of my DiskOnChip 2000 test units) will clear the whole data page too
1806 * if we don't do this. I have no clue why, but I seem to have 'fixed'
1807 * it in the doc2000 driver in August 1999. dwmw2.
1809 chip
->cmdfunc(mtd
, NAND_CMD_RESET
, -1, -1);
1811 /* Check, if it is write protected */
1812 if (nand_check_wp(mtd
))
1815 /* Invalidate the page cache, if we write to the cached page */
1816 if (page
== chip
->pagebuf
)
1819 memset(chip
->oob_poi
, 0xff, mtd
->oobsize
);
1820 nand_fill_oob(chip
, ops
->oobbuf
, ops
);
1821 status
= chip
->ecc
.write_oob(mtd
, chip
, page
& chip
->pagemask
);
1822 memset(chip
->oob_poi
, 0xff, mtd
->oobsize
);
1827 ops
->oobretlen
= ops
->ooblen
;
1833 * nand_write_oob - [MTD Interface] NAND write data and/or out-of-band
1834 * @mtd: MTD device structure
1835 * @to: offset to write to
1836 * @ops: oob operation description structure
1838 static int nand_write_oob(struct mtd_info
*mtd
, loff_t to
,
1839 struct mtd_oob_ops
*ops
)
1841 struct nand_chip
*chip
= mtd
->priv
;
1842 int ret
= -ENOTSUPP
;
1846 /* Do not allow writes past end of device */
1847 if (ops
->datbuf
&& (to
+ ops
->len
) > mtd
->size
) {
1848 DEBUG(MTD_DEBUG_LEVEL0
, "nand_read_oob: "
1849 "Attempt read beyond end of device\n");
1853 nand_get_device(chip
, mtd
, FL_WRITING
);
1866 ret
= nand_do_write_oob(mtd
, to
, ops
);
1868 ret
= nand_do_write_ops(mtd
, to
, ops
);
1871 nand_release_device(mtd
);
1876 * single_erease_cmd - [GENERIC] NAND standard block erase command function
1877 * @mtd: MTD device structure
1878 * @page: the page address of the block which will be erased
1880 * Standard erase command for NAND chips
1882 static void single_erase_cmd(struct mtd_info
*mtd
, int page
)
1884 struct nand_chip
*chip
= mtd
->priv
;
1885 /* Send commands to erase a block */
1886 chip
->cmdfunc(mtd
, NAND_CMD_ERASE1
, -1, page
);
1887 chip
->cmdfunc(mtd
, NAND_CMD_ERASE2
, -1, -1);
1891 * multi_erease_cmd - [GENERIC] AND specific block erase command function
1892 * @mtd: MTD device structure
1893 * @page: the page address of the block which will be erased
1895 * AND multi block erase command function
1896 * Erase 4 consecutive blocks
1898 static void multi_erase_cmd(struct mtd_info
*mtd
, int page
)
1900 struct nand_chip
*chip
= mtd
->priv
;
1901 /* Send commands to erase a block */
1902 chip
->cmdfunc(mtd
, NAND_CMD_ERASE1
, -1, page
++);
1903 chip
->cmdfunc(mtd
, NAND_CMD_ERASE1
, -1, page
++);
1904 chip
->cmdfunc(mtd
, NAND_CMD_ERASE1
, -1, page
++);
1905 chip
->cmdfunc(mtd
, NAND_CMD_ERASE1
, -1, page
);
1906 chip
->cmdfunc(mtd
, NAND_CMD_ERASE2
, -1, -1);
1910 * nand_erase - [MTD Interface] erase block(s)
1911 * @mtd: MTD device structure
1912 * @instr: erase instruction
1914 * Erase one ore more blocks
1916 static int nand_erase(struct mtd_info
*mtd
, struct erase_info
*instr
)
1918 return nand_erase_nand(mtd
, instr
, 0);
1921 #define BBT_PAGE_MASK 0xffffff3f
1923 * nand_erase_nand - [Internal] erase block(s)
1924 * @mtd: MTD device structure
1925 * @instr: erase instruction
1926 * @allowbbt: allow erasing the bbt area
1928 * Erase one ore more blocks
1930 int nand_erase_nand(struct mtd_info
*mtd
, struct erase_info
*instr
,
1933 int page
, len
, status
, pages_per_block
, ret
, chipnr
;
1934 struct nand_chip
*chip
= mtd
->priv
;
1935 int rewrite_bbt
[NAND_MAX_CHIPS
]={0};
1936 unsigned int bbt_masked_page
= 0xffffffff;
1938 DEBUG(MTD_DEBUG_LEVEL3
, "nand_erase: start = 0x%08x, len = %i\n",
1939 (unsigned int)instr
->addr
, (unsigned int)instr
->len
);
1941 /* Start address must align on block boundary */
1942 if (instr
->addr
& ((1 << chip
->phys_erase_shift
) - 1)) {
1943 DEBUG(MTD_DEBUG_LEVEL0
, "nand_erase: Unaligned address\n");
1947 /* Length must align on block boundary */
1948 if (instr
->len
& ((1 << chip
->phys_erase_shift
) - 1)) {
1949 DEBUG(MTD_DEBUG_LEVEL0
, "nand_erase: "
1950 "Length not block aligned\n");
1954 /* Do not allow erase past end of device */
1955 if ((instr
->len
+ instr
->addr
) > mtd
->size
) {
1956 DEBUG(MTD_DEBUG_LEVEL0
, "nand_erase: "
1957 "Erase past end of device\n");
1961 instr
->fail_addr
= 0xffffffff;
1963 /* Grab the lock and see if the device is available */
1964 nand_get_device(chip
, mtd
, FL_ERASING
);
1966 /* Shift to get first page */
1967 page
= (int)(instr
->addr
>> chip
->page_shift
);
1968 chipnr
= (int)(instr
->addr
>> chip
->chip_shift
);
1970 /* Calculate pages in each block */
1971 pages_per_block
= 1 << (chip
->phys_erase_shift
- chip
->page_shift
);
1973 /* Select the NAND device */
1974 chip
->select_chip(mtd
, chipnr
);
1976 /* Check, if it is write protected */
1977 if (nand_check_wp(mtd
)) {
1978 DEBUG(MTD_DEBUG_LEVEL0
, "nand_erase: "
1979 "Device is write protected!!!\n");
1980 instr
->state
= MTD_ERASE_FAILED
;
1985 * If BBT requires refresh, set the BBT page mask to see if the BBT
1986 * should be rewritten. Otherwise the mask is set to 0xffffffff which
1987 * can not be matched. This is also done when the bbt is actually
1988 * erased to avoid recusrsive updates
1990 if (chip
->options
& BBT_AUTO_REFRESH
&& !allowbbt
)
1991 bbt_masked_page
= chip
->bbt_td
->pages
[chipnr
] & BBT_PAGE_MASK
;
1993 /* Loop through the pages */
1996 instr
->state
= MTD_ERASING
;
2000 * heck if we have a bad block, we do not erase bad blocks !
2002 if (nand_block_checkbad(mtd
, ((loff_t
) page
) <<
2003 chip
->page_shift
, 0, allowbbt
)) {
2004 printk(KERN_WARNING
"nand_erase: attempt to erase a "
2005 "bad block at page 0x%08x\n", page
);
2006 instr
->state
= MTD_ERASE_FAILED
;
2011 * Invalidate the page cache, if we erase the block which
2012 * contains the current cached page
2014 if (page
<= chip
->pagebuf
&& chip
->pagebuf
<
2015 (page
+ pages_per_block
))
2018 chip
->erase_cmd(mtd
, page
& chip
->pagemask
);
2020 status
= chip
->waitfunc(mtd
, chip
);
2023 * See if operation failed and additional status checks are
2026 if ((status
& NAND_STATUS_FAIL
) && (chip
->errstat
))
2027 status
= chip
->errstat(mtd
, chip
, FL_ERASING
,
2030 /* See if block erase succeeded */
2031 if (status
& NAND_STATUS_FAIL
) {
2032 DEBUG(MTD_DEBUG_LEVEL0
, "nand_erase: "
2033 "Failed erase, page 0x%08x\n", page
);
2034 instr
->state
= MTD_ERASE_FAILED
;
2035 instr
->fail_addr
= (page
<< chip
->page_shift
);
2040 * If BBT requires refresh, set the BBT rewrite flag to the
2043 if (bbt_masked_page
!= 0xffffffff &&
2044 (page
& BBT_PAGE_MASK
) == bbt_masked_page
)
2045 rewrite_bbt
[chipnr
] = (page
<< chip
->page_shift
);
2047 /* Increment page address and decrement length */
2048 len
-= (1 << chip
->phys_erase_shift
);
2049 page
+= pages_per_block
;
2051 /* Check, if we cross a chip boundary */
2052 if (len
&& !(page
& chip
->pagemask
)) {
2054 chip
->select_chip(mtd
, -1);
2055 chip
->select_chip(mtd
, chipnr
);
2058 * If BBT requires refresh and BBT-PERCHIP, set the BBT
2059 * page mask to see if this BBT should be rewritten
2061 if (bbt_masked_page
!= 0xffffffff &&
2062 (chip
->bbt_td
->options
& NAND_BBT_PERCHIP
))
2063 bbt_masked_page
= chip
->bbt_td
->pages
[chipnr
] &
2067 instr
->state
= MTD_ERASE_DONE
;
2071 ret
= instr
->state
== MTD_ERASE_DONE
? 0 : -EIO
;
2073 /* Deselect and wake up anyone waiting on the device */
2074 nand_release_device(mtd
);
2076 /* Do call back function */
2078 mtd_erase_callback(instr
);
2081 * If BBT requires refresh and erase was successful, rewrite any
2082 * selected bad block tables
2084 if (bbt_masked_page
== 0xffffffff || ret
)
2087 for (chipnr
= 0; chipnr
< chip
->numchips
; chipnr
++) {
2088 if (!rewrite_bbt
[chipnr
])
2090 /* update the BBT for chip */
2091 DEBUG(MTD_DEBUG_LEVEL0
, "nand_erase_nand: nand_update_bbt "
2092 "(%d:0x%0x 0x%0x)\n", chipnr
, rewrite_bbt
[chipnr
],
2093 chip
->bbt_td
->pages
[chipnr
]);
2094 nand_update_bbt(mtd
, rewrite_bbt
[chipnr
]);
2097 /* Return more or less happy */
2102 * nand_sync - [MTD Interface] sync
2103 * @mtd: MTD device structure
2105 * Sync is actually a wait for chip ready function
2107 static void nand_sync(struct mtd_info
*mtd
)
2109 struct nand_chip
*chip
= mtd
->priv
;
2111 DEBUG(MTD_DEBUG_LEVEL3
, "nand_sync: called\n");
2113 /* Grab the lock and see if the device is available */
2114 nand_get_device(chip
, mtd
, FL_SYNCING
);
2115 /* Release it and go back */
2116 nand_release_device(mtd
);
2120 * nand_block_isbad - [MTD Interface] Check if block at offset is bad
2121 * @mtd: MTD device structure
2122 * @offs: offset relative to mtd start
2124 static int nand_block_isbad(struct mtd_info
*mtd
, loff_t offs
)
2126 /* Check for invalid offset */
2127 if (offs
> mtd
->size
)
2130 return nand_block_checkbad(mtd
, offs
, 1, 0);
2134 * nand_block_markbad - [MTD Interface] Mark block at the given offset as bad
2135 * @mtd: MTD device structure
2136 * @ofs: offset relative to mtd start
2138 static int nand_block_markbad(struct mtd_info
*mtd
, loff_t ofs
)
2140 struct nand_chip
*chip
= mtd
->priv
;
2143 if ((ret
= nand_block_isbad(mtd
, ofs
))) {
2144 /* If it was bad already, return success and do nothing. */
2150 return chip
->block_markbad(mtd
, ofs
);
2154 * nand_suspend - [MTD Interface] Suspend the NAND flash
2155 * @mtd: MTD device structure
2157 static int nand_suspend(struct mtd_info
*mtd
)
2159 struct nand_chip
*chip
= mtd
->priv
;
2161 return nand_get_device(chip
, mtd
, FL_PM_SUSPENDED
);
2165 * nand_resume - [MTD Interface] Resume the NAND flash
2166 * @mtd: MTD device structure
2168 static void nand_resume(struct mtd_info
*mtd
)
2170 struct nand_chip
*chip
= mtd
->priv
;
2172 if (chip
->state
== FL_PM_SUSPENDED
)
2173 nand_release_device(mtd
);
2175 printk(KERN_ERR
"nand_resume() called for a chip which is not "
2176 "in suspended state\n");
2180 * Set default functions
2182 static void nand_set_defaults(struct nand_chip
*chip
, int busw
)
2184 /* check for proper chip_delay setup, set 20us if not */
2185 if (!chip
->chip_delay
)
2186 chip
->chip_delay
= 20;
2188 /* check, if a user supplied command function given */
2189 if (chip
->cmdfunc
== NULL
)
2190 chip
->cmdfunc
= nand_command
;
2192 /* check, if a user supplied wait function given */
2193 if (chip
->waitfunc
== NULL
)
2194 chip
->waitfunc
= nand_wait
;
2196 if (!chip
->select_chip
)
2197 chip
->select_chip
= nand_select_chip
;
2198 if (!chip
->read_byte
)
2199 chip
->read_byte
= busw
? nand_read_byte16
: nand_read_byte
;
2200 if (!chip
->read_word
)
2201 chip
->read_word
= nand_read_word
;
2202 if (!chip
->block_bad
)
2203 chip
->block_bad
= nand_block_bad
;
2204 if (!chip
->block_markbad
)
2205 chip
->block_markbad
= nand_default_block_markbad
;
2206 if (!chip
->write_buf
)
2207 chip
->write_buf
= busw
? nand_write_buf16
: nand_write_buf
;
2208 if (!chip
->read_buf
)
2209 chip
->read_buf
= busw
? nand_read_buf16
: nand_read_buf
;
2210 if (!chip
->verify_buf
)
2211 chip
->verify_buf
= busw
? nand_verify_buf16
: nand_verify_buf
;
2212 if (!chip
->scan_bbt
)
2213 chip
->scan_bbt
= nand_default_bbt
;
2215 if (!chip
->controller
) {
2216 chip
->controller
= &chip
->hwcontrol
;
2217 spin_lock_init(&chip
->controller
->lock
);
2218 init_waitqueue_head(&chip
->controller
->wq
);
2224 * Get the flash and manufacturer id and lookup if the type is supported
2226 static struct nand_flash_dev
*nand_get_flash_type(struct mtd_info
*mtd
,
2227 struct nand_chip
*chip
,
2228 int busw
, int *maf_id
)
2230 struct nand_flash_dev
*type
= NULL
;
2231 int i
, dev_id
, maf_idx
;
2233 /* Select the device */
2234 chip
->select_chip(mtd
, 0);
2236 /* Send the command for reading device ID */
2237 chip
->cmdfunc(mtd
, NAND_CMD_READID
, 0x00, -1);
2239 /* Read manufacturer and device IDs */
2240 *maf_id
= chip
->read_byte(mtd
);
2241 dev_id
= chip
->read_byte(mtd
);
2243 /* Lookup the flash id */
2244 for (i
= 0; nand_flash_ids
[i
].name
!= NULL
; i
++) {
2245 if (dev_id
== nand_flash_ids
[i
].id
) {
2246 type
= &nand_flash_ids
[i
];
2252 return ERR_PTR(-ENODEV
);
2255 mtd
->name
= type
->name
;
2257 chip
->chipsize
= type
->chipsize
<< 20;
2259 /* Newer devices have all the information in additional id bytes */
2260 if (!type
->pagesize
) {
2262 /* The 3rd id byte holds MLC / multichip data */
2263 chip
->cellinfo
= chip
->read_byte(mtd
);
2264 /* The 4th id byte is the important one */
2265 extid
= chip
->read_byte(mtd
);
2267 mtd
->writesize
= 1024 << (extid
& 0x3);
2270 mtd
->oobsize
= (8 << (extid
& 0x01)) * (mtd
->writesize
>> 9);
2272 /* Calc blocksize. Blocksize is multiples of 64KiB */
2273 mtd
->erasesize
= (64 * 1024) << (extid
& 0x03);
2275 /* Get buswidth information */
2276 busw
= (extid
& 0x01) ? NAND_BUSWIDTH_16
: 0;
2280 * Old devices have chip data hardcoded in the device id table
2282 mtd
->erasesize
= type
->erasesize
;
2283 mtd
->writesize
= type
->pagesize
;
2284 mtd
->oobsize
= mtd
->writesize
/ 32;
2285 busw
= type
->options
& NAND_BUSWIDTH_16
;
2288 /* Try to identify manufacturer */
2289 for (maf_idx
= 0; nand_manuf_ids
[maf_idx
].id
!= 0x0; maf_idx
++) {
2290 if (nand_manuf_ids
[maf_idx
].id
== *maf_id
)
2295 * Check, if buswidth is correct. Hardware drivers should set
2298 if (busw
!= (chip
->options
& NAND_BUSWIDTH_16
)) {
2299 printk(KERN_INFO
"NAND device: Manufacturer ID:"
2300 " 0x%02x, Chip ID: 0x%02x (%s %s)\n", *maf_id
,
2301 dev_id
, nand_manuf_ids
[maf_idx
].name
, mtd
->name
);
2302 printk(KERN_WARNING
"NAND bus width %d instead %d bit\n",
2303 (chip
->options
& NAND_BUSWIDTH_16
) ? 16 : 8,
2305 return ERR_PTR(-EINVAL
);
2308 /* Calculate the address shift from the page size */
2309 chip
->page_shift
= ffs(mtd
->writesize
) - 1;
2310 /* Convert chipsize to number of pages per chip -1. */
2311 chip
->pagemask
= (chip
->chipsize
>> chip
->page_shift
) - 1;
2313 chip
->bbt_erase_shift
= chip
->phys_erase_shift
=
2314 ffs(mtd
->erasesize
) - 1;
2315 chip
->chip_shift
= ffs(chip
->chipsize
) - 1;
2317 /* Set the bad block position */
2318 chip
->badblockpos
= mtd
->writesize
> 512 ?
2319 NAND_LARGE_BADBLOCK_POS
: NAND_SMALL_BADBLOCK_POS
;
2321 /* Get chip options, preserve non chip based options */
2322 chip
->options
&= ~NAND_CHIPOPTIONS_MSK
;
2323 chip
->options
|= type
->options
& NAND_CHIPOPTIONS_MSK
;
2326 * Set chip as a default. Board drivers can override it, if necessary
2328 chip
->options
|= NAND_NO_AUTOINCR
;
2330 /* Check if chip is a not a samsung device. Do not clear the
2331 * options for chips which are not having an extended id.
2333 if (*maf_id
!= NAND_MFR_SAMSUNG
&& !type
->pagesize
)
2334 chip
->options
&= ~NAND_SAMSUNG_LP_OPTIONS
;
2336 /* Check for AND chips with 4 page planes */
2337 if (chip
->options
& NAND_4PAGE_ARRAY
)
2338 chip
->erase_cmd
= multi_erase_cmd
;
2340 chip
->erase_cmd
= single_erase_cmd
;
2342 /* Do not replace user supplied command function ! */
2343 if (mtd
->writesize
> 512 && chip
->cmdfunc
== nand_command
)
2344 chip
->cmdfunc
= nand_command_lp
;
2346 printk(KERN_INFO
"NAND device: Manufacturer ID:"
2347 " 0x%02x, Chip ID: 0x%02x (%s %s)\n", *maf_id
, dev_id
,
2348 nand_manuf_ids
[maf_idx
].name
, type
->name
);
2354 * nand_scan_ident - [NAND Interface] Scan for the NAND device
2355 * @mtd: MTD device structure
2356 * @maxchips: Number of chips to scan for
2358 * This is the first phase of the normal nand_scan() function. It
2359 * reads the flash ID and sets up MTD fields accordingly.
2361 * The mtd->owner field must be set to the module of the caller.
2363 int nand_scan_ident(struct mtd_info
*mtd
, int maxchips
)
2365 int i
, busw
, nand_maf_id
;
2366 struct nand_chip
*chip
= mtd
->priv
;
2367 struct nand_flash_dev
*type
;
2369 /* Get buswidth to select the correct functions */
2370 busw
= chip
->options
& NAND_BUSWIDTH_16
;
2371 /* Set the default functions */
2372 nand_set_defaults(chip
, busw
);
2374 /* Read the flash type */
2375 type
= nand_get_flash_type(mtd
, chip
, busw
, &nand_maf_id
);
2378 printk(KERN_WARNING
"No NAND device found!!!\n");
2379 chip
->select_chip(mtd
, -1);
2380 return PTR_ERR(type
);
2383 /* Check for a chip array */
2384 for (i
= 1; i
< maxchips
; i
++) {
2385 chip
->select_chip(mtd
, i
);
2386 /* Send the command for reading device ID */
2387 chip
->cmdfunc(mtd
, NAND_CMD_READID
, 0x00, -1);
2388 /* Read manufacturer and device IDs */
2389 if (nand_maf_id
!= chip
->read_byte(mtd
) ||
2390 type
->id
!= chip
->read_byte(mtd
))
2394 printk(KERN_INFO
"%d NAND chips detected\n", i
);
2396 /* Store the number of chips and calc total size for mtd */
2398 mtd
->size
= i
* chip
->chipsize
;
2405 * nand_scan_tail - [NAND Interface] Scan for the NAND device
2406 * @mtd: MTD device structure
2407 * @maxchips: Number of chips to scan for
2409 * This is the second phase of the normal nand_scan() function. It
2410 * fills out all the uninitialized function pointers with the defaults
2411 * and scans for a bad block table if appropriate.
2413 int nand_scan_tail(struct mtd_info
*mtd
)
2416 struct nand_chip
*chip
= mtd
->priv
;
2418 if (!(chip
->options
& NAND_OWN_BUFFERS
))
2419 chip
->buffers
= kmalloc(sizeof(*chip
->buffers
), GFP_KERNEL
);
2423 /* Set the internal oob buffer location, just after the page data */
2424 chip
->oob_poi
= chip
->buffers
->databuf
+ mtd
->writesize
;
2427 * If no default placement scheme is given, select an appropriate one
2429 if (!chip
->ecc
.layout
) {
2430 switch (mtd
->oobsize
) {
2432 chip
->ecc
.layout
= &nand_oob_8
;
2435 chip
->ecc
.layout
= &nand_oob_16
;
2438 chip
->ecc
.layout
= &nand_oob_64
;
2441 printk(KERN_WARNING
"No oob scheme defined for "
2442 "oobsize %d\n", mtd
->oobsize
);
2447 if (!chip
->write_page
)
2448 chip
->write_page
= nand_write_page
;
2451 * check ECC mode, default to software if 3byte/512byte hardware ECC is
2452 * selected and we have 256 byte pagesize fallback to software ECC
2454 if (!chip
->ecc
.read_page_raw
)
2455 chip
->ecc
.read_page_raw
= nand_read_page_raw
;
2456 if (!chip
->ecc
.write_page_raw
)
2457 chip
->ecc
.write_page_raw
= nand_write_page_raw
;
2459 switch (chip
->ecc
.mode
) {
2461 /* Use standard hwecc read page function ? */
2462 if (!chip
->ecc
.read_page
)
2463 chip
->ecc
.read_page
= nand_read_page_hwecc
;
2464 if (!chip
->ecc
.write_page
)
2465 chip
->ecc
.write_page
= nand_write_page_hwecc
;
2466 if (!chip
->ecc
.read_oob
)
2467 chip
->ecc
.read_oob
= nand_read_oob_std
;
2468 if (!chip
->ecc
.write_oob
)
2469 chip
->ecc
.write_oob
= nand_write_oob_std
;
2471 case NAND_ECC_HW_SYNDROME
:
2472 if ((!chip
->ecc
.calculate
|| !chip
->ecc
.correct
||
2473 !chip
->ecc
.hwctl
) &&
2474 (!chip
->ecc
.read_page
||
2475 chip
->ecc
.read_page
== nand_read_page_hwecc
) ||
2476 !chip
->ecc
.write_page
||
2477 chip
->ecc
.write_page
== nand_write_page_hwecc
) {
2478 printk(KERN_WARNING
"No ECC functions supplied, "
2479 "Hardware ECC not possible\n");
2482 /* Use standard syndrome read/write page function ? */
2483 if (!chip
->ecc
.read_page
)
2484 chip
->ecc
.read_page
= nand_read_page_syndrome
;
2485 if (!chip
->ecc
.write_page
)
2486 chip
->ecc
.write_page
= nand_write_page_syndrome
;
2487 if (!chip
->ecc
.read_oob
)
2488 chip
->ecc
.read_oob
= nand_read_oob_syndrome
;
2489 if (!chip
->ecc
.write_oob
)
2490 chip
->ecc
.write_oob
= nand_write_oob_syndrome
;
2492 if (mtd
->writesize
>= chip
->ecc
.size
)
2494 printk(KERN_WARNING
"%d byte HW ECC not possible on "
2495 "%d byte page size, fallback to SW ECC\n",
2496 chip
->ecc
.size
, mtd
->writesize
);
2497 chip
->ecc
.mode
= NAND_ECC_SOFT
;
2500 chip
->ecc
.calculate
= nand_calculate_ecc
;
2501 chip
->ecc
.correct
= nand_correct_data
;
2502 chip
->ecc
.read_page
= nand_read_page_swecc
;
2503 chip
->ecc
.write_page
= nand_write_page_swecc
;
2504 chip
->ecc
.read_oob
= nand_read_oob_std
;
2505 chip
->ecc
.write_oob
= nand_write_oob_std
;
2506 chip
->ecc
.size
= 256;
2507 chip
->ecc
.bytes
= 3;
2511 printk(KERN_WARNING
"NAND_ECC_NONE selected by board driver. "
2512 "This is not recommended !!\n");
2513 chip
->ecc
.read_page
= nand_read_page_raw
;
2514 chip
->ecc
.write_page
= nand_write_page_raw
;
2515 chip
->ecc
.read_oob
= nand_read_oob_std
;
2516 chip
->ecc
.write_oob
= nand_write_oob_std
;
2517 chip
->ecc
.size
= mtd
->writesize
;
2518 chip
->ecc
.bytes
= 0;
2522 printk(KERN_WARNING
"Invalid NAND_ECC_MODE %d\n",
2528 * The number of bytes available for a client to place data into
2529 * the out of band area
2531 chip
->ecc
.layout
->oobavail
= 0;
2532 for (i
= 0; chip
->ecc
.layout
->oobfree
[i
].length
; i
++)
2533 chip
->ecc
.layout
->oobavail
+=
2534 chip
->ecc
.layout
->oobfree
[i
].length
;
2535 mtd
->oobavail
= chip
->ecc
.layout
->oobavail
;
2538 * Set the number of read / write steps for one page depending on ECC
2541 chip
->ecc
.steps
= mtd
->writesize
/ chip
->ecc
.size
;
2542 if(chip
->ecc
.steps
* chip
->ecc
.size
!= mtd
->writesize
) {
2543 printk(KERN_WARNING
"Invalid ecc parameters\n");
2546 chip
->ecc
.total
= chip
->ecc
.steps
* chip
->ecc
.bytes
;
2549 * Allow subpage writes up to ecc.steps. Not possible for MLC
2552 if (!(chip
->options
& NAND_NO_SUBPAGE_WRITE
) &&
2553 !(chip
->cellinfo
& NAND_CI_CELLTYPE_MSK
)) {
2554 switch(chip
->ecc
.steps
) {
2556 mtd
->subpage_sft
= 1;
2560 mtd
->subpage_sft
= 2;
2564 chip
->subpagesize
= mtd
->writesize
>> mtd
->subpage_sft
;
2566 /* Initialize state */
2567 chip
->state
= FL_READY
;
2569 /* De-select the device */
2570 chip
->select_chip(mtd
, -1);
2572 /* Invalidate the pagebuffer reference */
2575 /* Fill in remaining MTD driver data */
2576 mtd
->type
= MTD_NANDFLASH
;
2577 mtd
->flags
= MTD_CAP_NANDFLASH
;
2578 mtd
->erase
= nand_erase
;
2580 mtd
->unpoint
= NULL
;
2581 mtd
->read
= nand_read
;
2582 mtd
->write
= nand_write
;
2583 mtd
->read_oob
= nand_read_oob
;
2584 mtd
->write_oob
= nand_write_oob
;
2585 mtd
->sync
= nand_sync
;
2588 mtd
->suspend
= nand_suspend
;
2589 mtd
->resume
= nand_resume
;
2590 mtd
->block_isbad
= nand_block_isbad
;
2591 mtd
->block_markbad
= nand_block_markbad
;
2593 /* propagate ecc.layout to mtd_info */
2594 mtd
->ecclayout
= chip
->ecc
.layout
;
2596 /* Check, if we should skip the bad block table scan */
2597 if (chip
->options
& NAND_SKIP_BBTSCAN
)
2600 /* Build bad block table */
2601 return chip
->scan_bbt(mtd
);
2604 /* module_text_address() isn't exported, and it's mostly a pointless
2605 test if this is a module _anyway_ -- they'd have to try _really_ hard
2606 to call us from in-kernel code if the core NAND support is modular. */
2608 #define caller_is_module() (1)
2610 #define caller_is_module() \
2611 module_text_address((unsigned long)__builtin_return_address(0))
2615 * nand_scan - [NAND Interface] Scan for the NAND device
2616 * @mtd: MTD device structure
2617 * @maxchips: Number of chips to scan for
2619 * This fills out all the uninitialized function pointers
2620 * with the defaults.
2621 * The flash ID is read and the mtd/chip structures are
2622 * filled with the appropriate values.
2623 * The mtd->owner field must be set to the module of the caller
2626 int nand_scan(struct mtd_info
*mtd
, int maxchips
)
2630 /* Many callers got this wrong, so check for it for a while... */
2631 if (!mtd
->owner
&& caller_is_module()) {
2632 printk(KERN_CRIT
"nand_scan() called with NULL mtd->owner!\n");
2636 ret
= nand_scan_ident(mtd
, maxchips
);
2638 ret
= nand_scan_tail(mtd
);
2643 * nand_release - [NAND Interface] Free resources held by the NAND device
2644 * @mtd: MTD device structure
2646 void nand_release(struct mtd_info
*mtd
)
2648 struct nand_chip
*chip
= mtd
->priv
;
2650 #ifdef CONFIG_MTD_PARTITIONS
2651 /* Deregister partitions */
2652 del_mtd_partitions(mtd
);
2654 /* Deregister the device */
2655 del_mtd_device(mtd
);
2657 /* Free bad block table memory */
2659 if (!(chip
->options
& NAND_OWN_BUFFERS
))
2660 kfree(chip
->buffers
);
2663 EXPORT_SYMBOL_GPL(nand_scan
);
2664 EXPORT_SYMBOL_GPL(nand_scan_ident
);
2665 EXPORT_SYMBOL_GPL(nand_scan_tail
);
2666 EXPORT_SYMBOL_GPL(nand_release
);
2668 static int __init
nand_base_init(void)
2670 led_trigger_register_simple("nand-disk", &nand_led_trigger
);
2674 static void __exit
nand_base_exit(void)
2676 led_trigger_unregister_simple(nand_led_trigger
);
2679 module_init(nand_base_init
);
2680 module_exit(nand_base_exit
);
2682 MODULE_LICENSE("GPL");
2683 MODULE_AUTHOR("Steven J. Hill <sjhill@realitydiluted.com>, Thomas Gleixner <tglx@linutronix.de>");
2684 MODULE_DESCRIPTION("Generic NAND flash driver code");