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