2 * linux/drivers/mtd/onenand/onenand_base.c
4 * Copyright (C) 2005-2007 Samsung Electronics
5 * Kyungmin Park <kyungmin.park@samsung.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
12 #include <linux/kernel.h>
13 #include <linux/module.h>
14 #include <linux/init.h>
15 #include <linux/sched.h>
16 #include <linux/interrupt.h>
17 #include <linux/jiffies.h>
18 #include <linux/mtd/mtd.h>
19 #include <linux/mtd/onenand.h>
20 #include <linux/mtd/partitions.h>
25 * onenand_oob_64 - oob info for large (2KB) page
27 static struct nand_ecclayout onenand_oob_64 = {
36 {2, 3}, {14, 2}, {18, 3}, {30, 2},
37 {34, 3}, {46, 2}, {50, 3}, {62, 2}
42 * onenand_oob_32 - oob info for middle (1KB) page
44 static struct nand_ecclayout onenand_oob_32 = {
50 .oobfree = { {2, 3}, {14, 2}, {18, 3}, {30, 2} }
53 static const unsigned char ffchars[] = {
54 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
55 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 16 */
56 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
57 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 32 */
58 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
59 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 48 */
60 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
61 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 64 */
65 * onenand_readw - [OneNAND Interface] Read OneNAND register
66 * @param addr address to read
68 * Read OneNAND register
70 static unsigned short onenand_readw(void __iomem *addr)
76 * onenand_writew - [OneNAND Interface] Write OneNAND register with value
77 * @param value value to write
78 * @param addr address to write
80 * Write OneNAND register with value
82 static void onenand_writew(unsigned short value, void __iomem *addr)
88 * onenand_block_address - [DEFAULT] Get block address
89 * @param this onenand chip data structure
90 * @param block the block
91 * @return translated block address if DDP, otherwise same
93 * Setup Start Address 1 Register (F100h)
95 static int onenand_block_address(struct onenand_chip *this, int block)
97 /* Device Flash Core select, NAND Flash Block Address */
98 if (block & this->density_mask)
99 return ONENAND_DDP_CHIP1 | (block ^ this->density_mask);
105 * onenand_bufferram_address - [DEFAULT] Get bufferram address
106 * @param this onenand chip data structure
107 * @param block the block
108 * @return set DBS value if DDP, otherwise 0
110 * Setup Start Address 2 Register (F101h) for DDP
112 static int onenand_bufferram_address(struct onenand_chip *this, int block)
114 /* Device BufferRAM Select */
115 if (block & this->density_mask)
116 return ONENAND_DDP_CHIP1;
118 return ONENAND_DDP_CHIP0;
122 * onenand_page_address - [DEFAULT] Get page address
123 * @param page the page address
124 * @param sector the sector address
125 * @return combined page and sector address
127 * Setup Start Address 8 Register (F107h)
129 static int onenand_page_address(int page, int sector)
131 /* Flash Page Address, Flash Sector Address */
134 fpa = page & ONENAND_FPA_MASK;
135 fsa = sector & ONENAND_FSA_MASK;
137 return ((fpa << ONENAND_FPA_SHIFT) | fsa);
141 * onenand_buffer_address - [DEFAULT] Get buffer address
142 * @param dataram1 DataRAM index
143 * @param sectors the sector address
144 * @param count the number of sectors
145 * @return the start buffer value
147 * Setup Start Buffer Register (F200h)
149 static int onenand_buffer_address(int dataram1, int sectors, int count)
153 /* BufferRAM Sector Address */
154 bsa = sectors & ONENAND_BSA_MASK;
157 bsa |= ONENAND_BSA_DATARAM1; /* DataRAM1 */
159 bsa |= ONENAND_BSA_DATARAM0; /* DataRAM0 */
161 /* BufferRAM Sector Count */
162 bsc = count & ONENAND_BSC_MASK;
164 return ((bsa << ONENAND_BSA_SHIFT) | bsc);
168 * onenand_command - [DEFAULT] Send command to OneNAND device
169 * @param mtd MTD device structure
170 * @param cmd the command to be sent
171 * @param addr offset to read from or write to
172 * @param len number of bytes to read or write
174 * Send command to OneNAND device. This function is used for middle/large page
175 * devices (1KB/2KB Bytes per page)
177 static int onenand_command(struct mtd_info *mtd, int cmd, loff_t addr, size_t len)
179 struct onenand_chip *this = mtd->priv;
180 int value, readcmd = 0, block_cmd = 0;
183 /* Address translation */
185 case ONENAND_CMD_UNLOCK:
186 case ONENAND_CMD_LOCK:
187 case ONENAND_CMD_LOCK_TIGHT:
188 case ONENAND_CMD_UNLOCK_ALL:
193 case ONENAND_CMD_ERASE:
194 case ONENAND_CMD_BUFFERRAM:
195 case ONENAND_CMD_OTP_ACCESS:
197 block = (int) (addr >> this->erase_shift);
202 block = (int) (addr >> this->erase_shift);
203 page = (int) (addr >> this->page_shift);
204 page &= this->page_mask;
208 /* NOTE: The setting order of the registers is very important! */
209 if (cmd == ONENAND_CMD_BUFFERRAM) {
210 /* Select DataRAM for DDP */
211 value = onenand_bufferram_address(this, block);
212 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
214 /* Switch to the next data buffer */
215 ONENAND_SET_NEXT_BUFFERRAM(this);
221 /* Write 'DFS, FBA' of Flash */
222 value = onenand_block_address(this, block);
223 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS1);
226 /* Select DataRAM for DDP */
227 value = onenand_bufferram_address(this, block);
228 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
233 /* Now we use page size operation */
234 int sectors = 4, count = 4;
238 case ONENAND_CMD_READ:
239 case ONENAND_CMD_READOOB:
240 dataram = ONENAND_SET_NEXT_BUFFERRAM(this);
245 dataram = ONENAND_CURRENT_BUFFERRAM(this);
249 /* Write 'FPA, FSA' of Flash */
250 value = onenand_page_address(page, sectors);
251 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS8);
253 /* Write 'BSA, BSC' of DataRAM */
254 value = onenand_buffer_address(dataram, sectors, count);
255 this->write_word(value, this->base + ONENAND_REG_START_BUFFER);
258 /* Select DataRAM for DDP */
259 value = onenand_bufferram_address(this, block);
260 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
264 /* Interrupt clear */
265 this->write_word(ONENAND_INT_CLEAR, this->base + ONENAND_REG_INTERRUPT);
268 this->write_word(cmd, this->base + ONENAND_REG_COMMAND);
274 * onenand_wait - [DEFAULT] wait until the command is done
275 * @param mtd MTD device structure
276 * @param state state to select the max. timeout value
278 * Wait for command done. This applies to all OneNAND command
279 * Read can take up to 30us, erase up to 2ms and program up to 350us
280 * according to general OneNAND specs
282 static int onenand_wait(struct mtd_info *mtd, int state)
284 struct onenand_chip * this = mtd->priv;
285 unsigned long timeout;
286 unsigned int flags = ONENAND_INT_MASTER;
287 unsigned int interrupt = 0;
290 /* The 20 msec is enough */
291 timeout = jiffies + msecs_to_jiffies(20);
292 while (time_before(jiffies, timeout)) {
293 interrupt = this->read_word(this->base + ONENAND_REG_INTERRUPT);
295 if (interrupt & flags)
298 if (state != FL_READING)
301 /* To get correct interrupt status in timeout case */
302 interrupt = this->read_word(this->base + ONENAND_REG_INTERRUPT);
304 ctrl = this->read_word(this->base + ONENAND_REG_CTRL_STATUS);
306 if (ctrl & ONENAND_CTRL_ERROR) {
307 printk(KERN_ERR "onenand_wait: controller error = 0x%04x\n", ctrl);
308 if (ctrl & ONENAND_CTRL_LOCK)
309 printk(KERN_ERR "onenand_wait: it's locked error.\n");
313 if (interrupt & ONENAND_INT_READ) {
314 int ecc = this->read_word(this->base + ONENAND_REG_ECC_STATUS);
316 printk(KERN_ERR "onenand_wait: ECC error = 0x%04x\n", ecc);
317 if (ecc & ONENAND_ECC_2BIT_ALL) {
318 mtd->ecc_stats.failed++;
320 } else if (ecc & ONENAND_ECC_1BIT_ALL)
321 mtd->ecc_stats.corrected++;
323 } else if (state == FL_READING) {
324 printk(KERN_ERR "onenand_wait: read timeout! ctrl=0x%04x intr=0x%04x\n", ctrl, interrupt);
332 * onenand_interrupt - [DEFAULT] onenand interrupt handler
333 * @param irq onenand interrupt number
334 * @param dev_id interrupt data
338 static irqreturn_t onenand_interrupt(int irq, void *data)
340 struct onenand_chip *this = (struct onenand_chip *) data;
342 /* To handle shared interrupt */
343 if (!this->complete.done)
344 complete(&this->complete);
350 * onenand_interrupt_wait - [DEFAULT] wait until the command is done
351 * @param mtd MTD device structure
352 * @param state state to select the max. timeout value
354 * Wait for command done.
356 static int onenand_interrupt_wait(struct mtd_info *mtd, int state)
358 struct onenand_chip *this = mtd->priv;
360 wait_for_completion(&this->complete);
362 return onenand_wait(mtd, state);
366 * onenand_try_interrupt_wait - [DEFAULT] try interrupt wait
367 * @param mtd MTD device structure
368 * @param state state to select the max. timeout value
370 * Try interrupt based wait (It is used one-time)
372 static int onenand_try_interrupt_wait(struct mtd_info *mtd, int state)
374 struct onenand_chip *this = mtd->priv;
375 unsigned long remain, timeout;
377 /* We use interrupt wait first */
378 this->wait = onenand_interrupt_wait;
380 timeout = msecs_to_jiffies(100);
381 remain = wait_for_completion_timeout(&this->complete, timeout);
383 printk(KERN_INFO "OneNAND: There's no interrupt. "
384 "We use the normal wait\n");
386 /* Release the irq */
387 free_irq(this->irq, this);
389 this->wait = onenand_wait;
392 return onenand_wait(mtd, state);
396 * onenand_setup_wait - [OneNAND Interface] setup onenand wait method
397 * @param mtd MTD device structure
399 * There's two method to wait onenand work
400 * 1. polling - read interrupt status register
401 * 2. interrupt - use the kernel interrupt method
403 static void onenand_setup_wait(struct mtd_info *mtd)
405 struct onenand_chip *this = mtd->priv;
408 init_completion(&this->complete);
410 if (this->irq <= 0) {
411 this->wait = onenand_wait;
415 if (request_irq(this->irq, &onenand_interrupt,
416 IRQF_SHARED, "onenand", this)) {
417 /* If we can't get irq, use the normal wait */
418 this->wait = onenand_wait;
422 /* Enable interrupt */
423 syscfg = this->read_word(this->base + ONENAND_REG_SYS_CFG1);
424 syscfg |= ONENAND_SYS_CFG1_IOBE;
425 this->write_word(syscfg, this->base + ONENAND_REG_SYS_CFG1);
427 this->wait = onenand_try_interrupt_wait;
431 * onenand_bufferram_offset - [DEFAULT] BufferRAM offset
432 * @param mtd MTD data structure
433 * @param area BufferRAM area
434 * @return offset given area
436 * Return BufferRAM offset given area
438 static inline int onenand_bufferram_offset(struct mtd_info *mtd, int area)
440 struct onenand_chip *this = mtd->priv;
442 if (ONENAND_CURRENT_BUFFERRAM(this)) {
443 if (area == ONENAND_DATARAM)
444 return mtd->writesize;
445 if (area == ONENAND_SPARERAM)
453 * onenand_read_bufferram - [OneNAND Interface] Read the bufferram area
454 * @param mtd MTD data structure
455 * @param area BufferRAM area
456 * @param buffer the databuffer to put/get data
457 * @param offset offset to read from or write to
458 * @param count number of bytes to read/write
460 * Read the BufferRAM area
462 static int onenand_read_bufferram(struct mtd_info *mtd, int area,
463 unsigned char *buffer, int offset, size_t count)
465 struct onenand_chip *this = mtd->priv;
466 void __iomem *bufferram;
468 bufferram = this->base + area;
470 bufferram += onenand_bufferram_offset(mtd, area);
472 if (ONENAND_CHECK_BYTE_ACCESS(count)) {
475 /* Align with word(16-bit) size */
478 /* Read word and save byte */
479 word = this->read_word(bufferram + offset + count);
480 buffer[count] = (word & 0xff);
483 memcpy(buffer, bufferram + offset, count);
489 * onenand_sync_read_bufferram - [OneNAND Interface] Read the bufferram area with Sync. Burst mode
490 * @param mtd MTD data structure
491 * @param area BufferRAM area
492 * @param buffer the databuffer to put/get data
493 * @param offset offset to read from or write to
494 * @param count number of bytes to read/write
496 * Read the BufferRAM area with Sync. Burst Mode
498 static int onenand_sync_read_bufferram(struct mtd_info *mtd, int area,
499 unsigned char *buffer, int offset, size_t count)
501 struct onenand_chip *this = mtd->priv;
502 void __iomem *bufferram;
504 bufferram = this->base + area;
506 bufferram += onenand_bufferram_offset(mtd, area);
508 this->mmcontrol(mtd, ONENAND_SYS_CFG1_SYNC_READ);
510 if (ONENAND_CHECK_BYTE_ACCESS(count)) {
513 /* Align with word(16-bit) size */
516 /* Read word and save byte */
517 word = this->read_word(bufferram + offset + count);
518 buffer[count] = (word & 0xff);
521 memcpy(buffer, bufferram + offset, count);
523 this->mmcontrol(mtd, 0);
529 * onenand_write_bufferram - [OneNAND Interface] Write the bufferram area
530 * @param mtd MTD data structure
531 * @param area BufferRAM area
532 * @param buffer the databuffer to put/get data
533 * @param offset offset to read from or write to
534 * @param count number of bytes to read/write
536 * Write the BufferRAM area
538 static int onenand_write_bufferram(struct mtd_info *mtd, int area,
539 const unsigned char *buffer, int offset, size_t count)
541 struct onenand_chip *this = mtd->priv;
542 void __iomem *bufferram;
544 bufferram = this->base + area;
546 bufferram += onenand_bufferram_offset(mtd, area);
548 if (ONENAND_CHECK_BYTE_ACCESS(count)) {
552 /* Align with word(16-bit) size */
555 /* Calculate byte access offset */
556 byte_offset = offset + count;
558 /* Read word and save byte */
559 word = this->read_word(bufferram + byte_offset);
560 word = (word & ~0xff) | buffer[count];
561 this->write_word(word, bufferram + byte_offset);
564 memcpy(bufferram + offset, buffer, count);
570 * onenand_check_bufferram - [GENERIC] Check BufferRAM information
571 * @param mtd MTD data structure
572 * @param addr address to check
573 * @return 1 if there are valid data, otherwise 0
575 * Check bufferram if there is data we required
577 static int onenand_check_bufferram(struct mtd_info *mtd, loff_t addr)
579 struct onenand_chip *this = mtd->priv;
583 blockpage = (int) (addr >> this->page_shift);
585 /* Is there valid data? */
586 i = ONENAND_CURRENT_BUFFERRAM(this);
587 if (this->bufferram[i].blockpage == blockpage)
590 /* Check another BufferRAM */
591 i = ONENAND_NEXT_BUFFERRAM(this);
592 if (this->bufferram[i].blockpage == blockpage) {
593 ONENAND_SET_NEXT_BUFFERRAM(this);
601 * onenand_update_bufferram - [GENERIC] Update BufferRAM information
602 * @param mtd MTD data structure
603 * @param addr address to update
604 * @param valid valid flag
606 * Update BufferRAM information
608 static void onenand_update_bufferram(struct mtd_info *mtd, loff_t addr,
611 struct onenand_chip *this = mtd->priv;
615 blockpage = (int) (addr >> this->page_shift);
617 /* Invalidate another BufferRAM */
618 i = ONENAND_NEXT_BUFFERRAM(this);
619 if (this->bufferram[i].blockpage == blockpage)
620 this->bufferram[i].blockpage = -1;
622 /* Update BufferRAM */
623 i = ONENAND_CURRENT_BUFFERRAM(this);
625 this->bufferram[i].blockpage = blockpage;
627 this->bufferram[i].blockpage = -1;
631 * onenand_get_device - [GENERIC] Get chip for selected access
632 * @param mtd MTD device structure
633 * @param new_state the state which is requested
635 * Get the device and lock it for exclusive access
637 static int onenand_get_device(struct mtd_info *mtd, int new_state)
639 struct onenand_chip *this = mtd->priv;
640 DECLARE_WAITQUEUE(wait, current);
643 * Grab the lock and see if the device is available
646 spin_lock(&this->chip_lock);
647 if (this->state == FL_READY) {
648 this->state = new_state;
649 spin_unlock(&this->chip_lock);
652 if (new_state == FL_PM_SUSPENDED) {
653 spin_unlock(&this->chip_lock);
654 return (this->state == FL_PM_SUSPENDED) ? 0 : -EAGAIN;
656 set_current_state(TASK_UNINTERRUPTIBLE);
657 add_wait_queue(&this->wq, &wait);
658 spin_unlock(&this->chip_lock);
660 remove_wait_queue(&this->wq, &wait);
667 * onenand_release_device - [GENERIC] release chip
668 * @param mtd MTD device structure
670 * Deselect, release chip lock and wake up anyone waiting on the device
672 static void onenand_release_device(struct mtd_info *mtd)
674 struct onenand_chip *this = mtd->priv;
676 /* Release the chip */
677 spin_lock(&this->chip_lock);
678 this->state = FL_READY;
680 spin_unlock(&this->chip_lock);
684 * onenand_read - [MTD Interface] Read data from flash
685 * @param mtd MTD device structure
686 * @param from offset to read from
687 * @param len number of bytes to read
688 * @param retlen pointer to variable to store the number of read bytes
689 * @param buf the databuffer to put data
693 static int onenand_read(struct mtd_info *mtd, loff_t from, size_t len,
694 size_t *retlen, u_char *buf)
696 struct onenand_chip *this = mtd->priv;
697 struct mtd_ecc_stats stats;
698 int read = 0, column;
700 int ret = 0, boundary = 0;
702 DEBUG(MTD_DEBUG_LEVEL3, "onenand_read: from = 0x%08x, len = %i\n", (unsigned int) from, (int) len);
704 /* Do not allow reads past end of device */
705 if ((from + len) > mtd->size) {
706 printk(KERN_ERR "onenand_read: Attempt read beyond end of device\n");
711 /* Grab the lock and see if the device is available */
712 onenand_get_device(mtd, FL_READING);
714 stats = mtd->ecc_stats;
716 /* Read-while-load method */
718 /* Do first load to bufferRAM */
720 if (!onenand_check_bufferram(mtd, from)) {
721 this->command(mtd, ONENAND_CMD_READ, from, mtd->writesize);
722 ret = this->wait(mtd, FL_READING);
723 onenand_update_bufferram(mtd, from, !ret);
727 thislen = min_t(int, mtd->writesize, len - read);
728 column = from & (mtd->writesize - 1);
729 if (column + thislen > mtd->writesize)
730 thislen = mtd->writesize - column;
733 /* If there is more to load then start next load */
735 if (read + thislen < len) {
736 this->command(mtd, ONENAND_CMD_READ, from, mtd->writesize);
738 * Chip boundary handling in DDP
739 * Now we issued chip 1 read and pointed chip 1
740 * bufferam so we have to point chip 0 bufferam.
742 if (ONENAND_IS_DDP(this) &&
743 unlikely(from == (this->chipsize >> 1))) {
744 this->write_word(ONENAND_DDP_CHIP0, this->base + ONENAND_REG_START_ADDRESS2);
748 ONENAND_SET_PREV_BUFFERRAM(this);
750 /* While load is going, read from last bufferRAM */
751 this->read_bufferram(mtd, ONENAND_DATARAM, buf, column, thislen);
752 /* See if we are done */
756 /* Set up for next read from bufferRAM */
757 if (unlikely(boundary))
758 this->write_word(ONENAND_DDP_CHIP1, this->base + ONENAND_REG_START_ADDRESS2);
759 ONENAND_SET_NEXT_BUFFERRAM(this);
761 thislen = min_t(int, mtd->writesize, len - read);
764 /* Now wait for load */
765 ret = this->wait(mtd, FL_READING);
766 onenand_update_bufferram(mtd, from, !ret);
769 /* Deselect and wake up anyone waiting on the device */
770 onenand_release_device(mtd);
773 * Return success, if no ECC failures, else -EBADMSG
774 * fs driver will take care of that, because
775 * retlen == desired len and result == -EBADMSG
779 if (mtd->ecc_stats.failed - stats.failed)
785 return mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
789 * onenand_transfer_auto_oob - [Internal] oob auto-placement transfer
790 * @param mtd MTD device structure
791 * @param buf destination address
792 * @param column oob offset to read from
793 * @param thislen oob length to read
795 static int onenand_transfer_auto_oob(struct mtd_info *mtd, uint8_t *buf, int column,
798 struct onenand_chip *this = mtd->priv;
799 struct nand_oobfree *free;
800 int readcol = column;
801 int readend = column + thislen;
803 uint8_t *oob_buf = this->page_buf + mtd->writesize;
805 for (free = this->ecclayout->oobfree; free->length; ++free) {
806 if (readcol >= lastgap)
807 readcol += free->offset - lastgap;
808 if (readend >= lastgap)
809 readend += free->offset - lastgap;
810 lastgap = free->offset + free->length;
812 this->read_bufferram(mtd, ONENAND_SPARERAM, oob_buf, 0, mtd->oobsize);
813 for (free = this->ecclayout->oobfree; free->length; ++free) {
814 int free_end = free->offset + free->length;
815 if (free->offset < readend && free_end > readcol) {
816 int st = max_t(int,free->offset,readcol);
817 int ed = min_t(int,free_end,readend);
819 memcpy(buf, oob_buf + st, n);
827 * onenand_do_read_oob - [MTD Interface] OneNAND read out-of-band
828 * @param mtd MTD device structure
829 * @param from offset to read from
830 * @param len number of bytes to read
831 * @param retlen pointer to variable to store the number of read bytes
832 * @param buf the databuffer to put data
833 * @param mode operation mode
835 * OneNAND read out-of-band data from the spare area
837 static int onenand_do_read_oob(struct mtd_info *mtd, loff_t from, size_t len,
838 size_t *retlen, u_char *buf, mtd_oob_mode_t mode)
840 struct onenand_chip *this = mtd->priv;
841 int read = 0, thislen, column, oobsize;
844 DEBUG(MTD_DEBUG_LEVEL3, "onenand_read_oob: from = 0x%08x, len = %i\n", (unsigned int) from, (int) len);
846 /* Initialize return length value */
849 if (mode == MTD_OOB_AUTO)
850 oobsize = this->ecclayout->oobavail;
852 oobsize = mtd->oobsize;
854 column = from & (mtd->oobsize - 1);
856 if (unlikely(column >= oobsize)) {
857 printk(KERN_ERR "onenand_read_oob: Attempted to start read outside oob\n");
861 /* Do not allow reads past end of device */
862 if (unlikely(from >= mtd->size ||
863 column + len > ((mtd->size >> this->page_shift) -
864 (from >> this->page_shift)) * oobsize)) {
865 printk(KERN_ERR "onenand_read_oob: Attempted to read beyond end of device\n");
869 /* Grab the lock and see if the device is available */
870 onenand_get_device(mtd, FL_READING);
875 thislen = oobsize - column;
876 thislen = min_t(int, thislen, len);
878 this->command(mtd, ONENAND_CMD_READOOB, from, mtd->oobsize);
880 onenand_update_bufferram(mtd, from, 0);
882 ret = this->wait(mtd, FL_READING);
883 /* First copy data and check return value for ECC handling */
885 if (mode == MTD_OOB_AUTO)
886 onenand_transfer_auto_oob(mtd, buf, column, thislen);
888 this->read_bufferram(mtd, ONENAND_SPARERAM, buf, column, thislen);
891 printk(KERN_ERR "onenand_read_oob: read failed = 0x%x\n", ret);
905 from += mtd->writesize;
910 /* Deselect and wake up anyone waiting on the device */
911 onenand_release_device(mtd);
918 * onenand_read_oob - [MTD Interface] NAND write data and/or out-of-band
919 * @mtd: MTD device structure
920 * @from: offset to read from
921 * @ops: oob operation description structure
923 static int onenand_read_oob(struct mtd_info *mtd, loff_t from,
924 struct mtd_oob_ops *ops)
931 /* Not implemented yet */
935 return onenand_do_read_oob(mtd, from + ops->ooboffs, ops->ooblen,
936 &ops->oobretlen, ops->oobbuf, ops->mode);
940 * onenand_bbt_wait - [DEFAULT] wait until the command is done
941 * @param mtd MTD device structure
942 * @param state state to select the max. timeout value
944 * Wait for command done.
946 static int onenand_bbt_wait(struct mtd_info *mtd, int state)
948 struct onenand_chip *this = mtd->priv;
949 unsigned long timeout;
950 unsigned int interrupt;
953 /* The 20 msec is enough */
954 timeout = jiffies + msecs_to_jiffies(20);
955 while (time_before(jiffies, timeout)) {
956 interrupt = this->read_word(this->base + ONENAND_REG_INTERRUPT);
957 if (interrupt & ONENAND_INT_MASTER)
960 /* To get correct interrupt status in timeout case */
961 interrupt = this->read_word(this->base + ONENAND_REG_INTERRUPT);
962 ctrl = this->read_word(this->base + ONENAND_REG_CTRL_STATUS);
964 if (ctrl & ONENAND_CTRL_ERROR) {
965 printk(KERN_DEBUG "onenand_bbt_wait: controller error = 0x%04x\n", ctrl);
966 /* Initial bad block case */
967 if (ctrl & ONENAND_CTRL_LOAD)
968 return ONENAND_BBT_READ_ERROR;
969 return ONENAND_BBT_READ_FATAL_ERROR;
972 if (interrupt & ONENAND_INT_READ) {
973 int ecc = this->read_word(this->base + ONENAND_REG_ECC_STATUS);
974 if (ecc & ONENAND_ECC_2BIT_ALL)
975 return ONENAND_BBT_READ_ERROR;
977 printk(KERN_ERR "onenand_bbt_wait: read timeout!"
978 "ctrl=0x%04x intr=0x%04x\n", ctrl, interrupt);
979 return ONENAND_BBT_READ_FATAL_ERROR;
986 * onenand_bbt_read_oob - [MTD Interface] OneNAND read out-of-band for bbt scan
987 * @param mtd MTD device structure
988 * @param from offset to read from
989 * @param @ops oob operation description structure
991 * OneNAND read out-of-band data from the spare area for bbt scan
993 int onenand_bbt_read_oob(struct mtd_info *mtd, loff_t from,
994 struct mtd_oob_ops *ops)
996 struct onenand_chip *this = mtd->priv;
997 int read = 0, thislen, column;
999 size_t len = ops->ooblen;
1000 u_char *buf = ops->oobbuf;
1002 DEBUG(MTD_DEBUG_LEVEL3, "onenand_bbt_read_oob: from = 0x%08x, len = %i\n", (unsigned int) from, len);
1004 /* Initialize return value */
1007 /* Do not allow reads past end of device */
1008 if (unlikely((from + len) > mtd->size)) {
1009 printk(KERN_ERR "onenand_bbt_read_oob: Attempt read beyond end of device\n");
1010 return ONENAND_BBT_READ_FATAL_ERROR;
1013 /* Grab the lock and see if the device is available */
1014 onenand_get_device(mtd, FL_READING);
1016 column = from & (mtd->oobsize - 1);
1018 while (read < len) {
1021 thislen = mtd->oobsize - column;
1022 thislen = min_t(int, thislen, len);
1024 this->command(mtd, ONENAND_CMD_READOOB, from, mtd->oobsize);
1026 onenand_update_bufferram(mtd, from, 0);
1028 ret = onenand_bbt_wait(mtd, FL_READING);
1032 this->read_bufferram(mtd, ONENAND_SPARERAM, buf, column, thislen);
1041 /* Update Page size */
1042 from += mtd->writesize;
1047 /* Deselect and wake up anyone waiting on the device */
1048 onenand_release_device(mtd);
1050 ops->oobretlen = read;
1054 #ifdef CONFIG_MTD_ONENAND_VERIFY_WRITE
1056 * onenand_verify_oob - [GENERIC] verify the oob contents after a write
1057 * @param mtd MTD device structure
1058 * @param buf the databuffer to verify
1059 * @param to offset to read from
1062 static int onenand_verify_oob(struct mtd_info *mtd, const u_char *buf, loff_t to)
1064 struct onenand_chip *this = mtd->priv;
1065 char *readp = this->page_buf + mtd->writesize;
1068 this->command(mtd, ONENAND_CMD_READOOB, to, mtd->oobsize);
1069 onenand_update_bufferram(mtd, to, 0);
1070 status = this->wait(mtd, FL_READING);
1074 this->read_bufferram(mtd, ONENAND_SPARERAM, readp, 0, mtd->oobsize);
1075 for(i = 0; i < mtd->oobsize; i++)
1076 if (buf[i] != 0xFF && buf[i] != readp[i])
1083 * onenand_verify - [GENERIC] verify the chip contents after a write
1084 * @param mtd MTD device structure
1085 * @param buf the databuffer to verify
1086 * @param addr offset to read from
1087 * @param len number of bytes to read and compare
1090 static int onenand_verify(struct mtd_info *mtd, const u_char *buf, loff_t addr, size_t len)
1092 struct onenand_chip *this = mtd->priv;
1093 void __iomem *dataram;
1095 int thislen, column;
1098 thislen = min_t(int, mtd->writesize, len);
1099 column = addr & (mtd->writesize - 1);
1100 if (column + thislen > mtd->writesize)
1101 thislen = mtd->writesize - column;
1103 this->command(mtd, ONENAND_CMD_READ, addr, mtd->writesize);
1105 onenand_update_bufferram(mtd, addr, 0);
1107 ret = this->wait(mtd, FL_READING);
1111 onenand_update_bufferram(mtd, addr, 1);
1113 dataram = this->base + ONENAND_DATARAM;
1114 dataram += onenand_bufferram_offset(mtd, ONENAND_DATARAM);
1116 if (memcmp(buf, dataram + column, thislen))
1127 #define onenand_verify(...) (0)
1128 #define onenand_verify_oob(...) (0)
1131 #define NOTALIGNED(x) ((x & (this->subpagesize - 1)) != 0)
1134 * onenand_write - [MTD Interface] write buffer to FLASH
1135 * @param mtd MTD device structure
1136 * @param to offset to write to
1137 * @param len number of bytes to write
1138 * @param retlen pointer to variable to store the number of written bytes
1139 * @param buf the data to write
1143 static int onenand_write(struct mtd_info *mtd, loff_t to, size_t len,
1144 size_t *retlen, const u_char *buf)
1146 struct onenand_chip *this = mtd->priv;
1149 int column, subpage;
1151 DEBUG(MTD_DEBUG_LEVEL3, "onenand_write: to = 0x%08x, len = %i\n", (unsigned int) to, (int) len);
1153 /* Initialize retlen, in case of early exit */
1156 /* Do not allow writes past end of device */
1157 if (unlikely((to + len) > mtd->size)) {
1158 printk(KERN_ERR "onenand_write: Attempt write to past end of device\n");
1162 /* Reject writes, which are not page aligned */
1163 if (unlikely(NOTALIGNED(to)) || unlikely(NOTALIGNED(len))) {
1164 printk(KERN_ERR "onenand_write: Attempt to write not page aligned data\n");
1168 column = to & (mtd->writesize - 1);
1170 /* Grab the lock and see if the device is available */
1171 onenand_get_device(mtd, FL_WRITING);
1173 /* Loop until all data write */
1174 while (written < len) {
1175 int thislen = min_t(int, mtd->writesize - column, len - written);
1176 u_char *wbuf = (u_char *) buf;
1180 this->command(mtd, ONENAND_CMD_BUFFERRAM, to, thislen);
1182 /* Partial page write */
1183 subpage = thislen < mtd->writesize;
1185 memset(this->page_buf, 0xff, mtd->writesize);
1186 memcpy(this->page_buf + column, buf, thislen);
1187 wbuf = this->page_buf;
1190 this->write_bufferram(mtd, ONENAND_DATARAM, wbuf, 0, mtd->writesize);
1191 this->write_bufferram(mtd, ONENAND_SPARERAM, ffchars, 0, mtd->oobsize);
1193 this->command(mtd, ONENAND_CMD_PROG, to, mtd->writesize);
1195 ret = this->wait(mtd, FL_WRITING);
1197 /* In partial page write we don't update bufferram */
1198 onenand_update_bufferram(mtd, to, !ret && !subpage);
1201 printk(KERN_ERR "onenand_write: write filaed %d\n", ret);
1205 /* Only check verify write turn on */
1206 ret = onenand_verify(mtd, (u_char *) wbuf, to, thislen);
1208 printk(KERN_ERR "onenand_write: verify failed %d\n", ret);
1222 /* Deselect and wake up anyone waiting on the device */
1223 onenand_release_device(mtd);
1231 * onenand_fill_auto_oob - [Internal] oob auto-placement transfer
1232 * @param mtd MTD device structure
1233 * @param oob_buf oob buffer
1234 * @param buf source address
1235 * @param column oob offset to write to
1236 * @param thislen oob length to write
1238 static int onenand_fill_auto_oob(struct mtd_info *mtd, u_char *oob_buf,
1239 const u_char *buf, int column, int thislen)
1241 struct onenand_chip *this = mtd->priv;
1242 struct nand_oobfree *free;
1243 int writecol = column;
1244 int writeend = column + thislen;
1247 for (free = this->ecclayout->oobfree; free->length; ++free) {
1248 if (writecol >= lastgap)
1249 writecol += free->offset - lastgap;
1250 if (writeend >= lastgap)
1251 writeend += free->offset - lastgap;
1252 lastgap = free->offset + free->length;
1254 for (free = this->ecclayout->oobfree; free->length; ++free) {
1255 int free_end = free->offset + free->length;
1256 if (free->offset < writeend && free_end > writecol) {
1257 int st = max_t(int,free->offset,writecol);
1258 int ed = min_t(int,free_end,writeend);
1260 memcpy(oob_buf + st, buf, n);
1268 * onenand_do_write_oob - [Internal] OneNAND write out-of-band
1269 * @param mtd MTD device structure
1270 * @param to offset to write to
1271 * @param len number of bytes to write
1272 * @param retlen pointer to variable to store the number of written bytes
1273 * @param buf the data to write
1274 * @param mode operation mode
1276 * OneNAND write out-of-band
1278 static int onenand_do_write_oob(struct mtd_info *mtd, loff_t to, size_t len,
1279 size_t *retlen, const u_char *buf, mtd_oob_mode_t mode)
1281 struct onenand_chip *this = mtd->priv;
1282 int column, ret = 0, oobsize;
1285 DEBUG(MTD_DEBUG_LEVEL3, "onenand_write_oob: to = 0x%08x, len = %i\n", (unsigned int) to, (int) len);
1287 /* Initialize retlen, in case of early exit */
1290 if (mode == MTD_OOB_AUTO)
1291 oobsize = this->ecclayout->oobavail;
1293 oobsize = mtd->oobsize;
1295 column = to & (mtd->oobsize - 1);
1297 if (unlikely(column >= oobsize)) {
1298 printk(KERN_ERR "onenand_write_oob: Attempted to start write outside oob\n");
1302 /* For compatibility with NAND: Do not allow write past end of page */
1303 if (column + len > oobsize) {
1304 printk(KERN_ERR "onenand_write_oob: "
1305 "Attempt to write past end of page\n");
1309 /* Do not allow reads past end of device */
1310 if (unlikely(to >= mtd->size ||
1311 column + len > ((mtd->size >> this->page_shift) -
1312 (to >> this->page_shift)) * oobsize)) {
1313 printk(KERN_ERR "onenand_write_oob: Attempted to write past end of device\n");
1317 /* Grab the lock and see if the device is available */
1318 onenand_get_device(mtd, FL_WRITING);
1320 /* Loop until all data write */
1321 while (written < len) {
1322 int thislen = min_t(int, oobsize, len - written);
1326 this->command(mtd, ONENAND_CMD_BUFFERRAM, to, mtd->oobsize);
1328 /* We send data to spare ram with oobsize
1329 * to prevent byte access */
1330 memset(this->page_buf, 0xff, mtd->oobsize);
1331 if (mode == MTD_OOB_AUTO)
1332 onenand_fill_auto_oob(mtd, this->page_buf, buf, column, thislen);
1334 memcpy(this->page_buf + column, buf, thislen);
1335 this->write_bufferram(mtd, ONENAND_SPARERAM, this->page_buf, 0, mtd->oobsize);
1337 this->command(mtd, ONENAND_CMD_PROGOOB, to, mtd->oobsize);
1339 onenand_update_bufferram(mtd, to, 0);
1341 ret = this->wait(mtd, FL_WRITING);
1343 printk(KERN_ERR "onenand_write_oob: write failed %d\n", ret);
1347 ret = onenand_verify_oob(mtd, this->page_buf, to);
1349 printk(KERN_ERR "onenand_write_oob: verify failed %d\n", ret);
1357 to += mtd->writesize;
1362 /* Deselect and wake up anyone waiting on the device */
1363 onenand_release_device(mtd);
1371 * onenand_write_oob - [MTD Interface] NAND write data and/or out-of-band
1372 * @mtd: MTD device structure
1373 * @from: offset to read from
1374 * @ops: oob operation description structure
1376 static int onenand_write_oob(struct mtd_info *mtd, loff_t to,
1377 struct mtd_oob_ops *ops)
1379 switch (ops->mode) {
1384 /* Not implemented yet */
1388 return onenand_do_write_oob(mtd, to + ops->ooboffs, ops->ooblen,
1389 &ops->oobretlen, ops->oobbuf, ops->mode);
1393 * onenand_block_checkbad - [GENERIC] Check if a block is marked bad
1394 * @param mtd MTD device structure
1395 * @param ofs offset from device start
1396 * @param getchip 0, if the chip is already selected
1397 * @param allowbbt 1, if its allowed to access the bbt area
1399 * Check, if the block is bad. Either by reading the bad block table or
1400 * calling of the scan function.
1402 static int onenand_block_checkbad(struct mtd_info *mtd, loff_t ofs, int getchip, int allowbbt)
1404 struct onenand_chip *this = mtd->priv;
1405 struct bbm_info *bbm = this->bbm;
1407 /* Return info from the table */
1408 return bbm->isbad_bbt(mtd, ofs, allowbbt);
1412 * onenand_erase - [MTD Interface] erase block(s)
1413 * @param mtd MTD device structure
1414 * @param instr erase instruction
1416 * Erase one ore more blocks
1418 static int onenand_erase(struct mtd_info *mtd, struct erase_info *instr)
1420 struct onenand_chip *this = mtd->priv;
1421 unsigned int block_size;
1426 DEBUG(MTD_DEBUG_LEVEL3, "onenand_erase: start = 0x%08x, len = %i\n", (unsigned int) instr->addr, (unsigned int) instr->len);
1428 block_size = (1 << this->erase_shift);
1430 /* Start address must align on block boundary */
1431 if (unlikely(instr->addr & (block_size - 1))) {
1432 printk(KERN_ERR "onenand_erase: Unaligned address\n");
1436 /* Length must align on block boundary */
1437 if (unlikely(instr->len & (block_size - 1))) {
1438 printk(KERN_ERR "onenand_erase: Length not block aligned\n");
1442 /* Do not allow erase past end of device */
1443 if (unlikely((instr->len + instr->addr) > mtd->size)) {
1444 printk(KERN_ERR "onenand_erase: Erase past end of device\n");
1448 instr->fail_addr = 0xffffffff;
1450 /* Grab the lock and see if the device is available */
1451 onenand_get_device(mtd, FL_ERASING);
1453 /* Loop throught the pages */
1457 instr->state = MTD_ERASING;
1462 /* Check if we have a bad block, we do not erase bad blocks */
1463 if (onenand_block_checkbad(mtd, addr, 0, 0)) {
1464 printk (KERN_WARNING "onenand_erase: attempt to erase a bad block at addr 0x%08x\n", (unsigned int) addr);
1465 instr->state = MTD_ERASE_FAILED;
1469 this->command(mtd, ONENAND_CMD_ERASE, addr, block_size);
1471 ret = this->wait(mtd, FL_ERASING);
1472 /* Check, if it is write protected */
1474 printk(KERN_ERR "onenand_erase: Failed erase, block %d\n", (unsigned) (addr >> this->erase_shift));
1475 instr->state = MTD_ERASE_FAILED;
1476 instr->fail_addr = addr;
1484 instr->state = MTD_ERASE_DONE;
1488 ret = instr->state == MTD_ERASE_DONE ? 0 : -EIO;
1489 /* Do call back function */
1491 mtd_erase_callback(instr);
1493 /* Deselect and wake up anyone waiting on the device */
1494 onenand_release_device(mtd);
1500 * onenand_sync - [MTD Interface] sync
1501 * @param mtd MTD device structure
1503 * Sync is actually a wait for chip ready function
1505 static void onenand_sync(struct mtd_info *mtd)
1507 DEBUG(MTD_DEBUG_LEVEL3, "onenand_sync: called\n");
1509 /* Grab the lock and see if the device is available */
1510 onenand_get_device(mtd, FL_SYNCING);
1512 /* Release it and go back */
1513 onenand_release_device(mtd);
1517 * onenand_block_isbad - [MTD Interface] Check whether the block at the given offset is bad
1518 * @param mtd MTD device structure
1519 * @param ofs offset relative to mtd start
1521 * Check whether the block is bad
1523 static int onenand_block_isbad(struct mtd_info *mtd, loff_t ofs)
1525 /* Check for invalid offset */
1526 if (ofs > mtd->size)
1529 return onenand_block_checkbad(mtd, ofs, 1, 0);
1533 * onenand_default_block_markbad - [DEFAULT] mark a block bad
1534 * @param mtd MTD device structure
1535 * @param ofs offset from device start
1537 * This is the default implementation, which can be overridden by
1538 * a hardware specific driver.
1540 static int onenand_default_block_markbad(struct mtd_info *mtd, loff_t ofs)
1542 struct onenand_chip *this = mtd->priv;
1543 struct bbm_info *bbm = this->bbm;
1544 u_char buf[2] = {0, 0};
1548 /* Get block number */
1549 block = ((int) ofs) >> bbm->bbt_erase_shift;
1551 bbm->bbt[block >> 2] |= 0x01 << ((block & 0x03) << 1);
1553 /* We write two bytes, so we dont have to mess with 16 bit access */
1554 ofs += mtd->oobsize + (bbm->badblockpos & ~0x01);
1555 return onenand_do_write_oob(mtd, ofs , 2, &retlen, buf, MTD_OOB_PLACE);
1559 * onenand_block_markbad - [MTD Interface] Mark the block at the given offset as bad
1560 * @param mtd MTD device structure
1561 * @param ofs offset relative to mtd start
1563 * Mark the block as bad
1565 static int onenand_block_markbad(struct mtd_info *mtd, loff_t ofs)
1567 struct onenand_chip *this = mtd->priv;
1570 ret = onenand_block_isbad(mtd, ofs);
1572 /* If it was bad already, return success and do nothing */
1578 return this->block_markbad(mtd, ofs);
1582 * onenand_do_lock_cmd - [OneNAND Interface] Lock or unlock block(s)
1583 * @param mtd MTD device structure
1584 * @param ofs offset relative to mtd start
1585 * @param len number of bytes to lock or unlock
1587 * Lock or unlock one or more blocks
1589 static int onenand_do_lock_cmd(struct mtd_info *mtd, loff_t ofs, size_t len, int cmd)
1591 struct onenand_chip *this = mtd->priv;
1592 int start, end, block, value, status;
1595 start = ofs >> this->erase_shift;
1596 end = len >> this->erase_shift;
1598 if (cmd == ONENAND_CMD_LOCK)
1599 wp_status_mask = ONENAND_WP_LS;
1601 wp_status_mask = ONENAND_WP_US;
1603 /* Continuous lock scheme */
1604 if (this->options & ONENAND_HAS_CONT_LOCK) {
1605 /* Set start block address */
1606 this->write_word(start, this->base + ONENAND_REG_START_BLOCK_ADDRESS);
1607 /* Set end block address */
1608 this->write_word(start + end - 1, this->base + ONENAND_REG_END_BLOCK_ADDRESS);
1609 /* Write lock command */
1610 this->command(mtd, cmd, 0, 0);
1612 /* There's no return value */
1613 this->wait(mtd, FL_LOCKING);
1616 while (this->read_word(this->base + ONENAND_REG_CTRL_STATUS)
1617 & ONENAND_CTRL_ONGO)
1620 /* Check lock status */
1621 status = this->read_word(this->base + ONENAND_REG_WP_STATUS);
1622 if (!(status & wp_status_mask))
1623 printk(KERN_ERR "wp status = 0x%x\n", status);
1628 /* Block lock scheme */
1629 for (block = start; block < start + end; block++) {
1630 /* Set block address */
1631 value = onenand_block_address(this, block);
1632 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS1);
1633 /* Select DataRAM for DDP */
1634 value = onenand_bufferram_address(this, block);
1635 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
1636 /* Set start block address */
1637 this->write_word(block, this->base + ONENAND_REG_START_BLOCK_ADDRESS);
1638 /* Write lock command */
1639 this->command(mtd, cmd, 0, 0);
1641 /* There's no return value */
1642 this->wait(mtd, FL_LOCKING);
1645 while (this->read_word(this->base + ONENAND_REG_CTRL_STATUS)
1646 & ONENAND_CTRL_ONGO)
1649 /* Check lock status */
1650 status = this->read_word(this->base + ONENAND_REG_WP_STATUS);
1651 if (!(status & wp_status_mask))
1652 printk(KERN_ERR "block = %d, wp status = 0x%x\n", block, status);
1659 * onenand_lock - [MTD Interface] Lock block(s)
1660 * @param mtd MTD device structure
1661 * @param ofs offset relative to mtd start
1662 * @param len number of bytes to unlock
1664 * Lock one or more blocks
1666 static int onenand_lock(struct mtd_info *mtd, loff_t ofs, size_t len)
1668 return onenand_do_lock_cmd(mtd, ofs, len, ONENAND_CMD_LOCK);
1672 * onenand_unlock - [MTD Interface] Unlock block(s)
1673 * @param mtd MTD device structure
1674 * @param ofs offset relative to mtd start
1675 * @param len number of bytes to unlock
1677 * Unlock one or more blocks
1679 static int onenand_unlock(struct mtd_info *mtd, loff_t ofs, size_t len)
1681 return onenand_do_lock_cmd(mtd, ofs, len, ONENAND_CMD_UNLOCK);
1685 * onenand_check_lock_status - [OneNAND Interface] Check lock status
1686 * @param this onenand chip data structure
1690 static void onenand_check_lock_status(struct onenand_chip *this)
1692 unsigned int value, block, status;
1695 end = this->chipsize >> this->erase_shift;
1696 for (block = 0; block < end; block++) {
1697 /* Set block address */
1698 value = onenand_block_address(this, block);
1699 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS1);
1700 /* Select DataRAM for DDP */
1701 value = onenand_bufferram_address(this, block);
1702 this->write_word(value, this->base + ONENAND_REG_START_ADDRESS2);
1703 /* Set start block address */
1704 this->write_word(block, this->base + ONENAND_REG_START_BLOCK_ADDRESS);
1706 /* Check lock status */
1707 status = this->read_word(this->base + ONENAND_REG_WP_STATUS);
1708 if (!(status & ONENAND_WP_US))
1709 printk(KERN_ERR "block = %d, wp status = 0x%x\n", block, status);
1714 * onenand_unlock_all - [OneNAND Interface] unlock all blocks
1715 * @param mtd MTD device structure
1719 static int onenand_unlock_all(struct mtd_info *mtd)
1721 struct onenand_chip *this = mtd->priv;
1723 if (this->options & ONENAND_HAS_UNLOCK_ALL) {
1724 /* Set start block address */
1725 this->write_word(0, this->base + ONENAND_REG_START_BLOCK_ADDRESS);
1726 /* Write unlock command */
1727 this->command(mtd, ONENAND_CMD_UNLOCK_ALL, 0, 0);
1729 /* There's no return value */
1730 this->wait(mtd, FL_LOCKING);
1733 while (this->read_word(this->base + ONENAND_REG_CTRL_STATUS)
1734 & ONENAND_CTRL_ONGO)
1737 /* Workaround for all block unlock in DDP */
1738 if (ONENAND_IS_DDP(this)) {
1739 /* 1st block on another chip */
1740 loff_t ofs = this->chipsize >> 1;
1741 size_t len = mtd->erasesize;
1743 onenand_unlock(mtd, ofs, len);
1746 onenand_check_lock_status(this);
1751 onenand_unlock(mtd, 0x0, this->chipsize);
1756 #ifdef CONFIG_MTD_ONENAND_OTP
1758 /* Interal OTP operation */
1759 typedef int (*otp_op_t)(struct mtd_info *mtd, loff_t form, size_t len,
1760 size_t *retlen, u_char *buf);
1763 * do_otp_read - [DEFAULT] Read OTP block area
1764 * @param mtd MTD device structure
1765 * @param from The offset to read
1766 * @param len number of bytes to read
1767 * @param retlen pointer to variable to store the number of readbytes
1768 * @param buf the databuffer to put/get data
1770 * Read OTP block area.
1772 static int do_otp_read(struct mtd_info *mtd, loff_t from, size_t len,
1773 size_t *retlen, u_char *buf)
1775 struct onenand_chip *this = mtd->priv;
1778 /* Enter OTP access mode */
1779 this->command(mtd, ONENAND_CMD_OTP_ACCESS, 0, 0);
1780 this->wait(mtd, FL_OTPING);
1782 ret = mtd->read(mtd, from, len, retlen, buf);
1784 /* Exit OTP access mode */
1785 this->command(mtd, ONENAND_CMD_RESET, 0, 0);
1786 this->wait(mtd, FL_RESETING);
1792 * do_otp_write - [DEFAULT] Write OTP block area
1793 * @param mtd MTD device structure
1794 * @param from The offset to write
1795 * @param len number of bytes to write
1796 * @param retlen pointer to variable to store the number of write bytes
1797 * @param buf the databuffer to put/get data
1799 * Write OTP block area.
1801 static int do_otp_write(struct mtd_info *mtd, loff_t from, size_t len,
1802 size_t *retlen, u_char *buf)
1804 struct onenand_chip *this = mtd->priv;
1805 unsigned char *pbuf = buf;
1808 /* Force buffer page aligned */
1809 if (len < mtd->writesize) {
1810 memcpy(this->page_buf, buf, len);
1811 memset(this->page_buf + len, 0xff, mtd->writesize - len);
1812 pbuf = this->page_buf;
1813 len = mtd->writesize;
1816 /* Enter OTP access mode */
1817 this->command(mtd, ONENAND_CMD_OTP_ACCESS, 0, 0);
1818 this->wait(mtd, FL_OTPING);
1820 ret = mtd->write(mtd, from, len, retlen, pbuf);
1822 /* Exit OTP access mode */
1823 this->command(mtd, ONENAND_CMD_RESET, 0, 0);
1824 this->wait(mtd, FL_RESETING);
1830 * do_otp_lock - [DEFAULT] Lock OTP block area
1831 * @param mtd MTD device structure
1832 * @param from The offset to lock
1833 * @param len number of bytes to lock
1834 * @param retlen pointer to variable to store the number of lock bytes
1835 * @param buf the databuffer to put/get data
1837 * Lock OTP block area.
1839 static int do_otp_lock(struct mtd_info *mtd, loff_t from, size_t len,
1840 size_t *retlen, u_char *buf)
1842 struct onenand_chip *this = mtd->priv;
1845 /* Enter OTP access mode */
1846 this->command(mtd, ONENAND_CMD_OTP_ACCESS, 0, 0);
1847 this->wait(mtd, FL_OTPING);
1849 ret = onenand_do_write_oob(mtd, from, len, retlen, buf, MTD_OOB_PLACE);
1851 /* Exit OTP access mode */
1852 this->command(mtd, ONENAND_CMD_RESET, 0, 0);
1853 this->wait(mtd, FL_RESETING);
1859 * onenand_otp_walk - [DEFAULT] Handle OTP operation
1860 * @param mtd MTD device structure
1861 * @param from The offset to read/write
1862 * @param len number of bytes to read/write
1863 * @param retlen pointer to variable to store the number of read bytes
1864 * @param buf the databuffer to put/get data
1865 * @param action do given action
1866 * @param mode specify user and factory
1868 * Handle OTP operation.
1870 static int onenand_otp_walk(struct mtd_info *mtd, loff_t from, size_t len,
1871 size_t *retlen, u_char *buf,
1872 otp_op_t action, int mode)
1874 struct onenand_chip *this = mtd->priv;
1881 density = this->device_id >> ONENAND_DEVICE_DENSITY_SHIFT;
1882 if (density < ONENAND_DEVICE_DENSITY_512Mb)
1887 if (mode == MTD_OTP_FACTORY) {
1888 from += mtd->writesize * otp_pages;
1889 otp_pages = 64 - otp_pages;
1892 /* Check User/Factory boundary */
1893 if (((mtd->writesize * otp_pages) - (from + len)) < 0)
1896 while (len > 0 && otp_pages > 0) {
1897 if (!action) { /* OTP Info functions */
1898 struct otp_info *otpinfo;
1900 len -= sizeof(struct otp_info);
1904 otpinfo = (struct otp_info *) buf;
1905 otpinfo->start = from;
1906 otpinfo->length = mtd->writesize;
1907 otpinfo->locked = 0;
1909 from += mtd->writesize;
1910 buf += sizeof(struct otp_info);
1911 *retlen += sizeof(struct otp_info);
1916 ret = action(mtd, from, len, &tmp_retlen, buf);
1932 * onenand_get_fact_prot_info - [MTD Interface] Read factory OTP info
1933 * @param mtd MTD device structure
1934 * @param buf the databuffer to put/get data
1935 * @param len number of bytes to read
1937 * Read factory OTP info.
1939 static int onenand_get_fact_prot_info(struct mtd_info *mtd,
1940 struct otp_info *buf, size_t len)
1945 ret = onenand_otp_walk(mtd, 0, len, &retlen, (u_char *) buf, NULL, MTD_OTP_FACTORY);
1947 return ret ? : retlen;
1951 * onenand_read_fact_prot_reg - [MTD Interface] Read factory OTP area
1952 * @param mtd MTD device structure
1953 * @param from The offset to read
1954 * @param len number of bytes to read
1955 * @param retlen pointer to variable to store the number of read bytes
1956 * @param buf the databuffer to put/get data
1958 * Read factory OTP area.
1960 static int onenand_read_fact_prot_reg(struct mtd_info *mtd, loff_t from,
1961 size_t len, size_t *retlen, u_char *buf)
1963 return onenand_otp_walk(mtd, from, len, retlen, buf, do_otp_read, MTD_OTP_FACTORY);
1967 * onenand_get_user_prot_info - [MTD Interface] Read user OTP info
1968 * @param mtd MTD device structure
1969 * @param buf the databuffer to put/get data
1970 * @param len number of bytes to read
1972 * Read user OTP info.
1974 static int onenand_get_user_prot_info(struct mtd_info *mtd,
1975 struct otp_info *buf, size_t len)
1980 ret = onenand_otp_walk(mtd, 0, len, &retlen, (u_char *) buf, NULL, MTD_OTP_USER);
1982 return ret ? : retlen;
1986 * onenand_read_user_prot_reg - [MTD Interface] Read user OTP area
1987 * @param mtd MTD device structure
1988 * @param from The offset to read
1989 * @param len number of bytes to read
1990 * @param retlen pointer to variable to store the number of read bytes
1991 * @param buf the databuffer to put/get data
1993 * Read user OTP area.
1995 static int onenand_read_user_prot_reg(struct mtd_info *mtd, loff_t from,
1996 size_t len, size_t *retlen, u_char *buf)
1998 return onenand_otp_walk(mtd, from, len, retlen, buf, do_otp_read, MTD_OTP_USER);
2002 * onenand_write_user_prot_reg - [MTD Interface] Write user OTP area
2003 * @param mtd MTD device structure
2004 * @param from The offset to write
2005 * @param len number of bytes to write
2006 * @param retlen pointer to variable to store the number of write bytes
2007 * @param buf the databuffer to put/get data
2009 * Write user OTP area.
2011 static int onenand_write_user_prot_reg(struct mtd_info *mtd, loff_t from,
2012 size_t len, size_t *retlen, u_char *buf)
2014 return onenand_otp_walk(mtd, from, len, retlen, buf, do_otp_write, MTD_OTP_USER);
2018 * onenand_lock_user_prot_reg - [MTD Interface] Lock user OTP area
2019 * @param mtd MTD device structure
2020 * @param from The offset to lock
2021 * @param len number of bytes to unlock
2023 * Write lock mark on spare area in page 0 in OTP block
2025 static int onenand_lock_user_prot_reg(struct mtd_info *mtd, loff_t from,
2028 unsigned char oob_buf[64];
2032 memset(oob_buf, 0xff, mtd->oobsize);
2034 * Note: OTP lock operation
2035 * OTP block : 0xXXFC
2036 * 1st block : 0xXXF3 (If chip support)
2037 * Both : 0xXXF0 (If chip support)
2039 oob_buf[ONENAND_OTP_LOCK_OFFSET] = 0xFC;
2042 * Write lock mark to 8th word of sector0 of page0 of the spare0.
2043 * We write 16 bytes spare area instead of 2 bytes.
2048 ret = onenand_otp_walk(mtd, from, len, &retlen, oob_buf, do_otp_lock, MTD_OTP_USER);
2050 return ret ? : retlen;
2052 #endif /* CONFIG_MTD_ONENAND_OTP */
2055 * onenand_check_features - Check and set OneNAND features
2056 * @param mtd MTD data structure
2058 * Check and set OneNAND features
2061 static void onenand_check_features(struct mtd_info *mtd)
2063 struct onenand_chip *this = mtd->priv;
2064 unsigned int density, process;
2066 /* Lock scheme depends on density and process */
2067 density = this->device_id >> ONENAND_DEVICE_DENSITY_SHIFT;
2068 process = this->version_id >> ONENAND_VERSION_PROCESS_SHIFT;
2071 if (density >= ONENAND_DEVICE_DENSITY_1Gb) {
2072 /* A-Die has all block unlock */
2074 printk(KERN_DEBUG "Chip support all block unlock\n");
2075 this->options |= ONENAND_HAS_UNLOCK_ALL;
2078 /* Some OneNAND has continues lock scheme */
2080 printk(KERN_DEBUG "Lock scheme is Continues Lock\n");
2081 this->options |= ONENAND_HAS_CONT_LOCK;
2087 * onenand_print_device_info - Print device ID
2088 * @param device device ID
2092 static void onenand_print_device_info(int device, int version)
2094 int vcc, demuxed, ddp, density;
2096 vcc = device & ONENAND_DEVICE_VCC_MASK;
2097 demuxed = device & ONENAND_DEVICE_IS_DEMUX;
2098 ddp = device & ONENAND_DEVICE_IS_DDP;
2099 density = device >> ONENAND_DEVICE_DENSITY_SHIFT;
2100 printk(KERN_INFO "%sOneNAND%s %dMB %sV 16-bit (0x%02x)\n",
2101 demuxed ? "" : "Muxed ",
2104 vcc ? "2.65/3.3" : "1.8",
2106 printk(KERN_DEBUG "OneNAND version = 0x%04x\n", version);
2109 static const struct onenand_manufacturers onenand_manuf_ids[] = {
2110 {ONENAND_MFR_SAMSUNG, "Samsung"},
2114 * onenand_check_maf - Check manufacturer ID
2115 * @param manuf manufacturer ID
2117 * Check manufacturer ID
2119 static int onenand_check_maf(int manuf)
2121 int size = ARRAY_SIZE(onenand_manuf_ids);
2125 for (i = 0; i < size; i++)
2126 if (manuf == onenand_manuf_ids[i].id)
2130 name = onenand_manuf_ids[i].name;
2134 printk(KERN_DEBUG "OneNAND Manufacturer: %s (0x%0x)\n", name, manuf);
2140 * onenand_probe - [OneNAND Interface] Probe the OneNAND device
2141 * @param mtd MTD device structure
2143 * OneNAND detection method:
2144 * Compare the the values from command with ones from register
2146 static int onenand_probe(struct mtd_info *mtd)
2148 struct onenand_chip *this = mtd->priv;
2149 int bram_maf_id, bram_dev_id, maf_id, dev_id, ver_id;
2153 /* Save system configuration 1 */
2154 syscfg = this->read_word(this->base + ONENAND_REG_SYS_CFG1);
2155 /* Clear Sync. Burst Read mode to read BootRAM */
2156 this->write_word((syscfg & ~ONENAND_SYS_CFG1_SYNC_READ), this->base + ONENAND_REG_SYS_CFG1);
2158 /* Send the command for reading device ID from BootRAM */
2159 this->write_word(ONENAND_CMD_READID, this->base + ONENAND_BOOTRAM);
2161 /* Read manufacturer and device IDs from BootRAM */
2162 bram_maf_id = this->read_word(this->base + ONENAND_BOOTRAM + 0x0);
2163 bram_dev_id = this->read_word(this->base + ONENAND_BOOTRAM + 0x2);
2165 /* Reset OneNAND to read default register values */
2166 this->write_word(ONENAND_CMD_RESET, this->base + ONENAND_BOOTRAM);
2168 this->wait(mtd, FL_RESETING);
2170 /* Restore system configuration 1 */
2171 this->write_word(syscfg, this->base + ONENAND_REG_SYS_CFG1);
2173 /* Check manufacturer ID */
2174 if (onenand_check_maf(bram_maf_id))
2177 /* Read manufacturer and device IDs from Register */
2178 maf_id = this->read_word(this->base + ONENAND_REG_MANUFACTURER_ID);
2179 dev_id = this->read_word(this->base + ONENAND_REG_DEVICE_ID);
2180 ver_id = this->read_word(this->base + ONENAND_REG_VERSION_ID);
2182 /* Check OneNAND device */
2183 if (maf_id != bram_maf_id || dev_id != bram_dev_id)
2186 /* Flash device information */
2187 onenand_print_device_info(dev_id, ver_id);
2188 this->device_id = dev_id;
2189 this->version_id = ver_id;
2191 density = dev_id >> ONENAND_DEVICE_DENSITY_SHIFT;
2192 this->chipsize = (16 << density) << 20;
2193 /* Set density mask. it is used for DDP */
2194 if (ONENAND_IS_DDP(this))
2195 this->density_mask = (1 << (density + 6));
2197 this->density_mask = 0;
2199 /* OneNAND page size & block size */
2200 /* The data buffer size is equal to page size */
2201 mtd->writesize = this->read_word(this->base + ONENAND_REG_DATA_BUFFER_SIZE);
2202 mtd->oobsize = mtd->writesize >> 5;
2203 /* Pages per a block are always 64 in OneNAND */
2204 mtd->erasesize = mtd->writesize << 6;
2206 this->erase_shift = ffs(mtd->erasesize) - 1;
2207 this->page_shift = ffs(mtd->writesize) - 1;
2208 this->page_mask = (1 << (this->erase_shift - this->page_shift)) - 1;
2210 /* REVIST: Multichip handling */
2212 mtd->size = this->chipsize;
2214 /* Check OneNAND features */
2215 onenand_check_features(mtd);
2221 * onenand_suspend - [MTD Interface] Suspend the OneNAND flash
2222 * @param mtd MTD device structure
2224 static int onenand_suspend(struct mtd_info *mtd)
2226 return onenand_get_device(mtd, FL_PM_SUSPENDED);
2230 * onenand_resume - [MTD Interface] Resume the OneNAND flash
2231 * @param mtd MTD device structure
2233 static void onenand_resume(struct mtd_info *mtd)
2235 struct onenand_chip *this = mtd->priv;
2237 if (this->state == FL_PM_SUSPENDED)
2238 onenand_release_device(mtd);
2240 printk(KERN_ERR "resume() called for the chip which is not"
2241 "in suspended state\n");
2245 * onenand_scan - [OneNAND Interface] Scan for the OneNAND device
2246 * @param mtd MTD device structure
2247 * @param maxchips Number of chips to scan for
2249 * This fills out all the not initialized function pointers
2250 * with the defaults.
2251 * The flash ID is read and the mtd/chip structures are
2252 * filled with the appropriate values.
2254 int onenand_scan(struct mtd_info *mtd, int maxchips)
2257 struct onenand_chip *this = mtd->priv;
2259 if (!this->read_word)
2260 this->read_word = onenand_readw;
2261 if (!this->write_word)
2262 this->write_word = onenand_writew;
2265 this->command = onenand_command;
2267 onenand_setup_wait(mtd);
2269 if (!this->read_bufferram)
2270 this->read_bufferram = onenand_read_bufferram;
2271 if (!this->write_bufferram)
2272 this->write_bufferram = onenand_write_bufferram;
2274 if (!this->block_markbad)
2275 this->block_markbad = onenand_default_block_markbad;
2276 if (!this->scan_bbt)
2277 this->scan_bbt = onenand_default_bbt;
2279 if (onenand_probe(mtd))
2282 /* Set Sync. Burst Read after probing */
2283 if (this->mmcontrol) {
2284 printk(KERN_INFO "OneNAND Sync. Burst Read support\n");
2285 this->read_bufferram = onenand_sync_read_bufferram;
2288 /* Allocate buffers, if necessary */
2289 if (!this->page_buf) {
2291 len = mtd->writesize + mtd->oobsize;
2292 this->page_buf = kmalloc(len, GFP_KERNEL);
2293 if (!this->page_buf) {
2294 printk(KERN_ERR "onenand_scan(): Can't allocate page_buf\n");
2297 this->options |= ONENAND_PAGEBUF_ALLOC;
2300 this->state = FL_READY;
2301 init_waitqueue_head(&this->wq);
2302 spin_lock_init(&this->chip_lock);
2305 * Allow subpage writes up to oobsize.
2307 switch (mtd->oobsize) {
2309 this->ecclayout = &onenand_oob_64;
2310 mtd->subpage_sft = 2;
2314 this->ecclayout = &onenand_oob_32;
2315 mtd->subpage_sft = 1;
2319 printk(KERN_WARNING "No OOB scheme defined for oobsize %d\n",
2321 mtd->subpage_sft = 0;
2322 /* To prevent kernel oops */
2323 this->ecclayout = &onenand_oob_32;
2327 this->subpagesize = mtd->writesize >> mtd->subpage_sft;
2330 * The number of bytes available for a client to place data into
2331 * the out of band area
2333 this->ecclayout->oobavail = 0;
2334 for (i = 0; this->ecclayout->oobfree[i].length; i++)
2335 this->ecclayout->oobavail +=
2336 this->ecclayout->oobfree[i].length;
2338 mtd->ecclayout = this->ecclayout;
2340 /* Fill in remaining MTD driver data */
2341 mtd->type = MTD_NANDFLASH;
2342 mtd->flags = MTD_CAP_NANDFLASH;
2343 mtd->ecctype = MTD_ECC_SW;
2344 mtd->erase = onenand_erase;
2346 mtd->unpoint = NULL;
2347 mtd->read = onenand_read;
2348 mtd->write = onenand_write;
2349 mtd->read_oob = onenand_read_oob;
2350 mtd->write_oob = onenand_write_oob;
2351 #ifdef CONFIG_MTD_ONENAND_OTP
2352 mtd->get_fact_prot_info = onenand_get_fact_prot_info;
2353 mtd->read_fact_prot_reg = onenand_read_fact_prot_reg;
2354 mtd->get_user_prot_info = onenand_get_user_prot_info;
2355 mtd->read_user_prot_reg = onenand_read_user_prot_reg;
2356 mtd->write_user_prot_reg = onenand_write_user_prot_reg;
2357 mtd->lock_user_prot_reg = onenand_lock_user_prot_reg;
2359 mtd->sync = onenand_sync;
2360 mtd->lock = onenand_lock;
2361 mtd->unlock = onenand_unlock;
2362 mtd->suspend = onenand_suspend;
2363 mtd->resume = onenand_resume;
2364 mtd->block_isbad = onenand_block_isbad;
2365 mtd->block_markbad = onenand_block_markbad;
2366 mtd->owner = THIS_MODULE;
2368 /* Unlock whole block */
2369 onenand_unlock_all(mtd);
2371 return this->scan_bbt(mtd);
2375 * onenand_release - [OneNAND Interface] Free resources held by the OneNAND device
2376 * @param mtd MTD device structure
2378 void onenand_release(struct mtd_info *mtd)
2380 struct onenand_chip *this = mtd->priv;
2382 #ifdef CONFIG_MTD_PARTITIONS
2383 /* Deregister partitions */
2384 del_mtd_partitions (mtd);
2386 /* Deregister the device */
2387 del_mtd_device (mtd);
2389 /* Free bad block table memory, if allocated */
2391 struct bbm_info *bbm = this->bbm;
2395 /* Buffer allocated by onenand_scan */
2396 if (this->options & ONENAND_PAGEBUF_ALLOC)
2397 kfree(this->page_buf);
2400 EXPORT_SYMBOL_GPL(onenand_scan);
2401 EXPORT_SYMBOL_GPL(onenand_release);
2403 MODULE_LICENSE("GPL");
2404 MODULE_AUTHOR("Kyungmin Park <kyungmin.park@samsung.com>");
2405 MODULE_DESCRIPTION("Generic OneNAND flash driver code");