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