xref: /rk3399_rockchip-uboot/cmd/nand.c (revision 6aef61663a678354957351d094894aaf5902137e)
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 
nand_dump(struct mtd_info * mtd,ulong off,int only_oob,int repeat)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 
set_dev(int dev)116 static int set_dev(int dev)
117 {
118 	struct mtd_info *mtd = get_nand_dev_by_index(dev);
119 
120 	if (!mtd)
121 		return -ENODEV;
122 
123 	if (nand_curr_device == dev)
124 		return 0;
125 
126 	printf("Device %d: %s", dev, mtd->name);
127 	puts("... is now current device\n");
128 	nand_curr_device = dev;
129 
130 #ifdef CONFIG_SYS_NAND_SELECT_DEVICE
131 	board_nand_select_device(mtd_to_nand(mtd), dev);
132 #endif
133 
134 	return 0;
135 }
136 
137 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
print_status(ulong start,ulong end,ulong erasesize,int status)138 static void print_status(ulong start, ulong end, ulong erasesize, int status)
139 {
140 	/*
141 	 * Micron NAND flash (e.g. MT29F4G08ABADAH4) BLOCK LOCK READ STATUS is
142 	 * not the same as others.  Instead of bit 1 being lock, it is
143 	 * #lock_tight. To make the driver support either format, ignore bit 1
144 	 * and use only bit 0 and bit 2.
145 	 */
146 	printf("%08lx - %08lx: %08lx blocks %s%s%s\n",
147 		start,
148 		end - 1,
149 		(end - start) / erasesize,
150 		((status & NAND_LOCK_STATUS_TIGHT) ?  "TIGHT " : ""),
151 		(!(status & NAND_LOCK_STATUS_UNLOCK) ?  "LOCK " : ""),
152 		((status & NAND_LOCK_STATUS_UNLOCK) ?  "UNLOCK " : ""));
153 }
154 
do_nand_status(struct mtd_info * mtd)155 static void do_nand_status(struct mtd_info *mtd)
156 {
157 	ulong block_start = 0;
158 	ulong off;
159 	int last_status = -1;
160 
161 	struct nand_chip *nand_chip = mtd_to_nand(mtd);
162 	/* check the WP bit */
163 	nand_chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
164 	printf("device is %swrite protected\n",
165 		(nand_chip->read_byte(mtd) & 0x80 ?
166 		 "NOT " : ""));
167 
168 	for (off = 0; off < mtd->size; off += mtd->erasesize) {
169 		int s = nand_get_lock_status(mtd, off);
170 
171 		/* print message only if status has changed */
172 		if (s != last_status && off != 0) {
173 			print_status(block_start, off, mtd->erasesize,
174 					last_status);
175 			block_start = off;
176 		}
177 		last_status = s;
178 	}
179 	/* Print the last block info */
180 	print_status(block_start, off, mtd->erasesize, last_status);
181 }
182 #endif
183 
184 #ifdef CONFIG_ENV_OFFSET_OOB
185 unsigned long nand_env_oob_offset;
186 
do_nand_env_oob(cmd_tbl_t * cmdtp,int argc,char * const argv[])187 int do_nand_env_oob(cmd_tbl_t *cmdtp, int argc, char *const argv[])
188 {
189 	int ret;
190 	uint32_t oob_buf[ENV_OFFSET_SIZE/sizeof(uint32_t)];
191 	struct mtd_info *mtd = get_nand_dev_by_index(0);
192 	char *cmd = argv[1];
193 
194 	if (CONFIG_SYS_MAX_NAND_DEVICE == 0 || !mtd) {
195 		puts("no devices available\n");
196 		return 1;
197 	}
198 
199 	set_dev(0);
200 
201 	if (!strcmp(cmd, "get")) {
202 		ret = get_nand_env_oob(mtd, &nand_env_oob_offset);
203 		if (ret)
204 			return 1;
205 
206 		printf("0x%08lx\n", nand_env_oob_offset);
207 	} else if (!strcmp(cmd, "set")) {
208 		loff_t addr;
209 		loff_t maxsize;
210 		struct mtd_oob_ops ops;
211 		int idx = 0;
212 
213 		if (argc < 3)
214 			goto usage;
215 
216 		mtd = get_nand_dev_by_index(idx);
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, mtd->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 
nand_print_and_set_info(int idx)285 static void nand_print_and_set_info(int idx)
286 {
287 	struct mtd_info *mtd;
288 	struct nand_chip *chip;
289 
290 	mtd = get_nand_dev_by_index(idx);
291 	if (!mtd)
292 		return;
293 
294 	chip = mtd_to_nand(mtd);
295 	printf("Device %d: ", idx);
296 	if (chip->numchips > 1)
297 		printf("%dx ", chip->numchips);
298 	printf("%s, sector size %u KiB\n",
299 	       mtd->name, mtd->erasesize >> 10);
300 	printf("  Page size   %8d b\n", mtd->writesize);
301 	printf("  OOB size    %8d b\n", mtd->oobsize);
302 	printf("  Erase size  %8d b\n", mtd->erasesize);
303 	printf("  subpagesize %8d b\n", chip->subpagesize);
304 	printf("  options     0x%08x\n", chip->options);
305 	printf("  bbt options 0x%08x\n", chip->bbt_options);
306 
307 	/* Set geometry info */
308 	env_set_hex("nand_writesize", mtd->writesize);
309 	env_set_hex("nand_oobsize", mtd->oobsize);
310 	env_set_hex("nand_erasesize", mtd->erasesize);
311 }
312 
mtd_is_aligned_with_block_size(struct mtd_info * mtd,u64 size)313 static bool mtd_is_aligned_with_block_size(struct mtd_info *mtd, u64 size)
314 {
315 	return !do_div(size, mtd->erasesize);
316 }
317 
raw_access(struct mtd_info * mtd,ulong addr,loff_t off,ulong count,int read,int no_verify)318 static int raw_access(struct mtd_info *mtd, ulong addr, loff_t off,
319 		      ulong count, int read, int no_verify)
320 {
321 	int ret = 0;
322 
323 	while (count && (off + mtd->writesize) <= mtd->size) {
324 		/*
325 		 * Skipping bad block interfaces meets practical usage
326 		 * requirements
327 		 */
328 		if (mtd_is_aligned_with_block_size(mtd, off) &&
329 			mtd_block_isbad(mtd, off)) {
330 			printf("raw_access skip bad block 0x%08llx\n",
331 			       off & ~(mtd->erasesize - 1));
332 			off += mtd->erasesize;
333 			continue;
334 		}
335 
336 		/* Raw access */
337 		mtd_oob_ops_t ops = {
338 			.datbuf = (u8 *)addr,
339 			.oobbuf = ((u8 *)addr) + mtd->writesize,
340 			.len = mtd->writesize,
341 			.ooblen = mtd->oobsize,
342 			.mode = MTD_OPS_RAW
343 		};
344 
345 		if (read) {
346 			ret = mtd_read_oob(mtd, off, &ops);
347 		} else {
348 			ret = mtd_write_oob(mtd, off, &ops);
349 			if (!ret && !no_verify)
350 				ret = nand_verify_page_oob(mtd, &ops, off);
351 		}
352 
353 		if (ret) {
354 			printf("%s: error at offset %llx, ret %d\n",
355 				__func__, (long long)off, ret);
356 			break;
357 		}
358 
359 		addr += mtd->writesize + mtd->oobsize;
360 		off += mtd->writesize;
361 		count--;
362 	}
363 
364 	return ret;
365 }
366 
367 /* Adjust a chip/partition size down for bad blocks so we don't
368  * read/write past the end of a chip/partition by accident.
369  */
adjust_size_for_badblocks(loff_t * size,loff_t offset,int dev)370 static void adjust_size_for_badblocks(loff_t *size, loff_t offset, int dev)
371 {
372 	/* We grab the nand info object here fresh because this is usually
373 	 * called after arg_off_size() which can change the value of dev.
374 	 */
375 	struct mtd_info *mtd = get_nand_dev_by_index(dev);
376 	loff_t maxoffset = offset + *size;
377 	int badblocks = 0;
378 
379 	/* count badblocks in NAND from offset to offset + size */
380 	for (; offset < maxoffset; offset += mtd->erasesize) {
381 		if (nand_block_isbad(mtd, offset))
382 			badblocks++;
383 	}
384 	/* adjust size if any bad blocks found */
385 	if (badblocks) {
386 		*size -= badblocks * mtd->erasesize;
387 		printf("size adjusted to 0x%llx (%d bad blocks)\n",
388 		       (unsigned long long)*size, badblocks);
389 	}
390 }
391 
do_nand(cmd_tbl_t * cmdtp,int flag,int argc,char * const argv[])392 static int do_nand(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
393 {
394 	int i, ret = 0;
395 	ulong addr;
396 	loff_t off, size, maxsize;
397 	char *cmd, *s;
398 	struct mtd_info *mtd;
399 #ifdef CONFIG_SYS_NAND_QUIET
400 	int quiet = CONFIG_SYS_NAND_QUIET;
401 #else
402 	int quiet = 0;
403 #endif
404 	const char *quiet_str = env_get("quiet");
405 	int dev = nand_curr_device;
406 	int repeat = flag & CMD_FLAG_REPEAT;
407 
408 	/* at least two arguments please */
409 	if (argc < 2)
410 		goto usage;
411 
412 	if (quiet_str)
413 		quiet = simple_strtoul(quiet_str, NULL, 0) != 0;
414 
415 	cmd = argv[1];
416 
417 	/* Only "dump" is repeatable. */
418 	if (repeat && strcmp(cmd, "dump"))
419 		return 0;
420 
421 	if (strcmp(cmd, "info") == 0) {
422 
423 		putc('\n');
424 		for (i = 0; i < CONFIG_SYS_MAX_NAND_DEVICE; i++)
425 			nand_print_and_set_info(i);
426 		return 0;
427 	}
428 
429 	if (strcmp(cmd, "device") == 0) {
430 		if (argc < 3) {
431 			putc('\n');
432 			if (dev < 0 || dev >= CONFIG_SYS_MAX_NAND_DEVICE)
433 				puts("no devices available\n");
434 			else
435 				nand_print_and_set_info(dev);
436 			return 0;
437 		}
438 
439 		dev = (int)simple_strtoul(argv[2], NULL, 10);
440 		set_dev(dev);
441 
442 		return 0;
443 	}
444 
445 #ifdef CONFIG_ENV_OFFSET_OOB
446 	/* this command operates only on the first nand device */
447 	if (strcmp(cmd, "env.oob") == 0)
448 		return do_nand_env_oob(cmdtp, argc - 1, argv + 1);
449 #endif
450 
451 	/* The following commands operate on the current device, unless
452 	 * overridden by a partition specifier.  Note that if somehow the
453 	 * current device is invalid, it will have to be changed to a valid
454 	 * one before these commands can run, even if a partition specifier
455 	 * for another device is to be used.
456 	 */
457 	mtd = get_nand_dev_by_index(dev);
458 	if (!mtd) {
459 		puts("\nno devices available\n");
460 		return 1;
461 	}
462 
463 	if (strcmp(cmd, "bad") == 0) {
464 		printf("\nDevice %d bad blocks:\n", dev);
465 		for (off = 0; off < mtd->size; off += mtd->erasesize)
466 			if (nand_block_isbad(mtd, off))
467 				printf("  %08llx\n", (unsigned long long)off);
468 		return 0;
469 	}
470 
471 	/*
472 	 * Syntax is:
473 	 *   0    1     2       3    4
474 	 *   nand erase [clean] [off size]
475 	 */
476 	if (strncmp(cmd, "erase", 5) == 0 || strncmp(cmd, "scrub", 5) == 0) {
477 		nand_erase_options_t opts;
478 		/* "clean" at index 2 means request to write cleanmarker */
479 		int clean = argc > 2 && !strcmp("clean", argv[2]);
480 		int scrub_yes = argc > 2 && !strcmp("-y", argv[2]);
481 		int o = (clean || scrub_yes) ? 3 : 2;
482 		int scrub = !strncmp(cmd, "scrub", 5);
483 		int spread = 0;
484 		int args = 2;
485 		const char *scrub_warn =
486 			"Warning: "
487 			"scrub option will erase all factory set bad blocks!\n"
488 			"         "
489 			"There is no reliable way to recover them.\n"
490 			"         "
491 			"Use this command only for testing purposes if you\n"
492 			"         "
493 			"are sure of what you are doing!\n"
494 			"\nReally scrub this NAND flash? <y/N>\n";
495 
496 		if (cmd[5] != 0) {
497 			if (!strcmp(&cmd[5], ".spread")) {
498 				spread = 1;
499 			} else if (!strcmp(&cmd[5], ".part")) {
500 				args = 1;
501 			} else if (!strcmp(&cmd[5], ".chip")) {
502 				args = 0;
503 			} else {
504 				goto usage;
505 			}
506 		}
507 
508 		/*
509 		 * Don't allow missing arguments to cause full chip/partition
510 		 * erases -- easy to do accidentally, e.g. with a misspelled
511 		 * variable name.
512 		 */
513 		if (argc != o + args)
514 			goto usage;
515 
516 		printf("\nNAND %s: ", cmd);
517 		/* skip first two or three arguments, look for offset and size */
518 		if (mtd_arg_off_size(argc - o, argv + o, &dev, &off, &size,
519 				     &maxsize, MTD_DEV_TYPE_NAND,
520 				     mtd->size) != 0)
521 			return 1;
522 
523 		if (set_dev(dev))
524 			return 1;
525 
526 		mtd = get_nand_dev_by_index(dev);
527 
528 		memset(&opts, 0, sizeof(opts));
529 		opts.offset = off;
530 		opts.length = size;
531 		opts.jffs2  = clean;
532 		opts.quiet  = quiet;
533 		opts.spread = spread;
534 
535 		if (scrub) {
536 			if (scrub_yes) {
537 				opts.scrub = 1;
538 			} else {
539 				puts(scrub_warn);
540 				if (confirm_yesno()) {
541 					opts.scrub = 1;
542 				} else {
543 					puts("scrub aborted\n");
544 					return 1;
545 				}
546 			}
547 		}
548 		ret = nand_erase_opts(mtd, &opts);
549 		printf("%s\n", ret ? "ERROR" : "OK");
550 
551 		return ret == 0 ? 0 : 1;
552 	}
553 
554 	if (strncmp(cmd, "dump", 4) == 0) {
555 		if (argc < 3)
556 			goto usage;
557 
558 		off = (int)simple_strtoul(argv[2], NULL, 16);
559 		ret = nand_dump(mtd, off, !strcmp(&cmd[4], ".oob"), repeat);
560 
561 		return ret == 0 ? 1 : 0;
562 	}
563 
564 	if (strncmp(cmd, "read", 4) == 0 || strncmp(cmd, "write", 5) == 0) {
565 		size_t rwsize;
566 		ulong pagecount = 1;
567 		int read;
568 		int raw = 0;
569 		int no_verify = 0;
570 
571 		if (argc < 4)
572 			goto usage;
573 
574 		addr = (ulong)simple_strtoul(argv[2], NULL, 16);
575 
576 		read = strncmp(cmd, "read", 4) == 0; /* 1 = read, 0 = write */
577 		printf("\nNAND %s: ", read ? "read" : "write");
578 
579 		s = strchr(cmd, '.');
580 
581 		if (s && !strncmp(s, ".raw", 4)) {
582 			raw = 1;
583 
584 			if (!strcmp(s, ".raw.noverify"))
585 				no_verify = 1;
586 
587 			if (mtd_arg_off(argv[3], &dev, &off, &size, &maxsize,
588 					MTD_DEV_TYPE_NAND,
589 					mtd->size))
590 				return 1;
591 
592 			if (set_dev(dev))
593 				return 1;
594 
595 			mtd = get_nand_dev_by_index(dev);
596 
597 			if (argc > 4 && !str2long(argv[4], &pagecount)) {
598 				printf("'%s' is not a number\n", argv[4]);
599 				return 1;
600 			}
601 
602 			if (strncmp(cmd, "readbyte", 8) == 0 || strncmp(cmd, "writebyte", 9) == 0) {
603 				if (pagecount % (mtd->writesize + mtd->oobsize)) {
604 					printf("Count=%ld should be aligned with (writesize + oobsize)\n", pagecount);
605 					return -1;
606 				}
607 				pagecount = pagecount / (mtd->writesize + mtd->oobsize);
608 			}
609 
610 			if (pagecount * mtd->writesize > size) {
611 				puts("Size exceeds partition or device limit\n");
612 				return -1;
613 			}
614 
615 			rwsize = pagecount * (mtd->writesize + mtd->oobsize);
616 		} else {
617 			if (mtd_arg_off_size(argc - 3, argv + 3, &dev, &off,
618 					     &size, &maxsize,
619 					     MTD_DEV_TYPE_NAND,
620 					     mtd->size) != 0)
621 				return 1;
622 
623 			if (set_dev(dev))
624 				return 1;
625 
626 			/* size is unspecified */
627 			if (argc < 5)
628 				adjust_size_for_badblocks(&size, off, dev);
629 			rwsize = size;
630 		}
631 
632 		mtd = get_nand_dev_by_index(dev);
633 
634 		if (!s || !strcmp(s, ".jffs2") ||
635 		    !strcmp(s, ".e") || !strcmp(s, ".i")) {
636 			if (read)
637 				ret = nand_read_skip_bad(mtd, off, &rwsize,
638 							 NULL, maxsize,
639 							 (u_char *)addr);
640 			else
641 				ret = nand_write_skip_bad(mtd, off, &rwsize,
642 							  NULL, maxsize,
643 							  (u_char *)addr,
644 							  WITH_WR_VERIFY);
645 #ifdef CONFIG_CMD_NAND_TRIMFFS
646 		} else if (!strcmp(s, ".trimffs")) {
647 			if (read) {
648 				printf("Unknown nand command suffix '%s'\n", s);
649 				return 1;
650 			}
651 			ret = nand_write_skip_bad(mtd, off, &rwsize, NULL,
652 						maxsize, (u_char *)addr,
653 						WITH_DROP_FFS | WITH_WR_VERIFY);
654 #endif
655 		} else if (!strcmp(s, ".oob")) {
656 			/* out-of-band data */
657 			mtd_oob_ops_t ops = {
658 				.oobbuf = (u8 *)addr,
659 				.ooblen = rwsize,
660 				.mode = MTD_OPS_RAW
661 			};
662 
663 			if (read)
664 				ret = mtd_read_oob(mtd, off, &ops);
665 			else
666 				ret = mtd_write_oob(mtd, off, &ops);
667 		} else if (raw) {
668 			ret = raw_access(mtd, addr, off, pagecount, read,
669 					 no_verify);
670 		} else {
671 			printf("Unknown nand command suffix '%s'.\n", s);
672 			return 1;
673 		}
674 
675 		printf(" %zu bytes %s: %s\n", rwsize,
676 		       read ? "read" : "written", ret ? "ERROR" : "OK");
677 
678 		return ret == 0 ? 0 : 1;
679 	}
680 
681 #ifdef CONFIG_CMD_NAND_TORTURE
682 	if (strcmp(cmd, "torture") == 0) {
683 		loff_t endoff;
684 		unsigned int failed = 0, passed = 0;
685 
686 		if (argc < 3)
687 			goto usage;
688 
689 		if (!str2off(argv[2], &off)) {
690 			puts("Offset is not a valid number\n");
691 			return 1;
692 		}
693 
694 		size = mtd->erasesize;
695 		if (argc > 3) {
696 			if (!str2off(argv[3], &size)) {
697 				puts("Size is not a valid number\n");
698 				return 1;
699 			}
700 		}
701 
702 		endoff = off + size;
703 		if (endoff > mtd->size) {
704 			puts("Arguments beyond end of NAND\n");
705 			return 1;
706 		}
707 
708 		off = round_down(off, mtd->erasesize);
709 		endoff = round_up(endoff, mtd->erasesize);
710 		size = endoff - off;
711 		printf("\nNAND torture: device %d offset 0x%llx size 0x%llx (block size 0x%x)\n",
712 		       dev, off, size, mtd->erasesize);
713 		while (off < endoff) {
714 			ret = nand_torture(mtd, off);
715 			if (ret) {
716 				failed++;
717 				printf("  block at 0x%llx failed\n", off);
718 			} else {
719 				passed++;
720 			}
721 			off += mtd->erasesize;
722 		}
723 		printf(" Passed: %u, failed: %u\n", passed, failed);
724 		return failed != 0;
725 	}
726 #endif
727 
728 	if (strcmp(cmd, "markbad") == 0) {
729 		argc -= 2;
730 		argv += 2;
731 
732 		if (argc <= 0)
733 			goto usage;
734 
735 		while (argc > 0) {
736 			addr = simple_strtoul(*argv, NULL, 16);
737 
738 			if (mtd_block_markbad(mtd, addr)) {
739 				printf("block 0x%08lx NOT marked "
740 					"as bad! ERROR %d\n",
741 					addr, ret);
742 				ret = 1;
743 			} else {
744 				printf("block 0x%08lx successfully "
745 					"marked as bad\n",
746 					addr);
747 			}
748 			--argc;
749 			++argv;
750 		}
751 		return ret;
752 	}
753 
754 	if (strcmp(cmd, "biterr") == 0) {
755 		/* todo */
756 		return 1;
757 	}
758 
759 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
760 	if (strcmp(cmd, "lock") == 0) {
761 		int tight = 0;
762 		int status = 0;
763 		if (argc == 3) {
764 			if (!strcmp("tight", argv[2]))
765 				tight = 1;
766 			if (!strcmp("status", argv[2]))
767 				status = 1;
768 		}
769 		if (status) {
770 			do_nand_status(mtd);
771 		} else {
772 			if (!nand_lock(mtd, tight)) {
773 				puts("NAND flash successfully locked\n");
774 			} else {
775 				puts("Error locking NAND flash\n");
776 				return 1;
777 			}
778 		}
779 		return 0;
780 	}
781 
782 	if (strncmp(cmd, "unlock", 5) == 0) {
783 		int allexcept = 0;
784 
785 		s = strchr(cmd, '.');
786 
787 		if (s && !strcmp(s, ".allexcept"))
788 			allexcept = 1;
789 
790 		if (mtd_arg_off_size(argc - 2, argv + 2, &dev, &off, &size,
791 				     &maxsize, MTD_DEV_TYPE_NAND,
792 				     mtd->size) < 0)
793 			return 1;
794 
795 		if (set_dev(dev))
796 			return 1;
797 
798 		mtd = get_nand_dev_by_index(dev);
799 
800 		if (!nand_unlock(mtd, off, size, allexcept)) {
801 			puts("NAND flash successfully unlocked\n");
802 		} else {
803 			puts("Error unlocking NAND flash, "
804 			     "write and erase will probably fail\n");
805 			return 1;
806 		}
807 		return 0;
808 	}
809 #endif
810 
811 usage:
812 	return CMD_RET_USAGE;
813 }
814 
815 #ifdef CONFIG_SYS_LONGHELP
816 static char nand_help_text[] =
817 	"info - show available NAND devices\n"
818 	"nand device [dev] - show or set current device\n"
819 	"nand read - addr off|partition size\n"
820 	"nand write - addr off|partition size\n"
821 	"    read/write 'size' bytes starting at offset 'off'\n"
822 	"    to/from memory address 'addr', skipping bad blocks.\n"
823 	"nand read.raw - addr off|partition [count]\n"
824 	"nand write.raw[.noverify] - addr off|partition [count]\n"
825 	"    Use read.raw/write.raw to avoid ECC and access the flash as-is,\n"
826 	"    and skip bad\n"
827 #ifdef CONFIG_CMD_NAND_TRIMFFS
828 	"nand write.trimffs - addr off|partition size\n"
829 	"    write 'size' bytes starting at offset 'off' from memory address\n"
830 	"    'addr', skipping bad blocks and dropping any pages at the end\n"
831 	"    of eraseblocks that contain only 0xFF\n"
832 #endif
833 	"nand erase[.spread] [clean] off size - erase 'size' bytes "
834 	"from offset 'off'\n"
835 	"    With '.spread', erase enough for given file size, otherwise,\n"
836 	"    'size' includes skipped bad blocks.\n"
837 	"nand erase.part [clean] partition - erase entire mtd partition'\n"
838 	"nand erase.chip [clean] - erase entire chip'\n"
839 	"nand bad - show bad blocks\n"
840 	"nand dump[.oob] off - dump page\n"
841 #ifdef CONFIG_CMD_NAND_TORTURE
842 	"nand torture off - torture one block at offset\n"
843 	"nand torture off [size] - torture blocks from off to off+size\n"
844 #endif
845 	"nand scrub [-y] off size | scrub.part partition | scrub.chip\n"
846 	"    really clean NAND erasing bad blocks (UNSAFE)\n"
847 	"nand markbad off [...] - mark bad block(s) at offset (UNSAFE)\n"
848 	"nand biterr off - make a bit error at offset (UNSAFE)"
849 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
850 	"\n"
851 	"nand lock [tight] [status]\n"
852 	"    bring nand to lock state or display locked pages\n"
853 	"nand unlock[.allexcept] [offset] [size] - unlock section"
854 #endif
855 #ifdef CONFIG_ENV_OFFSET_OOB
856 	"\n"
857 	"nand env.oob - environment offset in OOB of block 0 of"
858 	"    first device.\n"
859 	"nand env.oob set off|partition - set enviromnent offset\n"
860 	"nand env.oob get - get environment offset"
861 #endif
862 	"";
863 #endif
864 
865 U_BOOT_CMD(
866 	nand, CONFIG_SYS_MAXARGS, 1, do_nand,
867 	"NAND sub-system", nand_help_text
868 );
869 
nand_load_image(cmd_tbl_t * cmdtp,struct mtd_info * mtd,ulong offset,ulong addr,char * cmd)870 static int nand_load_image(cmd_tbl_t *cmdtp, struct mtd_info *mtd,
871 			   ulong offset, ulong addr, char *cmd)
872 {
873 	int r;
874 	char *s;
875 	size_t cnt;
876 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
877 	image_header_t *hdr;
878 #endif
879 #if defined(CONFIG_FIT)
880 	const void *fit_hdr = NULL;
881 #endif
882 
883 	s = strchr(cmd, '.');
884 	if (s != NULL &&
885 	    (strcmp(s, ".jffs2") && strcmp(s, ".e") && strcmp(s, ".i"))) {
886 		printf("Unknown nand load suffix '%s'\n", s);
887 		bootstage_error(BOOTSTAGE_ID_NAND_SUFFIX);
888 		return 1;
889 	}
890 
891 	printf("\nLoading from %s, offset 0x%lx\n", mtd->name, offset);
892 
893 	cnt = mtd->writesize;
894 	r = nand_read_skip_bad(mtd, offset, &cnt, NULL, mtd->size,
895 			       (u_char *)addr);
896 	if (r) {
897 		puts("** Read error\n");
898 		bootstage_error(BOOTSTAGE_ID_NAND_HDR_READ);
899 		return 1;
900 	}
901 	bootstage_mark(BOOTSTAGE_ID_NAND_HDR_READ);
902 
903 	switch (genimg_get_format ((void *)addr)) {
904 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
905 	case IMAGE_FORMAT_LEGACY:
906 		hdr = (image_header_t *)addr;
907 
908 		bootstage_mark(BOOTSTAGE_ID_NAND_TYPE);
909 		image_print_contents (hdr);
910 
911 		cnt = image_get_image_size (hdr);
912 		break;
913 #endif
914 #if defined(CONFIG_FIT)
915 	case IMAGE_FORMAT_FIT:
916 		fit_hdr = (const void *)addr;
917 		puts ("Fit image detected...\n");
918 
919 		cnt = fit_get_size (fit_hdr);
920 		break;
921 #endif
922 	default:
923 		bootstage_error(BOOTSTAGE_ID_NAND_TYPE);
924 		puts ("** Unknown image type\n");
925 		return 1;
926 	}
927 	bootstage_mark(BOOTSTAGE_ID_NAND_TYPE);
928 
929 	r = nand_read_skip_bad(mtd, offset, &cnt, NULL, mtd->size,
930 			       (u_char *)addr);
931 	if (r) {
932 		puts("** Read error\n");
933 		bootstage_error(BOOTSTAGE_ID_NAND_READ);
934 		return 1;
935 	}
936 	bootstage_mark(BOOTSTAGE_ID_NAND_READ);
937 
938 #if defined(CONFIG_FIT)
939 	/* This cannot be done earlier, we need complete FIT image in RAM first */
940 	if (genimg_get_format ((void *)addr) == IMAGE_FORMAT_FIT) {
941 		if (!fit_check_format (fit_hdr)) {
942 			bootstage_error(BOOTSTAGE_ID_NAND_FIT_READ);
943 			puts ("** Bad FIT image format\n");
944 			return 1;
945 		}
946 		bootstage_mark(BOOTSTAGE_ID_NAND_FIT_READ_OK);
947 		fit_print_contents (fit_hdr);
948 	}
949 #endif
950 
951 	/* Loading ok, update default load address */
952 
953 	load_addr = addr;
954 
955 	return bootm_maybe_autostart(cmdtp, cmd);
956 }
957 
do_nandboot(cmd_tbl_t * cmdtp,int flag,int argc,char * const argv[])958 static int do_nandboot(cmd_tbl_t *cmdtp, int flag, int argc,
959 		       char * const argv[])
960 {
961 	char *boot_device = NULL;
962 	int idx;
963 	ulong addr, offset = 0;
964 	struct mtd_info *mtd;
965 #if defined(CONFIG_CMD_MTDPARTS)
966 	struct mtd_device *dev;
967 	struct part_info *part;
968 	u8 pnum;
969 
970 	if (argc >= 2) {
971 		char *p = (argc == 2) ? argv[1] : argv[2];
972 		if (!(str2long(p, &addr)) && (mtdparts_init() == 0) &&
973 		    (find_dev_and_part(p, &dev, &pnum, &part) == 0)) {
974 			if (dev->id->type != MTD_DEV_TYPE_NAND) {
975 				puts("Not a NAND device\n");
976 				return 1;
977 			}
978 			if (argc > 3)
979 				goto usage;
980 			if (argc == 3)
981 				addr = simple_strtoul(argv[1], NULL, 16);
982 			else
983 				addr = CONFIG_SYS_LOAD_ADDR;
984 
985 			mtd = get_nand_dev_by_index(dev->id->num);
986 			return nand_load_image(cmdtp, mtd, part->offset,
987 					       addr, argv[0]);
988 		}
989 	}
990 #endif
991 
992 	bootstage_mark(BOOTSTAGE_ID_NAND_PART);
993 	switch (argc) {
994 	case 1:
995 		addr = CONFIG_SYS_LOAD_ADDR;
996 		boot_device = env_get("bootdevice");
997 		break;
998 	case 2:
999 		addr = simple_strtoul(argv[1], NULL, 16);
1000 		boot_device = env_get("bootdevice");
1001 		break;
1002 	case 3:
1003 		addr = simple_strtoul(argv[1], NULL, 16);
1004 		boot_device = argv[2];
1005 		break;
1006 	case 4:
1007 		addr = simple_strtoul(argv[1], NULL, 16);
1008 		boot_device = argv[2];
1009 		offset = simple_strtoul(argv[3], NULL, 16);
1010 		break;
1011 	default:
1012 #if defined(CONFIG_CMD_MTDPARTS)
1013 usage:
1014 #endif
1015 		bootstage_error(BOOTSTAGE_ID_NAND_SUFFIX);
1016 		return CMD_RET_USAGE;
1017 	}
1018 	bootstage_mark(BOOTSTAGE_ID_NAND_SUFFIX);
1019 
1020 	if (!boot_device) {
1021 		puts("\n** No boot device **\n");
1022 		bootstage_error(BOOTSTAGE_ID_NAND_BOOT_DEVICE);
1023 		return 1;
1024 	}
1025 	bootstage_mark(BOOTSTAGE_ID_NAND_BOOT_DEVICE);
1026 
1027 	idx = simple_strtoul(boot_device, NULL, 16);
1028 
1029 	mtd = get_nand_dev_by_index(idx);
1030 	if (!mtd) {
1031 		printf("\n** Device %d not available\n", idx);
1032 		bootstage_error(BOOTSTAGE_ID_NAND_AVAILABLE);
1033 		return 1;
1034 	}
1035 	bootstage_mark(BOOTSTAGE_ID_NAND_AVAILABLE);
1036 
1037 	return nand_load_image(cmdtp, mtd, offset, addr, argv[0]);
1038 }
1039 
1040 U_BOOT_CMD(nboot, 4, 1, do_nandboot,
1041 	"boot from NAND device",
1042 	"[partition] | [[[loadAddr] dev] offset]"
1043 );
1044