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