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 {
 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         /*
 235          * Micron NAND flash (e.g. MT29F4G08ABADAH4) BLOCK LOCK READ STATUS is
 236          * not the same as others.  Instead of bit 1 being lock, it is
 237          * #lock_tight. To make the driver support either format, ignore bit 1
 238          * and use only bit 0 and bit 2.
 239          */
 240         printf("%08lx - %08lx: %08lx blocks %s%s%s\n",
 241                 start,
 242                 end - 1,
 243                 (end - start) / erasesize,
 244                 ((status & NAND_LOCK_STATUS_TIGHT) ?  "TIGHT " : ""),
 245                 (!(status & NAND_LOCK_STATUS_UNLOCK) ?  "LOCK " : ""),
 246                 ((status & NAND_LOCK_STATUS_UNLOCK) ?  "UNLOCK " : ""));
 247 }
 248
 249 static void do_nand_status(nand_info_t *nand)
 250 {
 251         ulong block_start = 0;
 252         ulong off;
 253         int last_status = -1;
 254
 255         struct nand_chip *nand_chip = nand->priv;
 256         /* check the WP bit */
 257         nand_chip->cmdfunc(nand, NAND_CMD_STATUS, -1, -1);
 258         printf("device is %swrite protected\n",
 259                 (nand_chip->read_byte(nand) & 0x80 ?
 260                 "NOT " : ""));
 261
 262         for (off = 0; off < nand->size; off += nand->erasesize) {
 263                 int s = nand_get_lock_status(nand, off);
 264
 265                 /* print message only if status has changed */
 266                 if (s != last_status && off != 0) {
 267                         print_status(block_start, off, nand->erasesize,
 268                                         last_status);
 269                         block_start = off;
 270                 }
 271                 last_status = s;
 272         }
 273         /* Print the last block info */
 274         print_status(block_start, off, nand->erasesize, last_status);
 275 }
 276 #endif
 277
 278 #ifdef CONFIG_ENV_OFFSET_OOB
 279 unsigned long nand_env_oob_offset;
 280
 281 int do_nand_env_oob(cmd_tbl_t *cmdtp, int argc, char *const argv[])
 282 {
 283         int ret;
 284         uint32_t oob_buf[ENV_OFFSET_SIZE/sizeof(uint32_t)];
 285         nand_info_t *nand = &nand_info[0];
 286         char *cmd = argv[1];
 287
 288         if (CONFIG_SYS_MAX_NAND_DEVICE == 0 || !nand->name) {
 289                 puts("no devices available\n");
 290                 return 1;
 291         }
 292
 293         set_dev(0);
 294
 295         if (!strcmp(cmd, "get")) {
 296                 ret = get_nand_env_oob(nand, &nand_env_oob_offset);
 297                 if (ret)
 298                         return 1;
 299
 300                 printf("0x%08lx\n", nand_env_oob_offset);
 301         } else if (!strcmp(cmd, "set")) {
 302                 loff_t addr;
 303                 loff_t maxsize;
 304                 struct mtd_oob_ops ops;
 305                 int idx = 0;
 306
 307                 if (argc < 3)
 308                         goto usage;
 309
 310                 if (arg_off(argv[2], &idx, &addr, &maxsize)) {
 311                         puts("Offset or partition name expected\n");
 312                         return 1;
 313                 }
 314
 315                 if (idx != 0) {
 316                         puts("Partition not on first NAND device\n");
 317                         return 1;
 318                 }
 319
 320                 if (nand->oobavail < ENV_OFFSET_SIZE) {
 321                         printf("Insufficient available OOB bytes:\n"
 322                                "%d OOB bytes available but %d required for "
 323                                "env.oob support\n",
 324                                nand->oobavail, ENV_OFFSET_SIZE);
 325                         return 1;
 326                 }
 327
 328                 if ((addr & (nand->erasesize - 1)) != 0) {
 329                         printf("Environment offset must be block-aligned\n");
 330                         return 1;
 331                 }
 332
 333                 ops.datbuf = NULL;
 334                 ops.mode = MTD_OOB_AUTO;
 335                 ops.ooboffs = 0;
 336                 ops.ooblen = ENV_OFFSET_SIZE;
 337                 ops.oobbuf = (void *) oob_buf;
 338
 339                 oob_buf[0] = ENV_OOB_MARKER;
 340                 oob_buf[1] = addr / nand->erasesize;
 341
 342                 ret = nand->write_oob(nand, ENV_OFFSET_SIZE, &ops);
 343                 if (ret) {
 344                         printf("Error writing OOB block 0\n");
 345                         return ret;
 346                 }
 347
 348                 ret = get_nand_env_oob(nand, &nand_env_oob_offset);
 349                 if (ret) {
 350                         printf("Error reading env offset in OOB\n");
 351                         return ret;
 352                 }
 353
 354                 if (addr != nand_env_oob_offset) {
 355                         printf("Verification of env offset in OOB failed: "
 356                                "0x%08llx expected but got 0x%08lx\n",
 357                                (unsigned long long)addr, nand_env_oob_offset);
 358                         return 1;
 359                 }
 360         } else {
 361                 goto usage;
 362         }
 363
 364         return ret;
 365
 366 usage:
 367         return CMD_RET_USAGE;
 368 }
 369
 370 #endif
 371
 372 static void nand_print_and_set_info(int idx)
 373 {
 374         nand_info_t *nand = &nand_info[idx];
 375         struct nand_chip *chip = nand->priv;
 376         char buf[32];
 377
 378         printf("Device %d: ", idx);
 379         if (chip->numchips > 1)
 380                 printf("%dx ", chip->numchips);
 381         printf("%s, sector size %u KiB\n",
 382                nand->name, nand->erasesize >> 10);
 383         printf("  Page size  %8d b\n", nand->writesize);
 384         printf("  OOB size   %8d b\n", nand->oobsize);
 385         printf("  Erase size %8d b\n", nand->erasesize);
 386
 387         /* Set geometry info */
 388         sprintf(buf, "%x", nand->writesize);
 389         setenv("nand_writesize", buf);
 390
 391         sprintf(buf, "%x", nand->oobsize);
 392         setenv("nand_oobsize", buf);
 393
 394         sprintf(buf, "%x", nand->erasesize);
 395         setenv("nand_erasesize", buf);
 396 }
 397
 398 static int raw_access(nand_info_t *nand, ulong addr, loff_t off, ulong count,
 399                         int read)
 400 {
 401         int ret = 0;
 402
 403         while (count--) {
 404                 /* Raw access */
 405                 mtd_oob_ops_t ops = {
 406                         .datbuf = (u8 *)addr,
 407                         .oobbuf = ((u8 *)addr) + nand->writesize,
 408                         .len = nand->writesize,
 409                         .ooblen = nand->oobsize,
 410                         .mode = MTD_OOB_RAW
 411                 };
 412
 413                 if (read)
 414                         ret = nand->read_oob(nand, off, &ops);
 415                 else
 416                         ret = nand->write_oob(nand, off, &ops);
 417
 418                 if (ret) {
 419                         printf("%s: error at offset %llx, ret %d\n",
 420                                 __func__, (long long)off, ret);
 421                         break;
 422                 }
 423
 424                 addr += nand->writesize + nand->oobsize;
 425                 off += nand->writesize;
 426         }
 427
 428         return ret;
 429 }
 430
 431 static int do_nand(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 432 {
 433         int i, ret = 0;
 434         ulong addr;
 435         loff_t off, size;
 436         char *cmd, *s;
 437         nand_info_t *nand;
 438 #ifdef CONFIG_SYS_NAND_QUIET
 439         int quiet = CONFIG_SYS_NAND_QUIET;
 440 #else
 441         int quiet = 0;
 442 #endif
 443         const char *quiet_str = getenv("quiet");
 444         int dev = nand_curr_device;
 445         int repeat = flag & CMD_FLAG_REPEAT;
 446
 447         /* at least two arguments please */
 448         if (argc < 2)
 449                 goto usage;
 450
 451         if (quiet_str)
 452                 quiet = simple_strtoul(quiet_str, NULL, 0) != 0;
 453
 454         cmd = argv[1];
 455
 456         /* Only "dump" is repeatable. */
 457         if (repeat && strcmp(cmd, "dump"))
 458                 return CMD_RET_FAILURE;
 459
 460         if (strcmp(cmd, "info") == 0) {
 461
 462                 putc('\n');
 463                 for (i = 0; i < CONFIG_SYS_MAX_NAND_DEVICE; i++) {
 464                         if (nand_info[i].name)
 465                                 nand_print_and_set_info(i);
 466                 }
 467                 return CMD_RET_SUCCESS;
 468         }
 469
 470         if (strcmp(cmd, "device") == 0) {
 471                 if (argc < 3) {
 472                         putc('\n');
 473                         if (dev < 0 || dev >= CONFIG_SYS_MAX_NAND_DEVICE)
 474                                 puts("no devices available\n");
 475                         else
 476                                 nand_print_and_set_info(dev);
 477                         return CMD_RET_SUCCESS;
 478                 }
 479
 480                 dev = (int)simple_strtoul(argv[2], NULL, 10);
 481                 set_dev(dev);
 482
 483                 return CMD_RET_SUCCESS;
 484         }
 485
 486 #ifdef CONFIG_ENV_OFFSET_OOB
 487         /* this command operates only on the first nand device */
 488         if (strcmp(cmd, "env.oob") == 0)
 489                 return do_nand_env_oob(cmdtp, argc - 1, argv + 1) ?
 490                         CMD_RET_FAILURE : CMD_RET_SUCCESS;;
 491 #endif
 492
 493         /* The following commands operate on the current device, unless
 494          * overridden by a partition specifier.  Note that if somehow the
 495          * current device is invalid, it will have to be changed to a valid
 496          * one before these commands can run, even if a partition specifier
 497          * for another device is to be used.
 498          */
 499         if (dev < 0 || dev >= CONFIG_SYS_MAX_NAND_DEVICE ||
 500             !nand_info[dev].name) {
 501                 puts("\nno devices available\n");
 502                 return CMD_RET_FAILURE;
 503         }
 504         nand = &nand_info[dev];
 505
 506         if (strcmp(cmd, "bad") == 0) {
 507                 printf("\nDevice %d bad blocks:\n", dev);
 508                 for (off = 0; off < nand->size; off += nand->erasesize)
 509                         if (nand_block_isbad(nand, off))
 510                                 printf("  %08llx\n", (unsigned long long)off);
 511                 return CMD_RET_SUCCESS;
 512         }
 513
 514         /*
 515          * Syntax is:
 516          *   0    1     2       3    4
 517          *   nand erase [clean] [off size]
 518          */
 519         if (strncmp(cmd, "erase", 5) == 0 || strncmp(cmd, "scrub", 5) == 0) {
 520                 nand_erase_options_t opts;
 521                 /* "clean" at index 2 means request to write cleanmarker */
 522                 int clean = argc > 2 && !strcmp("clean", argv[2]);
 523                 int scrub_yes = argc > 2 && !strcmp("-y", argv[2]);
 524                 int o = (clean || scrub_yes) ? 3 : 2;
 525                 int scrub = !strncmp(cmd, "scrub", 5);
 526                 int spread = 0;
 527                 int args = 2;
 528                 const char *scrub_warn =
 529                         "Warning: "
 530                         "scrub option will erase all factory set bad blocks!\n"
 531                         "         "
 532                         "There is no reliable way to recover them.\n"
 533                         "         "
 534                         "Use this command only for testing purposes if you\n"
 535                         "         "
 536                         "are sure of what you are doing!\n"
 537                         "\nReally scrub this NAND flash? <y/N>\n";
 538
 539                 if (cmd[5] != 0) {
 540                         if (!strcmp(&cmd[5], ".spread")) {
 541                                 spread = 1;
 542                         } else if (!strcmp(&cmd[5], ".part")) {
 543                                 args = 1;
 544                         } else if (!strcmp(&cmd[5], ".chip")) {
 545                                 args = 0;
 546                         } else {
 547                                 goto usage;
 548                         }
 549                 }
 550
 551                 /*
 552                  * Don't allow missing arguments to cause full chip/partition
 553                  * erases -- easy to do accidentally, e.g. with a misspelled
 554                  * variable name.
 555                  */
 556                 if (argc != o + args)
 557                         goto usage;
 558
 559                 printf("\nNAND %s: ", cmd);
 560                 /* skip first two or three arguments, look for offset and size */
 561                 if (arg_off_size(argc - o, argv + o, &dev, &off, &size) != 0)
 562                         return CMD_RET_FAILURE;
 563
 564                 nand = &nand_info[dev];
 565
 566                 memset(&opts, 0, sizeof(opts));
 567                 opts.offset = off;
 568                 opts.length = size;
 569                 opts.jffs2  = clean;
 570                 opts.quiet  = quiet;
 571                 opts.spread = spread;
 572
 573                 if (scrub) {
 574                         if (!scrub_yes)
 575                                 puts(scrub_warn);
 576
 577                         if (scrub_yes)
 578                                 opts.scrub = 1;
 579                         else if (getc() == 'y') {
 580                                 puts("y");
 581                                 if (getc() == '\r')
 582                                         opts.scrub = 1;
 583                                 else {
 584                                         puts("scrub aborted\n");
 585                                         return CMD_RET_FAILURE;
 586                                 }
 587                         } else {
 588                                 puts("scrub aborted\n");
 589                                 return CMD_RET_FAILURE;
 590                         }
 591                 }
 592                 ret = nand_erase_opts(nand, &opts);
 593                 printf("%s\n", ret ? "ERROR" : "OK");
 594
 595                 return ret == 0 ? CMD_RET_SUCCESS : CMD_RET_FAILURE;
 596         }
 597
 598         if (strncmp(cmd, "dump", 4) == 0) {
 599                 if (argc < 3)
 600                         goto usage;
 601
 602                 off = (int)simple_strtoul(argv[2], NULL, 16);
 603                 ret = nand_dump(nand, off, !strcmp(&cmd[4], ".oob"), repeat);
 604
 605                 return ret == 0 ? CMD_RET_SUCCESS : CMD_RET_FAILURE;
 606         }
 607
 608         if (strncmp(cmd, "read", 4) == 0 || strncmp(cmd, "write", 5) == 0) {
 609                 size_t rwsize;
 610                 ulong pagecount = 1;
 611                 int read;
 612                 int raw;
 613
 614                 if (argc < 4)
 615                         goto usage;
 616
 617                 addr = (ulong)simple_strtoul(argv[2], NULL, 16);
 618
 619                 read = strncmp(cmd, "read", 4) == 0; /* 1 = read, 0 = write */
 620                 printf("\nNAND %s: ", read ? "read" : "write");
 621                 if (arg_off_size(argc - 3, argv + 3, &dev, &off, &size) != 0)
 622                         return CMD_RET_FAILURE;
 623
 624                 nand = &nand_info[dev];
 625
 626                 s = strchr(cmd, '.');
 627
 628                 if (s && !strcmp(s, ".raw")) {
 629                         raw = 1;
 630
 631                         if (arg_off(argv[3], &dev, &off, &size))
 632                                 return 1;
 633
 634                         if (argc > 4 && !str2long(argv[4], &pagecount)) {
 635                                 printf("'%s' is not a number\n", argv[4]);
 636                                 return 1;
 637                         }
 638
 639                         if (pagecount * nand->writesize > size) {
 640                                 puts("Size exceeds partition or device limit\n");
 641                                 return -1;
 642                         }
 643
 644                         rwsize = pagecount * (nand->writesize + nand->oobsize);
 645                 } else {
 646                         if (arg_off_size(argc - 3, argv + 3, &dev,
 647                                                 &off, &size) != 0)
 648                                 return 1;
 649
 650                         rwsize = size;
 651                 }
 652
 653                 if (!s || !strcmp(s, ".jffs2") ||
 654                     !strcmp(s, ".e") || !strcmp(s, ".i")) {
 655                         if (read)
 656                                 ret = nand_read_skip_bad(nand, off, &rwsize,
 657                                                          (u_char *)addr);
 658                         else
 659                                 ret = nand_write_skip_bad(nand, off, &rwsize,
 660                                                           (u_char *)addr, 0);
 661 #ifdef CONFIG_CMD_NAND_TRIMFFS
 662                 } else if (!strcmp(s, ".trimffs")) {
 663                         if (read) {
 664                                 printf("Unknown nand command suffix '%s'\n", s);
 665                                 return CMD_RET_FAILURE;
 666                         }
 667                         ret = nand_write_skip_bad(nand, off, &rwsize,
 668                                                 (u_char *)addr,
 669                                                 WITH_DROP_FFS);
 670 #endif
 671 #ifdef CONFIG_CMD_NAND_YAFFS
 672                 } else if (!strcmp(s, ".yaffs")) {
 673                         if (read) {
 674                                 printf("Unknown nand command suffix '%s'.\n", s);
 675                                 return CMD_RET_FAILURE;
 676                         }
 677                         ret = nand_write_skip_bad(nand, off, &rwsize,
 678                                                 (u_char *)addr,
 679                                                 WITH_INLINE_OOB);
 680 #endif
 681                 } else if (!strcmp(s, ".oob")) {
 682                         /* out-of-band data */
 683                         mtd_oob_ops_t ops = {
 684                                 .oobbuf = (u8 *)addr,
 685                                 .ooblen = rwsize,
 686                                 .mode = MTD_OOB_RAW
 687                         };
 688
 689                         if (read)
 690                                 ret = nand->read_oob(nand, off, &ops);
 691                         else
 692                                 ret = nand->write_oob(nand, off, &ops);
 693                 } else if (raw) {
 694                         ret = raw_access(nand, addr, off, pagecount, read);
 695                 } else {
 696                         printf("Unknown nand command suffix '%s'.\n", s);
 697                         return CMD_RET_FAILURE;
 698                 }
 699
 700                 printf(" %zu bytes %s: %s\n", rwsize,
 701                        read ? "read" : "written", ret ? "ERROR" : "OK");
 702
 703                 return ret == 0 ? CMD_RET_SUCCESS : CMD_RET_FAILURE;
 704         }
 705
 706 #ifdef CONFIG_CMD_NAND_TORTURE
 707         if (strcmp(cmd, "torture") == 0) {
 708                 if (argc < 3)
 709                         goto usage;
 710
 711                 if (!str2off(argv[2], &off)) {
 712                         puts("Offset is not a valid number\n");
 713                         return 1;
 714                 }
 715
 716                 printf("\nNAND torture: device %d offset 0x%llx size 0x%x\n",
 717                         dev, off, nand->erasesize);
 718                 ret = nand_torture(nand, off);
 719                 printf(" %s\n", ret ? "Failed" : "Passed");
 720
 721                 return ret == 0 ? 0 : 1;
 722         }
 723 #endif
 724
 725         if (strcmp(cmd, "markbad") == 0) {
 726                 argc -= 2;
 727                 argv += 2;
 728
 729                 if (argc <= 0)
 730                         goto usage;
 731
 732                 while (argc > 0) {
 733                         addr = simple_strtoul(*argv, NULL, 16);
 734
 735                         if (nand->block_markbad(nand, addr)) {
 736                                 printf("block 0x%08lx NOT marked "
 737                                         "as bad! ERROR %d\n",
 738                                         addr, ret);
 739                                 ret = 1;
 740                         } else {
 741                                 printf("block 0x%08lx successfully "
 742                                         "marked as bad\n",
 743                                         addr);
 744                         }
 745                         --argc;
 746                         ++argv;
 747                 }
 748                 return ret == 0 ? CMD_RET_SUCCESS : CMD_RET_FAILURE;
 749         }
 750
 751         if (strcmp(cmd, "biterr") == 0) {
 752                 /* todo */
 753                 return CMD_RET_FAILURE;
 754         }
 755
 756 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
 757         if (strcmp(cmd, "lock") == 0) {
 758                 int tight = 0;
 759                 int status = 0;
 760                 if (argc == 3) {
 761                         if (!strcmp("tight", argv[2]))
 762                                 tight = 1;
 763                         if (!strcmp("status", argv[2]))
 764                                 status = 1;
 765                 }
 766                 if (status) {
 767                         do_nand_status(nand);
 768                 } else {
 769                         if (!nand_lock(nand, tight)) {
 770                                 puts("NAND flash successfully locked\n");
 771                         } else {
 772                                 puts("Error locking NAND flash\n");
 773                                 return CMD_RET_FAILURE;
 774                         }
 775                 }
 776                 return CMD_RET_SUCCESS;
 777         }
 778
 779         if (strncmp(cmd, "unlock", 5) == 0) {
 780                 int allexcept = 0;
 781
 782                 s = strchr(cmd, '.');
 783
 784                 if (s && !strcmp(s, ".allexcept"))
 785                         allexcept = 1;
 786
 787                 if (arg_off_size(argc - 2, argv + 2, &dev, &off, &size) < 0)
 788                         return CMD_RET_FAILURE;
 789
 790                 if (!nand_unlock(&nand_info[dev], off, size, allexcept)) {
 791                         puts("NAND flash successfully unlocked\n");
 792                 } else {
 793                         puts("Error unlocking NAND flash, "
 794                              "write and erase will probably fail\n");
 795                         return CMD_RET_FAILURE;
 796                 }
 797                 return CMD_RET_SUCCESS;
 798         }
 799 #endif
 800
 801 usage:
 802         return CMD_RET_USAGE;
 803 }
 804
 805 #ifdef CONFIG_SYS_LONGHELP
 806 static char nand_help_text[] =
 807         "info - show available NAND devices\n"
 808         "nand device [dev] - show or set current device\n"
 809         "nand read - addr off|partition size\n"
 810         "nand write - addr off|partition size\n"
 811         "    read/write 'size' bytes starting at offset 'off'\n"
 812         "    to/from memory address 'addr', skipping bad blocks.\n"
 813         "nand read.raw - addr off|partition [count]\n"
 814         "nand write.raw - addr off|partition [count]\n"
 815         "    Use read.raw/write.raw to avoid ECC and access the flash as-is.\n"
 816 #ifdef CONFIG_CMD_NAND_TRIMFFS
 817         "nand write.trimffs - addr off|partition size\n"
 818         "    write 'size' bytes starting at offset 'off' from memory address\n"
 819         "    'addr', skipping bad blocks and dropping any pages at the end\n"
 820         "    of eraseblocks that contain only 0xFF\n"
 821 #endif
 822 #ifdef CONFIG_CMD_NAND_YAFFS
 823         "nand write.yaffs - addr off|partition size\n"
 824         "    write 'size' bytes starting at offset 'off' with yaffs format\n"
 825         "    from memory address 'addr', skipping bad blocks.\n"
 826 #endif
 827         "nand erase[.spread] [clean] off size - erase 'size' bytes "
 828         "from offset 'off'\n"
 829         "    With '.spread', erase enough for given file size, otherwise,\n"
 830         "    'size' includes skipped bad blocks.\n"
 831         "nand erase.part [clean] partition - erase entire mtd partition'\n"
 832         "nand erase.chip [clean] - erase entire chip'\n"
 833         "nand bad - show bad blocks\n"
 834         "nand dump[.oob] off - dump page\n"
 835 #ifdef CONFIG_CMD_NAND_TORTURE
 836         "nand torture off - torture block at offset\n"
 837 #endif
 838         "nand scrub [-y] off size | scrub.part partition | scrub.chip\n"
 839         "    really clean NAND erasing bad blocks (UNSAFE)\n"
 840         "nand markbad off [...] - mark bad block(s) at offset (UNSAFE)\n"
 841         "nand biterr off - make a bit error at offset (UNSAFE)"
 842 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
 843         "\n"
 844         "nand lock [tight] [status]\n"
 845         "    bring nand to lock state or display locked pages\n"
 846         "nand unlock[.allexcept] [offset] [size] - unlock section"
 847 #endif
 848 #ifdef CONFIG_ENV_OFFSET_OOB
 849         "\n"
 850         "nand env.oob - environment offset in OOB of block 0 of"
 851         "    first device.\n"
 852         "nand env.oob set off|partition - set enviromnent offset\n"
 853         "nand env.oob get - get environment offset"
 854 #endif
 855         "";
 856 #endif
 857
 858 U_BOOT_CMD(
 859         nand, CONFIG_SYS_MAXARGS, 1, do_nand,
 860         "NAND sub-system", nand_help_text
 861 );
 862
 863 static int nand_load_image(cmd_tbl_t *cmdtp, nand_info_t *nand,
 864                            ulong offset, ulong addr, char *cmd)
 865 {
 866         int r;
 867         char *s;
 868         size_t cnt;
 869         image_header_t *hdr;
 870 #if defined(CONFIG_FIT)
 871         const void *fit_hdr = NULL;
 872 #endif
 873
 874         s = strchr(cmd, '.');
 875         if (s != NULL &&
 876             (strcmp(s, ".jffs2") && strcmp(s, ".e") && strcmp(s, ".i"))) {
 877                 printf("Unknown nand load suffix '%s'\n", s);
 878                 bootstage_error(BOOTSTAGE_ID_NAND_SUFFIX);
 879                 return 1;
 880         }
 881
 882         printf("\nLoading from %s, offset 0x%lx\n", nand->name, offset);
 883
 884         cnt = nand->writesize;
 885         r = nand_read_skip_bad(nand, offset, &cnt, (u_char *) addr);
 886         if (r) {
 887                 puts("** Read error\n");
 888                 bootstage_error(BOOTSTAGE_ID_NAND_HDR_READ);
 889                 return 1;
 890         }
 891         bootstage_mark(BOOTSTAGE_ID_NAND_HDR_READ);
 892
 893         switch (genimg_get_format ((void *)addr)) {
 894         case IMAGE_FORMAT_LEGACY:
 895                 hdr = (image_header_t *)addr;
 896
 897                 bootstage_mark(BOOTSTAGE_ID_NAND_TYPE);
 898                 image_print_contents (hdr);
 899
 900                 cnt = image_get_image_size (hdr);
 901                 break;
 902 #if defined(CONFIG_FIT)
 903         case IMAGE_FORMAT_FIT:
 904                 fit_hdr = (const void *)addr;
 905                 puts ("Fit image detected...\n");
 906
 907                 cnt = fit_get_size (fit_hdr);
 908                 break;
 909 #endif
 910         default:
 911                 bootstage_error(BOOTSTAGE_ID_NAND_TYPE);
 912                 puts ("** Unknown image type\n");
 913                 return 1;
 914         }
 915         bootstage_mark(BOOTSTAGE_ID_NAND_TYPE);
 916
 917         r = nand_read_skip_bad(nand, offset, &cnt, (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 );