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>
32 #include <linux/random.h>
36 static int dev = -EINVAL;
37 static int bitflip_limit;
38 module_param(dev, int, S_IRUGO);
39 MODULE_PARM_DESC(dev, "MTD device number to use");
40 module_param(bitflip_limit, int, S_IRUGO);
41 MODULE_PARM_DESC(bitflip_limit, "Max. allowed bitflips per page");
43 static struct mtd_info *mtd;
44 static unsigned char *readbuf;
45 static unsigned char *writebuf;
46 static unsigned char *bbt;
51 static int use_offset;
53 static int use_len_max;
54 static int vary_offset;
55 static struct rnd_state rnd_state;
57 static void do_vary_offset(void)
62 if (use_offset >= use_len_max)
64 use_len = use_len_max - use_offset;
68 static int write_eraseblock(int ebnum)
71 struct mtd_oob_ops ops;
73 loff_t addr = (loff_t)ebnum * mtd->erasesize;
75 prandom_bytes_state(&rnd_state, writebuf, use_len_max * pgcnt);
76 for (i = 0; i < pgcnt; ++i, addr += mtd->writesize) {
77 ops.mode = MTD_OPS_AUTO_OOB;
82 ops.ooboffs = use_offset;
84 ops.oobbuf = writebuf + (use_len_max * i) + use_offset;
85 err = mtd_write_oob(mtd, addr, &ops);
86 if (err || ops.oobretlen != use_len) {
87 pr_err("error: writeoob failed at %#llx\n",
89 pr_err("error: use_len %d, use_offset %d\n",
92 return err ? err : -1;
101 static int write_whole_device(void)
106 pr_info("writing OOBs of whole device\n");
107 for (i = 0; i < ebcnt; ++i) {
110 err = write_eraseblock(i);
114 pr_info("written up to eraseblock %u\n", i);
116 err = mtdtest_relax();
120 pr_info("written %u eraseblocks\n", i);
125 * Display the address, offset and data bytes at comparison failure.
126 * Return number of bitflips encountered.
128 static size_t memcmpshowoffset(loff_t addr, loff_t offset, const void *cs,
129 const void *ct, size_t count)
131 const unsigned char *su1, *su2;
136 for (su1 = cs, su2 = ct; 0 < count; ++su1, ++su2, count--, i++) {
139 pr_info("error @addr[0x%lx:0x%lx] 0x%x -> 0x%x diff 0x%x\n",
140 (unsigned long)addr, (unsigned long)offset + i,
142 bitflips += hweight8(res);
149 #define memcmpshow(addr, cs, ct, count) memcmpshowoffset((addr), 0, (cs), (ct),\
153 * Compare with 0xff and show the address, offset and data bytes at
154 * comparison failure. Return number of bitflips encountered.
156 static size_t memffshow(loff_t addr, loff_t offset, const void *cs,
159 const unsigned char *su1;
164 for (su1 = cs; 0 < count; ++su1, count--, i++) {
167 pr_info("error @addr[0x%lx:0x%lx] 0x%x -> 0xff diff 0x%x\n",
168 (unsigned long)addr, (unsigned long)offset + i,
170 bitflips += hweight8(res);
177 static int verify_eraseblock(int ebnum)
180 struct mtd_oob_ops ops;
182 loff_t addr = (loff_t)ebnum * mtd->erasesize;
185 prandom_bytes_state(&rnd_state, writebuf, use_len_max * pgcnt);
186 for (i = 0; i < pgcnt; ++i, addr += mtd->writesize) {
187 ops.mode = MTD_OPS_AUTO_OOB;
190 ops.ooblen = use_len;
192 ops.ooboffs = use_offset;
194 ops.oobbuf = readbuf;
195 err = mtd_read_oob(mtd, addr, &ops);
196 if (err || ops.oobretlen != use_len) {
197 pr_err("error: readoob failed at %#llx\n",
200 return err ? err : -1;
203 bitflips = memcmpshow(addr, readbuf,
204 writebuf + (use_len_max * i) + use_offset,
206 if (bitflips > bitflip_limit) {
207 pr_err("error: verify failed at %#llx\n",
211 pr_err("error: too many errors\n");
214 } else if (bitflips) {
215 pr_info("ignoring error as within bitflip_limit\n");
218 if (use_offset != 0 || use_len < mtd->ecclayout->oobavail) {
221 ops.mode = MTD_OPS_AUTO_OOB;
224 ops.ooblen = mtd->ecclayout->oobavail;
228 ops.oobbuf = readbuf;
229 err = mtd_read_oob(mtd, addr, &ops);
230 if (err || ops.oobretlen != mtd->ecclayout->oobavail) {
231 pr_err("error: readoob failed at %#llx\n",
234 return err ? err : -1;
236 bitflips = memcmpshowoffset(addr, use_offset,
237 readbuf + use_offset,
238 writebuf + (use_len_max * i) + use_offset,
241 /* verify pre-offset area for 0xff */
242 bitflips += memffshow(addr, 0, readbuf, use_offset);
244 /* verify post-(use_offset + use_len) area for 0xff */
245 k = use_offset + use_len;
246 bitflips += memffshow(addr, k, readbuf + k,
247 mtd->ecclayout->oobavail - k);
249 if (bitflips > bitflip_limit) {
250 pr_err("error: verify failed at %#llx\n",
254 pr_err("error: too many errors\n");
257 } else if (bitflips) {
258 pr_info("ignoring errors as within bitflip limit\n");
267 static int verify_eraseblock_in_one_go(int ebnum)
269 struct mtd_oob_ops ops;
271 loff_t addr = (loff_t)ebnum * mtd->erasesize;
272 size_t len = mtd->ecclayout->oobavail * pgcnt;
273 size_t oobavail = mtd->ecclayout->oobavail;
277 prandom_bytes_state(&rnd_state, writebuf, len);
278 ops.mode = MTD_OPS_AUTO_OOB;
285 ops.oobbuf = readbuf;
287 /* read entire block's OOB at one go */
288 err = mtd_read_oob(mtd, addr, &ops);
289 if (err || ops.oobretlen != len) {
290 pr_err("error: readoob failed at %#llx\n",
293 return err ? err : -1;
296 /* verify one page OOB at a time for bitflip per page limit check */
297 for (i = 0; i < pgcnt; ++i, addr += mtd->writesize) {
298 bitflips = memcmpshow(addr, readbuf + (i * oobavail),
299 writebuf + (i * oobavail), oobavail);
300 if (bitflips > bitflip_limit) {
301 pr_err("error: verify failed at %#llx\n",
305 pr_err("error: too many errors\n");
308 } else if (bitflips) {
309 pr_info("ignoring error as within bitflip_limit\n");
316 static int verify_all_eraseblocks(void)
321 pr_info("verifying all eraseblocks\n");
322 for (i = 0; i < ebcnt; ++i) {
325 err = verify_eraseblock(i);
329 pr_info("verified up to eraseblock %u\n", i);
331 err = mtdtest_relax();
335 pr_info("verified %u eraseblocks\n", i);
339 static int __init mtd_oobtest_init(void)
344 struct mtd_oob_ops ops;
345 loff_t addr = 0, addr0;
347 printk(KERN_INFO "\n");
348 printk(KERN_INFO "=================================================\n");
351 pr_info("Please specify a valid mtd-device via module parameter\n");
352 pr_crit("CAREFUL: This test wipes all data on the specified MTD device!\n");
356 pr_info("MTD device: %d\n", dev);
358 mtd = get_mtd_device(NULL, dev);
361 pr_err("error: cannot get MTD device\n");
365 if (!mtd_type_is_nand(mtd)) {
366 pr_info("this test requires NAND flash\n");
371 do_div(tmp, mtd->erasesize);
373 pgcnt = mtd->erasesize / mtd->writesize;
375 pr_info("MTD device size %llu, eraseblock size %u, "
376 "page size %u, count of eraseblocks %u, pages per "
377 "eraseblock %u, OOB size %u\n",
378 (unsigned long long)mtd->size, mtd->erasesize,
379 mtd->writesize, ebcnt, pgcnt, mtd->oobsize);
382 readbuf = kmalloc(mtd->erasesize, GFP_KERNEL);
385 writebuf = kmalloc(mtd->erasesize, GFP_KERNEL);
388 bbt = kzalloc(ebcnt, GFP_KERNEL);
392 err = mtdtest_scan_for_bad_eraseblocks(mtd, bbt, 0, ebcnt);
397 use_len = mtd->ecclayout->oobavail;
398 use_len_max = mtd->ecclayout->oobavail;
401 /* First test: write all OOB, read it back and verify */
402 pr_info("test 1 of 5\n");
404 err = mtdtest_erase_good_eraseblocks(mtd, bbt, 0, ebcnt);
408 prandom_seed_state(&rnd_state, 1);
409 err = write_whole_device();
413 prandom_seed_state(&rnd_state, 1);
414 err = verify_all_eraseblocks();
419 * Second test: write all OOB, a block at a time, read it back and
422 pr_info("test 2 of 5\n");
424 err = mtdtest_erase_good_eraseblocks(mtd, bbt, 0, ebcnt);
428 prandom_seed_state(&rnd_state, 3);
429 err = write_whole_device();
433 /* Check all eraseblocks */
434 prandom_seed_state(&rnd_state, 3);
435 pr_info("verifying all eraseblocks\n");
436 for (i = 0; i < ebcnt; ++i) {
439 err = verify_eraseblock_in_one_go(i);
443 pr_info("verified up to eraseblock %u\n", i);
445 err = mtdtest_relax();
449 pr_info("verified %u eraseblocks\n", i);
452 * Third test: write OOB at varying offsets and lengths, read it back
455 pr_info("test 3 of 5\n");
457 err = mtdtest_erase_good_eraseblocks(mtd, bbt, 0, ebcnt);
461 /* Write all eraseblocks */
463 use_len = mtd->ecclayout->oobavail;
464 use_len_max = mtd->ecclayout->oobavail;
466 prandom_seed_state(&rnd_state, 5);
468 err = write_whole_device();
472 /* Check all eraseblocks */
474 use_len = mtd->ecclayout->oobavail;
475 use_len_max = mtd->ecclayout->oobavail;
477 prandom_seed_state(&rnd_state, 5);
478 err = verify_all_eraseblocks();
483 use_len = mtd->ecclayout->oobavail;
484 use_len_max = mtd->ecclayout->oobavail;
487 /* Fourth test: try to write off end of device */
488 pr_info("test 4 of 5\n");
490 err = mtdtest_erase_good_eraseblocks(mtd, bbt, 0, ebcnt);
495 for (i = 0; i < ebcnt && bbt[i]; ++i)
496 addr0 += mtd->erasesize;
498 /* Attempt to write off end of OOB */
499 ops.mode = MTD_OPS_AUTO_OOB;
504 ops.ooboffs = mtd->ecclayout->oobavail;
506 ops.oobbuf = writebuf;
507 pr_info("attempting to start write past end of OOB\n");
508 pr_info("an error is expected...\n");
509 err = mtd_write_oob(mtd, addr0, &ops);
511 pr_info("error occurred as expected\n");
514 pr_err("error: can write past end of OOB\n");
518 /* Attempt to read off end of OOB */
519 ops.mode = MTD_OPS_AUTO_OOB;
524 ops.ooboffs = mtd->ecclayout->oobavail;
526 ops.oobbuf = readbuf;
527 pr_info("attempting to start read past end of OOB\n");
528 pr_info("an error is expected...\n");
529 err = mtd_read_oob(mtd, addr0, &ops);
531 pr_info("error occurred as expected\n");
534 pr_err("error: can read past end of OOB\n");
539 pr_info("skipping end of device tests because last "
542 /* Attempt to write off end of device */
543 ops.mode = MTD_OPS_AUTO_OOB;
546 ops.ooblen = mtd->ecclayout->oobavail + 1;
550 ops.oobbuf = writebuf;
551 pr_info("attempting to write past end of device\n");
552 pr_info("an error is expected...\n");
553 err = mtd_write_oob(mtd, mtd->size - mtd->writesize, &ops);
555 pr_info("error occurred as expected\n");
558 pr_err("error: wrote past end of device\n");
562 /* Attempt to read off end of device */
563 ops.mode = MTD_OPS_AUTO_OOB;
566 ops.ooblen = mtd->ecclayout->oobavail + 1;
570 ops.oobbuf = readbuf;
571 pr_info("attempting to read past end of device\n");
572 pr_info("an error is expected...\n");
573 err = mtd_read_oob(mtd, mtd->size - mtd->writesize, &ops);
575 pr_info("error occurred as expected\n");
578 pr_err("error: read past end of device\n");
582 err = mtdtest_erase_eraseblock(mtd, ebcnt - 1);
586 /* Attempt to write off end of device */
587 ops.mode = MTD_OPS_AUTO_OOB;
590 ops.ooblen = mtd->ecclayout->oobavail;
594 ops.oobbuf = writebuf;
595 pr_info("attempting to write past end of device\n");
596 pr_info("an error is expected...\n");
597 err = mtd_write_oob(mtd, mtd->size - mtd->writesize, &ops);
599 pr_info("error occurred as expected\n");
602 pr_err("error: wrote past end of device\n");
606 /* Attempt to read off end of device */
607 ops.mode = MTD_OPS_AUTO_OOB;
610 ops.ooblen = mtd->ecclayout->oobavail;
614 ops.oobbuf = readbuf;
615 pr_info("attempting to read past end of device\n");
616 pr_info("an error is expected...\n");
617 err = mtd_read_oob(mtd, mtd->size - mtd->writesize, &ops);
619 pr_info("error occurred as expected\n");
622 pr_err("error: read past end of device\n");
627 /* Fifth test: write / read across block boundaries */
628 pr_info("test 5 of 5\n");
630 /* Erase all eraseblocks */
631 err = mtdtest_erase_good_eraseblocks(mtd, bbt, 0, ebcnt);
635 /* Write all eraseblocks */
636 prandom_seed_state(&rnd_state, 11);
637 pr_info("writing OOBs of whole device\n");
638 for (i = 0; i < ebcnt - 1; ++i) {
641 size_t sz = mtd->ecclayout->oobavail;
642 if (bbt[i] || bbt[i + 1])
644 addr = (loff_t)(i + 1) * mtd->erasesize - mtd->writesize;
645 prandom_bytes_state(&rnd_state, writebuf, sz * cnt);
646 for (pg = 0; pg < cnt; ++pg) {
647 ops.mode = MTD_OPS_AUTO_OOB;
654 ops.oobbuf = writebuf + pg * sz;
655 err = mtd_write_oob(mtd, addr, &ops);
659 pr_info("written up to eraseblock %u\n", i);
661 err = mtdtest_relax();
665 addr += mtd->writesize;
668 pr_info("written %u eraseblocks\n", i);
670 /* Check all eraseblocks */
671 prandom_seed_state(&rnd_state, 11);
672 pr_info("verifying all eraseblocks\n");
673 for (i = 0; i < ebcnt - 1; ++i) {
674 if (bbt[i] || bbt[i + 1])
676 prandom_bytes_state(&rnd_state, writebuf,
677 mtd->ecclayout->oobavail * 2);
678 addr = (loff_t)(i + 1) * mtd->erasesize - mtd->writesize;
679 ops.mode = MTD_OPS_AUTO_OOB;
682 ops.ooblen = mtd->ecclayout->oobavail * 2;
686 ops.oobbuf = readbuf;
687 err = mtd_read_oob(mtd, addr, &ops);
690 if (memcmpshow(addr, readbuf, writebuf,
691 mtd->ecclayout->oobavail * 2)) {
692 pr_err("error: verify failed at %#llx\n",
696 pr_err("error: too many errors\n");
701 pr_info("verified up to eraseblock %u\n", i);
703 err = mtdtest_relax();
707 pr_info("verified %u eraseblocks\n", i);
709 pr_info("finished with %d errors\n", errcnt);
716 pr_info("error %d occurred\n", err);
717 printk(KERN_INFO "=================================================\n");
720 module_init(mtd_oobtest_init);
722 static void __exit mtd_oobtest_exit(void)
726 module_exit(mtd_oobtest_exit);
728 MODULE_DESCRIPTION("Out-of-band test module");
729 MODULE_AUTHOR("Adrian Hunter");
730 MODULE_LICENSE("GPL");