common/cmd_nand.c

   1 /*
   2  * Driver for NAND support, Rick Bronson
   3  * borrowed heavily from:
   4  * (c) 1999 Machine Vision Holdings, Inc.
   5  * (c) 1999, 2000 David Woodhouse <dwmw2@infradead.org>
   6  *
   7  * Ported 'dynenv' to 'nand env.oob' command
   8  * (C) 2010 Nanometrics, Inc.
   9  * 'dynenv' -- Dynamic environment offset in NAND OOB
  10  * (C) Copyright 2006-2007 OpenMoko, Inc.
  11  * Added 16-bit nand support
  12  * (C) 2004 Texas Instruments
  13  *
  14  * Copyright 2010, 2012 Freescale Semiconductor
  15  * The portions of this file whose copyright is held by Freescale and which
  16  * are not considered a derived work of GPL v2-only code may be distributed
  17  * and/or modified under the terms of the GNU General Public License as
  18  * published by the Free Software Foundation; either version 2 of the
  19  * License, or (at your option) any later version.
  20  */
  21
  22 #include <common.h>
  23 #include <linux/mtd/mtd.h>
  24 #include <command.h>
  25 #include <watchdog.h>
  26 #include <malloc.h>
  27 #include <asm/byteorder.h>
  28 #include <jffs2/jffs2.h>
  29 #include <nand.h>
  30
  31 #if defined(CONFIG_CMD_MTDPARTS)
  32
  33 /* partition handling routines */
  34 int mtdparts_init(void);
  35 int id_parse(const char *id, const char **ret_id, u8 *dev_type, u8 *dev_num);
  36 int find_dev_and_part(const char *id, struct mtd_device **dev,
  37                       u8 *part_num, struct part_info **part);
  38 #endif
  39
  40 static int nand_dump(nand_info_t *nand, ulong off, int only_oob, int repeat)
  41 {
  42         int i;
  43         u_char *datbuf, *oobbuf, *p;
  44         static loff_t last;
  45         int ret = 0;
  46
  47         if (repeat)
  48                 off = last + nand->writesize;
  49
  50         last = off;
  51
  52         datbuf = memalign(ARCH_DMA_MINALIGN, nand->writesize);
  53         if (!datbuf) {
  54                 puts("No memory for page buffer\n");
  55                 return 1;
  56         }
  57
  58         oobbuf = memalign(ARCH_DMA_MINALIGN, nand->oobsize);
  59         if (!oobbuf) {
  60                 puts("No memory for page buffer\n");
  61                 ret = 1;
  62                 goto free_dat;
  63         }
  64         off &= ~(nand->writesize - 1);
  65         loff_t addr = (loff_t) off;
  66         struct mtd_oob_ops ops;
  67         memset(&ops, 0, sizeof(ops));
  68         ops.datbuf = datbuf;
  69         ops.oobbuf = oobbuf;
  70         ops.len = nand->writesize;
  71         ops.ooblen = nand->oobsize;
  72         ops.mode = MTD_OPS_RAW;
  73         i = mtd_read_oob(nand, addr, &ops);
  74         if (i < 0) {
  75                 printf("Error (%d) reading page %08lx\n", i, off);
  76                 ret = 1;
  77                 goto free_all;
  78         }
  79         printf("Page %08lx dump:\n", off);
  80
  81         if (!only_oob) {
  82                 i = nand->writesize >> 4;
  83                 p = datbuf;
  84
  85                 while (i--) {
  86                         printf("\t%02x %02x %02x %02x %02x %02x %02x %02x"
  87                                "  %02x %02x %02x %02x %02x %02x %02x %02x\n",
  88                                p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7],
  89                                p[8], p[9], p[10], p[11], p[12], p[13], p[14],
  90                                p[15]);
  91                         p += 16;
  92                 }
  93         }
  94
  95         puts("OOB:\n");
  96         i = nand->oobsize >> 3;
  97         p = oobbuf;
  98         while (i--) {
  99                 printf("\t%02x %02x %02x %02x %02x %02x %02x %02x\n",
 100                        p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7]);
 101                 p += 8;
 102         }
 103
 104 free_all:
 105         free(oobbuf);
 106 free_dat:
 107         free(datbuf);
 108
 109         return ret;
 110 }
 111
 112 /* ------------------------------------------------------------------------- */
 113
 114 static int set_dev(int dev)
 115 {
 116         if (dev < 0 || dev >= CONFIG_SYS_MAX_NAND_DEVICE ||
 117             !nand_info[dev].name) {
 118                 puts("No such device\n");
 119                 return -1;
 120         }
 121
 122         if (nand_curr_device == dev)
 123                 return 0;
 124
 125         printf("Device %d: %s", dev, nand_info[dev].name);
 126         puts("... is now current device\n");
 127         nand_curr_device = dev;
 128
 129 #ifdef CONFIG_SYS_NAND_SELECT_DEVICE
 130         board_nand_select_device(nand_info[dev].priv, dev);
 131 #endif
 132
 133         return 0;
 134 }
 135
 136 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
 137 static void print_status(ulong start, ulong end, ulong erasesize, int status)
 138 {
 139         /*
 140          * Micron NAND flash (e.g. MT29F4G08ABADAH4) BLOCK LOCK READ STATUS is
 141          * not the same as others.  Instead of bit 1 being lock, it is
 142          * #lock_tight. To make the driver support either format, ignore bit 1
 143          * and use only bit 0 and bit 2.
 144          */
 145         printf("%08lx - %08lx: %08lx blocks %s%s%s\n",
 146                 start,
 147                 end - 1,
 148                 (end - start) / erasesize,
 149                 ((status & NAND_LOCK_STATUS_TIGHT) ?  "TIGHT " : ""),
 150                 (!(status & NAND_LOCK_STATUS_UNLOCK) ?  "LOCK " : ""),
 151                 ((status & NAND_LOCK_STATUS_UNLOCK) ?  "UNLOCK " : ""));
 152 }
 153
 154 static void do_nand_status(nand_info_t *nand)
 155 {
 156         ulong block_start = 0;
 157         ulong off;
 158         int last_status = -1;
 159
 160         struct nand_chip *nand_chip = nand->priv;
 161         /* check the WP bit */
 162         nand_chip->cmdfunc(nand, NAND_CMD_STATUS, -1, -1);
 163         printf("device is %swrite protected\n",
 164                 (nand_chip->read_byte(nand) & 0x80 ?
 165                 "NOT " : ""));
 166
 167         for (off = 0; off < nand->size; off += nand->erasesize) {
 168                 int s = nand_get_lock_status(nand, off);
 169
 170                 /* print message only if status has changed */
 171                 if (s != last_status && off != 0) {
 172                         print_status(block_start, off, nand->erasesize,
 173                                         last_status);
 174                         block_start = off;
 175                 }
 176                 last_status = s;
 177         }
 178         /* Print the last block info */
 179         print_status(block_start, off, nand->erasesize, last_status);
 180 }
 181 #endif
 182
 183 #ifdef CONFIG_ENV_OFFSET_OOB
 184 unsigned long nand_env_oob_offset;
 185
 186 int do_nand_env_oob(cmd_tbl_t *cmdtp, int argc, char *const argv[])
 187 {
 188         int ret;
 189         uint32_t oob_buf[ENV_OFFSET_SIZE/sizeof(uint32_t)];
 190         nand_info_t *nand = &nand_info[0];
 191         char *cmd = argv[1];
 192
 193         if (CONFIG_SYS_MAX_NAND_DEVICE == 0 || !nand->name) {
 194                 puts("no devices available\n");
 195                 return 1;
 196         }
 197
 198         set_dev(0);
 199
 200         if (!strcmp(cmd, "get")) {
 201                 ret = get_nand_env_oob(nand, &nand_env_oob_offset);
 202                 if (ret)
 203                         return 1;
 204
 205                 printf("0x%08lx\n", nand_env_oob_offset);
 206         } else if (!strcmp(cmd, "set")) {
 207                 loff_t addr;
 208                 loff_t maxsize;
 209                 struct mtd_oob_ops ops;
 210                 int idx = 0;
 211
 212                 if (argc < 3)
 213                         goto usage;
 214
 215                 /* We don't care about size, or maxsize. */
 216                 if (mtd_arg_off(argv[2], &idx, &addr, &maxsize, &maxsize,
 217                                 MTD_DEV_TYPE_NAND, nand_info[idx].size)) {
 218                         puts("Offset or partition name expected\n");
 219                         return 1;
 220                 }
 221                 if (set_dev(idx)) {
 222                         puts("Offset or partition name expected\n");
 223                         return 1;
 224                 }
 225
 226                 if (idx != 0) {
 227                         puts("Partition not on first NAND device\n");
 228                         return 1;
 229                 }
 230
 231                 if (nand->oobavail < ENV_OFFSET_SIZE) {
 232                         printf("Insufficient available OOB bytes:\n"
 233                                "%d OOB bytes available but %d required for "
 234                                "env.oob support\n",
 235                                nand->oobavail, ENV_OFFSET_SIZE);
 236                         return 1;
 237                 }
 238
 239                 if ((addr & (nand->erasesize - 1)) != 0) {
 240                         printf("Environment offset must be block-aligned\n");
 241                         return 1;
 242                 }
 243
 244                 ops.datbuf = NULL;
 245                 ops.mode = MTD_OOB_AUTO;
 246                 ops.ooboffs = 0;
 247                 ops.ooblen = ENV_OFFSET_SIZE;
 248                 ops.oobbuf = (void *) oob_buf;
 249
 250                 oob_buf[0] = ENV_OOB_MARKER;
 251                 oob_buf[1] = addr / nand->erasesize;
 252
 253                 ret = nand->write_oob(nand, ENV_OFFSET_SIZE, &ops);
 254                 if (ret) {
 255                         printf("Error writing OOB block 0\n");
 256                         return ret;
 257                 }
 258
 259                 ret = get_nand_env_oob(nand, &nand_env_oob_offset);
 260                 if (ret) {
 261                         printf("Error reading env offset in OOB\n");
 262                         return ret;
 263                 }
 264
 265                 if (addr != nand_env_oob_offset) {
 266                         printf("Verification of env offset in OOB failed: "
 267                                "0x%08llx expected but got 0x%08lx\n",
 268                                (unsigned long long)addr, nand_env_oob_offset);
 269                         return 1;
 270                 }
 271         } else {
 272                 goto usage;
 273         }
 274
 275         return ret;
 276
 277 usage:
 278         return CMD_RET_USAGE;
 279 }
 280
 281 #endif
 282
 283 static void nand_print_and_set_info(int idx)
 284 {
 285         nand_info_t *nand = &nand_info[idx];
 286         struct nand_chip *chip = nand->priv;
 287
 288         printf("Device %d: ", idx);
 289         if (chip->numchips > 1)
 290                 printf("%dx ", chip->numchips);
 291         printf("%s, sector size %u KiB\n",
 292                nand->name, nand->erasesize >> 10);
 293         printf("  Page size   %8d b\n", nand->writesize);
 294         printf("  OOB size    %8d b\n", nand->oobsize);
 295         printf("  Erase size  %8d b\n", nand->erasesize);
 296         printf("  subpagesize %8d b\n", chip->subpagesize);
 297         printf("  options     0x%8x\n", chip->options);
 298         printf("  bbt options 0x%8x\n", chip->bbt_options);
 299
 300         /* Set geometry info */
 301         setenv_hex("nand_writesize", nand->writesize);
 302         setenv_hex("nand_oobsize", nand->oobsize);
 303         setenv_hex("nand_erasesize", nand->erasesize);
 304 }
 305
 306 static int raw_access(nand_info_t *nand, ulong addr, loff_t off, ulong count,
 307                         int read)
 308 {
 309         int ret = 0;
 310
 311         while (count--) {
 312                 /* Raw access */
 313                 mtd_oob_ops_t ops = {
 314                         .datbuf = (u8 *)addr,
 315                         .oobbuf = ((u8 *)addr) + nand->writesize,
 316                         .len = nand->writesize,
 317                         .ooblen = nand->oobsize,
 318                         .mode = MTD_OPS_RAW
 319                 };
 320
 321                 if (read) {
 322                         ret = mtd_read_oob(nand, off, &ops);
 323                 } else {
 324                         ret = mtd_write_oob(nand, off, &ops);
 325                         if (!ret)
 326                                 ret = nand_verify_page_oob(nand, &ops, off);
 327                 }
 328
 329                 if (ret) {
 330                         printf("%s: error at offset %llx, ret %d\n",
 331                                 __func__, (long long)off, ret);
 332                         break;
 333                 }
 334
 335                 addr += nand->writesize + nand->oobsize;
 336                 off += nand->writesize;
 337         }
 338
 339         return ret;
 340 }
 341
 342 /* Adjust a chip/partition size down for bad blocks so we don't
 343  * read/write past the end of a chip/partition by accident.
 344  */
 345 static void adjust_size_for_badblocks(loff_t *size, loff_t offset, int dev)
 346 {
 347         /* We grab the nand info object here fresh because this is usually
 348          * called after arg_off_size() which can change the value of dev.
 349          */
 350         nand_info_t *nand = &nand_info[dev];
 351         loff_t maxoffset = offset + *size;
 352         int badblocks = 0;
 353
 354         /* count badblocks in NAND from offset to offset + size */
 355         for (; offset < maxoffset; offset += nand->erasesize) {
 356                 if (nand_block_isbad(nand, offset))
 357                         badblocks++;
 358         }
 359         /* adjust size if any bad blocks found */
 360         if (badblocks) {
 361                 *size -= badblocks * nand->erasesize;
 362                 printf("size adjusted to 0x%llx (%d bad blocks)\n",
 363                        (unsigned long long)*size, badblocks);
 364         }
 365 }
 366
 367 static int do_nand(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 368 {
 369         int i, ret = 0;
 370         ulong addr;
 371         loff_t off, size, maxsize;
 372         char *cmd, *s;
 373         nand_info_t *nand;
 374 #ifdef CONFIG_SYS_NAND_QUIET
 375         int quiet = CONFIG_SYS_NAND_QUIET;
 376 #else
 377         int quiet = 0;
 378 #endif
 379         const char *quiet_str = getenv("quiet");
 380         int dev = nand_curr_device;
 381         int repeat = flag & CMD_FLAG_REPEAT;
 382
 383         /* at least two arguments please */
 384         if (argc < 2)
 385                 goto usage;
 386
 387         if (quiet_str)
 388                 quiet = simple_strtoul(quiet_str, NULL, 0) != 0;
 389
 390         cmd = argv[1];
 391
 392         /* Only "dump" is repeatable. */
 393         if (repeat && strcmp(cmd, "dump"))
 394                 return CMD_RET_FAILURE;
 395
 396         if (strcmp(cmd, "info") == 0) {
 397
 398                 putc('\n');
 399                 for (i = 0; i < CONFIG_SYS_MAX_NAND_DEVICE; i++) {
 400                         if (nand_info[i].name)
 401                                 nand_print_and_set_info(i);
 402                 }
 403                 return CMD_RET_SUCCESS;
 404         }
 405
 406         if (strcmp(cmd, "device") == 0) {
 407                 if (argc < 3) {
 408                         putc('\n');
 409                         if (dev < 0 || dev >= CONFIG_SYS_MAX_NAND_DEVICE)
 410                                 puts("no devices available\n");
 411                         else
 412                                 nand_print_and_set_info(dev);
 413                         return CMD_RET_SUCCESS;
 414                 }
 415
 416                 dev = (int)simple_strtoul(argv[2], NULL, 10);
 417                 set_dev(dev);
 418
 419                 return CMD_RET_SUCCESS;
 420         }
 421
 422 #ifdef CONFIG_ENV_OFFSET_OOB
 423         /* this command operates only on the first nand device */
 424         if (strcmp(cmd, "env.oob") == 0)
 425                 return do_nand_env_oob(cmdtp, argc - 1, argv + 1) ?
 426                         CMD_RET_FAILURE : CMD_RET_SUCCESS;;
 427 #endif
 428
 429         /* The following commands operate on the current device, unless
 430          * overridden by a partition specifier.  Note that if somehow the
 431          * current device is invalid, it will have to be changed to a valid
 432          * one before these commands can run, even if a partition specifier
 433          * for another device is to be used.
 434          */
 435         if (dev < 0 || dev >= CONFIG_SYS_MAX_NAND_DEVICE ||
 436             !nand_info[dev].name) {
 437                 puts("\nno devices available\n");
 438                 return CMD_RET_FAILURE;
 439         }
 440         nand = &nand_info[dev];
 441
 442         if (strcmp(cmd, "bad") == 0) {
 443                 printf("\nDevice %d bad blocks:\n", dev);
 444                 for (off = 0; off < nand->size; off += nand->erasesize)
 445                         if (nand_block_isbad(nand, off))
 446                                 printf("  %08llx\n", (unsigned long long)off);
 447                 return CMD_RET_SUCCESS;
 448         }
 449
 450         /*
 451          * Syntax is:
 452          *   0    1     2       3    4
 453          *   nand erase [clean] [off size]
 454          */
 455         if (strncmp(cmd, "erase", 5) == 0 || strncmp(cmd, "scrub", 5) == 0) {
 456                 nand_erase_options_t opts;
 457                 /* "clean" at index 2 means request to write cleanmarker */
 458                 int clean = argc > 2 && !strcmp("clean", argv[2]);
 459                 int scrub_yes = argc > 2 && !strcmp("-y", argv[2]);
 460                 int o = (clean || scrub_yes) ? 3 : 2;
 461                 int scrub = !strncmp(cmd, "scrub", 5);
 462                 int spread = 0;
 463                 int args = 2;
 464                 const char *scrub_warn =
 465                         "Warning: "
 466                         "scrub option will erase all factory set bad blocks!\n"
 467                         "         "
 468                         "There is no reliable way to recover them.\n"
 469                         "         "
 470                         "Use this command only for testing purposes if you\n"
 471                         "         "
 472                         "are sure of what you are doing!\n"
 473                         "\nReally scrub this NAND flash? <y/N>\n";
 474
 475                 if (cmd[5] != 0) {
 476                         if (!strcmp(&cmd[5], ".spread")) {
 477                                 spread = 1;
 478                         } else if (!strcmp(&cmd[5], ".part")) {
 479                                 args = 1;
 480                         } else if (!strcmp(&cmd[5], ".chip")) {
 481                                 args = 0;
 482                         } else {
 483                                 goto usage;
 484                         }
 485                 }
 486
 487                 /*
 488                  * Don't allow missing arguments to cause full chip/partition
 489                  * erases -- easy to do accidentally, e.g. with a misspelled
 490                  * variable name.
 491                  */
 492                 if (argc != o + args)
 493                         goto usage;
 494
 495                 printf("\nNAND %s: ", cmd);
 496                 /* skip first two or three arguments, look for offset and size */
 497                 if (mtd_arg_off_size(argc - o, argv + o, &dev, &off, &size,
 498                                      &maxsize, MTD_DEV_TYPE_NAND,
 499                                      nand_info[dev].size) != 0)
 500                         return CMD_RET_FAILURE;
 501
 502                 if (set_dev(dev))
 503                         return CMD_RET_FAILURE;
 504
 505                 nand = &nand_info[dev];
 506
 507                 memset(&opts, 0, sizeof(opts));
 508                 opts.offset = off;
 509                 opts.length = size;
 510                 opts.jffs2  = clean;
 511                 opts.quiet  = quiet;
 512                 opts.spread = spread;
 513
 514                 if (scrub) {
 515                         if (scrub_yes) {
 516                                 opts.scrub = 1;
 517                         } else {
 518                                 puts(scrub_warn);
 519                                 if (confirm_yesno()) {
 520                                         opts.scrub = 1;
 521                                 } else {
 522                                         puts("scrub aborted\n");
 523                                         return CMD_RET_FAILURE;
 524                                 }
 525                         }
 526                 }
 527                 ret = nand_erase_opts(nand, &opts);
 528                 printf("%s\n", ret ? "ERROR" : "OK");
 529
 530                 return ret == 0 ? CMD_RET_SUCCESS : CMD_RET_FAILURE;
 531         }
 532
 533         if (strncmp(cmd, "dump", 4) == 0) {
 534                 if (argc < 3)
 535                         goto usage;
 536
 537                 off = (int)simple_strtoul(argv[2], NULL, 16);
 538                 ret = nand_dump(nand, off, !strcmp(&cmd[4], ".oob"), repeat);
 539
 540                 return ret == 0 ? CMD_RET_SUCCESS : CMD_RET_FAILURE;
 541         }
 542
 543         if (strncmp(cmd, "read", 4) == 0 || strncmp(cmd, "write", 5) == 0) {
 544                 size_t rwsize;
 545                 ulong pagecount = 1;
 546                 int read;
 547                 int raw = 0;
 548
 549                 if (argc < 4)
 550                         goto usage;
 551
 552                 addr = (ulong)simple_strtoul(argv[2], NULL, 16);
 553
 554                 read = strncmp(cmd, "read", 4) == 0; /* 1 = read, 0 = write */
 555                 printf("\nNAND %s: ", read ? "read" : "write");
 556
 557                 s = strchr(cmd, '.');
 558
 559                 if (s && !strcmp(s, ".raw")) {
 560                         raw = 1;
 561
 562                         if (mtd_arg_off(argv[3], &dev, &off, &size, &maxsize,
 563                                         MTD_DEV_TYPE_NAND,
 564                                         nand_info[dev].size))
 565                                 return CMD_RET_FAILURE;
 566
 567                         if (set_dev(dev))
 568                                 return CMD_RET_FAILURE;
 569
 570                         nand = &nand_info[dev];
 571
 572                         if (argc > 4 && !str2long(argv[4], &pagecount)) {
 573                                 printf("'%s' is not a number\n", argv[4]);
 574                                 return CMD_RET_FAILURE;
 575                         }
 576
 577                         if (pagecount * nand->writesize > size) {
 578                                 puts("Size exceeds partition or device limit\n");
 579                                 return CMD_RET_FAILURE;
 580                         }
 581
 582                         rwsize = pagecount * (nand->writesize + nand->oobsize);
 583                 } else {
 584                         if (mtd_arg_off_size(argc - 3, argv + 3, &dev, &off,
 585                                              &size, &maxsize,
 586                                              MTD_DEV_TYPE_NAND,
 587                                              nand_info[dev].size) != 0)
 588                                 return CMD_RET_FAILURE;
 589
 590                         if (set_dev(dev))
 591                                 return CMD_RET_FAILURE;
 592
 593                         /* size is unspecified */
 594                         if (argc < 5)
 595                                 adjust_size_for_badblocks(&size, off, dev);
 596                         rwsize = size;
 597                 }
 598
 599                 nand = &nand_info[dev];
 600
 601                 if (!s || !strcmp(s, ".jffs2") ||
 602                     !strcmp(s, ".e") || !strcmp(s, ".i")) {
 603                         if (read)
 604                                 ret = nand_read_skip_bad(nand, off, &rwsize,
 605                                                          NULL, maxsize,
 606                                                          (u_char *)addr);
 607                         else
 608                                 ret = nand_write_skip_bad(nand, off, &rwsize,
 609                                                           NULL, maxsize,
 610                                                           (u_char *)addr,
 611                                                           WITH_WR_VERIFY);
 612 #ifdef CONFIG_CMD_NAND_TRIMFFS
 613                 } else if (!strcmp(s, ".trimffs")) {
 614                         if (read) {
 615                                 printf("Unknown nand command suffix '%s'\n", s);
 616                                 return CMD_RET_FAILURE;
 617                         }
 618                         ret = nand_write_skip_bad(nand, off, &rwsize, NULL,
 619                                                 maxsize, (u_char *)addr,
 620                                                 WITH_DROP_FFS | WITH_WR_VERIFY);
 621 #endif
 622                 } else if (!strcmp(s, ".oob")) {
 623                         /* out-of-band data */
 624                         mtd_oob_ops_t ops = {
 625                                 .oobbuf = (u8 *)addr,
 626                                 .ooblen = rwsize,
 627                                 .mode = MTD_OPS_RAW
 628                         };
 629
 630                         if (read)
 631                                 ret = mtd_read_oob(nand, off, &ops);
 632                         else
 633                                 ret = mtd_write_oob(nand, off, &ops);
 634                 } else if (raw) {
 635                         ret = raw_access(nand, addr, off, pagecount, read);
 636                 } else {
 637                         printf("Unknown nand command suffix '%s'.\n", s);
 638                         return CMD_RET_FAILURE;
 639                 }
 640
 641                 printf(" %zu bytes %s: %s\n", rwsize,
 642                        read ? "read" : "written", ret ? "ERROR" : "OK");
 643
 644                 return ret == 0 ? CMD_RET_SUCCESS : CMD_RET_FAILURE;
 645         }
 646
 647 #ifdef CONFIG_CMD_NAND_TORTURE
 648         if (strcmp(cmd, "torture") == 0) {
 649                 if (argc < 3)
 650                         goto usage;
 651
 652                 if (!str2off(argv[2], &off)) {
 653                         puts("Offset is not a valid number\n");
 654                         return CMD_RET_FAILURE;
 655                 }
 656
 657                 printf("\nNAND torture: device %d offset 0x%llx size 0x%x\n",
 658                         dev, off, nand->erasesize);
 659                 ret = nand_torture(nand, off);
 660                 printf(" %s\n", ret ? "Failed" : "Passed");
 661
 662                 return ret == 0 ? CMD_RET_SUCCESS : CMD_RET_FAILURE;
 663         }
 664 #endif
 665
 666         if (strcmp(cmd, "markbad") == 0) {
 667                 argc -= 2;
 668                 argv += 2;
 669
 670                 if (argc <= 0)
 671                         goto usage;
 672
 673                 while (argc > 0) {
 674                         addr = simple_strtoul(*argv, NULL, 16);
 675
 676                         if (mtd_block_markbad(nand, addr)) {
 677                                 printf("block 0x%08lx NOT marked "
 678                                         "as bad! ERROR %d\n",
 679                                         addr, ret);
 680                                 ret = 1;
 681                         } else {
 682                                 printf("block 0x%08lx successfully "
 683                                         "marked as bad\n",
 684                                         addr);
 685                         }
 686                         --argc;
 687                         ++argv;
 688                 }
 689                 return ret == 0 ? CMD_RET_SUCCESS : CMD_RET_FAILURE;
 690         }
 691
 692         if (strcmp(cmd, "biterr") == 0) {
 693                 /* todo */
 694                 return CMD_RET_FAILURE;
 695         }
 696
 697 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
 698         if (strcmp(cmd, "lock") == 0) {
 699                 int tight = 0;
 700                 int status = 0;
 701                 if (argc == 3) {
 702                         if (!strcmp("tight", argv[2]))
 703                                 tight = 1;
 704                         if (!strcmp("status", argv[2]))
 705                                 status = 1;
 706                 }
 707                 if (status) {
 708                         do_nand_status(nand);
 709                 } else {
 710                         if (!nand_lock(nand, tight)) {
 711                                 puts("NAND flash successfully locked\n");
 712                         } else {
 713                                 puts("Error locking NAND flash\n");
 714                                 return CMD_RET_FAILURE;
 715                         }
 716                 }
 717                 return CMD_RET_SUCCESS;
 718         }
 719
 720         if (strncmp(cmd, "unlock", 5) == 0) {
 721                 int allexcept = 0;
 722
 723                 s = strchr(cmd, '.');
 724
 725                 if (s && !strcmp(s, ".allexcept"))
 726                         allexcept = 1;
 727
 728                 if (mtd_arg_off_size(argc - 2, argv + 2, &dev, &off, &size,
 729                                      &maxsize, MTD_DEV_TYPE_NAND,
 730                                      nand_info[dev].size) < 0)
 731                         return CMD_RET_FAILURE;
 732
 733                 if (set_dev(dev))
 734                         return CMD_RET_FAILURE;
 735
 736                 if (!nand_unlock(&nand_info[dev], off, size, allexcept)) {
 737                         puts("NAND flash successfully unlocked\n");
 738                 } else {
 739                         puts("Error unlocking NAND flash, "
 740                              "write and erase will probably fail\n");
 741                         return CMD_RET_FAILURE;
 742                 }
 743                 return CMD_RET_SUCCESS;
 744         }
 745 #endif
 746
 747 usage:
 748         return CMD_RET_USAGE;
 749 }
 750
 751 #ifdef CONFIG_SYS_LONGHELP
 752 static char nand_help_text[] =
 753         "info - show available NAND devices\n"
 754         "nand device [dev] - show or set current device\n"
 755         "nand read - addr off|partition size\n"
 756         "nand write - addr off|partition size\n"
 757         "    read/write 'size' bytes starting at offset 'off'\n"
 758         "    to/from memory address 'addr', skipping bad blocks.\n"
 759         "nand read.raw - addr off|partition [count]\n"
 760         "nand write.raw - addr off|partition [count]\n"
 761         "    Use read.raw/write.raw to avoid ECC and access the flash as-is.\n"
 762 #ifdef CONFIG_CMD_NAND_TRIMFFS
 763         "nand write.trimffs - addr off|partition size\n"
 764         "    write 'size' bytes starting at offset 'off' from memory address\n"
 765         "    'addr', skipping bad blocks and dropping any pages at the end\n"
 766         "    of eraseblocks that contain only 0xFF\n"
 767 #endif
 768         "nand erase[.spread] [clean] off size - erase 'size' bytes "
 769         "from offset 'off'\n"
 770         "    With '.spread', erase enough for given file size, otherwise,\n"
 771         "    'size' includes skipped bad blocks.\n"
 772         "nand erase.part [clean] partition - erase entire mtd partition'\n"
 773         "nand erase.chip [clean] - erase entire chip'\n"
 774         "nand bad - show bad blocks\n"
 775         "nand dump[.oob] off - dump page\n"
 776 #ifdef CONFIG_CMD_NAND_TORTURE
 777         "nand torture off - torture block at offset\n"
 778 #endif
 779         "nand scrub [-y] off size | scrub.part partition | scrub.chip\n"
 780         "    really clean NAND erasing bad blocks (UNSAFE)\n"
 781         "nand markbad off [...] - mark bad block(s) at offset (UNSAFE)\n"
 782         "nand biterr off - make a bit error at offset (UNSAFE)"
 783 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
 784         "\n"
 785         "nand lock [tight] [status]\n"
 786         "    bring nand to lock state or display locked pages\n"
 787         "nand unlock[.allexcept] [offset] [size] - unlock section"
 788 #endif
 789 #ifdef CONFIG_ENV_OFFSET_OOB
 790         "\n"
 791         "nand env.oob - environment offset in OOB of block 0 of"
 792         "    first device.\n"
 793         "nand env.oob set off|partition - set enviromnent offset\n"
 794         "nand env.oob get - get environment offset"
 795 #endif
 796         "";
 797 #endif
 798
 799 U_BOOT_CMD(
 800         nand, CONFIG_SYS_MAXARGS, 1, do_nand,
 801         "NAND sub-system", nand_help_text
 802 );
 803
 804 static int nand_load_image(cmd_tbl_t *cmdtp, nand_info_t *nand,
 805                            ulong offset, ulong addr, char *cmd)
 806 {
 807         int r;
 808         char *s;
 809         size_t cnt;
 810 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
 811         image_header_t *hdr;
 812 #endif
 813 #if defined(CONFIG_FIT)
 814         const void *fit_hdr = NULL;
 815 #endif
 816
 817         s = strchr(cmd, '.');
 818         if (s != NULL &&
 819             (strcmp(s, ".jffs2") && strcmp(s, ".e") && strcmp(s, ".i"))) {
 820                 printf("Unknown nand load suffix '%s'\n", s);
 821                 bootstage_error(BOOTSTAGE_ID_NAND_SUFFIX);
 822                 return CMD_RET_FAILURE;
 823         }
 824
 825         printf("\nLoading from %s, offset 0x%lx\n", nand->name, offset);
 826
 827         cnt = nand->writesize;
 828         r = nand_read_skip_bad(nand, offset, &cnt, NULL, nand->size,
 829                         (u_char *)addr);
 830         if (r) {
 831                 puts("** Read error\n");
 832                 bootstage_error(BOOTSTAGE_ID_NAND_HDR_READ);
 833                 return CMD_RET_FAILURE;
 834         }
 835         bootstage_mark(BOOTSTAGE_ID_NAND_HDR_READ);
 836
 837         switch (genimg_get_format ((void *)addr)) {
 838 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
 839         case IMAGE_FORMAT_LEGACY:
 840                 hdr = (image_header_t *)addr;
 841
 842                 bootstage_mark(BOOTSTAGE_ID_NAND_TYPE);
 843                 image_print_contents (hdr);
 844
 845                 cnt = image_get_image_size (hdr);
 846                 break;
 847 #endif
 848 #if defined(CONFIG_FIT)
 849         case IMAGE_FORMAT_FIT:
 850                 fit_hdr = (const void *)addr;
 851                 puts ("Fit image detected...\n");
 852
 853                 cnt = fit_get_size (fit_hdr);
 854                 break;
 855 #endif
 856         default:
 857                 bootstage_error(BOOTSTAGE_ID_NAND_TYPE);
 858                 puts ("** Unknown image type\n");
 859                 return CMD_RET_FAILURE;
 860         }
 861         bootstage_mark(BOOTSTAGE_ID_NAND_TYPE);
 862
 863         r = nand_read_skip_bad(nand, offset, &cnt, NULL, nand->size,
 864                         (u_char *)addr);
 865         if (r) {
 866                 puts("** Read error\n");
 867                 bootstage_error(BOOTSTAGE_ID_NAND_READ);
 868                 return CMD_RET_FAILURE;
 869         }
 870         bootstage_mark(BOOTSTAGE_ID_NAND_READ);
 871
 872 #if defined(CONFIG_FIT)
 873         /* This cannot be done earlier, we need complete FIT image in RAM first */
 874         if (genimg_get_format ((void *)addr) == IMAGE_FORMAT_FIT) {
 875                 if (!fit_check_format (fit_hdr)) {
 876                         bootstage_error(BOOTSTAGE_ID_NAND_FIT_READ);
 877                         puts ("** Bad FIT image format\n");
 878                         return CMD_RET_FAILURE;
 879                 }
 880                 bootstage_mark(BOOTSTAGE_ID_NAND_FIT_READ_OK);
 881                 fit_print_contents (fit_hdr);
 882         }
 883 #endif
 884
 885         /* Loading ok, update default load address */
 886
 887         load_addr = addr;
 888
 889         if (bootm_maybe_autostart(cmdtp, cmd))
 890                 return CMD_RET_FAILURE;
 891
 892         return CMD_RET_SUCCESS;
 893 }
 894
 895 static int do_nandboot(cmd_tbl_t *cmdtp, int flag, int argc,
 896                        char * const argv[])
 897 {
 898         char *boot_device = NULL;
 899         int idx;
 900         ulong addr, offset = 0;
 901 #if defined(CONFIG_CMD_MTDPARTS)
 902         struct mtd_device *dev;
 903         struct part_info *part;
 904         u8 pnum;
 905
 906         if (argc >= 2) {
 907                 char *p = (argc == 2) ? argv[1] : argv[2];
 908                 if (!(str2long(p, &addr)) && (mtdparts_init() == 0) &&
 909                     (find_dev_and_part(p, &dev, &pnum, &part) == 0)) {
 910                         if (dev->id->type != MTD_DEV_TYPE_NAND) {
 911                                 puts("Not a NAND device\n");
 912                                 return CMD_RET_FAILURE;
 913                         }
 914                         if (argc > 3)
 915                                 goto usage;
 916                         if (argc == 3)
 917                                 addr = simple_strtoul(argv[1], NULL, 16);
 918                         else
 919                                 addr = CONFIG_SYS_LOAD_ADDR;
 920                         return nand_load_image(cmdtp, &nand_info[dev->id->num],
 921                                                part->offset, addr, argv[0]);
 922                 }
 923         }
 924 #endif
 925
 926         bootstage_mark(BOOTSTAGE_ID_NAND_PART);
 927         switch (argc) {
 928         case 1:
 929                 addr = CONFIG_SYS_LOAD_ADDR;
 930                 boot_device = getenv("bootdevice");
 931                 break;
 932         case 2:
 933                 addr = simple_strtoul(argv[1], NULL, 16);
 934                 boot_device = getenv("bootdevice");
 935                 break;
 936         case 3:
 937                 addr = simple_strtoul(argv[1], NULL, 16);
 938                 boot_device = argv[2];
 939                 break;
 940         case 4:
 941                 addr = simple_strtoul(argv[1], NULL, 16);
 942                 boot_device = argv[2];
 943                 offset = simple_strtoul(argv[3], NULL, 16);
 944                 break;
 945         default:
 946 #if defined(CONFIG_CMD_MTDPARTS)
 947 usage:
 948 #endif
 949                 bootstage_error(BOOTSTAGE_ID_NAND_SUFFIX);
 950                 return CMD_RET_USAGE;
 951         }
 952         bootstage_mark(BOOTSTAGE_ID_NAND_SUFFIX);
 953
 954         if (!boot_device) {
 955                 puts("\n** No boot device **\n");
 956                 bootstage_error(BOOTSTAGE_ID_NAND_BOOT_DEVICE);
 957                 return CMD_RET_FAILURE;
 958         }
 959         bootstage_mark(BOOTSTAGE_ID_NAND_BOOT_DEVICE);
 960
 961         idx = simple_strtoul(boot_device, NULL, 16);
 962
 963         if (idx < 0 || idx >= CONFIG_SYS_MAX_NAND_DEVICE || !nand_info[idx].name) {
 964                 printf("\n** Device %d not available\n", idx);
 965                 bootstage_error(BOOTSTAGE_ID_NAND_AVAILABLE);
 966                 return CMD_RET_FAILURE;
 967         }
 968         bootstage_mark(BOOTSTAGE_ID_NAND_AVAILABLE);
 969
 970         return nand_load_image(cmdtp, &nand_info[idx], offset, addr, argv[0]);
 971 }
 972
 973 U_BOOT_CMD(nboot, 4, 1, do_nandboot,
 974         "boot from NAND device",
 975         "[partition] | [[[loadAddr] dev] offset]"
 976 );