2 * Copyright (C) 2006-2008 Nokia Corporation
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 as published by
6 * the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; see the file COPYING. If not, write to the Free Software
15 * Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17 * Test OOB read and write on MTD device.
19 * Author: Adrian Hunter <ext-adrian.hunter@nokia.com>
22 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
24 #include <asm/div64.h>
25 #include <linux/init.h>
26 #include <linux/module.h>
27 #include <linux/moduleparam.h>
28 #include <linux/err.h>
29 #include <linux/mtd/mtd.h>
30 #include <linux/slab.h>
31 #include <linux/sched.h>
33 static int dev = -EINVAL;
34 module_param(dev, int, S_IRUGO);
35 MODULE_PARM_DESC(dev, "MTD device number to use");
37 static struct mtd_info *mtd;
38 static unsigned char *readbuf;
39 static unsigned char *writebuf;
40 static unsigned char *bbt;
45 static int use_offset;
47 static int use_len_max;
48 static int vary_offset;
49 static unsigned long next = 1;
51 static inline unsigned int simple_rand(void)
53 next = next * 1103515245 + 12345;
54 return (unsigned int)((next / 65536) % 32768);
57 static inline void simple_srand(unsigned long seed)
62 static void set_random_data(unsigned char *buf, size_t len)
66 for (i = 0; i < len; ++i)
67 buf[i] = simple_rand();
70 static int erase_eraseblock(int ebnum)
74 loff_t addr = ebnum * mtd->erasesize;
76 memset(&ei, 0, sizeof(struct erase_info));
79 ei.len = mtd->erasesize;
81 err = mtd_erase(mtd, &ei);
83 pr_err("error %d while erasing EB %d\n", err, ebnum);
87 if (ei.state == MTD_ERASE_FAILED) {
88 pr_err("some erase error occurred at EB %d\n", ebnum);
95 static int erase_whole_device(void)
100 pr_info("erasing whole device\n");
101 for (i = 0; i < ebcnt; ++i) {
104 err = erase_eraseblock(i);
109 pr_info("erased %u eraseblocks\n", i);
113 static void do_vary_offset(void)
118 if (use_offset >= use_len_max)
120 use_len = use_len_max - use_offset;
124 static int write_eraseblock(int ebnum)
127 struct mtd_oob_ops ops;
129 loff_t addr = ebnum * mtd->erasesize;
131 for (i = 0; i < pgcnt; ++i, addr += mtd->writesize) {
132 set_random_data(writebuf, use_len);
133 ops.mode = MTD_OPS_AUTO_OOB;
136 ops.ooblen = use_len;
138 ops.ooboffs = use_offset;
140 ops.oobbuf = writebuf;
141 err = mtd_write_oob(mtd, addr, &ops);
142 if (err || ops.oobretlen != use_len) {
143 pr_err("error: writeoob failed at %#llx\n",
145 pr_err("error: use_len %d, use_offset %d\n",
146 use_len, use_offset);
148 return err ? err : -1;
157 static int write_whole_device(void)
162 pr_info("writing OOBs of whole device\n");
163 for (i = 0; i < ebcnt; ++i) {
166 err = write_eraseblock(i);
170 pr_info("written up to eraseblock %u\n", i);
173 pr_info("written %u eraseblocks\n", i);
177 static int verify_eraseblock(int ebnum)
180 struct mtd_oob_ops ops;
182 loff_t addr = ebnum * mtd->erasesize;
184 for (i = 0; i < pgcnt; ++i, addr += mtd->writesize) {
185 set_random_data(writebuf, use_len);
186 ops.mode = MTD_OPS_AUTO_OOB;
189 ops.ooblen = use_len;
191 ops.ooboffs = use_offset;
193 ops.oobbuf = readbuf;
194 err = mtd_read_oob(mtd, addr, &ops);
195 if (err || ops.oobretlen != use_len) {
196 pr_err("error: readoob failed at %#llx\n",
199 return err ? err : -1;
201 if (memcmp(readbuf, writebuf, use_len)) {
202 pr_err("error: verify failed at %#llx\n",
206 pr_err("error: too many errors\n");
210 if (use_offset != 0 || use_len < mtd->ecclayout->oobavail) {
213 ops.mode = MTD_OPS_AUTO_OOB;
216 ops.ooblen = mtd->ecclayout->oobavail;
220 ops.oobbuf = readbuf;
221 err = mtd_read_oob(mtd, addr, &ops);
222 if (err || ops.oobretlen != mtd->ecclayout->oobavail) {
223 pr_err("error: readoob failed at %#llx\n",
226 return err ? err : -1;
228 if (memcmp(readbuf + use_offset, writebuf, use_len)) {
229 pr_err("error: verify failed at %#llx\n",
233 pr_err("error: too many errors\n");
237 for (k = 0; k < use_offset; ++k)
238 if (readbuf[k] != 0xff) {
239 pr_err("error: verify 0xff "
249 for (k = use_offset + use_len;
250 k < mtd->ecclayout->oobavail; ++k)
251 if (readbuf[k] != 0xff) {
252 pr_err("error: verify 0xff "
269 static int verify_eraseblock_in_one_go(int ebnum)
271 struct mtd_oob_ops ops;
273 loff_t addr = ebnum * mtd->erasesize;
274 size_t len = mtd->ecclayout->oobavail * pgcnt;
276 set_random_data(writebuf, len);
277 ops.mode = MTD_OPS_AUTO_OOB;
284 ops.oobbuf = readbuf;
285 err = mtd_read_oob(mtd, addr, &ops);
286 if (err || ops.oobretlen != len) {
287 pr_err("error: readoob failed at %#llx\n",
290 return err ? err : -1;
292 if (memcmp(readbuf, writebuf, len)) {
293 pr_err("error: verify failed at %#llx\n",
297 pr_err("error: too many errors\n");
305 static int verify_all_eraseblocks(void)
310 pr_info("verifying all eraseblocks\n");
311 for (i = 0; i < ebcnt; ++i) {
314 err = verify_eraseblock(i);
318 pr_info("verified up to eraseblock %u\n", i);
321 pr_info("verified %u eraseblocks\n", i);
325 static int is_block_bad(int ebnum)
328 loff_t addr = ebnum * mtd->erasesize;
330 ret = mtd_block_isbad(mtd, addr);
332 pr_info("block %d is bad\n", ebnum);
336 static int scan_for_bad_eraseblocks(void)
340 bbt = kmalloc(ebcnt, GFP_KERNEL);
342 pr_err("error: cannot allocate memory\n");
346 pr_info("scanning for bad eraseblocks\n");
347 for (i = 0; i < ebcnt; ++i) {
348 bbt[i] = is_block_bad(i) ? 1 : 0;
353 pr_info("scanned %d eraseblocks, %d are bad\n", i, bad);
357 static int __init mtd_oobtest_init(void)
362 struct mtd_oob_ops ops;
363 loff_t addr = 0, addr0;
365 printk(KERN_INFO "\n");
366 printk(KERN_INFO "=================================================\n");
369 pr_info("Please specify a valid mtd-device via module parameter\n");
370 pr_crit("CAREFUL: This test wipes all data on the specified MTD device!\n");
374 pr_info("MTD device: %d\n", dev);
376 mtd = get_mtd_device(NULL, dev);
379 pr_err("error: cannot get MTD device\n");
383 if (mtd->type != MTD_NANDFLASH) {
384 pr_info("this test requires NAND flash\n");
389 do_div(tmp, mtd->erasesize);
391 pgcnt = mtd->erasesize / mtd->writesize;
393 pr_info("MTD device size %llu, eraseblock size %u, "
394 "page size %u, count of eraseblocks %u, pages per "
395 "eraseblock %u, OOB size %u\n",
396 (unsigned long long)mtd->size, mtd->erasesize,
397 mtd->writesize, ebcnt, pgcnt, mtd->oobsize);
400 readbuf = kmalloc(mtd->erasesize, GFP_KERNEL);
402 pr_err("error: cannot allocate memory\n");
405 writebuf = kmalloc(mtd->erasesize, GFP_KERNEL);
407 pr_err("error: cannot allocate memory\n");
411 err = scan_for_bad_eraseblocks();
416 use_len = mtd->ecclayout->oobavail;
417 use_len_max = mtd->ecclayout->oobavail;
420 /* First test: write all OOB, read it back and verify */
421 pr_info("test 1 of 5\n");
423 err = erase_whole_device();
428 err = write_whole_device();
433 err = verify_all_eraseblocks();
438 * Second test: write all OOB, a block at a time, read it back and
441 pr_info("test 2 of 5\n");
443 err = erase_whole_device();
448 err = write_whole_device();
452 /* Check all eraseblocks */
454 pr_info("verifying all eraseblocks\n");
455 for (i = 0; i < ebcnt; ++i) {
458 err = verify_eraseblock_in_one_go(i);
462 pr_info("verified up to eraseblock %u\n", i);
465 pr_info("verified %u eraseblocks\n", i);
468 * Third test: write OOB at varying offsets and lengths, read it back
471 pr_info("test 3 of 5\n");
473 err = erase_whole_device();
477 /* Write all eraseblocks */
479 use_len = mtd->ecclayout->oobavail;
480 use_len_max = mtd->ecclayout->oobavail;
484 err = write_whole_device();
488 /* Check all eraseblocks */
490 use_len = mtd->ecclayout->oobavail;
491 use_len_max = mtd->ecclayout->oobavail;
494 err = verify_all_eraseblocks();
499 use_len = mtd->ecclayout->oobavail;
500 use_len_max = mtd->ecclayout->oobavail;
503 /* Fourth test: try to write off end of device */
504 pr_info("test 4 of 5\n");
506 err = erase_whole_device();
511 for (i = 0; i < ebcnt && bbt[i]; ++i)
512 addr0 += mtd->erasesize;
514 /* Attempt to write off end of OOB */
515 ops.mode = MTD_OPS_AUTO_OOB;
520 ops.ooboffs = mtd->ecclayout->oobavail;
522 ops.oobbuf = writebuf;
523 pr_info("attempting to start write past end of OOB\n");
524 pr_info("an error is expected...\n");
525 err = mtd_write_oob(mtd, addr0, &ops);
527 pr_info("error occurred as expected\n");
530 pr_err("error: can write past end of OOB\n");
534 /* Attempt to read off end of OOB */
535 ops.mode = MTD_OPS_AUTO_OOB;
540 ops.ooboffs = mtd->ecclayout->oobavail;
542 ops.oobbuf = readbuf;
543 pr_info("attempting to start read past end of OOB\n");
544 pr_info("an error is expected...\n");
545 err = mtd_read_oob(mtd, addr0, &ops);
547 pr_info("error occurred as expected\n");
550 pr_err("error: can read past end of OOB\n");
555 pr_info("skipping end of device tests because last "
558 /* Attempt to write off end of device */
559 ops.mode = MTD_OPS_AUTO_OOB;
562 ops.ooblen = mtd->ecclayout->oobavail + 1;
566 ops.oobbuf = writebuf;
567 pr_info("attempting to write past end of device\n");
568 pr_info("an error is expected...\n");
569 err = mtd_write_oob(mtd, mtd->size - mtd->writesize, &ops);
571 pr_info("error occurred as expected\n");
574 pr_err("error: wrote past end of device\n");
578 /* Attempt to read off end of device */
579 ops.mode = MTD_OPS_AUTO_OOB;
582 ops.ooblen = mtd->ecclayout->oobavail + 1;
586 ops.oobbuf = readbuf;
587 pr_info("attempting to read past end of device\n");
588 pr_info("an error is expected...\n");
589 err = mtd_read_oob(mtd, mtd->size - mtd->writesize, &ops);
591 pr_info("error occurred as expected\n");
594 pr_err("error: read past end of device\n");
598 err = erase_eraseblock(ebcnt - 1);
602 /* Attempt to write off end of device */
603 ops.mode = MTD_OPS_AUTO_OOB;
606 ops.ooblen = mtd->ecclayout->oobavail;
610 ops.oobbuf = writebuf;
611 pr_info("attempting to write past end of device\n");
612 pr_info("an error is expected...\n");
613 err = mtd_write_oob(mtd, mtd->size - mtd->writesize, &ops);
615 pr_info("error occurred as expected\n");
618 pr_err("error: wrote past end of device\n");
622 /* Attempt to read off end of device */
623 ops.mode = MTD_OPS_AUTO_OOB;
626 ops.ooblen = mtd->ecclayout->oobavail;
630 ops.oobbuf = readbuf;
631 pr_info("attempting to read past end of device\n");
632 pr_info("an error is expected...\n");
633 err = mtd_read_oob(mtd, mtd->size - mtd->writesize, &ops);
635 pr_info("error occurred as expected\n");
638 pr_err("error: read past end of device\n");
643 /* Fifth test: write / read across block boundaries */
644 pr_info("test 5 of 5\n");
646 /* Erase all eraseblocks */
647 err = erase_whole_device();
651 /* Write all eraseblocks */
653 pr_info("writing OOBs of whole device\n");
654 for (i = 0; i < ebcnt - 1; ++i) {
657 size_t sz = mtd->ecclayout->oobavail;
658 if (bbt[i] || bbt[i + 1])
660 addr = (i + 1) * mtd->erasesize - mtd->writesize;
661 for (pg = 0; pg < cnt; ++pg) {
662 set_random_data(writebuf, sz);
663 ops.mode = MTD_OPS_AUTO_OOB;
670 ops.oobbuf = writebuf;
671 err = mtd_write_oob(mtd, addr, &ops);
675 pr_info("written up to eraseblock %u\n", i);
677 addr += mtd->writesize;
680 pr_info("written %u eraseblocks\n", i);
682 /* Check all eraseblocks */
684 pr_info("verifying all eraseblocks\n");
685 for (i = 0; i < ebcnt - 1; ++i) {
686 if (bbt[i] || bbt[i + 1])
688 set_random_data(writebuf, mtd->ecclayout->oobavail * 2);
689 addr = (i + 1) * mtd->erasesize - mtd->writesize;
690 ops.mode = MTD_OPS_AUTO_OOB;
693 ops.ooblen = mtd->ecclayout->oobavail * 2;
697 ops.oobbuf = readbuf;
698 err = mtd_read_oob(mtd, addr, &ops);
701 if (memcmp(readbuf, writebuf, mtd->ecclayout->oobavail * 2)) {
702 pr_err("error: verify failed at %#llx\n",
706 pr_err("error: too many errors\n");
711 pr_info("verified up to eraseblock %u\n", i);
714 pr_info("verified %u eraseblocks\n", i);
716 pr_info("finished with %d errors\n", errcnt);
723 pr_info("error %d occurred\n", err);
724 printk(KERN_INFO "=================================================\n");
727 module_init(mtd_oobtest_init);
729 static void __exit mtd_oobtest_exit(void)
733 module_exit(mtd_oobtest_exit);
735 MODULE_DESCRIPTION("Out-of-band test module");
736 MODULE_AUTHOR("Adrian Hunter");
737 MODULE_LICENSE("GPL");