#include <cfg/log.h>
#include <cfg/macros.h>
-
#include <io/sam3.h>
-
#include <drv/timer.h>
#include <drv/mt29f.h>
-
+#include <struct/heap.h>
#include <cpu/power.h> /* cpu_relax() */
#include <cpu/types.h>
// Get chip select mask for command register
#define MT29F_CSID(chip) (((chip)->chip_select << NFC_CMD_CSID_SHIFT) & NFC_CMD_CSID_MASK)
+// Get block from page
+#define PAGE(blk) ((blk) * MT29F_PAGES_PER_BLOCK)
+
+// Page from block and page in block
+#define BLOCK(page) ((uint16_t)((page) / MT29F_PAGES_PER_BLOCK))
+#define PAGE_IN_BLOCK(page) ((uint16_t)((page) % MT29F_PAGES_PER_BLOCK))
+
+
+/*
+ * Remap info written in the first page of each block
+ * used to remap bad blocks.
+ */
+struct RemapInfo
+{
+ uint32_t tag; // Magic number to detect valid info
+ uint16_t mapped_blk; // Bad block the block containing this info is remapping
+};
+
/*
* Translate flash page index plus a byte offset
*cycle0 = offset & 0xff;
*cycle1234 = (page << 8) | ((offset >> 8) & 0xf);
- LOG_INFO("mt29f addr: %lx %lx\n", *cycle1234, *cycle0);
+ //LOG_INFO("mt29f addr: %lx %lx\n", *cycle1234, *cycle0);
}
return HWREG(NFC_CMD_BASE_ADDR + NFC_CMD_NFCCMD) & 0x8000000;
}
+
+/*
+ * Return true if SMC/NFC controller completed the last operations.
+ */
INLINE bool isCmdDone(void)
{
return SMC_SR & SMC_SR_CMDDONE;
}
+
+/*
+ * Wait for edge transition of READY/BUSY NAND
+ * signal.
+ * Return true for edge detection, false in case of timeout.
+ */
static bool waitReadyBusy(void)
{
time_t start = timer_clock();
/**
- * Erase the whole block containing given page.
+ * Erase the whole block.
*/
-int mt29f_blockErase(Mt29f *chip, uint32_t page)
+int mt29f_blockErase(Mt29f *chip, uint16_t block)
{
uint32_t cycle0;
uint32_t cycle1234;
- getAddrCycles(page, 0, &cycle0, &cycle1234);
+ uint16_t remapped_block = chip->block_map[block];
+ if (block != remapped_block)
+ {
+ LOG_INFO("mt29f_blockErase: remapped block: blk %d->%d\n", block, remapped_block);
+ block = remapped_block;
+ }
+
+ getAddrCycles(PAGE(block), 0, &cycle0, &cycle1234);
sendCommand(MT29F_CSID(chip) |
NFC_CMD_NFCCMD | NFC_CMD_ACYCLE_THREE | NFC_CMD_VCMD2 |
}
-static bool checkEcc(void)
+static bool checkEcc(Mt29f *chip)
{
- uint32_t sr1 = SMC_ECC_SR1;
+ struct RemapInfo *remap_info = (struct RemapInfo *)(NFC_SRAM_BASE_ADDR + MT29F_REMAP_TAG_OFFSET);
- if (sr1)
+ /*
+ * Check for ECC hardware status only if a valid RemapInfo structure is found.
+ * That guarantees we wrote the block and a valid ECC is present.
+ */
+ if (remap_info->tag == MT29F_REMAP_TAG)
{
- LOG_INFO("ECC error, ECC_SR1=0x%lx\n", sr1);
- return false;
+ uint32_t sr1 = SMC_ECC_SR1;
+ if (sr1)
+ {
+ LOG_INFO("ECC error, ECC_SR1=0x%lx\n", sr1);
+ chip->status |= MT29F_ERR_ECC;
+ return false;
+ }
}
- else
- return true;
+
+ return true;
}
uint32_t cycle0;
uint32_t cycle1234;
- LOG_INFO("mt29f_readPage: page 0x%lx off 0x%x\n", page, offset);
+ //LOG_INFO("mt29f_readPage: page 0x%lx off 0x%x\n", page, offset);
getAddrCycles(page, offset, &cycle0, &cycle1234);
* Read page data and ECC, checking for errors.
* TODO: fix errors with ECC when possible.
*/
-bool mt29f_read(Mt29f *chip, uint32_t page, void *buf, uint16_t size)
+static bool mt29f_read(Mt29f *chip, uint32_t page, void *buf, uint16_t size)
{
- ASSERT(size <= MT29F_DATA_SIZE);
+ uint32_t remapped_page = PAGE(chip->block_map[BLOCK(page)]) + PAGE_IN_BLOCK(page);
+
+ if (page != remapped_page)
+ {
+ LOG_INFO("mt29f_read: remapped block: blk %d->%d, pg %ld->%ld\n",
+ BLOCK(page), chip->block_map[BLOCK(page)], page, remapped_page);
+ page = remapped_page;
+ }
if (!mt29f_readPage(chip, page, 0))
return false;
memcpy(buf, (void *)NFC_SRAM_BASE_ADDR, size);
- return checkEcc();
+ return checkEcc(chip);
}
uint32_t cycle0;
uint32_t cycle1234;
- LOG_INFO("mt29f_writePage: page 0x%lx off 0x%x\n", page, offset);
+ //LOG_INFO("mt29f_writePage: page 0x%lx off 0x%x\n", page, offset);
getAddrCycles(page, offset, &cycle0, &cycle1234);
/*
- * Write the ECC for a page.
+ * Write the spare area in a page: ECC and remap block index.
+ * \param page the page to be written
+ * \parma original_page if different from page, it's the page that's being remapped
*
* ECC data are extracted from ECC_PRx registers and written
* in the page's spare area.
* For 2048 bytes pages and 1 ECC word each 256 bytes,
* 24 bytes of ECC data are stored.
*/
-static bool mt29f_writePageEcc(Mt29f *chip, uint32_t page)
+static bool mt29f_writePageSpare(Mt29f *chip, uint32_t page, uint32_t original_page)
{
int i;
uint32_t *buf = (uint32_t *)NFC_SRAM_BASE_ADDR;
+ struct RemapInfo *remap_info = (struct RemapInfo *)(NFC_SRAM_BASE_ADDR + MT29F_REMAP_TAG_OFFSET);
memset((void *)NFC_SRAM_BASE_ADDR, 0xff, MT29F_SPARE_SIZE);
for (i = 0; i < MT29F_ECC_NWORDS; i++)
buf[i] = *((reg32_t *)(SMC_BASE + SMC_ECC_PR0_OFF) + i);
+ // Write remap tag
+ remap_info->tag = MT29F_REMAP_TAG;
+ remap_info->mapped_blk = BLOCK(original_page);
+
return mt29f_writePage(chip, page, MT29F_DATA_SIZE);
}
-bool mt29f_write(Mt29f *chip, uint32_t page, const void *buf, uint16_t size)
+static bool mt29f_write(Mt29f *chip, uint32_t page, const void *buf, uint16_t size)
{
+ uint32_t remapped_page = PAGE(chip->block_map[BLOCK(page)]) + PAGE_IN_BLOCK(page);
+
+ if (page != remapped_page)
+ LOG_INFO("mt29f_write: remapped block: blk %d->%d, pg %ld->%ld\n",
+ BLOCK(page), chip->block_map[BLOCK(page)], page, remapped_page);
+
return
- mt29f_writePageData(chip, page, buf, size) &&
- mt29f_writePageEcc(chip, page);
+ mt29f_writePageData(chip, remapped_page, buf, size) &&
+ mt29f_writePageSpare(chip, remapped_page, page);
}
-int mt29f_error(Mt29f *chip)
+/*
+ * Check if the given block is marked bad: ONFI standard mandates
+ * that bad block are marked with "00" bytes on the spare area of the
+ * first page in block.
+ */
+static bool blockIsGood(Mt29f *chip, uint16_t blk)
{
- return chip->status;
+ uint8_t *first_byte = (uint8_t *)NFC_SRAM_BASE_ADDR;
+ bool good;
+
+ // Check first byte in spare area of first page in block
+ mt29f_readPage(chip, PAGE(blk), MT29F_DATA_SIZE);
+ good = *first_byte != 0;
+
+ if (!good)
+ LOG_INFO("mt29f: bad block %d\n", blk);
+
+ return good;
}
-void mt29f_clearError(Mt29f *chip)
+/*
+ * Return the main partition block remapped on given block in the remap
+ * partition (dest_blk).
+ */
+static int getBadBlockFromRemapBlock(Mt29f *chip, uint16_t dest_blk)
{
- chip->status = 0;
+ struct RemapInfo *remap_info = (struct RemapInfo *)NFC_SRAM_BASE_ADDR;
+
+ if (!mt29f_readPage(chip, PAGE(dest_blk), MT29F_DATA_SIZE + MT29F_REMAP_TAG_OFFSET))
+ return -1;
+
+ if (remap_info->tag == MT29F_REMAP_TAG)
+ return remap_info->mapped_blk;
+ else
+ return -1;
+}
+
+
+/*
+ * Set a block remapping: src_blk (a block in main data partition) is remappend
+ * on dest_blk (block in reserved remapped blocks partition).
+ */
+static bool setMapping(Mt29f *chip, uint32_t src_blk, uint32_t dest_blk)
+{
+ struct RemapInfo *remap_info = (struct RemapInfo *)NFC_SRAM_BASE_ADDR;
+
+ LOG_INFO("mt29f, setMapping(): src=%ld dst=%ld\n", src_blk, dest_blk);
+
+ if (!mt29f_readPage(chip, PAGE(dest_blk), MT29F_DATA_SIZE + MT29F_REMAP_TAG_OFFSET))
+ return false;
+
+ remap_info->tag = MT29F_REMAP_TAG;
+ remap_info->mapped_blk = src_blk;
+
+ return mt29f_writePage(chip, PAGE(dest_blk), MT29F_DATA_SIZE + MT29F_REMAP_TAG_OFFSET);
+}
+
+
+/*
+ * Get a new block from the remap partition to use as a substitute
+ * for a bad block.
+ */
+static uint16_t getFreeRemapBlock(Mt29f *chip)
+{
+ int blk;
+
+ for (blk = chip->remap_start; blk < MT29F_NUM_BLOCKS; blk++)
+ {
+ if (blockIsGood(chip, blk))
+ {
+ chip->remap_start = blk + 1;
+ return blk;
+ }
+ }
+
+ LOG_ERR("mt29f: reserved blocks for bad block remapping exhausted!\n");
+ return 0;
+}
+
+
+/*
+ * Check if NAND is initialized.
+ */
+static bool chipIsMarked(Mt29f *chip)
+{
+ return getBadBlockFromRemapBlock(chip, MT29F_NUM_USER_BLOCKS) != -1;
+}
+
+
+/*
+ * Initialize NAND (format). Scan NAND for factory marked bad blocks.
+ * All bad blocks found are remapped to the remap partition: each
+ * block in the remap partition used to remap bad blocks is marked.
+ */
+static void initBlockMap(Mt29f *chip)
+{
+ int b, last;
+
+ // Default is for each block to not be remapped
+ for (b = 0; b < MT29F_NUM_BLOCKS; b++)
+ chip->block_map[b] = b;
+ chip->remap_start = MT29F_NUM_USER_BLOCKS;
+
+ if (chipIsMarked(chip))
+ {
+ LOG_INFO("mt29f: found initialized NAND, searching for remapped blocks\n");
+
+ // Scan for assigned blocks in remap area
+ for (b = last = MT29F_NUM_USER_BLOCKS; b < MT29F_NUM_BLOCKS; b++)
+ {
+ int remapped_blk = getBadBlockFromRemapBlock(chip, b);
+ if (remapped_blk != -1 && remapped_blk != b)
+ {
+ LOG_INFO("mt29f: found remapped block %d->%d\n", remapped_blk, b);
+ chip->block_map[remapped_blk] = b;
+ last = b + 1;
+ }
+ }
+ chip->remap_start = last;
+ }
+ else
+ {
+ bool remapped_anything = false;
+
+ LOG_INFO("mt29f: found new NAND, searching for bad blocks\n");
+
+ for (b = 0; b < MT29F_NUM_USER_BLOCKS; b++)
+ {
+ if (!blockIsGood(chip, b))
+ {
+ chip->block_map[b] = getFreeRemapBlock(chip);
+ setMapping(chip, b, chip->block_map[b]);
+ remapped_anything = true;
+ LOG_INFO("mt29f: found new bad block %d, remapped to %d\n", b, chip->block_map[b]);
+ }
+ }
+
+ /*
+ * If no bad blocks are found (we're lucky!) write a dummy
+ * remap to mark NAND and detect we already scanned it next time.
+ */
+ if (!remapped_anything)
+ {
+ setMapping(chip, MT29F_NUM_USER_BLOCKS, MT29F_NUM_USER_BLOCKS);
+ LOG_INFO("mt29f: no bad block founds, marked NAND\n");
+ }
+ }
+}
+
+
+/**
+ * Reset bad blocks map and erase all blocks.
+ *
+ * \note DON'T USE on production chips: this function will try to erase
+ * factory marked bad blocks too.
+ */
+void mt29f_format(Mt29f *chip)
+{
+ int b;
+
+ for (b = 0; b < MT29F_NUM_BLOCKS; b++)
+ {
+ LOG_INFO("mt29f: erasing block %d\n", b);
+ chip->block_map[b] = b;
+ mt29f_blockErase(chip, b);
+ }
+ chip->remap_start = MT29F_NUM_USER_BLOCKS;
+}
+
+#ifdef _DEBUG
+
+/*
+ * Create some bad blocks, erasing them and writing the bad block mark.
+ */
+void mt29f_ruinSomeBlocks(Mt29f *chip)
+{
+ int bads[] = { 7, 99, 555, 1003, 1004, 1432 };
+ unsigned i;
+
+ LOG_INFO("mt29f: erasing mark\n");
+ mt29f_blockErase(chip, MT29F_NUM_USER_BLOCKS);
+
+ for (i = 0; i < countof(bads); i++)
+ {
+ LOG_INFO("mt29f: erasing block %d\n", bads[i]);
+ mt29f_blockErase(chip, bads[i]);
+
+ LOG_INFO("mt29f: marking page %d as bad\n", PAGE(bads[i]));
+ memset((void *)NFC_SRAM_BASE_ADDR, 0, MT29F_SPARE_SIZE);
+ mt29f_writePage(chip, PAGE(bads[i]), MT29F_DATA_SIZE);
+ }
}
+#endif
+
static void initPio(void)
{
}
-void mt29f_init(Mt29f *chip, uint8_t chip_select)
+static bool commonInit(Mt29f *chip, struct Heap *heap, unsigned chip_select)
{
memset(chip, 0, sizeof(Mt29f));
+ DB(chip->fd.priv.type = KBT_NAND);
+ chip->fd.blk_size = MT29F_BLOCK_SIZE;
+ chip->fd.blk_cnt = MT29F_NUM_USER_BLOCKS;
+
chip->chip_select = chip_select;
+ chip->block_map = heap_allocmem(heap, MT29F_NUM_BLOCKS * sizeof(*chip->block_map));
+ if (!chip->block_map)
+ {
+ LOG_ERR("mt29f: error allocating block map\n");
+ return false;
+ }
initPio();
initSmc();
chipReset(chip);
+ initBlockMap(chip);
+
+ return true;
+}
+
+
+/**************** Kblock interface ****************/
+
+
+static size_t mt29f_writeDirect(struct KBlock *kblk, block_idx_t idx, const void *buf, size_t offset, size_t size)
+{
+ ASSERT(offset <= MT29F_BLOCK_SIZE);
+ ASSERT(offset % MT29F_DATA_SIZE == 0);
+ ASSERT(size <= MT29F_BLOCK_SIZE);
+ ASSERT(size % MT29F_DATA_SIZE == 0);
+
+ LOG_INFO("mt29f_writeDirect: blk=%ld\n", idx);
+
+ mt29f_blockErase(MT29F_CAST(kblk), idx);
+
+ while (offset < size)
+ {
+ uint32_t page = PAGE(idx) + (offset / MT29F_DATA_SIZE);
+
+ if (!mt29f_write(MT29F_CAST(kblk), page, buf, MT29F_DATA_SIZE))
+ break;
+
+ offset += MT29F_DATA_SIZE;
+ buf = (const char *)buf + MT29F_DATA_SIZE;
+ }
+
+ return offset;
}
+
+static size_t mt29f_readDirect(struct KBlock *kblk, block_idx_t idx, void *buf, size_t offset, size_t size)
+{
+ ASSERT(offset <= MT29F_BLOCK_SIZE);
+ ASSERT(offset % MT29F_DATA_SIZE == 0);
+ ASSERT(size <= MT29F_BLOCK_SIZE);
+ ASSERT(size % MT29F_DATA_SIZE == 0);
+
+ LOG_INFO("mt29f_readDirect: blk=%ld\n", idx);
+
+ while (offset < size)
+ {
+ uint32_t page = PAGE(idx) + (offset / MT29F_DATA_SIZE);
+
+ if (!mt29f_read(MT29F_CAST(kblk), page, buf, MT29F_DATA_SIZE))
+ break;
+
+ offset += MT29F_DATA_SIZE;
+ buf = (char *)buf + MT29F_DATA_SIZE;
+ }
+
+ return offset;
+}
+
+
+static int mt29f_error(struct KBlock *kblk)
+{
+ Mt29f *chip = MT29F_CAST(kblk);
+ return chip->status;
+}
+
+
+static void mt29f_clearError(struct KBlock *kblk)
+{
+ Mt29f *chip = MT29F_CAST(kblk);
+ chip->status = 0;
+}
+
+
+static const KBlockVTable mt29f_buffered_vt =
+{
+ .readDirect = mt29f_readDirect,
+ .writeDirect = mt29f_writeDirect,
+
+ .readBuf = kblock_swReadBuf,
+ .writeBuf = kblock_swWriteBuf,
+ .load = kblock_swLoad,
+ .store = kblock_swStore,
+
+ .error = mt29f_error,
+ .clearerr = mt29f_clearError,
+};
+
+static const KBlockVTable mt29f_unbuffered_vt =
+{
+ .readDirect = mt29f_readDirect,
+ .writeDirect = mt29f_writeDirect,
+
+ .error = mt29f_error,
+ .clearerr = mt29f_clearError,
+};
+
+
+bool mt29f_init(Mt29f *chip, struct Heap *heap, unsigned chip_select)
+{
+ if (!commonInit(chip, heap, chip_select))
+ return false;
+
+ chip->fd.priv.vt = &mt29f_buffered_vt;
+ chip->fd.priv.flags |= KB_BUFFERED;
+
+ chip->fd.priv.buf = heap_allocmem(heap, MT29F_BLOCK_SIZE);
+ if (!chip->fd.priv.buf)
+ {
+ LOG_ERR("mt29f: error allocating block buffer\n");
+ return false;
+ }
+
+ // Load the first block in the cache
+ return mt29f_readDirect(&chip->fd, 0, chip->fd.priv.buf, 0, MT29F_DATA_SIZE);
+}
+
+
+bool mt29f_initUnbuffered(Mt29f *chip, struct Heap *heap, unsigned chip_select)
+{
+ if (!commonInit(chip, heap, chip_select))
+ return false;
+
+ chip->fd.priv.vt = &mt29f_unbuffered_vt;
+ return true;
+}
+
+
projects / bertos.git / blobdiff