2 * Copyright 2004-2007 Freescale Semiconductor, Inc. All Rights Reserved.
3 * Copyright 2008 Sascha Hauer, kernel@pengutronix.de
4 * Copyright 2009 Ilya Yanok, <yanok@emcraft.com>
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
23 #include <linux/err.h>
26 #include <asm/arch/imx-regs.h>
29 #define DRIVER_NAME "mxc_nand"
32 /* NFC RAM BUFFER Main area 0 */
33 uint8_t main_area0[0x200];
34 uint8_t main_area1[0x200];
35 uint8_t main_area2[0x200];
36 uint8_t main_area3[0x200];
37 /* SPARE BUFFER Spare area 0 */
38 uint8_t spare_area0[0x10];
39 uint8_t spare_area1[0x10];
40 uint8_t spare_area2[0x10];
41 uint8_t spare_area3[0x10];
44 uint16_t nfc_buf_size;
46 uint16_t nfc_buf_addr;
47 uint16_t nfc_flash_addr;
48 uint16_t nfc_flash_cmd;
50 uint16_t nfc_ecc_status_result;
51 uint16_t nfc_rsltmain_area;
52 uint16_t nfc_rsltspare_area;
54 uint16_t nfc_unlockstart_blkaddr;
55 uint16_t nfc_unlockend_blkaddr;
56 uint16_t nfc_nf_wrprst;
62 * Set INT to 0, FCMD to 1, rest to 0 in NFC_CONFIG2 Register
63 * for Command operation
68 * Set INT to 0, FADD to 1, rest to 0 in NFC_CONFIG2 Register
69 * for Address operation
74 * Set INT to 0, FDI to 1, rest to 0 in NFC_CONFIG2 Register
80 * Set INT to 0, FDO to 001, rest to 0 in NFC_CONFIG2 Register
81 * for Data Output operation
83 #define NFC_OUTPUT 0x8
86 * Set INT to 0, FD0 to 010, rest to 0 in NFC_CONFIG2 Register
87 * for Read ID operation
92 * Set INT to 0, FDO to 100, rest to 0 in NFC_CONFIG2 Register
93 * for Read Status operation
95 #define NFC_STATUS 0x20
98 * Set INT to 1, rest to 0 in NFC_CONFIG2 Register for Read
101 #define NFC_INT 0x8000
103 #define NFC_SP_EN (1 << 2)
104 #define NFC_ECC_EN (1 << 3)
105 #define NFC_BIG (1 << 5)
106 #define NFC_RST (1 << 6)
107 #define NFC_CE (1 << 7)
108 #define NFC_ONE_CYCLE (1 << 8)
110 typedef enum {false, true} bool;
112 struct mxc_nand_host {
114 struct nand_chip *nand;
116 struct nfc_regs __iomem *regs;
124 static struct mxc_nand_host mxc_host;
125 static struct mxc_nand_host *host = &mxc_host;
127 /* Define delays in microsec for NAND device operations */
128 #define TROP_US_DELAY 2000
129 /* Macros to get byte and bit positions of ECC */
130 #define COLPOS(x) ((x) >> 3)
131 #define BITPOS(x) ((x) & 0xf)
133 /* Define single bit Error positions in Main & Spare area */
134 #define MAIN_SINGLEBIT_ERROR 0x4
135 #define SPARE_SINGLEBIT_ERROR 0x1
137 /* OOB placement block for use with hardware ecc generation */
138 #ifdef CONFIG_MXC_NAND_HWECC
139 static struct nand_ecclayout nand_hw_eccoob = {
141 .eccpos = {6, 7, 8, 9, 10},
142 .oobfree = {{0, 5}, {11, 5}, }
145 static struct nand_ecclayout nand_soft_eccoob = {
147 .eccpos = {6, 7, 8, 9, 10, 11},
148 .oobfree = {{0, 5}, {12, 4}, }
152 static uint32_t *mxc_nand_memcpy32(uint32_t *dest, uint32_t *source, size_t size)
158 __raw_writel(__raw_readl(source++), d++);
163 * This function polls the NANDFC to wait for the basic operation to
164 * complete by checking the INT bit of config2 register.
166 static void wait_op_done(struct mxc_nand_host *host, int max_retries,
171 while (max_retries-- > 0) {
172 if (readw(&host->regs->nfc_config2) & NFC_INT) {
173 tmp = readw(&host->regs->nfc_config2);
175 writew(tmp, &host->regs->nfc_config2);
180 if (max_retries < 0) {
181 MTDDEBUG(MTD_DEBUG_LEVEL0, "%s(%d): INT not set\n",
187 * This function issues the specified command to the NAND device and
188 * waits for completion.
190 static void send_cmd(struct mxc_nand_host *host, uint16_t cmd)
192 MTDDEBUG(MTD_DEBUG_LEVEL3, "send_cmd(host, 0x%x)\n", cmd);
194 writew(cmd, &host->regs->nfc_flash_cmd);
195 writew(NFC_CMD, &host->regs->nfc_config2);
197 /* Wait for operation to complete */
198 wait_op_done(host, TROP_US_DELAY, cmd);
202 * This function sends an address (or partial address) to the
203 * NAND device. The address is used to select the source/destination for
206 static void send_addr(struct mxc_nand_host *host, uint16_t addr)
208 MTDDEBUG(MTD_DEBUG_LEVEL3, "send_addr(host, 0x%x)\n", addr);
210 writew(addr, &host->regs->nfc_flash_addr);
211 writew(NFC_ADDR, &host->regs->nfc_config2);
213 /* Wait for operation to complete */
214 wait_op_done(host, TROP_US_DELAY, addr);
218 * This function requests the NANDFC to initate the transfer
219 * of data currently in the NANDFC RAM buffer to the NAND device.
221 static void send_prog_page(struct mxc_nand_host *host, uint8_t buf_id,
224 MTDDEBUG(MTD_DEBUG_LEVEL3, "send_prog_page (%d)\n", spare_only);
226 writew(buf_id, &host->regs->nfc_buf_addr);
228 /* Configure spare or page+spare access */
229 if (!host->pagesize_2k) {
230 uint16_t config1 = readw(&host->regs->nfc_config1);
232 config1 |= NFC_SP_EN;
234 config1 &= ~(NFC_SP_EN);
235 writew(config1, &host->regs->nfc_config1);
238 writew(NFC_INPUT, &host->regs->nfc_config2);
240 /* Wait for operation to complete */
241 wait_op_done(host, TROP_US_DELAY, spare_only);
245 * Requests NANDFC to initated the transfer of data from the
246 * NAND device into in the NANDFC ram buffer.
248 static void send_read_page(struct mxc_nand_host *host, uint8_t buf_id,
251 MTDDEBUG(MTD_DEBUG_LEVEL3, "send_read_page (%d)\n", spare_only);
253 writew(buf_id, &host->regs->nfc_buf_addr);
255 /* Configure spare or page+spare access */
256 if (!host->pagesize_2k) {
257 uint32_t config1 = readw(&host->regs->nfc_config1);
259 config1 |= NFC_SP_EN;
261 config1 &= ~NFC_SP_EN;
262 writew(config1, &host->regs->nfc_config1);
265 writew(NFC_OUTPUT, &host->regs->nfc_config2);
267 /* Wait for operation to complete */
268 wait_op_done(host, TROP_US_DELAY, spare_only);
271 /* Request the NANDFC to perform a read of the NAND device ID. */
272 static void send_read_id(struct mxc_nand_host *host)
276 /* NANDFC buffer 0 is used for device ID output */
277 writew(0x0, &host->regs->nfc_buf_addr);
279 /* Read ID into main buffer */
280 tmp = readw(&host->regs->nfc_config1);
282 writew(tmp, &host->regs->nfc_config1);
284 writew(NFC_ID, &host->regs->nfc_config2);
286 /* Wait for operation to complete */
287 wait_op_done(host, TROP_US_DELAY, 0);
291 * This function requests the NANDFC to perform a read of the
292 * NAND device status and returns the current status.
294 static uint16_t get_dev_status(struct mxc_nand_host *host)
296 void __iomem *main_buf = host->regs->main_area1;
299 /* Issue status request to NAND device */
301 /* store the main area1 first word, later do recovery */
302 store = readl(main_buf);
303 /* NANDFC buffer 1 is used for device status */
304 writew(1, &host->regs->nfc_buf_addr);
306 /* Read status into main buffer */
307 tmp = readw(&host->regs->nfc_config1);
309 writew(tmp, &host->regs->nfc_config1);
311 writew(NFC_STATUS, &host->regs->nfc_config2);
313 /* Wait for operation to complete */
314 wait_op_done(host, TROP_US_DELAY, 0);
317 * Status is placed in first word of main buffer
318 * get status, then recovery area 1 data
320 ret = readw(main_buf);
321 writel(store, main_buf);
326 /* This function is used by upper layer to checks if device is ready */
327 static int mxc_nand_dev_ready(struct mtd_info *mtd)
330 * NFC handles R/B internally. Therefore, this function
331 * always returns status as ready.
336 #ifdef CONFIG_MXC_NAND_HWECC
337 static void mxc_nand_enable_hwecc(struct mtd_info *mtd, int mode)
340 * If HW ECC is enabled, we turn it on during init. There is
341 * no need to enable again here.
345 static int mxc_nand_correct_data(struct mtd_info *mtd, u_char *dat,
346 u_char *read_ecc, u_char *calc_ecc)
348 struct nand_chip *nand_chip = mtd->priv;
349 struct mxc_nand_host *host = nand_chip->priv;
352 * 1-Bit errors are automatically corrected in HW. No need for
353 * additional correction. 2-Bit errors cannot be corrected by
354 * HW ECC, so we need to return failure
356 uint16_t ecc_status = readw(&host->regs->nfc_ecc_status_result);
358 if (((ecc_status & 0x3) == 2) || ((ecc_status >> 2) == 2)) {
359 MTDDEBUG(MTD_DEBUG_LEVEL0,
360 "MXC_NAND: HWECC uncorrectable 2-bit ECC error\n");
367 static int mxc_nand_calculate_ecc(struct mtd_info *mtd, const u_char *dat,
374 static u_char mxc_nand_read_byte(struct mtd_info *mtd)
376 struct nand_chip *nand_chip = mtd->priv;
377 struct mxc_nand_host *host = nand_chip->priv;
380 uint16_t __iomem *main_buf =
381 (uint16_t __iomem *)host->regs->main_area0;
382 uint16_t __iomem *spare_buf =
383 (uint16_t __iomem *)host->regs->spare_area0;
389 /* Check for status request */
390 if (host->status_request)
391 return get_dev_status(host) & 0xFF;
393 /* Get column for 16-bit access */
394 col = host->col_addr >> 1;
396 /* If we are accessing the spare region */
397 if (host->spare_only)
398 nfc_word.word = readw(&spare_buf[col]);
400 nfc_word.word = readw(&main_buf[col]);
402 /* Pick upper/lower byte of word from RAM buffer */
403 ret = nfc_word.bytes[host->col_addr & 0x1];
405 /* Update saved column address */
406 if (nand_chip->options & NAND_BUSWIDTH_16)
414 static uint16_t mxc_nand_read_word(struct mtd_info *mtd)
416 struct nand_chip *nand_chip = mtd->priv;
417 struct mxc_nand_host *host = nand_chip->priv;
421 MTDDEBUG(MTD_DEBUG_LEVEL3,
422 "mxc_nand_read_word(col = %d)\n", host->col_addr);
424 col = host->col_addr;
425 /* Adjust saved column address */
426 if (col < mtd->writesize && host->spare_only)
427 col += mtd->writesize;
429 if (col < mtd->writesize) {
430 p = (uint16_t __iomem *)(host->regs->main_area0 + (col >> 1));
432 p = (uint16_t __iomem *)(host->regs->spare_area0 +
433 ((col - mtd->writesize) >> 1));
442 nfc_word[0].word = readw(p);
443 nfc_word[1].word = readw(p + 1);
445 nfc_word[2].bytes[0] = nfc_word[0].bytes[1];
446 nfc_word[2].bytes[1] = nfc_word[1].bytes[0];
448 ret = nfc_word[2].word;
453 /* Update saved column address */
454 host->col_addr = col + 2;
460 * Write data of length len to buffer buf. The data to be
461 * written on NAND Flash is first copied to RAMbuffer. After the Data Input
462 * Operation by the NFC, the data is written to NAND Flash
464 static void mxc_nand_write_buf(struct mtd_info *mtd,
465 const u_char *buf, int len)
467 struct nand_chip *nand_chip = mtd->priv;
468 struct mxc_nand_host *host = nand_chip->priv;
471 MTDDEBUG(MTD_DEBUG_LEVEL3,
472 "mxc_nand_write_buf(col = %d, len = %d)\n", host->col_addr,
475 col = host->col_addr;
477 /* Adjust saved column address */
478 if (col < mtd->writesize && host->spare_only)
479 col += mtd->writesize;
481 n = mtd->writesize + mtd->oobsize - col;
484 MTDDEBUG(MTD_DEBUG_LEVEL3,
485 "%s:%d: col = %d, n = %d\n", __func__, __LINE__, col, n);
490 if (col < mtd->writesize) {
491 p = host->regs->main_area0 + (col & ~3);
493 p = host->regs->spare_area0 -
494 mtd->writesize + (col & ~3);
497 MTDDEBUG(MTD_DEBUG_LEVEL3, "%s:%d: p = %p\n", __func__,
500 if (((col | (unsigned long)&buf[i]) & 3) || n < 4) {
506 nfc_word.word = readl(p);
507 nfc_word.bytes[col & 3] = buf[i++];
511 writel(nfc_word.word, p);
513 int m = mtd->writesize - col;
515 if (col >= mtd->writesize)
520 MTDDEBUG(MTD_DEBUG_LEVEL3,
521 "%s:%d: n = %d, m = %d, i = %d, col = %d\n",
522 __func__, __LINE__, n, m, i, col);
524 mxc_nand_memcpy32(p, (uint32_t *)&buf[i], m);
530 /* Update saved column address */
531 host->col_addr = col;
535 * Read the data buffer from the NAND Flash. To read the data from NAND
536 * Flash first the data output cycle is initiated by the NFC, which copies
537 * the data to RAMbuffer. This data of length len is then copied to buffer buf.
539 static void mxc_nand_read_buf(struct mtd_info *mtd, u_char *buf, int len)
541 struct nand_chip *nand_chip = mtd->priv;
542 struct mxc_nand_host *host = nand_chip->priv;
545 MTDDEBUG(MTD_DEBUG_LEVEL3,
546 "mxc_nand_read_buf(col = %d, len = %d)\n", host->col_addr, len);
548 col = host->col_addr;
550 /* Adjust saved column address */
551 if (col < mtd->writesize && host->spare_only)
552 col += mtd->writesize;
554 n = mtd->writesize + mtd->oobsize - col;
560 if (col < mtd->writesize) {
561 p = host->regs->main_area0 + (col & ~3);
563 p = host->regs->spare_area0 -
564 mtd->writesize + (col & ~3);
567 if (((col | (int)&buf[i]) & 3) || n < 4) {
573 nfc_word.word = readl(p);
574 buf[i++] = nfc_word.bytes[col & 3];
578 int m = mtd->writesize - col;
580 if (col >= mtd->writesize)
584 mxc_nand_memcpy32((uint32_t *)&buf[i], p, m);
591 /* Update saved column address */
592 host->col_addr = col;
596 * Used by the upper layer to verify the data in NAND Flash
597 * with the data in the buf.
599 static int mxc_nand_verify_buf(struct mtd_info *mtd,
600 const u_char *buf, int len)
606 bsize = min(len, 256);
607 mxc_nand_read_buf(mtd, tmp, bsize);
609 if (memcmp(buf, tmp, bsize))
620 * This function is used by upper layer for select and
621 * deselect of the NAND chip
623 static void mxc_nand_select_chip(struct mtd_info *mtd, int chip)
625 struct nand_chip *nand_chip = mtd->priv;
626 struct mxc_nand_host *host = nand_chip->priv;
630 /* TODO: Disable the NFC clock */
635 /* TODO: Enable the NFC clock */
646 * Used by the upper layer to write command to NAND Flash for
647 * different operations to be carried out on NAND Flash
649 static void mxc_nand_command(struct mtd_info *mtd, unsigned command,
650 int column, int page_addr)
652 struct nand_chip *nand_chip = mtd->priv;
653 struct mxc_nand_host *host = nand_chip->priv;
655 MTDDEBUG(MTD_DEBUG_LEVEL3,
656 "mxc_nand_command (cmd = 0x%x, col = 0x%x, page = 0x%x)\n",
657 command, column, page_addr);
659 /* Reset command state information */
660 host->status_request = false;
662 /* Command pre-processing step */
665 case NAND_CMD_STATUS:
667 host->status_request = true;
671 host->col_addr = column;
672 host->spare_only = false;
675 case NAND_CMD_READOOB:
676 host->col_addr = column;
677 host->spare_only = true;
678 if (host->pagesize_2k)
679 command = NAND_CMD_READ0; /* only READ0 is valid */
683 if (column >= mtd->writesize) {
685 * before sending SEQIN command for partial write,
686 * we need read one page out. FSL NFC does not support
687 * partial write. It alway send out 512+ecc+512+ecc ...
688 * for large page nand flash. But for small page nand
689 * flash, it does support SPARE ONLY operation.
691 if (host->pagesize_2k) {
692 /* call ourself to read a page */
693 mxc_nand_command(mtd, NAND_CMD_READ0, 0,
697 host->col_addr = column - mtd->writesize;
698 host->spare_only = true;
700 /* Set program pointer to spare region */
701 if (!host->pagesize_2k)
702 send_cmd(host, NAND_CMD_READOOB);
704 host->spare_only = false;
705 host->col_addr = column;
707 /* Set program pointer to page start */
708 if (!host->pagesize_2k)
709 send_cmd(host, NAND_CMD_READ0);
713 case NAND_CMD_PAGEPROG:
714 send_prog_page(host, 0, host->spare_only);
716 if (host->pagesize_2k) {
717 /* data in 4 areas datas */
718 send_prog_page(host, 1, host->spare_only);
719 send_prog_page(host, 2, host->spare_only);
720 send_prog_page(host, 3, host->spare_only);
726 /* Write out the command to the device. */
727 send_cmd(host, command);
729 /* Write out column address, if necessary */
732 * MXC NANDFC can only perform full page+spare or
733 * spare-only read/write. When the upper layers
734 * layers perform a read/write buf operation,
735 * we will used the saved column adress to index into
739 if (host->pagesize_2k)
740 /* another col addr cycle for 2k page */
744 /* Write out page address, if necessary */
745 if (page_addr != -1) {
746 /* paddr_0 - p_addr_7 */
747 send_addr(host, (page_addr & 0xff));
749 if (host->pagesize_2k) {
750 send_addr(host, (page_addr >> 8) & 0xFF);
751 if (mtd->size >= 0x10000000) {
752 /* paddr_8 - paddr_15 */
753 send_addr(host, (page_addr >> 8) & 0xff);
754 send_addr(host, (page_addr >> 16) & 0xff);
756 /* paddr_8 - paddr_15 */
757 send_addr(host, (page_addr >> 8) & 0xff);
760 /* One more address cycle for higher density devices */
761 if (mtd->size >= 0x4000000) {
762 /* paddr_8 - paddr_15 */
763 send_addr(host, (page_addr >> 8) & 0xff);
764 send_addr(host, (page_addr >> 16) & 0xff);
766 /* paddr_8 - paddr_15 */
767 send_addr(host, (page_addr >> 8) & 0xff);
772 /* Command post-processing step */
778 case NAND_CMD_READOOB:
780 if (host->pagesize_2k) {
781 /* send read confirm command */
782 send_cmd(host, NAND_CMD_READSTART);
783 /* read for each AREA */
784 send_read_page(host, 0, host->spare_only);
785 send_read_page(host, 1, host->spare_only);
786 send_read_page(host, 2, host->spare_only);
787 send_read_page(host, 3, host->spare_only);
789 send_read_page(host, 0, host->spare_only);
793 case NAND_CMD_READID:
798 case NAND_CMD_PAGEPROG:
801 case NAND_CMD_STATUS:
804 case NAND_CMD_ERASE2:
809 int board_nand_init(struct nand_chip *this)
811 struct system_control_regs *sc_regs =
812 (struct system_control_regs *)IMX_SYSTEM_CTL_BASE;
813 struct mtd_info *mtd;
817 /* structures must be linked */
822 /* 5 us command delay time */
823 this->chip_delay = 5;
826 this->dev_ready = mxc_nand_dev_ready;
827 this->cmdfunc = mxc_nand_command;
828 this->select_chip = mxc_nand_select_chip;
829 this->read_byte = mxc_nand_read_byte;
830 this->read_word = mxc_nand_read_word;
831 this->write_buf = mxc_nand_write_buf;
832 this->read_buf = mxc_nand_read_buf;
833 this->verify_buf = mxc_nand_verify_buf;
835 host->regs = (struct nfc_regs __iomem *)CONFIG_MXC_NAND_REGS_BASE;
838 #ifdef CONFIG_MXC_NAND_HWECC
839 this->ecc.calculate = mxc_nand_calculate_ecc;
840 this->ecc.hwctl = mxc_nand_enable_hwecc;
841 this->ecc.correct = mxc_nand_correct_data;
842 this->ecc.mode = NAND_ECC_HW;
843 this->ecc.size = 512;
845 this->ecc.layout = &nand_hw_eccoob;
846 tmp = readw(&host->regs->nfc_config1);
848 writew(tmp, &host->regs->nfc_config1);
850 this->ecc.layout = &nand_soft_eccoob;
851 this->ecc.mode = NAND_ECC_SOFT;
852 tmp = readw(&host->regs->nfc_config1);
854 writew(tmp, &host->regs->nfc_config1);
858 this->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
862 * Unlock the internal RAM Buffer
864 writew(0x2, &host->regs->nfc_config);
866 /* Blocks to be unlocked */
867 writew(0x0, &host->regs->nfc_unlockstart_blkaddr);
868 writew(0x4000, &host->regs->nfc_unlockend_blkaddr);
870 /* Unlock Block Command for given address range */
871 writew(0x4, &host->regs->nfc_wrprot);
873 /* NAND bus width determines access funtions used by upper layer */
874 if (readl(&sc_regs->fmcr) & NF_16BIT_SEL)
875 this->options |= NAND_BUSWIDTH_16;
877 host->pagesize_2k = 0;