2 * Freescale i.MX28 NAND flash driver
4 * Copyright (C) 2011 Marek Vasut <marek.vasut@gmail.com>
5 * on behalf of DENX Software Engineering GmbH
7 * Based on code from LTIB:
8 * Freescale GPMI NFC NAND Flash Driver
10 * Copyright (C) 2010 Freescale Semiconductor, Inc.
11 * Copyright (C) 2008 Embedded Alley Solutions, Inc.
13 * SPDX-License-Identifier: GPL-2.0+
18 #include <linux/mtd/mtd.h>
19 #include <linux/mtd/nand.h>
20 #include <linux/types.h>
22 #include <asm/errno.h>
24 #include <asm/arch/clock.h>
25 #include <asm/arch/imx-regs.h>
26 #include <asm/imx-common/regs-bch.h>
27 #include <asm/imx-common/regs-gpmi.h>
28 #include <asm/arch/sys_proto.h>
29 #include <asm/imx-common/dma.h>
31 #define MXS_NAND_DMA_DESCRIPTOR_COUNT 4
33 #define MXS_NAND_CHUNK_DATA_CHUNK_SIZE 512
34 #if defined(CONFIG_SOC_MX6)
35 #define MXS_NAND_CHUNK_DATA_CHUNK_SIZE_SHIFT 2
37 #define MXS_NAND_CHUNK_DATA_CHUNK_SIZE_SHIFT 0
39 #define MXS_NAND_METADATA_SIZE 10
40 #define MXS_NAND_BITS_PER_ECC_LEVEL 13
41 #define MXS_NAND_COMMAND_BUFFER_SIZE 32
43 /* BCH timeout in microseconds */
44 #define MXS_NAND_BCH_TIMEOUT 10000
46 static struct bch_regs *bch_regs = (void *)BCH_BASE_ADDRESS;
47 static struct gpmi_regs *gpmi_regs = (void *)GPMI_BASE_ADDRESS;
48 struct mxs_nand_info {
51 uint32_t cmd_queue_len;
52 uint32_t data_buf_size;
58 uint8_t marking_block_bad;
61 /* Functions with altered behaviour */
62 int (*hooked_read_oob)(struct mtd_info *mtd,
63 loff_t from, struct mtd_oob_ops *ops);
64 int (*hooked_write_oob)(struct mtd_info *mtd,
65 loff_t to, struct mtd_oob_ops *ops);
66 int (*hooked_block_markbad)(struct mtd_info *mtd,
70 struct mxs_dma_desc **desc;
75 #define dump_reg(b, r) __dump_reg(&b->r, #r)
76 static inline void __dump_reg(void *addr, const char *name)
78 printf("%16s[%p]=%08x\n", name, addr, readl(addr));
81 #define dump_bch_reg(n) __dump_reg(&bch_regs->hw_bch_##n, #n)
82 #define dump_gpmi_reg(n) __dump_reg(&gpmi_regs->hw_gpmi_##n, #n)
83 static inline void dump_regs(void)
87 dump_bch_reg(status0);
90 dump_bch_reg(dbgkesread);
91 dump_bch_reg(dbgcsferead);
92 dump_bch_reg(dbgsyndegread);
93 dump_bch_reg(dbgahbmread);
94 dump_bch_reg(blockname);
95 dump_bch_reg(version);
99 dump_gpmi_reg(eccctrl);
100 dump_gpmi_reg(ecccount);
101 dump_gpmi_reg(payload);
102 dump_gpmi_reg(auxiliary);
103 dump_gpmi_reg(ctrl1);
106 dump_gpmi_reg(debug);
107 dump_gpmi_reg(version);
108 dump_gpmi_reg(debug2);
109 dump_gpmi_reg(debug3);
112 static inline int dbg_addr(void *addr)
114 if (((unsigned long)addr & ~0xfff) == BCH_BASE_ADDRESS)
119 static inline u32 mxs_readl(void *addr,
120 const char *fn, int ln)
122 u32 val = readl(addr);
123 static void *last_addr;
129 if (addr != last_addr || last_val != val) {
130 printf("%s@%d: Read %08x from %p\n", fn, ln, val, addr);
137 static inline void mxs_writel(u32 val, void *addr,
138 const char *fn, int ln)
141 printf("%s@%d: Writing %08x to %p...", fn, ln, val, addr);
144 printf(" result: %08x\n", readl(addr));
148 #define readl(a) mxs_readl(a, __func__, __LINE__)
151 #define writel(v, a) mxs_writel(v, a, __func__, __LINE__)
152 static inline void memdump(const void *addr, size_t len)
154 const char *buf = addr;
157 for (i = 0; i < len; i++) {
161 printf("%p:", &buf[i]);
163 printf(" %02x", buf[i]);
168 static inline void memdump(void *addr, size_t len)
172 static inline void dump_regs(void)
177 struct nand_ecclayout fake_ecc_layout;
178 static int chunk_data_size = MXS_NAND_CHUNK_DATA_CHUNK_SIZE;
179 static int galois_field = 13;
182 * Cache management functions
184 #ifndef CONFIG_SYS_DCACHE_OFF
185 static void mxs_nand_flush_data_buf(struct mxs_nand_info *info)
187 uint32_t addr = (uint32_t)info->data_buf;
189 flush_dcache_range(addr, addr + info->data_buf_size);
192 static void mxs_nand_inval_data_buf(struct mxs_nand_info *info)
194 uint32_t addr = (uint32_t)info->data_buf;
196 invalidate_dcache_range(addr, addr + info->data_buf_size);
199 static void mxs_nand_flush_cmd_buf(struct mxs_nand_info *info)
201 uint32_t addr = (uint32_t)info->cmd_buf;
203 flush_dcache_range(addr, addr + MXS_NAND_COMMAND_BUFFER_SIZE);
206 static inline void mxs_nand_flush_data_buf(struct mxs_nand_info *info) {}
207 static inline void mxs_nand_inval_data_buf(struct mxs_nand_info *info) {}
208 static inline void mxs_nand_flush_cmd_buf(struct mxs_nand_info *info) {}
211 static struct mxs_dma_desc *mxs_nand_get_dma_desc(struct mxs_nand_info *info)
213 struct mxs_dma_desc *desc;
215 if (info->desc_index >= MXS_NAND_DMA_DESCRIPTOR_COUNT) {
216 printf("MXS NAND: Too many DMA descriptors requested\n");
220 desc = info->desc[info->desc_index];
226 static void mxs_nand_return_dma_descs(struct mxs_nand_info *info)
229 struct mxs_dma_desc *desc;
231 for (i = 0; i < info->desc_index; i++) {
232 desc = info->desc[i];
233 memset(desc, 0, sizeof(struct mxs_dma_desc));
234 desc->address = (dma_addr_t)desc;
237 info->desc_index = 0;
240 static uint32_t mxs_nand_ecc_chunk_cnt(uint32_t page_data_size)
242 return page_data_size / chunk_data_size;
245 static uint32_t mxs_nand_ecc_size_in_bits(uint32_t ecc_strength)
247 return ecc_strength * galois_field;
250 static uint32_t mxs_nand_aux_status_offset(void)
252 return (MXS_NAND_METADATA_SIZE + 0x3) & ~0x3;
255 static int mxs_nand_gpmi_init(void)
259 /* Reset the GPMI block. */
260 ret = mxs_reset_block(&gpmi_regs->hw_gpmi_ctrl0_reg);
262 printf("Failed to reset GPMI block\n");
266 ret = mxs_reset_block(&bch_regs->hw_bch_ctrl_reg);
268 printf("Failed to reset BCH block\n");
273 * Choose NAND mode, set IRQ polarity, disable write protection and
276 clrsetbits_le32(&gpmi_regs->hw_gpmi_ctrl1,
277 GPMI_CTRL1_GPMI_MODE,
278 GPMI_CTRL1_ATA_IRQRDY_POLARITY | GPMI_CTRL1_DEV_RESET |
279 GPMI_CTRL1_BCH_MODE);
280 writel(0x500 << 16, &gpmi_regs->hw_gpmi_timing1);
284 static inline uint32_t mxs_nand_get_ecc_strength(uint32_t page_data_size,
285 uint32_t page_oob_size)
290 * Determine the ECC layout with the formula:
291 * ECC bits per chunk = (total page spare data bits) /
292 * (bits per ECC level) / (chunks per page)
294 * total page spare data bits =
295 * (page oob size - meta data size) * (bits per byte)
297 ecc_strength = ((page_oob_size - MXS_NAND_METADATA_SIZE) * 8)
299 mxs_nand_ecc_chunk_cnt(page_data_size));
301 return round_down(ecc_strength, 2);
304 static inline uint32_t mxs_nand_get_mark_offset(uint32_t page_data_size,
305 uint32_t ecc_strength)
307 uint32_t chunk_data_size_in_bits;
308 uint32_t chunk_ecc_size_in_bits;
309 uint32_t chunk_total_size_in_bits;
310 uint32_t block_mark_chunk_number;
311 uint32_t block_mark_chunk_bit_offset;
312 uint32_t block_mark_bit_offset;
314 chunk_data_size_in_bits = chunk_data_size * 8;
315 chunk_ecc_size_in_bits = mxs_nand_ecc_size_in_bits(ecc_strength);
317 chunk_total_size_in_bits =
318 chunk_data_size_in_bits + chunk_ecc_size_in_bits;
320 /* Compute the bit offset of the block mark within the physical page. */
321 block_mark_bit_offset = page_data_size * 8;
323 /* Subtract the metadata bits. */
324 block_mark_bit_offset -= MXS_NAND_METADATA_SIZE * 8;
327 * Compute the chunk number (starting at zero) in which the block mark
330 block_mark_chunk_number =
331 block_mark_bit_offset / chunk_total_size_in_bits;
334 * Compute the bit offset of the block mark within its chunk, and
337 block_mark_chunk_bit_offset = block_mark_bit_offset -
338 (block_mark_chunk_number * chunk_total_size_in_bits);
340 if (block_mark_chunk_bit_offset > chunk_data_size_in_bits)
344 * Now that we know the chunk number in which the block mark appears,
345 * we can subtract all the ECC bits that appear before it.
347 block_mark_bit_offset -=
348 block_mark_chunk_number * chunk_ecc_size_in_bits;
350 return block_mark_bit_offset;
353 static inline uint32_t mxs_nand_mark_byte_offset(struct mtd_info *mtd)
355 uint32_t ecc_strength;
356 ecc_strength = mxs_nand_get_ecc_strength(mtd->writesize, mtd->oobsize);
357 return mxs_nand_get_mark_offset(mtd->writesize, ecc_strength) >> 3;
360 static inline uint32_t mxs_nand_mark_bit_offset(struct mtd_info *mtd)
362 uint32_t ecc_strength;
363 ecc_strength = mxs_nand_get_ecc_strength(mtd->writesize, mtd->oobsize);
364 return mxs_nand_get_mark_offset(mtd->writesize, ecc_strength) & 0x7;
368 * Wait for BCH complete IRQ and clear the IRQ
370 static int mxs_nand_wait_for_bch_complete(void)
372 int timeout = MXS_NAND_BCH_TIMEOUT;
375 ret = mxs_wait_mask_set(&bch_regs->hw_bch_ctrl_reg,
376 BCH_CTRL_COMPLETE_IRQ, timeout);
378 debug("%s@%d: %d\n", __func__, __LINE__, ret);
379 mxs_nand_gpmi_init();
382 writel(BCH_CTRL_COMPLETE_IRQ, &bch_regs->hw_bch_ctrl_clr);
388 * This is the function that we install in the cmd_ctrl function pointer of the
389 * owning struct nand_chip. The only functions in the reference implementation
390 * that use these functions pointers are cmdfunc and select_chip.
392 * In this driver, we implement our own select_chip, so this function will only
393 * be called by the reference implementation's cmdfunc. For this reason, we can
394 * ignore the chip enable bit and concentrate only on sending bytes to the NAND
397 static void mxs_nand_cmd_ctrl(struct mtd_info *mtd, int data, unsigned int ctrl)
399 struct nand_chip *nand = mtd->priv;
400 struct mxs_nand_info *nand_info = nand->priv;
401 struct mxs_dma_desc *d;
402 uint32_t channel = MXS_DMA_CHANNEL_AHB_APBH_GPMI0 + nand_info->cur_chip;
406 * If this condition is true, something is _VERY_ wrong in MTD
409 if (nand_info->cmd_queue_len == MXS_NAND_COMMAND_BUFFER_SIZE) {
410 printf("MXS NAND: Command queue too long\n");
415 * Every operation begins with a command byte and a series of zero or
416 * more address bytes. These are distinguished by either the Address
417 * Latch Enable (ALE) or Command Latch Enable (CLE) signals being
418 * asserted. When MTD is ready to execute the command, it will
419 * deasert both latch enables.
421 * Rather than run a separate DMA operation for every single byte, we
422 * queue them up and run a single DMA operation for the entire series
423 * of command and data bytes.
425 if (ctrl & (NAND_ALE | NAND_CLE)) {
426 if (data != NAND_CMD_NONE)
427 nand_info->cmd_buf[nand_info->cmd_queue_len++] = data;
432 * If control arrives here, MTD has deasserted both the ALE and CLE,
433 * which means it's ready to run an operation. Check if we have any
436 if (nand_info->cmd_queue_len == 0)
439 /* Compile the DMA descriptor -- a descriptor that sends command. */
440 d = mxs_nand_get_dma_desc(nand_info);
442 MXS_DMA_DESC_COMMAND_DMA_READ | MXS_DMA_DESC_IRQ |
443 MXS_DMA_DESC_CHAIN | MXS_DMA_DESC_DEC_SEM |
444 MXS_DMA_DESC_WAIT4END | (3 << MXS_DMA_DESC_PIO_WORDS_OFFSET) |
445 (nand_info->cmd_queue_len << MXS_DMA_DESC_BYTES_OFFSET);
447 d->cmd.address = (dma_addr_t)nand_info->cmd_buf;
449 d->cmd.pio_words[0] =
450 GPMI_CTRL0_COMMAND_MODE_WRITE |
451 GPMI_CTRL0_WORD_LENGTH |
452 (nand_info->cur_chip << GPMI_CTRL0_CS_OFFSET) |
453 GPMI_CTRL0_ADDRESS_NAND_CLE |
454 GPMI_CTRL0_ADDRESS_INCREMENT |
455 nand_info->cmd_queue_len;
457 mxs_dma_desc_append(channel, d);
460 mxs_nand_flush_cmd_buf(nand_info);
462 /* Execute the DMA chain. */
463 ret = mxs_dma_go(channel);
467 printf("MXS NAND: Error sending command %08lx\n", d->cmd.pio_words[0]);
468 for (i = 0; i < nand_info->cmd_queue_len; i++) {
469 printf("%02x ", nand_info->cmd_buf[i]);
474 mxs_nand_return_dma_descs(nand_info);
476 /* Reset the command queue. */
477 nand_info->cmd_queue_len = 0;
481 * Test if the NAND flash is ready.
483 static int mxs_nand_device_ready(struct mtd_info *mtd)
485 struct nand_chip *chip = mtd->priv;
486 struct mxs_nand_info *nand_info = chip->priv;
489 tmp = readl(&gpmi_regs->hw_gpmi_stat);
490 tmp >>= (GPMI_STAT_READY_BUSY_OFFSET + nand_info->cur_chip);
496 * Select the NAND chip.
498 static void mxs_nand_select_chip(struct mtd_info *mtd, int chip)
500 struct nand_chip *nand = mtd->priv;
501 struct mxs_nand_info *nand_info = nand->priv;
503 nand_info->cur_chip = chip;
507 * Handle block mark swapping.
509 * Note that, when this function is called, it doesn't know whether it's
510 * swapping the block mark, or swapping it *back* -- but it doesn't matter
511 * because the the operation is the same.
513 #ifndef CONFIG_NAND_MXS_NO_BBM_SWAP
514 static void mxs_nand_swap_block_mark(struct mtd_info *mtd,
515 uint8_t *data_buf, uint8_t *oob_buf)
523 bit_offset = mxs_nand_mark_bit_offset(mtd);
524 buf_offset = mxs_nand_mark_byte_offset(mtd);
527 * Get the byte from the data area that overlays the block mark. Since
528 * the ECC engine applies its own view to the bits in the page, the
529 * physical block mark won't (in general) appear on a byte boundary in
532 src = data_buf[buf_offset] >> bit_offset;
533 src |= data_buf[buf_offset + 1] << (8 - bit_offset);
537 debug("Swapping byte %02x @ %03x.%d with %02x @ %03x\n",
538 src & 0xff, buf_offset, bit_offset, dst & 0xff, 0);
542 data_buf[buf_offset] &= ~(0xff << bit_offset);
543 data_buf[buf_offset + 1] &= 0xff << bit_offset;
545 data_buf[buf_offset] |= dst << bit_offset;
546 data_buf[buf_offset + 1] |= dst >> (8 - bit_offset);
549 static inline void mxs_nand_swap_block_mark(struct mtd_info *mtd,
550 uint8_t *data_buf, uint8_t *oob_buf)
556 * Read data from NAND.
558 static void mxs_nand_read_buf(struct mtd_info *mtd, uint8_t *buf, int length)
560 struct nand_chip *nand = mtd->priv;
561 struct mxs_nand_info *nand_info = nand->priv;
562 struct mxs_dma_desc *d;
563 uint32_t channel = MXS_DMA_CHANNEL_AHB_APBH_GPMI0 + nand_info->cur_chip;
566 if (length > NAND_MAX_PAGESIZE) {
567 printf("MXS NAND: DMA buffer too big\n");
572 printf("MXS NAND: DMA buffer is NULL\n");
576 /* Compile the DMA descriptor - a descriptor that reads data. */
577 d = mxs_nand_get_dma_desc(nand_info);
579 MXS_DMA_DESC_COMMAND_DMA_WRITE | MXS_DMA_DESC_IRQ |
580 MXS_DMA_DESC_DEC_SEM | MXS_DMA_DESC_WAIT4END |
581 (1 << MXS_DMA_DESC_PIO_WORDS_OFFSET) |
582 (length << MXS_DMA_DESC_BYTES_OFFSET);
584 d->cmd.address = (dma_addr_t)nand_info->data_buf;
586 d->cmd.pio_words[0] =
587 GPMI_CTRL0_COMMAND_MODE_READ |
588 GPMI_CTRL0_WORD_LENGTH |
589 (nand_info->cur_chip << GPMI_CTRL0_CS_OFFSET) |
590 GPMI_CTRL0_ADDRESS_NAND_DATA |
593 mxs_dma_desc_append(channel, d);
595 #ifndef CONFIG_SOC_MX6Q
597 * A DMA descriptor that waits for the command to end and the chip to
600 * I think we actually should *not* be waiting for the chip to become
601 * ready because, after all, we don't care. I think the original code
602 * did that and no one has re-thought it yet.
604 d = mxs_nand_get_dma_desc(nand_info);
606 MXS_DMA_DESC_COMMAND_NO_DMAXFER | MXS_DMA_DESC_IRQ |
607 MXS_DMA_DESC_NAND_WAIT_4_READY | MXS_DMA_DESC_DEC_SEM |
608 MXS_DMA_DESC_WAIT4END | (1 << MXS_DMA_DESC_PIO_WORDS_OFFSET);
612 d->cmd.pio_words[0] =
613 GPMI_CTRL0_COMMAND_MODE_WAIT_FOR_READY |
614 GPMI_CTRL0_WORD_LENGTH |
615 (nand_info->cur_chip << GPMI_CTRL0_CS_OFFSET) |
616 GPMI_CTRL0_ADDRESS_NAND_DATA;
618 mxs_dma_desc_append(channel, d);
620 /* Execute the DMA chain. */
621 ret = mxs_dma_go(channel);
623 printf("%s: DMA read error\n", __func__);
627 /* Invalidate caches */
628 mxs_nand_inval_data_buf(nand_info);
630 memcpy(buf, nand_info->data_buf, length);
633 mxs_nand_return_dma_descs(nand_info);
637 * Write data to NAND.
639 static void mxs_nand_write_buf(struct mtd_info *mtd, const uint8_t *buf,
642 struct nand_chip *nand = mtd->priv;
643 struct mxs_nand_info *nand_info = nand->priv;
644 struct mxs_dma_desc *d;
645 uint32_t channel = MXS_DMA_CHANNEL_AHB_APBH_GPMI0 + nand_info->cur_chip;
648 if (length > NAND_MAX_PAGESIZE) {
649 printf("MXS NAND: DMA buffer too big\n");
654 printf("MXS NAND: DMA buffer is NULL\n");
658 memcpy(nand_info->data_buf, buf, length);
660 /* Compile the DMA descriptor - a descriptor that writes data. */
661 d = mxs_nand_get_dma_desc(nand_info);
663 MXS_DMA_DESC_COMMAND_DMA_READ | MXS_DMA_DESC_IRQ |
664 MXS_DMA_DESC_DEC_SEM | MXS_DMA_DESC_WAIT4END |
665 (1 << MXS_DMA_DESC_PIO_WORDS_OFFSET) |
666 (length << MXS_DMA_DESC_BYTES_OFFSET);
668 d->cmd.address = (dma_addr_t)nand_info->data_buf;
670 d->cmd.pio_words[0] =
671 GPMI_CTRL0_COMMAND_MODE_WRITE |
672 GPMI_CTRL0_WORD_LENGTH |
673 (nand_info->cur_chip << GPMI_CTRL0_CS_OFFSET) |
674 GPMI_CTRL0_ADDRESS_NAND_DATA |
677 mxs_dma_desc_append(channel, d);
680 mxs_nand_flush_data_buf(nand_info);
682 /* Execute the DMA chain. */
683 ret = mxs_dma_go(channel);
685 printf("%s: DMA write error\n", __func__);
687 mxs_nand_return_dma_descs(nand_info);
691 * Read a single byte from NAND.
693 static uint8_t mxs_nand_read_byte(struct mtd_info *mtd)
696 mxs_nand_read_buf(mtd, &buf, 1);
700 static void flush_buffers(struct mtd_info *mtd, struct mxs_nand_info *nand_info)
702 flush_dcache_range((unsigned long)nand_info->data_buf,
703 (unsigned long)nand_info->data_buf +
705 flush_dcache_range((unsigned long)nand_info->oob_buf,
706 (unsigned long)nand_info->oob_buf +
711 * Read a page from NAND.
713 static int mxs_nand_ecc_read_page(struct mtd_info *mtd, struct nand_chip *nand,
714 uint8_t *buf, int oob_required,
717 struct mxs_nand_info *nand_info = nand->priv;
718 struct mxs_dma_desc *d;
719 uint32_t channel = MXS_DMA_CHANNEL_AHB_APBH_GPMI0 + nand_info->cur_chip;
720 uint32_t corrected = 0, failed = 0;
724 /* Compile the DMA descriptor - wait for ready. */
725 d = mxs_nand_get_dma_desc(nand_info);
727 MXS_DMA_DESC_COMMAND_NO_DMAXFER | MXS_DMA_DESC_CHAIN |
728 MXS_DMA_DESC_NAND_WAIT_4_READY | MXS_DMA_DESC_WAIT4END |
729 (1 << MXS_DMA_DESC_PIO_WORDS_OFFSET);
733 d->cmd.pio_words[0] =
734 GPMI_CTRL0_COMMAND_MODE_WAIT_FOR_READY |
735 GPMI_CTRL0_WORD_LENGTH |
736 (nand_info->cur_chip << GPMI_CTRL0_CS_OFFSET) |
737 GPMI_CTRL0_ADDRESS_NAND_DATA;
739 mxs_dma_desc_append(channel, d);
741 /* Compile the DMA descriptor - enable the BCH block and read. */
742 d = mxs_nand_get_dma_desc(nand_info);
744 MXS_DMA_DESC_COMMAND_NO_DMAXFER | MXS_DMA_DESC_CHAIN |
745 MXS_DMA_DESC_WAIT4END | (6 << MXS_DMA_DESC_PIO_WORDS_OFFSET);
749 d->cmd.pio_words[0] =
750 GPMI_CTRL0_COMMAND_MODE_READ |
751 GPMI_CTRL0_WORD_LENGTH |
752 (nand_info->cur_chip << GPMI_CTRL0_CS_OFFSET) |
753 GPMI_CTRL0_ADDRESS_NAND_DATA |
754 (mtd->writesize + mtd->oobsize);
755 d->cmd.pio_words[1] = 0;
756 d->cmd.pio_words[2] =
757 GPMI_ECCCTRL_ENABLE_ECC |
758 GPMI_ECCCTRL_ECC_CMD_DECODE |
759 GPMI_ECCCTRL_BUFFER_MASK_BCH_PAGE;
760 d->cmd.pio_words[3] = mtd->writesize + mtd->oobsize;
761 d->cmd.pio_words[4] = (dma_addr_t)nand_info->data_buf;
762 d->cmd.pio_words[5] = (dma_addr_t)nand_info->oob_buf;
764 flush_buffers(mtd, nand_info);
766 mxs_dma_desc_append(channel, d);
768 /* Compile the DMA descriptor - disable the BCH block. */
769 d = mxs_nand_get_dma_desc(nand_info);
771 MXS_DMA_DESC_COMMAND_NO_DMAXFER | MXS_DMA_DESC_CHAIN |
772 MXS_DMA_DESC_NAND_WAIT_4_READY | MXS_DMA_DESC_WAIT4END |
773 (3 << MXS_DMA_DESC_PIO_WORDS_OFFSET);
777 d->cmd.pio_words[0] =
778 GPMI_CTRL0_COMMAND_MODE_WAIT_FOR_READY |
779 GPMI_CTRL0_WORD_LENGTH |
780 (nand_info->cur_chip << GPMI_CTRL0_CS_OFFSET) |
781 GPMI_CTRL0_ADDRESS_NAND_DATA |
782 (mtd->writesize + mtd->oobsize);
783 d->cmd.pio_words[1] = 0;
784 d->cmd.pio_words[2] = 0;
786 mxs_dma_desc_append(channel, d);
788 /* Compile the DMA descriptor - deassert the NAND lock and interrupt. */
789 d = mxs_nand_get_dma_desc(nand_info);
791 MXS_DMA_DESC_COMMAND_NO_DMAXFER | MXS_DMA_DESC_IRQ |
792 MXS_DMA_DESC_DEC_SEM;
796 mxs_dma_desc_append(channel, d);
798 /* Execute the DMA chain. */
799 ret = mxs_dma_go(channel);
801 printf("%s: DMA read error\n", __func__);
805 ret = mxs_nand_wait_for_bch_complete();
807 printf("MXS NAND: BCH read timeout\n");
811 /* Invalidate caches */
812 mxs_nand_inval_data_buf(nand_info);
814 /* Read DMA completed, now do the mark swapping. */
815 mxs_nand_swap_block_mark(mtd, nand_info->data_buf, nand_info->oob_buf);
817 /* Loop over status bytes, accumulating ECC status. */
818 status = nand_info->oob_buf + mxs_nand_aux_status_offset();
819 for (i = 0; i < mxs_nand_ecc_chunk_cnt(mtd->writesize); i++) {
820 if (status[i] == 0x00)
823 if (status[i] == 0xff)
826 if (status[i] == 0xfe) {
831 corrected += status[i];
834 /* Propagate ECC status to the owning MTD. */
835 mtd->ecc_stats.failed += failed;
836 mtd->ecc_stats.corrected += corrected;
839 * It's time to deliver the OOB bytes. See mxs_nand_ecc_read_oob() for
840 * details about our policy for delivering the OOB.
842 * We fill the caller's buffer with set bits, and then copy the block
843 * mark to the caller's buffer. Note that, if block mark swapping was
844 * necessary, it has already been done, so we can rely on the first
845 * byte of the auxiliary buffer to contain the block mark.
847 memset(nand->oob_poi, 0xff, mtd->oobsize);
849 nand->oob_poi[0] = nand_info->oob_buf[0];
851 memcpy(buf, nand_info->data_buf, mtd->writesize);
854 mxs_nand_return_dma_descs(nand_info);
860 * Write a page to NAND.
862 static int mxs_nand_ecc_write_page(struct mtd_info *mtd,
863 struct nand_chip *nand, const uint8_t *buf,
866 struct mxs_nand_info *nand_info = nand->priv;
867 struct mxs_dma_desc *d;
868 uint32_t channel = MXS_DMA_CHANNEL_AHB_APBH_GPMI0 + nand_info->cur_chip;
871 memcpy(nand_info->data_buf, buf, mtd->writesize);
872 memcpy(nand_info->oob_buf, nand->oob_poi, mtd->oobsize);
874 /* Handle block mark swapping. */
875 mxs_nand_swap_block_mark(mtd, nand_info->data_buf, nand_info->oob_buf);
877 /* Compile the DMA descriptor - write data. */
878 d = mxs_nand_get_dma_desc(nand_info);
880 MXS_DMA_DESC_COMMAND_NO_DMAXFER | MXS_DMA_DESC_IRQ |
881 MXS_DMA_DESC_DEC_SEM | MXS_DMA_DESC_WAIT4END |
882 (6 << MXS_DMA_DESC_PIO_WORDS_OFFSET);
886 d->cmd.pio_words[0] =
887 GPMI_CTRL0_COMMAND_MODE_WRITE |
888 GPMI_CTRL0_WORD_LENGTH |
889 (nand_info->cur_chip << GPMI_CTRL0_CS_OFFSET) |
890 GPMI_CTRL0_ADDRESS_NAND_DATA;
891 d->cmd.pio_words[1] = 0;
892 d->cmd.pio_words[2] =
893 GPMI_ECCCTRL_ENABLE_ECC |
894 GPMI_ECCCTRL_ECC_CMD_ENCODE |
895 GPMI_ECCCTRL_BUFFER_MASK_BCH_PAGE;
896 d->cmd.pio_words[3] = mtd->writesize + mtd->oobsize;
897 d->cmd.pio_words[4] = (dma_addr_t)nand_info->data_buf;
898 d->cmd.pio_words[5] = (dma_addr_t)nand_info->oob_buf;
900 flush_buffers(mtd, nand_info);
902 mxs_dma_desc_append(channel, d);
905 mxs_nand_flush_data_buf(nand_info);
907 /* Execute the DMA chain. */
908 ret = mxs_dma_go(channel);
910 printf("%s: DMA write error\n", __func__);
914 ret = mxs_nand_wait_for_bch_complete();
916 printf("%s: BCH write timeout\n", __func__);
921 mxs_nand_return_dma_descs(nand_info);
926 * Read OOB from NAND.
928 * This function is a veneer that replaces the function originally installed by
929 * the NAND Flash MTD code.
931 static int mxs_nand_hook_read_oob(struct mtd_info *mtd, loff_t from,
932 struct mtd_oob_ops *ops)
934 struct nand_chip *chip = mtd->priv;
935 struct mxs_nand_info *nand_info = chip->priv;
938 if (ops->mode == MTD_OPS_RAW)
939 nand_info->raw_oob_mode = 1;
941 nand_info->raw_oob_mode = 0;
943 ret = nand_info->hooked_read_oob(mtd, from, ops);
945 nand_info->raw_oob_mode = 0;
953 * This function is a veneer that replaces the function originally installed by
954 * the NAND Flash MTD code.
956 static int mxs_nand_hook_write_oob(struct mtd_info *mtd, loff_t to,
957 struct mtd_oob_ops *ops)
959 struct nand_chip *chip = mtd->priv;
960 struct mxs_nand_info *nand_info = chip->priv;
963 if (ops->mode == MTD_OPS_RAW)
964 nand_info->raw_oob_mode = 1;
966 nand_info->raw_oob_mode = 0;
968 ret = nand_info->hooked_write_oob(mtd, to, ops);
970 nand_info->raw_oob_mode = 0;
976 * Mark a block bad in NAND.
978 * This function is a veneer that replaces the function originally installed by
979 * the NAND Flash MTD code.
981 static int mxs_nand_hook_block_markbad(struct mtd_info *mtd, loff_t ofs)
983 struct nand_chip *chip = mtd->priv;
984 struct mxs_nand_info *nand_info = chip->priv;
987 nand_info->marking_block_bad = 1;
989 ret = nand_info->hooked_block_markbad(mtd, ofs);
991 nand_info->marking_block_bad = 0;
997 * There are several places in this driver where we have to handle the OOB and
998 * block marks. This is the function where things are the most complicated, so
999 * this is where we try to explain it all. All the other places refer back to
1002 * These are the rules, in order of decreasing importance:
1004 * 1) Nothing the caller does can be allowed to imperil the block mark, so all
1005 * write operations take measures to protect it.
1007 * 2) In read operations, the first byte of the OOB we return must reflect the
1008 * true state of the block mark, no matter where that block mark appears in
1009 * the physical page.
1011 * 3) ECC-based read operations return an OOB full of set bits (since we never
1012 * allow ECC-based writes to the OOB, it doesn't matter what ECC-based reads
1015 * 4) "Raw" read operations return a direct view of the physical bytes in the
1016 * page, using the conventional definition of which bytes are data and which
1017 * are OOB. This gives the caller a way to see the actual, physical bytes
1018 * in the page, without the distortions applied by our ECC engine.
1020 * What we do for this specific read operation depends on whether we're doing
1021 * "raw" read, or an ECC-based read.
1023 * It turns out that knowing whether we want an "ECC-based" or "raw" read is not
1024 * easy. When reading a page, for example, the NAND Flash MTD code calls our
1025 * ecc.read_page or ecc.read_page_raw function. Thus, the fact that MTD wants an
1026 * ECC-based or raw view of the page is implicit in which function it calls
1027 * (there is a similar pair of ECC-based/raw functions for writing).
1029 * Since MTD assumes the OOB is not covered by ECC, there is no pair of
1030 * ECC-based/raw functions for reading or or writing the OOB. The fact that the
1031 * caller wants an ECC-based or raw view of the page is not propagated down to
1034 * Since our OOB *is* covered by ECC, we need this information. So, we hook the
1035 * ecc.read_oob and ecc.write_oob function pointers in the owning
1036 * struct mtd_info with our own functions. These hook functions set the
1037 * raw_oob_mode field so that, when control finally arrives here, we'll know
1040 static int mxs_nand_ecc_read_oob(struct mtd_info *mtd, struct nand_chip *nand,
1043 struct mxs_nand_info *nand_info = nand->priv;
1046 * First, fill in the OOB buffer. If we're doing a raw read, we need to
1047 * get the bytes from the physical page. If we're not doing a raw read,
1048 * we need to fill the buffer with set bits.
1050 if (nand_info->raw_oob_mode) {
1052 * If control arrives here, we're doing a "raw" read. Send the
1053 * command to read the conventional OOB and read it.
1055 nand->cmdfunc(mtd, NAND_CMD_READ0, mtd->writesize, page);
1056 nand->read_buf(mtd, nand->oob_poi, mtd->oobsize);
1059 * If control arrives here, we're not doing a "raw" read. Fill
1060 * the OOB buffer with set bits and correct the block mark.
1062 memset(nand->oob_poi, 0xff, mtd->oobsize);
1064 nand->cmdfunc(mtd, NAND_CMD_READ0, mtd->writesize, page);
1065 mxs_nand_read_buf(mtd, nand->oob_poi, 1);
1073 * Write OOB data to NAND.
1075 static int mxs_nand_ecc_write_oob(struct mtd_info *mtd, struct nand_chip *nand,
1078 struct mxs_nand_info *nand_info = nand->priv;
1079 uint8_t block_mark = 0;
1082 * There are fundamental incompatibilities between the i.MX GPMI NFC and
1083 * the NAND Flash MTD model that make it essentially impossible to write
1084 * the out-of-band bytes.
1086 * We permit *ONE* exception. If the *intent* of writing the OOB is to
1087 * mark a block bad, we can do that.
1090 if (!nand_info->marking_block_bad) {
1091 printf("NXS NAND: Writing OOB isn't supported\n");
1095 /* Write the block mark. */
1096 nand->cmdfunc(mtd, NAND_CMD_SEQIN, mtd->writesize, page);
1097 nand->write_buf(mtd, &block_mark, 1);
1098 nand->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1100 /* Check if it worked. */
1101 if (nand->waitfunc(mtd, nand) & NAND_STATUS_FAIL)
1108 * Claims all blocks are good.
1110 * In principle, this function is *only* called when the NAND Flash MTD system
1111 * isn't allowed to keep an in-memory bad block table, so it is forced to ask
1112 * the driver for bad block information.
1114 * In fact, we permit the NAND Flash MTD system to have an in-memory BBT, so
1115 * this function is *only* called when we take it away.
1117 * Thus, this function is only called when we want *all* blocks to look good,
1118 * so it *always* return success.
1120 static int mxs_nand_block_bad(struct mtd_info *mtd, loff_t ofs, int getchip)
1126 * Nominally, the purpose of this function is to look for or create the bad
1127 * block table. In fact, since the we call this function at the very end of
1128 * the initialization process started by nand_scan(), and we don't have a
1129 * more formal mechanism, we "hook" this function to continue init process.
1131 * At this point, the physical NAND Flash chips have been identified and
1132 * counted, so we know the physical geometry. This enables us to make some
1133 * important configuration decisions.
1135 * The return value of this function propogates directly back to this driver's
1136 * call to nand_scan(). Anything other than zero will cause this driver to
1137 * tear everything down and declare failure.
1139 static int mxs_nand_scan_bbt(struct mtd_info *mtd)
1141 struct nand_chip *nand = mtd->priv;
1142 struct mxs_nand_info *nand_info = nand->priv;
1145 if (mtd->oobsize > MXS_NAND_CHUNK_DATA_CHUNK_SIZE) {
1147 chunk_data_size = MXS_NAND_CHUNK_DATA_CHUNK_SIZE * 2;
1150 if (mtd->oobsize > chunk_data_size) {
1151 printf("OOB size of chip (%u bytes) is larger than max. supported size (%u bytes)\n",
1152 mtd->oobsize, chunk_data_size);
1156 /* Configure BCH and set NFC geometry */
1157 mxs_reset_block(&bch_regs->hw_bch_ctrl_reg);
1159 debug("mtd->writesize=%d\n", mtd->writesize);
1160 debug("mtd->oobsize=%d\n", mtd->oobsize);
1161 debug("ecc_strength=%d\n", mxs_nand_get_ecc_strength(mtd->writesize, mtd->oobsize));
1163 /* Configure layout 0 */
1164 tmp = (mxs_nand_ecc_chunk_cnt(mtd->writesize) - 1)
1165 << BCH_FLASHLAYOUT0_NBLOCKS_OFFSET;
1166 tmp |= MXS_NAND_METADATA_SIZE << BCH_FLASHLAYOUT0_META_SIZE_OFFSET;
1167 tmp |= (mxs_nand_get_ecc_strength(mtd->writesize, mtd->oobsize) >> 1)
1168 << BCH_FLASHLAYOUT0_ECC0_OFFSET;
1169 tmp |= chunk_data_size >> MXS_NAND_CHUNK_DATA_CHUNK_SIZE_SHIFT;
1170 tmp |= (14 == galois_field ? 1 : 0) <<
1171 BCH_FLASHLAYOUT0_GF13_0_GF14_1_OFFSET;
1172 writel(tmp, &bch_regs->hw_bch_flash0layout0);
1174 tmp = (mtd->writesize + mtd->oobsize)
1175 << BCH_FLASHLAYOUT1_PAGE_SIZE_OFFSET;
1176 tmp |= (mxs_nand_get_ecc_strength(mtd->writesize, mtd->oobsize) >> 1)
1177 << BCH_FLASHLAYOUT1_ECCN_OFFSET;
1178 tmp |= chunk_data_size >> MXS_NAND_CHUNK_DATA_CHUNK_SIZE_SHIFT;
1179 tmp |= (14 == galois_field ? 1 : 0) <<
1180 BCH_FLASHLAYOUT1_GF13_0_GF14_1_OFFSET;
1181 writel(tmp, &bch_regs->hw_bch_flash0layout1);
1183 /* Set *all* chip selects to use layout 0 */
1184 writel(0, &bch_regs->hw_bch_layoutselect);
1186 /* Enable BCH complete interrupt */
1187 writel(BCH_CTRL_COMPLETE_IRQ_EN, &bch_regs->hw_bch_ctrl_set);
1189 /* Hook some operations at the MTD level. */
1190 if (mtd->_read_oob != mxs_nand_hook_read_oob) {
1191 nand_info->hooked_read_oob = mtd->_read_oob;
1192 mtd->_read_oob = mxs_nand_hook_read_oob;
1195 if (mtd->_write_oob != mxs_nand_hook_write_oob) {
1196 nand_info->hooked_write_oob = mtd->_write_oob;
1197 mtd->_write_oob = mxs_nand_hook_write_oob;
1200 if (mtd->_block_markbad != mxs_nand_hook_block_markbad) {
1201 nand_info->hooked_block_markbad = mtd->_block_markbad;
1202 mtd->_block_markbad = mxs_nand_hook_block_markbad;
1205 /* We use the reference implementation for bad block management. */
1206 return nand_default_bbt(mtd);
1210 * Allocate DMA buffers
1212 int mxs_nand_alloc_buffers(struct mxs_nand_info *nand_info)
1215 const int size = NAND_MAX_PAGESIZE + NAND_MAX_OOBSIZE;
1217 nand_info->data_buf_size = roundup(size, MXS_DMA_ALIGNMENT);
1220 buf = memalign(MXS_DMA_ALIGNMENT, nand_info->data_buf_size);
1222 printf("%s: Error allocating DMA buffers\n", __func__);
1226 memset(buf, 0, nand_info->data_buf_size);
1228 nand_info->data_buf = buf;
1229 nand_info->oob_buf = buf + NAND_MAX_PAGESIZE;
1230 /* Command buffers */
1231 nand_info->cmd_buf = memalign(MXS_DMA_ALIGNMENT,
1232 MXS_NAND_COMMAND_BUFFER_SIZE);
1233 if (!nand_info->cmd_buf) {
1235 printf("MXS NAND: Error allocating command buffers\n");
1238 memset(nand_info->cmd_buf, 0, MXS_NAND_COMMAND_BUFFER_SIZE);
1239 nand_info->cmd_queue_len = 0;
1245 * Initializes the NFC hardware.
1247 int mxs_nand_init(struct mxs_nand_info *info)
1252 info->desc = calloc(MXS_NAND_DMA_DESCRIPTOR_COUNT,
1253 sizeof(struct mxs_dma_desc *));
1256 printf("MXS NAND: Unable to allocate DMA descriptor table\n");
1263 /* Allocate the DMA descriptors. */
1264 for (i = 0; i < MXS_NAND_DMA_DESCRIPTOR_COUNT; i++) {
1265 info->desc[i] = mxs_dma_desc_alloc();
1266 if (!info->desc[i]) {
1267 printf("MXS NAND: Unable to allocate DMA descriptors\n");
1273 /* Init the DMA controller. */
1274 for (i = 0; i < CONFIG_SYS_NAND_MAX_CHIPS; i++) {
1275 const int chan = MXS_DMA_CHANNEL_AHB_APBH_GPMI0 + i;
1277 ret = mxs_dma_init_channel(chan);
1279 printf("Failed to initialize DMA channel %d\n", chan);
1284 ret = mxs_nand_gpmi_init();
1291 for (--i; i >= 0; i--)
1292 mxs_dma_release(i + MXS_DMA_CHANNEL_AHB_APBH_GPMI0);
1293 i = MXS_NAND_DMA_DESCRIPTOR_COUNT - 1;
1296 for (--i; i >= 0; i--)
1297 mxs_dma_desc_free(info->desc[i]);
1303 * This function is called during the driver binding process.
1305 * @param pdev the device structure used to store device specific
1306 * information that is used by the suspend, resume and
1309 * @return 0 for success; errno value in case of error
1311 int board_nand_init(struct nand_chip *nand)
1313 struct mxs_nand_info *nand_info;
1316 nand_info = kzalloc(sizeof(struct mxs_nand_info), 0);
1318 printf("MXS NAND: Failed to allocate private data\n");
1322 err = mxs_nand_alloc_buffers(nand_info);
1326 err = mxs_nand_init(nand_info);
1330 memset(&fake_ecc_layout, 0, sizeof(fake_ecc_layout));
1332 nand->priv = nand_info;
1333 nand->options |= NAND_NO_SUBPAGE_WRITE;
1334 #ifdef CONFIG_SYS_NAND_USE_FLASH_BBT
1335 nand->bbt_options |= NAND_BBT_USE_FLASH | NAND_BBT_NO_OOB;
1337 nand->cmd_ctrl = mxs_nand_cmd_ctrl;
1339 nand->dev_ready = mxs_nand_device_ready;
1340 nand->select_chip = mxs_nand_select_chip;
1341 nand->block_bad = mxs_nand_block_bad;
1342 nand->scan_bbt = mxs_nand_scan_bbt;
1344 nand->read_byte = mxs_nand_read_byte;
1346 nand->read_buf = mxs_nand_read_buf;
1347 nand->write_buf = mxs_nand_write_buf;
1349 nand->ecc.read_page = mxs_nand_ecc_read_page;
1350 nand->ecc.write_page = mxs_nand_ecc_write_page;
1351 nand->ecc.read_oob = mxs_nand_ecc_read_oob;
1352 nand->ecc.write_oob = mxs_nand_ecc_write_oob;
1354 nand->ecc.layout = &fake_ecc_layout;
1355 nand->ecc.mode = NAND_ECC_HW;
1356 nand->ecc.bytes = 9;
1357 nand->ecc.size = 512;
1358 nand->ecc.strength = 8;
1363 free(nand_info->data_buf);
1364 free(nand_info->cmd_buf);