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