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 = memalign(ARCH_DMA_MINALIGN, nand->writesize);
  52         oobbuf = memalign(ARCH_DMA_MINALIGN, 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                 loff_t *maxsize)
 142 {
 143 #ifdef CONFIG_CMD_MTDPARTS
 144         struct mtd_device *dev;
 145         struct part_info *part;
 146         u8 pnum;
 147         int ret;
 148
 149         ret = mtdparts_init();
 150         if (ret)
 151                 return ret;
 152
 153         ret = find_dev_and_part(partname, &dev, &pnum, &part);
 154         if (ret)
 155                 return ret;
 156
 157         if (dev->id->type != MTD_DEV_TYPE_NAND) {
 158                 puts("not a NAND device\n");
 159                 return -1;
 160         }
 161
 162         *off = part->offset;
 163         *size = part->size;
 164         *maxsize = part->size;
 165         *idx = dev->id->num;
 166
 167         ret = set_dev(*idx);
 168         if (ret)
 169                 return ret;
 170
 171         return 0;
 172 #else
 173         puts("offset is not a number\n");
 174         return -1;
 175 #endif
 176 }
 177
 178 static int arg_off(const char *arg, int *idx, loff_t *off, loff_t *size,
 179                 loff_t *maxsize)
 180 {
 181         if (!str2off(arg, off))
 182                 return get_part(arg, idx, off, size, maxsize);
 183
 184         if (*off >= nand_info[*idx].size) {
 185                 puts("Offset exceeds device limit\n");
 186                 return -1;
 187         }
 188
 189         *maxsize = nand_info[*idx].size - *off;
 190         *size = *maxsize;
 191         return 0;
 192 }
 193
 194 static int arg_off_size(int argc, char *const argv[], int *idx,
 195                         loff_t *off, loff_t *size, loff_t *maxsize)
 196 {
 197         int ret;
 198
 199         if (argc == 0) {
 200                 *off = 0;
 201                 *size = nand_info[*idx].size;
 202                 *maxsize = *size;
 203                 goto print;
 204         }
 205
 206         ret = arg_off(argv[0], idx, off, size, maxsize);
 207         if (ret)
 208                 return ret;
 209
 210         if (argc == 1)
 211                 goto print;
 212
 213         if (!str2off(argv[1], size)) {
 214                 printf("'%s' is not a number\n", argv[1]);
 215                 return -1;
 216         }
 217
 218         if (*size > *maxsize) {
 219                 puts("Size exceeds partition or device limit\n");
 220                 return -1;
 221         }
 222
 223 print:
 224         printf("device %d ", *idx);
 225         if (*size == nand_info[*idx].size)
 226                 puts("whole chip\n");
 227         else
 228                 printf("offset 0x%llx, size 0x%llx\n",
 229                        (unsigned long long)*off, (unsigned long long)*size);
 230         return 0;
 231 }
 232
 233 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
 234 static void print_status(ulong start, ulong end, ulong erasesize, int status)
 235 {
 236         /*
 237          * Micron NAND flash (e.g. MT29F4G08ABADAH4) BLOCK LOCK READ STATUS is
 238          * not the same as others.  Instead of bit 1 being lock, it is
 239          * #lock_tight. To make the driver support either format, ignore bit 1
 240          * and use only bit 0 and bit 2.
 241          */
 242         printf("%08lx - %08lx: %08lx blocks %s%s%s\n",
 243                 start,
 244                 end - 1,
 245                 (end - start) / erasesize,
 246                 ((status & NAND_LOCK_STATUS_TIGHT) ?  "TIGHT " : ""),
 247                 (!(status & NAND_LOCK_STATUS_UNLOCK) ?  "LOCK " : ""),
 248                 ((status & NAND_LOCK_STATUS_UNLOCK) ?  "UNLOCK " : ""));
 249 }
 250
 251 static void do_nand_status(nand_info_t *nand)
 252 {
 253         ulong block_start = 0;
 254         ulong off;
 255         int last_status = -1;
 256
 257         struct nand_chip *nand_chip = nand->priv;
 258         /* check the WP bit */
 259         nand_chip->cmdfunc(nand, NAND_CMD_STATUS, -1, -1);
 260         printf("device is %swrite protected\n",
 261                 (nand_chip->read_byte(nand) & 0x80 ?
 262                 "NOT " : ""));
 263
 264         for (off = 0; off < nand->size; off += nand->erasesize) {
 265                 int s = nand_get_lock_status(nand, off);
 266
 267                 /* print message only if status has changed */
 268                 if (s != last_status && off != 0) {
 269                         print_status(block_start, off, nand->erasesize,
 270                                         last_status);
 271                         block_start = off;
 272                 }
 273                 last_status = s;
 274         }
 275         /* Print the last block info */
 276         print_status(block_start, off, nand->erasesize, last_status);
 277 }
 278 #endif
 279
 280 #ifdef CONFIG_ENV_OFFSET_OOB
 281 unsigned long nand_env_oob_offset;
 282
 283 int do_nand_env_oob(cmd_tbl_t *cmdtp, int argc, char *const argv[])
 284 {
 285         int ret;
 286         uint32_t oob_buf[ENV_OFFSET_SIZE/sizeof(uint32_t)];
 287         nand_info_t *nand = &nand_info[0];
 288         char *cmd = argv[1];
 289
 290         if (CONFIG_SYS_MAX_NAND_DEVICE == 0 || !nand->name) {
 291                 puts("no devices available\n");
 292                 return 1;
 293         }
 294
 295         set_dev(0);
 296
 297         if (!strcmp(cmd, "get")) {
 298                 ret = get_nand_env_oob(nand, &nand_env_oob_offset);
 299                 if (ret)
 300                         return 1;
 301
 302                 printf("0x%08lx\n", nand_env_oob_offset);
 303         } else if (!strcmp(cmd, "set")) {
 304                 loff_t addr;
 305                 loff_t maxsize;
 306                 struct mtd_oob_ops ops;
 307                 int idx = 0;
 308
 309                 if (argc < 3)
 310                         goto usage;
 311
 312                 /* We don't care about size, or maxsize. */
 313                 if (arg_off(argv[2], &idx, &addr, &maxsize, &maxsize)) {
 314                         puts("Offset or partition name expected\n");
 315                         return 1;
 316                 }
 317
 318                 if (idx != 0) {
 319                         puts("Partition not on first NAND device\n");
 320                         return 1;
 321                 }
 322
 323                 if (nand->oobavail < ENV_OFFSET_SIZE) {
 324                         printf("Insufficient available OOB bytes:\n"
 325                                "%d OOB bytes available but %d required for "
 326                                "env.oob support\n",
 327                                nand->oobavail, ENV_OFFSET_SIZE);
 328                         return 1;
 329                 }
 330
 331                 if ((addr & (nand->erasesize - 1)) != 0) {
 332                         printf("Environment offset must be block-aligned\n");
 333                         return 1;
 334                 }
 335
 336                 ops.datbuf = NULL;
 337                 ops.mode = MTD_OOB_AUTO;
 338                 ops.ooboffs = 0;
 339                 ops.ooblen = ENV_OFFSET_SIZE;
 340                 ops.oobbuf = (void *) oob_buf;
 341
 342                 oob_buf[0] = ENV_OOB_MARKER;
 343                 oob_buf[1] = addr / nand->erasesize;
 344
 345                 ret = nand->write_oob(nand, ENV_OFFSET_SIZE, &ops);
 346                 if (ret) {
 347                         printf("Error writing OOB block 0\n");
 348                         return ret;
 349                 }
 350
 351                 ret = get_nand_env_oob(nand, &nand_env_oob_offset);
 352                 if (ret) {
 353                         printf("Error reading env offset in OOB\n");
 354                         return ret;
 355                 }
 356
 357                 if (addr != nand_env_oob_offset) {
 358                         printf("Verification of env offset in OOB failed: "
 359                                "0x%08llx expected but got 0x%08lx\n",
 360                                (unsigned long long)addr, nand_env_oob_offset);
 361                         return 1;
 362                 }
 363         } else {
 364                 goto usage;
 365         }
 366
 367         return ret;
 368
 369 usage:
 370         return CMD_RET_USAGE;
 371 }
 372
 373 #endif
 374
 375 static void nand_print_and_set_info(int idx)
 376 {
 377         nand_info_t *nand = &nand_info[idx];
 378         struct nand_chip *chip = nand->priv;
 379
 380         printf("Device %d: ", idx);
 381         if (chip->numchips > 1)
 382                 printf("%dx ", chip->numchips);
 383         printf("%s, sector size %u KiB\n",
 384                nand->name, nand->erasesize >> 10);
 385         printf("  Page size  %8d b\n", nand->writesize);
 386         printf("  OOB size   %8d b\n", nand->oobsize);
 387         printf("  Erase size %8d b\n", nand->erasesize);
 388
 389         /* Set geometry info */
 390         setenv_hex("nand_writesize", nand->writesize);
 391         setenv_hex("nand_oobsize", nand->oobsize);
 392         setenv_hex("nand_erasesize", nand->erasesize);
 393 }
 394
 395 static int raw_access(nand_info_t *nand, ulong addr, loff_t off, ulong count,
 396                         int read)
 397 {
 398         int ret = 0;
 399
 400         while (count--) {
 401                 /* Raw access */
 402                 mtd_oob_ops_t ops = {
 403                         .datbuf = (u8 *)addr,
 404                         .oobbuf = ((u8 *)addr) + nand->writesize,
 405                         .len = nand->writesize,
 406                         .ooblen = nand->oobsize,
 407                         .mode = MTD_OOB_RAW
 408                 };
 409
 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 static 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, maxsize;
 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,
 558                                  &maxsize) != 0)
 559                         return 1;
 560
 561                 nand = &nand_info[dev];
 562
 563                 memset(&opts, 0, sizeof(opts));
 564                 opts.offset = off;
 565                 opts.length = size;
 566                 opts.jffs2  = clean;
 567                 opts.quiet  = quiet;
 568                 opts.spread = spread;
 569
 570                 if (scrub) {
 571                         if (!scrub_yes)
 572                                 puts(scrub_warn);
 573
 574                         if (scrub_yes)
 575                                 opts.scrub = 1;
 576                         else if (getc() == 'y') {
 577                                 puts("y");
 578                                 if (getc() == '\r')
 579                                         opts.scrub = 1;
 580                                 else {
 581                                         puts("scrub aborted\n");
 582                                         return -1;
 583                                 }
 584                         } else {
 585                                 puts("scrub aborted\n");
 586                                 return -1;
 587                         }
 588                 }
 589                 ret = nand_erase_opts(nand, &opts);
 590                 printf("%s\n", ret ? "ERROR" : "OK");
 591
 592                 return ret == 0 ? 0 : 1;
 593         }
 594
 595         if (strncmp(cmd, "dump", 4) == 0) {
 596                 if (argc < 3)
 597                         goto usage;
 598
 599                 off = (int)simple_strtoul(argv[2], NULL, 16);
 600                 ret = nand_dump(nand, off, !strcmp(&cmd[4], ".oob"), repeat);
 601
 602                 return ret == 0 ? 1 : 0;
 603         }
 604
 605         if (strncmp(cmd, "read", 4) == 0 || strncmp(cmd, "write", 5) == 0) {
 606                 size_t rwsize;
 607                 ulong pagecount = 1;
 608                 int read;
 609                 int raw = 0;
 610
 611                 if (argc < 4)
 612                         goto usage;
 613
 614                 addr = (ulong)simple_strtoul(argv[2], NULL, 16);
 615
 616                 read = strncmp(cmd, "read", 4) == 0; /* 1 = read, 0 = write */
 617                 printf("\nNAND %s: ", read ? "read" : "write");
 618
 619                 nand = &nand_info[dev];
 620
 621                 s = strchr(cmd, '.');
 622
 623                 if (s && !strcmp(s, ".raw")) {
 624                         raw = 1;
 625
 626                         if (arg_off(argv[3], &dev, &off, &size, &maxsize))
 627                                 return 1;
 628
 629                         if (argc > 4 && !str2long(argv[4], &pagecount)) {
 630                                 printf("'%s' is not a number\n", argv[4]);
 631                                 return 1;
 632                         }
 633
 634                         if (pagecount * nand->writesize > size) {
 635                                 puts("Size exceeds partition or device limit\n");
 636                                 return -1;
 637                         }
 638
 639                         rwsize = pagecount * (nand->writesize + nand->oobsize);
 640                 } else {
 641                         if (arg_off_size(argc - 3, argv + 3, &dev,
 642                                                 &off, &size, &maxsize) != 0)
 643                                 return 1;
 644
 645                         rwsize = size;
 646                 }
 647
 648                 if (!s || !strcmp(s, ".jffs2") ||
 649                     !strcmp(s, ".e") || !strcmp(s, ".i")) {
 650                         if (read)
 651                                 ret = nand_read_skip_bad(nand, off, &rwsize,
 652                                                          NULL, maxsize,
 653                                                          (u_char *)addr);
 654                         else
 655                                 ret = nand_write_skip_bad(nand, off, &rwsize,
 656                                                           NULL, maxsize,
 657                                                           (u_char *)addr, 0);
 658 #ifdef CONFIG_CMD_NAND_TRIMFFS
 659                 } else if (!strcmp(s, ".trimffs")) {
 660                         if (read) {
 661                                 printf("Unknown nand command suffix '%s'\n", s);
 662                                 return 1;
 663                         }
 664                         ret = nand_write_skip_bad(nand, off, &rwsize, NULL,
 665                                                 maxsize, (u_char *)addr,
 666                                                 WITH_DROP_FFS);
 667 #endif
 668 #ifdef CONFIG_CMD_NAND_YAFFS
 669                 } else if (!strcmp(s, ".yaffs")) {
 670                         if (read) {
 671                                 printf("Unknown nand command suffix '%s'.\n", s);
 672                                 return 1;
 673                         }
 674                         ret = nand_write_skip_bad(nand, off, &rwsize, NULL,
 675                                                 maxsize, (u_char *)addr,
 676                                                 WITH_YAFFS_OOB);
 677 #endif
 678                 } else if (!strcmp(s, ".oob")) {
 679                         /* out-of-band data */
 680                         mtd_oob_ops_t ops = {
 681                                 .oobbuf = (u8 *)addr,
 682                                 .ooblen = rwsize,
 683                                 .mode = MTD_OOB_RAW
 684                         };
 685
 686                         if (read)
 687                                 ret = nand->read_oob(nand, off, &ops);
 688                         else
 689                                 ret = nand->write_oob(nand, off, &ops);
 690                 } else if (raw) {
 691                         ret = raw_access(nand, addr, off, pagecount, read);
 692                 } else {
 693                         printf("Unknown nand command suffix '%s'.\n", s);
 694                         return 1;
 695                 }
 696
 697                 printf(" %zu bytes %s: %s\n", rwsize,
 698                        read ? "read" : "written", ret ? "ERROR" : "OK");
 699
 700                 return ret == 0 ? 0 : 1;
 701         }
 702
 703 #ifdef CONFIG_CMD_NAND_TORTURE
 704         if (strcmp(cmd, "torture") == 0) {
 705                 if (argc < 3)
 706                         goto usage;
 707
 708                 if (!str2off(argv[2], &off)) {
 709                         puts("Offset is not a valid number\n");
 710                         return 1;
 711                 }
 712
 713                 printf("\nNAND torture: device %d offset 0x%llx size 0x%x\n",
 714                         dev, off, nand->erasesize);
 715                 ret = nand_torture(nand, off);
 716                 printf(" %s\n", ret ? "Failed" : "Passed");
 717
 718                 return ret == 0 ? 0 : 1;
 719         }
 720 #endif
 721
 722         if (strcmp(cmd, "markbad") == 0) {
 723                 argc -= 2;
 724                 argv += 2;
 725
 726                 if (argc <= 0)
 727                         goto usage;
 728
 729                 while (argc > 0) {
 730                         addr = simple_strtoul(*argv, NULL, 16);
 731
 732                         if (nand->block_markbad(nand, addr)) {
 733                                 printf("block 0x%08lx NOT marked "
 734                                         "as bad! ERROR %d\n",
 735                                         addr, ret);
 736                                 ret = 1;
 737                         } else {
 738                                 printf("block 0x%08lx successfully "
 739                                         "marked as bad\n",
 740                                         addr);
 741                         }
 742                         --argc;
 743                         ++argv;
 744                 }
 745                 return ret;
 746         }
 747
 748         if (strcmp(cmd, "biterr") == 0) {
 749                 /* todo */
 750                 return 1;
 751         }
 752
 753 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
 754         if (strcmp(cmd, "lock") == 0) {
 755                 int tight = 0;
 756                 int status = 0;
 757                 if (argc == 3) {
 758                         if (!strcmp("tight", argv[2]))
 759                                 tight = 1;
 760                         if (!strcmp("status", argv[2]))
 761                                 status = 1;
 762                 }
 763                 if (status) {
 764                         do_nand_status(nand);
 765                 } else {
 766                         if (!nand_lock(nand, tight)) {
 767                                 puts("NAND flash successfully locked\n");
 768                         } else {
 769                                 puts("Error locking NAND flash\n");
 770                                 return 1;
 771                         }
 772                 }
 773                 return 0;
 774         }
 775
 776         if (strncmp(cmd, "unlock", 5) == 0) {
 777                 int allexcept = 0;
 778
 779                 s = strchr(cmd, '.');
 780
 781                 if (s && !strcmp(s, ".allexcept"))
 782                         allexcept = 1;
 783
 784                 if (arg_off_size(argc - 2, argv + 2, &dev, &off, &size,
 785                                  &maxsize) < 0)
 786                         return 1;
 787
 788                 if (!nand_unlock(&nand_info[dev], off, size, allexcept)) {
 789                         puts("NAND flash successfully unlocked\n");
 790                 } else {
 791                         puts("Error unlocking NAND flash, "
 792                              "write and erase will probably fail\n");
 793                         return 1;
 794                 }
 795                 return 0;
 796         }
 797 #endif
 798
 799 usage:
 800         return CMD_RET_USAGE;
 801 }
 802
 803 #ifdef CONFIG_SYS_LONGHELP
 804 static char nand_help_text[] =
 805         "info - show available NAND devices\n"
 806         "nand device [dev] - show or set current device\n"
 807         "nand read - addr off|partition size\n"
 808         "nand write - addr off|partition size\n"
 809         "    read/write 'size' bytes starting at offset 'off'\n"
 810         "    to/from memory address 'addr', skipping bad blocks.\n"
 811         "nand read.raw - addr off|partition [count]\n"
 812         "nand write.raw - addr off|partition [count]\n"
 813         "    Use read.raw/write.raw to avoid ECC and access the flash as-is.\n"
 814 #ifdef CONFIG_CMD_NAND_TRIMFFS
 815         "nand write.trimffs - addr off|partition size\n"
 816         "    write 'size' bytes starting at offset 'off' from memory address\n"
 817         "    'addr', skipping bad blocks and dropping any pages at the end\n"
 818         "    of eraseblocks that contain only 0xFF\n"
 819 #endif
 820 #ifdef CONFIG_CMD_NAND_YAFFS
 821         "nand write.yaffs - addr off|partition size\n"
 822         "    write 'size' bytes starting at offset 'off' with yaffs format\n"
 823         "    from memory address 'addr', skipping bad blocks.\n"
 824 #endif
 825         "nand erase[.spread] [clean] off size - erase 'size' bytes "
 826         "from offset 'off'\n"
 827         "    With '.spread', erase enough for given file size, otherwise,\n"
 828         "    'size' includes skipped bad blocks.\n"
 829         "nand erase.part [clean] partition - erase entire mtd partition'\n"
 830         "nand erase.chip [clean] - erase entire chip'\n"
 831         "nand bad - show bad blocks\n"
 832         "nand dump[.oob] off - dump page\n"
 833 #ifdef CONFIG_CMD_NAND_TORTURE
 834         "nand torture off - torture block at offset\n"
 835 #endif
 836         "nand scrub [-y] off size | scrub.part partition | scrub.chip\n"
 837         "    really clean NAND erasing bad blocks (UNSAFE)\n"
 838         "nand markbad off [...] - mark bad block(s) at offset (UNSAFE)\n"
 839         "nand biterr off - make a bit error at offset (UNSAFE)"
 840 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
 841         "\n"
 842         "nand lock [tight] [status]\n"
 843         "    bring nand to lock state or display locked pages\n"
 844         "nand unlock[.allexcept] [offset] [size] - unlock section"
 845 #endif
 846 #ifdef CONFIG_ENV_OFFSET_OOB
 847         "\n"
 848         "nand env.oob - environment offset in OOB of block 0 of"
 849         "    first device.\n"
 850         "nand env.oob set off|partition - set enviromnent offset\n"
 851         "nand env.oob get - get environment offset"
 852 #endif
 853         "";
 854 #endif
 855
 856 U_BOOT_CMD(
 857         nand, CONFIG_SYS_MAXARGS, 1, do_nand,
 858         "NAND sub-system", nand_help_text
 859 );
 860
 861 static int nand_load_image(cmd_tbl_t *cmdtp, nand_info_t *nand,
 862                            ulong offset, ulong addr, char *cmd)
 863 {
 864         int r;
 865         char *s;
 866         size_t cnt;
 867         image_header_t *hdr;
 868 #if defined(CONFIG_FIT)
 869         const void *fit_hdr = NULL;
 870 #endif
 871
 872         s = strchr(cmd, '.');
 873         if (s != NULL &&
 874             (strcmp(s, ".jffs2") && strcmp(s, ".e") && strcmp(s, ".i"))) {
 875                 printf("Unknown nand load suffix '%s'\n", s);
 876                 bootstage_error(BOOTSTAGE_ID_NAND_SUFFIX);
 877                 return 1;
 878         }
 879
 880         printf("\nLoading from %s, offset 0x%lx\n", nand->name, offset);
 881
 882         cnt = nand->writesize;
 883         r = nand_read_skip_bad(nand, offset, &cnt, NULL, nand->size,
 884                         (u_char *)addr);
 885         if (r) {
 886                 puts("** Read error\n");
 887                 bootstage_error(BOOTSTAGE_ID_NAND_HDR_READ);
 888                 return 1;
 889         }
 890         bootstage_mark(BOOTSTAGE_ID_NAND_HDR_READ);
 891
 892         switch (genimg_get_format ((void *)addr)) {
 893         case IMAGE_FORMAT_LEGACY:
 894                 hdr = (image_header_t *)addr;
 895
 896                 bootstage_mark(BOOTSTAGE_ID_NAND_TYPE);
 897                 image_print_contents (hdr);
 898
 899                 cnt = image_get_image_size (hdr);
 900                 break;
 901 #if defined(CONFIG_FIT)
 902         case IMAGE_FORMAT_FIT:
 903                 fit_hdr = (const void *)addr;
 904                 puts ("Fit image detected...\n");
 905
 906                 cnt = fit_get_size (fit_hdr);
 907                 break;
 908 #endif
 909         default:
 910                 bootstage_error(BOOTSTAGE_ID_NAND_TYPE);
 911                 puts ("** Unknown image type\n");
 912                 return 1;
 913         }
 914         bootstage_mark(BOOTSTAGE_ID_NAND_TYPE);
 915
 916         r = nand_read_skip_bad(nand, offset, &cnt, NULL, nand->size,
 917                         (u_char *)addr);
 918         if (r) {
 919                 puts("** Read error\n");
 920                 bootstage_error(BOOTSTAGE_ID_NAND_READ);
 921                 return 1;
 922         }
 923         bootstage_mark(BOOTSTAGE_ID_NAND_READ);
 924
 925 #if defined(CONFIG_FIT)
 926         /* This cannot be done earlier, we need complete FIT image in RAM first */
 927         if (genimg_get_format ((void *)addr) == IMAGE_FORMAT_FIT) {
 928                 if (!fit_check_format (fit_hdr)) {
 929                         bootstage_error(BOOTSTAGE_ID_NAND_FIT_READ);
 930                         puts ("** Bad FIT image format\n");
 931                         return 1;
 932                 }
 933                 bootstage_mark(BOOTSTAGE_ID_NAND_FIT_READ_OK);
 934                 fit_print_contents (fit_hdr);
 935         }
 936 #endif
 937
 938         /* Loading ok, update default load address */
 939
 940         load_addr = addr;
 941
 942         return bootm_maybe_autostart(cmdtp, cmd);
 943 }
 944
 945 static int do_nandboot(cmd_tbl_t *cmdtp, int flag, int argc,
 946                        char * const argv[])
 947 {
 948         char *boot_device = NULL;
 949         int idx;
 950         ulong addr, offset = 0;
 951 #if defined(CONFIG_CMD_MTDPARTS)
 952         struct mtd_device *dev;
 953         struct part_info *part;
 954         u8 pnum;
 955
 956         if (argc >= 2) {
 957                 char *p = (argc == 2) ? argv[1] : argv[2];
 958                 if (!(str2long(p, &addr)) && (mtdparts_init() == 0) &&
 959                     (find_dev_and_part(p, &dev, &pnum, &part) == 0)) {
 960                         if (dev->id->type != MTD_DEV_TYPE_NAND) {
 961                                 puts("Not a NAND device\n");
 962                                 return 1;
 963                         }
 964                         if (argc > 3)
 965                                 goto usage;
 966                         if (argc == 3)
 967                                 addr = simple_strtoul(argv[1], NULL, 16);
 968                         else
 969                                 addr = CONFIG_SYS_LOAD_ADDR;
 970                         return nand_load_image(cmdtp, &nand_info[dev->id->num],
 971                                                part->offset, addr, argv[0]);
 972                 }
 973         }
 974 #endif
 975
 976         bootstage_mark(BOOTSTAGE_ID_NAND_PART);
 977         switch (argc) {
 978         case 1:
 979                 addr = CONFIG_SYS_LOAD_ADDR;
 980                 boot_device = getenv("bootdevice");
 981                 break;
 982         case 2:
 983                 addr = simple_strtoul(argv[1], NULL, 16);
 984                 boot_device = getenv("bootdevice");
 985                 break;
 986         case 3:
 987                 addr = simple_strtoul(argv[1], NULL, 16);
 988                 boot_device = argv[2];
 989                 break;
 990         case 4:
 991                 addr = simple_strtoul(argv[1], NULL, 16);
 992                 boot_device = argv[2];
 993                 offset = simple_strtoul(argv[3], NULL, 16);
 994                 break;
 995         default:
 996 #if defined(CONFIG_CMD_MTDPARTS)
 997 usage:
 998 #endif
 999                 bootstage_error(BOOTSTAGE_ID_NAND_SUFFIX);
1000                 return CMD_RET_USAGE;
1001         }
1002         bootstage_mark(BOOTSTAGE_ID_NAND_SUFFIX);
1003
1004         if (!boot_device) {
1005                 puts("\n** No boot device **\n");
1006                 bootstage_error(BOOTSTAGE_ID_NAND_BOOT_DEVICE);
1007                 return 1;
1008         }
1009         bootstage_mark(BOOTSTAGE_ID_NAND_BOOT_DEVICE);
1010
1011         idx = simple_strtoul(boot_device, NULL, 16);
1012
1013         if (idx < 0 || idx >= CONFIG_SYS_MAX_NAND_DEVICE || !nand_info[idx].name) {
1014                 printf("\n** Device %d not available\n", idx);
1015                 bootstage_error(BOOTSTAGE_ID_NAND_AVAILABLE);
1016                 return 1;
1017         }
1018         bootstage_mark(BOOTSTAGE_ID_NAND_AVAILABLE);
1019
1020         return nand_load_image(cmdtp, &nand_info[idx], offset, addr, argv[0]);
1021 }
1022
1023 U_BOOT_CMD(nboot, 4, 1, do_nandboot,
1024         "boot from NAND device",
1025         "[partition] | [[[loadAddr] dev] offset]"
1026 );