2 * Copyright 2009-2014 Freescale Semiconductor, Inc. and others
4 * Description: MPC5125, VF610, MCF54418 and Kinetis K70 Nand driver.
5 * Ported to U-Boot by Stefan Agner
6 * Based on RFC driver posted on Kernel Mailing list by Bill Pringlemeir
7 * Jason ported to M54418TWR and MVFA5.
8 * Authors: Stefan Agner <stefan.agner@toradex.com>
9 * Bill Pringlemeir <bpringlemeir@nbsps.com>
10 * Shaohui Xie <b21989@freescale.com>
11 * Jason Jin <Jason.jin@freescale.com>
13 * Based on original driver mpc5121_nfc.c.
15 * This is free software; you can redistribute it and/or modify it
16 * under the terms of the GNU General Public License as published by
17 * the Free Software Foundation; either version 2 of the License, or
18 * (at your option) any later version.
21 * - Untested on MPC5125 and M54418.
24 * - Only 2K page w. 64+OOB and hardware ECC.
30 #include <linux/mtd/mtd.h>
31 #include <linux/mtd/nand.h>
32 #include <linux/mtd/partitions.h>
38 /* Register Offsets */
39 #define NFC_FLASH_CMD1 0x3F00
40 #define NFC_FLASH_CMD2 0x3F04
41 #define NFC_COL_ADDR 0x3F08
42 #define NFC_ROW_ADDR 0x3F0c
43 #define NFC_ROW_ADDR_INC 0x3F14
44 #define NFC_FLASH_STATUS1 0x3F18
45 #define NFC_FLASH_STATUS2 0x3F1c
46 #define NFC_CACHE_SWAP 0x3F28
47 #define NFC_SECTOR_SIZE 0x3F2c
48 #define NFC_FLASH_CONFIG 0x3F30
49 #define NFC_IRQ_STATUS 0x3F38
51 /* Addresses for NFC MAIN RAM BUFFER areas */
52 #define NFC_MAIN_AREA(n) ((n) * 0x1000)
54 #define PAGE_2K 0x0800
58 * NFC_CMD2[CODE] values. See section:
59 * - 31.4.7 Flash Command Code Description, Vybrid manual
60 * - 23.8.6 Flash Command Sequencer, MPC5125 manual
62 * Briefly these are bitmasks of controller cycles.
64 #define READ_PAGE_CMD_CODE 0x7EE0
65 #define PROGRAM_PAGE_CMD_CODE 0x7FC0
66 #define ERASE_CMD_CODE 0x4EC0
67 #define READ_ID_CMD_CODE 0x4804
68 #define RESET_CMD_CODE 0x4040
69 #define STATUS_READ_CMD_CODE 0x4068
71 /* NFC ECC mode define */
75 /*** Register Mask and bit definitions */
77 /* NFC_FLASH_CMD1 Field */
78 #define CMD_BYTE2_MASK 0xFF000000
79 #define CMD_BYTE2_SHIFT 24
81 /* NFC_FLASH_CM2 Field */
82 #define CMD_BYTE1_MASK 0xFF000000
83 #define CMD_BYTE1_SHIFT 24
84 #define CMD_CODE_MASK 0x00FFFF00
85 #define CMD_CODE_SHIFT 8
86 #define BUFNO_MASK 0x00000006
88 #define START_BIT (1<<0)
90 /* NFC_COL_ADDR Field */
91 #define COL_ADDR_MASK 0x0000FFFF
92 #define COL_ADDR_SHIFT 0
94 /* NFC_ROW_ADDR Field */
95 #define ROW_ADDR_MASK 0x00FFFFFF
96 #define ROW_ADDR_SHIFT 0
97 #define ROW_ADDR_CHIP_SEL_RB_MASK 0xF0000000
98 #define ROW_ADDR_CHIP_SEL_RB_SHIFT 28
99 #define ROW_ADDR_CHIP_SEL_MASK 0x0F000000
100 #define ROW_ADDR_CHIP_SEL_SHIFT 24
102 /* NFC_FLASH_STATUS2 Field */
103 #define STATUS_BYTE1_MASK 0x000000FF
105 /* NFC_FLASH_CONFIG Field */
106 #define CONFIG_ECC_SRAM_ADDR_MASK 0x7FC00000
107 #define CONFIG_ECC_SRAM_ADDR_SHIFT 22
108 #define CONFIG_ECC_SRAM_REQ_BIT (1<<21)
109 #define CONFIG_DMA_REQ_BIT (1<<20)
110 #define CONFIG_ECC_MODE_MASK 0x000E0000
111 #define CONFIG_ECC_MODE_SHIFT 17
112 #define CONFIG_FAST_FLASH_BIT (1<<16)
113 #define CONFIG_16BIT (1<<7)
114 #define CONFIG_BOOT_MODE_BIT (1<<6)
115 #define CONFIG_ADDR_AUTO_INCR_BIT (1<<5)
116 #define CONFIG_BUFNO_AUTO_INCR_BIT (1<<4)
117 #define CONFIG_PAGE_CNT_MASK 0xF
118 #define CONFIG_PAGE_CNT_SHIFT 0
120 /* NFC_IRQ_STATUS Field */
121 #define IDLE_IRQ_BIT (1<<29)
122 #define IDLE_EN_BIT (1<<20)
123 #define CMD_DONE_CLEAR_BIT (1<<18)
124 #define IDLE_CLEAR_BIT (1<<17)
126 #define NFC_TIMEOUT (1000)
128 /* ECC status placed at end of buffers. */
129 #define ECC_SRAM_ADDR ((PAGE_2K+256-8) >> 3)
130 #define ECC_STATUS_MASK 0x80
131 #define ECC_ERR_COUNT 0x3F
134 * ECC status is stored at NFC_CFG[ECCADD] +4 for little-endian
135 * and +7 for big-endian SOC.
144 struct mtd_info *mtd;
145 struct nand_chip chip;
150 /* Status and ID are in alternate locations. */
153 #define ALT_BUF_STAT 2
157 #define mtd_to_nfc(_mtd) \
158 (struct vf610_nfc *)((struct nand_chip *)_mtd->priv)->priv
160 static u8 bbt_pattern[] = {'B', 'b', 't', '0' };
161 static u8 mirror_pattern[] = {'1', 't', 'b', 'B' };
163 static struct nand_bbt_descr bbt_main_descr = {
164 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE |
165 NAND_BBT_2BIT | NAND_BBT_VERSION,
170 .pattern = bbt_pattern,
173 static struct nand_bbt_descr bbt_mirror_descr = {
174 .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE |
175 NAND_BBT_2BIT | NAND_BBT_VERSION,
180 .pattern = mirror_pattern,
183 static struct nand_ecclayout vf610_nfc_ecc45 = {
185 .eccpos = {19, 20, 21, 22, 23,
186 24, 25, 26, 27, 28, 29, 30, 31,
187 32, 33, 34, 35, 36, 37, 38, 39,
188 40, 41, 42, 43, 44, 45, 46, 47,
189 48, 49, 50, 51, 52, 53, 54, 55,
190 56, 57, 58, 59, 60, 61, 62, 63},
196 static inline u32 vf610_nfc_read(struct mtd_info *mtd, uint reg)
198 struct vf610_nfc *nfc = mtd_to_nfc(mtd);
200 return readl(nfc->regs + reg);
203 static inline void vf610_nfc_write(struct mtd_info *mtd, uint reg, u32 val)
205 struct vf610_nfc *nfc = mtd_to_nfc(mtd);
207 writel(val, nfc->regs + reg);
210 static inline void vf610_nfc_set(struct mtd_info *mtd, uint reg, u32 bits)
212 vf610_nfc_write(mtd, reg, vf610_nfc_read(mtd, reg) | bits);
215 static inline void vf610_nfc_clear(struct mtd_info *mtd, uint reg, u32 bits)
217 vf610_nfc_write(mtd, reg, vf610_nfc_read(mtd, reg) & ~bits);
220 static inline void vf610_nfc_set_field(struct mtd_info *mtd, u32 reg,
221 u32 mask, u32 shift, u32 val)
223 vf610_nfc_write(mtd, reg,
224 (vf610_nfc_read(mtd, reg) & (~mask)) | val << shift);
227 static inline void vf610_nfc_memcpy(void *dst, const void *src, size_t n)
230 * Use this accessor for the interal SRAM buffers. On ARM we can
231 * treat the SRAM buffer as if its memory, hence use memcpy
236 /* Clear flags for upcoming command */
237 static inline void vf610_nfc_clear_status(void __iomem *regbase)
239 void __iomem *reg = regbase + NFC_IRQ_STATUS;
240 u32 tmp = __raw_readl(reg);
241 tmp |= CMD_DONE_CLEAR_BIT | IDLE_CLEAR_BIT;
242 __raw_writel(tmp, reg);
245 /* Wait for complete operation */
246 static inline void vf610_nfc_done(struct mtd_info *mtd)
248 struct vf610_nfc *nfc = mtd_to_nfc(mtd);
252 * Barrier is needed after this write. This write need
253 * to be done before reading the next register the first
255 * vf610_nfc_set implicates such a barrier by using writel
256 * to write to the register.
258 vf610_nfc_set(mtd, NFC_FLASH_CMD2, START_BIT);
260 start = get_timer(0);
262 while (!(vf610_nfc_read(mtd, NFC_IRQ_STATUS) & IDLE_IRQ_BIT)) {
263 if (get_timer(start) > NFC_TIMEOUT) {
264 printf("Timeout while waiting for !BUSY.\n");
268 vf610_nfc_clear_status(nfc->regs);
271 static u8 vf610_nfc_get_id(struct mtd_info *mtd, int col)
276 flash_id = vf610_nfc_read(mtd, NFC_FLASH_STATUS1);
277 return (flash_id >> (3-col)*8) & 0xff;
279 flash_id = vf610_nfc_read(mtd, NFC_FLASH_STATUS2);
280 return flash_id >> 24;
284 static u8 vf610_nfc_get_status(struct mtd_info *mtd)
286 return vf610_nfc_read(mtd, NFC_FLASH_STATUS2) & STATUS_BYTE1_MASK;
290 static void vf610_nfc_send_command(void __iomem *regbase, u32 cmd_byte1,
293 void __iomem *reg = regbase + NFC_FLASH_CMD2;
295 vf610_nfc_clear_status(regbase);
297 tmp = __raw_readl(reg);
298 tmp &= ~(CMD_BYTE1_MASK | CMD_CODE_MASK | BUFNO_MASK);
299 tmp |= cmd_byte1 << CMD_BYTE1_SHIFT;
300 tmp |= cmd_code << CMD_CODE_SHIFT;
301 __raw_writel(tmp, reg);
305 static void vf610_nfc_send_commands(void __iomem *regbase, u32 cmd_byte1,
306 u32 cmd_byte2, u32 cmd_code)
308 void __iomem *reg = regbase + NFC_FLASH_CMD1;
310 vf610_nfc_send_command(regbase, cmd_byte1, cmd_code);
312 tmp = __raw_readl(reg);
313 tmp &= ~CMD_BYTE2_MASK;
314 tmp |= cmd_byte2 << CMD_BYTE2_SHIFT;
315 __raw_writel(tmp, reg);
318 static void vf610_nfc_addr_cycle(struct mtd_info *mtd, int column, int page)
321 struct vf610_nfc *nfc = mtd_to_nfc(mtd);
322 if (nfc->chip.options | NAND_BUSWIDTH_16)
324 vf610_nfc_set_field(mtd, NFC_COL_ADDR, COL_ADDR_MASK,
325 COL_ADDR_SHIFT, column);
328 vf610_nfc_set_field(mtd, NFC_ROW_ADDR, ROW_ADDR_MASK,
329 ROW_ADDR_SHIFT, page);
332 /* Send command to NAND chip */
333 static void vf610_nfc_command(struct mtd_info *mtd, unsigned command,
334 int column, int page)
336 struct vf610_nfc *nfc = mtd_to_nfc(mtd);
338 nfc->column = max(column, 0);
343 case NAND_CMD_PAGEPROG:
345 vf610_nfc_send_commands(nfc->regs, NAND_CMD_SEQIN,
346 command, PROGRAM_PAGE_CMD_CODE);
347 vf610_nfc_addr_cycle(mtd, column, page);
351 vf610_nfc_send_command(nfc->regs, command, RESET_CMD_CODE);
354 * NFC does not support sub-page reads and writes,
355 * so emulate them using full page transfers.
357 case NAND_CMD_READOOB:
359 case NAND_CMD_SEQIN: /* Pre-read for partial writes. */
363 if (nfc->page == page)
366 vf610_nfc_send_commands(nfc->regs, NAND_CMD_READ0,
367 NAND_CMD_READSTART, READ_PAGE_CMD_CODE);
368 vf610_nfc_addr_cycle(mtd, column, page);
371 case NAND_CMD_ERASE1:
372 if (nfc->page == page)
374 vf610_nfc_send_commands(nfc->regs, command,
375 NAND_CMD_ERASE2, ERASE_CMD_CODE);
376 vf610_nfc_addr_cycle(mtd, column, page);
379 case NAND_CMD_READID:
380 nfc->alt_buf = ALT_BUF_ID;
381 vf610_nfc_send_command(nfc->regs, command, READ_ID_CMD_CODE);
384 case NAND_CMD_STATUS:
385 nfc->alt_buf = ALT_BUF_STAT;
386 vf610_nfc_send_command(nfc->regs, command,
387 STATUS_READ_CMD_CODE);
396 static inline void vf610_nfc_read_spare(struct mtd_info *mtd, void *buf,
399 struct vf610_nfc *nfc = mtd_to_nfc(mtd);
401 len = min(mtd->oobsize, (uint)len);
403 vf610_nfc_memcpy(buf, nfc->regs + mtd->writesize, len);
406 /* Read data from NFC buffers */
407 static void vf610_nfc_read_buf(struct mtd_info *mtd, u_char *buf, int len)
409 struct vf610_nfc *nfc = mtd_to_nfc(mtd);
410 uint c = nfc->column;
413 /* Handle main area */
414 if (!nfc->spareonly) {
415 l = min((uint)len, mtd->writesize - c);
419 vf610_nfc_memcpy(buf, nfc->regs + NFC_MAIN_AREA(0) + c,
422 if (nfc->alt_buf & ALT_BUF_ID)
423 *buf = vf610_nfc_get_id(mtd, c);
425 *buf = vf610_nfc_get_status(mtd);
431 /* Handle spare area access */
434 vf610_nfc_read_spare(mtd, buf, len);
438 /* Write data to NFC buffers */
439 static void vf610_nfc_write_buf(struct mtd_info *mtd, const u_char *buf,
442 struct vf610_nfc *nfc = mtd_to_nfc(mtd);
443 uint c = nfc->column;
446 l = min((uint)len, mtd->writesize + mtd->oobsize - c);
448 vf610_nfc_memcpy(nfc->regs + NFC_MAIN_AREA(0) + c, buf, l);
451 /* Read byte from NFC buffers */
452 static u8 vf610_nfc_read_byte(struct mtd_info *mtd)
455 vf610_nfc_read_buf(mtd, &tmp, sizeof(tmp));
459 /* Read word from NFC buffers */
460 static u16 vf610_nfc_read_word(struct mtd_info *mtd)
463 vf610_nfc_read_buf(mtd, (u_char *)&tmp, sizeof(tmp));
467 /* If not provided, upper layers apply a fixed delay. */
468 static int vf610_nfc_dev_ready(struct mtd_info *mtd)
470 /* NFC handles R/B internally; always ready. */
475 * This function supports Vybrid only (MPC5125 would have full RB and four CS)
477 static void vf610_nfc_select_chip(struct mtd_info *mtd, int chip)
480 u32 tmp = vf610_nfc_read(mtd, NFC_ROW_ADDR);
481 tmp &= ~(ROW_ADDR_CHIP_SEL_RB_MASK | ROW_ADDR_CHIP_SEL_MASK);
482 tmp |= 1 << ROW_ADDR_CHIP_SEL_RB_SHIFT;
485 tmp |= 1 << ROW_ADDR_CHIP_SEL_SHIFT;
487 tmp |= 2 << ROW_ADDR_CHIP_SEL_SHIFT;
489 vf610_nfc_write(mtd, NFC_ROW_ADDR, tmp);
493 /* Count the number of 0's in buff upto max_bits */
494 static inline int count_written_bits(uint8_t *buff, int size, int max_bits)
496 uint32_t *buff32 = (uint32_t *)buff;
497 int k, written_bits = 0;
499 for (k = 0; k < (size / 4); k++) {
500 written_bits += hweight32(~buff32[k]);
501 if (written_bits > max_bits)
508 static inline int vf610_nfc_correct_data(struct mtd_info *mtd, u_char *dat)
510 struct vf610_nfc *nfc = mtd_to_nfc(mtd);
515 ecc_status = __raw_readb(nfc->regs + ECC_SRAM_ADDR * 8 + ECC_OFFSET);
516 ecc_count = ecc_status & ECC_ERR_COUNT;
517 if (!(ecc_status & ECC_STATUS_MASK))
520 /* If 'ecc_count' zero or less then buffer is all 0xff or erased. */
521 flip = count_written_bits(dat, nfc->chip.ecc.size, ecc_count);
524 if (flip > ecc_count) {
530 memset(dat, 0xff, nfc->chip.ecc.size);
535 static int vf610_nfc_read_page(struct mtd_info *mtd, struct nand_chip *chip,
536 uint8_t *buf, int oob_required, int page)
538 int eccsize = chip->ecc.size;
543 vf610_nfc_read_buf(mtd, p, eccsize);
546 vf610_nfc_read_buf(mtd, chip->oob_poi, mtd->oobsize);
548 stat = vf610_nfc_correct_data(mtd, p);
551 mtd->ecc_stats.failed++;
553 mtd->ecc_stats.corrected += stat;
559 * ECC will be calculated automatically
561 static int vf610_nfc_write_page(struct mtd_info *mtd, struct nand_chip *chip,
562 const uint8_t *buf, int oob_required)
564 vf610_nfc_write_buf(mtd, buf, mtd->writesize);
566 vf610_nfc_write_buf(mtd, chip->oob_poi, mtd->oobsize);
571 struct vf610_nfc_config {
577 static int vf610_nfc_nand_init(int devnum, void __iomem *addr)
579 struct mtd_info *mtd = &nand_info[devnum];
580 struct nand_chip *chip;
581 struct vf610_nfc *nfc;
584 struct vf610_nfc_config cfg = {
586 #ifdef CONFIG_SYS_NAND_BUSWIDTH_16BIT
594 nfc = malloc(sizeof(*nfc));
596 printf(KERN_ERR "%s: Memory exhausted!\n", __func__);
606 if (cfg.width == 16) {
607 chip->options |= NAND_BUSWIDTH_16;
608 vf610_nfc_set(mtd, NFC_FLASH_CONFIG, CONFIG_16BIT);
610 chip->options &= ~NAND_BUSWIDTH_16;
611 vf610_nfc_clear(mtd, NFC_FLASH_CONFIG, CONFIG_16BIT);
614 chip->dev_ready = vf610_nfc_dev_ready;
615 chip->cmdfunc = vf610_nfc_command;
616 chip->read_byte = vf610_nfc_read_byte;
617 chip->read_word = vf610_nfc_read_word;
618 chip->read_buf = vf610_nfc_read_buf;
619 chip->write_buf = vf610_nfc_write_buf;
620 chip->select_chip = vf610_nfc_select_chip;
622 /* Bad block options. */
624 chip->bbt_options = NAND_BBT_USE_FLASH | NAND_BBT_CREATE;
626 /* Default to software ECC until flash ID. */
627 vf610_nfc_set_field(mtd, NFC_FLASH_CONFIG,
628 CONFIG_ECC_MODE_MASK,
629 CONFIG_ECC_MODE_SHIFT, ECC_BYPASS);
631 chip->bbt_td = &bbt_main_descr;
632 chip->bbt_md = &bbt_mirror_descr;
634 page_sz = PAGE_2K + OOB_64;
635 page_sz += cfg.width == 16 ? 1 : 0;
636 vf610_nfc_write(mtd, NFC_SECTOR_SIZE, page_sz);
638 /* Set configuration register. */
639 vf610_nfc_clear(mtd, NFC_FLASH_CONFIG, CONFIG_ADDR_AUTO_INCR_BIT);
640 vf610_nfc_clear(mtd, NFC_FLASH_CONFIG, CONFIG_BUFNO_AUTO_INCR_BIT);
641 vf610_nfc_clear(mtd, NFC_FLASH_CONFIG, CONFIG_BOOT_MODE_BIT);
642 vf610_nfc_clear(mtd, NFC_FLASH_CONFIG, CONFIG_DMA_REQ_BIT);
643 vf610_nfc_set(mtd, NFC_FLASH_CONFIG, CONFIG_FAST_FLASH_BIT);
645 /* Enable Idle IRQ */
646 vf610_nfc_set(mtd, NFC_IRQ_STATUS, IDLE_EN_BIT);
649 vf610_nfc_set_field(mtd, NFC_FLASH_CONFIG, CONFIG_PAGE_CNT_MASK,
650 CONFIG_PAGE_CNT_SHIFT, 1);
652 /* Set ECC_STATUS offset */
653 vf610_nfc_set_field(mtd, NFC_FLASH_CONFIG,
654 CONFIG_ECC_SRAM_ADDR_MASK,
655 CONFIG_ECC_SRAM_ADDR_SHIFT, ECC_SRAM_ADDR);
657 /* first scan to find the device and get the page size */
658 if (nand_scan_ident(mtd, CONFIG_SYS_MAX_NAND_DEVICE, NULL)) {
663 chip->ecc.mode = NAND_ECC_SOFT; /* default */
665 page_sz = mtd->writesize + mtd->oobsize;
667 /* Single buffer only, max 256 OOB minus ECC status */
668 if (page_sz > PAGE_2K + 256 - 8) {
669 dev_err(nfc->dev, "Unsupported flash size\n");
673 page_sz += cfg.width == 16 ? 1 : 0;
674 vf610_nfc_write(mtd, NFC_SECTOR_SIZE, page_sz);
676 if (cfg.hardware_ecc) {
677 if (mtd->writesize != PAGE_2K && mtd->oobsize < 64) {
678 dev_err(nfc->dev, "Unsupported flash with hwecc\n");
683 chip->ecc.layout = &vf610_nfc_ecc45;
685 /* propagate ecc.layout to mtd_info */
686 mtd->ecclayout = chip->ecc.layout;
687 chip->ecc.read_page = vf610_nfc_read_page;
688 chip->ecc.write_page = vf610_nfc_write_page;
689 chip->ecc.mode = NAND_ECC_HW;
691 chip->ecc.bytes = 45;
692 chip->ecc.size = PAGE_2K;
693 chip->ecc.strength = 24;
695 /* set ECC mode to 45 bytes OOB with 24 bits correction */
696 vf610_nfc_set_field(mtd, NFC_FLASH_CONFIG,
697 CONFIG_ECC_MODE_MASK,
698 CONFIG_ECC_MODE_SHIFT, ECC_45_BYTE);
700 /* Enable ECC_STATUS */
701 vf610_nfc_set(mtd, NFC_FLASH_CONFIG, CONFIG_ECC_SRAM_REQ_BIT);
704 /* second phase scan */
705 err = nand_scan_tail(mtd);
709 err = nand_register(devnum);
719 void board_nand_init(void)
721 int err = vf610_nfc_nand_init(0, (void __iomem *)CONFIG_SYS_NAND_BASE);
723 printf("VF610 NAND init failed (err %d)\n", err);