xref: /openbmc/u-boot/cmd/nand.c (revision 9702ec00)
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  * Ported 'dynenv' to 'nand env.oob' command
8  * (C) 2010 Nanometrics, Inc.
9  * 'dynenv' -- Dynamic environment offset in NAND OOB
10  * (C) Copyright 2006-2007 OpenMoko, Inc.
11  * Added 16-bit nand support
12  * (C) 2004 Texas Instruments
13  *
14  * Copyright 2010, 2012 Freescale Semiconductor
15  * The portions of this file whose copyright is held by Freescale and which
16  * are not considered a derived work of GPL v2-only code may be distributed
17  * and/or modified under the terms of the GNU General Public License as
18  * published by the Free Software Foundation; either version 2 of the
19  * License, or (at your option) any later version.
20  */
21 
22 #include <common.h>
23 #include <linux/mtd/mtd.h>
24 #include <command.h>
25 #include <console.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_MTDPARTS)
33 
34 /* partition 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(struct mtd_info *mtd, ulong off, int only_oob,
42 		     int repeat)
43 {
44 	int i;
45 	u_char *datbuf, *oobbuf, *p;
46 	static loff_t last;
47 	int ret = 0;
48 
49 	if (repeat)
50 		off = last + mtd->writesize;
51 
52 	last = off;
53 
54 	datbuf = memalign(ARCH_DMA_MINALIGN, mtd->writesize);
55 	if (!datbuf) {
56 		puts("No memory for page buffer\n");
57 		return 1;
58 	}
59 
60 	oobbuf = memalign(ARCH_DMA_MINALIGN, mtd->oobsize);
61 	if (!oobbuf) {
62 		puts("No memory for page buffer\n");
63 		ret = 1;
64 		goto free_dat;
65 	}
66 	off &= ~(mtd->writesize - 1);
67 	loff_t addr = (loff_t) off;
68 	struct mtd_oob_ops ops;
69 	memset(&ops, 0, sizeof(ops));
70 	ops.datbuf = datbuf;
71 	ops.oobbuf = oobbuf;
72 	ops.len = mtd->writesize;
73 	ops.ooblen = mtd->oobsize;
74 	ops.mode = MTD_OPS_RAW;
75 	i = mtd_read_oob(mtd, addr, &ops);
76 	if (i < 0) {
77 		printf("Error (%d) reading page %08lx\n", i, off);
78 		ret = 1;
79 		goto free_all;
80 	}
81 	printf("Page %08lx dump:\n", off);
82 
83 	if (!only_oob) {
84 		i = mtd->writesize >> 4;
85 		p = datbuf;
86 
87 		while (i--) {
88 			printf("\t%02x %02x %02x %02x %02x %02x %02x %02x"
89 			       "  %02x %02x %02x %02x %02x %02x %02x %02x\n",
90 			       p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7],
91 			       p[8], p[9], p[10], p[11], p[12], p[13], p[14],
92 			       p[15]);
93 			p += 16;
94 		}
95 	}
96 
97 	puts("OOB:\n");
98 	i = mtd->oobsize >> 3;
99 	p = oobbuf;
100 	while (i--) {
101 		printf("\t%02x %02x %02x %02x %02x %02x %02x %02x\n",
102 		       p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7]);
103 		p += 8;
104 	}
105 
106 free_all:
107 	free(oobbuf);
108 free_dat:
109 	free(datbuf);
110 
111 	return ret;
112 }
113 
114 /* ------------------------------------------------------------------------- */
115 
116 static int set_dev(int dev)
117 {
118 	if (dev < 0 || dev >= CONFIG_SYS_MAX_NAND_DEVICE ||
119 	    !nand_info[dev]->name) {
120 		puts("No such device\n");
121 		return -1;
122 	}
123 
124 	if (nand_curr_device == dev)
125 		return 0;
126 
127 	printf("Device %d: %s", dev, nand_info[dev]->name);
128 	puts("... is now current device\n");
129 	nand_curr_device = dev;
130 
131 #ifdef CONFIG_SYS_NAND_SELECT_DEVICE
132 	board_nand_select_device(nand_info[dev]->priv, dev);
133 #endif
134 
135 	return 0;
136 }
137 
138 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
139 static void print_status(ulong start, ulong end, ulong erasesize, int status)
140 {
141 	/*
142 	 * Micron NAND flash (e.g. MT29F4G08ABADAH4) BLOCK LOCK READ STATUS is
143 	 * not the same as others.  Instead of bit 1 being lock, it is
144 	 * #lock_tight. To make the driver support either format, ignore bit 1
145 	 * and use only bit 0 and bit 2.
146 	 */
147 	printf("%08lx - %08lx: %08lx blocks %s%s%s\n",
148 		start,
149 		end - 1,
150 		(end - start) / erasesize,
151 		((status & NAND_LOCK_STATUS_TIGHT) ?  "TIGHT " : ""),
152 		(!(status & NAND_LOCK_STATUS_UNLOCK) ?  "LOCK " : ""),
153 		((status & NAND_LOCK_STATUS_UNLOCK) ?  "UNLOCK " : ""));
154 }
155 
156 static void do_nand_status(struct mtd_info *mtd)
157 {
158 	ulong block_start = 0;
159 	ulong off;
160 	int last_status = -1;
161 
162 	struct nand_chip *nand_chip = mtd_to_nand(mtd);
163 	/* check the WP bit */
164 	nand_chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
165 	printf("device is %swrite protected\n",
166 		(nand_chip->read_byte(mtd) & 0x80 ?
167 		 "NOT " : ""));
168 
169 	for (off = 0; off < mtd->size; off += mtd->erasesize) {
170 		int s = nand_get_lock_status(mtd, off);
171 
172 		/* print message only if status has changed */
173 		if (s != last_status && off != 0) {
174 			print_status(block_start, off, mtd->erasesize,
175 					last_status);
176 			block_start = off;
177 		}
178 		last_status = s;
179 	}
180 	/* Print the last block info */
181 	print_status(block_start, off, mtd->erasesize, last_status);
182 }
183 #endif
184 
185 #ifdef CONFIG_ENV_OFFSET_OOB
186 unsigned long nand_env_oob_offset;
187 
188 int do_nand_env_oob(cmd_tbl_t *cmdtp, int argc, char *const argv[])
189 {
190 	int ret;
191 	uint32_t oob_buf[ENV_OFFSET_SIZE/sizeof(uint32_t)];
192 	struct mtd_info *mtd = nand_info[0];
193 	char *cmd = argv[1];
194 
195 	if (CONFIG_SYS_MAX_NAND_DEVICE == 0 || !mtd->name) {
196 		puts("no devices available\n");
197 		return 1;
198 	}
199 
200 	set_dev(0);
201 
202 	if (!strcmp(cmd, "get")) {
203 		ret = get_nand_env_oob(mtd, &nand_env_oob_offset);
204 		if (ret)
205 			return 1;
206 
207 		printf("0x%08lx\n", nand_env_oob_offset);
208 	} else if (!strcmp(cmd, "set")) {
209 		loff_t addr;
210 		loff_t maxsize;
211 		struct mtd_oob_ops ops;
212 		int idx = 0;
213 
214 		if (argc < 3)
215 			goto usage;
216 
217 		/* We don't care about size, or maxsize. */
218 		if (mtd_arg_off(argv[2], &idx, &addr, &maxsize, &maxsize,
219 				MTD_DEV_TYPE_NAND, nand_info[idx]->size)) {
220 			puts("Offset or partition name expected\n");
221 			return 1;
222 		}
223 		if (set_dev(idx)) {
224 			puts("Offset or partition name expected\n");
225 			return 1;
226 		}
227 
228 		if (idx != 0) {
229 			puts("Partition not on first NAND device\n");
230 			return 1;
231 		}
232 
233 		if (mtd->oobavail < ENV_OFFSET_SIZE) {
234 			printf("Insufficient available OOB bytes:\n"
235 			       "%d OOB bytes available but %d required for "
236 			       "env.oob support\n",
237 			       mtd->oobavail, ENV_OFFSET_SIZE);
238 			return 1;
239 		}
240 
241 		if ((addr & (mtd->erasesize - 1)) != 0) {
242 			printf("Environment offset must be block-aligned\n");
243 			return 1;
244 		}
245 
246 		ops.datbuf = NULL;
247 		ops.mode = MTD_OOB_AUTO;
248 		ops.ooboffs = 0;
249 		ops.ooblen = ENV_OFFSET_SIZE;
250 		ops.oobbuf = (void *) oob_buf;
251 
252 		oob_buf[0] = ENV_OOB_MARKER;
253 		oob_buf[1] = addr / mtd->erasesize;
254 
255 		ret = mtd->write_oob(mtd, ENV_OFFSET_SIZE, &ops);
256 		if (ret) {
257 			printf("Error writing OOB block 0\n");
258 			return ret;
259 		}
260 
261 		ret = get_nand_env_oob(mtd, &nand_env_oob_offset);
262 		if (ret) {
263 			printf("Error reading env offset in OOB\n");
264 			return ret;
265 		}
266 
267 		if (addr != nand_env_oob_offset) {
268 			printf("Verification of env offset in OOB failed: "
269 			       "0x%08llx expected but got 0x%08lx\n",
270 			       (unsigned long long)addr, nand_env_oob_offset);
271 			return 1;
272 		}
273 	} else {
274 		goto usage;
275 	}
276 
277 	return ret;
278 
279 usage:
280 	return CMD_RET_USAGE;
281 }
282 
283 #endif
284 
285 static void nand_print_and_set_info(int idx)
286 {
287 	struct mtd_info *mtd = nand_info[idx];
288 	struct nand_chip *chip = mtd_to_nand(mtd);
289 
290 	printf("Device %d: ", idx);
291 	if (chip->numchips > 1)
292 		printf("%dx ", chip->numchips);
293 	printf("%s, sector size %u KiB\n",
294 	       mtd->name, mtd->erasesize >> 10);
295 	printf("  Page size   %8d b\n", mtd->writesize);
296 	printf("  OOB size    %8d b\n", mtd->oobsize);
297 	printf("  Erase size  %8d b\n", mtd->erasesize);
298 	printf("  subpagesize %8d b\n", chip->subpagesize);
299 	printf("  options     0x%8x\n", chip->options);
300 	printf("  bbt options 0x%8x\n", chip->bbt_options);
301 
302 	/* Set geometry info */
303 	setenv_hex("nand_writesize", mtd->writesize);
304 	setenv_hex("nand_oobsize", mtd->oobsize);
305 	setenv_hex("nand_erasesize", mtd->erasesize);
306 }
307 
308 static int raw_access(struct mtd_info *mtd, ulong addr, loff_t off,
309 		      ulong count, int read)
310 {
311 	int ret = 0;
312 
313 	while (count--) {
314 		/* Raw access */
315 		mtd_oob_ops_t ops = {
316 			.datbuf = (u8 *)addr,
317 			.oobbuf = ((u8 *)addr) + mtd->writesize,
318 			.len = mtd->writesize,
319 			.ooblen = mtd->oobsize,
320 			.mode = MTD_OPS_RAW
321 		};
322 
323 		if (read) {
324 			ret = mtd_read_oob(mtd, off, &ops);
325 		} else {
326 			ret = mtd_write_oob(mtd, off, &ops);
327 			if (!ret)
328 				ret = nand_verify_page_oob(mtd, &ops, off);
329 		}
330 
331 		if (ret) {
332 			printf("%s: error at offset %llx, ret %d\n",
333 				__func__, (long long)off, ret);
334 			break;
335 		}
336 
337 		addr += mtd->writesize + mtd->oobsize;
338 		off += mtd->writesize;
339 	}
340 
341 	return ret;
342 }
343 
344 /* Adjust a chip/partition size down for bad blocks so we don't
345  * read/write past the end of a chip/partition by accident.
346  */
347 static void adjust_size_for_badblocks(loff_t *size, loff_t offset, int dev)
348 {
349 	/* We grab the nand info object here fresh because this is usually
350 	 * called after arg_off_size() which can change the value of dev.
351 	 */
352 	struct mtd_info *mtd = nand_info[dev];
353 	loff_t maxoffset = offset + *size;
354 	int badblocks = 0;
355 
356 	/* count badblocks in NAND from offset to offset + size */
357 	for (; offset < maxoffset; offset += mtd->erasesize) {
358 		if (nand_block_isbad(mtd, offset))
359 			badblocks++;
360 	}
361 	/* adjust size if any bad blocks found */
362 	if (badblocks) {
363 		*size -= badblocks * mtd->erasesize;
364 		printf("size adjusted to 0x%llx (%d bad blocks)\n",
365 		       (unsigned long long)*size, badblocks);
366 	}
367 }
368 
369 static int do_nand(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
370 {
371 	int i, ret = 0;
372 	ulong addr;
373 	loff_t off, size, maxsize;
374 	char *cmd, *s;
375 	struct mtd_info *mtd;
376 #ifdef CONFIG_SYS_NAND_QUIET
377 	int quiet = CONFIG_SYS_NAND_QUIET;
378 #else
379 	int quiet = 0;
380 #endif
381 	const char *quiet_str = getenv("quiet");
382 	int dev = nand_curr_device;
383 	int repeat = flag & CMD_FLAG_REPEAT;
384 
385 	/* at least two arguments please */
386 	if (argc < 2)
387 		goto usage;
388 
389 	if (quiet_str)
390 		quiet = simple_strtoul(quiet_str, NULL, 0) != 0;
391 
392 	cmd = argv[1];
393 
394 	/* Only "dump" is repeatable. */
395 	if (repeat && strcmp(cmd, "dump"))
396 		return 0;
397 
398 	if (strcmp(cmd, "info") == 0) {
399 
400 		putc('\n');
401 		for (i = 0; i < CONFIG_SYS_MAX_NAND_DEVICE; i++) {
402 			if (nand_info[i]->name)
403 				nand_print_and_set_info(i);
404 		}
405 		return 0;
406 	}
407 
408 	if (strcmp(cmd, "device") == 0) {
409 		if (argc < 3) {
410 			putc('\n');
411 			if (dev < 0 || dev >= CONFIG_SYS_MAX_NAND_DEVICE)
412 				puts("no devices available\n");
413 			else
414 				nand_print_and_set_info(dev);
415 			return 0;
416 		}
417 
418 		dev = (int)simple_strtoul(argv[2], NULL, 10);
419 		set_dev(dev);
420 
421 		return 0;
422 	}
423 
424 #ifdef CONFIG_ENV_OFFSET_OOB
425 	/* this command operates only on the first nand device */
426 	if (strcmp(cmd, "env.oob") == 0)
427 		return do_nand_env_oob(cmdtp, argc - 1, argv + 1);
428 #endif
429 
430 	/* The following commands operate on the current device, unless
431 	 * overridden by a partition specifier.  Note that if somehow the
432 	 * current device is invalid, it will have to be changed to a valid
433 	 * one before these commands can run, even if a partition specifier
434 	 * for another device is to be used.
435 	 */
436 	if (dev < 0 || dev >= CONFIG_SYS_MAX_NAND_DEVICE ||
437 	    !nand_info[dev]->name) {
438 		puts("\nno devices available\n");
439 		return 1;
440 	}
441 	mtd = nand_info[dev];
442 
443 	if (strcmp(cmd, "bad") == 0) {
444 		printf("\nDevice %d bad blocks:\n", dev);
445 		for (off = 0; off < mtd->size; off += mtd->erasesize)
446 			if (nand_block_isbad(mtd, off))
447 				printf("  %08llx\n", (unsigned long long)off);
448 		return 0;
449 	}
450 
451 	/*
452 	 * Syntax is:
453 	 *   0    1     2       3    4
454 	 *   nand erase [clean] [off size]
455 	 */
456 	if (strncmp(cmd, "erase", 5) == 0 || strncmp(cmd, "scrub", 5) == 0) {
457 		nand_erase_options_t opts;
458 		/* "clean" at index 2 means request to write cleanmarker */
459 		int clean = argc > 2 && !strcmp("clean", argv[2]);
460 		int scrub_yes = argc > 2 && !strcmp("-y", argv[2]);
461 		int o = (clean || scrub_yes) ? 3 : 2;
462 		int scrub = !strncmp(cmd, "scrub", 5);
463 		int spread = 0;
464 		int args = 2;
465 		const char *scrub_warn =
466 			"Warning: "
467 			"scrub option will erase all factory set bad blocks!\n"
468 			"         "
469 			"There is no reliable way to recover them.\n"
470 			"         "
471 			"Use this command only for testing purposes if you\n"
472 			"         "
473 			"are sure of what you are doing!\n"
474 			"\nReally scrub this NAND flash? <y/N>\n";
475 
476 		if (cmd[5] != 0) {
477 			if (!strcmp(&cmd[5], ".spread")) {
478 				spread = 1;
479 			} else if (!strcmp(&cmd[5], ".part")) {
480 				args = 1;
481 			} else if (!strcmp(&cmd[5], ".chip")) {
482 				args = 0;
483 			} else {
484 				goto usage;
485 			}
486 		}
487 
488 		/*
489 		 * Don't allow missing arguments to cause full chip/partition
490 		 * erases -- easy to do accidentally, e.g. with a misspelled
491 		 * variable name.
492 		 */
493 		if (argc != o + args)
494 			goto usage;
495 
496 		printf("\nNAND %s: ", cmd);
497 		/* skip first two or three arguments, look for offset and size */
498 		if (mtd_arg_off_size(argc - o, argv + o, &dev, &off, &size,
499 				     &maxsize, MTD_DEV_TYPE_NAND,
500 				     nand_info[dev]->size) != 0)
501 			return 1;
502 
503 		if (set_dev(dev))
504 			return 1;
505 
506 		mtd = nand_info[dev];
507 
508 		memset(&opts, 0, sizeof(opts));
509 		opts.offset = off;
510 		opts.length = size;
511 		opts.jffs2  = clean;
512 		opts.quiet  = quiet;
513 		opts.spread = spread;
514 
515 		if (scrub) {
516 			if (scrub_yes) {
517 				opts.scrub = 1;
518 			} else {
519 				puts(scrub_warn);
520 				if (confirm_yesno()) {
521 					opts.scrub = 1;
522 				} else {
523 					puts("scrub aborted\n");
524 					return 1;
525 				}
526 			}
527 		}
528 		ret = nand_erase_opts(mtd, &opts);
529 		printf("%s\n", ret ? "ERROR" : "OK");
530 
531 		return ret == 0 ? 0 : 1;
532 	}
533 
534 	if (strncmp(cmd, "dump", 4) == 0) {
535 		if (argc < 3)
536 			goto usage;
537 
538 		off = (int)simple_strtoul(argv[2], NULL, 16);
539 		ret = nand_dump(mtd, off, !strcmp(&cmd[4], ".oob"), repeat);
540 
541 		return ret == 0 ? 1 : 0;
542 	}
543 
544 	if (strncmp(cmd, "read", 4) == 0 || strncmp(cmd, "write", 5) == 0) {
545 		size_t rwsize;
546 		ulong pagecount = 1;
547 		int read;
548 		int raw = 0;
549 
550 		if (argc < 4)
551 			goto usage;
552 
553 		addr = (ulong)simple_strtoul(argv[2], NULL, 16);
554 
555 		read = strncmp(cmd, "read", 4) == 0; /* 1 = read, 0 = write */
556 		printf("\nNAND %s: ", read ? "read" : "write");
557 
558 		s = strchr(cmd, '.');
559 
560 		if (s && !strcmp(s, ".raw")) {
561 			raw = 1;
562 
563 			if (mtd_arg_off(argv[3], &dev, &off, &size, &maxsize,
564 					MTD_DEV_TYPE_NAND,
565 					nand_info[dev]->size))
566 				return 1;
567 
568 			if (set_dev(dev))
569 				return 1;
570 
571 			mtd = nand_info[dev];
572 
573 			if (argc > 4 && !str2long(argv[4], &pagecount)) {
574 				printf("'%s' is not a number\n", argv[4]);
575 				return 1;
576 			}
577 
578 			if (pagecount * mtd->writesize > size) {
579 				puts("Size exceeds partition or device limit\n");
580 				return -1;
581 			}
582 
583 			rwsize = pagecount * (mtd->writesize + mtd->oobsize);
584 		} else {
585 			if (mtd_arg_off_size(argc - 3, argv + 3, &dev, &off,
586 					     &size, &maxsize,
587 					     MTD_DEV_TYPE_NAND,
588 					     nand_info[dev]->size) != 0)
589 				return 1;
590 
591 			if (set_dev(dev))
592 				return 1;
593 
594 			/* size is unspecified */
595 			if (argc < 5)
596 				adjust_size_for_badblocks(&size, off, dev);
597 			rwsize = size;
598 		}
599 
600 		mtd = nand_info[dev];
601 
602 		if (!s || !strcmp(s, ".jffs2") ||
603 		    !strcmp(s, ".e") || !strcmp(s, ".i")) {
604 			if (read)
605 				ret = nand_read_skip_bad(mtd, off, &rwsize,
606 							 NULL, maxsize,
607 							 (u_char *)addr);
608 			else
609 				ret = nand_write_skip_bad(mtd, off, &rwsize,
610 							  NULL, maxsize,
611 							  (u_char *)addr,
612 							  WITH_WR_VERIFY);
613 #ifdef CONFIG_CMD_NAND_TRIMFFS
614 		} else if (!strcmp(s, ".trimffs")) {
615 			if (read) {
616 				printf("Unknown nand command suffix '%s'\n", s);
617 				return 1;
618 			}
619 			ret = nand_write_skip_bad(mtd, off, &rwsize, NULL,
620 						maxsize, (u_char *)addr,
621 						WITH_DROP_FFS | WITH_WR_VERIFY);
622 #endif
623 		} else if (!strcmp(s, ".oob")) {
624 			/* out-of-band data */
625 			mtd_oob_ops_t ops = {
626 				.oobbuf = (u8 *)addr,
627 				.ooblen = rwsize,
628 				.mode = MTD_OPS_RAW
629 			};
630 
631 			if (read)
632 				ret = mtd_read_oob(mtd, off, &ops);
633 			else
634 				ret = mtd_write_oob(mtd, off, &ops);
635 		} else if (raw) {
636 			ret = raw_access(mtd, addr, off, pagecount, read);
637 		} else {
638 			printf("Unknown nand command suffix '%s'.\n", s);
639 			return 1;
640 		}
641 
642 		printf(" %zu bytes %s: %s\n", rwsize,
643 		       read ? "read" : "written", ret ? "ERROR" : "OK");
644 
645 		return ret == 0 ? 0 : 1;
646 	}
647 
648 #ifdef CONFIG_CMD_NAND_TORTURE
649 	if (strcmp(cmd, "torture") == 0) {
650 		if (argc < 3)
651 			goto usage;
652 
653 		if (!str2off(argv[2], &off)) {
654 			puts("Offset is not a valid number\n");
655 			return 1;
656 		}
657 
658 		printf("\nNAND torture: device %d offset 0x%llx size 0x%x\n",
659 			dev, off, mtd->erasesize);
660 		ret = nand_torture(mtd, off);
661 		printf(" %s\n", ret ? "Failed" : "Passed");
662 
663 		return ret == 0 ? 0 : 1;
664 	}
665 #endif
666 
667 	if (strcmp(cmd, "markbad") == 0) {
668 		argc -= 2;
669 		argv += 2;
670 
671 		if (argc <= 0)
672 			goto usage;
673 
674 		while (argc > 0) {
675 			addr = simple_strtoul(*argv, NULL, 16);
676 
677 			if (mtd_block_markbad(mtd, addr)) {
678 				printf("block 0x%08lx NOT marked "
679 					"as bad! ERROR %d\n",
680 					addr, ret);
681 				ret = 1;
682 			} else {
683 				printf("block 0x%08lx successfully "
684 					"marked as bad\n",
685 					addr);
686 			}
687 			--argc;
688 			++argv;
689 		}
690 		return ret;
691 	}
692 
693 	if (strcmp(cmd, "biterr") == 0) {
694 		/* todo */
695 		return 1;
696 	}
697 
698 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
699 	if (strcmp(cmd, "lock") == 0) {
700 		int tight = 0;
701 		int status = 0;
702 		if (argc == 3) {
703 			if (!strcmp("tight", argv[2]))
704 				tight = 1;
705 			if (!strcmp("status", argv[2]))
706 				status = 1;
707 		}
708 		if (status) {
709 			do_nand_status(mtd);
710 		} else {
711 			if (!nand_lock(mtd, tight)) {
712 				puts("NAND flash successfully locked\n");
713 			} else {
714 				puts("Error locking NAND flash\n");
715 				return 1;
716 			}
717 		}
718 		return 0;
719 	}
720 
721 	if (strncmp(cmd, "unlock", 5) == 0) {
722 		int allexcept = 0;
723 
724 		s = strchr(cmd, '.');
725 
726 		if (s && !strcmp(s, ".allexcept"))
727 			allexcept = 1;
728 
729 		if (mtd_arg_off_size(argc - 2, argv + 2, &dev, &off, &size,
730 				     &maxsize, MTD_DEV_TYPE_NAND,
731 				     nand_info[dev]->size) < 0)
732 			return 1;
733 
734 		if (set_dev(dev))
735 			return 1;
736 
737 		if (!nand_unlock(nand_info[dev], off, size, allexcept)) {
738 			puts("NAND flash successfully unlocked\n");
739 		} else {
740 			puts("Error unlocking NAND flash, "
741 			     "write and erase will probably fail\n");
742 			return 1;
743 		}
744 		return 0;
745 	}
746 #endif
747 
748 usage:
749 	return CMD_RET_USAGE;
750 }
751 
752 #ifdef CONFIG_SYS_LONGHELP
753 static char nand_help_text[] =
754 	"info - show available NAND devices\n"
755 	"nand device [dev] - show or set current device\n"
756 	"nand read - addr off|partition size\n"
757 	"nand write - addr off|partition size\n"
758 	"    read/write 'size' bytes starting at offset 'off'\n"
759 	"    to/from memory address 'addr', skipping bad blocks.\n"
760 	"nand read.raw - addr off|partition [count]\n"
761 	"nand write.raw - addr off|partition [count]\n"
762 	"    Use read.raw/write.raw to avoid ECC and access the flash as-is.\n"
763 #ifdef CONFIG_CMD_NAND_TRIMFFS
764 	"nand write.trimffs - addr off|partition size\n"
765 	"    write 'size' bytes starting at offset 'off' from memory address\n"
766 	"    'addr', skipping bad blocks and dropping any pages at the end\n"
767 	"    of eraseblocks that contain only 0xFF\n"
768 #endif
769 	"nand erase[.spread] [clean] off size - erase 'size' bytes "
770 	"from offset 'off'\n"
771 	"    With '.spread', erase enough for given file size, otherwise,\n"
772 	"    'size' includes skipped bad blocks.\n"
773 	"nand erase.part [clean] partition - erase entire mtd partition'\n"
774 	"nand erase.chip [clean] - erase entire chip'\n"
775 	"nand bad - show bad blocks\n"
776 	"nand dump[.oob] off - dump page\n"
777 #ifdef CONFIG_CMD_NAND_TORTURE
778 	"nand torture off - torture block at offset\n"
779 #endif
780 	"nand scrub [-y] off size | scrub.part partition | scrub.chip\n"
781 	"    really clean NAND erasing bad blocks (UNSAFE)\n"
782 	"nand markbad off [...] - mark bad block(s) at offset (UNSAFE)\n"
783 	"nand biterr off - make a bit error at offset (UNSAFE)"
784 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
785 	"\n"
786 	"nand lock [tight] [status]\n"
787 	"    bring nand to lock state or display locked pages\n"
788 	"nand unlock[.allexcept] [offset] [size] - unlock section"
789 #endif
790 #ifdef CONFIG_ENV_OFFSET_OOB
791 	"\n"
792 	"nand env.oob - environment offset in OOB of block 0 of"
793 	"    first device.\n"
794 	"nand env.oob set off|partition - set enviromnent offset\n"
795 	"nand env.oob get - get environment offset"
796 #endif
797 	"";
798 #endif
799 
800 U_BOOT_CMD(
801 	nand, CONFIG_SYS_MAXARGS, 1, do_nand,
802 	"NAND sub-system", nand_help_text
803 );
804 
805 static int nand_load_image(cmd_tbl_t *cmdtp, struct mtd_info *mtd,
806 			   ulong offset, ulong addr, char *cmd)
807 {
808 	int r;
809 	char *s;
810 	size_t cnt;
811 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
812 	image_header_t *hdr;
813 #endif
814 #if defined(CONFIG_FIT)
815 	const void *fit_hdr = NULL;
816 #endif
817 
818 	s = strchr(cmd, '.');
819 	if (s != NULL &&
820 	    (strcmp(s, ".jffs2") && strcmp(s, ".e") && strcmp(s, ".i"))) {
821 		printf("Unknown nand load suffix '%s'\n", s);
822 		bootstage_error(BOOTSTAGE_ID_NAND_SUFFIX);
823 		return 1;
824 	}
825 
826 	printf("\nLoading from %s, offset 0x%lx\n", mtd->name, offset);
827 
828 	cnt = mtd->writesize;
829 	r = nand_read_skip_bad(mtd, offset, &cnt, NULL, mtd->size,
830 			       (u_char *)addr);
831 	if (r) {
832 		puts("** Read error\n");
833 		bootstage_error(BOOTSTAGE_ID_NAND_HDR_READ);
834 		return 1;
835 	}
836 	bootstage_mark(BOOTSTAGE_ID_NAND_HDR_READ);
837 
838 	switch (genimg_get_format ((void *)addr)) {
839 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
840 	case IMAGE_FORMAT_LEGACY:
841 		hdr = (image_header_t *)addr;
842 
843 		bootstage_mark(BOOTSTAGE_ID_NAND_TYPE);
844 		image_print_contents (hdr);
845 
846 		cnt = image_get_image_size (hdr);
847 		break;
848 #endif
849 #if defined(CONFIG_FIT)
850 	case IMAGE_FORMAT_FIT:
851 		fit_hdr = (const void *)addr;
852 		puts ("Fit image detected...\n");
853 
854 		cnt = fit_get_size (fit_hdr);
855 		break;
856 #endif
857 	default:
858 		bootstage_error(BOOTSTAGE_ID_NAND_TYPE);
859 		puts ("** Unknown image type\n");
860 		return 1;
861 	}
862 	bootstage_mark(BOOTSTAGE_ID_NAND_TYPE);
863 
864 	r = nand_read_skip_bad(mtd, offset, &cnt, NULL, mtd->size,
865 			       (u_char *)addr);
866 	if (r) {
867 		puts("** Read error\n");
868 		bootstage_error(BOOTSTAGE_ID_NAND_READ);
869 		return 1;
870 	}
871 	bootstage_mark(BOOTSTAGE_ID_NAND_READ);
872 
873 #if defined(CONFIG_FIT)
874 	/* This cannot be done earlier, we need complete FIT image in RAM first */
875 	if (genimg_get_format ((void *)addr) == IMAGE_FORMAT_FIT) {
876 		if (!fit_check_format (fit_hdr)) {
877 			bootstage_error(BOOTSTAGE_ID_NAND_FIT_READ);
878 			puts ("** Bad FIT image format\n");
879 			return 1;
880 		}
881 		bootstage_mark(BOOTSTAGE_ID_NAND_FIT_READ_OK);
882 		fit_print_contents (fit_hdr);
883 	}
884 #endif
885 
886 	/* Loading ok, update default load address */
887 
888 	load_addr = addr;
889 
890 	return bootm_maybe_autostart(cmdtp, cmd);
891 }
892 
893 static int do_nandboot(cmd_tbl_t *cmdtp, int flag, int argc,
894 		       char * const argv[])
895 {
896 	char *boot_device = NULL;
897 	int idx;
898 	ulong addr, offset = 0;
899 #if defined(CONFIG_CMD_MTDPARTS)
900 	struct mtd_device *dev;
901 	struct part_info *part;
902 	u8 pnum;
903 
904 	if (argc >= 2) {
905 		char *p = (argc == 2) ? argv[1] : argv[2];
906 		if (!(str2long(p, &addr)) && (mtdparts_init() == 0) &&
907 		    (find_dev_and_part(p, &dev, &pnum, &part) == 0)) {
908 			if (dev->id->type != MTD_DEV_TYPE_NAND) {
909 				puts("Not a NAND device\n");
910 				return 1;
911 			}
912 			if (argc > 3)
913 				goto usage;
914 			if (argc == 3)
915 				addr = simple_strtoul(argv[1], NULL, 16);
916 			else
917 				addr = CONFIG_SYS_LOAD_ADDR;
918 			return nand_load_image(cmdtp, nand_info[dev->id->num],
919 					       part->offset, addr, argv[0]);
920 		}
921 	}
922 #endif
923 
924 	bootstage_mark(BOOTSTAGE_ID_NAND_PART);
925 	switch (argc) {
926 	case 1:
927 		addr = CONFIG_SYS_LOAD_ADDR;
928 		boot_device = getenv("bootdevice");
929 		break;
930 	case 2:
931 		addr = simple_strtoul(argv[1], NULL, 16);
932 		boot_device = getenv("bootdevice");
933 		break;
934 	case 3:
935 		addr = simple_strtoul(argv[1], NULL, 16);
936 		boot_device = argv[2];
937 		break;
938 	case 4:
939 		addr = simple_strtoul(argv[1], NULL, 16);
940 		boot_device = argv[2];
941 		offset = simple_strtoul(argv[3], NULL, 16);
942 		break;
943 	default:
944 #if defined(CONFIG_CMD_MTDPARTS)
945 usage:
946 #endif
947 		bootstage_error(BOOTSTAGE_ID_NAND_SUFFIX);
948 		return CMD_RET_USAGE;
949 	}
950 	bootstage_mark(BOOTSTAGE_ID_NAND_SUFFIX);
951 
952 	if (!boot_device) {
953 		puts("\n** No boot device **\n");
954 		bootstage_error(BOOTSTAGE_ID_NAND_BOOT_DEVICE);
955 		return 1;
956 	}
957 	bootstage_mark(BOOTSTAGE_ID_NAND_BOOT_DEVICE);
958 
959 	idx = simple_strtoul(boot_device, NULL, 16);
960 
961 	if (idx < 0 || idx >= CONFIG_SYS_MAX_NAND_DEVICE || !nand_info[idx]->name) {
962 		printf("\n** Device %d not available\n", idx);
963 		bootstage_error(BOOTSTAGE_ID_NAND_AVAILABLE);
964 		return 1;
965 	}
966 	bootstage_mark(BOOTSTAGE_ID_NAND_AVAILABLE);
967 
968 	return nand_load_image(cmdtp, nand_info[idx], offset, addr, argv[0]);
969 }
970 
971 U_BOOT_CMD(nboot, 4, 1, do_nandboot,
972 	"boot from NAND device",
973 	"[partition] | [[[loadAddr] dev] offset]"
974 );
975