2 * YAFFS: Yet Another Flash File System. A NAND-flash specific file system.
4 * Copyright (C) 2002-2018 Aleph One Ltd.
6 * Created by Charles Manning <charles@aleph1.co.uk>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
14 * This version hacked for emulating 2kpage NAND for YAFFS2 testing.
17 //#include <linux/config.h>
18 #include <linux/kernel.h>
19 #include <linux/module.h>
20 #include <linux/version.h>
21 #include <linux/slab.h>
22 #include <linux/init.h>
23 #include <linux/list.h>
25 #include <linux/proc_fs.h>
26 #include <linux/pagemap.h>
27 #include <linux/mtd/mtd.h>
28 #include <linux/interrupt.h>
29 #include <linux/string.h>
30 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
31 #include <linux/locks.h>
34 #include <asm/uaccess.h>
35 #include <linux/mtd/mtd.h>
36 #include <linux/mtd/partitions.h>
37 #include <linux/mtd/nand.h>
38 #include "../yaffs_nandemul2k.h"
40 #define ALLOCATE(x) kmalloc(x,GFP_KERNEL)
41 #define FREE(x) kfree(x)
47 #define NAND_SHIFT (11) // Shifter for 2k
48 #define PAGE_DATA_SIZE (1 << NAND_SHIFT)
49 #define PAGE_SPARE_SIZE (64)
51 #define PAGES_PER_BLOCK (1 << BLK_SHIFT) // = 64
54 #define EM_SIZE_IN_MEG 4
55 #define EM_SIZE_IN_BYTES (EM_SIZE_IN_MEG * (1<<20))
57 #define PAGE_TOTAL_SIZE (PAGE_DATA_SIZE+PAGE_SPARE_SIZE)
59 #define BLOCK_TOTAL_SIZE (PAGES_PER_BLOCK * PAGE_TOTAL_SIZE)
61 #define BLOCKS_PER_MEG ((1<<20)/(PAGES_PER_BLOCK * PAGE_DATA_SIZE))
64 static struct mtd_info nandemul2k_mtd;
68 u8 data[PAGE_TOTAL_SIZE]; // Data + spare
69 int empty; // is this empty?
75 nandemul_Page *page[PAGES_PER_BLOCK];
83 nandemul_Block**block;
87 static nandemul_Device ned;
89 static int sizeInMB = EM_SIZE_IN_MEG;
92 static void nandemul_yield(int n)
95 if(n > 0) schedule_timeout(n);
101 static void nandemul2k_Read(void *buffer, int page, int start, int n_bytes)
103 int pg = page%PAGES_PER_BLOCK;
104 int blk = page/PAGES_PER_BLOCK;
105 if(buffer && n_bytes > 0)
107 memcpy(buffer,&ned.block[blk]->page[pg]->data[start],n_bytes);
112 static void nandemul2k_Program(const void *buffer, int page, int start, int n_bytes)
114 int pg = page%PAGES_PER_BLOCK;
115 int blk = page/PAGES_PER_BLOCK;
117 u8 *b = (u8 *)buffer;
119 p = &ned.block[blk]->page[pg]->data[start];
121 while(buffer && n_bytes>0)
130 static void nandemul2k_DoErase(int blockNumber)
136 if(blockNumber < 0 || blockNumber >= ned.nBlocks)
141 blk = ned.block[blockNumber];
143 for(i = 0; i < PAGES_PER_BLOCK; i++)
145 memset(blk->page[i],0xff,sizeof(nandemul_Page));
146 blk->page[i]->empty = 1;
152 static int nandemul2k_CalcNBlocks(void)
154 return EM_SIZE_IN_MEG * BLOCKS_PER_MEG;
159 static int CheckInit(void)
161 static int initialised = 0;
176 ned.nBlocks = nBlocks = nandemul2k_CalcNBlocks();
179 ned.block = ALLOCATE(sizeof(nandemul_Block*) * nBlocks );
181 if(!ned.block) return ENOMEM;
187 for(i=fail=0; i <nBlocks; i++)
192 if(!(blk = ned.block[i] = ALLOCATE(sizeof(nandemul_Block))))
198 for(j = 0; j < PAGES_PER_BLOCK; j++)
200 if((blk->page[j] = ALLOCATE(sizeof(nandemul_Page))) == 0)
205 nandemul2k_DoErase(i);
206 ned.block[i]->damaged = 0;
215 for(i = 0; i < nAllocated; i++)
224 ned.nBlocks = nBlocks;
233 static void nandemul2k_CleanUp(void)
237 for(i = 0; i < ned.nBlocks; i++)
239 for(j = 0; j < PAGES_PER_BLOCK; j++)
241 FREE(ned.block[i]->page[j]);
250 int nandemul2k_GetBytesPerChunk(void) { return PAGE_DATA_SIZE;}
252 int nandemul2k_GetChunksPerBlock(void) { return PAGES_PER_BLOCK; }
253 int nandemul2k_GetNumberOfBlocks(void) {return nandemul2k_CalcNBlocks();}
257 static int nandemul2k_ReadId(u8 *vendorId, u8 *deviceId)
266 static int nandemul2k_ReadStatus(u8 *status)
273 #ifdef CONFIG_MTD_NAND_ECC
274 #include <linux/mtd/nand_ecc.h>
278 * NAND low-level MTD interface functions
280 static int nand_read (struct mtd_info *mtd, loff_t from, size_t len,
281 size_t *retlen, u_char *buf);
282 static int nand_read_oob (struct mtd_info *mtd, loff_t from, size_t len,
283 size_t *retlen, u_char *buf);
284 static int nand_write (struct mtd_info *mtd, loff_t to, size_t len,
285 size_t *retlen, const u_char *buf);
286 static int nand_write_oob (struct mtd_info *mtd, loff_t to, size_t len,
287 size_t *retlen, const u_char *buf);
288 #if (LINUX_VERSION_CODE > KERNEL_VERSION(2,6,7))
289 static int nand_writev (struct mtd_info *mtd, const struct kvec *vecs,
290 unsigned long count, loff_t to, size_t *retlen);
292 static int nand_writev (struct mtd_info *mtd, const struct iovec *vecs,
293 unsigned long count, loff_t to, size_t *retlen);
295 static int nand_erase (struct mtd_info *mtd, struct erase_info *instr);
296 static void nand_sync (struct mtd_info *mtd);
303 static int nand_read (struct mtd_info *mtd, loff_t from, size_t len,
304 size_t *retlen, u_char *buf)
306 return nand_read_ecc (mtd, from, len, retlen, buf, NULL,NULL);
313 static int nand_read_ecc (struct mtd_info *mtd, loff_t from, size_t len,
314 size_t *retlen, u_char *buf, u_char *oob_buf,struct nand_oobinfo *oobsel)
322 /* Do not allow reads past end of device */
323 if ((from + len) > mtd->size) {
329 /* Initialize return value */
335 /* First we calculate the starting page */
336 page = from >> NAND_SHIFT;
338 /* Get raw starting column */
340 start = from & (PAGE_DATA_SIZE - 1);
342 // OK now check for the curveball where the start and end are in
344 if((start + n) < PAGE_DATA_SIZE)
350 nToCopy = PAGE_DATA_SIZE - start;
353 nandemul2k_Read(buf, page, start, nToCopy);
354 nandemul2k_Read(oob_buf,page,PAGE_DATA_SIZE,PAGE_SPARE_SIZE);
359 if(oob_buf) oob_buf += PAGE_SPARE_SIZE;
369 * NAND read out-of-band
371 static int nand_read_oob (struct mtd_info *mtd, loff_t from, size_t len,
372 size_t *retlen, u_char *buf)
376 T(0,("nand_read_oob: from = 0x%08x, buf = 0x%08x, len = %i\n", (unsigned int) from, (unsigned int) buf,
379 /* Shift to get page */
380 page = ((int) from) >> NAND_SHIFT;
382 /* Mask to get column */
383 col = from & (PAGE_SPARE_SIZE-1)
385 /* Initialize return length value */
388 /* Do not allow reads past end of device */
389 if ((from + len) > mtd->size) {
391 ("nand_read_oob: Attempt read beyond end of device\n"));
396 nandemul2k_Read(buf,page,PAGE_DATA_SIZE + col,len);
406 static int nand_write (struct mtd_info *mtd, loff_t to, size_t len,
407 size_t *retlen, const u_char *buf)
409 return nand_write_ecc (mtd, to, len, retlen, buf, NULL,NULL);
413 * NAND write with ECC
415 static int nand_write_ecc (struct mtd_info *mtd, loff_t to, size_t len,
416 size_t *retlen, const u_char *buf,
417 u_char *oob_buf, struct nand_oobinfo *dummy)
426 /* Do not allow reads past end of device */
427 if ((to + len) > mtd->size) {
433 /* Initialize return value */
439 /* First we calculate the starting page */
440 page = to >> NAND_SHIFT;
442 /* Get raw starting column */
444 start = to & (PAGE_DATA_SIZE - 1);
446 // OK now check for the curveball where the start and end are in
448 if((start + n) < PAGE_DATA_SIZE)
454 nToCopy = PAGE_DATA_SIZE - start;
457 nandemul2k_Program(buf, page, start, nToCopy);
458 nandemul2k_Program(oob_buf, page, PAGE_DATA_SIZE, PAGE_SPARE_SIZE);
463 if(oob_buf) oob_buf += PAGE_SPARE_SIZE;
473 * NAND write out-of-band
475 static int nand_write_oob (struct mtd_info *mtd, loff_t to, size_t len,
476 size_t *retlen, const u_char *buf)
482 "nand_read_oob: to = 0x%08x, len = %i\n", (unsigned int) to,
485 /* Shift to get page */
486 page = ((int) to) >> NAND_SHIFT;
488 /* Mask to get column */
489 col = to & PAGE_SPARE_SIZE;
491 /* Initialize return length value */
494 /* Do not allow reads past end of device */
495 if ((to + len) > mtd->size) {
497 "nand_read_oob: Attempt read beyond end of device\n"));
502 nandemul2k_Program(buf,page,512 + col,len);
511 * NAND write with iovec
513 #if (LINUX_VERSION_CODE > KERNEL_VERSION(2,6,7))
514 static int nand_writev (struct mtd_info *mtd, const struct kvec *vecs,
515 unsigned long count, loff_t to, size_t *retlen)
517 static int nand_writev (struct mtd_info *mtd, const struct iovec *vecs,
518 unsigned long count, loff_t to, size_t *retlen)
527 static int nand_erase (struct mtd_info *mtd, struct erase_info *instr)
529 int i, nBlocks,block;
532 "nand_erase: start = 0x%08x, len = %i\n",
533 (unsigned int) instr->addr, (unsigned int) instr->len));
535 /* Start address must align on block boundary */
536 if (instr->addr & (mtd->erasesize - 1)) {
538 "nand_erase: Unaligned address\n"));
542 /* Length must align on block boundary */
543 if (instr->len & (mtd->erasesize - 1)) {
545 "nand_erase: Length not block aligned\n"));
549 /* Do not allow erase past end of device */
550 if ((instr->len + instr->addr) > mtd->size) {
552 "nand_erase: Erase past end of device\n"));
556 nBlocks = instr->len >> (NAND_SHIFT + BLK_SHIFT);
557 block = instr->addr >> (NAND_SHIFT + BLK_SHIFT);
559 for(i = 0; i < nBlocks; i++)
561 nandemul2k_DoErase(block);
565 instr->state = MTD_ERASE_DONE; /* Changed state to done */
566 instr->callback(instr); /* ... and wake up */
574 static int nand_block_isbad(struct mtd_info *mtd, loff_t ofs)
579 static int nand_block_markbad(struct mtd_info *mtd, loff_t ofs)
588 static void nand_sync (struct mtd_info *mtd)
590 T(0,("nand_sync: called\n"));
595 * Scan for the NAND device
597 static int nandemul2k_scan (struct mtd_info *mtd,int nchips)
599 mtd->writesize = PAGE_DATA_SIZE;
600 mtd->oobsize = PAGE_SPARE_SIZE;
601 mtd->oobavail = PAGE_SPARE_SIZE/2; /* Simulate using up some for other uses */
602 mtd->erasesize = PAGE_DATA_SIZE * PAGES_PER_BLOCK;
603 mtd->size = sizeInMB * 1024*1024;
607 /* Fill in remaining MTD driver data */
608 mtd->type = MTD_NANDFLASH;
609 mtd->flags = MTD_CAP_NANDFLASH;
610 mtd->owner = THIS_MODULE;
611 mtd->erase = nand_erase;
614 mtd->read = nand_read;
615 mtd->write = nand_write;
616 mtd->read_oob = nand_read_oob;
617 mtd->write_oob = nand_write_oob;
618 mtd->read_oob = nand_read_oob;
619 mtd->write_oob = nand_write_oob;
620 mtd->block_isbad = nand_block_isbad;
621 mtd->block_markbad = nand_block_markbad;
623 mtd->writev = nand_writev;
624 mtd->sync = nand_sync;
630 mtd->name = "NANDemul2k";
638 MODULE_PARM(sizeInMB, "i");
640 __setup("sizeInMB=",sizeInMB);
645 * Define partitions for flash devices
648 static struct mtd_partition nandemul2k_partition[] =
650 { .name = "NANDemul partition 1",
655 static int nPartitions = sizeof(nandemul2k_partition)/sizeof(nandemul2k_partition[0]);
658 * Main initialization routine
660 int __init nandemul2k_init (void)
667 nandemul2k_scan(&nandemul2k_mtd,1);
669 // Build the partition table
671 nandemul2k_partition[0].size = sizeInMB * 1024 * 1024;
673 // Register the partition
674 add_mtd_partitions(&nandemul2k_mtd,nandemul2k_partition,nPartitions);
680 module_init(nandemul2k_init);
686 static void __exit nandemul2k_cleanup (void)
689 nandemul2k_CleanUp();
691 /* Unregister partitions */
692 del_mtd_partitions(&nandemul2k_mtd);
694 /* Unregister the device */
695 del_mtd_device (&nandemul2k_mtd);
698 module_exit(nandemul2k_cleanup);
701 MODULE_LICENSE("GPL");
702 MODULE_AUTHOR("Charles Manning <manningc@aleph1.co.uk>");
703 MODULE_DESCRIPTION("2k Page/128k Block NAND emulated in RAM");