nand_util.c 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876
  1. /*
  2. * drivers/mtd/nand/nand_util.c
  3. *
  4. * Copyright (C) 2006 by Weiss-Electronic GmbH.
  5. * All rights reserved.
  6. *
  7. * @author: Guido Classen <clagix@gmail.com>
  8. * @descr: NAND Flash support
  9. * @references: borrowed heavily from Linux mtd-utils code:
  10. * flash_eraseall.c by Arcom Control System Ltd
  11. * nandwrite.c by Steven J. Hill (sjhill@realitydiluted.com)
  12. * and Thomas Gleixner (tglx@linutronix.de)
  13. *
  14. * Copyright (C) 2008 Nokia Corporation: drop_ffs() function by
  15. * Artem Bityutskiy <dedekind1@gmail.com> from mtd-utils
  16. *
  17. * See file CREDITS for list of people who contributed to this
  18. * project.
  19. *
  20. * This program is free software; you can redistribute it and/or
  21. * modify it under the terms of the GNU General Public License version
  22. * 2 as published by the Free Software Foundation.
  23. *
  24. * This program is distributed in the hope that it will be useful,
  25. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  26. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  27. * GNU General Public License for more details.
  28. *
  29. * You should have received a copy of the GNU General Public License
  30. * along with this program; if not, write to the Free Software
  31. * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  32. * MA 02111-1307 USA
  33. *
  34. * Copyright 2010 Freescale Semiconductor
  35. * The portions of this file whose copyright is held by Freescale and which
  36. * are not considered a derived work of GPL v2-only code may be distributed
  37. * and/or modified under the terms of the GNU General Public License as
  38. * published by the Free Software Foundation; either version 2 of the
  39. * License, or (at your option) any later version.
  40. */
  41. #include <common.h>
  42. #include <command.h>
  43. #include <watchdog.h>
  44. #include <malloc.h>
  45. #include <div64.h>
  46. #include <asm/errno.h>
  47. #include <linux/mtd/mtd.h>
  48. #include <nand.h>
  49. #include <jffs2/jffs2.h>
  50. typedef struct erase_info erase_info_t;
  51. typedef struct mtd_info mtd_info_t;
  52. /* support only for native endian JFFS2 */
  53. #define cpu_to_je16(x) (x)
  54. #define cpu_to_je32(x) (x)
  55. /**
  56. * nand_erase_opts: - erase NAND flash with support for various options
  57. * (jffs2 formatting)
  58. *
  59. * @param meminfo NAND device to erase
  60. * @param opts options, @see struct nand_erase_options
  61. * @return 0 in case of success
  62. *
  63. * This code is ported from flash_eraseall.c from Linux mtd utils by
  64. * Arcom Control System Ltd.
  65. */
  66. int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts)
  67. {
  68. struct jffs2_unknown_node cleanmarker;
  69. erase_info_t erase;
  70. unsigned long erase_length, erased_length; /* in blocks */
  71. int bbtest = 1;
  72. int result;
  73. int percent_complete = -1;
  74. const char *mtd_device = meminfo->name;
  75. struct mtd_oob_ops oob_opts;
  76. struct nand_chip *chip = meminfo->priv;
  77. if ((opts->offset & (meminfo->erasesize - 1)) != 0) {
  78. printf("Attempt to erase non block-aligned data\n");
  79. return -1;
  80. }
  81. memset(&erase, 0, sizeof(erase));
  82. memset(&oob_opts, 0, sizeof(oob_opts));
  83. erase.mtd = meminfo;
  84. erase.len = meminfo->erasesize;
  85. erase.addr = opts->offset;
  86. erase_length = lldiv(opts->length + meminfo->erasesize - 1,
  87. meminfo->erasesize);
  88. cleanmarker.magic = cpu_to_je16(JFFS2_MAGIC_BITMASK);
  89. cleanmarker.nodetype = cpu_to_je16(JFFS2_NODETYPE_CLEANMARKER);
  90. cleanmarker.totlen = cpu_to_je32(8);
  91. /* scrub option allows to erase badblock. To prevent internal
  92. * check from erase() method, set block check method to dummy
  93. * and disable bad block table while erasing.
  94. */
  95. if (opts->scrub) {
  96. erase.scrub = opts->scrub;
  97. /*
  98. * We don't need the bad block table anymore...
  99. * after scrub, there are no bad blocks left!
  100. */
  101. if (chip->bbt) {
  102. kfree(chip->bbt);
  103. }
  104. chip->bbt = NULL;
  105. }
  106. for (erased_length = 0;
  107. erased_length < erase_length;
  108. erase.addr += meminfo->erasesize) {
  109. WATCHDOG_RESET();
  110. if (!opts->scrub && bbtest) {
  111. int ret = meminfo->block_isbad(meminfo, erase.addr);
  112. if (ret > 0) {
  113. if (!opts->quiet)
  114. printf("\rSkipping bad block at "
  115. "0x%08llx "
  116. " \n",
  117. erase.addr);
  118. if (!opts->spread)
  119. erased_length++;
  120. continue;
  121. } else if (ret < 0) {
  122. printf("\n%s: MTD get bad block failed: %d\n",
  123. mtd_device,
  124. ret);
  125. return -1;
  126. }
  127. }
  128. erased_length++;
  129. result = meminfo->erase(meminfo, &erase);
  130. if (result != 0) {
  131. printf("\n%s: MTD Erase failure: %d\n",
  132. mtd_device, result);
  133. continue;
  134. }
  135. /* format for JFFS2 ? */
  136. if (opts->jffs2 && chip->ecc.layout->oobavail >= 8) {
  137. chip->ops.ooblen = 8;
  138. chip->ops.datbuf = NULL;
  139. chip->ops.oobbuf = (uint8_t *)&cleanmarker;
  140. chip->ops.ooboffs = 0;
  141. chip->ops.mode = MTD_OOB_AUTO;
  142. result = meminfo->write_oob(meminfo,
  143. erase.addr,
  144. &chip->ops);
  145. if (result != 0) {
  146. printf("\n%s: MTD writeoob failure: %d\n",
  147. mtd_device, result);
  148. continue;
  149. }
  150. }
  151. if (!opts->quiet) {
  152. unsigned long long n = erased_length * 100ULL;
  153. int percent;
  154. do_div(n, erase_length);
  155. percent = (int)n;
  156. /* output progress message only at whole percent
  157. * steps to reduce the number of messages printed
  158. * on (slow) serial consoles
  159. */
  160. if (percent != percent_complete) {
  161. percent_complete = percent;
  162. printf("\rErasing at 0x%llx -- %3d%% complete.",
  163. erase.addr, percent);
  164. if (opts->jffs2 && result == 0)
  165. printf(" Cleanmarker written at 0x%llx.",
  166. erase.addr);
  167. }
  168. }
  169. }
  170. if (!opts->quiet)
  171. printf("\n");
  172. if (opts->scrub)
  173. chip->scan_bbt(meminfo);
  174. return 0;
  175. }
  176. #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
  177. /******************************************************************************
  178. * Support for locking / unlocking operations of some NAND devices
  179. *****************************************************************************/
  180. /**
  181. * nand_lock: Set all pages of NAND flash chip to the LOCK or LOCK-TIGHT
  182. * state
  183. *
  184. * @param mtd nand mtd instance
  185. * @param tight bring device in lock tight mode
  186. *
  187. * @return 0 on success, -1 in case of error
  188. *
  189. * The lock / lock-tight command only applies to the whole chip. To get some
  190. * parts of the chip lock and others unlocked use the following sequence:
  191. *
  192. * - Lock all pages of the chip using nand_lock(mtd, 0) (or the lockpre pin)
  193. * - Call nand_unlock() once for each consecutive area to be unlocked
  194. * - If desired: Bring the chip to the lock-tight state using nand_lock(mtd, 1)
  195. *
  196. * If the device is in lock-tight state software can't change the
  197. * current active lock/unlock state of all pages. nand_lock() / nand_unlock()
  198. * calls will fail. It is only posible to leave lock-tight state by
  199. * an hardware signal (low pulse on _WP pin) or by power down.
  200. */
  201. int nand_lock(struct mtd_info *mtd, int tight)
  202. {
  203. int ret = 0;
  204. int status;
  205. struct nand_chip *chip = mtd->priv;
  206. /* select the NAND device */
  207. chip->select_chip(mtd, 0);
  208. /* check the Lock Tight Status */
  209. chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, 0);
  210. if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
  211. printf("nand_lock: Device is locked tight!\n");
  212. ret = -1;
  213. goto out;
  214. }
  215. chip->cmdfunc(mtd,
  216. (tight ? NAND_CMD_LOCK_TIGHT : NAND_CMD_LOCK),
  217. -1, -1);
  218. /* call wait ready function */
  219. status = chip->waitfunc(mtd, chip);
  220. /* see if device thinks it succeeded */
  221. if (status & 0x01) {
  222. ret = -1;
  223. }
  224. out:
  225. /* de-select the NAND device */
  226. chip->select_chip(mtd, -1);
  227. return ret;
  228. }
  229. /**
  230. * nand_get_lock_status: - query current lock state from one page of NAND
  231. * flash
  232. *
  233. * @param mtd nand mtd instance
  234. * @param offset page address to query (must be page-aligned!)
  235. *
  236. * @return -1 in case of error
  237. * >0 lock status:
  238. * bitfield with the following combinations:
  239. * NAND_LOCK_STATUS_TIGHT: page in tight state
  240. * NAND_LOCK_STATUS_UNLOCK: page unlocked
  241. *
  242. */
  243. int nand_get_lock_status(struct mtd_info *mtd, loff_t offset)
  244. {
  245. int ret = 0;
  246. int chipnr;
  247. int page;
  248. struct nand_chip *chip = mtd->priv;
  249. /* select the NAND device */
  250. chipnr = (int)(offset >> chip->chip_shift);
  251. chip->select_chip(mtd, chipnr);
  252. if ((offset & (mtd->writesize - 1)) != 0) {
  253. printf("nand_get_lock_status: "
  254. "Start address must be beginning of "
  255. "nand page!\n");
  256. ret = -1;
  257. goto out;
  258. }
  259. /* check the Lock Status */
  260. page = (int)(offset >> chip->page_shift);
  261. chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
  262. ret = chip->read_byte(mtd) & (NAND_LOCK_STATUS_TIGHT
  263. | NAND_LOCK_STATUS_UNLOCK);
  264. out:
  265. /* de-select the NAND device */
  266. chip->select_chip(mtd, -1);
  267. return ret;
  268. }
  269. /**
  270. * nand_unlock: - Unlock area of NAND pages
  271. * only one consecutive area can be unlocked at one time!
  272. *
  273. * @param mtd nand mtd instance
  274. * @param start start byte address
  275. * @param length number of bytes to unlock (must be a multiple of
  276. * page size nand->writesize)
  277. * @param allexcept if set, unlock everything not selected
  278. *
  279. * @return 0 on success, -1 in case of error
  280. */
  281. int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
  282. int allexcept)
  283. {
  284. int ret = 0;
  285. int chipnr;
  286. int status;
  287. int page;
  288. struct nand_chip *chip = mtd->priv;
  289. debug("nand_unlock%s: start: %08llx, length: %d!\n",
  290. allexcept ? " (allexcept)" : "", start, length);
  291. /* select the NAND device */
  292. chipnr = (int)(start >> chip->chip_shift);
  293. chip->select_chip(mtd, chipnr);
  294. /* check the WP bit */
  295. chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
  296. if (!(chip->read_byte(mtd) & NAND_STATUS_WP)) {
  297. printf("nand_unlock: Device is write protected!\n");
  298. ret = -1;
  299. goto out;
  300. }
  301. /* check the Lock Tight Status */
  302. page = (int)(start >> chip->page_shift);
  303. chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
  304. if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
  305. printf("nand_unlock: Device is locked tight!\n");
  306. ret = -1;
  307. goto out;
  308. }
  309. if ((start & (mtd->erasesize - 1)) != 0) {
  310. printf("nand_unlock: Start address must be beginning of "
  311. "nand block!\n");
  312. ret = -1;
  313. goto out;
  314. }
  315. if (length == 0 || (length & (mtd->erasesize - 1)) != 0) {
  316. printf("nand_unlock: Length must be a multiple of nand block "
  317. "size %08x!\n", mtd->erasesize);
  318. ret = -1;
  319. goto out;
  320. }
  321. /*
  322. * Set length so that the last address is set to the
  323. * starting address of the last block
  324. */
  325. length -= mtd->erasesize;
  326. /* submit address of first page to unlock */
  327. chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);
  328. /* submit ADDRESS of LAST page to unlock */
  329. page += (int)(length >> chip->page_shift);
  330. /*
  331. * Page addresses for unlocking are supposed to be block-aligned.
  332. * At least some NAND chips use the low bit to indicate that the
  333. * page range should be inverted.
  334. */
  335. if (allexcept)
  336. page |= 1;
  337. chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1, page & chip->pagemask);
  338. /* call wait ready function */
  339. status = chip->waitfunc(mtd, chip);
  340. /* see if device thinks it succeeded */
  341. if (status & 0x01) {
  342. /* there was an error */
  343. ret = -1;
  344. goto out;
  345. }
  346. out:
  347. /* de-select the NAND device */
  348. chip->select_chip(mtd, -1);
  349. return ret;
  350. }
  351. #endif
  352. /**
  353. * check_skip_len
  354. *
  355. * Check if there are any bad blocks, and whether length including bad
  356. * blocks fits into device
  357. *
  358. * @param nand NAND device
  359. * @param offset offset in flash
  360. * @param length image length
  361. * @param used length of flash needed for the requested length
  362. * @return 0 if the image fits and there are no bad blocks
  363. * 1 if the image fits, but there are bad blocks
  364. * -1 if the image does not fit
  365. */
  366. static int check_skip_len(nand_info_t *nand, loff_t offset, size_t length,
  367. size_t *used)
  368. {
  369. size_t len_excl_bad = 0;
  370. int ret = 0;
  371. while (len_excl_bad < length) {
  372. size_t block_len, block_off;
  373. loff_t block_start;
  374. if (offset >= nand->size)
  375. return -1;
  376. block_start = offset & ~(loff_t)(nand->erasesize - 1);
  377. block_off = offset & (nand->erasesize - 1);
  378. block_len = nand->erasesize - block_off;
  379. if (!nand_block_isbad(nand, block_start))
  380. len_excl_bad += block_len;
  381. else
  382. ret = 1;
  383. offset += block_len;
  384. *used += block_len;
  385. }
  386. /* If the length is not a multiple of block_len, adjust. */
  387. if (len_excl_bad > length)
  388. *used -= (len_excl_bad - length);
  389. return ret;
  390. }
  391. #ifdef CONFIG_CMD_NAND_TRIMFFS
  392. static size_t drop_ffs(const nand_info_t *nand, const u_char *buf,
  393. const size_t *len)
  394. {
  395. size_t i, l = *len;
  396. for (i = l - 1; i >= 0; i--)
  397. if (buf[i] != 0xFF)
  398. break;
  399. /* The resulting length must be aligned to the minimum flash I/O size */
  400. l = i + 1;
  401. l = (l + nand->writesize - 1) / nand->writesize;
  402. l *= nand->writesize;
  403. /*
  404. * since the input length may be unaligned, prevent access past the end
  405. * of the buffer
  406. */
  407. return min(l, *len);
  408. }
  409. #endif
  410. /**
  411. * nand_write_skip_bad:
  412. *
  413. * Write image to NAND flash.
  414. * Blocks that are marked bad are skipped and the is written to the next
  415. * block instead as long as the image is short enough to fit even after
  416. * skipping the bad blocks. Due to bad blocks we may not be able to
  417. * perform the requested write. In the case where the write would
  418. * extend beyond the end of the NAND device, both length and actual (if
  419. * not NULL) are set to 0. In the case where the write would extend
  420. * beyond the limit we are passed, length is set to 0 and actual is set
  421. * to the required length.
  422. *
  423. * @param nand NAND device
  424. * @param offset offset in flash
  425. * @param length buffer length
  426. * @param actual set to size required to write length worth of
  427. * buffer or 0 on error, if not NULL
  428. * @param lim maximum size that actual may be in order to not
  429. * exceed the buffer
  430. * @param buffer buffer to read from
  431. * @param flags flags modifying the behaviour of the write to NAND
  432. * @return 0 in case of success
  433. */
  434. int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
  435. size_t *actual, loff_t lim, u_char *buffer, int flags)
  436. {
  437. int rval = 0, blocksize;
  438. size_t left_to_write = *length;
  439. size_t used_for_write = 0;
  440. u_char *p_buffer = buffer;
  441. int need_skip;
  442. if (actual)
  443. *actual = 0;
  444. #ifdef CONFIG_CMD_NAND_YAFFS
  445. if (flags & WITH_YAFFS_OOB) {
  446. if (flags & ~WITH_YAFFS_OOB)
  447. return -EINVAL;
  448. int pages;
  449. pages = nand->erasesize / nand->writesize;
  450. blocksize = (pages * nand->oobsize) + nand->erasesize;
  451. if (*length % (nand->writesize + nand->oobsize)) {
  452. printf("Attempt to write incomplete page"
  453. " in yaffs mode\n");
  454. return -EINVAL;
  455. }
  456. } else
  457. #endif
  458. {
  459. blocksize = nand->erasesize;
  460. }
  461. /*
  462. * nand_write() handles unaligned, partial page writes.
  463. *
  464. * We allow length to be unaligned, for convenience in
  465. * using the $filesize variable.
  466. *
  467. * However, starting at an unaligned offset makes the
  468. * semantics of bad block skipping ambiguous (really,
  469. * you should only start a block skipping access at a
  470. * partition boundary). So don't try to handle that.
  471. */
  472. if ((offset & (nand->writesize - 1)) != 0) {
  473. printf("Attempt to write non page-aligned data\n");
  474. *length = 0;
  475. return -EINVAL;
  476. }
  477. need_skip = check_skip_len(nand, offset, *length, &used_for_write);
  478. if (actual)
  479. *actual = used_for_write;
  480. if (need_skip < 0) {
  481. printf("Attempt to write outside the flash area\n");
  482. *length = 0;
  483. return -EINVAL;
  484. }
  485. if (used_for_write > lim) {
  486. puts("Size of write exceeds partition or device limit\n");
  487. *length = 0;
  488. return -EFBIG;
  489. }
  490. if (!need_skip && !(flags & WITH_DROP_FFS)) {
  491. rval = nand_write(nand, offset, length, buffer);
  492. if (rval == 0)
  493. return 0;
  494. *length = 0;
  495. printf("NAND write to offset %llx failed %d\n",
  496. offset, rval);
  497. return rval;
  498. }
  499. while (left_to_write > 0) {
  500. size_t block_offset = offset & (nand->erasesize - 1);
  501. size_t write_size, truncated_write_size;
  502. WATCHDOG_RESET();
  503. if (nand_block_isbad(nand, offset & ~(nand->erasesize - 1))) {
  504. printf("Skip bad block 0x%08llx\n",
  505. offset & ~(nand->erasesize - 1));
  506. offset += nand->erasesize - block_offset;
  507. continue;
  508. }
  509. if (left_to_write < (blocksize - block_offset))
  510. write_size = left_to_write;
  511. else
  512. write_size = blocksize - block_offset;
  513. #ifdef CONFIG_CMD_NAND_YAFFS
  514. if (flags & WITH_YAFFS_OOB) {
  515. int page, pages;
  516. size_t pagesize = nand->writesize;
  517. size_t pagesize_oob = pagesize + nand->oobsize;
  518. struct mtd_oob_ops ops;
  519. ops.len = pagesize;
  520. ops.ooblen = nand->oobsize;
  521. ops.mode = MTD_OOB_AUTO;
  522. ops.ooboffs = 0;
  523. pages = write_size / pagesize_oob;
  524. for (page = 0; page < pages; page++) {
  525. WATCHDOG_RESET();
  526. ops.datbuf = p_buffer;
  527. ops.oobbuf = ops.datbuf + pagesize;
  528. rval = nand->write_oob(nand, offset, &ops);
  529. if (rval != 0)
  530. break;
  531. offset += pagesize;
  532. p_buffer += pagesize_oob;
  533. }
  534. }
  535. else
  536. #endif
  537. {
  538. truncated_write_size = write_size;
  539. #ifdef CONFIG_CMD_NAND_TRIMFFS
  540. if (flags & WITH_DROP_FFS)
  541. truncated_write_size = drop_ffs(nand, p_buffer,
  542. &write_size);
  543. #endif
  544. rval = nand_write(nand, offset, &truncated_write_size,
  545. p_buffer);
  546. offset += write_size;
  547. p_buffer += write_size;
  548. }
  549. if (rval != 0) {
  550. printf("NAND write to offset %llx failed %d\n",
  551. offset, rval);
  552. *length -= left_to_write;
  553. return rval;
  554. }
  555. left_to_write -= write_size;
  556. }
  557. return 0;
  558. }
  559. /**
  560. * nand_read_skip_bad:
  561. *
  562. * Read image from NAND flash.
  563. * Blocks that are marked bad are skipped and the next block is read
  564. * instead as long as the image is short enough to fit even after
  565. * skipping the bad blocks. Due to bad blocks we may not be able to
  566. * perform the requested read. In the case where the read would extend
  567. * beyond the end of the NAND device, both length and actual (if not
  568. * NULL) are set to 0. In the case where the read would extend beyond
  569. * the limit we are passed, length is set to 0 and actual is set to the
  570. * required length.
  571. *
  572. * @param nand NAND device
  573. * @param offset offset in flash
  574. * @param length buffer length, on return holds number of read bytes
  575. * @param actual set to size required to read length worth of buffer or 0
  576. * on error, if not NULL
  577. * @param lim maximum size that actual may be in order to not exceed the
  578. * buffer
  579. * @param buffer buffer to write to
  580. * @return 0 in case of success
  581. */
  582. int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
  583. size_t *actual, loff_t lim, u_char *buffer)
  584. {
  585. int rval;
  586. size_t left_to_read = *length;
  587. size_t used_for_read = 0;
  588. u_char *p_buffer = buffer;
  589. int need_skip;
  590. if ((offset & (nand->writesize - 1)) != 0) {
  591. printf("Attempt to read non page-aligned data\n");
  592. *length = 0;
  593. if (actual)
  594. *actual = 0;
  595. return -EINVAL;
  596. }
  597. need_skip = check_skip_len(nand, offset, *length, &used_for_read);
  598. if (actual)
  599. *actual = used_for_read;
  600. if (need_skip < 0) {
  601. printf("Attempt to read outside the flash area\n");
  602. *length = 0;
  603. return -EINVAL;
  604. }
  605. if (used_for_read > lim) {
  606. puts("Size of read exceeds partition or device limit\n");
  607. *length = 0;
  608. return -EFBIG;
  609. }
  610. if (!need_skip) {
  611. rval = nand_read(nand, offset, length, buffer);
  612. if (!rval || rval == -EUCLEAN)
  613. return 0;
  614. *length = 0;
  615. printf("NAND read from offset %llx failed %d\n",
  616. offset, rval);
  617. return rval;
  618. }
  619. while (left_to_read > 0) {
  620. size_t block_offset = offset & (nand->erasesize - 1);
  621. size_t read_length;
  622. WATCHDOG_RESET();
  623. if (nand_block_isbad(nand, offset & ~(nand->erasesize - 1))) {
  624. printf("Skipping bad block 0x%08llx\n",
  625. offset & ~(nand->erasesize - 1));
  626. offset += nand->erasesize - block_offset;
  627. continue;
  628. }
  629. if (left_to_read < (nand->erasesize - block_offset))
  630. read_length = left_to_read;
  631. else
  632. read_length = nand->erasesize - block_offset;
  633. rval = nand_read(nand, offset, &read_length, p_buffer);
  634. if (rval && rval != -EUCLEAN) {
  635. printf("NAND read from offset %llx failed %d\n",
  636. offset, rval);
  637. *length -= left_to_read;
  638. return rval;
  639. }
  640. left_to_read -= read_length;
  641. offset += read_length;
  642. p_buffer += read_length;
  643. }
  644. return 0;
  645. }
  646. #ifdef CONFIG_CMD_NAND_TORTURE
  647. /**
  648. * check_pattern:
  649. *
  650. * Check if buffer contains only a certain byte pattern.
  651. *
  652. * @param buf buffer to check
  653. * @param patt the pattern to check
  654. * @param size buffer size in bytes
  655. * @return 1 if there are only patt bytes in buf
  656. * 0 if something else was found
  657. */
  658. static int check_pattern(const u_char *buf, u_char patt, int size)
  659. {
  660. int i;
  661. for (i = 0; i < size; i++)
  662. if (buf[i] != patt)
  663. return 0;
  664. return 1;
  665. }
  666. /**
  667. * nand_torture:
  668. *
  669. * Torture a block of NAND flash.
  670. * This is useful to determine if a block that caused a write error is still
  671. * good or should be marked as bad.
  672. *
  673. * @param nand NAND device
  674. * @param offset offset in flash
  675. * @return 0 if the block is still good
  676. */
  677. int nand_torture(nand_info_t *nand, loff_t offset)
  678. {
  679. u_char patterns[] = {0xa5, 0x5a, 0x00};
  680. struct erase_info instr = {
  681. .mtd = nand,
  682. .addr = offset,
  683. .len = nand->erasesize,
  684. };
  685. size_t retlen;
  686. int err, ret = -1, i, patt_count;
  687. u_char *buf;
  688. if ((offset & (nand->erasesize - 1)) != 0) {
  689. puts("Attempt to torture a block at a non block-aligned offset\n");
  690. return -EINVAL;
  691. }
  692. if (offset + nand->erasesize > nand->size) {
  693. puts("Attempt to torture a block outside the flash area\n");
  694. return -EINVAL;
  695. }
  696. patt_count = ARRAY_SIZE(patterns);
  697. buf = malloc(nand->erasesize);
  698. if (buf == NULL) {
  699. puts("Out of memory for erase block buffer\n");
  700. return -ENOMEM;
  701. }
  702. for (i = 0; i < patt_count; i++) {
  703. err = nand->erase(nand, &instr);
  704. if (err) {
  705. printf("%s: erase() failed for block at 0x%llx: %d\n",
  706. nand->name, instr.addr, err);
  707. goto out;
  708. }
  709. /* Make sure the block contains only 0xff bytes */
  710. err = nand->read(nand, offset, nand->erasesize, &retlen, buf);
  711. if ((err && err != -EUCLEAN) || retlen != nand->erasesize) {
  712. printf("%s: read() failed for block at 0x%llx: %d\n",
  713. nand->name, instr.addr, err);
  714. goto out;
  715. }
  716. err = check_pattern(buf, 0xff, nand->erasesize);
  717. if (!err) {
  718. printf("Erased block at 0x%llx, but a non-0xff byte was found\n",
  719. offset);
  720. ret = -EIO;
  721. goto out;
  722. }
  723. /* Write a pattern and check it */
  724. memset(buf, patterns[i], nand->erasesize);
  725. err = nand->write(nand, offset, nand->erasesize, &retlen, buf);
  726. if (err || retlen != nand->erasesize) {
  727. printf("%s: write() failed for block at 0x%llx: %d\n",
  728. nand->name, instr.addr, err);
  729. goto out;
  730. }
  731. err = nand->read(nand, offset, nand->erasesize, &retlen, buf);
  732. if ((err && err != -EUCLEAN) || retlen != nand->erasesize) {
  733. printf("%s: read() failed for block at 0x%llx: %d\n",
  734. nand->name, instr.addr, err);
  735. goto out;
  736. }
  737. err = check_pattern(buf, patterns[i], nand->erasesize);
  738. if (!err) {
  739. printf("Pattern 0x%.2x checking failed for block at "
  740. "0x%llx\n", patterns[i], offset);
  741. ret = -EIO;
  742. goto out;
  743. }
  744. }
  745. ret = 0;
  746. out:
  747. free(buf);
  748. return ret;
  749. }
  750. #endif