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