2 * linux/drivers/mtd/onenand/onenand_base.c
4 * Copyright (C) 2005 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/mtd/mtd.h>
16 #include <linux/mtd/onenand.h>
17 #include <linux/mtd/partitions.h>
22 * onenand_oob_64 - oob info for large (2KB) page
24 static struct nand_oobinfo onenand_oob_64
= {
25 .useecc
= MTD_NANDECC_AUTOPLACE
,
34 {2, 3}, {14, 2}, {18, 3}, {30, 2},
35 {24, 3}, {46, 2}, {40, 3}, {62, 2} }
39 * onenand_oob_32 - oob info for middle (1KB) page
41 static struct nand_oobinfo onenand_oob_32
= {
42 .useecc
= MTD_NANDECC_AUTOPLACE
,
48 .oobfree
= { {2, 3}, {14, 2}, {18, 3}, {30, 2} }
51 static const unsigned char ffchars
[] = {
52 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
53 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 16 */
54 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
55 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 32 */
56 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
57 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 48 */
58 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
59 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 64 */
63 * onenand_readw - [OneNAND Interface] Read OneNAND register
64 * @param addr address to read
66 * Read OneNAND register
68 static unsigned short onenand_readw(void __iomem
*addr
)
74 * onenand_writew - [OneNAND Interface] Write OneNAND register with value
75 * @param value value to write
76 * @param addr address to write
78 * Write OneNAND register with value
80 static void onenand_writew(unsigned short value
, void __iomem
*addr
)
86 * onenand_block_address - [DEFAULT] Get block address
87 * @param device the device id
88 * @param block the block
89 * @return translated block address if DDP, otherwise same
91 * Setup Start Address 1 Register (F100h)
93 static int onenand_block_address(int device
, int block
)
95 if (device
& ONENAND_DEVICE_IS_DDP
) {
96 /* Device Flash Core select, NAND Flash Block Address */
97 int dfs
= 0, density
, mask
;
99 density
= device
>> ONENAND_DEVICE_DENSITY_SHIFT
;
100 mask
= (1 << (density
+ 6));
105 return (dfs
<< ONENAND_DDP_SHIFT
) | (block
& (mask
- 1));
112 * onenand_bufferram_address - [DEFAULT] Get bufferram address
113 * @param device the device id
114 * @param block the block
115 * @return set DBS value if DDP, otherwise 0
117 * Setup Start Address 2 Register (F101h) for DDP
119 static int onenand_bufferram_address(int device
, int block
)
121 if (device
& ONENAND_DEVICE_IS_DDP
) {
122 /* Device BufferRAM Select */
123 int dbs
= 0, density
, mask
;
125 density
= device
>> ONENAND_DEVICE_DENSITY_SHIFT
;
126 mask
= (1 << (density
+ 6));
131 return (dbs
<< ONENAND_DDP_SHIFT
);
138 * onenand_page_address - [DEFAULT] Get page address
139 * @param page the page address
140 * @param sector the sector address
141 * @return combined page and sector address
143 * Setup Start Address 8 Register (F107h)
145 static int onenand_page_address(int page
, int sector
)
147 /* Flash Page Address, Flash Sector Address */
150 fpa
= page
& ONENAND_FPA_MASK
;
151 fsa
= sector
& ONENAND_FSA_MASK
;
153 return ((fpa
<< ONENAND_FPA_SHIFT
) | fsa
);
157 * onenand_buffer_address - [DEFAULT] Get buffer address
158 * @param dataram1 DataRAM index
159 * @param sectors the sector address
160 * @param count the number of sectors
161 * @return the start buffer value
163 * Setup Start Buffer Register (F200h)
165 static int onenand_buffer_address(int dataram1
, int sectors
, int count
)
169 /* BufferRAM Sector Address */
170 bsa
= sectors
& ONENAND_BSA_MASK
;
173 bsa
|= ONENAND_BSA_DATARAM1
; /* DataRAM1 */
175 bsa
|= ONENAND_BSA_DATARAM0
; /* DataRAM0 */
177 /* BufferRAM Sector Count */
178 bsc
= count
& ONENAND_BSC_MASK
;
180 return ((bsa
<< ONENAND_BSA_SHIFT
) | bsc
);
184 * onenand_command - [DEFAULT] Send command to OneNAND device
185 * @param mtd MTD device structure
186 * @param cmd the command to be sent
187 * @param addr offset to read from or write to
188 * @param len number of bytes to read or write
190 * Send command to OneNAND device. This function is used for middle/large page
191 * devices (1KB/2KB Bytes per page)
193 static int onenand_command(struct mtd_info
*mtd
, int cmd
, loff_t addr
, size_t len
)
195 struct onenand_chip
*this = mtd
->priv
;
196 int value
, readcmd
= 0;
198 /* Now we use page size operation */
199 int sectors
= 4, count
= 4;
201 /* Address translation */
203 case ONENAND_CMD_UNLOCK
:
204 case ONENAND_CMD_LOCK
:
205 case ONENAND_CMD_LOCK_TIGHT
:
210 case ONENAND_CMD_ERASE
:
211 case ONENAND_CMD_BUFFERRAM
:
212 block
= (int) (addr
>> this->erase_shift
);
217 block
= (int) (addr
>> this->erase_shift
);
218 page
= (int) (addr
>> this->page_shift
);
219 page
&= this->page_mask
;
223 /* NOTE: The setting order of the registers is very important! */
224 if (cmd
== ONENAND_CMD_BUFFERRAM
) {
225 /* Select DataRAM for DDP */
226 value
= onenand_bufferram_address(this->device_id
, block
);
227 this->write_word(value
, this->base
+ ONENAND_REG_START_ADDRESS2
);
229 /* Switch to the next data buffer */
230 ONENAND_SET_NEXT_BUFFERRAM(this);
236 /* Write 'DFS, FBA' of Flash */
237 value
= onenand_block_address(this->device_id
, block
);
238 this->write_word(value
, this->base
+ ONENAND_REG_START_ADDRESS1
);
245 case ONENAND_CMD_READ
:
246 case ONENAND_CMD_READOOB
:
247 dataram
= ONENAND_SET_NEXT_BUFFERRAM(this);
252 dataram
= ONENAND_CURRENT_BUFFERRAM(this);
256 /* Write 'FPA, FSA' of Flash */
257 value
= onenand_page_address(page
, sectors
);
258 this->write_word(value
, this->base
+ ONENAND_REG_START_ADDRESS8
);
260 /* Write 'BSA, BSC' of DataRAM */
261 value
= onenand_buffer_address(dataram
, sectors
, count
);
262 this->write_word(value
, this->base
+ ONENAND_REG_START_BUFFER
);
265 /* Select DataRAM for DDP */
266 value
= onenand_bufferram_address(this->device_id
, block
);
267 this->write_word(value
, this->base
+ ONENAND_REG_START_ADDRESS2
);
271 /* Interrupt clear */
272 this->write_word(ONENAND_INT_CLEAR
, this->base
+ ONENAND_REG_INTERRUPT
);
275 this->write_word(cmd
, this->base
+ ONENAND_REG_COMMAND
);
281 * onenand_wait - [DEFAULT] wait until the command is done
282 * @param mtd MTD device structure
283 * @param state state to select the max. timeout value
285 * Wait for command done. This applies to all OneNAND command
286 * Read can take up to 30us, erase up to 2ms and program up to 350us
287 * according to general OneNAND specs
289 static int onenand_wait(struct mtd_info
*mtd
, int state
)
291 struct onenand_chip
* this = mtd
->priv
;
292 unsigned long timeout
;
293 unsigned int flags
= ONENAND_INT_MASTER
;
294 unsigned int interrupt
= 0;
295 unsigned int ctrl
, ecc
;
297 /* The 20 msec is enough */
298 timeout
= jiffies
+ msecs_to_jiffies(20);
299 while (time_before(jiffies
, timeout
)) {
300 interrupt
= this->read_word(this->base
+ ONENAND_REG_INTERRUPT
);
302 if (interrupt
& flags
)
305 if (state
!= FL_READING
)
308 /* To get correct interrupt status in timeout case */
309 interrupt
= this->read_word(this->base
+ ONENAND_REG_INTERRUPT
);
311 ctrl
= this->read_word(this->base
+ ONENAND_REG_CTRL_STATUS
);
313 if (ctrl
& ONENAND_CTRL_ERROR
) {
314 /* It maybe occur at initial bad block */
315 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_wait: controller error = 0x%04x\n", ctrl
);
316 /* Clear other interrupt bits for preventing ECC error */
317 interrupt
&= ONENAND_INT_MASTER
;
320 if (ctrl
& ONENAND_CTRL_LOCK
) {
321 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_wait: it's locked error = 0x%04x\n", ctrl
);
325 if (interrupt
& ONENAND_INT_READ
) {
326 ecc
= this->read_word(this->base
+ ONENAND_REG_ECC_STATUS
);
327 if (ecc
& ONENAND_ECC_2BIT_ALL
) {
328 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_wait: ECC error = 0x%04x\n", ecc
);
337 * onenand_bufferram_offset - [DEFAULT] BufferRAM offset
338 * @param mtd MTD data structure
339 * @param area BufferRAM area
340 * @return offset given area
342 * Return BufferRAM offset given area
344 static inline int onenand_bufferram_offset(struct mtd_info
*mtd
, int area
)
346 struct onenand_chip
*this = mtd
->priv
;
348 if (ONENAND_CURRENT_BUFFERRAM(this)) {
349 if (area
== ONENAND_DATARAM
)
350 return mtd
->oobblock
;
351 if (area
== ONENAND_SPARERAM
)
359 * onenand_read_bufferram - [OneNAND Interface] Read the bufferram area
360 * @param mtd MTD data structure
361 * @param area BufferRAM area
362 * @param buffer the databuffer to put/get data
363 * @param offset offset to read from or write to
364 * @param count number of bytes to read/write
366 * Read the BufferRAM area
368 static int onenand_read_bufferram(struct mtd_info
*mtd
, int area
,
369 unsigned char *buffer
, int offset
, size_t count
)
371 struct onenand_chip
*this = mtd
->priv
;
372 void __iomem
*bufferram
;
374 bufferram
= this->base
+ area
;
376 bufferram
+= onenand_bufferram_offset(mtd
, area
);
378 memcpy(buffer
, bufferram
+ offset
, count
);
384 * onenand_sync_read_bufferram - [OneNAND Interface] Read the bufferram area with Sync. Burst mode
385 * @param mtd MTD data structure
386 * @param area BufferRAM area
387 * @param buffer the databuffer to put/get data
388 * @param offset offset to read from or write to
389 * @param count number of bytes to read/write
391 * Read the BufferRAM area with Sync. Burst Mode
393 static int onenand_sync_read_bufferram(struct mtd_info
*mtd
, int area
,
394 unsigned char *buffer
, int offset
, size_t count
)
396 struct onenand_chip
*this = mtd
->priv
;
397 void __iomem
*bufferram
;
399 bufferram
= this->base
+ area
;
401 bufferram
+= onenand_bufferram_offset(mtd
, area
);
403 this->mmcontrol(mtd
, ONENAND_SYS_CFG1_SYNC_READ
);
405 memcpy(buffer
, bufferram
+ offset
, count
);
407 this->mmcontrol(mtd
, 0);
413 * onenand_write_bufferram - [OneNAND Interface] Write the bufferram area
414 * @param mtd MTD data structure
415 * @param area BufferRAM area
416 * @param buffer the databuffer to put/get data
417 * @param offset offset to read from or write to
418 * @param count number of bytes to read/write
420 * Write the BufferRAM area
422 static int onenand_write_bufferram(struct mtd_info
*mtd
, int area
,
423 const unsigned char *buffer
, int offset
, size_t count
)
425 struct onenand_chip
*this = mtd
->priv
;
426 void __iomem
*bufferram
;
428 bufferram
= this->base
+ area
;
430 bufferram
+= onenand_bufferram_offset(mtd
, area
);
432 memcpy(bufferram
+ offset
, buffer
, count
);
438 * onenand_check_bufferram - [GENERIC] Check BufferRAM information
439 * @param mtd MTD data structure
440 * @param addr address to check
441 * @return 1 if there are valid data, otherwise 0
443 * Check bufferram if there is data we required
445 static int onenand_check_bufferram(struct mtd_info
*mtd
, loff_t addr
)
447 struct onenand_chip
*this = mtd
->priv
;
451 block
= (int) (addr
>> this->erase_shift
);
452 page
= (int) (addr
>> this->page_shift
);
453 page
&= this->page_mask
;
455 i
= ONENAND_CURRENT_BUFFERRAM(this);
457 /* Is there valid data? */
458 if (this->bufferram
[i
].block
== block
&&
459 this->bufferram
[i
].page
== page
&&
460 this->bufferram
[i
].valid
)
467 * onenand_update_bufferram - [GENERIC] Update BufferRAM information
468 * @param mtd MTD data structure
469 * @param addr address to update
470 * @param valid valid flag
472 * Update BufferRAM information
474 static int onenand_update_bufferram(struct mtd_info
*mtd
, loff_t addr
,
477 struct onenand_chip
*this = mtd
->priv
;
481 block
= (int) (addr
>> this->erase_shift
);
482 page
= (int) (addr
>> this->page_shift
);
483 page
&= this->page_mask
;
485 /* Invalidate BufferRAM */
486 for (i
= 0; i
< MAX_BUFFERRAM
; i
++) {
487 if (this->bufferram
[i
].block
== block
&&
488 this->bufferram
[i
].page
== page
)
489 this->bufferram
[i
].valid
= 0;
492 /* Update BufferRAM */
493 i
= ONENAND_CURRENT_BUFFERRAM(this);
494 this->bufferram
[i
].block
= block
;
495 this->bufferram
[i
].page
= page
;
496 this->bufferram
[i
].valid
= valid
;
502 * onenand_get_device - [GENERIC] Get chip for selected access
503 * @param mtd MTD device structure
504 * @param new_state the state which is requested
506 * Get the device and lock it for exclusive access
508 static void onenand_get_device(struct mtd_info
*mtd
, int new_state
)
510 struct onenand_chip
*this = mtd
->priv
;
511 DECLARE_WAITQUEUE(wait
, current
);
514 * Grab the lock and see if the device is available
517 spin_lock(&this->chip_lock
);
518 if (this->state
== FL_READY
) {
519 this->state
= new_state
;
520 spin_unlock(&this->chip_lock
);
523 set_current_state(TASK_UNINTERRUPTIBLE
);
524 add_wait_queue(&this->wq
, &wait
);
525 spin_unlock(&this->chip_lock
);
527 remove_wait_queue(&this->wq
, &wait
);
532 * onenand_release_device - [GENERIC] release chip
533 * @param mtd MTD device structure
535 * Deselect, release chip lock and wake up anyone waiting on the device
537 static void onenand_release_device(struct mtd_info
*mtd
)
539 struct onenand_chip
*this = mtd
->priv
;
541 /* Release the chip */
542 spin_lock(&this->chip_lock
);
543 this->state
= FL_READY
;
545 spin_unlock(&this->chip_lock
);
549 * onenand_read_ecc - [MTD Interface] Read data with ECC
550 * @param mtd MTD device structure
551 * @param from offset to read from
552 * @param len number of bytes to read
553 * @param retlen pointer to variable to store the number of read bytes
554 * @param buf the databuffer to put data
555 * @param oob_buf filesystem supplied oob data buffer
556 * @param oobsel oob selection structure
558 * OneNAND read with ECC
560 static int onenand_read_ecc(struct mtd_info
*mtd
, loff_t from
, size_t len
,
561 size_t *retlen
, u_char
*buf
,
562 u_char
*oob_buf
, struct nand_oobinfo
*oobsel
)
564 struct onenand_chip
*this = mtd
->priv
;
565 int read
= 0, column
;
569 DEBUG(MTD_DEBUG_LEVEL3
, "onenand_read_ecc: from = 0x%08x, len = %i\n", (unsigned int) from
, (int) len
);
571 /* Do not allow reads past end of device */
572 if ((from
+ len
) > mtd
->size
) {
573 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_read_ecc: Attempt read beyond end of device\n");
578 /* Grab the lock and see if the device is available */
579 onenand_get_device(mtd
, FL_READING
);
581 /* TODO handling oob */
584 thislen
= min_t(int, mtd
->oobblock
, len
- read
);
586 column
= from
& (mtd
->oobblock
- 1);
587 if (column
+ thislen
> mtd
->oobblock
)
588 thislen
= mtd
->oobblock
- column
;
590 if (!onenand_check_bufferram(mtd
, from
)) {
591 this->command(mtd
, ONENAND_CMD_READ
, from
, mtd
->oobblock
);
593 ret
= this->wait(mtd
, FL_READING
);
594 /* First copy data and check return value for ECC handling */
595 onenand_update_bufferram(mtd
, from
, 1);
598 this->read_bufferram(mtd
, ONENAND_DATARAM
, buf
, column
, thislen
);
606 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_read_ecc: read failed = %d\n", ret
);
615 /* Deselect and wake up anyone waiting on the device */
616 onenand_release_device(mtd
);
619 * Return success, if no ECC failures, else -EBADMSG
620 * fs driver will take care of that, because
621 * retlen == desired len and result == -EBADMSG
628 * onenand_read - [MTD Interface] MTD compability function for onenand_read_ecc
629 * @param mtd MTD device structure
630 * @param from offset to read from
631 * @param len number of bytes to read
632 * @param retlen pointer to variable to store the number of read bytes
633 * @param buf the databuffer to put data
635 * This function simply calls onenand_read_ecc with oob buffer and oobsel = NULL
637 static int onenand_read(struct mtd_info
*mtd
, loff_t from
, size_t len
,
638 size_t *retlen
, u_char
*buf
)
640 return onenand_read_ecc(mtd
, from
, len
, retlen
, buf
, NULL
, NULL
);
644 * onenand_read_oob - [MTD Interface] OneNAND read out-of-band
645 * @param mtd MTD device structure
646 * @param from offset to read from
647 * @param len number of bytes to read
648 * @param retlen pointer to variable to store the number of read bytes
649 * @param buf the databuffer to put data
651 * OneNAND read out-of-band data from the spare area
653 static int onenand_read_oob(struct mtd_info
*mtd
, loff_t from
, size_t len
,
654 size_t *retlen
, u_char
*buf
)
656 struct onenand_chip
*this = mtd
->priv
;
657 int read
= 0, thislen
, column
;
660 DEBUG(MTD_DEBUG_LEVEL3
, "onenand_read_oob: from = 0x%08x, len = %i\n", (unsigned int) from
, (int) len
);
662 /* Initialize return length value */
665 /* Do not allow reads past end of device */
666 if (unlikely((from
+ len
) > mtd
->size
)) {
667 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_read_oob: Attempt read beyond end of device\n");
671 /* Grab the lock and see if the device is available */
672 onenand_get_device(mtd
, FL_READING
);
674 column
= from
& (mtd
->oobsize
- 1);
677 thislen
= mtd
->oobsize
- column
;
678 thislen
= min_t(int, thislen
, len
);
680 this->command(mtd
, ONENAND_CMD_READOOB
, from
, mtd
->oobsize
);
682 onenand_update_bufferram(mtd
, from
, 0);
684 ret
= this->wait(mtd
, FL_READING
);
685 /* First copy data and check return value for ECC handling */
687 this->read_bufferram(mtd
, ONENAND_SPARERAM
, buf
, column
, thislen
);
695 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_read_oob: read failed = %d\n", ret
);
704 from
+= mtd
->oobblock
;
710 /* Deselect and wake up anyone waiting on the device */
711 onenand_release_device(mtd
);
717 #ifdef CONFIG_MTD_ONENAND_VERIFY_WRITE
719 * onenand_verify_page - [GENERIC] verify the chip contents after a write
720 * @param mtd MTD device structure
721 * @param buf the databuffer to verify
722 * @param block block address
723 * @param page page address
725 * Check DataRAM area directly
727 static int onenand_verify_page(struct mtd_info
*mtd
, u_char
*buf
,
728 loff_t addr
, int block
, int page
)
730 struct onenand_chip
*this = mtd
->priv
;
731 void __iomem
*dataram0
, *dataram1
;
734 this->command(mtd
, ONENAND_CMD_READ
, addr
, mtd
->oobblock
);
736 ret
= this->wait(mtd
, FL_READING
);
740 onenand_update_bufferram(mtd
, addr
, 1);
742 /* Check, if the two dataram areas are same */
743 dataram0
= this->base
+ ONENAND_DATARAM
;
744 dataram1
= dataram0
+ mtd
->oobblock
;
746 if (memcmp(dataram0
, dataram1
, mtd
->oobblock
))
752 #define onenand_verify_page(...) (0)
755 #define NOTALIGNED(x) ((x & (mtd->oobblock - 1)) != 0)
758 * onenand_write_ecc - [MTD Interface] OneNAND write with ECC
759 * @param mtd MTD device structure
760 * @param to offset to write to
761 * @param len number of bytes to write
762 * @param retlen pointer to variable to store the number of written bytes
763 * @param buf the data to write
764 * @param eccbuf filesystem supplied oob data buffer
765 * @param oobsel oob selection structure
767 * OneNAND write with ECC
769 static int onenand_write_ecc(struct mtd_info
*mtd
, loff_t to
, size_t len
,
770 size_t *retlen
, const u_char
*buf
,
771 u_char
*eccbuf
, struct nand_oobinfo
*oobsel
)
773 struct onenand_chip
*this = mtd
->priv
;
777 DEBUG(MTD_DEBUG_LEVEL3
, "onenand_write_ecc: to = 0x%08x, len = %i\n", (unsigned int) to
, (int) len
);
779 /* Initialize retlen, in case of early exit */
782 /* Do not allow writes past end of device */
783 if (unlikely((to
+ len
) > mtd
->size
)) {
784 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_write_ecc: Attempt write to past end of device\n");
788 /* Reject writes, which are not page aligned */
789 if (unlikely(NOTALIGNED(to
)) || unlikely(NOTALIGNED(len
))) {
790 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_write_ecc: Attempt to write not page aligned data\n");
794 /* Grab the lock and see if the device is available */
795 onenand_get_device(mtd
, FL_WRITING
);
797 /* Loop until all data write */
798 while (written
< len
) {
799 int thislen
= min_t(int, mtd
->oobblock
, len
- written
);
801 this->command(mtd
, ONENAND_CMD_BUFFERRAM
, to
, mtd
->oobblock
);
803 this->write_bufferram(mtd
, ONENAND_DATARAM
, buf
, 0, thislen
);
804 this->write_bufferram(mtd
, ONENAND_SPARERAM
, ffchars
, 0, mtd
->oobsize
);
806 this->command(mtd
, ONENAND_CMD_PROG
, to
, mtd
->oobblock
);
808 onenand_update_bufferram(mtd
, to
, 1);
810 ret
= this->wait(mtd
, FL_WRITING
);
812 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_write_ecc: write filaed %d\n", ret
);
818 /* Only check verify write turn on */
819 ret
= onenand_verify_page(mtd
, (u_char
*) buf
, to
, block
, page
);
821 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_write_ecc: verify failed %d\n", ret
);
833 /* Deselect and wake up anyone waiting on the device */
834 onenand_release_device(mtd
);
842 * onenand_write - [MTD Interface] compability function for onenand_write_ecc
843 * @param mtd MTD device structure
844 * @param to offset to write to
845 * @param len number of bytes to write
846 * @param retlen pointer to variable to store the number of written bytes
847 * @param buf the data to write
849 * This function simply calls onenand_write_ecc
850 * with oob buffer and oobsel = NULL
852 static int onenand_write(struct mtd_info
*mtd
, loff_t to
, size_t len
,
853 size_t *retlen
, const u_char
*buf
)
855 return onenand_write_ecc(mtd
, to
, len
, retlen
, buf
, NULL
, NULL
);
859 * onenand_write_oob - [MTD Interface] OneNAND write out-of-band
860 * @param mtd MTD device structure
861 * @param to offset to write to
862 * @param len number of bytes to write
863 * @param retlen pointer to variable to store the number of written bytes
864 * @param buf the data to write
866 * OneNAND write out-of-band
868 static int onenand_write_oob(struct mtd_info
*mtd
, loff_t to
, size_t len
,
869 size_t *retlen
, const u_char
*buf
)
871 struct onenand_chip
*this = mtd
->priv
;
875 DEBUG(MTD_DEBUG_LEVEL3
, "onenand_write_oob: to = 0x%08x, len = %i\n", (unsigned int) to
, (int) len
);
877 /* Initialize retlen, in case of early exit */
880 /* Do not allow writes past end of device */
881 if (unlikely((to
+ len
) > mtd
->size
)) {
882 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_write_oob: Attempt write to past end of device\n");
886 /* Grab the lock and see if the device is available */
887 onenand_get_device(mtd
, FL_WRITING
);
889 /* Loop until all data write */
890 while (written
< len
) {
891 int thislen
= min_t(int, mtd
->oobsize
, len
- written
);
893 column
= to
& (mtd
->oobsize
- 1);
895 this->command(mtd
, ONENAND_CMD_BUFFERRAM
, to
, mtd
->oobsize
);
897 this->write_bufferram(mtd
, ONENAND_SPARERAM
, ffchars
, 0, mtd
->oobsize
);
898 this->write_bufferram(mtd
, ONENAND_SPARERAM
, buf
, column
, thislen
);
900 this->command(mtd
, ONENAND_CMD_PROGOOB
, to
, mtd
->oobsize
);
902 onenand_update_bufferram(mtd
, to
, 0);
904 status
= this->wait(mtd
, FL_WRITING
);
918 /* Deselect and wake up anyone waiting on the device */
919 onenand_release_device(mtd
);
927 * onenand_writev_ecc - [MTD Interface] write with iovec with ecc
928 * @param mtd MTD device structure
929 * @param vecs the iovectors to write
930 * @param count number of vectors
931 * @param to offset to write to
932 * @param retlen pointer to variable to store the number of written bytes
933 * @param eccbuf filesystem supplied oob data buffer
934 * @param oobsel oob selection structure
936 * OneNAND write with iovec with ecc
938 static int onenand_writev_ecc(struct mtd_info
*mtd
, const struct kvec
*vecs
,
939 unsigned long count
, loff_t to
, size_t *retlen
,
940 u_char
*eccbuf
, struct nand_oobinfo
*oobsel
)
942 struct onenand_chip
*this = mtd
->priv
;
943 unsigned char buffer
[mtd
->oobblock
], *pbuf
;
944 size_t total_len
, len
;
948 /* Preset written len for early exit */
951 /* Calculate total length of data */
953 for (i
= 0; i
< count
; i
++)
954 total_len
+= vecs
[i
].iov_len
;
956 DEBUG(MTD_DEBUG_LEVEL3
, "onenand_writev_ecc: to = 0x%08x, len = %i, count = %ld\n", (unsigned int) to
, (unsigned int) total_len
, count
);
958 /* Do not allow write past end of the device */
959 if (unlikely((to
+ total_len
) > mtd
->size
)) {
960 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_writev_ecc: Attempted write past end of device\n");
964 /* Reject writes, which are not page aligned */
965 if (unlikely(NOTALIGNED(to
)) || unlikely(NOTALIGNED(total_len
))) {
966 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_writev_ecc: Attempt to write not page aligned data\n");
970 /* Grab the lock and see if the device is available */
971 onenand_get_device(mtd
, FL_WRITING
);
973 /* TODO handling oob */
975 /* Loop until all keve's data has been written */
980 * If the given tuple is >= pagesize then
981 * write it out from the iov
983 if ((vecs
->iov_len
- len
) >= mtd
->oobblock
) {
984 pbuf
= vecs
->iov_base
+ len
;
986 len
+= mtd
->oobblock
;
988 /* Check, if we have to switch to the next tuple */
989 if (len
>= (int) vecs
->iov_len
) {
995 int cnt
= 0, thislen
;
996 while (cnt
< mtd
->oobblock
) {
997 thislen
= min_t(int, mtd
->oobblock
- cnt
, vecs
->iov_len
- len
);
998 memcpy(buffer
+ cnt
, vecs
->iov_base
+ len
, thislen
);
1002 /* Check, if we have to switch to the next tuple */
1003 if (len
>= (int) vecs
->iov_len
) {
1011 this->command(mtd
, ONENAND_CMD_BUFFERRAM
, to
, mtd
->oobblock
);
1013 this->write_bufferram(mtd
, ONENAND_DATARAM
, pbuf
, 0, mtd
->oobblock
);
1014 this->write_bufferram(mtd
, ONENAND_SPARERAM
, ffchars
, 0, mtd
->oobsize
);
1016 this->command(mtd
, ONENAND_CMD_PROG
, to
, mtd
->oobblock
);
1018 onenand_update_bufferram(mtd
, to
, 1);
1020 ret
= this->wait(mtd
, FL_WRITING
);
1022 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_writev_ecc: write failed %d\n", ret
);
1027 /* Only check verify write turn on */
1028 ret
= onenand_verify_page(mtd
, (u_char
*) pbuf
, to
, block
, page
);
1030 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_writev_ecc: verify failed %d\n", ret
);
1034 written
+= mtd
->oobblock
;
1036 to
+= mtd
->oobblock
;
1040 /* Deselect and wakt up anyone waiting on the device */
1041 onenand_release_device(mtd
);
1049 * onenand_writev - [MTD Interface] compabilty function for onenand_writev_ecc
1050 * @param mtd MTD device structure
1051 * @param vecs the iovectors to write
1052 * @param count number of vectors
1053 * @param to offset to write to
1054 * @param retlen pointer to variable to store the number of written bytes
1056 * OneNAND write with kvec. This just calls the ecc function
1058 static int onenand_writev(struct mtd_info
*mtd
, const struct kvec
*vecs
,
1059 unsigned long count
, loff_t to
, size_t *retlen
)
1061 return onenand_writev_ecc(mtd
, vecs
, count
, to
, retlen
, NULL
, NULL
);
1065 * onenand_block_checkbad - [GENERIC] Check if a block is marked bad
1066 * @param mtd MTD device structure
1067 * @param ofs offset from device start
1068 * @param getchip 0, if the chip is already selected
1069 * @param allowbbt 1, if its allowed to access the bbt area
1071 * Check, if the block is bad. Either by reading the bad block table or
1072 * calling of the scan function.
1074 static int onenand_block_checkbad(struct mtd_info
*mtd
, loff_t ofs
, int getchip
, int allowbbt
)
1076 struct onenand_chip
*this = mtd
->priv
;
1077 struct bbm_info
*bbm
= this->bbm
;
1079 /* Return info from the table */
1080 return bbm
->isbad_bbt(mtd
, ofs
, allowbbt
);
1084 * onenand_erase - [MTD Interface] erase block(s)
1085 * @param mtd MTD device structure
1086 * @param instr erase instruction
1088 * Erase one ore more blocks
1090 static int onenand_erase(struct mtd_info
*mtd
, struct erase_info
*instr
)
1092 struct onenand_chip
*this = mtd
->priv
;
1093 unsigned int block_size
;
1098 DEBUG(MTD_DEBUG_LEVEL3
, "onenand_erase: start = 0x%08x, len = %i\n", (unsigned int) instr
->addr
, (unsigned int) instr
->len
);
1100 block_size
= (1 << this->erase_shift
);
1102 /* Start address must align on block boundary */
1103 if (unlikely(instr
->addr
& (block_size
- 1))) {
1104 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_erase: Unaligned address\n");
1108 /* Length must align on block boundary */
1109 if (unlikely(instr
->len
& (block_size
- 1))) {
1110 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_erase: Length not block aligned\n");
1114 /* Do not allow erase past end of device */
1115 if (unlikely((instr
->len
+ instr
->addr
) > mtd
->size
)) {
1116 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_erase: Erase past end of device\n");
1120 instr
->fail_addr
= 0xffffffff;
1122 /* Grab the lock and see if the device is available */
1123 onenand_get_device(mtd
, FL_ERASING
);
1125 /* Loop throught the pages */
1129 instr
->state
= MTD_ERASING
;
1133 /* Check if we have a bad block, we do not erase bad blocks */
1134 if (onenand_block_checkbad(mtd
, addr
, 0, 0)) {
1135 printk (KERN_WARNING
"onenand_erase: attempt to erase a bad block at addr 0x%08x\n", (unsigned int) addr
);
1136 instr
->state
= MTD_ERASE_FAILED
;
1140 this->command(mtd
, ONENAND_CMD_ERASE
, addr
, block_size
);
1142 ret
= this->wait(mtd
, FL_ERASING
);
1143 /* Check, if it is write protected */
1146 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_erase: Device is write protected!!!\n");
1148 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_erase: Failed erase, block %d\n", (unsigned) (addr
>> this->erase_shift
));
1149 instr
->state
= MTD_ERASE_FAILED
;
1150 instr
->fail_addr
= addr
;
1158 instr
->state
= MTD_ERASE_DONE
;
1162 ret
= instr
->state
== MTD_ERASE_DONE
? 0 : -EIO
;
1163 /* Do call back function */
1165 mtd_erase_callback(instr
);
1167 /* Deselect and wake up anyone waiting on the device */
1168 onenand_release_device(mtd
);
1174 * onenand_sync - [MTD Interface] sync
1175 * @param mtd MTD device structure
1177 * Sync is actually a wait for chip ready function
1179 static void onenand_sync(struct mtd_info
*mtd
)
1181 DEBUG(MTD_DEBUG_LEVEL3
, "onenand_sync: called\n");
1183 /* Grab the lock and see if the device is available */
1184 onenand_get_device(mtd
, FL_SYNCING
);
1186 /* Release it and go back */
1187 onenand_release_device(mtd
);
1192 * onenand_block_isbad - [MTD Interface] Check whether the block at the given offset is bad
1193 * @param mtd MTD device structure
1194 * @param ofs offset relative to mtd start
1196 * Check whether the block is bad
1198 static int onenand_block_isbad(struct mtd_info
*mtd
, loff_t ofs
)
1200 /* Check for invalid offset */
1201 if (ofs
> mtd
->size
)
1204 return onenand_block_checkbad(mtd
, ofs
, 1, 0);
1208 * onenand_default_block_markbad - [DEFAULT] mark a block bad
1209 * @param mtd MTD device structure
1210 * @param ofs offset from device start
1212 * This is the default implementation, which can be overridden by
1213 * a hardware specific driver.
1215 static int onenand_default_block_markbad(struct mtd_info
*mtd
, loff_t ofs
)
1217 struct onenand_chip
*this = mtd
->priv
;
1218 struct bbm_info
*bbm
= this->bbm
;
1219 u_char buf
[2] = {0, 0};
1223 /* Get block number */
1224 block
= ((int) ofs
) >> bbm
->bbt_erase_shift
;
1226 bbm
->bbt
[block
>> 2] |= 0x01 << ((block
& 0x03) << 1);
1228 /* We write two bytes, so we dont have to mess with 16 bit access */
1229 ofs
+= mtd
->oobsize
+ (bbm
->badblockpos
& ~0x01);
1230 return mtd
->write_oob(mtd
, ofs
, 2, &retlen
, buf
);
1234 * onenand_block_markbad - [MTD Interface] Mark the block at the given offset as bad
1235 * @param mtd MTD device structure
1236 * @param ofs offset relative to mtd start
1238 * Mark the block as bad
1240 static int onenand_block_markbad(struct mtd_info
*mtd
, loff_t ofs
)
1242 struct onenand_chip
*this = mtd
->priv
;
1245 ret
= onenand_block_isbad(mtd
, ofs
);
1247 /* If it was bad already, return success and do nothing */
1253 return this->block_markbad(mtd
, ofs
);
1257 * onenand_unlock - [MTD Interface] Unlock block(s)
1258 * @param mtd MTD device structure
1259 * @param ofs offset relative to mtd start
1260 * @param len number of bytes to unlock
1262 * Unlock one or more blocks
1264 static int onenand_unlock(struct mtd_info
*mtd
, loff_t ofs
, size_t len
)
1266 struct onenand_chip
*this = mtd
->priv
;
1267 int start
, end
, block
, value
, status
;
1269 start
= ofs
>> this->erase_shift
;
1270 end
= len
>> this->erase_shift
;
1272 /* Continuous lock scheme */
1273 if (this->options
& ONENAND_CONT_LOCK
) {
1274 /* Set start block address */
1275 this->write_word(start
, this->base
+ ONENAND_REG_START_BLOCK_ADDRESS
);
1276 /* Set end block address */
1277 this->write_word(end
- 1, this->base
+ ONENAND_REG_END_BLOCK_ADDRESS
);
1278 /* Write unlock command */
1279 this->command(mtd
, ONENAND_CMD_UNLOCK
, 0, 0);
1281 /* There's no return value */
1282 this->wait(mtd
, FL_UNLOCKING
);
1285 while (this->read_word(this->base
+ ONENAND_REG_CTRL_STATUS
)
1286 & ONENAND_CTRL_ONGO
)
1289 /* Check lock status */
1290 status
= this->read_word(this->base
+ ONENAND_REG_WP_STATUS
);
1291 if (!(status
& ONENAND_WP_US
))
1292 printk(KERN_ERR
"wp status = 0x%x\n", status
);
1297 /* Block lock scheme */
1298 for (block
= start
; block
< end
; block
++) {
1299 /* Set start block address */
1300 this->write_word(block
, this->base
+ ONENAND_REG_START_BLOCK_ADDRESS
);
1301 /* Write unlock command */
1302 this->command(mtd
, ONENAND_CMD_UNLOCK
, 0, 0);
1304 /* There's no return value */
1305 this->wait(mtd
, FL_UNLOCKING
);
1308 while (this->read_word(this->base
+ ONENAND_REG_CTRL_STATUS
)
1309 & ONENAND_CTRL_ONGO
)
1312 /* Set block address for read block status */
1313 value
= onenand_block_address(this->device_id
, block
);
1314 this->write_word(value
, this->base
+ ONENAND_REG_START_ADDRESS1
);
1316 /* Check lock status */
1317 status
= this->read_word(this->base
+ ONENAND_REG_WP_STATUS
);
1318 if (!(status
& ONENAND_WP_US
))
1319 printk(KERN_ERR
"block = %d, wp status = 0x%x\n", block
, status
);
1326 * onenand_print_device_info - Print device ID
1327 * @param device device ID
1331 static void onenand_print_device_info(int device
)
1333 int vcc
, demuxed
, ddp
, density
;
1335 vcc
= device
& ONENAND_DEVICE_VCC_MASK
;
1336 demuxed
= device
& ONENAND_DEVICE_IS_DEMUX
;
1337 ddp
= device
& ONENAND_DEVICE_IS_DDP
;
1338 density
= device
>> ONENAND_DEVICE_DENSITY_SHIFT
;
1339 printk(KERN_INFO
"%sOneNAND%s %dMB %sV 16-bit (0x%02x)\n",
1340 demuxed
? "" : "Muxed ",
1343 vcc
? "2.65/3.3" : "1.8",
1347 static const struct onenand_manufacturers onenand_manuf_ids
[] = {
1348 {ONENAND_MFR_SAMSUNG
, "Samsung"},
1349 {ONENAND_MFR_UNKNOWN
, "Unknown"}
1353 * onenand_check_maf - Check manufacturer ID
1354 * @param manuf manufacturer ID
1356 * Check manufacturer ID
1358 static int onenand_check_maf(int manuf
)
1362 for (i
= 0; onenand_manuf_ids
[i
].id
; i
++) {
1363 if (manuf
== onenand_manuf_ids
[i
].id
)
1367 printk(KERN_DEBUG
"OneNAND Manufacturer: %s (0x%0x)\n",
1368 onenand_manuf_ids
[i
].name
, manuf
);
1370 return (i
!= ONENAND_MFR_UNKNOWN
);
1374 * onenand_probe - [OneNAND Interface] Probe the OneNAND device
1375 * @param mtd MTD device structure
1377 * OneNAND detection method:
1378 * Compare the the values from command with ones from register
1380 static int onenand_probe(struct mtd_info
*mtd
)
1382 struct onenand_chip
*this = mtd
->priv
;
1383 int bram_maf_id
, bram_dev_id
, maf_id
, dev_id
;
1387 /* Send the command for reading device ID from BootRAM */
1388 this->write_word(ONENAND_CMD_READID
, this->base
+ ONENAND_BOOTRAM
);
1390 /* Read manufacturer and device IDs from BootRAM */
1391 bram_maf_id
= this->read_word(this->base
+ ONENAND_BOOTRAM
+ 0x0);
1392 bram_dev_id
= this->read_word(this->base
+ ONENAND_BOOTRAM
+ 0x2);
1394 /* Check manufacturer ID */
1395 if (onenand_check_maf(bram_maf_id
))
1398 /* Reset OneNAND to read default register values */
1399 this->write_word(ONENAND_CMD_RESET
, this->base
+ ONENAND_BOOTRAM
);
1401 /* Read manufacturer and device IDs from Register */
1402 maf_id
= this->read_word(this->base
+ ONENAND_REG_MANUFACTURER_ID
);
1403 dev_id
= this->read_word(this->base
+ ONENAND_REG_DEVICE_ID
);
1405 /* Check OneNAND device */
1406 if (maf_id
!= bram_maf_id
|| dev_id
!= bram_dev_id
)
1409 /* Flash device information */
1410 onenand_print_device_info(dev_id
);
1411 this->device_id
= dev_id
;
1413 density
= dev_id
>> ONENAND_DEVICE_DENSITY_SHIFT
;
1414 this->chipsize
= (16 << density
) << 20;
1416 /* OneNAND page size & block size */
1417 /* The data buffer size is equal to page size */
1418 mtd
->oobblock
= this->read_word(this->base
+ ONENAND_REG_DATA_BUFFER_SIZE
);
1419 mtd
->oobsize
= mtd
->oobblock
>> 5;
1420 /* Pagers per block is always 64 in OneNAND */
1421 mtd
->erasesize
= mtd
->oobblock
<< 6;
1423 this->erase_shift
= ffs(mtd
->erasesize
) - 1;
1424 this->page_shift
= ffs(mtd
->oobblock
) - 1;
1425 this->ppb_shift
= (this->erase_shift
- this->page_shift
);
1426 this->page_mask
= (mtd
->erasesize
/ mtd
->oobblock
) - 1;
1428 /* REVIST: Multichip handling */
1430 mtd
->size
= this->chipsize
;
1433 version_id
= this->read_word(this->base
+ ONENAND_REG_VERSION_ID
);
1434 printk(KERN_DEBUG
"OneNAND version = 0x%04x\n", version_id
);
1437 if (density
<= ONENAND_DEVICE_DENSITY_512Mb
&&
1438 !(version_id
>> ONENAND_VERSION_PROCESS_SHIFT
)) {
1439 printk(KERN_INFO
"Lock scheme is Continues Lock\n");
1440 this->options
|= ONENAND_CONT_LOCK
;
1448 * onenand_scan - [OneNAND Interface] Scan for the OneNAND device
1449 * @param mtd MTD device structure
1450 * @param maxchips Number of chips to scan for
1452 * This fills out all the not initialized function pointers
1453 * with the defaults.
1454 * The flash ID is read and the mtd/chip structures are
1455 * filled with the appropriate values.
1457 int onenand_scan(struct mtd_info
*mtd
, int maxchips
)
1459 struct onenand_chip
*this = mtd
->priv
;
1461 if (!this->read_word
)
1462 this->read_word
= onenand_readw
;
1463 if (!this->write_word
)
1464 this->write_word
= onenand_writew
;
1467 this->command
= onenand_command
;
1469 this->wait
= onenand_wait
;
1471 if (!this->read_bufferram
)
1472 this->read_bufferram
= onenand_read_bufferram
;
1473 if (!this->write_bufferram
)
1474 this->write_bufferram
= onenand_write_bufferram
;
1476 if (!this->block_markbad
)
1477 this->block_markbad
= onenand_default_block_markbad
;
1478 if (!this->scan_bbt
)
1479 this->scan_bbt
= onenand_default_bbt
;
1481 if (onenand_probe(mtd
))
1484 /* Set Sync. Burst Read after probing */
1485 if (this->mmcontrol
) {
1486 printk(KERN_INFO
"OneNAND Sync. Burst Read support\n");
1487 this->read_bufferram
= onenand_sync_read_bufferram
;
1490 this->state
= FL_READY
;
1491 init_waitqueue_head(&this->wq
);
1492 spin_lock_init(&this->chip_lock
);
1494 switch (mtd
->oobsize
) {
1496 this->autooob
= &onenand_oob_64
;
1500 this->autooob
= &onenand_oob_32
;
1504 printk(KERN_WARNING
"No OOB scheme defined for oobsize %d\n",
1506 /* To prevent kernel oops */
1507 this->autooob
= &onenand_oob_32
;
1511 memcpy(&mtd
->oobinfo
, this->autooob
, sizeof(mtd
->oobinfo
));
1513 /* Fill in remaining MTD driver data */
1514 mtd
->type
= MTD_NANDFLASH
;
1515 mtd
->flags
= MTD_CAP_NANDFLASH
| MTD_ECC
;
1516 mtd
->ecctype
= MTD_ECC_SW
;
1517 mtd
->erase
= onenand_erase
;
1519 mtd
->unpoint
= NULL
;
1520 mtd
->read
= onenand_read
;
1521 mtd
->write
= onenand_write
;
1522 mtd
->read_ecc
= onenand_read_ecc
;
1523 mtd
->write_ecc
= onenand_write_ecc
;
1524 mtd
->read_oob
= onenand_read_oob
;
1525 mtd
->write_oob
= onenand_write_oob
;
1527 mtd
->readv_ecc
= NULL
;
1528 mtd
->writev
= onenand_writev
;
1529 mtd
->writev_ecc
= onenand_writev_ecc
;
1530 mtd
->sync
= onenand_sync
;
1532 mtd
->unlock
= onenand_unlock
;
1533 mtd
->suspend
= NULL
;
1535 mtd
->block_isbad
= onenand_block_isbad
;
1536 mtd
->block_markbad
= onenand_block_markbad
;
1537 mtd
->owner
= THIS_MODULE
;
1539 /* Unlock whole block */
1540 mtd
->unlock(mtd
, 0x0, this->chipsize
);
1542 return this->scan_bbt(mtd
);
1546 * onenand_release - [OneNAND Interface] Free resources held by the OneNAND device
1547 * @param mtd MTD device structure
1549 void onenand_release(struct mtd_info
*mtd
)
1551 #ifdef CONFIG_MTD_PARTITIONS
1552 /* Deregister partitions */
1553 del_mtd_partitions (mtd
);
1555 /* Deregister the device */
1556 del_mtd_device (mtd
);
1559 EXPORT_SYMBOL_GPL(onenand_scan
);
1560 EXPORT_SYMBOL_GPL(onenand_release
);
1562 MODULE_LICENSE("GPL");
1563 MODULE_AUTHOR("Kyungmin Park <kyungmin.park@samsung.com>");
1564 MODULE_DESCRIPTION("Generic OneNAND flash driver code");