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 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 int do_nand(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
 394 {
 395         int i, ret = 0;
 396         ulong addr;
 397         loff_t off, size;
 398         char *cmd, *s;
 399         nand_info_t *nand;
 400 #ifdef CONFIG_SYS_NAND_QUIET
 401         int quiet = CONFIG_SYS_NAND_QUIET;
 402 #else
 403         int quiet = 0;
 404 #endif
 405         const char *quiet_str = getenv("quiet");
 406         int dev = nand_curr_device;
 407         int repeat = flag & CMD_FLAG_REPEAT;
 408
 409         /* at least two arguments please */
 410         if (argc < 2)
 411                 goto usage;
 412
 413         if (quiet_str)
 414                 quiet = simple_strtoul(quiet_str, NULL, 0) != 0;
 415
 416         cmd = argv[1];
 417
 418         /* Only "dump" is repeatable. */
 419         if (repeat && strcmp(cmd, "dump"))
 420                 return CMD_RET_FAILURE;
 421
 422         if (strcmp(cmd, "info") == 0) {
 423
 424                 putc('\n');
 425                 for (i = 0; i < CONFIG_SYS_MAX_NAND_DEVICE; i++) {
 426                         if (nand_info[i].name)
 427                                 nand_print_and_set_info(i);
 428                 }
 429                 return CMD_RET_SUCCESS;
 430         }
 431
 432         if (strcmp(cmd, "device") == 0) {
 433                 if (argc < 3) {
 434                         putc('\n');
 435                         if (dev < 0 || dev >= CONFIG_SYS_MAX_NAND_DEVICE)
 436                                 puts("no devices available\n");
 437                         else
 438                                 nand_print_and_set_info(dev);
 439                         return CMD_RET_SUCCESS;
 440                 }
 441
 442                 dev = (int)simple_strtoul(argv[2], NULL, 10);
 443                 set_dev(dev);
 444
 445                 return CMD_RET_SUCCESS;
 446         }
 447
 448 #ifdef CONFIG_ENV_OFFSET_OOB
 449         /* this command operates only on the first nand device */
 450         if (strcmp(cmd, "env.oob") == 0)
 451                 return do_nand_env_oob(cmdtp, argc - 1, argv + 1) ?
 452                         CMD_RET_FAILURE : CMD_RET_SUCCESS;;
 453 #endif
 454
 455         /* The following commands operate on the current device, unless
 456          * overridden by a partition specifier.  Note that if somehow the
 457          * current device is invalid, it will have to be changed to a valid
 458          * one before these commands can run, even if a partition specifier
 459          * for another device is to be used.
 460          */
 461         if (dev < 0 || dev >= CONFIG_SYS_MAX_NAND_DEVICE ||
 462             !nand_info[dev].name) {
 463                 puts("\nno devices available\n");
 464                 return CMD_RET_FAILURE;
 465         }
 466         nand = &nand_info[dev];
 467
 468         if (strcmp(cmd, "bad") == 0) {
 469                 printf("\nDevice %d bad blocks:\n", dev);
 470                 for (off = 0; off < nand->size; off += nand->erasesize)
 471                         if (nand_block_isbad(nand, off))
 472                                 printf("  %08llx\n", (unsigned long long)off);
 473                 return CMD_RET_SUCCESS;
 474         }
 475
 476         /*
 477          * Syntax is:
 478          *   0    1     2       3    4
 479          *   nand erase [clean] [off size]
 480          */
 481         if (strncmp(cmd, "erase", 5) == 0 || strncmp(cmd, "scrub", 5) == 0) {
 482                 nand_erase_options_t opts;
 483                 /* "clean" at index 2 means request to write cleanmarker */
 484                 int clean = argc > 2 && !strcmp("clean", argv[2]);
 485                 int scrub_yes = argc > 2 && !strcmp("-y", argv[2]);
 486                 int o = (clean || scrub_yes) ? 3 : 2;
 487                 int scrub = !strncmp(cmd, "scrub", 5);
 488                 int spread = 0;
 489                 int args = 2;
 490                 const char *scrub_warn =
 491                         "Warning: "
 492                         "scrub option will erase all factory set bad blocks!\n"
 493                         "         "
 494                         "There is no reliable way to recover them.\n"
 495                         "         "
 496                         "Use this command only for testing purposes if you\n"
 497                         "         "
 498                         "are sure of what you are doing!\n"
 499                         "\nReally scrub this NAND flash? <y/N>\n";
 500
 501                 if (cmd[5] != 0) {
 502                         if (!strcmp(&cmd[5], ".spread")) {
 503                                 spread = 1;
 504                         } else if (!strcmp(&cmd[5], ".part")) {
 505                                 args = 1;
 506                         } else if (!strcmp(&cmd[5], ".chip")) {
 507                                 args = 0;
 508                         } else {
 509                                 goto usage;
 510                         }
 511                 }
 512
 513                 /*
 514                  * Don't allow missing arguments to cause full chip/partition
 515                  * erases -- easy to do accidentally, e.g. with a misspelled
 516                  * variable name.
 517                  */
 518                 if (argc != o + args)
 519                         goto usage;
 520
 521                 printf("\nNAND %s: ", cmd);
 522                 /* skip first two or three arguments, look for offset and size */
 523                 if (arg_off_size(argc - o, argv + o, &dev, &off, &size) != 0)
 524                         return CMD_RET_FAILURE;
 525
 526                 nand = &nand_info[dev];
 527
 528                 memset(&opts, 0, sizeof(opts));
 529                 opts.offset = off;
 530                 opts.length = size;
 531                 opts.jffs2  = clean;
 532                 opts.quiet  = quiet;
 533                 opts.spread = spread;
 534
 535                 if (scrub) {
 536                         if (!scrub_yes)
 537                                 puts(scrub_warn);
 538
 539                         if (scrub_yes)
 540                                 opts.scrub = 1;
 541                         else if (getc() == 'y') {
 542                                 puts("y");
 543                                 if (getc() == '\r')
 544                                         opts.scrub = 1;
 545                                 else {
 546                                         puts("scrub aborted\n");
 547                                         return CMD_RET_FAILURE;
 548                                 }
 549                         } else {
 550                                 puts("scrub aborted\n");
 551                                 return CMD_RET_FAILURE;
 552                         }
 553                 }
 554                 ret = nand_erase_opts(nand, &opts);
 555                 printf("%s\n", ret ? "ERROR" : "OK");
 556
 557                 return ret == 0 ? CMD_RET_SUCCESS : CMD_RET_FAILURE;
 558         }
 559
 560         if (strncmp(cmd, "dump", 4) == 0) {
 561                 if (argc < 3)
 562                         goto usage;
 563
 564                 off = (int)simple_strtoul(argv[2], NULL, 16);
 565                 ret = nand_dump(nand, off, !strcmp(&cmd[4], ".oob"), repeat);
 566
 567                 return ret == 0 ? CMD_RET_SUCCESS : CMD_RET_FAILURE;
 568         }
 569
 570         if (strncmp(cmd, "read", 4) == 0 || strncmp(cmd, "write", 5) == 0) {
 571                 size_t rwsize;
 572                 int read;
 573
 574                 if (argc < 4)
 575                         goto usage;
 576
 577                 addr = (ulong)simple_strtoul(argv[2], NULL, 16);
 578
 579                 read = strncmp(cmd, "read", 4) == 0; /* 1 = read, 0 = write */
 580                 printf("\nNAND %s: ", read ? "read" : "write");
 581                 if (arg_off_size(argc - 3, argv + 3, &dev, &off, &size) != 0)
 582                         return CMD_RET_FAILURE;
 583
 584                 nand = &nand_info[dev];
 585                 rwsize = size;
 586
 587                 s = strchr(cmd, '.');
 588                 if (!s || !strcmp(s, ".jffs2") ||
 589                     !strcmp(s, ".e") || !strcmp(s, ".i")) {
 590                         if (read)
 591                                 ret = nand_read_skip_bad(nand, off, &rwsize,
 592                                                          (u_char *)addr);
 593                         else
 594                                 ret = nand_write_skip_bad(nand, off, &rwsize,
 595                                                           (u_char *)addr, 0);
 596 #ifdef CONFIG_CMD_NAND_TRIMFFS
 597                 } else if (!strcmp(s, ".trimffs")) {
 598                         if (read) {
 599                                 printf("Unknown nand command suffix '%s'\n", s);
 600                                 return CMD_RET_FAILURE;
 601                         }
 602                         ret = nand_write_skip_bad(nand, off, &rwsize,
 603                                                 (u_char *)addr,
 604                                                 WITH_DROP_FFS);
 605 #endif
 606 #ifdef CONFIG_CMD_NAND_YAFFS
 607                 } else if (!strcmp(s, ".yaffs")) {
 608                         if (read) {
 609                                 printf("Unknown nand command suffix '%s'.\n", s);
 610                                 return CMD_RET_FAILURE;
 611                         }
 612                         ret = nand_write_skip_bad(nand, off, &rwsize,
 613                                                 (u_char *)addr, WITH_YAFFS_OOB);
 614 #endif
 615                 } else if (!strcmp(s, ".oob")) {
 616                         /* out-of-band data */
 617                         mtd_oob_ops_t ops = {
 618                                 .oobbuf = (u8 *)addr,
 619                                 .ooblen = rwsize,
 620                                 .mode = MTD_OOB_RAW
 621                         };
 622
 623                         if (read)
 624                                 ret = nand->read_oob(nand, off, &ops);
 625                         else
 626                                 ret = nand->write_oob(nand, off, &ops);
 627                 } else if (!strcmp(s, ".raw")) {
 628                         /* Raw access */
 629                         mtd_oob_ops_t ops = {
 630                                 .datbuf = (u8 *)addr,
 631                                 .oobbuf = ((u8 *)addr) + nand->writesize,
 632                                 .len = nand->writesize,
 633                                 .ooblen = nand->oobsize,
 634                                 .mode = MTD_OOB_RAW
 635                         };
 636
 637                         rwsize = nand->writesize + nand->oobsize;
 638
 639                         if (read)
 640                                 ret = nand->read_oob(nand, off, &ops);
 641                         else
 642                                 ret = nand->write_oob(nand, off, &ops);
 643                 } else {
 644                         printf("Unknown nand command suffix '%s'.\n", s);
 645                         return CMD_RET_FAILURE;
 646                 }
 647
 648                 printf(" %zu bytes %s: %s\n", rwsize,
 649                        read ? "read" : "written", ret ? "ERROR" : "OK");
 650
 651                 return ret == 0 ? CMD_RET_SUCCESS : CMD_RET_FAILURE;
 652         }
 653
 654         if (strcmp(cmd, "markbad") == 0) {
 655                 argc -= 2;
 656                 argv += 2;
 657
 658                 if (argc <= 0)
 659                         goto usage;
 660
 661                 while (argc > 0) {
 662                         addr = simple_strtoul(*argv, NULL, 16);
 663
 664                         if (nand->block_markbad(nand, addr)) {
 665                                 printf("block 0x%08lx NOT marked "
 666                                         "as bad! ERROR %d\n",
 667                                         addr, ret);
 668                                 ret = 1;
 669                         } else {
 670                                 printf("block 0x%08lx successfully "
 671                                         "marked as bad\n",
 672                                         addr);
 673                         }
 674                         --argc;
 675                         ++argv;
 676                 }
 677                 return ret == 0 ? CMD_RET_SUCCESS : CMD_RET_FAILURE;
 678         }
 679
 680         if (strcmp(cmd, "biterr") == 0) {
 681                 /* todo */
 682                 return CMD_RET_FAILURE;
 683         }
 684
 685 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
 686         if (strcmp(cmd, "lock") == 0) {
 687                 int tight = 0;
 688                 int status = 0;
 689                 if (argc == 3) {
 690                         if (!strcmp("tight", argv[2]))
 691                                 tight = 1;
 692                         if (!strcmp("status", argv[2]))
 693                                 status = 1;
 694                 }
 695                 if (status) {
 696                         do_nand_status(nand);
 697                 } else {
 698                         if (!nand_lock(nand, tight)) {
 699                                 puts("NAND flash successfully locked\n");
 700                         } else {
 701                                 puts("Error locking NAND flash\n");
 702                                 return CMD_RET_FAILURE;
 703                         }
 704                 }
 705                 return CMD_RET_SUCCESS;
 706         }
 707
 708         if (strcmp(cmd, "unlock") == 0) {
 709                 if (arg_off_size(argc - 2, argv + 2, &dev, &off, &size) < 0)
 710                         return CMD_RET_FAILURE;
 711
 712                 if (!nand_unlock(&nand_info[dev], off, size)) {
 713                         puts("NAND flash successfully unlocked\n");
 714                 } else {
 715                         puts("Error unlocking NAND flash, "
 716                              "write and erase will probably fail\n");
 717                         return CMD_RET_FAILURE;
 718                 }
 719                 return CMD_RET_SUCCESS;
 720         }
 721 #endif
 722
 723 usage:
 724         return CMD_RET_USAGE;
 725 }
 726
 727 U_BOOT_CMD(
 728         nand, CONFIG_SYS_MAXARGS, 1, do_nand,
 729         "NAND sub-system",
 730         "info - show available NAND devices\n"
 731         "nand device [dev] - show or set current device\n"
 732         "nand read - addr off|partition size\n"
 733         "nand write - addr off|partition size\n"
 734         "    read/write 'size' bytes starting at offset 'off'\n"
 735         "    to/from memory address 'addr', skipping bad blocks.\n"
 736         "nand read.raw - addr off|partition\n"
 737         "nand write.raw - addr off|partition\n"
 738         "    Use read.raw/write.raw to avoid ECC and access the page as-is.\n"
 739 #ifdef CONFIG_CMD_NAND_TRIMFFS
 740         "nand write.trimffs - addr off|partition size\n"
 741         "    write 'size' bytes starting at offset 'off' from memory address\n"
 742         "    'addr', skipping bad blocks and dropping any pages at the end\n"
 743         "    of eraseblocks that contain only 0xFF\n"
 744 #endif
 745 #ifdef CONFIG_CMD_NAND_YAFFS
 746         "nand write.yaffs - addr off|partition size\n"
 747         "    write 'size' bytes starting at offset 'off' with yaffs format\n"
 748         "    from memory address 'addr', skipping bad blocks.\n"
 749 #endif
 750         "nand erase[.spread] [clean] off size - erase 'size' bytes "
 751         "from offset 'off'\n"
 752         "    With '.spread', erase enough for given file size, otherwise,\n"
 753         "    'size' includes skipped bad blocks.\n"
 754         "nand erase.part [clean] partition - erase entire mtd partition'\n"
 755         "nand erase.chip [clean] - erase entire chip'\n"
 756         "nand bad - show bad blocks\n"
 757         "nand dump[.oob] off - dump page\n"
 758         "nand scrub [-y] off size | scrub.part partition | scrub.chip\n"
 759         "    really clean NAND erasing bad blocks (UNSAFE)\n"
 760         "nand markbad off [...] - mark bad block(s) at offset (UNSAFE)\n"
 761         "nand biterr off - make a bit error at offset (UNSAFE)"
 762 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
 763         "\n"
 764         "nand lock [tight] [status]\n"
 765         "    bring nand to lock state or display locked pages\n"
 766         "nand unlock [offset] [size] - unlock section"
 767 #endif
 768 #ifdef CONFIG_ENV_OFFSET_OOB
 769         "\n"
 770         "nand env.oob - environment offset in OOB of block 0 of"
 771         "    first device.\n"
 772         "nand env.oob set off|partition - set enviromnent offset\n"
 773         "nand env.oob get - get environment offset"
 774 #endif
 775 );
 776
 777 static int nand_load_image(cmd_tbl_t *cmdtp, nand_info_t *nand,
 778                            ulong offset, ulong addr, char *cmd)
 779 {
 780         int r;
 781         char *s;
 782         size_t cnt;
 783         image_header_t *hdr;
 784 #if defined(CONFIG_FIT)
 785         const void *fit_hdr = NULL;
 786 #endif
 787
 788         s = strchr(cmd, '.');
 789         if (s != NULL &&
 790             (strcmp(s, ".jffs2") && strcmp(s, ".e") && strcmp(s, ".i"))) {
 791                 printf("Unknown nand load suffix '%s'\n", s);
 792                 bootstage_error(BOOTSTAGE_ID_NAND_SUFFIX);
 793                 return 1;
 794         }
 795
 796         printf("\nLoading from %s, offset 0x%lx\n", nand->name, offset);
 797
 798         cnt = nand->writesize;
 799         r = nand_read_skip_bad(nand, offset, &cnt, (u_char *) addr);
 800         if (r) {
 801                 puts("** Read error\n");
 802                 bootstage_error(BOOTSTAGE_ID_NAND_HDR_READ);
 803                 return 1;
 804         }
 805         bootstage_mark(BOOTSTAGE_ID_NAND_HDR_READ);
 806
 807         switch (genimg_get_format ((void *)addr)) {
 808         case IMAGE_FORMAT_LEGACY:
 809                 hdr = (image_header_t *)addr;
 810
 811                 bootstage_mark(BOOTSTAGE_ID_NAND_TYPE);
 812                 image_print_contents (hdr);
 813
 814                 cnt = image_get_image_size (hdr);
 815                 break;
 816 #if defined(CONFIG_FIT)
 817         case IMAGE_FORMAT_FIT:
 818                 fit_hdr = (const void *)addr;
 819                 puts ("Fit image detected...\n");
 820
 821                 cnt = fit_get_size (fit_hdr);
 822                 break;
 823 #endif
 824         default:
 825                 bootstage_error(BOOTSTAGE_ID_NAND_TYPE);
 826                 puts ("** Unknown image type\n");
 827                 return 1;
 828         }
 829         bootstage_mark(BOOTSTAGE_ID_NAND_TYPE);
 830
 831         r = nand_read_skip_bad(nand, offset, &cnt, (u_char *) addr);
 832         if (r) {
 833                 puts("** Read error\n");
 834                 bootstage_error(BOOTSTAGE_ID_NAND_READ);
 835                 return 1;
 836         }
 837         bootstage_mark(BOOTSTAGE_ID_NAND_READ);
 838
 839 #if defined(CONFIG_FIT)
 840         /* This cannot be done earlier, we need complete FIT image in RAM first */
 841         if (genimg_get_format ((void *)addr) == IMAGE_FORMAT_FIT) {
 842                 if (!fit_check_format (fit_hdr)) {
 843                         bootstage_error(BOOTSTAGE_ID_NAND_FIT_READ);
 844                         puts ("** Bad FIT image format\n");
 845                         return 1;
 846                 }
 847                 bootstage_mark(BOOTSTAGE_ID_NAND_FIT_READ_OK);
 848                 fit_print_contents (fit_hdr);
 849         }
 850 #endif
 851
 852         /* Loading ok, update default load address */
 853
 854         load_addr = addr;
 855
 856         return bootm_maybe_autostart(cmdtp, cmd);
 857 }
 858
 859 int do_nandboot(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
 860 {
 861         char *boot_device = NULL;
 862         int idx;
 863         ulong addr, offset = 0;
 864 #if defined(CONFIG_CMD_MTDPARTS)
 865         struct mtd_device *dev;
 866         struct part_info *part;
 867         u8 pnum;
 868
 869         if (argc >= 2) {
 870                 char *p = (argc == 2) ? argv[1] : argv[2];
 871                 if (!(str2long(p, &addr)) && (mtdparts_init() == 0) &&
 872                     (find_dev_and_part(p, &dev, &pnum, &part) == 0)) {
 873                         if (dev->id->type != MTD_DEV_TYPE_NAND) {
 874                                 puts("Not a NAND device\n");
 875                                 return 1;
 876                         }
 877                         if (argc > 3)
 878                                 goto usage;
 879                         if (argc == 3)
 880                                 addr = simple_strtoul(argv[1], NULL, 16);
 881                         else
 882                                 addr = CONFIG_SYS_LOAD_ADDR;
 883                         return nand_load_image(cmdtp, &nand_info[dev->id->num],
 884                                                part->offset, addr, argv[0]);
 885                 }
 886         }
 887 #endif
 888
 889         bootstage_mark(BOOTSTAGE_ID_NAND_PART);
 890         switch (argc) {
 891         case 1:
 892                 addr = CONFIG_SYS_LOAD_ADDR;
 893                 boot_device = getenv("bootdevice");
 894                 break;
 895         case 2:
 896                 addr = simple_strtoul(argv[1], NULL, 16);
 897                 boot_device = getenv("bootdevice");
 898                 break;
 899         case 3:
 900                 addr = simple_strtoul(argv[1], NULL, 16);
 901                 boot_device = argv[2];
 902                 break;
 903         case 4:
 904                 addr = simple_strtoul(argv[1], NULL, 16);
 905                 boot_device = argv[2];
 906                 offset = simple_strtoul(argv[3], NULL, 16);
 907                 break;
 908         default:
 909 #if defined(CONFIG_CMD_MTDPARTS)
 910 usage:
 911 #endif
 912                 bootstage_error(BOOTSTAGE_ID_NAND_SUFFIX);
 913                 return CMD_RET_USAGE;
 914         }
 915         bootstage_mark(BOOTSTAGE_ID_NAND_SUFFIX);
 916
 917         if (!boot_device) {
 918                 puts("\n** No boot device **\n");
 919                 bootstage_error(BOOTSTAGE_ID_NAND_BOOT_DEVICE);
 920                 return 1;
 921         }
 922         bootstage_mark(BOOTSTAGE_ID_NAND_BOOT_DEVICE);
 923
 924         idx = simple_strtoul(boot_device, NULL, 16);
 925
 926         if (idx < 0 || idx >= CONFIG_SYS_MAX_NAND_DEVICE || !nand_info[idx].name) {
 927                 printf("\n** Device %d not available\n", idx);
 928                 bootstage_error(BOOTSTAGE_ID_NAND_AVAILABLE);
 929                 return 1;
 930         }
 931         bootstage_mark(BOOTSTAGE_ID_NAND_AVAILABLE);
 932
 933         return nand_load_image(cmdtp, &nand_info[idx], offset, addr, argv[0]);
 934 }
 935
 936 U_BOOT_CMD(nboot, 4, 1, do_nandboot,
 937         "boot from NAND device",
 938         "[partition] | [[[loadAddr] dev] offset]"
 939 );