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