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