cmd_onenand.c 12.7 KB
Newer Older
Kyungmin Park's avatar
Kyungmin Park committed
1 2 3
/*
 *  U-Boot command for OneNAND support
 *
4
 *  Copyright (C) 2005-2008 Samsung Electronics
Kyungmin Park's avatar
Kyungmin Park committed
5 6 7 8 9 10 11 12 13
 *  Kyungmin Park <kyungmin.park@samsung.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#include <common.h>
#include <command.h>
14
#include <malloc.h>
Kyungmin Park's avatar
Kyungmin Park committed
15

16
#include <linux/compat.h>
Kyungmin Park's avatar
Kyungmin Park committed
17 18 19 20 21
#include <linux/mtd/mtd.h>
#include <linux/mtd/onenand.h>

#include <asm/io.h>

22 23 24 25 26 27 28 29 30 31 32 33 34
static struct mtd_info *mtd;

static loff_t next_ofs;
static loff_t skip_ofs;

static inline int str2long(char *p, ulong *num)
{
	char *endptr;

	*num = simple_strtoul(p, &endptr, 16);
	return (*p != '\0' && *endptr == '\0') ? 1 : 0;
}

35
static int arg_off_size(int argc, char * const argv[], ulong *off, size_t *size)
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
{
	if (argc >= 1) {
		if (!(str2long(argv[0], off))) {
			printf("'%s' is not a number\n", argv[0]);
			return -1;
		}
	} else {
		*off = 0;
	}

	if (argc >= 2) {
		if (!(str2long(argv[1], (ulong *)size))) {
			printf("'%s' is not a number\n", argv[1]);
			return -1;
		}
	} else {
		*size = mtd->size - *off;
	}

	if ((*off + *size) > mtd->size) {
56
		printf("total chip size (0x%llx) exceeded!\n", mtd->size);
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
		return -1;
	}

	if (*size == mtd->size)
		puts("whole chip\n");
	else
		printf("offset 0x%lx, size 0x%x\n", *off, *size);

	return 0;
}

static int onenand_block_read(loff_t from, size_t len,
			      size_t *retlen, u_char *buf, int oob)
{
	struct onenand_chip *this = mtd->priv;
	int blocks = (int) len >> this->erase_shift;
	int blocksize = (1 << this->erase_shift);
	loff_t ofs = from;
	struct mtd_oob_ops ops = {
		.retlen		= 0,
	};
	int ret;

	if (oob)
		ops.ooblen = blocksize;
	else
		ops.len = blocksize;

	while (blocks) {
		ret = mtd->block_isbad(mtd, ofs);
		if (ret) {
			printk("Bad blocks %d at 0x%x\n",
			       (u32)(ofs >> this->erase_shift), (u32)ofs);
			ofs += blocksize;
			continue;
		}

		if (oob)
			ops.oobbuf = buf;
		else
			ops.datbuf = buf;

		ops.retlen = 0;
		ret = mtd->read_oob(mtd, ofs, &ops);
		if (ret) {
			printk("Read failed 0x%x, %d\n", (u32)ofs, ret);
			ofs += blocksize;
			continue;
		}
		ofs += blocksize;
		buf += blocksize;
		blocks--;
		*retlen += ops.retlen;
	}

	return 0;
}

Lei Wen's avatar
Lei Wen committed
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
static int onenand_write_oneblock_withoob(loff_t to, const u_char * buf,
					  size_t *retlen)
{
	struct mtd_oob_ops ops = {
		.len = mtd->writesize,
		.ooblen = mtd->oobsize,
		.mode = MTD_OOB_AUTO,
	};
	int page, ret = 0;
	for (page = 0; page < (mtd->erasesize / mtd->writesize); page ++) {
		ops.datbuf = (u_char *)buf;
		buf += mtd->writesize;
		ops.oobbuf = (u_char *)buf;
		buf += mtd->oobsize;
		ret = mtd->write_oob(mtd, to, &ops);
		if (ret)
			break;
		to += mtd->writesize;
	}

	*retlen = (ret) ? 0 : mtd->erasesize;
	return ret;
}

139
static int onenand_block_write(loff_t to, size_t len,
Lei Wen's avatar
Lei Wen committed
140
			       size_t *retlen, const u_char * buf, int withoob)
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
{
	struct onenand_chip *this = mtd->priv;
	int blocks = len >> this->erase_shift;
	int blocksize = (1 << this->erase_shift);
	loff_t ofs;
	size_t _retlen = 0;
	int ret;

	if (to == next_ofs) {
		next_ofs = to + len;
		to += skip_ofs;
	} else {
		next_ofs = to + len;
		skip_ofs = 0;
	}
	ofs = to;

	while (blocks) {
		ret = mtd->block_isbad(mtd, ofs);
		if (ret) {
			printk("Bad blocks %d at 0x%x\n",
			       (u32)(ofs >> this->erase_shift), (u32)ofs);
			skip_ofs += blocksize;
			goto next;
		}

Lei Wen's avatar
Lei Wen committed
167 168 169 170
		if (!withoob)
			ret = mtd->write(mtd, ofs, blocksize, &_retlen, buf);
		else
			ret = onenand_write_oneblock_withoob(ofs, buf, &_retlen);
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
		if (ret) {
			printk("Write failed 0x%x, %d", (u32)ofs, ret);
			skip_ofs += blocksize;
			goto next;
		}

		buf += blocksize;
		blocks--;
		*retlen += _retlen;
next:
		ofs += blocksize;
	}

	return 0;
}

static int onenand_block_erase(u32 start, u32 size, int force)
{
	struct onenand_chip *this = mtd->priv;
	struct erase_info instr = {
		.callback	= NULL,
	};
	loff_t ofs;
	int ret;
	int blocksize = 1 << this->erase_shift;

	for (ofs = start; ofs < (start + size); ofs += blocksize) {
		ret = mtd->block_isbad(mtd, ofs);
		if (ret && !force) {
			printf("Skip erase bad block %d at 0x%x\n",
			       (u32)(ofs >> this->erase_shift), (u32)ofs);
			continue;
		}

		instr.addr = ofs;
		instr.len = blocksize;
		instr.priv = force;
		instr.mtd = mtd;
		ret = mtd->erase(mtd, &instr);
		if (ret) {
			printf("erase failed block %d at 0x%x\n",
			       (u32)(ofs >> this->erase_shift), (u32)ofs);
			continue;
		}
	}

	return 0;
}

static int onenand_block_test(u32 start, u32 size)
{
	struct onenand_chip *this = mtd->priv;
	struct erase_info instr = {
		.callback	= NULL,
		.priv		= 0,
	};

	int blocks;
	loff_t ofs;
	int blocksize = 1 << this->erase_shift;
	int start_block, end_block;
	size_t retlen;
	u_char *buf;
	u_char *verify_buf;
	int ret;

	buf = malloc(blocksize);
	if (!buf) {
		printf("Not enough malloc space available!\n");
		return -1;
	}

	verify_buf = malloc(blocksize);
	if (!verify_buf) {
		printf("Not enough malloc space available!\n");
		return -1;
	}

	start_block = start >> this->erase_shift;
	end_block = (start + size) >> this->erase_shift;

	/* Protect boot-loader from badblock testing */
	if (start_block < 2)
		start_block = 2;

	if (end_block > (mtd->size >> this->erase_shift))
		end_block = mtd->size >> this->erase_shift;

	blocks = start_block;
	ofs = start;
	while (blocks < end_block) {
		printf("\rTesting block %d at 0x%x", (u32)(ofs >> this->erase_shift), (u32)ofs);

		ret = mtd->block_isbad(mtd, ofs);
		if (ret) {
			printf("Skip erase bad block %d at 0x%x\n",
			       (u32)(ofs >> this->erase_shift), (u32)ofs);
			goto next;
		}

		instr.addr = ofs;
		instr.len = blocksize;
		ret = mtd->erase(mtd, &instr);
		if (ret) {
			printk("Erase failed 0x%x, %d\n", (u32)ofs, ret);
			goto next;
		}

		ret = mtd->write(mtd, ofs, blocksize, &retlen, buf);
		if (ret) {
			printk("Write failed 0x%x, %d\n", (u32)ofs, ret);
			goto next;
		}

		ret = mtd->read(mtd, ofs, blocksize, &retlen, verify_buf);
		if (ret) {
			printk("Read failed 0x%x, %d\n", (u32)ofs, ret);
			goto next;
		}

		if (memcmp(buf, verify_buf, blocksize))
			printk("\nRead/Write test failed at 0x%x\n", (u32)ofs);

next:
		ofs += blocksize;
		blocks++;
	}
	printf("...Done\n");

	free(buf);
	free(verify_buf);

	return 0;
}

static int onenand_dump(struct mtd_info *mtd, ulong off, int only_oob)
{
	int i;
	u_char *datbuf, *oobbuf, *p;
	struct mtd_oob_ops ops;
	loff_t addr;

	datbuf = malloc(mtd->writesize + mtd->oobsize);
	oobbuf = malloc(mtd->oobsize);
	if (!datbuf || !oobbuf) {
		puts("No memory for page buffer\n");
		return 1;
	}
	off &= ~(mtd->writesize - 1);
	addr = (loff_t) off;
	memset(&ops, 0, sizeof(ops));
	ops.datbuf = datbuf;
Lei Wen's avatar
Lei Wen committed
323
	ops.oobbuf = oobbuf;
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
	ops.len = mtd->writesize;
	ops.ooblen = mtd->oobsize;
	ops.retlen = 0;
	i = mtd->read_oob(mtd, addr, &ops);
	if (i < 0) {
		printf("Error (%d) reading page %08lx\n", i, off);
		free(datbuf);
		free(oobbuf);
		return 1;
	}
	printf("Page %08lx dump:\n", off);
	i = mtd->writesize >> 4;
	p = datbuf;

	while (i--) {
		if (!only_oob)
			printf("\t%02x %02x %02x %02x %02x %02x %02x %02x"
			       "  %02x %02x %02x %02x %02x %02x %02x %02x\n",
			       p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7],
			       p[8], p[9], p[10], p[11], p[12], p[13], p[14],
			       p[15]);
		p += 16;
	}
	puts("OOB:\n");
	i = mtd->oobsize >> 3;
Lei Wen's avatar
Lei Wen committed
349 350
	p = oobbuf;

351 352 353 354 355 356 357 358 359 360
	while (i--) {
		printf("\t%02x %02x %02x %02x %02x %02x %02x %02x\n",
		       p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7]);
		p += 8;
	}
	free(datbuf);
	free(oobbuf);

	return 0;
}
Kyungmin Park's avatar
Kyungmin Park committed
361

362
static int do_onenand_info(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
Kyungmin Park's avatar
Kyungmin Park committed
363
{
364 365 366 367
	printf("%s\n", mtd->name);
	return 0;
}

368
static int do_onenand_bad(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
369 370 371 372 373 374 375 376 377 378 379 380 381 382
{
	ulong ofs;

	mtd = &onenand_mtd;
	/* Currently only one OneNAND device is supported */
	printf("\nDevice %d bad blocks:\n", 0);
	for (ofs = 0; ofs < mtd->size; ofs += mtd->erasesize) {
		if (mtd->block_isbad(mtd, ofs))
			printf("  %08x\n", (u32)ofs);
	}

	return 0;
}

383
static int do_onenand_read(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
384 385 386
{
	char *s;
	int oob = 0;
387
	ulong addr, ofs;
388
	size_t len;
389
	int ret = 0;
390
	size_t retlen = 0;
391

392
	if (argc < 3)
393
		return CMD_RET_USAGE;
394

395 396 397
	s = strchr(argv[0], '.');
	if ((s != NULL) && (!strcmp(s, ".oob")))
		oob = 1;
Kyungmin Park's avatar
Kyungmin Park committed
398

399
	addr = (ulong)simple_strtoul(argv[1], NULL, 16);
Kyungmin Park's avatar
Kyungmin Park committed
400

401 402 403
	printf("\nOneNAND read: ");
	if (arg_off_size(argc - 2, argv + 2, &ofs, &len) != 0)
		return 1;
404

405
	ret = onenand_block_read(ofs, len, &retlen, (u8 *)addr, oob);
406

407
	printf(" %d bytes read: %s\n", retlen, ret ? "ERROR" : "OK");
Kyungmin Park's avatar
Kyungmin Park committed
408

409 410
	return ret == 0 ? 0 : 1;
}
Kyungmin Park's avatar
Kyungmin Park committed
411

412
static int do_onenand_write(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
413 414 415
{
	ulong addr, ofs;
	size_t len;
Lei Wen's avatar
Lei Wen committed
416
	int ret = 0, withoob = 0;
417
	size_t retlen = 0;
Kyungmin Park's avatar
Kyungmin Park committed
418

419
	if (argc < 3)
420
		return CMD_RET_USAGE;
Kyungmin Park's avatar
Kyungmin Park committed
421

Lei Wen's avatar
Lei Wen committed
422 423 424
	if (strncmp(argv[0] + 6, "yaffs", 5) == 0)
		withoob = 1;

425 426 427 428 429
	addr = (ulong)simple_strtoul(argv[1], NULL, 16);

	printf("\nOneNAND write: ");
	if (arg_off_size(argc - 2, argv + 2, &ofs, &len) != 0)
		return 1;
Kyungmin Park's avatar
Kyungmin Park committed
430

Lei Wen's avatar
Lei Wen committed
431
	ret = onenand_block_write(ofs, len, &retlen, (u8 *)addr, withoob);
Kyungmin Park's avatar
Kyungmin Park committed
432

433
	printf(" %d bytes written: %s\n", retlen, ret ? "ERROR" : "OK");
434

435 436 437
	return ret == 0 ? 0 : 1;
}

438
static int do_onenand_erase(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
{
	ulong ofs;
	int ret = 0;
	size_t len;
	int force;

	/*
	 * Syntax is:
	 *   0       1     2       3    4
	 *   onenand erase [force] [off size]
	 */
	argc--;
	argv++;
	if (argc)
	{
		if (!strcmp("force", argv[0]))
		{
			force = 1;
			argc--;
			argv++;
Kyungmin Park's avatar
Kyungmin Park committed
459
		}
460 461
	}
	printf("\nOneNAND erase: ");
Kyungmin Park's avatar
Kyungmin Park committed
462

463 464 465
	/* skip first two or three arguments, look for offset and size */
	if (arg_off_size(argc, argv, &ofs, &len) != 0)
		return 1;
466

467
	ret = onenand_block_erase(ofs, len, force);
468

469
	printf("%s\n", ret ? "ERROR" : "OK");
Kyungmin Park's avatar
Kyungmin Park committed
470

471 472
	return ret == 0 ? 0 : 1;
}
Kyungmin Park's avatar
Kyungmin Park committed
473

474
static int do_onenand_test(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
475 476 477 478
{
	ulong ofs;
	int ret = 0;
	size_t len;
Kyungmin Park's avatar
Kyungmin Park committed
479

480 481 482 483 484
	/*
	 * Syntax is:
	 *   0       1     2       3    4
	 *   onenand test [force] [off size]
	 */
Kyungmin Park's avatar
Kyungmin Park committed
485

486
	printf("\nOneNAND test: ");
Kyungmin Park's avatar
Kyungmin Park committed
487

488 489 490
	/* skip first two or three arguments, look for offset and size */
	if (arg_off_size(argc - 1, argv + 1, &ofs, &len) != 0)
		return 1;
Kyungmin Park's avatar
Kyungmin Park committed
491

492
	ret = onenand_block_test(ofs, len);
Kyungmin Park's avatar
Kyungmin Park committed
493

494
	printf("%s\n", ret ? "ERROR" : "OK");
Kyungmin Park's avatar
Kyungmin Park committed
495

496 497
	return ret == 0 ? 0 : 1;
}
498

499
static int do_onenand_dump(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
500 501 502 503
{
	ulong ofs;
	int ret = 0;
	char *s;
Kyungmin Park's avatar
Kyungmin Park committed
504

505
	if (argc < 2)
506
		return CMD_RET_USAGE;
507 508 509 510 511 512 513 514

	s = strchr(argv[0], '.');
	ofs = (int)simple_strtoul(argv[1], NULL, 16);

	if (s != NULL && strcmp(s, ".oob") == 0)
		ret = onenand_dump(mtd, ofs, 1);
	else
		ret = onenand_dump(mtd, ofs, 0);
Kyungmin Park's avatar
Kyungmin Park committed
515

516 517 518
	return ret == 0 ? 1 : 0;
}

519
static int do_onenand_markbad(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
520 521 522 523 524 525 526 527
{
	int ret = 0;
	ulong addr;

	argc -= 2;
	argv += 2;

	if (argc <= 0)
528
		return CMD_RET_USAGE;
Kyungmin Park's avatar
Kyungmin Park committed
529

530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
	while (argc > 0) {
		addr = simple_strtoul(*argv, NULL, 16);

		if (mtd->block_markbad(mtd, addr)) {
			printf("block 0x%08lx NOT marked "
				"as bad! ERROR %d\n",
				addr, ret);
			ret = 1;
		} else {
			printf("block 0x%08lx successfully "
				"marked as bad\n",
				addr);
		}
		--argc;
		++argv;
	}
	return ret;
}

static cmd_tbl_t cmd_onenand_sub[] = {
	U_BOOT_CMD_MKENT(info, 1, 0, do_onenand_info, "", ""),
	U_BOOT_CMD_MKENT(bad, 1, 0, do_onenand_bad, "", ""),
	U_BOOT_CMD_MKENT(read, 4, 0, do_onenand_read, "", ""),
	U_BOOT_CMD_MKENT(write, 4, 0, do_onenand_write, "", ""),
Lei Wen's avatar
Lei Wen committed
554
	U_BOOT_CMD_MKENT(write.yaffs, 4, 0, do_onenand_write, "", ""),
555 556 557 558 559 560
	U_BOOT_CMD_MKENT(erase, 3, 0, do_onenand_erase, "", ""),
	U_BOOT_CMD_MKENT(test, 3, 0, do_onenand_test, "", ""),
	U_BOOT_CMD_MKENT(dump, 2, 0, do_onenand_dump, "", ""),
	U_BOOT_CMD_MKENT(markbad, CONFIG_SYS_MAXARGS, 0, do_onenand_markbad, "", ""),
};

561
#ifdef CONFIG_NEEDS_MANUAL_RELOC
562 563 564 565 566
void onenand_reloc(void) {
	fixup_cmdtable(cmd_onenand_sub, ARRAY_SIZE(cmd_onenand_sub));
}
#endif

567
static int do_onenand(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
568 569 570
{
	cmd_tbl_t *c;

571
	if (argc < 2)
572
		return CMD_RET_USAGE;
573

574 575 576 577 578
	mtd = &onenand_mtd;

	/* Strip off leading 'onenand' command argument */
	argc--;
	argv++;
579

580 581
	c = find_cmd_tbl(argv[0], &cmd_onenand_sub[0], ARRAY_SIZE(cmd_onenand_sub));

582 583 584
	if (c)
		return c->cmd(cmdtp, flag, argc, argv);
	else
585
		return CMD_RET_USAGE;
Kyungmin Park's avatar
Kyungmin Park committed
586 587 588
}

U_BOOT_CMD(
589
	onenand,	CONFIG_SYS_MAXARGS,	1,	do_onenand,
Peter Tyser's avatar
Peter Tyser committed
590
	"OneNAND sub-system",
591 592 593
	"info - show available OneNAND devices\n"
	"onenand bad - show bad blocks\n"
	"onenand read[.oob] addr off size\n"
Lei Wen's avatar
Lei Wen committed
594
	"onenand write[.yaffs] addr off size\n"
595 596 597 598 599 600
	"    read/write 'size' bytes starting at offset 'off'\n"
	"    to/from memory address 'addr', skipping bad blocks.\n"
	"onenand erase [force] [off size] - erase 'size' bytes from\n"
	"onenand test [off size] - test 'size' bytes from\n"
	"    offset 'off' (entire device if not specified)\n"
	"onenand dump[.oob] off - dump page\n"
Wolfgang Denk's avatar
Wolfgang Denk committed
601
	"onenand markbad off [...] - mark bad block(s) at offset (UNSAFE)"
Kyungmin Park's avatar
Kyungmin Park committed
602
);