nandbiterrs.c 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * Copyright © 2012 NetCommWireless
  4. * Iwo Mergler <Iwo.Mergler@netcommwireless.com.au>
  5. *
  6. * Test for multi-bit error recovery on a NAND page This mostly tests the
  7. * ECC controller / driver.
  8. *
  9. * There are two test modes:
  10. *
  11. * 0 - artificially inserting bit errors until the ECC fails
  12. * This is the default method and fairly quick. It should
  13. * be independent of the quality of the FLASH.
  14. *
  15. * 1 - re-writing the same pattern repeatedly until the ECC fails.
  16. * This method relies on the physics of NAND FLASH to eventually
  17. * generate '0' bits if '1' has been written sufficient times.
  18. * Depending on the NAND, the first bit errors will appear after
  19. * 1000 or more writes and then will usually snowball, reaching the
  20. * limits of the ECC quickly.
  21. *
  22. * The test stops after 10000 cycles, should your FLASH be
  23. * exceptionally good and not generate bit errors before that. Try
  24. * a different page in that case.
  25. *
  26. * Please note that neither of these tests will significantly 'use up' any
  27. * FLASH endurance. Only a maximum of two erase operations will be performed.
  28. */
  29. #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  30. #include <linux/init.h>
  31. #include <linux/module.h>
  32. #include <linux/moduleparam.h>
  33. #include <linux/mtd/mtd.h>
  34. #include <linux/err.h>
  35. #include <linux/mtd/rawnand.h>
  36. #include <linux/slab.h>
  37. #include "mtd_test.h"
  38. static int dev;
  39. module_param(dev, int, S_IRUGO);
  40. MODULE_PARM_DESC(dev, "MTD device number to use");
  41. static unsigned page_offset;
  42. module_param(page_offset, uint, S_IRUGO);
  43. MODULE_PARM_DESC(page_offset, "Page number relative to dev start");
  44. static unsigned seed;
  45. module_param(seed, uint, S_IRUGO);
  46. MODULE_PARM_DESC(seed, "Random seed");
  47. static int mode;
  48. module_param(mode, int, S_IRUGO);
  49. MODULE_PARM_DESC(mode, "0=incremental errors, 1=overwrite test");
  50. static unsigned max_overwrite = 10000;
  51. static loff_t offset; /* Offset of the page we're using. */
  52. static unsigned eraseblock; /* Eraseblock number for our page. */
  53. /* We assume that the ECC can correct up to a certain number
  54. * of biterrors per subpage. */
  55. static unsigned subsize; /* Size of subpages */
  56. static unsigned subcount; /* Number of subpages per page */
  57. static struct mtd_info *mtd; /* MTD device */
  58. static uint8_t *wbuffer; /* One page write / compare buffer */
  59. static uint8_t *rbuffer; /* One page read buffer */
  60. /* 'random' bytes from known offsets */
  61. static uint8_t hash(unsigned offset)
  62. {
  63. unsigned v = offset;
  64. unsigned char c;
  65. v ^= 0x7f7edfd3;
  66. v = v ^ (v >> 3);
  67. v = v ^ (v >> 5);
  68. v = v ^ (v >> 13);
  69. c = v & 0xFF;
  70. /* Reverse bits of result. */
  71. c = (c & 0x0F) << 4 | (c & 0xF0) >> 4;
  72. c = (c & 0x33) << 2 | (c & 0xCC) >> 2;
  73. c = (c & 0x55) << 1 | (c & 0xAA) >> 1;
  74. return c;
  75. }
  76. /* Writes wbuffer to page */
  77. static int write_page(int log)
  78. {
  79. if (log)
  80. pr_info("write_page\n");
  81. return mtdtest_write(mtd, offset, mtd->writesize, wbuffer);
  82. }
  83. /* Re-writes the data area while leaving the OOB alone. */
  84. static int rewrite_page(int log)
  85. {
  86. int err = 0;
  87. struct mtd_oob_ops ops;
  88. if (log)
  89. pr_info("rewrite page\n");
  90. ops.mode = MTD_OPS_RAW; /* No ECC */
  91. ops.len = mtd->writesize;
  92. ops.retlen = 0;
  93. ops.ooblen = 0;
  94. ops.oobretlen = 0;
  95. ops.ooboffs = 0;
  96. ops.datbuf = wbuffer;
  97. ops.oobbuf = NULL;
  98. err = mtd_write_oob(mtd, offset, &ops);
  99. if (err || ops.retlen != mtd->writesize) {
  100. pr_err("error: write_oob failed (%d)\n", err);
  101. if (!err)
  102. err = -EIO;
  103. }
  104. return err;
  105. }
  106. /* Reads page into rbuffer. Returns number of corrected bit errors (>=0)
  107. * or error (<0) */
  108. static int read_page(int log)
  109. {
  110. int err = 0;
  111. size_t read;
  112. struct mtd_ecc_stats oldstats;
  113. if (log)
  114. pr_info("read_page\n");
  115. /* Saving last mtd stats */
  116. memcpy(&oldstats, &mtd->ecc_stats, sizeof(oldstats));
  117. err = mtd_read(mtd, offset, mtd->writesize, &read, rbuffer);
  118. if (!err || err == -EUCLEAN)
  119. err = mtd->ecc_stats.corrected - oldstats.corrected;
  120. if (err < 0 || read != mtd->writesize) {
  121. pr_err("error: read failed at %#llx\n", (long long)offset);
  122. if (err >= 0)
  123. err = -EIO;
  124. }
  125. return err;
  126. }
  127. /* Verifies rbuffer against random sequence */
  128. static int verify_page(int log)
  129. {
  130. unsigned i, errs = 0;
  131. if (log)
  132. pr_info("verify_page\n");
  133. for (i = 0; i < mtd->writesize; i++) {
  134. if (rbuffer[i] != hash(i+seed)) {
  135. pr_err("Error: page offset %u, expected %02x, got %02x\n",
  136. i, hash(i+seed), rbuffer[i]);
  137. errs++;
  138. }
  139. }
  140. if (errs)
  141. return -EIO;
  142. else
  143. return 0;
  144. }
  145. #define CBIT(v, n) ((v) & (1 << (n)))
  146. #define BCLR(v, n) ((v) = (v) & ~(1 << (n)))
  147. /* Finds the first '1' bit in wbuffer starting at offset 'byte'
  148. * and sets it to '0'. */
  149. static int insert_biterror(unsigned byte)
  150. {
  151. int bit;
  152. while (byte < mtd->writesize) {
  153. for (bit = 7; bit >= 0; bit--) {
  154. if (CBIT(wbuffer[byte], bit)) {
  155. BCLR(wbuffer[byte], bit);
  156. pr_info("Inserted biterror @ %u/%u\n", byte, bit);
  157. return 0;
  158. }
  159. }
  160. byte++;
  161. }
  162. pr_err("biterror: Failed to find a '1' bit\n");
  163. return -EIO;
  164. }
  165. /* Writes 'random' data to page and then introduces deliberate bit
  166. * errors into the page, while verifying each step. */
  167. static int incremental_errors_test(void)
  168. {
  169. int err = 0;
  170. unsigned i;
  171. unsigned errs_per_subpage = 0;
  172. pr_info("incremental biterrors test\n");
  173. for (i = 0; i < mtd->writesize; i++)
  174. wbuffer[i] = hash(i+seed);
  175. err = write_page(1);
  176. if (err)
  177. goto exit;
  178. while (1) {
  179. err = rewrite_page(1);
  180. if (err)
  181. goto exit;
  182. err = read_page(1);
  183. if (err > 0)
  184. pr_info("Read reported %d corrected bit errors\n", err);
  185. if (err < 0) {
  186. pr_err("After %d biterrors per subpage, read reported error %d\n",
  187. errs_per_subpage, err);
  188. err = 0;
  189. goto exit;
  190. }
  191. err = verify_page(1);
  192. if (err) {
  193. pr_err("ECC failure, read data is incorrect despite read success\n");
  194. goto exit;
  195. }
  196. pr_info("Successfully corrected %d bit errors per subpage\n",
  197. errs_per_subpage);
  198. for (i = 0; i < subcount; i++) {
  199. err = insert_biterror(i * subsize);
  200. if (err < 0)
  201. goto exit;
  202. }
  203. errs_per_subpage++;
  204. }
  205. exit:
  206. return err;
  207. }
  208. /* Writes 'random' data to page and then re-writes that same data repeatedly.
  209. This eventually develops bit errors (bits written as '1' will slowly become
  210. '0'), which are corrected as far as the ECC is capable of. */
  211. static int overwrite_test(void)
  212. {
  213. int err = 0;
  214. unsigned i;
  215. unsigned max_corrected = 0;
  216. unsigned opno = 0;
  217. /* We don't expect more than this many correctable bit errors per
  218. * page. */
  219. #define MAXBITS 512
  220. static unsigned bitstats[MAXBITS]; /* bit error histogram. */
  221. memset(bitstats, 0, sizeof(bitstats));
  222. pr_info("overwrite biterrors test\n");
  223. for (i = 0; i < mtd->writesize; i++)
  224. wbuffer[i] = hash(i+seed);
  225. err = write_page(1);
  226. if (err)
  227. goto exit;
  228. while (opno < max_overwrite) {
  229. err = write_page(0);
  230. if (err)
  231. break;
  232. err = read_page(0);
  233. if (err >= 0) {
  234. if (err >= MAXBITS) {
  235. pr_info("Implausible number of bit errors corrected\n");
  236. err = -EIO;
  237. break;
  238. }
  239. bitstats[err]++;
  240. if (err > max_corrected) {
  241. max_corrected = err;
  242. pr_info("Read reported %d corrected bit errors\n",
  243. err);
  244. }
  245. } else { /* err < 0 */
  246. pr_info("Read reported error %d\n", err);
  247. err = 0;
  248. break;
  249. }
  250. err = verify_page(0);
  251. if (err) {
  252. bitstats[max_corrected] = opno;
  253. pr_info("ECC failure, read data is incorrect despite read success\n");
  254. break;
  255. }
  256. err = mtdtest_relax();
  257. if (err)
  258. break;
  259. opno++;
  260. }
  261. /* At this point bitstats[0] contains the number of ops with no bit
  262. * errors, bitstats[1] the number of ops with 1 bit error, etc. */
  263. pr_info("Bit error histogram (%d operations total):\n", opno);
  264. for (i = 0; i < max_corrected; i++)
  265. pr_info("Page reads with %3d corrected bit errors: %d\n",
  266. i, bitstats[i]);
  267. exit:
  268. return err;
  269. }
  270. static int __init mtd_nandbiterrs_init(void)
  271. {
  272. int err = 0;
  273. printk("\n");
  274. printk(KERN_INFO "==================================================\n");
  275. pr_info("MTD device: %d\n", dev);
  276. mtd = get_mtd_device(NULL, dev);
  277. if (IS_ERR(mtd)) {
  278. err = PTR_ERR(mtd);
  279. pr_err("error: cannot get MTD device\n");
  280. goto exit_mtddev;
  281. }
  282. if (!mtd_type_is_nand(mtd)) {
  283. pr_info("this test requires NAND flash\n");
  284. err = -ENODEV;
  285. goto exit_nand;
  286. }
  287. pr_info("MTD device size %llu, eraseblock=%u, page=%u, oob=%u\n",
  288. (unsigned long long)mtd->size, mtd->erasesize,
  289. mtd->writesize, mtd->oobsize);
  290. subsize = mtd->writesize >> mtd->subpage_sft;
  291. subcount = mtd->writesize / subsize;
  292. pr_info("Device uses %d subpages of %d bytes\n", subcount, subsize);
  293. offset = (loff_t)page_offset * mtd->writesize;
  294. eraseblock = mtd_div_by_eb(offset, mtd);
  295. pr_info("Using page=%u, offset=%llu, eraseblock=%u\n",
  296. page_offset, offset, eraseblock);
  297. wbuffer = kmalloc(mtd->writesize, GFP_KERNEL);
  298. if (!wbuffer) {
  299. err = -ENOMEM;
  300. goto exit_wbuffer;
  301. }
  302. rbuffer = kmalloc(mtd->writesize, GFP_KERNEL);
  303. if (!rbuffer) {
  304. err = -ENOMEM;
  305. goto exit_rbuffer;
  306. }
  307. err = mtdtest_erase_eraseblock(mtd, eraseblock);
  308. if (err)
  309. goto exit_error;
  310. if (mode == 0)
  311. err = incremental_errors_test();
  312. else
  313. err = overwrite_test();
  314. if (err)
  315. goto exit_error;
  316. /* We leave the block un-erased in case of test failure. */
  317. err = mtdtest_erase_eraseblock(mtd, eraseblock);
  318. if (err)
  319. goto exit_error;
  320. err = -EIO;
  321. pr_info("finished successfully.\n");
  322. printk(KERN_INFO "==================================================\n");
  323. exit_error:
  324. kfree(rbuffer);
  325. exit_rbuffer:
  326. kfree(wbuffer);
  327. exit_wbuffer:
  328. /* Nothing */
  329. exit_nand:
  330. put_mtd_device(mtd);
  331. exit_mtddev:
  332. return err;
  333. }
  334. static void __exit mtd_nandbiterrs_exit(void)
  335. {
  336. return;
  337. }
  338. module_init(mtd_nandbiterrs_init);
  339. module_exit(mtd_nandbiterrs_exit);
  340. MODULE_DESCRIPTION("NAND bit error recovery test");
  341. MODULE_AUTHOR("Iwo Mergler");
  342. MODULE_LICENSE("GPL");