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.
14 #ifdef CONFIG_CMD_ONENAND
16 #include <linux/mtd/compat.h>
17 #include <linux/mtd/mtd.h>
18 #include <linux/mtd/onenand.h>
21 #include <asm/errno.h>
23 /* It should access 16-bit instead of 8-bit */
24 static inline void *memcpy_16(void *dst
, const void *src
, unsigned int len
)
36 static const unsigned char ffchars
[] = {
37 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
38 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 16 */
39 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
40 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 32 */
41 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
42 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 48 */
43 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
44 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 64 */
48 * onenand_readw - [OneNAND Interface] Read OneNAND register
49 * @param addr address to read
51 * Read OneNAND register
53 static unsigned short onenand_readw(void __iomem
* addr
)
59 * onenand_writew - [OneNAND Interface] Write OneNAND register with value
60 * @param value value to write
61 * @param addr address to write
63 * Write OneNAND register with value
65 static void onenand_writew(unsigned short value
, void __iomem
* addr
)
71 * onenand_block_address - [DEFAULT] Get block address
72 * @param device the device id
73 * @param block the block
74 * @return translated block address if DDP, otherwise same
76 * Setup Start Address 1 Register (F100h)
78 static int onenand_block_address(int device
, int block
)
80 if (device
& ONENAND_DEVICE_IS_DDP
) {
81 /* Device Flash Core select, NAND Flash Block Address */
82 int dfs
= 0, density
, mask
;
84 density
= device
>> ONENAND_DEVICE_DENSITY_SHIFT
;
85 mask
= (1 << (density
+ 6));
90 return (dfs
<< ONENAND_DDP_SHIFT
) | (block
& (mask
- 1));
97 * onenand_bufferram_address - [DEFAULT] Get bufferram address
98 * @param device the device id
99 * @param block the block
100 * @return set DBS value if DDP, otherwise 0
102 * Setup Start Address 2 Register (F101h) for DDP
104 static int onenand_bufferram_address(int device
, int block
)
106 if (device
& ONENAND_DEVICE_IS_DDP
) {
107 /* Device BufferRAM Select */
108 int dbs
= 0, density
, mask
;
110 density
= device
>> ONENAND_DEVICE_DENSITY_SHIFT
;
111 mask
= (1 << (density
+ 6));
116 return (dbs
<< ONENAND_DDP_SHIFT
);
123 * onenand_page_address - [DEFAULT] Get page address
124 * @param page the page address
125 * @param sector the sector address
126 * @return combined page and sector address
128 * Setup Start Address 8 Register (F107h)
130 static int onenand_page_address(int page
, int sector
)
132 /* Flash Page Address, Flash Sector Address */
135 fpa
= page
& ONENAND_FPA_MASK
;
136 fsa
= sector
& ONENAND_FSA_MASK
;
138 return ((fpa
<< ONENAND_FPA_SHIFT
) | fsa
);
142 * onenand_buffer_address - [DEFAULT] Get buffer address
143 * @param dataram1 DataRAM index
144 * @param sectors the sector address
145 * @param count the number of sectors
146 * @return the start buffer value
148 * Setup Start Buffer Register (F200h)
150 static int onenand_buffer_address(int dataram1
, int sectors
, int count
)
154 /* BufferRAM Sector Address */
155 bsa
= sectors
& ONENAND_BSA_MASK
;
158 bsa
|= ONENAND_BSA_DATARAM1
; /* DataRAM1 */
160 bsa
|= ONENAND_BSA_DATARAM0
; /* DataRAM0 */
162 /* BufferRAM Sector Count */
163 bsc
= count
& ONENAND_BSC_MASK
;
165 return ((bsa
<< ONENAND_BSA_SHIFT
) | bsc
);
169 * onenand_command - [DEFAULT] Send command to OneNAND device
170 * @param mtd MTD device structure
171 * @param cmd the command to be sent
172 * @param addr offset to read from or write to
173 * @param len number of bytes to read or write
175 * Send command to OneNAND device. This function is used for middle/large page
176 * devices (1KB/2KB Bytes per page)
178 static int onenand_command(struct mtd_info
*mtd
, int cmd
, loff_t addr
,
181 struct onenand_chip
*this = mtd
->priv
;
182 int value
, readcmd
= 0;
184 /* Now we use page size operation */
185 int sectors
= 4, count
= 4;
187 /* Address translation */
189 case ONENAND_CMD_UNLOCK
:
190 case ONENAND_CMD_LOCK
:
191 case ONENAND_CMD_LOCK_TIGHT
:
196 case ONENAND_CMD_ERASE
:
197 case ONENAND_CMD_BUFFERRAM
:
198 block
= (int)(addr
>> this->erase_shift
);
203 block
= (int)(addr
>> this->erase_shift
);
204 page
= (int)(addr
>> this->page_shift
);
205 page
&= this->page_mask
;
209 /* NOTE: The setting order of the registers is very important! */
210 if (cmd
== ONENAND_CMD_BUFFERRAM
) {
211 /* Select DataRAM for DDP */
212 value
= onenand_bufferram_address(this->device_id
, block
);
213 this->write_word(value
,
214 this->base
+ ONENAND_REG_START_ADDRESS2
);
216 /* Switch to the next data buffer */
217 ONENAND_SET_NEXT_BUFFERRAM(this);
223 /* Write 'DFS, FBA' of Flash */
224 value
= onenand_block_address(this->device_id
, block
);
225 this->write_word(value
,
226 this->base
+ ONENAND_REG_START_ADDRESS1
);
233 case ONENAND_CMD_READ
:
234 case ONENAND_CMD_READOOB
:
235 dataram
= ONENAND_SET_NEXT_BUFFERRAM(this);
240 dataram
= ONENAND_CURRENT_BUFFERRAM(this);
244 /* Write 'FPA, FSA' of Flash */
245 value
= onenand_page_address(page
, sectors
);
246 this->write_word(value
,
247 this->base
+ ONENAND_REG_START_ADDRESS8
);
249 /* Write 'BSA, BSC' of DataRAM */
250 value
= onenand_buffer_address(dataram
, sectors
, count
);
251 this->write_word(value
, this->base
+ ONENAND_REG_START_BUFFER
);
254 /* Select DataRAM for DDP */
256 onenand_bufferram_address(this->device_id
, block
);
257 this->write_word(value
,
259 ONENAND_REG_START_ADDRESS2
);
263 /* Interrupt clear */
264 this->write_word(ONENAND_INT_CLEAR
, this->base
+ ONENAND_REG_INTERRUPT
);
266 this->write_word(cmd
, this->base
+ ONENAND_REG_COMMAND
);
272 * onenand_wait - [DEFAULT] wait until the command is done
273 * @param mtd MTD device structure
274 * @param state state to select the max. timeout value
276 * Wait for command done. This applies to all OneNAND command
277 * Read can take up to 30us, erase up to 2ms and program up to 350us
278 * according to general OneNAND specs
280 static int onenand_wait(struct mtd_info
*mtd
, int state
)
282 struct onenand_chip
*this = mtd
->priv
;
283 unsigned int flags
= ONENAND_INT_MASTER
;
284 unsigned int interrupt
= 0;
285 unsigned int ctrl
, ecc
;
288 interrupt
= this->read_word(this->base
+ ONENAND_REG_INTERRUPT
);
289 if (interrupt
& flags
)
293 ctrl
= this->read_word(this->base
+ ONENAND_REG_CTRL_STATUS
);
295 if (ctrl
& ONENAND_CTRL_ERROR
) {
296 DEBUG(MTD_DEBUG_LEVEL0
,
297 "onenand_wait: controller error = 0x%04x\n", ctrl
);
301 if (ctrl
& ONENAND_CTRL_LOCK
) {
302 DEBUG(MTD_DEBUG_LEVEL0
,
303 "onenand_wait: it's locked error = 0x%04x\n", ctrl
);
307 if (interrupt
& ONENAND_INT_READ
) {
308 ecc
= this->read_word(this->base
+ ONENAND_REG_ECC_STATUS
);
309 if (ecc
& ONENAND_ECC_2BIT_ALL
) {
310 DEBUG(MTD_DEBUG_LEVEL0
,
311 "onenand_wait: ECC error = 0x%04x\n", ecc
);
320 * onenand_bufferram_offset - [DEFAULT] BufferRAM offset
321 * @param mtd MTD data structure
322 * @param area BufferRAM area
323 * @return offset given area
325 * Return BufferRAM offset given area
327 static inline int onenand_bufferram_offset(struct mtd_info
*mtd
, int area
)
329 struct onenand_chip
*this = mtd
->priv
;
331 if (ONENAND_CURRENT_BUFFERRAM(this)) {
332 if (area
== ONENAND_DATARAM
)
333 return mtd
->oobblock
;
334 if (area
== ONENAND_SPARERAM
)
342 * onenand_read_bufferram - [OneNAND Interface] Read the bufferram area
343 * @param mtd MTD data structure
344 * @param area BufferRAM area
345 * @param buffer the databuffer to put/get data
346 * @param offset offset to read from or write to
347 * @param count number of bytes to read/write
349 * Read the BufferRAM area
351 static int onenand_read_bufferram(struct mtd_info
*mtd
, int area
,
352 unsigned char *buffer
, int offset
,
355 struct onenand_chip
*this = mtd
->priv
;
356 void __iomem
*bufferram
;
358 bufferram
= this->base
+ area
;
359 bufferram
+= onenand_bufferram_offset(mtd
, area
);
361 memcpy_16(buffer
, bufferram
+ offset
, count
);
367 * onenand_sync_read_bufferram - [OneNAND Interface] Read the bufferram area with Sync. Burst mode
368 * @param mtd MTD data structure
369 * @param area BufferRAM area
370 * @param buffer the databuffer to put/get data
371 * @param offset offset to read from or write to
372 * @param count number of bytes to read/write
374 * Read the BufferRAM area with Sync. Burst Mode
376 static int onenand_sync_read_bufferram(struct mtd_info
*mtd
, int area
,
377 unsigned char *buffer
, int offset
,
380 struct onenand_chip
*this = mtd
->priv
;
381 void __iomem
*bufferram
;
383 bufferram
= this->base
+ area
;
384 bufferram
+= onenand_bufferram_offset(mtd
, area
);
386 this->mmcontrol(mtd
, ONENAND_SYS_CFG1_SYNC_READ
);
388 memcpy_16(buffer
, bufferram
+ offset
, count
);
390 this->mmcontrol(mtd
, 0);
396 * onenand_write_bufferram - [OneNAND Interface] Write the bufferram area
397 * @param mtd MTD data structure
398 * @param area BufferRAM area
399 * @param buffer the databuffer to put/get data
400 * @param offset offset to read from or write to
401 * @param count number of bytes to read/write
403 * Write the BufferRAM area
405 static int onenand_write_bufferram(struct mtd_info
*mtd
, int area
,
406 const unsigned char *buffer
, int offset
,
409 struct onenand_chip
*this = mtd
->priv
;
410 void __iomem
*bufferram
;
412 bufferram
= this->base
+ area
;
413 bufferram
+= onenand_bufferram_offset(mtd
, area
);
415 memcpy_16(bufferram
+ offset
, buffer
, count
);
421 * onenand_check_bufferram - [GENERIC] Check BufferRAM information
422 * @param mtd MTD data structure
423 * @param addr address to check
424 * @return 1 if there are valid data, otherwise 0
426 * Check bufferram if there is data we required
428 static int onenand_check_bufferram(struct mtd_info
*mtd
, loff_t addr
)
430 struct onenand_chip
*this = mtd
->priv
;
434 block
= (int)(addr
>> this->erase_shift
);
435 page
= (int)(addr
>> this->page_shift
);
436 page
&= this->page_mask
;
438 i
= ONENAND_CURRENT_BUFFERRAM(this);
440 /* Is there valid data? */
441 if (this->bufferram
[i
].block
== block
&&
442 this->bufferram
[i
].page
== page
&& this->bufferram
[i
].valid
)
449 * onenand_update_bufferram - [GENERIC] Update BufferRAM information
450 * @param mtd MTD data structure
451 * @param addr address to update
452 * @param valid valid flag
454 * Update BufferRAM information
456 static int onenand_update_bufferram(struct mtd_info
*mtd
, loff_t addr
,
459 struct onenand_chip
*this = mtd
->priv
;
463 block
= (int)(addr
>> this->erase_shift
);
464 page
= (int)(addr
>> this->page_shift
);
465 page
&= this->page_mask
;
467 /* Invalidate BufferRAM */
468 for (i
= 0; i
< MAX_BUFFERRAM
; i
++) {
469 if (this->bufferram
[i
].block
== block
&&
470 this->bufferram
[i
].page
== page
)
471 this->bufferram
[i
].valid
= 0;
474 /* Update BufferRAM */
475 i
= ONENAND_CURRENT_BUFFERRAM(this);
476 this->bufferram
[i
].block
= block
;
477 this->bufferram
[i
].page
= page
;
478 this->bufferram
[i
].valid
= valid
;
484 * onenand_get_device - [GENERIC] Get chip for selected access
485 * @param mtd MTD device structure
486 * @param new_state the state which is requested
488 * Get the device and lock it for exclusive access
490 static void onenand_get_device(struct mtd_info
*mtd
, int new_state
)
496 * onenand_release_device - [GENERIC] release chip
497 * @param mtd MTD device structure
499 * Deselect, release chip lock and wake up anyone waiting on the device
501 static void onenand_release_device(struct mtd_info
*mtd
)
507 * onenand_read_ecc - [MTD Interface] Read data with ECC
508 * @param mtd MTD device structure
509 * @param from offset to read from
510 * @param len number of bytes to read
511 * @param retlen pointer to variable to store the number of read bytes
512 * @param buf the databuffer to put data
513 * @param oob_buf filesystem supplied oob data buffer
514 * @param oobsel oob selection structure
516 * OneNAND read with ECC
518 static int onenand_read_ecc(struct mtd_info
*mtd
, loff_t from
, size_t len
,
519 size_t * retlen
, u_char
* buf
,
520 u_char
* oob_buf
, struct nand_oobinfo
*oobsel
)
522 struct onenand_chip
*this = mtd
->priv
;
523 int read
= 0, column
;
527 DEBUG(MTD_DEBUG_LEVEL3
, "onenand_read_ecc: from = 0x%08x, len = %i\n",
528 (unsigned int)from
, (int)len
);
530 /* Do not allow reads past end of device */
531 if ((from
+ len
) > mtd
->size
) {
532 DEBUG(MTD_DEBUG_LEVEL0
,
533 "onenand_read_ecc: Attempt read beyond end of device\n");
538 /* Grab the lock and see if the device is available */
539 onenand_get_device(mtd
, FL_READING
);
542 thislen
= min_t(int, mtd
->oobblock
, len
- read
);
544 column
= from
& (mtd
->oobblock
- 1);
545 if (column
+ thislen
> mtd
->oobblock
)
546 thislen
= mtd
->oobblock
- column
;
548 if (!onenand_check_bufferram(mtd
, from
)) {
549 this->command(mtd
, ONENAND_CMD_READ
, from
,
551 ret
= this->wait(mtd
, FL_READING
);
552 /* First copy data and check return value for ECC handling */
553 onenand_update_bufferram(mtd
, from
, 1);
556 this->read_bufferram(mtd
, ONENAND_DATARAM
, buf
, column
,
564 DEBUG(MTD_DEBUG_LEVEL0
,
565 "onenand_read_ecc: read failed = %d\n", ret
);
573 /* Deselect and wake up anyone waiting on the device */
574 onenand_release_device(mtd
);
577 * Return success, if no ECC failures, else -EBADMSG
578 * fs driver will take care of that, because
579 * retlen == desired len and result == -EBADMSG
586 * onenand_read - [MTD Interface] MTD compability function for onenand_read_ecc
587 * @param mtd MTD device structure
588 * @param from offset to read from
589 * @param len number of bytes to read
590 * @param retlen pointer to variable to store the number of read bytes
591 * @param buf the databuffer to put data
593 * This function simply calls onenand_read_ecc with oob buffer and oobsel = NULL
595 int onenand_read(struct mtd_info
*mtd
, loff_t from
, size_t len
,
596 size_t * retlen
, u_char
* buf
)
598 return onenand_read_ecc(mtd
, from
, len
, retlen
, buf
, NULL
, NULL
);
602 * onenand_read_oob - [MTD Interface] OneNAND read out-of-band
603 * @param mtd MTD device structure
604 * @param from offset to read from
605 * @param len number of bytes to read
606 * @param retlen pointer to variable to store the number of read bytes
607 * @param buf the databuffer to put data
609 * OneNAND read out-of-band data from the spare area
611 int onenand_read_oob(struct mtd_info
*mtd
, loff_t from
, size_t len
,
612 size_t * retlen
, u_char
* buf
)
614 struct onenand_chip
*this = mtd
->priv
;
615 int read
= 0, thislen
, column
;
618 DEBUG(MTD_DEBUG_LEVEL3
, "onenand_read_oob: from = 0x%08x, len = %i\n",
619 (unsigned int)from
, (int)len
);
621 /* Initialize return length value */
624 /* Do not allow reads past end of device */
625 if (unlikely((from
+ len
) > mtd
->size
)) {
626 DEBUG(MTD_DEBUG_LEVEL0
,
627 "onenand_read_oob: Attempt read beyond end of device\n");
631 /* Grab the lock and see if the device is available */
632 onenand_get_device(mtd
, FL_READING
);
634 column
= from
& (mtd
->oobsize
- 1);
637 thislen
= mtd
->oobsize
- column
;
638 thislen
= min_t(int, thislen
, len
);
640 this->command(mtd
, ONENAND_CMD_READOOB
, from
, mtd
->oobsize
);
642 onenand_update_bufferram(mtd
, from
, 0);
644 ret
= this->wait(mtd
, FL_READING
);
645 /* First copy data and check return value for ECC handling */
647 this->read_bufferram(mtd
, ONENAND_SPARERAM
, buf
, column
,
655 DEBUG(MTD_DEBUG_LEVEL0
,
656 "onenand_read_oob: read failed = %d\n", ret
);
664 from
+= mtd
->oobblock
;
669 /* Deselect and wake up anyone waiting on the device */
670 onenand_release_device(mtd
);
676 #ifdef CONFIG_MTD_ONENAND_VERIFY_WRITE
678 * onenand_verify_page - [GENERIC] verify the chip contents after a write
679 * @param mtd MTD device structure
680 * @param buf the databuffer to verify
681 * @param block block address
682 * @param page page address
684 * Check DataRAM area directly
686 static int onenand_verify_page(struct mtd_info
*mtd
, u_char
* buf
,
687 loff_t addr
, int block
, int page
)
689 struct onenand_chip
*this = mtd
->priv
;
690 void __iomem
*dataram0
, *dataram1
;
693 this->command(mtd
, ONENAND_CMD_READ
, addr
, mtd
->oobblock
);
695 ret
= this->wait(mtd
, FL_READING
);
699 onenand_update_bufferram(mtd
, addr
, 1);
701 /* Check, if the two dataram areas are same */
702 dataram0
= this->base
+ ONENAND_DATARAM
;
703 dataram1
= dataram0
+ mtd
->oobblock
;
705 if (memcmp(dataram0
, dataram1
, mtd
->oobblock
))
711 #define onenand_verify_page(...) (0)
714 #define NOTALIGNED(x) ((x & (mtd->oobblock - 1)) != 0)
717 * onenand_write_ecc - [MTD Interface] OneNAND write with ECC
718 * @param mtd MTD device structure
719 * @param to offset to write to
720 * @param len number of bytes to write
721 * @param retlen pointer to variable to store the number of written bytes
722 * @param buf the data to write
723 * @param eccbuf filesystem supplied oob data buffer
724 * @param oobsel oob selection structure
726 * OneNAND write with ECC
728 static int onenand_write_ecc(struct mtd_info
*mtd
, loff_t to
, size_t len
,
729 size_t * retlen
, const u_char
* buf
,
730 u_char
* eccbuf
, struct nand_oobinfo
*oobsel
)
732 struct onenand_chip
*this = mtd
->priv
;
736 DEBUG(MTD_DEBUG_LEVEL3
, "onenand_write_ecc: to = 0x%08x, len = %i\n",
737 (unsigned int)to
, (int)len
);
739 /* Initialize retlen, in case of early exit */
742 /* Do not allow writes past end of device */
743 if (unlikely((to
+ len
) > mtd
->size
)) {
744 DEBUG(MTD_DEBUG_LEVEL0
,
745 "onenand_write_ecc: Attempt write to past end of device\n");
749 /* Reject writes, which are not page aligned */
750 if (unlikely(NOTALIGNED(to
)) || unlikely(NOTALIGNED(len
))) {
751 DEBUG(MTD_DEBUG_LEVEL0
,
752 "onenand_write_ecc: Attempt to write not page aligned data\n");
756 /* Grab the lock and see if the device is available */
757 onenand_get_device(mtd
, FL_WRITING
);
759 /* Loop until all data write */
760 while (written
< len
) {
761 int thislen
= min_t(int, mtd
->oobblock
, len
- written
);
763 this->command(mtd
, ONENAND_CMD_BUFFERRAM
, to
, mtd
->oobblock
);
765 this->write_bufferram(mtd
, ONENAND_DATARAM
, buf
, 0, thislen
);
766 this->write_bufferram(mtd
, ONENAND_SPARERAM
, ffchars
, 0,
769 this->command(mtd
, ONENAND_CMD_PROG
, to
, mtd
->oobblock
);
771 onenand_update_bufferram(mtd
, to
, 1);
773 ret
= this->wait(mtd
, FL_WRITING
);
775 DEBUG(MTD_DEBUG_LEVEL0
,
776 "onenand_write_ecc: write filaed %d\n", ret
);
782 /* Only check verify write turn on */
783 ret
= onenand_verify_page(mtd
, (u_char
*) buf
, to
, block
, page
);
785 DEBUG(MTD_DEBUG_LEVEL0
,
786 "onenand_write_ecc: verify failed %d\n", ret
);
797 /* Deselect and wake up anyone waiting on the device */
798 onenand_release_device(mtd
);
806 * onenand_write - [MTD Interface] compability function for onenand_write_ecc
807 * @param mtd MTD device structure
808 * @param to offset to write to
809 * @param len number of bytes to write
810 * @param retlen pointer to variable to store the number of written bytes
811 * @param buf the data to write
813 * This function simply calls onenand_write_ecc
814 * with oob buffer and oobsel = NULL
816 int onenand_write(struct mtd_info
*mtd
, loff_t to
, size_t len
,
817 size_t * retlen
, const u_char
* buf
)
819 return onenand_write_ecc(mtd
, to
, len
, retlen
, buf
, NULL
, NULL
);
823 * onenand_write_oob - [MTD Interface] OneNAND write out-of-band
824 * @param mtd MTD device structure
825 * @param to offset to write to
826 * @param len number of bytes to write
827 * @param retlen pointer to variable to store the number of written bytes
828 * @param buf the data to write
830 * OneNAND write out-of-band
832 int onenand_write_oob(struct mtd_info
*mtd
, loff_t to
, size_t len
,
833 size_t * retlen
, const u_char
* buf
)
835 struct onenand_chip
*this = mtd
->priv
;
839 DEBUG(MTD_DEBUG_LEVEL3
, "onenand_write_oob: to = 0x%08x, len = %i\n",
840 (unsigned int)to
, (int)len
);
842 /* Initialize retlen, in case of early exit */
845 /* Do not allow writes past end of device */
846 if (unlikely((to
+ len
) > mtd
->size
)) {
847 DEBUG(MTD_DEBUG_LEVEL0
,
848 "onenand_write_oob: Attempt write to past end of device\n");
852 /* Grab the lock and see if the device is available */
853 onenand_get_device(mtd
, FL_WRITING
);
855 /* Loop until all data write */
856 while (written
< len
) {
857 int thislen
= min_t(int, mtd
->oobsize
, len
- written
);
859 column
= to
& (mtd
->oobsize
- 1);
861 this->command(mtd
, ONENAND_CMD_BUFFERRAM
, to
, mtd
->oobsize
);
863 this->write_bufferram(mtd
, ONENAND_SPARERAM
, ffchars
, 0,
865 this->write_bufferram(mtd
, ONENAND_SPARERAM
, buf
, column
,
868 this->command(mtd
, ONENAND_CMD_PROGOOB
, to
, mtd
->oobsize
);
870 onenand_update_bufferram(mtd
, to
, 0);
872 status
= this->wait(mtd
, FL_WRITING
);
884 /* Deselect and wake up anyone waiting on the device */
885 onenand_release_device(mtd
);
893 * onenand_erase - [MTD Interface] erase block(s)
894 * @param mtd MTD device structure
895 * @param instr erase instruction
897 * Erase one ore more blocks
899 int onenand_erase(struct mtd_info
*mtd
, struct erase_info
*instr
)
901 struct onenand_chip
*this = mtd
->priv
;
902 unsigned int block_size
;
907 DEBUG(MTD_DEBUG_LEVEL3
, "onenand_erase: start = 0x%08x, len = %i\n",
908 (unsigned int)instr
->addr
, (unsigned int)instr
->len
);
910 block_size
= (1 << this->erase_shift
);
912 /* Start address must align on block boundary */
913 if (unlikely(instr
->addr
& (block_size
- 1))) {
914 DEBUG(MTD_DEBUG_LEVEL0
, "onenand_erase: Unaligned address\n");
918 /* Length must align on block boundary */
919 if (unlikely(instr
->len
& (block_size
- 1))) {
920 DEBUG(MTD_DEBUG_LEVEL0
,
921 "onenand_erase: Length not block aligned\n");
925 /* Do not allow erase past end of device */
926 if (unlikely((instr
->len
+ instr
->addr
) > mtd
->size
)) {
927 DEBUG(MTD_DEBUG_LEVEL0
,
928 "onenand_erase: Erase past end of device\n");
932 instr
->fail_addr
= 0xffffffff;
934 /* Grab the lock and see if the device is available */
935 onenand_get_device(mtd
, FL_ERASING
);
937 /* Loop throught the pages */
941 instr
->state
= MTD_ERASING
;
945 /* TODO Check badblock */
947 this->command(mtd
, ONENAND_CMD_ERASE
, addr
, block_size
);
949 ret
= this->wait(mtd
, FL_ERASING
);
950 /* Check, if it is write protected */
953 DEBUG(MTD_DEBUG_LEVEL0
,
954 "onenand_erase: Device is write protected!!!\n");
956 DEBUG(MTD_DEBUG_LEVEL0
,
957 "onenand_erase: Failed erase, block %d\n",
958 (unsigned)(addr
>> this->erase_shift
));
959 instr
->state
= MTD_ERASE_FAILED
;
960 instr
->fail_addr
= addr
;
968 instr
->state
= MTD_ERASE_DONE
;
972 ret
= instr
->state
== MTD_ERASE_DONE
? 0 : -EIO
;
973 /* Do call back function */
975 mtd_erase_callback(instr
);
977 /* Deselect and wake up anyone waiting on the device */
978 onenand_release_device(mtd
);
984 * onenand_sync - [MTD Interface] sync
985 * @param mtd MTD device structure
987 * Sync is actually a wait for chip ready function
989 void onenand_sync(struct mtd_info
*mtd
)
991 DEBUG(MTD_DEBUG_LEVEL3
, "onenand_sync: called\n");
993 /* Grab the lock and see if the device is available */
994 onenand_get_device(mtd
, FL_SYNCING
);
996 /* Release it and go back */
997 onenand_release_device(mtd
);
1001 * onenand_block_isbad - [MTD Interface] Check whether the block at the given offset is bad
1002 * @param mtd MTD device structure
1003 * @param ofs offset relative to mtd start
1005 int onenand_block_isbad(struct mtd_info
*mtd
, loff_t ofs
)
1009 * 1. Bad block table (BBT)
1010 * -> using NAND BBT to support JFFS2
1011 * 2. Bad block management (BBM)
1012 * -> bad block replace scheme
1014 * Currently we do nothing
1020 * onenand_block_markbad - [MTD Interface] Mark the block at the given offset as bad
1021 * @param mtd MTD device structure
1022 * @param ofs offset relative to mtd start
1024 int onenand_block_markbad(struct mtd_info
*mtd
, loff_t ofs
)
1031 * onenand_unlock - [MTD Interface] Unlock block(s)
1032 * @param mtd MTD device structure
1033 * @param ofs offset relative to mtd start
1034 * @param len number of bytes to unlock
1036 * Unlock one or more blocks
1038 int onenand_unlock(struct mtd_info
*mtd
, loff_t ofs
, size_t len
)
1040 struct onenand_chip
*this = mtd
->priv
;
1041 int start
, end
, block
, value
, status
;
1043 start
= ofs
>> this->erase_shift
;
1044 end
= len
>> this->erase_shift
;
1046 /* Continuous lock scheme */
1047 if (this->options
& ONENAND_CONT_LOCK
) {
1048 /* Set start block address */
1049 this->write_word(start
,
1050 this->base
+ ONENAND_REG_START_BLOCK_ADDRESS
);
1051 /* Set end block address */
1052 this->write_word(end
- 1,
1053 this->base
+ ONENAND_REG_END_BLOCK_ADDRESS
);
1054 /* Write unlock command */
1055 this->command(mtd
, ONENAND_CMD_UNLOCK
, 0, 0);
1057 /* There's no return value */
1058 this->wait(mtd
, FL_UNLOCKING
);
1061 while (this->read_word(this->base
+ ONENAND_REG_CTRL_STATUS
)
1062 & ONENAND_CTRL_ONGO
)
1065 /* Check lock status */
1066 status
= this->read_word(this->base
+ ONENAND_REG_WP_STATUS
);
1067 if (!(status
& ONENAND_WP_US
))
1068 printk(KERN_ERR
"wp status = 0x%x\n", status
);
1073 /* Block lock scheme */
1074 for (block
= start
; block
< end
; block
++) {
1075 /* Set start block address */
1076 this->write_word(block
,
1077 this->base
+ ONENAND_REG_START_BLOCK_ADDRESS
);
1078 /* Write unlock command */
1079 this->command(mtd
, ONENAND_CMD_UNLOCK
, 0, 0);
1081 /* There's no return value */
1082 this->wait(mtd
, FL_UNLOCKING
);
1085 while (this->read_word(this->base
+ ONENAND_REG_CTRL_STATUS
)
1086 & ONENAND_CTRL_ONGO
)
1089 /* Set block address for read block status */
1090 value
= onenand_block_address(this->device_id
, block
);
1091 this->write_word(value
,
1092 this->base
+ ONENAND_REG_START_ADDRESS1
);
1094 /* Check lock status */
1095 status
= this->read_word(this->base
+ ONENAND_REG_WP_STATUS
);
1096 if (!(status
& ONENAND_WP_US
))
1097 printk(KERN_ERR
"block = %d, wp status = 0x%x\n",
1105 * onenand_print_device_info - Print device ID
1106 * @param device device ID
1110 void onenand_print_device_info(int device
, int verbose
)
1112 int vcc
, demuxed
, ddp
, density
;
1117 vcc
= device
& ONENAND_DEVICE_VCC_MASK
;
1118 demuxed
= device
& ONENAND_DEVICE_IS_DEMUX
;
1119 ddp
= device
& ONENAND_DEVICE_IS_DDP
;
1120 density
= device
>> ONENAND_DEVICE_DENSITY_SHIFT
;
1121 printk(KERN_INFO
"%sOneNAND%s %dMB %sV 16-bit (0x%02x)\n",
1122 demuxed
? "" : "Muxed ",
1124 (16 << density
), vcc
? "2.65/3.3" : "1.8", device
);
1127 static const struct onenand_manufacturers onenand_manuf_ids
[] = {
1128 {ONENAND_MFR_SAMSUNG
, "Samsung"},
1129 {ONENAND_MFR_UNKNOWN
, "Unknown"}
1133 * onenand_check_maf - Check manufacturer ID
1134 * @param manuf manufacturer ID
1136 * Check manufacturer ID
1138 static int onenand_check_maf(int manuf
)
1142 for (i
= 0; onenand_manuf_ids
[i
].id
; i
++) {
1143 if (manuf
== onenand_manuf_ids
[i
].id
)
1147 #ifdef ONENAND_DEBUG
1148 printk(KERN_DEBUG
"OneNAND Manufacturer: %s (0x%0x)\n",
1149 onenand_manuf_ids
[i
].name
, manuf
);
1152 return (i
!= ONENAND_MFR_UNKNOWN
);
1156 * onenand_probe - [OneNAND Interface] Probe the OneNAND device
1157 * @param mtd MTD device structure
1159 * OneNAND detection method:
1160 * Compare the the values from command with ones from register
1162 static int onenand_probe(struct mtd_info
*mtd
)
1164 struct onenand_chip
*this = mtd
->priv
;
1165 int bram_maf_id
, bram_dev_id
, maf_id
, dev_id
;
1169 /* Send the command for reading device ID from BootRAM */
1170 this->write_word(ONENAND_CMD_READID
, this->base
+ ONENAND_BOOTRAM
);
1172 /* Read manufacturer and device IDs from BootRAM */
1173 bram_maf_id
= this->read_word(this->base
+ ONENAND_BOOTRAM
+ 0x0);
1174 bram_dev_id
= this->read_word(this->base
+ ONENAND_BOOTRAM
+ 0x2);
1176 /* Check manufacturer ID */
1177 if (onenand_check_maf(bram_maf_id
))
1180 /* Reset OneNAND to read default register values */
1181 this->write_word(ONENAND_CMD_RESET
, this->base
+ ONENAND_BOOTRAM
);
1185 for (i
= 0; i
< 10000; i
++) ;
1188 /* Read manufacturer and device IDs from Register */
1189 maf_id
= this->read_word(this->base
+ ONENAND_REG_MANUFACTURER_ID
);
1190 dev_id
= this->read_word(this->base
+ ONENAND_REG_DEVICE_ID
);
1192 /* Check OneNAND device */
1193 if (maf_id
!= bram_maf_id
|| dev_id
!= bram_dev_id
)
1196 /* FIXME : Current OneNAND MTD doesn't support Flex-OneNAND */
1197 if (dev_id
& (1 << 9)) {
1198 printk("Not yet support Flex-OneNAND\n");
1202 /* Flash device information */
1203 onenand_print_device_info(dev_id
, 0);
1204 this->device_id
= dev_id
;
1206 density
= dev_id
>> ONENAND_DEVICE_DENSITY_SHIFT
;
1207 this->chipsize
= (16 << density
) << 20;
1209 /* OneNAND page size & block size */
1210 /* The data buffer size is equal to page size */
1212 this->read_word(this->base
+ ONENAND_REG_DATA_BUFFER_SIZE
);
1213 mtd
->oobsize
= mtd
->oobblock
>> 5;
1214 /* Pagers per block is always 64 in OneNAND */
1215 mtd
->erasesize
= mtd
->oobblock
<< 6;
1217 this->erase_shift
= ffs(mtd
->erasesize
) - 1;
1218 this->page_shift
= ffs(mtd
->oobblock
) - 1;
1219 this->ppb_shift
= (this->erase_shift
- this->page_shift
);
1220 this->page_mask
= (mtd
->erasesize
/ mtd
->oobblock
) - 1;
1222 /* REVIST: Multichip handling */
1224 mtd
->size
= this->chipsize
;
1227 version_id
= this->read_word(this->base
+ ONENAND_REG_VERSION_ID
);
1228 #ifdef ONENAND_DEBUG
1229 printk(KERN_DEBUG
"OneNAND version = 0x%04x\n", version_id
);
1233 if (density
<= ONENAND_DEVICE_DENSITY_512Mb
&&
1234 !(version_id
>> ONENAND_VERSION_PROCESS_SHIFT
)) {
1235 printk(KERN_INFO
"Lock scheme is Continues Lock\n");
1236 this->options
|= ONENAND_CONT_LOCK
;
1243 * onenand_scan - [OneNAND Interface] Scan for the OneNAND device
1244 * @param mtd MTD device structure
1245 * @param maxchips Number of chips to scan for
1247 * This fills out all the not initialized function pointers
1248 * with the defaults.
1249 * The flash ID is read and the mtd/chip structures are
1250 * filled with the appropriate values.
1252 int onenand_scan(struct mtd_info
*mtd
, int maxchips
)
1254 struct onenand_chip
*this = mtd
->priv
;
1256 if (!this->read_word
)
1257 this->read_word
= onenand_readw
;
1258 if (!this->write_word
)
1259 this->write_word
= onenand_writew
;
1262 this->command
= onenand_command
;
1264 this->wait
= onenand_wait
;
1266 if (!this->read_bufferram
)
1267 this->read_bufferram
= onenand_read_bufferram
;
1268 if (!this->write_bufferram
)
1269 this->write_bufferram
= onenand_write_bufferram
;
1271 if (onenand_probe(mtd
))
1274 /* Set Sync. Burst Read after probing */
1275 if (this->mmcontrol
) {
1276 printk(KERN_INFO
"OneNAND Sync. Burst Read support\n");
1277 this->read_bufferram
= onenand_sync_read_bufferram
;
1280 onenand_unlock(mtd
, 0, mtd
->size
);
1282 return onenand_default_bbt(mtd
);
1286 * onenand_release - [OneNAND Interface] Free resources held by the OneNAND device
1287 * @param mtd MTD device structure
1289 void onenand_release(struct mtd_info
*mtd
)
1293 #endif /* CONFIG_CMD_ONENAND */