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