drivers/mtd/nand/nand_util.c

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