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  * Added 16-bit nand support
   8  * (C) 2004 Texas Instruments
   9  */
  10
  11 #include <common.h>
  12
  13
  14 #ifndef CFG_NAND_LEGACY
  15 /*
  16  *
  17  * New NAND support
  18  *
  19  */
  20 #include <common.h>
  21 #include <linux/mtd/mtd.h>
  22
  23 #if defined(CONFIG_CMD_NAND)
  24
  25 #include <command.h>
  26 #include <watchdog.h>
  27 #include <malloc.h>
  28 #include <asm/byteorder.h>
  29 #include <jffs2/jffs2.h>
  30 #include <nand.h>
  31
  32 #if defined(CONFIG_CMD_JFFS2) && defined(CONFIG_JFFS2_CMDLINE)
  33
  34 /* parition handling routines */
  35 int mtdparts_init(void);
  36 int id_parse(const char *id, const char **ret_id, u8 *dev_type, u8 *dev_num);
  37 int find_dev_and_part(const char *id, struct mtd_device **dev,
  38                       u8 *part_num, struct part_info **part);
  39 #endif
  40
  41 static int nand_dump(nand_info_t *nand, ulong off, int only_oob)
  42 {
  43         int i;
  44         u_char *datbuf, *oobbuf, *p;
  45
  46         datbuf = malloc(nand->writesize + nand->oobsize);
  47         oobbuf = malloc(nand->oobsize);
  48         if (!datbuf || !oobbuf) {
  49                 puts("No memory for page buffer\n");
  50                 return 1;
  51         }
  52         off &= ~(nand->writesize - 1);
  53         size_t dummy;
  54         loff_t addr = (loff_t) off;
  55         struct mtd_oob_ops ops;
  56         memset(&ops, 0, sizeof(ops));
  57         ops.datbuf = datbuf;
  58         ops.oobbuf = oobbuf; /* must exist, but oob data will be appended to ops.datbuf */
  59         ops.len = nand->writesize;
  60         ops.ooblen = nand->oobsize;
  61         ops.mode = MTD_OOB_RAW;
  62         i = nand->read_oob(nand, addr, &ops);
  63         if (i < 0) {
  64                 printf("Error (%d) reading page %08lx\n", i, off);
  65                 free(datbuf);
  66                 free(oobbuf);
  67                 return 1;
  68         }
  69         printf("Page %08lx dump:\n", off);
  70         i = nand->writesize >> 4;
  71         p = datbuf;
  72
  73         while (i--) {
  74                 if (!only_oob)
  75                         printf("\t%02x %02x %02x %02x %02x %02x %02x %02x"
  76                                "  %02x %02x %02x %02x %02x %02x %02x %02x\n",
  77                                p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7],
  78                                p[8], p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
  79                 p += 16;
  80         }
  81         puts("OOB:\n");
  82         i = nand->oobsize >> 3;
  83         while (i--) {
  84                 printf("\t%02x %02x %02x %02x %02x %02x %02x %02x\n",
  85                        p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7]);
  86                 p += 8;
  87         }
  88         free(datbuf);
  89         free(oobbuf);
  90
  91         return 0;
  92 }
  93
  94 /* ------------------------------------------------------------------------- */
  95
  96 static inline int str2long(char *p, ulong *num)
  97 {
  98         char *endptr;
  99
 100         *num = simple_strtoul(p, &endptr, 16);
 101         return (*p != '\0' && *endptr == '\0') ? 1 : 0;
 102 }
 103
 104 static int
 105 arg_off_size(int argc, char *argv[], nand_info_t *nand, ulong *off, size_t *size)
 106 {
 107         int idx = nand_curr_device;
 108 #if defined(CONFIG_CMD_JFFS2) && defined(CONFIG_JFFS2_CMDLINE)
 109         struct mtd_device *dev;
 110         struct part_info *part;
 111         u8 pnum;
 112
 113         if (argc >= 1 && !(str2long(argv[0], off))) {
 114                 if ((mtdparts_init() == 0) &&
 115                     (find_dev_and_part(argv[0], &dev, &pnum, &part) == 0)) {
 116                         if (dev->id->type != MTD_DEV_TYPE_NAND) {
 117                                 puts("not a NAND device\n");
 118                                 return -1;
 119                         }
 120                         *off = part->offset;
 121                         if (argc >= 2) {
 122                                 if (!(str2long(argv[1], (ulong *)size))) {
 123                                         printf("'%s' is not a number\n", argv[1]);
 124                                         return -1;
 125                                 }
 126                                 if (*size > part->size)
 127                                         *size = part->size;
 128                         } else {
 129                                 *size = part->size;
 130                         }
 131                         idx = dev->id->num;
 132                         *nand = nand_info[idx];
 133                         goto out;
 134                 }
 135         }
 136 #endif
 137
 138         if (argc >= 1) {
 139                 if (!(str2long(argv[0], off))) {
 140                         printf("'%s' is not a number\n", argv[0]);
 141                         return -1;
 142                 }
 143         } else {
 144                 *off = 0;
 145         }
 146
 147         if (argc >= 2) {
 148                 if (!(str2long(argv[1], (ulong *)size))) {
 149                         printf("'%s' is not a number\n", argv[1]);
 150                         return -1;
 151                 }
 152         } else {
 153                 *size = nand->size - *off;
 154         }
 155
 156 #if  defined(CONFIG_CMD_JFFS2) && defined(CONFIG_JFFS2_CMDLINE)
 157 out:
 158 #endif
 159         printf("device %d ", idx);
 160         if (*size == nand->size)
 161                 puts("whole chip\n");
 162         else
 163                 printf("offset 0x%lx, size 0x%x\n", *off, *size);
 164         return 0;
 165 }
 166
 167 int do_nand(cmd_tbl_t * cmdtp, int flag, int argc, char *argv[])
 168 {
 169         int i, dev, ret = 0;
 170         ulong addr, off;
 171         size_t size;
 172         char *cmd, *s;
 173         nand_info_t *nand;
 174 #ifdef CFG_NAND_QUIET
 175         int quiet = CFG_NAND_QUIET;
 176 #else
 177         int quiet = 0;
 178 #endif
 179         const char *quiet_str = getenv("quiet");
 180
 181         /* at least two arguments please */
 182         if (argc < 2)
 183                 goto usage;
 184
 185         if (quiet_str)
 186                 quiet = simple_strtoul(quiet_str, NULL, 0) != 0;
 187
 188         cmd = argv[1];
 189
 190         if (strcmp(cmd, "info") == 0) {
 191
 192                 putc('\n');
 193                 for (i = 0; i < CFG_MAX_NAND_DEVICE; i++) {
 194                         if (nand_info[i].name)
 195                                 printf("Device %d: %s, sector size %u KiB\n",
 196                                        i, nand_info[i].name,
 197                                        nand_info[i].erasesize >> 10);
 198                 }
 199                 return 0;
 200         }
 201
 202         if (strcmp(cmd, "device") == 0) {
 203
 204                 if (argc < 3) {
 205                         if ((nand_curr_device < 0) ||
 206                             (nand_curr_device >= CFG_MAX_NAND_DEVICE))
 207                                 puts("\nno devices available\n");
 208                         else
 209                                 printf("\nDevice %d: %s\n", nand_curr_device,
 210                                        nand_info[nand_curr_device].name);
 211                         return 0;
 212                 }
 213                 dev = (int)simple_strtoul(argv[2], NULL, 10);
 214                 if (dev < 0 || dev >= CFG_MAX_NAND_DEVICE || !nand_info[dev].name) {
 215                         puts("No such device\n");
 216                         return 1;
 217                 }
 218                 printf("Device %d: %s", dev, nand_info[dev].name);
 219                 puts("... is now current device\n");
 220                 nand_curr_device = dev;
 221
 222 #ifdef CFG_NAND_SELECT_DEVICE
 223                 /*
 224                  * Select the chip in the board/cpu specific driver
 225                  */
 226                 board_nand_select_device(nand_info[dev].priv, dev);
 227 #endif
 228
 229                 return 0;
 230         }
 231
 232         if (strcmp(cmd, "bad") != 0 && strcmp(cmd, "erase") != 0 &&
 233             strncmp(cmd, "dump", 4) != 0 &&
 234             strncmp(cmd, "read", 4) != 0 && strncmp(cmd, "write", 5) != 0 &&
 235             strcmp(cmd, "scrub") != 0 && strcmp(cmd, "markbad") != 0 &&
 236             strcmp(cmd, "biterr") != 0 &&
 237             strcmp(cmd, "lock") != 0 && strcmp(cmd, "unlock") != 0 )
 238                 goto usage;
 239
 240         /* the following commands operate on the current device */
 241         if (nand_curr_device < 0 || nand_curr_device >= CFG_MAX_NAND_DEVICE ||
 242             !nand_info[nand_curr_device].name) {
 243                 puts("\nno devices available\n");
 244                 return 1;
 245         }
 246         nand = &nand_info[nand_curr_device];
 247
 248         if (strcmp(cmd, "bad") == 0) {
 249                 printf("\nDevice %d bad blocks:\n", nand_curr_device);
 250                 for (off = 0; off < nand->size; off += nand->erasesize)
 251                         if (nand_block_isbad(nand, off))
 252                                 printf("  %08lx\n", off);
 253                 return 0;
 254         }
 255
 256         /*
 257          * Syntax is:
 258          *   0    1     2       3    4
 259          *   nand erase [clean] [off size]
 260          */
 261         if (strcmp(cmd, "erase") == 0 || strcmp(cmd, "scrub") == 0) {
 262                 nand_erase_options_t opts;
 263                 /* "clean" at index 2 means request to write cleanmarker */
 264                 int clean = argc > 2 && !strcmp("clean", argv[2]);
 265                 int o = clean ? 3 : 2;
 266                 int scrub = !strcmp(cmd, "scrub");
 267
 268                 printf("\nNAND %s: ", scrub ? "scrub" : "erase");
 269                 /* skip first two or three arguments, look for offset and size */
 270                 if (arg_off_size(argc - o, argv + o, nand, &off, &size) != 0)
 271                         return 1;
 272
 273                 memset(&opts, 0, sizeof(opts));
 274                 opts.offset = off;
 275                 opts.length = size;
 276                 opts.jffs2  = clean;
 277                 opts.quiet  = quiet;
 278
 279                 if (scrub) {
 280                         puts("Warning: "
 281                              "scrub option will erase all factory set "
 282                              "bad blocks!\n"
 283                              "         "
 284                              "There is no reliable way to recover them.\n"
 285                              "         "
 286                              "Use this command only for testing purposes "
 287                              "if you\n"
 288                              "         "
 289                              "are sure of what you are doing!\n"
 290                              "\nReally scrub this NAND flash? <y/N>\n");
 291
 292                         if (getc() == 'y' && getc() == '\r') {
 293                                 opts.scrub = 1;
 294                         } else {
 295                                 puts("scrub aborted\n");
 296                                 return -1;
 297                         }
 298                 }
 299                 ret = nand_erase_opts(nand, &opts);
 300                 printf("%s\n", ret ? "ERROR" : "OK");
 301
 302                 return ret == 0 ? 0 : 1;
 303         }
 304
 305         if (strncmp(cmd, "dump", 4) == 0) {
 306                 if (argc < 3)
 307                         goto usage;
 308
 309                 s = strchr(cmd, '.');
 310                 off = (int)simple_strtoul(argv[2], NULL, 16);
 311
 312                 if (s != NULL && strcmp(s, ".oob") == 0)
 313                         ret = nand_dump(nand, off, 1);
 314                 else
 315                         ret = nand_dump(nand, off, 0);
 316
 317                 return ret == 0 ? 1 : 0;
 318
 319         }
 320
 321         /* read write */
 322         if (strncmp(cmd, "read", 4) == 0 || strncmp(cmd, "write", 5) == 0) {
 323                 int read;
 324
 325                 if (argc < 4)
 326                         goto usage;
 327
 328                 addr = (ulong)simple_strtoul(argv[2], NULL, 16);
 329
 330                 read = strncmp(cmd, "read", 4) == 0; /* 1 = read, 0 = write */
 331                 printf("\nNAND %s: ", read ? "read" : "write");
 332                 if (arg_off_size(argc - 3, argv + 3, nand, &off, &size) != 0)
 333                         return 1;
 334
 335                 s = strchr(cmd, '.');
 336                 if (s != NULL &&
 337                     (!strcmp(s, ".jffs2") || !strcmp(s, ".e") || !strcmp(s, ".i"))) {
 338                         if (read) {
 339                                 /* read */
 340                                 nand_read_options_t opts;
 341                                 memset(&opts, 0, sizeof(opts));
 342                                 opts.buffer = (u_char*) addr;
 343                                 opts.length = size;
 344                                 opts.offset = off;
 345                                 opts.quiet = quiet;
 346 /*
 347  *  ! BROKEN !
 348  *
 349  *  TODO: Function must be implemented
 350  *
 351  *                              ret = nand_read_opts(nand, &opts);
 352  */
 353                         } else {
 354                                 /* write */
 355                                 mtd_oob_ops_t opts;
 356                                 memset(&opts, 0, sizeof(opts));
 357                                 opts.datbuf = (u_char*) addr;
 358                                 opts.len = size;
 359                                 opts.ooblen = 64;
 360                                 opts.mode = MTD_OOB_AUTO;
 361                                 ret = nand_write_opts(nand, off, &opts);
 362                         }
 363                 } else if (s != NULL && !strcmp(s, ".oob")) {
 364                         /* out-of-band data */
 365                         mtd_oob_ops_t ops = {
 366                                 .oobbuf = (u8 *)addr,
 367                                 .ooblen = size,
 368                                 .mode = MTD_OOB_RAW
 369                         };
 370
 371                         if (read)
 372                                 ret = nand->read_oob(nand, off, &ops);
 373                         else
 374                                 ret = nand->write_oob(nand, off, &ops);
 375                 } else {
 376                         if (read)
 377                                 ret = nand_read(nand, off, &size, (u_char *)addr);
 378                         else
 379                                 ret = nand_write(nand, off, &size, (u_char *)addr);
 380                 }
 381
 382                 printf(" %d bytes %s: %s\n", size,
 383                        read ? "read" : "written", ret ? "ERROR" : "OK");
 384
 385                 return ret == 0 ? 0 : 1;
 386         }
 387
 388         if (strcmp(cmd, "markbad") == 0) {
 389                 addr = (ulong)simple_strtoul(argv[2], NULL, 16);
 390
 391                 int ret = nand->block_markbad(nand, addr);
 392                 if (ret == 0) {
 393                         printf("block 0x%08lx successfully marked as bad\n",
 394                                (ulong) addr);
 395                         return 0;
 396                 } else {
 397                         printf("block 0x%08lx NOT marked as bad! ERROR %d\n",
 398                                (ulong) addr, ret);
 399                 }
 400                 return 1;
 401         }
 402         if (strcmp(cmd, "biterr") == 0) {
 403                 /* todo */
 404                 return 1;
 405         }
 406
 407         if (strcmp(cmd, "lock") == 0) {
 408                 int tight  = 0;
 409                 int status = 0;
 410                 if (argc == 3) {
 411                         if (!strcmp("tight", argv[2]))
 412                                 tight = 1;
 413                         if (!strcmp("status", argv[2]))
 414                                 status = 1;
 415                 }
 416 /*
 417  * ! BROKEN !
 418  *
 419  * TODO: must be implemented and tested by someone with HW
 420  */
 421 #if 0
 422                 if (status) {
 423                         ulong block_start = 0;
 424                         ulong off;
 425                         int last_status = -1;
 426
 427                         struct nand_chip *nand_chip = nand->priv;
 428                         /* check the WP bit */
 429                         nand_chip->cmdfunc (nand, NAND_CMD_STATUS, -1, -1);
 430                         printf("device is %swrite protected\n",
 431                                (nand_chip->read_byte(nand) & 0x80 ?
 432                                "NOT " : ""));
 433
 434                         for (off = 0; off < nand->size; off += nand->writesize) {
 435                                 int s = nand_get_lock_status(nand, off);
 436
 437                                 /* print message only if status has changed
 438                                  * or at end of chip
 439                                  */
 440                                 if (off == nand->size - nand->writesize
 441                                     || (s != last_status && off != 0))  {
 442
 443                                         printf("%08lx - %08lx: %8d pages %s%s%s\n",
 444                                                block_start,
 445                                                off-1,
 446                                                (off-block_start)/nand->writesize,
 447                                                ((last_status & NAND_LOCK_STATUS_TIGHT) ? "TIGHT " : ""),
 448                                                ((last_status & NAND_LOCK_STATUS_LOCK) ? "LOCK " : ""),
 449                                                ((last_status & NAND_LOCK_STATUS_UNLOCK) ? "UNLOCK " : ""));
 450                                 }
 451
 452                                 last_status = s;
 453                         }
 454                 } else {
 455                         if (!nand_lock(nand, tight)) {
 456                                 puts("NAND flash successfully locked\n");
 457                         } else {
 458                                 puts("Error locking NAND flash\n");
 459                                 return 1;
 460                         }
 461                 }
 462 #endif
 463                 return 0;
 464         }
 465
 466         if (strcmp(cmd, "unlock") == 0) {
 467                 if (arg_off_size(argc - 2, argv + 2, nand, &off, &size) < 0)
 468                         return 1;
 469
 470 /*
 471  * ! BROKEN !
 472  *
 473  * TODO: must be implemented and tested by someone with HW
 474  */
 475 #if 0
 476                 if (!nand_unlock(nand, off, size)) {
 477                         puts("NAND flash successfully unlocked\n");
 478                 } else {
 479                         puts("Error unlocking NAND flash, "
 480                              "write and erase will probably fail\n");
 481                         return 1;
 482                 }
 483 #endif
 484                 return 0;
 485         }
 486
 487 usage:
 488         printf("Usage:\n%s\n", cmdtp->usage);
 489         return 1;
 490 }
 491
 492 U_BOOT_CMD(nand, 5, 1, do_nand,
 493            "nand - NAND sub-system\n",
 494            "info - show available NAND devices\n"
 495            "nand device [dev] - show or set current device\n"
 496            "nand read[.jffs2] - addr off|partition size\n"
 497            "nand write[.jffs2] - addr off|partition size\n"
 498            "    read/write 'size' bytes starting at offset 'off'\n"
 499            "    to/from memory address 'addr'\n"
 500            "nand erase [clean] [off size] - erase 'size' bytes from\n"
 501            "    offset 'off' (entire device if not specified)\n"
 502            "nand bad - show bad blocks\n"
 503            "nand dump[.oob] off - dump page\n"
 504            "nand scrub - really clean NAND erasing bad blocks (UNSAFE)\n"
 505            "nand markbad off - mark bad block at offset (UNSAFE)\n"
 506            "nand biterr off - make a bit error at offset (UNSAFE)\n"
 507            "nand lock [tight] [status]\n"
 508            "    bring nand to lock state or display locked pages\n"
 509            "nand unlock [offset] [size] - unlock section\n");
 510
 511 static int nand_load_image(cmd_tbl_t *cmdtp, nand_info_t *nand,
 512                            ulong offset, ulong addr, char *cmd)
 513 {
 514         int r;
 515         char *ep, *s;
 516         size_t cnt;
 517         image_header_t *hdr;
 518         int jffs2 = 0;
 519 #if defined(CONFIG_FIT)
 520         const void *fit_hdr = NULL;
 521 #endif
 522
 523         s = strchr(cmd, '.');
 524         if (s != NULL &&
 525             (!strcmp(s, ".jffs2") || !strcmp(s, ".e") || !strcmp(s, ".i")))
 526                 jffs2 = 1;
 527
 528         printf("\nLoading from %s, offset 0x%lx\n", nand->name, offset);
 529
 530         cnt = nand->writesize;
 531         r = nand_read(nand, offset, &cnt, (u_char *) addr);
 532         if (r) {
 533                 puts("** Read error\n");
 534                 show_boot_progress (-56);
 535                 return 1;
 536         }
 537         show_boot_progress (56);
 538
 539         switch (genimg_get_format ((void *)addr)) {
 540         case IMAGE_FORMAT_LEGACY:
 541                 hdr = (image_header_t *)addr;
 542
 543                 show_boot_progress (57);
 544                 image_print_contents (hdr);
 545
 546                 cnt = image_get_image_size (hdr);
 547                 break;
 548 #if defined(CONFIG_FIT)
 549         case IMAGE_FORMAT_FIT:
 550                 fit_hdr = (const void *)addr;
 551                 puts ("Fit image detected...\n");
 552
 553                 cnt = fit_get_size (fit_hdr);
 554                 break;
 555 #endif
 556         default:
 557                 show_boot_progress (-57);
 558                 puts ("** Unknown image type\n");
 559                 return 1;
 560         }
 561         show_boot_progress (57);
 562
 563         r = nand_read(nand, offset, &cnt, (u_char *) addr);
 564         if (r) {
 565                 puts("** Read error\n");
 566                 show_boot_progress (-58);
 567                 return 1;
 568         }
 569         show_boot_progress (58);
 570
 571 #if defined(CONFIG_FIT)
 572         /* This cannot be done earlier, we need complete FIT image in RAM first */
 573         if (genimg_get_format ((void *)addr) == IMAGE_FORMAT_FIT) {
 574                 if (!fit_check_format (fit_hdr)) {
 575                         show_boot_progress (-150);
 576                         puts ("** Bad FIT image format\n");
 577                         return 1;
 578                 }
 579                 show_boot_progress (151);
 580                 fit_print_contents (fit_hdr);
 581         }
 582 #endif
 583
 584         /* Loading ok, update default load address */
 585
 586         load_addr = addr;
 587
 588         /* Check if we should attempt an auto-start */
 589         if (((ep = getenv("autostart")) != NULL) && (strcmp(ep, "yes") == 0)) {
 590                 char *local_args[2];
 591                 extern int do_bootm(cmd_tbl_t *, int, int, char *[]);
 592
 593                 local_args[0] = cmd;
 594                 local_args[1] = NULL;
 595
 596                 printf("Automatic boot of image at addr 0x%08lx ...\n", addr);
 597
 598                 do_bootm(cmdtp, 0, 1, local_args);
 599                 return 1;
 600         }
 601         return 0;
 602 }
 603
 604 int do_nandboot(cmd_tbl_t * cmdtp, int flag, int argc, char *argv[])
 605 {
 606         char *boot_device = NULL;
 607         int idx;
 608         ulong addr, offset = 0;
 609 #if defined(CONFIG_CMD_JFFS2) && defined(CONFIG_JFFS2_CMDLINE)
 610         struct mtd_device *dev;
 611         struct part_info *part;
 612         u8 pnum;
 613
 614         if (argc >= 2) {
 615                 char *p = (argc == 2) ? argv[1] : argv[2];
 616                 if (!(str2long(p, &addr)) && (mtdparts_init() == 0) &&
 617                     (find_dev_and_part(p, &dev, &pnum, &part) == 0)) {
 618                         if (dev->id->type != MTD_DEV_TYPE_NAND) {
 619                                 puts("Not a NAND device\n");
 620                                 return 1;
 621                         }
 622                         if (argc > 3)
 623                                 goto usage;
 624                         if (argc == 3)
 625                                 addr = simple_strtoul(argv[1], NULL, 16);
 626                         else
 627                                 addr = CFG_LOAD_ADDR;
 628                         return nand_load_image(cmdtp, &nand_info[dev->id->num],
 629                                                part->offset, addr, argv[0]);
 630                 }
 631         }
 632 #endif
 633
 634         show_boot_progress(52);
 635         switch (argc) {
 636         case 1:
 637                 addr = CFG_LOAD_ADDR;
 638                 boot_device = getenv("bootdevice");
 639                 break;
 640         case 2:
 641                 addr = simple_strtoul(argv[1], NULL, 16);
 642                 boot_device = getenv("bootdevice");
 643                 break;
 644         case 3:
 645                 addr = simple_strtoul(argv[1], NULL, 16);
 646                 boot_device = argv[2];
 647                 break;
 648         case 4:
 649                 addr = simple_strtoul(argv[1], NULL, 16);
 650                 boot_device = argv[2];
 651                 offset = simple_strtoul(argv[3], NULL, 16);
 652                 break;
 653         default:
 654 #if defined(CONFIG_CMD_JFFS2) && defined(CONFIG_JFFS2_CMDLINE)
 655 usage:
 656 #endif
 657                 printf("Usage:\n%s\n", cmdtp->usage);
 658                 show_boot_progress(-53);
 659                 return 1;
 660         }
 661
 662         show_boot_progress(53);
 663         if (!boot_device) {
 664                 puts("\n** No boot device **\n");
 665                 show_boot_progress(-54);
 666                 return 1;
 667         }
 668         show_boot_progress(54);
 669
 670         idx = simple_strtoul(boot_device, NULL, 16);
 671
 672         if (idx < 0 || idx >= CFG_MAX_NAND_DEVICE || !nand_info[idx].name) {
 673                 printf("\n** Device %d not available\n", idx);
 674                 show_boot_progress(-55);
 675                 return 1;
 676         }
 677         show_boot_progress(55);
 678
 679         return nand_load_image(cmdtp, &nand_info[idx], offset, addr, argv[0]);
 680 }
 681
 682 U_BOOT_CMD(nboot, 4, 1, do_nandboot,
 683         "nboot   - boot from NAND device\n",
 684         "[.jffs2] [partition] | [[[loadAddr] dev] offset]\n");
 685
 686 #endif
 687
 688 #else /* CFG_NAND_LEGACY */
 689 /*
 690  *
 691  * Legacy NAND support - to be phased out
 692  *
 693  */
 694 #include <command.h>
 695 #include <malloc.h>
 696 #include <asm/io.h>
 697 #include <watchdog.h>
 698
 699 #ifdef CONFIG_show_boot_progress
 700 # include <status_led.h>
 701 # define show_boot_progress(arg)        show_boot_progress(arg)
 702 #else
 703 # define show_boot_progress(arg)
 704 #endif
 705
 706 #if defined(CONFIG_CMD_NAND)
 707 #include <linux/mtd/nand_legacy.h>
 708 #if 0
 709 #include <linux/mtd/nand_ids.h>
 710 #include <jffs2/jffs2.h>
 711 #endif
 712
 713 #ifdef CONFIG_OMAP1510
 714 void archflashwp(void *archdata, int wp);
 715 #endif
 716
 717 #define ROUND_DOWN(value,boundary)      ((value) & (~((boundary)-1)))
 718
 719 #undef  NAND_DEBUG
 720 #undef  PSYCHO_DEBUG
 721
 722 /* ****************** WARNING *********************
 723  * When ALLOW_ERASE_BAD_DEBUG is non-zero the erase command will
 724  * erase (or at least attempt to erase) blocks that are marked
 725  * bad. This can be very handy if you are _sure_ that the block
 726  * is OK, say because you marked a good block bad to test bad
 727  * block handling and you are done testing, or if you have
 728  * accidentally marked blocks bad.
 729  *
 730  * Erasing factory marked bad blocks is a _bad_ idea. If the
 731  * erase succeeds there is no reliable way to find them again,
 732  * and attempting to program or erase bad blocks can affect
 733  * the data in _other_ (good) blocks.
 734  */
 735 #define  ALLOW_ERASE_BAD_DEBUG 0
 736
 737 #define CONFIG_MTD_NAND_ECC  /* enable ECC */
 738 #define CONFIG_MTD_NAND_ECC_JFFS2
 739
 740 /* bits for nand_legacy_rw() `cmd'; or together as needed */
 741 #define NANDRW_READ         0x01
 742 #define NANDRW_WRITE        0x00
 743 #define NANDRW_JFFS2        0x02
 744 #define NANDRW_JFFS2_SKIP   0x04
 745
 746 /*
 747  * Imports from nand_legacy.c
 748  */
 749 extern struct nand_chip nand_dev_desc[CFG_MAX_NAND_DEVICE];
 750 extern int curr_device;
 751 extern int nand_legacy_erase(struct nand_chip *nand, size_t ofs,
 752                             size_t len, int clean);
 753 extern int nand_legacy_rw(struct nand_chip *nand, int cmd, size_t start,
 754                          size_t len, size_t *retlen, u_char *buf);
 755 extern void nand_print(struct nand_chip *nand);
 756 extern void nand_print_bad(struct nand_chip *nand);
 757 extern int nand_read_oob(struct nand_chip *nand, size_t ofs,
 758                                size_t len, size_t *retlen, u_char *buf);
 759 extern int nand_write_oob(struct nand_chip *nand, size_t ofs,
 760                                 size_t len, size_t *retlen, const u_char *buf);
 761
 762
 763 int do_nand (cmd_tbl_t * cmdtp, int flag, int argc, char *argv[])
 764 {
 765         int rcode = 0;
 766
 767         switch (argc) {
 768         case 0:
 769         case 1:
 770                 printf ("Usage:\n%s\n", cmdtp->usage);
 771                 return 1;
 772         case 2:
 773                 if (strcmp (argv[1], "info") == 0) {
 774                         int i;
 775
 776                         putc ('\n');
 777
 778                         for (i = 0; i < CFG_MAX_NAND_DEVICE; ++i) {
 779                                 if (nand_dev_desc[i].ChipID ==
 780                                     NAND_ChipID_UNKNOWN)
 781                                         continue;       /* list only known devices */
 782                                 printf ("Device %d: ", i);
 783                                 nand_print (&nand_dev_desc[i]);
 784                         }
 785                         return 0;
 786
 787                 } else if (strcmp (argv[1], "device") == 0) {
 788                         if ((curr_device < 0)
 789                             || (curr_device >= CFG_MAX_NAND_DEVICE)) {
 790                                 puts ("\nno devices available\n");
 791                                 return 1;
 792                         }
 793                         printf ("\nDevice %d: ", curr_device);
 794                         nand_print (&nand_dev_desc[curr_device]);
 795                         return 0;
 796
 797                 } else if (strcmp (argv[1], "bad") == 0) {
 798                         if ((curr_device < 0)
 799                             || (curr_device >= CFG_MAX_NAND_DEVICE)) {
 800                                 puts ("\nno devices available\n");
 801                                 return 1;
 802                         }
 803                         printf ("\nDevice %d bad blocks:\n", curr_device);
 804                         nand_print_bad (&nand_dev_desc[curr_device]);
 805                         return 0;
 806
 807                 }
 808                 printf ("Usage:\n%s\n", cmdtp->usage);
 809                 return 1;
 810         case 3:
 811                 if (strcmp (argv[1], "device") == 0) {
 812                         int dev = (int) simple_strtoul (argv[2], NULL, 10);
 813
 814                         printf ("\nDevice %d: ", dev);
 815                         if (dev >= CFG_MAX_NAND_DEVICE) {
 816                                 puts ("unknown device\n");
 817                                 return 1;
 818                         }
 819                         nand_print (&nand_dev_desc[dev]);
 820                         /*nand_print (dev); */
 821
 822                         if (nand_dev_desc[dev].ChipID == NAND_ChipID_UNKNOWN) {
 823                                 return 1;
 824                         }
 825
 826                         curr_device = dev;
 827
 828                         puts ("... is now current device\n");
 829
 830                         return 0;
 831                 } else if (strcmp (argv[1], "erase") == 0
 832                            && strcmp (argv[2], "clean") == 0) {
 833                         struct nand_chip *nand = &nand_dev_desc[curr_device];
 834                         ulong off = 0;
 835                         ulong size = nand->totlen;
 836                         int ret;
 837
 838                         printf ("\nNAND erase: device %d offset %ld, size %ld ... ", curr_device, off, size);
 839
 840                         ret = nand_legacy_erase (nand, off, size, 1);
 841
 842                         printf ("%s\n", ret ? "ERROR" : "OK");
 843
 844                         return ret;
 845                 }
 846
 847                 printf ("Usage:\n%s\n", cmdtp->usage);
 848                 return 1;
 849         default:
 850                 /* at least 4 args */
 851
 852                 if (strncmp (argv[1], "read", 4) == 0 ||
 853                     strncmp (argv[1], "write", 5) == 0) {
 854                         ulong addr = simple_strtoul (argv[2], NULL, 16);
 855                         off_t off = simple_strtoul (argv[3], NULL, 16);
 856                         size_t size = simple_strtoul (argv[4], NULL, 16);
 857                         int cmd = (strncmp (argv[1], "read", 4) == 0) ?
 858                                   NANDRW_READ : NANDRW_WRITE;
 859                         size_t total;
 860                         int ret;
 861                         char *cmdtail = strchr (argv[1], '.');
 862
 863                         if (cmdtail && !strncmp (cmdtail, ".oob", 2)) {
 864                                 /* read out-of-band data */
 865                                 if (cmd & NANDRW_READ) {
 866                                         ret = nand_read_oob (nand_dev_desc + curr_device,
 867                                                              off, size, &total,
 868                                                              (u_char *) addr);
 869                                 } else {
 870                                         ret = nand_write_oob (nand_dev_desc + curr_device,
 871                                                               off, size, &total,
 872                                                               (u_char *) addr);
 873                                 }
 874                                 return ret;
 875                         } else if (cmdtail && !strncmp (cmdtail, ".jffs2", 2))
 876                                 cmd |= NANDRW_JFFS2;    /* skip bad blocks */
 877                         else if (cmdtail && !strncmp (cmdtail, ".jffs2s", 2)) {
 878                                 cmd |= NANDRW_JFFS2;    /* skip bad blocks (on read too) */
 879                                 if (cmd & NANDRW_READ)
 880                                         cmd |= NANDRW_JFFS2_SKIP;       /* skip bad blocks (on read too) */
 881                         }
 882 #ifdef SXNI855T
 883                         /* need ".e" same as ".j" for compatibility with older units */
 884                         else if (cmdtail && !strcmp (cmdtail, ".e"))
 885                                 cmd |= NANDRW_JFFS2;    /* skip bad blocks */
 886 #endif
 887 #ifdef CFG_NAND_SKIP_BAD_DOT_I
 888                         /* need ".i" same as ".jffs2s" for compatibility with older units (esd) */
 889                         /* ".i" for image -> read skips bad block (no 0xff) */
 890                         else if (cmdtail && !strcmp (cmdtail, ".i")) {
 891                                 cmd |= NANDRW_JFFS2;    /* skip bad blocks (on read too) */
 892                                 if (cmd & NANDRW_READ)
 893                                         cmd |= NANDRW_JFFS2_SKIP;       /* skip bad blocks (on read too) */
 894                         }
 895 #endif /* CFG_NAND_SKIP_BAD_DOT_I */
 896                         else if (cmdtail) {
 897                                 printf ("Usage:\n%s\n", cmdtp->usage);
 898                                 return 1;
 899                         }
 900
 901                         printf ("\nNAND %s: device %d offset %ld, size %lu ...\n",
 902                                 (cmd & NANDRW_READ) ? "read" : "write",
 903                                 curr_device, off, (ulong)size);
 904
 905                         ret = nand_legacy_rw (nand_dev_desc + curr_device,
 906                                               cmd, off, size,
 907                                               &total, (u_char *) addr);
 908
 909                         printf (" %d bytes %s: %s\n", total,
 910                                 (cmd & NANDRW_READ) ? "read" : "written",
 911                                 ret ? "ERROR" : "OK");
 912
 913                         return ret;
 914                 } else if (strcmp (argv[1], "erase") == 0 &&
 915                            (argc == 4 || strcmp ("clean", argv[2]) == 0)) {
 916                         int clean = argc == 5;
 917                         ulong off =
 918                                 simple_strtoul (argv[2 + clean], NULL, 16);
 919                         ulong size =
 920                                 simple_strtoul (argv[3 + clean], NULL, 16);
 921                         int ret;
 922
 923                         printf ("\nNAND erase: device %d offset %ld, size %ld ...\n",
 924                                 curr_device, off, size);
 925
 926                         ret = nand_legacy_erase (nand_dev_desc + curr_device,
 927                                                  off, size, clean);
 928
 929                         printf ("%s\n", ret ? "ERROR" : "OK");
 930
 931                         return ret;
 932                 } else {
 933                         printf ("Usage:\n%s\n", cmdtp->usage);
 934                         rcode = 1;
 935                 }
 936
 937                 return rcode;
 938         }
 939 }
 940
 941 U_BOOT_CMD(
 942         nand,   5,      1,      do_nand,
 943         "nand    - legacy NAND sub-system\n",
 944         "info  - show available NAND devices\n"
 945         "nand device [dev] - show or set current device\n"
 946         "nand read[.jffs2[s]]  addr off size\n"
 947         "nand write[.jffs2] addr off size - read/write `size' bytes starting\n"
 948         "    at offset `off' to/from memory address `addr'\n"
 949         "nand erase [clean] [off size] - erase `size' bytes from\n"
 950         "    offset `off' (entire device if not specified)\n"
 951         "nand bad - show bad blocks\n"
 952         "nand read.oob addr off size - read out-of-band data\n"
 953         "nand write.oob addr off size - read out-of-band data\n"
 954 );
 955
 956 int do_nandboot (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
 957 {
 958         char *boot_device = NULL;
 959         char *ep;
 960         int dev;
 961         ulong cnt;
 962         ulong addr;
 963         ulong offset = 0;
 964         image_header_t *hdr;
 965         int rcode = 0;
 966 #if defined(CONFIG_FIT)
 967         const void *fit_hdr = NULL;
 968 #endif
 969
 970         show_boot_progress (52);
 971         switch (argc) {
 972         case 1:
 973                 addr = CFG_LOAD_ADDR;
 974                 boot_device = getenv ("bootdevice");
 975                 break;
 976         case 2:
 977                 addr = simple_strtoul(argv[1], NULL, 16);
 978                 boot_device = getenv ("bootdevice");
 979                 break;
 980         case 3:
 981                 addr = simple_strtoul(argv[1], NULL, 16);
 982                 boot_device = argv[2];
 983                 break;
 984         case 4:
 985                 addr = simple_strtoul(argv[1], NULL, 16);
 986                 boot_device = argv[2];
 987                 offset = simple_strtoul(argv[3], NULL, 16);
 988                 break;
 989         default:
 990                 printf ("Usage:\n%s\n", cmdtp->usage);
 991                 show_boot_progress (-53);
 992                 return 1;
 993         }
 994
 995         show_boot_progress (53);
 996         if (!boot_device) {
 997                 puts ("\n** No boot device **\n");
 998                 show_boot_progress (-54);
 999                 return 1;
1000         }
1001         show_boot_progress (54);
1002
1003         dev = simple_strtoul(boot_device, &ep, 16);
1004
1005         if ((dev >= CFG_MAX_NAND_DEVICE) ||
1006             (nand_dev_desc[dev].ChipID == NAND_ChipID_UNKNOWN)) {
1007                 printf ("\n** Device %d not available\n", dev);
1008                 show_boot_progress (-55);
1009                 return 1;
1010         }
1011         show_boot_progress (55);
1012
1013         printf ("\nLoading from device %d: %s at 0x%lx (offset 0x%lx)\n",
1014             dev, nand_dev_desc[dev].name, nand_dev_desc[dev].IO_ADDR,
1015             offset);
1016
1017         if (nand_legacy_rw (nand_dev_desc + dev, NANDRW_READ, offset,
1018                             SECTORSIZE, NULL, (u_char *)addr)) {
1019                 printf ("** Read error on %d\n", dev);
1020                 show_boot_progress (-56);
1021                 return 1;
1022         }
1023         show_boot_progress (56);
1024
1025         switch (genimg_get_format ((void *)addr)) {
1026         case IMAGE_FORMAT_LEGACY:
1027                 hdr = (image_header_t *)addr;
1028                 image_print_contents (hdr);
1029
1030                 cnt = image_get_image_size (hdr);
1031                 cnt -= SECTORSIZE;
1032                 break;
1033 #if defined(CONFIG_FIT)
1034         case IMAGE_FORMAT_FIT:
1035                 fit_hdr = (const void *)addr;
1036                 puts ("Fit image detected...\n");
1037
1038                 cnt = fit_get_size (fit_hdr);
1039                 break;
1040 #endif
1041         default:
1042                 show_boot_progress (-57);
1043                 puts ("** Unknown image type\n");
1044                 return 1;
1045         }
1046         show_boot_progress (57);
1047
1048         if (nand_legacy_rw (nand_dev_desc + dev, NANDRW_READ,
1049                             offset + SECTORSIZE, cnt, NULL,
1050                             (u_char *)(addr+SECTORSIZE))) {
1051                 printf ("** Read error on %d\n", dev);
1052                 show_boot_progress (-58);
1053                 return 1;
1054         }
1055         show_boot_progress (58);
1056
1057 #if defined(CONFIG_FIT)
1058         /* This cannot be done earlier, we need complete FIT image in RAM first */
1059         if (genimg_get_format ((void *)addr) == IMAGE_FORMAT_FIT) {
1060                 if (!fit_check_format (fit_hdr)) {
1061                         show_boot_progress (-150);
1062                         puts ("** Bad FIT image format\n");
1063                         return 1;
1064                 }
1065                 show_boot_progress (151);
1066                 fit_print_contents (fit_hdr);
1067         }
1068 #endif
1069
1070         /* Loading ok, update default load address */
1071
1072         load_addr = addr;
1073
1074         /* Check if we should attempt an auto-start */
1075         if (((ep = getenv("autostart")) != NULL) && (strcmp(ep,"yes") == 0)) {
1076                 char *local_args[2];
1077                 extern int do_bootm (cmd_tbl_t *, int, int, char *[]);
1078
1079                 local_args[0] = argv[0];
1080                 local_args[1] = NULL;
1081
1082                 printf ("Automatic boot of image at addr 0x%08lx ...\n", addr);
1083
1084                 do_bootm (cmdtp, 0, 1, local_args);
1085                 rcode = 1;
1086         }
1087         return rcode;
1088 }
1089
1090 U_BOOT_CMD(
1091         nboot,  4,      1,      do_nandboot,
1092         "nboot   - boot from NAND device\n",
1093         "loadAddr dev\n"
1094 );
1095
1096 #endif
1097
1098 #endif /* CFG_NAND_LEGACY */