ubi.c 14.9 KB
Newer Older
1 2 3 4 5 6
/*
 * Unsorted Block Image commands
 *
 *  Copyright (C) 2008 Samsung Electronics
 *  Kyungmin Park <kyungmin.park@samsung.com>
 *
7
 * Copyright 2008-2009 Stefan Roese <sr@denx.de>, DENX Software Engineering
8 9 10 11 12 13 14 15 16
 *
 * 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>
#include <exports.h>
17
#include <memalign.h>
18 19 20 21
#include <nand.h>
#include <onenand_uboot.h>
#include <linux/mtd/mtd.h>
#include <linux/mtd/partitions.h>
22
#include <linux/err.h>
23 24 25 26
#include <ubi_uboot.h>
#include <asm/errno.h>
#include <jffs2/load_kernel.h>

27 28 29
#undef ubi_msg
#define ubi_msg(fmt, ...) printf("UBI: " fmt "\n", ##__VA_ARGS__)

30 31 32
#define DEV_TYPE_NONE		0
#define DEV_TYPE_NAND		1
#define DEV_TYPE_ONENAND	2
33
#define DEV_TYPE_NOR		3
34 35 36

/* Private own data */
static struct ubi_device *ubi;
37
static char buffer[80];
38
static int ubi_initialized;
39 40 41

struct selected_dev {
	char part_name[80];
42
	int selected;
43 44 45 46 47 48
	int nr;
	struct mtd_info *mtd_info;
};

static struct selected_dev ubi_dev;

49 50 51 52 53
#ifdef CONFIG_CMD_UBIFS
int ubifs_is_mounted(void);
void cmd_ubifs_umount(void);
#endif

54 55 56 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
static void display_volume_info(struct ubi_device *ubi)
{
	int i;

	for (i = 0; i < (ubi->vtbl_slots + 1); i++) {
		if (!ubi->volumes[i])
			continue;	/* Empty record */
		ubi_dump_vol_info(ubi->volumes[i]);
	}
}

static void display_ubi_info(struct ubi_device *ubi)
{
	ubi_msg("MTD device name:            \"%s\"", ubi->mtd->name);
	ubi_msg("MTD device size:            %llu MiB", ubi->flash_size >> 20);
	ubi_msg("physical eraseblock size:   %d bytes (%d KiB)",
			ubi->peb_size, ubi->peb_size >> 10);
	ubi_msg("logical eraseblock size:    %d bytes", ubi->leb_size);
	ubi_msg("number of good PEBs:        %d", ubi->good_peb_count);
	ubi_msg("number of bad PEBs:         %d", ubi->bad_peb_count);
	ubi_msg("smallest flash I/O unit:    %d", ubi->min_io_size);
	ubi_msg("VID header offset:          %d (aligned %d)",
			ubi->vid_hdr_offset, ubi->vid_hdr_aloffset);
	ubi_msg("data offset:                %d", ubi->leb_start);
	ubi_msg("max. allowed volumes:       %d", ubi->vtbl_slots);
	ubi_msg("wear-leveling threshold:    %d", CONFIG_MTD_UBI_WL_THRESHOLD);
	ubi_msg("number of internal volumes: %d", UBI_INT_VOL_COUNT);
	ubi_msg("number of user volumes:     %d",
			ubi->vol_count - UBI_INT_VOL_COUNT);
	ubi_msg("available PEBs:             %d", ubi->avail_pebs);
	ubi_msg("total number of reserved PEBs: %d", ubi->rsvd_pebs);
	ubi_msg("number of PEBs reserved for bad PEB handling: %d",
			ubi->beb_rsvd_pebs);
	ubi_msg("max/mean erase counter: %d/%d", ubi->max_ec, ubi->mean_ec);
}

static int ubi_info(int layout)
{
	if (layout)
		display_volume_info(ubi);
	else
		display_ubi_info(ubi);

	return 0;
}

100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
static int ubi_check_volumename(const struct ubi_volume *vol, char *name)
{
	return strcmp(vol->name, name);
}

static int ubi_check(char *name)
{
	int i;

	for (i = 0; i < (ubi->vtbl_slots + 1); i++) {
		if (!ubi->volumes[i])
			continue;	/* Empty record */

		if (!ubi_check_volumename(ubi->volumes[i], name))
			return 0;
	}

117
	return 1;
118 119 120
}


121 122 123
static int verify_mkvol_req(const struct ubi_device *ubi,
			    const struct ubi_mkvol_req *req)
{
124
	int n, err = EINVAL;
125 126 127 128 129 130 131 132 133 134 135 136

	if (req->bytes < 0 || req->alignment < 0 || req->vol_type < 0 ||
	    req->name_len < 0)
		goto bad;

	if ((req->vol_id < 0 || req->vol_id >= ubi->vtbl_slots) &&
	    req->vol_id != UBI_VOL_NUM_AUTO)
		goto bad;

	if (req->alignment == 0)
		goto bad;

137 138 139
	if (req->bytes == 0) {
		printf("No space left in UBI device!\n");
		err = ENOMEM;
140
		goto bad;
141
	}
142 143 144 145 146 147 148 149 150 151 152 153 154

	if (req->vol_type != UBI_DYNAMIC_VOLUME &&
	    req->vol_type != UBI_STATIC_VOLUME)
		goto bad;

	if (req->alignment > ubi->leb_size)
		goto bad;

	n = req->alignment % ubi->min_io_size;
	if (req->alignment != 1 && n)
		goto bad;

	if (req->name_len > UBI_VOL_NAME_MAX) {
155 156
		printf("Name too long!\n");
		err = ENAMETOOLONG;
157 158 159 160 161 162 163 164
		goto bad;
	}

	return 0;
bad:
	return err;
}

165
static int ubi_create_vol(char *volume, int64_t size, int dynamic)
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
{
	struct ubi_mkvol_req req;
	int err;

	if (dynamic)
		req.vol_type = UBI_DYNAMIC_VOLUME;
	else
		req.vol_type = UBI_STATIC_VOLUME;

	req.vol_id = UBI_VOL_NUM_AUTO;
	req.alignment = 1;
	req.bytes = size;

	strcpy(req.name, volume);
	req.name_len = strlen(volume);
	req.name[req.name_len] = '\0';
	req.padding1 = 0;
	/* It's duplicated at drivers/mtd/ubi/cdev.c */
	err = verify_mkvol_req(ubi, &req);
	if (err) {
		printf("verify_mkvol_req failed %d\n", err);
		return err;
	}
189
	printf("Creating %s volume %s of size %lld\n",
190 191 192 193 194
		dynamic ? "dynamic" : "static", volume, size);
	/* Call real ubi create volume */
	return ubi_create_volume(ubi, &req);
}

195
static struct ubi_volume *ubi_find_volume(char *volume)
196
{
197
	struct ubi_volume *vol = NULL;
198
	int i;
199 200 201

	for (i = 0; i < ubi->vtbl_slots; i++) {
		vol = ubi->volumes[i];
202 203
		if (vol && !strcmp(vol->name, volume))
			return vol;
204
	}
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219

	printf("Volume %s not found!\n", volume);
	return NULL;
}

static int ubi_remove_vol(char *volume)
{
	int err, reserved_pebs, i;
	struct ubi_volume *vol;

	vol = ubi_find_volume(volume);
	if (vol == NULL)
		return ENODEV;

	printf("Remove UBI volume %s (id %d)\n", vol->name, vol->vol_id);
220 221 222

	if (ubi->ro_mode) {
		printf("It's read-only mode\n");
223
		err = EROFS;
224 225 226
		goto out_err;
	}

227
	err = ubi_change_vtbl_record(ubi, vol->vol_id, NULL);
228 229 230 231 232 233 234 235 236 237 238 239
	if (err) {
		printf("Error changing Vol tabel record err=%x\n", err);
		goto out_err;
	}
	reserved_pebs = vol->reserved_pebs;
	for (i = 0; i < vol->reserved_pebs; i++) {
		err = ubi_eba_unmap_leb(ubi, vol, i);
		if (err)
			goto out_err;
	}

	kfree(vol->eba_tbl);
240 241
	ubi->volumes[vol->vol_id]->eba_tbl = NULL;
	ubi->volumes[vol->vol_id] = NULL;
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257

	ubi->rsvd_pebs -= reserved_pebs;
	ubi->avail_pebs += reserved_pebs;
	i = ubi->beb_rsvd_level - ubi->beb_rsvd_pebs;
	if (i > 0) {
		i = ubi->avail_pebs >= i ? i : ubi->avail_pebs;
		ubi->avail_pebs -= i;
		ubi->rsvd_pebs += i;
		ubi->beb_rsvd_pebs += i;
		if (i > 0)
			ubi_msg("reserve more %d PEBs", i);
	}
	ubi->vol_count -= 1;

	return 0;
out_err:
258
	ubi_err(ubi, "cannot remove volume %s, error %d", volume, err);
259 260
	if (err < 0)
		err = -err;
261 262 263
	return err;
}

264
static int ubi_volume_continue_write(char *volume, void *buf, size_t size)
265
{
266
	int err = 1;
267 268
	struct ubi_volume *vol;

269 270 271 272
	vol = ubi_find_volume(volume);
	if (vol == NULL)
		return ENODEV;

273 274
	err = ubi_more_update_data(ubi, vol, buf, size);
	if (err < 0) {
275 276
		printf("Couldnt or partially wrote data\n");
		return -err;
277 278 279 280 281 282
	}

	if (err) {
		size = err;

		err = ubi_check_volume(ubi, vol->vol_id);
283 284
		if (err < 0)
			return -err;
285 286

		if (err) {
287 288
			ubi_warn(ubi, "volume %d on UBI device %d is corrupt",
				 vol->vol_id, ubi->ubi_num);
289 290 291 292 293 294 295 296 297 298
			vol->corrupted = 1;
		}

		vol->checked = 1;
		ubi_gluebi_updated(vol);
	}

	return 0;
}

299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
int ubi_volume_begin_write(char *volume, void *buf, size_t size,
	size_t full_size)
{
	int err = 1;
	int rsvd_bytes = 0;
	struct ubi_volume *vol;

	vol = ubi_find_volume(volume);
	if (vol == NULL)
		return ENODEV;

	rsvd_bytes = vol->reserved_pebs * (ubi->leb_size - vol->data_pad);
	if (size < 0 || size > rsvd_bytes) {
		printf("size > volume size! Aborting!\n");
		return EINVAL;
	}

	err = ubi_start_update(ubi, vol, full_size);
	if (err < 0) {
		printf("Cannot start volume update\n");
		return -err;
	}

	return ubi_volume_continue_write(volume, buf, size);
}

int ubi_volume_write(char *volume, void *buf, size_t size)
{
	return ubi_volume_begin_write(volume, buf, size, size);
}

330
int ubi_volume_read(char *volume, char *buf, size_t size)
331
{
332
	int err, lnum, off, len, tbuf_size;
333 334
	void *tbuf;
	unsigned long long tmp;
335
	struct ubi_volume *vol;
336 337
	loff_t offp = 0;

338 339 340
	vol = ubi_find_volume(volume);
	if (vol == NULL)
		return ENODEV;
341 342 343

	if (vol->updating) {
		printf("updating");
344
		return EBUSY;
345 346 347
	}
	if (vol->upd_marker) {
		printf("damaged volume, update marker is set");
348
		return EBADF;
349 350 351 352 353
	}
	if (offp == vol->used_bytes)
		return 0;

	if (size == 0) {
354
		printf("No size specified -> Using max size (%lld)\n", vol->used_bytes);
355 356 357 358 359 360
		size = vol->used_bytes;
	}

	if (vol->corrupted)
		printf("read from corrupted volume %d", vol->vol_id);
	if (offp + size > vol->used_bytes)
361
		size = vol->used_bytes - offp;
362 363 364 365

	tbuf_size = vol->usable_leb_size;
	if (size < tbuf_size)
		tbuf_size = ALIGN(size, ubi->min_io_size);
366
	tbuf = malloc_cache_aligned(tbuf_size);
367 368
	if (!tbuf) {
		printf("NO MEM\n");
369
		return ENOMEM;
370 371 372 373 374 375 376 377 378 379 380 381 382
	}
	len = size > tbuf_size ? tbuf_size : size;

	tmp = offp;
	off = do_div(tmp, vol->usable_leb_size);
	lnum = tmp;
	do {
		if (off + len >= vol->usable_leb_size)
			len = vol->usable_leb_size - off;

		err = ubi_eba_read_leb(ubi, vol, lnum, tbuf, off, len, 0);
		if (err) {
			printf("read err %x\n", err);
383
			err = -err;
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
			break;
		}
		off += len;
		if (off == vol->usable_leb_size) {
			lnum += 1;
			off -= vol->usable_leb_size;
		}

		size -= len;
		offp += len;

		memcpy(buf, tbuf, len);

		buf += len;
		len = size > tbuf_size ? tbuf_size : size;
	} while (size);

	free(tbuf);
402
	return err;
403 404
}

405 406
static int ubi_dev_scan(struct mtd_info *info, char *ubidev,
		const char *vid_header_offset)
407 408 409 410
{
	struct mtd_device *dev;
	struct part_info *part;
	struct mtd_partition mtd_part;
411
	char ubi_mtd_param_buffer[80];
412 413 414 415 416 417 418 419 420 421 422 423 424
	u8 pnum;
	int err;

	if (find_dev_and_part(ubidev, &dev, &pnum, &part) != 0)
		return 1;

	sprintf(buffer, "mtd=%d", pnum);
	memset(&mtd_part, 0, sizeof(mtd_part));
	mtd_part.name = buffer;
	mtd_part.size = part->size;
	mtd_part.offset = part->offset;
	add_mtd_partitions(info, &mtd_part, 1);

425 426 427 428 429
	strcpy(ubi_mtd_param_buffer, buffer);
	if (vid_header_offset)
		sprintf(ubi_mtd_param_buffer, "mtd=%d,%s", pnum,
				vid_header_offset);
	err = ubi_mtd_param_parse(ubi_mtd_param_buffer, NULL);
430 431
	if (err) {
		del_mtd_partitions(info);
432
		return -err;
433 434 435 436 437
	}

	err = ubi_init();
	if (err) {
		del_mtd_partitions(info);
438
		return -err;
439 440
	}

441 442
	ubi_initialized = 1;

443 444 445
	return 0;
}

446
int ubi_part(char *part_name, const char *vid_header_offset)
447 448
{
	int err = 0;
449 450 451 452
	char mtd_dev[16];
	struct mtd_device *dev;
	struct part_info *part;
	u8 pnum;
453

454 455 456 457 458
	if (mtdparts_init() != 0) {
		printf("Error initializing mtdparts!\n");
		return 1;
	}

459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
#ifdef CONFIG_CMD_UBIFS
	/*
	 * Automatically unmount UBIFS partition when user
	 * changes the UBI device. Otherwise the following
	 * UBIFS commands will crash.
	 */
	if (ubifs_is_mounted())
		cmd_ubifs_umount();
#endif

	/* todo: get dev number for NAND... */
	ubi_dev.nr = 0;

	/*
	 * Call ubi_exit() before re-initializing the UBI subsystem
	 */
	if (ubi_initialized) {
		ubi_exit();
		del_mtd_partitions(ubi_dev.mtd_info);
	}

	/*
	 * Search the mtd device number where this partition
	 * is located
	 */
	if (find_dev_and_part(part_name, &dev, &pnum, &part)) {
		printf("Partition %s not found!\n", part_name);
		return 1;
	}
	sprintf(mtd_dev, "%s%d", MTD_DEV_TYPE(dev->id->type), dev->id->num);
	ubi_dev.mtd_info = get_mtd_device_nm(mtd_dev);
	if (IS_ERR(ubi_dev.mtd_info)) {
		printf("Partition %s not found on device %s!\n", part_name,
		       mtd_dev);
		return 1;
	}

	ubi_dev.selected = 1;

	strcpy(ubi_dev.part_name, part_name);
	err = ubi_dev_scan(ubi_dev.mtd_info, ubi_dev.part_name,
			vid_header_offset);
	if (err) {
		printf("UBI init error %d\n", err);
		ubi_dev.selected = 0;
		return err;
	}

	ubi = ubi_devices[0];

	return 0;
}

static int do_ubi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
{
514
	int64_t size = 0;
515 516 517 518 519
	ulong addr = 0;

	if (argc < 2)
		return CMD_RET_USAGE;

520
	if (strcmp(argv[1], "part") == 0) {
521
		const char *vid_header_offset = NULL;
522

523 524
		/* Print current partition */
		if (argc == 2) {
525
			if (!ubi_dev.selected) {
526 527 528 529
				printf("Error, no UBI device/partition selected!\n");
				return 1;
			}

530
			printf("Device %d: %s, partition %s\n",
531 532 533 534
			       ubi_dev.nr, ubi_dev.mtd_info->name, ubi_dev.part_name);
			return 0;
		}

535
		if (argc < 3)
536
			return CMD_RET_USAGE;
537

538 539
		if (argc > 3)
			vid_header_offset = argv[3];
540

541
		return ubi_part(argv[2], vid_header_offset);
542 543
	}

544
	if ((strcmp(argv[1], "part") != 0) && (!ubi_dev.selected)) {
545 546 547 548 549 550 551 552 553 554 555
		printf("Error, no UBI device/partition selected!\n");
		return 1;
	}

	if (strcmp(argv[1], "info") == 0) {
		int layout = 0;
		if (argc > 2 && !strncmp(argv[2], "l", 1))
			layout = 1;
		return ubi_info(layout);
	}

556 557 558 559 560 561 562 563
	if (strcmp(argv[1], "check") == 0) {
		if (argc > 2)
			return ubi_check(argv[2]);

		printf("Error, no volume name passed\n");
		return 1;
	}

564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
	if (strncmp(argv[1], "create", 6) == 0) {
		int dynamic = 1;	/* default: dynamic volume */

		/* Use maximum available size */
		size = 0;

		/* E.g., create volume size type */
		if (argc == 5) {
			if (strncmp(argv[4], "s", 1) == 0)
				dynamic = 0;
			else if (strncmp(argv[4], "d", 1) != 0) {
				printf("Incorrect type\n");
				return 1;
			}
			argc--;
		}
		/* E.g., create volume size */
		if (argc == 4) {
582
			size = simple_strtoull(argv[3], NULL, 16);
583 584 585
			argc--;
		}
		/* Use maximum available size */
586
		if (!size) {
587 588
			size = (int64_t)ubi->avail_pebs * ubi->leb_size;
			printf("No size specified -> Using max size (%lld)\n", size);
589
		}
590 591 592 593 594 595 596 597 598 599 600 601
		/* E.g., create volume */
		if (argc == 3)
			return ubi_create_vol(argv[2], size, dynamic);
	}

	if (strncmp(argv[1], "remove", 6) == 0) {
		/* E.g., remove volume */
		if (argc == 3)
			return ubi_remove_vol(argv[2]);
	}

	if (strncmp(argv[1], "write", 5) == 0) {
602 603
		int ret;

604 605 606 607 608 609
		if (argc < 5) {
			printf("Please see usage\n");
			return 1;
		}

		addr = simple_strtoul(argv[2], NULL, 16);
610
		size = simple_strtoul(argv[4], NULL, 16);
611

612 613 614 615 616 617 618 619 620 621 622 623 624 625
		if (strlen(argv[1]) == 10 &&
		    strncmp(argv[1] + 5, ".part", 5) == 0) {
			if (argc < 6) {
				ret = ubi_volume_continue_write(argv[3],
						(void *)addr, size);
			} else {
				size_t full_size;
				full_size = simple_strtoul(argv[5], NULL, 16);
				ret = ubi_volume_begin_write(argv[3],
						(void *)addr, size, full_size);
			}
		} else {
			ret = ubi_volume_write(argv[3], (void *)addr, size);
		}
626
		if (!ret) {
627
			printf("%lld bytes written to volume %s\n", size,
628 629 630 631
			       argv[3]);
		}

		return ret;
632 633 634 635 636 637 638
	}

	if (strncmp(argv[1], "read", 4) == 0) {
		size = 0;

		/* E.g., read volume size */
		if (argc == 5) {
639
			size = simple_strtoul(argv[4], NULL, 16);
640 641 642 643 644 645 646 647 648
			argc--;
		}

		/* E.g., read volume */
		if (argc == 4) {
			addr = simple_strtoul(argv[2], NULL, 16);
			argc--;
		}

649
		if (argc == 3) {
650
			printf("Read %lld bytes from volume %s to %lx\n", size,
651 652
			       argv[3], addr);

653
			return ubi_volume_read(argv[3], (char *)addr, size);
654
		}
655 656 657
	}

	printf("Please see usage\n");
658
	return 1;
659 660
}

661 662
U_BOOT_CMD(
	ubi, 6, 1, do_ubi,
Peter Tyser's avatar
Peter Tyser committed
663
	"ubi commands",
664 665 666
	"part [part] [offset]\n"
		" - Show or set current partition (with optional VID"
		" header offset)\n"
667 668
	"ubi info [l[ayout]]"
		" - Display volume and ubi layout information\n"
669 670
	"ubi check volumename"
		" - check if volumename exists\n"
671 672 673 674
	"ubi create[vol] volume [size] [type]"
		" - create volume name with size\n"
	"ubi write[vol] address volume size"
		" - Write volume from address with size\n"
675 676
	"ubi write.part address volume size [fullsize]\n"
		" - Write part of a volume from address\n"
677 678 679 680 681
	"ubi read[vol] address volume [size]"
		" - Read volume to address with size\n"
	"ubi remove[vol] volume"
		" - Remove volume\n"
	"[Legends]\n"
682 683
	" volume: character name\n"
	" size: specified in bytes\n"
684
	" type: s[tatic] or d[ynamic] (default=dynamic)"
685
);