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