2 * Unsorted Block Image commands
4 * Copyright (C) 2008 Samsung Electronics
5 * Kyungmin Park <kyungmin.park@samsung.com>
7 * Copyright 2008-2009 Stefan Roese <sr@denx.de>, DENX Software Engineering
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
19 #include <onenand_uboot.h>
20 #include <linux/mtd/mtd.h>
21 #include <linux/mtd/partitions.h>
22 #include <ubi_uboot.h>
23 #include <asm/errno.h>
24 #include <jffs2/load_kernel.h>
27 #define ubi_msg(fmt, ...) printf("UBI: " fmt "\n", ##__VA_ARGS__)
29 #define DEV_TYPE_NONE 0
30 #define DEV_TYPE_NAND 1
31 #define DEV_TYPE_ONENAND 2
32 #define DEV_TYPE_NOR 3
34 /* Private own data */
35 static struct ubi_device
*ubi
;
36 static char buffer
[80];
37 static int ubi_initialized
;
43 struct mtd_info
*mtd_info
;
46 static struct selected_dev ubi_dev
;
48 #ifdef CONFIG_CMD_UBIFS
49 int ubifs_is_mounted(void);
50 void cmd_ubifs_umount(void);
53 static void ubi_dump_vol_info(const struct ubi_volume
*vol
)
55 ubi_msg("volume information dump:");
56 ubi_msg("vol_id %d", vol
->vol_id
);
57 ubi_msg("reserved_pebs %d", vol
->reserved_pebs
);
58 ubi_msg("alignment %d", vol
->alignment
);
59 ubi_msg("data_pad %d", vol
->data_pad
);
60 ubi_msg("vol_type %d", vol
->vol_type
);
61 ubi_msg("name_len %d", vol
->name_len
);
62 ubi_msg("usable_leb_size %d", vol
->usable_leb_size
);
63 ubi_msg("used_ebs %d", vol
->used_ebs
);
64 ubi_msg("used_bytes %lld", vol
->used_bytes
);
65 ubi_msg("last_eb_bytes %d", vol
->last_eb_bytes
);
66 ubi_msg("corrupted %d", vol
->corrupted
);
67 ubi_msg("upd_marker %d", vol
->upd_marker
);
69 if (vol
->name_len
<= UBI_VOL_NAME_MAX
&&
70 strnlen(vol
->name
, vol
->name_len
+ 1) == vol
->name_len
) {
71 ubi_msg("name %s", vol
->name
);
73 ubi_msg("the 1st 5 characters of the name: %c%c%c%c%c",
74 vol
->name
[0], vol
->name
[1], vol
->name
[2],
75 vol
->name
[3], vol
->name
[4]);
80 static void display_volume_info(struct ubi_device
*ubi
)
84 for (i
= 0; i
< (ubi
->vtbl_slots
+ 1); i
++) {
86 continue; /* Empty record */
87 ubi_dump_vol_info(ubi
->volumes
[i
]);
91 static void display_ubi_info(struct ubi_device
*ubi
)
93 ubi_msg("MTD device name: \"%s\"", ubi
->mtd
->name
);
94 ubi_msg("MTD device size: %llu MiB", ubi
->flash_size
>> 20);
95 ubi_msg("physical eraseblock size: %d bytes (%d KiB)",
96 ubi
->peb_size
, ubi
->peb_size
>> 10);
97 ubi_msg("logical eraseblock size: %d bytes", ubi
->leb_size
);
98 ubi_msg("number of good PEBs: %d", ubi
->good_peb_count
);
99 ubi_msg("number of bad PEBs: %d", ubi
->bad_peb_count
);
100 ubi_msg("smallest flash I/O unit: %d", ubi
->min_io_size
);
101 ubi_msg("VID header offset: %d (aligned %d)",
102 ubi
->vid_hdr_offset
, ubi
->vid_hdr_aloffset
);
103 ubi_msg("data offset: %d", ubi
->leb_start
);
104 ubi_msg("max. allowed volumes: %d", ubi
->vtbl_slots
);
105 ubi_msg("wear-leveling threshold: %d", CONFIG_MTD_UBI_WL_THRESHOLD
);
106 ubi_msg("number of internal volumes: %d", UBI_INT_VOL_COUNT
);
107 ubi_msg("number of user volumes: %d",
108 ubi
->vol_count
- UBI_INT_VOL_COUNT
);
109 ubi_msg("available PEBs: %d", ubi
->avail_pebs
);
110 ubi_msg("total number of reserved PEBs: %d", ubi
->rsvd_pebs
);
111 ubi_msg("number of PEBs reserved for bad PEB handling: %d",
113 ubi_msg("max/mean erase counter: %d/%d", ubi
->max_ec
, ubi
->mean_ec
);
116 static int ubi_info(int layout
)
119 display_volume_info(ubi
);
121 display_ubi_info(ubi
);
126 static int ubi_check_volumename(const struct ubi_volume
*vol
, char *name
)
128 return strcmp(vol
->name
, name
);
131 static int ubi_check(char *name
)
135 for (i
= 0; i
< (ubi
->vtbl_slots
+ 1); i
++) {
136 if (!ubi
->volumes
[i
])
137 continue; /* Empty record */
139 if (!ubi_check_volumename(ubi
->volumes
[i
], name
))
147 static int verify_mkvol_req(const struct ubi_device
*ubi
,
148 const struct ubi_mkvol_req
*req
)
152 if (req
->bytes
< 0 || req
->alignment
< 0 || req
->vol_type
< 0 ||
156 if ((req
->vol_id
< 0 || req
->vol_id
>= ubi
->vtbl_slots
) &&
157 req
->vol_id
!= UBI_VOL_NUM_AUTO
)
160 if (req
->alignment
== 0)
163 if (req
->bytes
== 0) {
164 printf("No space left in UBI device!\n");
169 if (req
->vol_type
!= UBI_DYNAMIC_VOLUME
&&
170 req
->vol_type
!= UBI_STATIC_VOLUME
)
173 if (req
->alignment
> ubi
->leb_size
)
176 n
= req
->alignment
% ubi
->min_io_size
;
177 if (req
->alignment
!= 1 && n
)
180 if (req
->name_len
> UBI_VOL_NAME_MAX
) {
181 printf("Name too long!\n");
191 static int ubi_create_vol(char *volume
, int64_t size
, int dynamic
)
193 struct ubi_mkvol_req req
;
197 req
.vol_type
= UBI_DYNAMIC_VOLUME
;
199 req
.vol_type
= UBI_STATIC_VOLUME
;
201 req
.vol_id
= UBI_VOL_NUM_AUTO
;
205 strcpy(req
.name
, volume
);
206 req
.name_len
= strlen(volume
);
207 req
.name
[req
.name_len
] = '\0';
209 /* It's duplicated at drivers/mtd/ubi/cdev.c */
210 err
= verify_mkvol_req(ubi
, &req
);
212 printf("verify_mkvol_req failed %d\n", err
);
215 printf("Creating %s volume %s of size %lld\n",
216 dynamic
? "dynamic" : "static", volume
, size
);
217 /* Call real ubi create volume */
218 return ubi_create_volume(ubi
, &req
);
221 static struct ubi_volume
*ubi_find_volume(char *volume
)
223 struct ubi_volume
*vol
= NULL
;
226 for (i
= 0; i
< ubi
->vtbl_slots
; i
++) {
227 vol
= ubi
->volumes
[i
];
228 if (vol
&& !strcmp(vol
->name
, volume
))
232 printf("Volume %s not found!\n", volume
);
236 static int ubi_remove_vol(char *volume
)
238 int err
, reserved_pebs
, i
;
239 struct ubi_volume
*vol
;
241 vol
= ubi_find_volume(volume
);
245 printf("Remove UBI volume %s (id %d)\n", vol
->name
, vol
->vol_id
);
248 printf("It's read-only mode\n");
253 err
= ubi_change_vtbl_record(ubi
, vol
->vol_id
, NULL
);
255 printf("Error changing Vol tabel record err=%x\n", err
);
258 reserved_pebs
= vol
->reserved_pebs
;
259 for (i
= 0; i
< vol
->reserved_pebs
; i
++) {
260 err
= ubi_eba_unmap_leb(ubi
, vol
, i
);
266 ubi
->volumes
[vol
->vol_id
]->eba_tbl
= NULL
;
267 ubi
->volumes
[vol
->vol_id
] = NULL
;
269 ubi
->rsvd_pebs
-= reserved_pebs
;
270 ubi
->avail_pebs
+= reserved_pebs
;
271 i
= ubi
->beb_rsvd_level
- ubi
->beb_rsvd_pebs
;
273 i
= ubi
->avail_pebs
>= i
? i
: ubi
->avail_pebs
;
274 ubi
->avail_pebs
-= i
;
276 ubi
->beb_rsvd_pebs
+= i
;
278 ubi_msg("reserve more %d PEBs", i
);
284 ubi_err("cannot remove volume %s, error %d", volume
, err
);
290 static int ubi_volume_continue_write(char *volume
, void *buf
, size_t size
)
293 struct ubi_volume
*vol
;
295 vol
= ubi_find_volume(volume
);
299 err
= ubi_more_update_data(ubi
, vol
, buf
, size
);
301 printf("Couldnt or partially wrote data\n");
308 err
= ubi_check_volume(ubi
, vol
->vol_id
);
313 ubi_warn("volume %d on UBI device %d is corrupted",
314 vol
->vol_id
, ubi
->ubi_num
);
319 ubi_gluebi_updated(vol
);
325 int ubi_volume_begin_write(char *volume
, void *buf
, size_t size
,
330 struct ubi_volume
*vol
;
332 vol
= ubi_find_volume(volume
);
336 rsvd_bytes
= vol
->reserved_pebs
* (ubi
->leb_size
- vol
->data_pad
);
337 if (size
< 0 || size
> rsvd_bytes
) {
338 printf("size > volume size! Aborting!\n");
342 err
= ubi_start_update(ubi
, vol
, full_size
);
344 printf("Cannot start volume update\n");
348 return ubi_volume_continue_write(volume
, buf
, size
);
351 int ubi_volume_write(char *volume
, void *buf
, size_t size
)
353 return ubi_volume_begin_write(volume
, buf
, size
, size
);
356 int ubi_volume_read(char *volume
, char *buf
, size_t size
)
358 int err
, lnum
, off
, len
, tbuf_size
;
360 unsigned long long tmp
;
361 struct ubi_volume
*vol
;
364 vol
= ubi_find_volume(volume
);
372 if (vol
->upd_marker
) {
373 printf("damaged volume, update marker is set");
376 if (offp
== vol
->used_bytes
)
380 printf("No size specified -> Using max size (%lld)\n", vol
->used_bytes
);
381 size
= vol
->used_bytes
;
385 printf("read from corrupted volume %d", vol
->vol_id
);
386 if (offp
+ size
> vol
->used_bytes
)
387 size
= vol
->used_bytes
- offp
;
389 tbuf_size
= vol
->usable_leb_size
;
390 if (size
< tbuf_size
)
391 tbuf_size
= ALIGN(size
, ubi
->min_io_size
);
392 tbuf
= malloc(tbuf_size
);
397 len
= size
> tbuf_size
? tbuf_size
: size
;
400 off
= do_div(tmp
, vol
->usable_leb_size
);
403 if (off
+ len
>= vol
->usable_leb_size
)
404 len
= vol
->usable_leb_size
- off
;
406 err
= ubi_eba_read_leb(ubi
, vol
, lnum
, tbuf
, off
, len
, 0);
408 printf("read err %x\n", err
);
413 if (off
== vol
->usable_leb_size
) {
415 off
-= vol
->usable_leb_size
;
421 memcpy(buf
, tbuf
, len
);
424 len
= size
> tbuf_size
? tbuf_size
: size
;
431 static int ubi_dev_scan(struct mtd_info
*info
, char *ubidev
,
432 const char *vid_header_offset
)
434 struct mtd_device
*dev
;
435 struct part_info
*part
;
436 struct mtd_partition mtd_part
;
437 char ubi_mtd_param_buffer
[80];
441 if (find_dev_and_part(ubidev
, &dev
, &pnum
, &part
) != 0)
444 sprintf(buffer
, "mtd=%d", pnum
);
445 memset(&mtd_part
, 0, sizeof(mtd_part
));
446 mtd_part
.name
= buffer
;
447 mtd_part
.size
= part
->size
;
448 mtd_part
.offset
= part
->offset
;
449 add_mtd_partitions(info
, &mtd_part
, 1);
451 strcpy(ubi_mtd_param_buffer
, buffer
);
452 if (vid_header_offset
)
453 sprintf(ubi_mtd_param_buffer
, "mtd=%d,%s", pnum
,
455 err
= ubi_mtd_param_parse(ubi_mtd_param_buffer
, NULL
);
457 del_mtd_partitions(info
);
463 del_mtd_partitions(info
);
472 int ubi_part(char *part_name
, const char *vid_header_offset
)
476 struct mtd_device
*dev
;
477 struct part_info
*part
;
480 if (mtdparts_init() != 0) {
481 printf("Error initializing mtdparts!\n");
485 #ifdef CONFIG_CMD_UBIFS
487 * Automatically unmount UBIFS partition when user
488 * changes the UBI device. Otherwise the following
489 * UBIFS commands will crash.
491 if (ubifs_is_mounted())
495 /* todo: get dev number for NAND... */
499 * Call ubi_exit() before re-initializing the UBI subsystem
501 if (ubi_initialized
) {
503 del_mtd_partitions(ubi_dev
.mtd_info
);
507 * Search the mtd device number where this partition
510 if (find_dev_and_part(part_name
, &dev
, &pnum
, &part
)) {
511 printf("Partition %s not found!\n", part_name
);
514 sprintf(mtd_dev
, "%s%d", MTD_DEV_TYPE(dev
->id
->type
), dev
->id
->num
);
515 ubi_dev
.mtd_info
= get_mtd_device_nm(mtd_dev
);
516 if (IS_ERR(ubi_dev
.mtd_info
)) {
517 printf("Partition %s not found on device %s!\n", part_name
,
522 ubi_dev
.selected
= 1;
524 strcpy(ubi_dev
.part_name
, part_name
);
525 err
= ubi_dev_scan(ubi_dev
.mtd_info
, ubi_dev
.part_name
,
528 printf("UBI init error %d\n", err
);
529 ubi_dev
.selected
= 0;
533 ubi
= ubi_devices
[0];
538 static int do_ubi(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
544 return CMD_RET_USAGE
;
546 if (strcmp(argv
[1], "part") == 0) {
547 const char *vid_header_offset
= NULL
;
549 /* Print current partition */
551 if (!ubi_dev
.selected
) {
552 printf("Error, no UBI device/partition selected!\n");
556 printf("Device %d: %s, partition %s\n",
557 ubi_dev
.nr
, ubi_dev
.mtd_info
->name
, ubi_dev
.part_name
);
562 return CMD_RET_USAGE
;
565 vid_header_offset
= argv
[3];
567 return ubi_part(argv
[2], vid_header_offset
);
570 if ((strcmp(argv
[1], "part") != 0) && (!ubi_dev
.selected
)) {
571 printf("Error, no UBI device/partition selected!\n");
575 if (strcmp(argv
[1], "info") == 0) {
577 if (argc
> 2 && !strncmp(argv
[2], "l", 1))
579 return ubi_info(layout
);
582 if (strcmp(argv
[1], "check") == 0) {
584 return ubi_check(argv
[2]);
586 printf("Error, no volume name passed\n");
590 if (strncmp(argv
[1], "create", 6) == 0) {
591 int dynamic
= 1; /* default: dynamic volume */
593 /* Use maximum available size */
596 /* E.g., create volume size type */
598 if (strncmp(argv
[4], "s", 1) == 0)
600 else if (strncmp(argv
[4], "d", 1) != 0) {
601 printf("Incorrect type\n");
606 /* E.g., create volume size */
608 size
= simple_strtoull(argv
[3], NULL
, 16);
611 /* Use maximum available size */
613 size
= (int64_t)ubi
->avail_pebs
* ubi
->leb_size
;
614 printf("No size specified -> Using max size (%lld)\n", size
);
616 /* E.g., create volume */
618 return ubi_create_vol(argv
[2], size
, dynamic
);
621 if (strncmp(argv
[1], "remove", 6) == 0) {
622 /* E.g., remove volume */
624 return ubi_remove_vol(argv
[2]);
627 if (strncmp(argv
[1], "write", 5) == 0) {
631 printf("Please see usage\n");
635 addr
= simple_strtoul(argv
[2], NULL
, 16);
636 size
= simple_strtoul(argv
[4], NULL
, 16);
638 if (strlen(argv
[1]) == 10 &&
639 strncmp(argv
[1] + 5, ".part", 5) == 0) {
641 ret
= ubi_volume_continue_write(argv
[3],
645 full_size
= simple_strtoul(argv
[5], NULL
, 16);
646 ret
= ubi_volume_begin_write(argv
[3],
647 (void *)addr
, size
, full_size
);
650 ret
= ubi_volume_write(argv
[3], (void *)addr
, size
);
653 printf("%lld bytes written to volume %s\n", size
,
660 if (strncmp(argv
[1], "read", 4) == 0) {
663 /* E.g., read volume size */
665 size
= simple_strtoul(argv
[4], NULL
, 16);
669 /* E.g., read volume */
671 addr
= simple_strtoul(argv
[2], NULL
, 16);
676 printf("Read %lld bytes from volume %s to %lx\n", size
,
679 return ubi_volume_read(argv
[3], (char *)addr
, size
);
683 printf("Please see usage\n");
690 "part [part] [offset]\n"
691 " - Show or set current partition (with optional VID"
693 "ubi info [l[ayout]]"
694 " - Display volume and ubi layout information\n"
695 "ubi check volumename"
696 " - check if volumename exists\n"
697 "ubi create[vol] volume [size] [type]"
698 " - create volume name with size\n"
699 "ubi write[vol] address volume size"
700 " - Write volume from address with size\n"
701 "ubi write.part address volume size [fullsize]\n"
702 " - Write part of a volume from address\n"
703 "ubi read[vol] address volume [size]"
704 " - Read volume to address with size\n"
705 "ubi remove[vol] volume"
708 " volume: character name\n"
709 " size: specified in bytes\n"
710 " type: s[tatic] or d[ynamic] (default=dynamic)"