1 /* 2 * Copyright (C) 2006-2008 Artem Bityutskiy 3 * Copyright (C) 2006-2008 Jarkko Lavinen 4 * Copyright (C) 2006-2008 Adrian Hunter 5 * 6 * This program is free software; you can redistribute it and/or modify it 7 * under the terms of the GNU General Public License version 2 as published by 8 * the Free Software Foundation. 9 * 10 * This program is distributed in the hope that it will be useful, but WITHOUT 11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 13 * more details. 14 * 15 * You should have received a copy of the GNU General Public License along with 16 * this program; see the file COPYING. If not, write to the Free Software 17 * Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. 18 * 19 * Authors: Artem Bityutskiy, Jarkko Lavinen, Adria Hunter 20 * 21 * WARNING: this test program may kill your flash and your device. Do not 22 * use it unless you know what you do. Authors are not responsible for any 23 * damage caused by this program. 24 */ 25 26 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt 27 28 #include <linux/init.h> 29 #include <linux/module.h> 30 #include <linux/moduleparam.h> 31 #include <linux/err.h> 32 #include <linux/mtd/mtd.h> 33 #include <linux/slab.h> 34 #include <linux/sched.h> 35 #include "mtd_test.h" 36 37 #define RETRIES 3 38 39 static int eb = 8; 40 module_param(eb, int, S_IRUGO); 41 MODULE_PARM_DESC(eb, "eraseblock number within the selected MTD device"); 42 43 static int ebcnt = 32; 44 module_param(ebcnt, int, S_IRUGO); 45 MODULE_PARM_DESC(ebcnt, "number of consecutive eraseblocks to torture"); 46 47 static int pgcnt; 48 module_param(pgcnt, int, S_IRUGO); 49 MODULE_PARM_DESC(pgcnt, "number of pages per eraseblock to torture (0 => all)"); 50 51 static int dev = -EINVAL; 52 module_param(dev, int, S_IRUGO); 53 MODULE_PARM_DESC(dev, "MTD device number to use"); 54 55 static int gran = 512; 56 module_param(gran, int, S_IRUGO); 57 MODULE_PARM_DESC(gran, "how often the status information should be printed"); 58 59 static int check = 1; 60 module_param(check, int, S_IRUGO); 61 MODULE_PARM_DESC(check, "if the written data should be checked"); 62 63 static unsigned int cycles_count; 64 module_param(cycles_count, uint, S_IRUGO); 65 MODULE_PARM_DESC(cycles_count, "how many erase cycles to do " 66 "(infinite by default)"); 67 68 static struct mtd_info *mtd; 69 70 /* This buffer contains 0x555555...0xAAAAAA... pattern */ 71 static unsigned char *patt_5A5; 72 /* This buffer contains 0xAAAAAA...0x555555... pattern */ 73 static unsigned char *patt_A5A; 74 /* This buffer contains all 0xFF bytes */ 75 static unsigned char *patt_FF; 76 /* This a temporary buffer is use when checking data */ 77 static unsigned char *check_buf; 78 /* How many erase cycles were done */ 79 static unsigned int erase_cycles; 80 81 static int pgsize; 82 static struct timeval start, finish; 83 84 static void report_corrupt(unsigned char *read, unsigned char *written); 85 86 static inline void start_timing(void) 87 { 88 do_gettimeofday(&start); 89 } 90 91 static inline void stop_timing(void) 92 { 93 do_gettimeofday(&finish); 94 } 95 96 /* 97 * Check that the contents of eraseblock number @enbum is equivalent to the 98 * @buf buffer. 99 */ 100 static inline int check_eraseblock(int ebnum, unsigned char *buf) 101 { 102 int err, retries = 0; 103 size_t read; 104 loff_t addr = ebnum * mtd->erasesize; 105 size_t len = mtd->erasesize; 106 107 if (pgcnt) { 108 addr = (ebnum + 1) * mtd->erasesize - pgcnt * pgsize; 109 len = pgcnt * pgsize; 110 } 111 112 retry: 113 err = mtd_read(mtd, addr, len, &read, check_buf); 114 if (mtd_is_bitflip(err)) 115 pr_err("single bit flip occurred at EB %d " 116 "MTD reported that it was fixed.\n", ebnum); 117 else if (err) { 118 pr_err("error %d while reading EB %d, " 119 "read %zd\n", err, ebnum, read); 120 return err; 121 } 122 123 if (read != len) { 124 pr_err("failed to read %zd bytes from EB %d, " 125 "read only %zd, but no error reported\n", 126 len, ebnum, read); 127 return -EIO; 128 } 129 130 if (memcmp(buf, check_buf, len)) { 131 pr_err("read wrong data from EB %d\n", ebnum); 132 report_corrupt(check_buf, buf); 133 134 if (retries++ < RETRIES) { 135 /* Try read again */ 136 yield(); 137 pr_info("re-try reading data from EB %d\n", 138 ebnum); 139 goto retry; 140 } else { 141 pr_info("retried %d times, still errors, " 142 "give-up\n", RETRIES); 143 return -EINVAL; 144 } 145 } 146 147 if (retries != 0) 148 pr_info("only attempt number %d was OK (!!!)\n", 149 retries); 150 151 return 0; 152 } 153 154 static inline int write_pattern(int ebnum, void *buf) 155 { 156 int err; 157 size_t written; 158 loff_t addr = ebnum * mtd->erasesize; 159 size_t len = mtd->erasesize; 160 161 if (pgcnt) { 162 addr = (ebnum + 1) * mtd->erasesize - pgcnt * pgsize; 163 len = pgcnt * pgsize; 164 } 165 err = mtd_write(mtd, addr, len, &written, buf); 166 if (err) { 167 pr_err("error %d while writing EB %d, written %zd" 168 " bytes\n", err, ebnum, written); 169 return err; 170 } 171 if (written != len) { 172 pr_info("written only %zd bytes of %zd, but no error" 173 " reported\n", written, len); 174 return -EIO; 175 } 176 177 return 0; 178 } 179 180 static int __init tort_init(void) 181 { 182 int err = 0, i, infinite = !cycles_count; 183 unsigned char *bad_ebs; 184 185 printk(KERN_INFO "\n"); 186 printk(KERN_INFO "=================================================\n"); 187 pr_info("Warning: this program is trying to wear out your " 188 "flash, stop it if this is not wanted.\n"); 189 190 if (dev < 0) { 191 pr_info("Please specify a valid mtd-device via module parameter\n"); 192 pr_crit("CAREFUL: This test wipes all data on the specified MTD device!\n"); 193 return -EINVAL; 194 } 195 196 pr_info("MTD device: %d\n", dev); 197 pr_info("torture %d eraseblocks (%d-%d) of mtd%d\n", 198 ebcnt, eb, eb + ebcnt - 1, dev); 199 if (pgcnt) 200 pr_info("torturing just %d pages per eraseblock\n", 201 pgcnt); 202 pr_info("write verify %s\n", check ? "enabled" : "disabled"); 203 204 mtd = get_mtd_device(NULL, dev); 205 if (IS_ERR(mtd)) { 206 err = PTR_ERR(mtd); 207 pr_err("error: cannot get MTD device\n"); 208 return err; 209 } 210 211 if (mtd->writesize == 1) { 212 pr_info("not NAND flash, assume page size is 512 " 213 "bytes.\n"); 214 pgsize = 512; 215 } else 216 pgsize = mtd->writesize; 217 218 if (pgcnt && (pgcnt > mtd->erasesize / pgsize || pgcnt < 0)) { 219 pr_err("error: invalid pgcnt value %d\n", pgcnt); 220 goto out_mtd; 221 } 222 223 err = -ENOMEM; 224 patt_5A5 = kmalloc(mtd->erasesize, GFP_KERNEL); 225 if (!patt_5A5) 226 goto out_mtd; 227 228 patt_A5A = kmalloc(mtd->erasesize, GFP_KERNEL); 229 if (!patt_A5A) 230 goto out_patt_5A5; 231 232 patt_FF = kmalloc(mtd->erasesize, GFP_KERNEL); 233 if (!patt_FF) 234 goto out_patt_A5A; 235 236 check_buf = kmalloc(mtd->erasesize, GFP_KERNEL); 237 if (!check_buf) 238 goto out_patt_FF; 239 240 bad_ebs = kzalloc(ebcnt, GFP_KERNEL); 241 if (!bad_ebs) 242 goto out_check_buf; 243 244 err = 0; 245 246 /* Initialize patterns */ 247 memset(patt_FF, 0xFF, mtd->erasesize); 248 for (i = 0; i < mtd->erasesize / pgsize; i++) { 249 if (!(i & 1)) { 250 memset(patt_5A5 + i * pgsize, 0x55, pgsize); 251 memset(patt_A5A + i * pgsize, 0xAA, pgsize); 252 } else { 253 memset(patt_5A5 + i * pgsize, 0xAA, pgsize); 254 memset(patt_A5A + i * pgsize, 0x55, pgsize); 255 } 256 } 257 258 err = mtdtest_scan_for_bad_eraseblocks(mtd, bad_ebs, eb, ebcnt); 259 if (err) 260 goto out; 261 262 start_timing(); 263 while (1) { 264 int i; 265 void *patt; 266 267 err = mtdtest_erase_good_eraseblocks(mtd, bad_ebs, eb, ebcnt); 268 if (err) 269 goto out; 270 271 /* Check if the eraseblocks contain only 0xFF bytes */ 272 if (check) { 273 for (i = eb; i < eb + ebcnt; i++) { 274 if (bad_ebs[i - eb]) 275 continue; 276 err = check_eraseblock(i, patt_FF); 277 if (err) { 278 pr_info("verify failed" 279 " for 0xFF... pattern\n"); 280 goto out; 281 } 282 cond_resched(); 283 } 284 } 285 286 /* Write the pattern */ 287 for (i = eb; i < eb + ebcnt; i++) { 288 if (bad_ebs[i - eb]) 289 continue; 290 if ((eb + erase_cycles) & 1) 291 patt = patt_5A5; 292 else 293 patt = patt_A5A; 294 err = write_pattern(i, patt); 295 if (err) 296 goto out; 297 cond_resched(); 298 } 299 300 /* Verify what we wrote */ 301 if (check) { 302 for (i = eb; i < eb + ebcnt; i++) { 303 if (bad_ebs[i - eb]) 304 continue; 305 if ((eb + erase_cycles) & 1) 306 patt = patt_5A5; 307 else 308 patt = patt_A5A; 309 err = check_eraseblock(i, patt); 310 if (err) { 311 pr_info("verify failed for %s" 312 " pattern\n", 313 ((eb + erase_cycles) & 1) ? 314 "0x55AA55..." : "0xAA55AA..."); 315 goto out; 316 } 317 cond_resched(); 318 } 319 } 320 321 erase_cycles += 1; 322 323 if (erase_cycles % gran == 0) { 324 long ms; 325 326 stop_timing(); 327 ms = (finish.tv_sec - start.tv_sec) * 1000 + 328 (finish.tv_usec - start.tv_usec) / 1000; 329 pr_info("%08u erase cycles done, took %lu " 330 "milliseconds (%lu seconds)\n", 331 erase_cycles, ms, ms / 1000); 332 start_timing(); 333 } 334 335 if (!infinite && --cycles_count == 0) 336 break; 337 } 338 out: 339 340 pr_info("finished after %u erase cycles\n", 341 erase_cycles); 342 kfree(bad_ebs); 343 out_check_buf: 344 kfree(check_buf); 345 out_patt_FF: 346 kfree(patt_FF); 347 out_patt_A5A: 348 kfree(patt_A5A); 349 out_patt_5A5: 350 kfree(patt_5A5); 351 out_mtd: 352 put_mtd_device(mtd); 353 if (err) 354 pr_info("error %d occurred during torturing\n", err); 355 printk(KERN_INFO "=================================================\n"); 356 return err; 357 } 358 module_init(tort_init); 359 360 static void __exit tort_exit(void) 361 { 362 return; 363 } 364 module_exit(tort_exit); 365 366 static int countdiffs(unsigned char *buf, unsigned char *check_buf, 367 unsigned offset, unsigned len, unsigned *bytesp, 368 unsigned *bitsp); 369 static void print_bufs(unsigned char *read, unsigned char *written, int start, 370 int len); 371 372 /* 373 * Report the detailed information about how the read EB differs from what was 374 * written. 375 */ 376 static void report_corrupt(unsigned char *read, unsigned char *written) 377 { 378 int i; 379 int bytes, bits, pages, first; 380 int offset, len; 381 size_t check_len = mtd->erasesize; 382 383 if (pgcnt) 384 check_len = pgcnt * pgsize; 385 386 bytes = bits = pages = 0; 387 for (i = 0; i < check_len; i += pgsize) 388 if (countdiffs(written, read, i, pgsize, &bytes, 389 &bits) >= 0) 390 pages++; 391 392 pr_info("verify fails on %d pages, %d bytes/%d bits\n", 393 pages, bytes, bits); 394 pr_info("The following is a list of all differences between" 395 " what was read from flash and what was expected\n"); 396 397 for (i = 0; i < check_len; i += pgsize) { 398 cond_resched(); 399 bytes = bits = 0; 400 first = countdiffs(written, read, i, pgsize, &bytes, 401 &bits); 402 if (first < 0) 403 continue; 404 405 printk("-------------------------------------------------------" 406 "----------------------------------\n"); 407 408 pr_info("Page %zd has %d bytes/%d bits failing verify," 409 " starting at offset 0x%x\n", 410 (mtd->erasesize - check_len + i) / pgsize, 411 bytes, bits, first); 412 413 offset = first & ~0x7; 414 len = ((first + bytes) | 0x7) + 1 - offset; 415 416 print_bufs(read, written, offset, len); 417 } 418 } 419 420 static void print_bufs(unsigned char *read, unsigned char *written, int start, 421 int len) 422 { 423 int i = 0, j1, j2; 424 char *diff; 425 426 printk("Offset Read Written\n"); 427 while (i < len) { 428 printk("0x%08x: ", start + i); 429 diff = " "; 430 for (j1 = 0; j1 < 8 && i + j1 < len; j1++) { 431 printk(" %02x", read[start + i + j1]); 432 if (read[start + i + j1] != written[start + i + j1]) 433 diff = "***"; 434 } 435 436 while (j1 < 8) { 437 printk(" "); 438 j1 += 1; 439 } 440 441 printk(" %s ", diff); 442 443 for (j2 = 0; j2 < 8 && i + j2 < len; j2++) 444 printk(" %02x", written[start + i + j2]); 445 printk("\n"); 446 i += 8; 447 } 448 } 449 450 /* 451 * Count the number of differing bytes and bits and return the first differing 452 * offset. 453 */ 454 static int countdiffs(unsigned char *buf, unsigned char *check_buf, 455 unsigned offset, unsigned len, unsigned *bytesp, 456 unsigned *bitsp) 457 { 458 unsigned i, bit; 459 int first = -1; 460 461 for (i = offset; i < offset + len; i++) 462 if (buf[i] != check_buf[i]) { 463 first = i; 464 break; 465 } 466 467 while (i < offset + len) { 468 if (buf[i] != check_buf[i]) { 469 (*bytesp)++; 470 bit = 1; 471 while (bit < 256) { 472 if ((buf[i] & bit) != (check_buf[i] & bit)) 473 (*bitsp)++; 474 bit <<= 1; 475 } 476 } 477 i++; 478 } 479 480 return first; 481 } 482 483 MODULE_DESCRIPTION("Eraseblock torturing module"); 484 MODULE_AUTHOR("Artem Bityutskiy, Jarkko Lavinen, Adrian Hunter"); 485 MODULE_LICENSE("GPL"); 486