4 * This file is part of BeRTOS.
6 * Bertos is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * As a special exception, you may use this file as part of a free software
21 * library without restriction. Specifically, if other files instantiate
22 * templates or use macros or inline functions from this file, or you compile
23 * this file and link it with other files to produce an executable, this
24 * file does not by itself cause the resulting executable to be covered by
25 * the GNU General Public License. This exception does not however
26 * invalidate any other reasons why the executable file might be covered by
27 * the GNU General Public License.
29 * Copyright 2011 Develer S.r.l. (http://www.develer.com/)
33 * \brief Micron MT29F serial NAND driver for SAM3's static memory controller.
35 * \author Stefano Fedrigo <aleph@develer.com>
38 #include "mt29f_sam3.h"
39 #include "cfg/cfg_mt29f.h"
41 // Define log settings for cfg/log.h
42 #define LOG_LEVEL CONFIG_MT29F_LOG_LEVEL
43 #define LOG_FORMAT CONFIG_MT29F_LOG_FORMAT
46 #include <cfg/macros.h>
48 #include <drv/timer.h>
49 #include <drv/mt29f.h>
50 #include <struct/heap.h>
51 #include <cpu/power.h> /* cpu_relax() */
52 #include <cpu/types.h>
54 #include <string.h> /* memcpy() */
56 // Timeout for NAND operations in ms
57 #define MT29F_TMOUT 100
59 // NAND flash status codes
60 #define MT29F_STATUS_READY BV(6)
61 #define MT29F_STATUS_ERROR BV(0)
63 // NAND flash commands
64 #define MT29F_CMD_READ_1 0x00
65 #define MT29F_CMD_READ_2 0x30
66 #define MT29F_CMD_COPYBACK_READ_1 0x00
67 #define MT29F_CMD_COPYBACK_READ_2 0x35
68 #define MT29F_CMD_COPYBACK_PROGRAM_1 0x85
69 #define MT29F_CMD_COPYBACK_PROGRAM_2 0x10
70 #define MT29F_CMD_RANDOM_OUT 0x05
71 #define MT29F_CMD_RANDOM_OUT_2 0xE0
72 #define MT29F_CMD_RANDOM_IN 0x85
73 #define MT29F_CMD_READID 0x90
74 #define MT29F_CMD_WRITE_1 0x80
75 #define MT29F_CMD_WRITE_2 0x10
76 #define MT29F_CMD_ERASE_1 0x60
77 #define MT29F_CMD_ERASE_2 0xD0
78 #define MT29F_CMD_STATUS 0x70
79 #define MT29F_CMD_RESET 0xFF
81 // Addresses for sending command, addresses and data bytes to flash
82 #define MT29F_CMD_ADDR 0x60400000
83 #define MT29F_ADDR_ADDR 0x60200000
84 #define MT29F_DATA_ADDR 0x60000000
86 // Get chip select mask for command register
87 #define MT29F_CSID(chip) (((chip)->chip_select << NFC_CMD_CSID_SHIFT) & NFC_CMD_CSID_MASK)
91 * Remap info written in the first page of each block
92 * used to remap bad blocks.
96 uint32_t tag; // Magic number to detect valid info
97 uint16_t mapped_blk; // Bad block the block containing this info is remapping
102 * Translate flash page index plus a byte offset
103 * in the five address cycles format needed by NAND.
105 * Cycles in x8 mode as the MT29F2G08AAD
106 * CA = column addr, PA = page addr, BA = block addr
108 * Cycle I/O7 I/O6 I/O5 I/O4 I/O3 I/O2 I/O1 I/O0
109 * -------------------------------------------------------
110 * First CA7 CA6 CA5 CA4 CA3 CA2 CA1 CA0
111 * Second LOW LOW LOW LOW CA11 CA10 CA9 CA8
112 * Third BA7 BA6 PA5 PA4 PA3 PA2 PA1 PA0
113 * Fourth BA15 BA14 BA13 BA12 BA11 BA10 BA9 BA8
114 * Fifth LOW LOW LOW LOW LOW LOW LOW BA16
116 static void getAddrCycles(uint32_t page, uint16_t offset, uint32_t *cycle0, uint32_t *cycle1234)
118 ASSERT(offset < MT29F_PAGE_SIZE);
120 *cycle0 = offset & 0xff;
121 *cycle1234 = (page << 8) | ((offset >> 8) & 0xf);
123 //LOG_INFO("mt29f addr: %lx %lx\n", *cycle1234, *cycle0);
127 INLINE bool nfcIsBusy(void)
129 return HWREG(NFC_CMD_BASE_ADDR + NFC_CMD_NFCCMD) & 0x8000000;
134 * Return true if SMC/NFC controller completed the last operations.
136 INLINE bool isCmdDone(void)
138 return SMC_SR & SMC_SR_CMDDONE;
143 * Wait for edge transition of READY/BUSY NAND
145 * Return true for edge detection, false in case of timeout.
147 static bool waitReadyBusy(void)
149 time_t start = timer_clock();
151 while (!(SMC_SR & SMC_SR_RB_EDGE0))
154 if (timer_clock() - start > MT29F_TMOUT)
156 LOG_INFO("mt29f: R/B timeout\n");
165 * Wait for transfer to complete until timeout.
166 * If transfer completes return true, false in case of timeout.
168 static bool waitTransferComplete(void)
170 time_t start = timer_clock();
172 while (!(SMC_SR & SMC_SR_XFRDONE))
175 if (timer_clock() - start > MT29F_TMOUT)
177 LOG_INFO("mt29f: xfer complete timeout\n");
187 * Send command to NAND and wait for completion.
189 static void sendCommand(uint32_t cmd,
190 int num_cycles, uint32_t cycle0, uint32_t cycle1234)
199 cmd_addr = (reg32_t *)(NFC_CMD_BASE_ADDR + cmd);
200 *cmd_addr = cycle1234;
202 while (!isCmdDone());
206 static bool isOperationComplete(Mt29f *chip)
210 sendCommand(MT29F_CSID(chip) |
211 NFC_CMD_NFCCMD | NFC_CMD_ACYCLE_NONE |
212 MT29F_CMD_STATUS << 2,
215 status = (uint8_t)HWREG(MT29F_DATA_ADDR);
216 return (status & MT29F_STATUS_READY) && !(status & MT29F_STATUS_ERROR);
220 static void chipReset(Mt29f *chip)
222 sendCommand(MT29F_CSID(chip) |
223 NFC_CMD_NFCCMD | NFC_CMD_ACYCLE_NONE |
224 MT29F_CMD_RESET << 2,
232 * Erase the whole block.
234 int mt29f_blockErase(Mt29f *chip, uint16_t block)
239 getAddrCycles(block * MT29F_PAGES_PER_BLOCK, 0, &cycle0, &cycle1234);
241 sendCommand(MT29F_CSID(chip) |
242 NFC_CMD_NFCCMD | NFC_CMD_ACYCLE_THREE | NFC_CMD_VCMD2 |
243 (MT29F_CMD_ERASE_2 << 10) | (MT29F_CMD_ERASE_1 << 2),
244 3, 0, cycle1234 >> 8);
248 if (!isOperationComplete(chip))
250 LOG_ERR("mt29f: error erasing block\n");
251 chip->status |= MT29F_ERR_ERASE;
260 * Read Device ID and configuration codes.
262 bool mt29f_getDevId(Mt29f *chip, uint8_t dev_id[5])
264 sendCommand(MT29F_CSID(chip) |
265 NFC_CMD_NFCCMD | NFC_CMD_NFCEN | NFC_CMD_ACYCLE_ONE |
266 MT29F_CMD_READID << 2,
270 if (!waitTransferComplete())
272 LOG_ERR("mt29f: getDevId timeout\n");
273 chip->status |= MT29F_ERR_RD_TMOUT;
277 memcpy(dev_id, (void *)NFC_SRAM_BASE_ADDR, 5);
282 static bool checkEcc(Mt29f *chip)
284 struct RemapInfo *remap_info = (struct RemapInfo *)(NFC_SRAM_BASE_ADDR + MT29F_REMAP_TAG_OFFSET);
287 * Check for ECC hardware status only if a valid RemapInfo structure is found.
288 * That guarantees we wrote the block and a valid ECC is present.
290 if (remap_info->tag == MT29F_REMAP_TAG)
292 uint32_t sr1 = SMC_ECC_SR1;
295 LOG_INFO("ECC error, ECC_SR1=0x%lx\n", sr1);
296 chip->status |= MT29F_ERR_ECC;
305 static bool mt29f_readPage(Mt29f *chip, uint32_t page, uint16_t offset)
310 //LOG_INFO("mt29f_readPage: page 0x%lx off 0x%x\n", page, offset);
312 getAddrCycles(page, offset, &cycle0, &cycle1234);
314 sendCommand(MT29F_CSID(chip) |
315 NFC_CMD_NFCCMD | NFC_CMD_NFCEN | NFC_CMD_ACYCLE_FIVE | NFC_CMD_VCMD2 |
316 (MT29F_CMD_READ_2 << 10) | (MT29F_CMD_READ_1 << 2),
317 5, cycle0, cycle1234);
320 if (!waitTransferComplete())
322 LOG_ERR("mt29f: read timeout\n");
323 chip->status |= MT29F_ERR_RD_TMOUT;
332 * Read page data and ECC, checking for errors.
333 * TODO: fix errors with ECC when possible.
335 bool mt29f_read(Mt29f *chip, uint32_t page, void *buf, uint16_t size)
337 ASSERT(size <= MT29F_DATA_SIZE);
339 if (!mt29f_readPage(chip, page, 0))
342 memcpy(buf, (void *)NFC_SRAM_BASE_ADDR, size);
349 * Write data in NFC SRAM buffer to a NAND page, starting at a given offset.
350 * Usually offset will be 0 to write data or MT29F_DATA_SIZE to write the spare
353 * According to datasheet to get ECC computed by hardware is sufficient
354 * to write the main area. But it seems that in that way the last ECC_PR
355 * register is not generated. The workaround is to write data and dummy (ff)
356 * spare data in one write, at this point the last ECC_PR is correct and
357 * ECC data can be written in the spare area with a second program operation.
359 static bool mt29f_writePage(Mt29f *chip, uint32_t page, uint16_t offset)
364 LOG_INFO("mt29f_writePage: page 0x%lx off 0x%x\n", page, offset);
366 getAddrCycles(page, offset, &cycle0, &cycle1234);
368 sendCommand(MT29F_CSID(chip) |
369 NFC_CMD_NFCCMD | NFC_CMD_NFCWR | NFC_CMD_NFCEN | NFC_CMD_ACYCLE_FIVE |
370 MT29F_CMD_WRITE_1 << 2,
371 5, cycle0, cycle1234);
373 if (!waitTransferComplete())
375 LOG_ERR("mt29f: write timeout\n");
376 chip->status |= MT29F_ERR_WR_TMOUT;
380 sendCommand(MT29F_CSID(chip) |
381 NFC_CMD_NFCCMD | NFC_CMD_ACYCLE_NONE |
382 MT29F_CMD_WRITE_2 << 2,
387 if (!isOperationComplete(chip))
389 LOG_ERR("mt29f: error writing page\n");
390 chip->status |= MT29F_ERR_WRITE;
399 * Write data in a page.
401 static bool mt29f_writePageData(Mt29f *chip, uint32_t page, const void *buf, uint16_t size)
403 ASSERT(size <= MT29F_DATA_SIZE);
405 memset((void *)NFC_SRAM_BASE_ADDR, 0xff, MT29F_PAGE_SIZE);
406 memcpy((void *)NFC_SRAM_BASE_ADDR, buf, size);
408 return mt29f_writePage(chip, page, 0);
413 * Write the spare area in a page: ECC and remap block index.
415 * ECC data are extracted from ECC_PRx registers and written
416 * in the page's spare area.
417 * For 2048 bytes pages and 1 ECC word each 256 bytes,
418 * 24 bytes of ECC data are stored.
420 static bool mt29f_writePageSpare(Mt29f *chip, uint32_t page)
423 uint32_t *buf = (uint32_t *)NFC_SRAM_BASE_ADDR;
424 uint16_t blk = page / MT29F_PAGES_PER_BLOCK;
425 uint16_t page_in_blk = page % MT29F_PAGES_PER_BLOCK;
426 struct RemapInfo *remap_info = (struct RemapInfo *)(NFC_SRAM_BASE_ADDR + MT29F_REMAP_TAG_OFFSET);
428 memset((void *)NFC_SRAM_BASE_ADDR, 0xff, MT29F_SPARE_SIZE);
430 for (i = 0; i < MT29F_ECC_NWORDS; i++)
431 buf[i] = *((reg32_t *)(SMC_BASE + SMC_ECC_PR0_OFF) + i);
433 // Check for remapped block
434 if (chip->block_map[blk] != blk)
435 page = chip->block_map[blk] * MT29F_PAGES_PER_BLOCK + page_in_blk;
438 remap_info->tag = MT29F_REMAP_TAG;
439 remap_info->mapped_blk = blk;
441 return mt29f_writePage(chip, page, MT29F_DATA_SIZE);
445 bool mt29f_write(Mt29f *chip, uint32_t page, const void *buf, uint16_t size)
448 mt29f_writePageData(chip, page, buf, size) &&
449 mt29f_writePageSpare(chip, page);
453 int mt29f_error(Mt29f *chip)
459 void mt29f_clearError(Mt29f *chip)
466 * Check if the given block is marked bad: ONFI standard mandates
467 * that bad block are marked with "00" bytes on the spare area of the
468 * first page in block.
470 static bool blockIsGood(Mt29f *chip, uint16_t blk)
472 uint8_t *first_byte = (uint8_t *)NFC_SRAM_BASE_ADDR;
475 // Check first byte in spare area of first page in block
476 mt29f_readPage(chip, blk * MT29F_PAGES_PER_BLOCK, MT29F_DATA_SIZE);
477 good = *first_byte == 0xFF;
480 LOG_INFO("mt29f: bad block %d\n", blk);
487 * Return the main partition block remapped on given block in the remap
488 * partition (dest_blk).
490 static int getBadBlockFromRemapBlock(Mt29f *chip, uint16_t dest_blk)
492 struct RemapInfo *remap_info = (struct RemapInfo *)NFC_SRAM_BASE_ADDR;
494 if (!mt29f_readPage(chip, dest_blk * MT29F_PAGES_PER_BLOCK, MT29F_DATA_SIZE + MT29F_REMAP_TAG_OFFSET))
497 if (remap_info->tag == MT29F_REMAP_TAG)
498 return remap_info->mapped_blk;
505 * Set a block remapping: src_blk (a block in main data partition) is remappend
506 * on dest_blk (block in reserved remapped blocks partition).
508 static bool setMapping(Mt29f *chip, uint32_t src_blk, uint32_t dest_blk)
510 struct RemapInfo *remap_info = (struct RemapInfo *)NFC_SRAM_BASE_ADDR;
512 LOG_INFO("mt29f, setMapping(): src=%ld dst=%ld\n", src_blk, dest_blk);
514 if (!mt29f_readPage(chip, dest_blk * MT29F_PAGES_PER_BLOCK, MT29F_DATA_SIZE + MT29F_REMAP_TAG_OFFSET))
517 remap_info->tag = MT29F_REMAP_TAG;
518 remap_info->mapped_blk = src_blk;
520 return mt29f_writePage(chip, dest_blk * MT29F_PAGES_PER_BLOCK, MT29F_DATA_SIZE + MT29F_REMAP_TAG_OFFSET);
525 * Get a new block from the remap partition to use as a substitute
528 static uint16_t getFreeRemapBlock(Mt29f *chip)
532 for (blk = chip->remap_start; blk < MT29F_NUM_BLOCKS; blk++)
534 if (blockIsGood(chip, blk))
536 chip->remap_start = blk + 1;
541 LOG_ERR("mt29f: reserved blocks for bad block remapping exhausted!\n");
547 * Check if NAND is initialized.
549 static bool chipIsMarked(Mt29f *chip)
551 return getBadBlockFromRemapBlock(chip, MT29F_NUM_USER_BLOCKS) != -1;
556 * Initialize NAND (format). Scan NAND for factory marked bad blocks.
557 * All bad blocks found are remapped to the remap partition: each
558 * block in the remap partition used to remap bad blocks is marked.
560 static void initBlockMap(Mt29f *chip)
564 // Default is for each block to not be remapped
565 for (b = 0; b < MT29F_NUM_USER_BLOCKS; b++)
566 chip->block_map[b] = b;
567 chip->remap_start = MT29F_NUM_USER_BLOCKS;
569 if (chipIsMarked(chip))
571 LOG_INFO("mt29f: found initialized NAND, searching for remapped blocks\n");
573 // Scan for assigned blocks in remap area
574 for (b = last = MT29F_NUM_USER_BLOCKS; b < MT29F_NUM_BLOCKS; b++)
576 if (blockIsGood(chip, b))
578 int remapped_blk = getBadBlockFromRemapBlock(chip, b);
579 if (remapped_blk != -1 && remapped_blk != MT29F_NULL_REMAP)
581 LOG_INFO("mt29f: found remapped block %d->%d\n", remapped_blk, b);
582 chip->block_map[remapped_blk] = b;
587 chip->remap_start = last;
591 bool remapped_anything = false;
593 LOG_INFO("mt29f: found new NAND, searching for bad blocks\n");
595 for (b = 0; b < MT29F_NUM_USER_BLOCKS; b++)
597 if (!blockIsGood(chip, b))
599 chip->block_map[b] = getFreeRemapBlock(chip);
600 setMapping(chip, b, chip->block_map[b]);
601 remapped_anything = true;
602 LOG_INFO("mt29f: found new bad block %d, remapped to %d\n", b, chip->block_map[b]);
607 * If no bad blocks are found (we're lucky!) write a dummy
608 * remap to mark NAND and detect we already scanned it next time.
610 if (!remapped_anything)
612 setMapping(chip, MT29F_NULL_REMAP, MT29F_NUM_USER_BLOCKS);
613 LOG_INFO("mt29f: no bad block founds, marked NAND\n");
623 * DON'T USE on production chips: this function will try to erase
624 * factory marked bad blocks too.
626 static void mt29f_wipe(Mt29f *chip)
629 for (b = 0; b < MT29F_NUM_BLOCKS; b++)
631 LOG_INFO("mt29f: erasing block %d\n", b);
632 mt29f_blockErase(chip, b);
637 * Create some bad blocks, erasing them and writing the bad block mark.
639 static void mt29f_ruinSomeBlocks(Mt29f *chip)
641 int bads[] = { 7, 99, 555, 1003, 1004, 1432 };
644 LOG_INFO("mt29f: erasing mark\n");
645 mt29f_blockErase(chip, MT29F_NUM_USER_BLOCKS);
647 for (i = 0; i < countof(bads); i++)
649 LOG_INFO("mt29f: erasing block %d\n", bads[i]);
650 mt29f_blockErase(chip, bads[i]);
652 LOG_INFO("mt29f: marking page %d as bad\n", bads[i] * MT29F_PAGES_PER_BLOCK);
653 memset((void *)NFC_SRAM_BASE_ADDR, 0, MT29F_SPARE_SIZE);
654 mt29f_writePage(chip, bads[i] * MT29F_PAGES_PER_BLOCK, MT29F_DATA_SIZE);
661 static void initPio(void)
664 * TODO: put following stuff in hw_ file dependent
665 * Parameters for MT29F8G08AAD
667 pmc_periphEnable(PIOA_ID);
668 pmc_periphEnable(PIOC_ID);
669 pmc_periphEnable(PIOD_ID);
671 PIO_PERIPH_SEL(PIOA_BASE, MT29F_PINS_PORTA, MT29F_PERIPH_PORTA);
672 PIOA_PDR = MT29F_PINS_PORTA;
673 PIOA_PUER = MT29F_PINS_PORTA;
675 PIO_PERIPH_SEL(PIOC_BASE, MT29F_PINS_PORTC, MT29F_PERIPH_PORTC);
676 PIOC_PDR = MT29F_PINS_PORTC;
677 PIOC_PUER = MT29F_PINS_PORTC;
679 PIO_PERIPH_SEL(PIOD_BASE, MT29F_PINS_PORTD, MT29F_PERIPH_PORTD);
680 PIOD_PDR = MT29F_PINS_PORTD;
681 PIOD_PUER = MT29F_PINS_PORTD;
683 pmc_periphEnable(SMC_SDRAMC_ID);
687 static void initSmc(void)
689 SMC_SETUP0 = SMC_SETUP_NWE_SETUP(0)
690 | SMC_SETUP_NCS_WR_SETUP(0)
691 | SMC_SETUP_NRD_SETUP(0)
692 | SMC_SETUP_NCS_RD_SETUP(0);
694 SMC_PULSE0 = SMC_PULSE_NWE_PULSE(2)
695 | SMC_PULSE_NCS_WR_PULSE(3)
696 | SMC_PULSE_NRD_PULSE(2)
697 | SMC_PULSE_NCS_RD_PULSE(3);
699 SMC_CYCLE0 = SMC_CYCLE_NWE_CYCLE(3)
700 | SMC_CYCLE_NRD_CYCLE(3);
702 SMC_TIMINGS0 = SMC_TIMINGS_TCLR(1)
703 | SMC_TIMINGS_TADL(6)
707 | SMC_TIMINGS_RBNSEL(7)
710 SMC_MODE0 = SMC_MODE_READ_MODE
711 | SMC_MODE_WRITE_MODE;
713 SMC_CFG = SMC_CFG_PAGESIZE_PS2048_64
715 | SMC_CFG_DTOMUL_X1048576
716 | SMC_CFG_DTOCYC(0xF)
720 // Disable SMC interrupts, reset and enable NFC controller
723 SMC_CTRL = SMC_CTRL_NFCEN;
725 // Enable ECC, 1 ECC per 256 bytes
726 SMC_ECC_CTRL = SMC_ECC_CTRL_SWRST;
727 SMC_ECC_MD = SMC_ECC_MD_ECC_PAGESIZE_PS2048_64 | SMC_ECC_MD_TYPCORREC_C256B;
731 bool mt29f_init(Mt29f *chip, struct Heap *heap, uint8_t chip_select)
733 memset(chip, 0, sizeof(Mt29f));
735 chip->chip_select = chip_select;
736 chip->block_map = heap_allocmem(heap, MT29F_NUM_USER_BLOCKS * sizeof(*chip->block_map));
737 if (!chip->block_map)
739 LOG_ERR("mt29f: error allocating block map\n");