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