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