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