Commit | Line | Data |
---|---|---|
4db451a7 AB |
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 | #include <linux/init.h> | |
27 | #include <linux/module.h> | |
28 | #include <linux/moduleparam.h> | |
29 | #include <linux/err.h> | |
30 | #include <linux/mtd/mtd.h> | |
5a0e3ad6 | 31 | #include <linux/slab.h> |
4db451a7 AB |
32 | #include <linux/sched.h> |
33 | ||
34 | #define PRINT_PREF KERN_INFO "mtd_torturetest: " | |
35 | #define RETRIES 3 | |
36 | ||
37 | static int eb = 8; | |
38 | module_param(eb, int, S_IRUGO); | |
39 | MODULE_PARM_DESC(eb, "eraseblock number within the selected MTD device"); | |
40 | ||
41 | static int ebcnt = 32; | |
42 | module_param(ebcnt, int, S_IRUGO); | |
43 | MODULE_PARM_DESC(ebcnt, "number of consecutive eraseblocks to torture"); | |
44 | ||
45 | static int pgcnt; | |
46 | module_param(pgcnt, int, S_IRUGO); | |
47 | MODULE_PARM_DESC(pgcnt, "number of pages per eraseblock to torture (0 => all)"); | |
48 | ||
7406060e | 49 | static int dev = -EINVAL; |
4db451a7 AB |
50 | module_param(dev, int, S_IRUGO); |
51 | MODULE_PARM_DESC(dev, "MTD device number to use"); | |
52 | ||
53 | static int gran = 512; | |
54 | module_param(gran, int, S_IRUGO); | |
55 | MODULE_PARM_DESC(gran, "how often the status information should be printed"); | |
56 | ||
57 | static int check = 1; | |
58 | module_param(check, int, S_IRUGO); | |
59 | MODULE_PARM_DESC(check, "if the written data should be checked"); | |
60 | ||
61 | static unsigned int cycles_count; | |
62 | module_param(cycles_count, uint, S_IRUGO); | |
63 | MODULE_PARM_DESC(cycles_count, "how many erase cycles to do " | |
64 | "(infinite by default)"); | |
65 | ||
66 | static struct mtd_info *mtd; | |
67 | ||
68 | /* This buffer contains 0x555555...0xAAAAAA... pattern */ | |
69 | static unsigned char *patt_5A5; | |
70 | /* This buffer contains 0xAAAAAA...0x555555... pattern */ | |
71 | static unsigned char *patt_A5A; | |
72 | /* This buffer contains all 0xFF bytes */ | |
73 | static unsigned char *patt_FF; | |
74 | /* This a temporary buffer is use when checking data */ | |
75 | static unsigned char *check_buf; | |
76 | /* How many erase cycles were done */ | |
77 | static unsigned int erase_cycles; | |
78 | ||
79 | static int pgsize; | |
80 | static struct timeval start, finish; | |
81 | ||
82 | static void report_corrupt(unsigned char *read, unsigned char *written); | |
83 | ||
84 | static inline void start_timing(void) | |
85 | { | |
86 | do_gettimeofday(&start); | |
87 | } | |
88 | ||
89 | static inline void stop_timing(void) | |
90 | { | |
91 | do_gettimeofday(&finish); | |
92 | } | |
93 | ||
94 | /* | |
95 | * Erase eraseblock number @ebnum. | |
96 | */ | |
97 | static inline int erase_eraseblock(int ebnum) | |
98 | { | |
99 | int err; | |
100 | struct erase_info ei; | |
101 | loff_t addr = ebnum * mtd->erasesize; | |
102 | ||
103 | memset(&ei, 0, sizeof(struct erase_info)); | |
104 | ei.mtd = mtd; | |
105 | ei.addr = addr; | |
106 | ei.len = mtd->erasesize; | |
107 | ||
7e1f0dc0 | 108 | err = mtd_erase(mtd, &ei); |
4db451a7 AB |
109 | if (err) { |
110 | printk(PRINT_PREF "error %d while erasing EB %d\n", err, ebnum); | |
111 | return err; | |
112 | } | |
113 | ||
114 | if (ei.state == MTD_ERASE_FAILED) { | |
115 | printk(PRINT_PREF "some erase error occurred at EB %d\n", | |
116 | ebnum); | |
117 | return -EIO; | |
118 | } | |
119 | ||
120 | return 0; | |
121 | } | |
122 | ||
123 | /* | |
124 | * Check that the contents of eraseblock number @enbum is equivalent to the | |
125 | * @buf buffer. | |
126 | */ | |
127 | static inline int check_eraseblock(int ebnum, unsigned char *buf) | |
128 | { | |
129 | int err, retries = 0; | |
130 | size_t read = 0; | |
131 | loff_t addr = ebnum * mtd->erasesize; | |
132 | size_t len = mtd->erasesize; | |
133 | ||
134 | if (pgcnt) { | |
135 | addr = (ebnum + 1) * mtd->erasesize - pgcnt * pgsize; | |
136 | len = pgcnt * pgsize; | |
137 | } | |
138 | ||
139 | retry: | |
140 | err = mtd->read(mtd, addr, len, &read, check_buf); | |
d57f4054 | 141 | if (mtd_is_bitflip(err)) |
4db451a7 AB |
142 | printk(PRINT_PREF "single bit flip occurred at EB %d " |
143 | "MTD reported that it was fixed.\n", ebnum); | |
144 | else if (err) { | |
145 | printk(PRINT_PREF "error %d while reading EB %d, " | |
146 | "read %zd\n", err, ebnum, read); | |
147 | return err; | |
148 | } | |
149 | ||
150 | if (read != len) { | |
151 | printk(PRINT_PREF "failed to read %zd bytes from EB %d, " | |
152 | "read only %zd, but no error reported\n", | |
153 | len, ebnum, read); | |
154 | return -EIO; | |
155 | } | |
156 | ||
157 | if (memcmp(buf, check_buf, len)) { | |
158 | printk(PRINT_PREF "read wrong data from EB %d\n", ebnum); | |
159 | report_corrupt(check_buf, buf); | |
160 | ||
161 | if (retries++ < RETRIES) { | |
162 | /* Try read again */ | |
163 | yield(); | |
164 | printk(PRINT_PREF "re-try reading data from EB %d\n", | |
165 | ebnum); | |
166 | goto retry; | |
167 | } else { | |
168 | printk(PRINT_PREF "retried %d times, still errors, " | |
169 | "give-up\n", RETRIES); | |
170 | return -EINVAL; | |
171 | } | |
172 | } | |
173 | ||
174 | if (retries != 0) | |
175 | printk(PRINT_PREF "only attempt number %d was OK (!!!)\n", | |
176 | retries); | |
177 | ||
178 | return 0; | |
179 | } | |
180 | ||
181 | static inline int write_pattern(int ebnum, void *buf) | |
182 | { | |
183 | int err; | |
184 | size_t written = 0; | |
185 | loff_t addr = ebnum * mtd->erasesize; | |
186 | size_t len = mtd->erasesize; | |
187 | ||
188 | if (pgcnt) { | |
189 | addr = (ebnum + 1) * mtd->erasesize - pgcnt * pgsize; | |
190 | len = pgcnt * pgsize; | |
191 | } | |
192 | err = mtd->write(mtd, addr, len, &written, buf); | |
193 | if (err) { | |
194 | printk(PRINT_PREF "error %d while writing EB %d, written %zd" | |
195 | " bytes\n", err, ebnum, written); | |
196 | return err; | |
197 | } | |
198 | if (written != len) { | |
199 | printk(PRINT_PREF "written only %zd bytes of %zd, but no error" | |
200 | " reported\n", written, len); | |
201 | return -EIO; | |
202 | } | |
203 | ||
204 | return 0; | |
205 | } | |
206 | ||
207 | static int __init tort_init(void) | |
208 | { | |
209 | int err = 0, i, infinite = !cycles_count; | |
210 | int bad_ebs[ebcnt]; | |
211 | ||
212 | printk(KERN_INFO "\n"); | |
213 | printk(KERN_INFO "=================================================\n"); | |
214 | printk(PRINT_PREF "Warning: this program is trying to wear out your " | |
215 | "flash, stop it if this is not wanted.\n"); | |
7406060e WS |
216 | |
217 | if (dev < 0) { | |
218 | printk(PRINT_PREF "Please specify a valid mtd-device via module paramter\n"); | |
219 | printk(KERN_CRIT "CAREFUL: This test wipes all data on the specified MTD device!\n"); | |
220 | return -EINVAL; | |
221 | } | |
222 | ||
4db451a7 AB |
223 | printk(PRINT_PREF "MTD device: %d\n", dev); |
224 | printk(PRINT_PREF "torture %d eraseblocks (%d-%d) of mtd%d\n", | |
225 | ebcnt, eb, eb + ebcnt - 1, dev); | |
226 | if (pgcnt) | |
227 | printk(PRINT_PREF "torturing just %d pages per eraseblock\n", | |
228 | pgcnt); | |
229 | printk(PRINT_PREF "write verify %s\n", check ? "enabled" : "disabled"); | |
230 | ||
231 | mtd = get_mtd_device(NULL, dev); | |
232 | if (IS_ERR(mtd)) { | |
233 | err = PTR_ERR(mtd); | |
234 | printk(PRINT_PREF "error: cannot get MTD device\n"); | |
235 | return err; | |
236 | } | |
237 | ||
238 | if (mtd->writesize == 1) { | |
239 | printk(PRINT_PREF "not NAND flash, assume page size is 512 " | |
240 | "bytes.\n"); | |
241 | pgsize = 512; | |
242 | } else | |
243 | pgsize = mtd->writesize; | |
244 | ||
245 | if (pgcnt && (pgcnt > mtd->erasesize / pgsize || pgcnt < 0)) { | |
246 | printk(PRINT_PREF "error: invalid pgcnt value %d\n", pgcnt); | |
247 | goto out_mtd; | |
248 | } | |
249 | ||
250 | err = -ENOMEM; | |
251 | patt_5A5 = kmalloc(mtd->erasesize, GFP_KERNEL); | |
252 | if (!patt_5A5) { | |
253 | printk(PRINT_PREF "error: cannot allocate memory\n"); | |
254 | goto out_mtd; | |
255 | } | |
256 | ||
257 | patt_A5A = kmalloc(mtd->erasesize, GFP_KERNEL); | |
258 | if (!patt_A5A) { | |
259 | printk(PRINT_PREF "error: cannot allocate memory\n"); | |
260 | goto out_patt_5A5; | |
261 | } | |
262 | ||
263 | patt_FF = kmalloc(mtd->erasesize, GFP_KERNEL); | |
264 | if (!patt_FF) { | |
265 | printk(PRINT_PREF "error: cannot allocate memory\n"); | |
266 | goto out_patt_A5A; | |
267 | } | |
268 | ||
269 | check_buf = kmalloc(mtd->erasesize, GFP_KERNEL); | |
270 | if (!check_buf) { | |
271 | printk(PRINT_PREF "error: cannot allocate memory\n"); | |
272 | goto out_patt_FF; | |
273 | } | |
274 | ||
275 | err = 0; | |
276 | ||
277 | /* Initialize patterns */ | |
278 | memset(patt_FF, 0xFF, mtd->erasesize); | |
279 | for (i = 0; i < mtd->erasesize / pgsize; i++) { | |
280 | if (!(i & 1)) { | |
281 | memset(patt_5A5 + i * pgsize, 0x55, pgsize); | |
282 | memset(patt_A5A + i * pgsize, 0xAA, pgsize); | |
283 | } else { | |
284 | memset(patt_5A5 + i * pgsize, 0xAA, pgsize); | |
285 | memset(patt_A5A + i * pgsize, 0x55, pgsize); | |
286 | } | |
287 | } | |
288 | ||
289 | /* | |
290 | * Check if there is a bad eraseblock among those we are going to test. | |
291 | */ | |
292 | memset(&bad_ebs[0], 0, sizeof(int) * ebcnt); | |
293 | if (mtd->block_isbad) { | |
294 | for (i = eb; i < eb + ebcnt; i++) { | |
295 | err = mtd->block_isbad(mtd, | |
296 | (loff_t)i * mtd->erasesize); | |
297 | ||
298 | if (err < 0) { | |
299 | printk(PRINT_PREF "block_isbad() returned %d " | |
300 | "for EB %d\n", err, i); | |
301 | goto out; | |
302 | } | |
303 | ||
304 | if (err) { | |
305 | printk("EB %d is bad. Skip it.\n", i); | |
306 | bad_ebs[i - eb] = 1; | |
307 | } | |
308 | } | |
309 | } | |
310 | ||
311 | start_timing(); | |
312 | while (1) { | |
313 | int i; | |
314 | void *patt; | |
315 | ||
316 | /* Erase all eraseblocks */ | |
317 | for (i = eb; i < eb + ebcnt; i++) { | |
318 | if (bad_ebs[i - eb]) | |
319 | continue; | |
320 | err = erase_eraseblock(i); | |
321 | if (err) | |
322 | goto out; | |
323 | cond_resched(); | |
324 | } | |
325 | ||
326 | /* Check if the eraseblocks contain only 0xFF bytes */ | |
327 | if (check) { | |
328 | for (i = eb; i < eb + ebcnt; i++) { | |
329 | if (bad_ebs[i - eb]) | |
330 | continue; | |
331 | err = check_eraseblock(i, patt_FF); | |
332 | if (err) { | |
333 | printk(PRINT_PREF "verify failed" | |
334 | " for 0xFF... pattern\n"); | |
335 | goto out; | |
336 | } | |
337 | cond_resched(); | |
338 | } | |
339 | } | |
340 | ||
341 | /* Write the pattern */ | |
342 | for (i = eb; i < eb + ebcnt; i++) { | |
343 | if (bad_ebs[i - eb]) | |
344 | continue; | |
345 | if ((eb + erase_cycles) & 1) | |
346 | patt = patt_5A5; | |
347 | else | |
348 | patt = patt_A5A; | |
349 | err = write_pattern(i, patt); | |
350 | if (err) | |
351 | goto out; | |
352 | cond_resched(); | |
353 | } | |
354 | ||
355 | /* Verify what we wrote */ | |
356 | if (check) { | |
357 | for (i = eb; i < eb + ebcnt; i++) { | |
358 | if (bad_ebs[i - eb]) | |
359 | continue; | |
360 | if ((eb + erase_cycles) & 1) | |
361 | patt = patt_5A5; | |
362 | else | |
363 | patt = patt_A5A; | |
364 | err = check_eraseblock(i, patt); | |
365 | if (err) { | |
366 | printk(PRINT_PREF "verify failed for %s" | |
367 | " pattern\n", | |
368 | ((eb + erase_cycles) & 1) ? | |
369 | "0x55AA55..." : "0xAA55AA..."); | |
370 | goto out; | |
371 | } | |
372 | cond_resched(); | |
373 | } | |
374 | } | |
375 | ||
376 | erase_cycles += 1; | |
377 | ||
378 | if (erase_cycles % gran == 0) { | |
379 | long ms; | |
380 | ||
381 | stop_timing(); | |
382 | ms = (finish.tv_sec - start.tv_sec) * 1000 + | |
383 | (finish.tv_usec - start.tv_usec) / 1000; | |
384 | printk(PRINT_PREF "%08u erase cycles done, took %lu " | |
385 | "milliseconds (%lu seconds)\n", | |
386 | erase_cycles, ms, ms / 1000); | |
387 | start_timing(); | |
388 | } | |
389 | ||
390 | if (!infinite && --cycles_count == 0) | |
391 | break; | |
392 | } | |
393 | out: | |
394 | ||
395 | printk(PRINT_PREF "finished after %u erase cycles\n", | |
396 | erase_cycles); | |
397 | kfree(check_buf); | |
398 | out_patt_FF: | |
399 | kfree(patt_FF); | |
400 | out_patt_A5A: | |
401 | kfree(patt_A5A); | |
402 | out_patt_5A5: | |
403 | kfree(patt_5A5); | |
404 | out_mtd: | |
405 | put_mtd_device(mtd); | |
406 | if (err) | |
407 | printk(PRINT_PREF "error %d occurred during torturing\n", err); | |
408 | printk(KERN_INFO "=================================================\n"); | |
409 | return err; | |
410 | } | |
411 | module_init(tort_init); | |
412 | ||
413 | static void __exit tort_exit(void) | |
414 | { | |
415 | return; | |
416 | } | |
417 | module_exit(tort_exit); | |
418 | ||
419 | static int countdiffs(unsigned char *buf, unsigned char *check_buf, | |
420 | unsigned offset, unsigned len, unsigned *bytesp, | |
421 | unsigned *bitsp); | |
422 | static void print_bufs(unsigned char *read, unsigned char *written, int start, | |
423 | int len); | |
424 | ||
425 | /* | |
426 | * Report the detailed information about how the read EB differs from what was | |
427 | * written. | |
428 | */ | |
429 | static void report_corrupt(unsigned char *read, unsigned char *written) | |
430 | { | |
431 | int i; | |
432 | int bytes, bits, pages, first; | |
433 | int offset, len; | |
434 | size_t check_len = mtd->erasesize; | |
435 | ||
436 | if (pgcnt) | |
437 | check_len = pgcnt * pgsize; | |
438 | ||
439 | bytes = bits = pages = 0; | |
440 | for (i = 0; i < check_len; i += pgsize) | |
441 | if (countdiffs(written, read, i, pgsize, &bytes, | |
442 | &bits) >= 0) | |
443 | pages++; | |
444 | ||
445 | printk(PRINT_PREF "verify fails on %d pages, %d bytes/%d bits\n", | |
446 | pages, bytes, bits); | |
447 | printk(PRINT_PREF "The following is a list of all differences between" | |
448 | " what was read from flash and what was expected\n"); | |
449 | ||
450 | for (i = 0; i < check_len; i += pgsize) { | |
451 | cond_resched(); | |
452 | bytes = bits = 0; | |
453 | first = countdiffs(written, read, i, pgsize, &bytes, | |
454 | &bits); | |
455 | if (first < 0) | |
456 | continue; | |
457 | ||
458 | printk("-------------------------------------------------------" | |
459 | "----------------------------------\n"); | |
460 | ||
647b0d38 | 461 | printk(PRINT_PREF "Page %zd has %d bytes/%d bits failing verify," |
4db451a7 AB |
462 | " starting at offset 0x%x\n", |
463 | (mtd->erasesize - check_len + i) / pgsize, | |
464 | bytes, bits, first); | |
465 | ||
466 | offset = first & ~0x7; | |
467 | len = ((first + bytes) | 0x7) + 1 - offset; | |
468 | ||
469 | print_bufs(read, written, offset, len); | |
470 | } | |
471 | } | |
472 | ||
473 | static void print_bufs(unsigned char *read, unsigned char *written, int start, | |
474 | int len) | |
475 | { | |
476 | int i = 0, j1, j2; | |
477 | char *diff; | |
478 | ||
479 | printk("Offset Read Written\n"); | |
480 | while (i < len) { | |
481 | printk("0x%08x: ", start + i); | |
482 | diff = " "; | |
483 | for (j1 = 0; j1 < 8 && i + j1 < len; j1++) { | |
484 | printk(" %02x", read[start + i + j1]); | |
485 | if (read[start + i + j1] != written[start + i + j1]) | |
486 | diff = "***"; | |
487 | } | |
488 | ||
489 | while (j1 < 8) { | |
490 | printk(" "); | |
491 | j1 += 1; | |
492 | } | |
493 | ||
494 | printk(" %s ", diff); | |
495 | ||
496 | for (j2 = 0; j2 < 8 && i + j2 < len; j2++) | |
497 | printk(" %02x", written[start + i + j2]); | |
498 | printk("\n"); | |
499 | i += 8; | |
500 | } | |
501 | } | |
502 | ||
503 | /* | |
504 | * Count the number of differing bytes and bits and return the first differing | |
505 | * offset. | |
506 | */ | |
507 | static int countdiffs(unsigned char *buf, unsigned char *check_buf, | |
508 | unsigned offset, unsigned len, unsigned *bytesp, | |
509 | unsigned *bitsp) | |
510 | { | |
511 | unsigned i, bit; | |
512 | int first = -1; | |
513 | ||
514 | for (i = offset; i < offset + len; i++) | |
515 | if (buf[i] != check_buf[i]) { | |
516 | first = i; | |
517 | break; | |
518 | } | |
519 | ||
520 | while (i < offset + len) { | |
521 | if (buf[i] != check_buf[i]) { | |
522 | (*bytesp)++; | |
523 | bit = 1; | |
524 | while (bit < 256) { | |
525 | if ((buf[i] & bit) != (check_buf[i] & bit)) | |
526 | (*bitsp)++; | |
527 | bit <<= 1; | |
528 | } | |
529 | } | |
530 | i++; | |
531 | } | |
532 | ||
533 | return first; | |
534 | } | |
535 | ||
536 | MODULE_DESCRIPTION("Eraseblock torturing module"); | |
537 | MODULE_AUTHOR("Artem Bityutskiy, Jarkko Lavinen, Adrian Hunter"); | |
538 | MODULE_LICENSE("GPL"); |