common/cmd_nand.c

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