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.
20 #include <onenand_uboot.h>
21 #include <linux/mtd/mtd.h>
22 #include <linux/mtd/partitions.h>
23 #include <linux/err.h>
24 #include <ubi_uboot.h>
25 #include <linux/errno.h>
26 #include <jffs2/load_kernel.h>
29 #define ubi_msg(fmt, ...) printf("UBI: " fmt "\n", ##__VA_ARGS__)
31 /* Private own data */
32 static struct ubi_device
*ubi
;
34 #ifdef CONFIG_CMD_UBIFS
35 #include <ubifs_uboot.h>
38 static void display_volume_info(struct ubi_device
*ubi
)
42 for (i
= 0; i
< (ubi
->vtbl_slots
+ 1); i
++) {
44 continue; /* Empty record */
45 ubi_dump_vol_info(ubi
->volumes
[i
]);
49 static void display_ubi_info(struct ubi_device
*ubi
)
51 ubi_msg("MTD device name: \"%s\"", ubi
->mtd
->name
);
52 ubi_msg("MTD device size: %llu MiB", ubi
->flash_size
>> 20);
53 ubi_msg("physical eraseblock size: %d bytes (%d KiB)",
54 ubi
->peb_size
, ubi
->peb_size
>> 10);
55 ubi_msg("logical eraseblock size: %d bytes", ubi
->leb_size
);
56 ubi_msg("number of good PEBs: %d", ubi
->good_peb_count
);
57 ubi_msg("number of bad PEBs: %d", ubi
->bad_peb_count
);
58 ubi_msg("smallest flash I/O unit: %d", ubi
->min_io_size
);
59 ubi_msg("VID header offset: %d (aligned %d)",
60 ubi
->vid_hdr_offset
, ubi
->vid_hdr_aloffset
);
61 ubi_msg("data offset: %d", ubi
->leb_start
);
62 ubi_msg("max. allowed volumes: %d", ubi
->vtbl_slots
);
63 ubi_msg("wear-leveling threshold: %d", CONFIG_MTD_UBI_WL_THRESHOLD
);
64 ubi_msg("number of internal volumes: %d", UBI_INT_VOL_COUNT
);
65 ubi_msg("number of user volumes: %d",
66 ubi
->vol_count
- UBI_INT_VOL_COUNT
);
67 ubi_msg("available PEBs: %d", ubi
->avail_pebs
);
68 ubi_msg("total number of reserved PEBs: %d", ubi
->rsvd_pebs
);
69 ubi_msg("number of PEBs reserved for bad PEB handling: %d",
71 ubi_msg("max/mean erase counter: %d/%d", ubi
->max_ec
, ubi
->mean_ec
);
74 static int ubi_info(int layout
)
77 display_volume_info(ubi
);
79 display_ubi_info(ubi
);
84 static int ubi_check_volumename(const struct ubi_volume
*vol
, char *name
)
86 return strcmp(vol
->name
, name
);
89 static int ubi_check(char *name
)
93 for (i
= 0; i
< (ubi
->vtbl_slots
+ 1); i
++) {
95 continue; /* Empty record */
97 if (!ubi_check_volumename(ubi
->volumes
[i
], name
))
104 static int verify_mkvol_req(const struct ubi_device
*ubi
,
105 const struct ubi_mkvol_req
*req
)
109 if (req
->bytes
< 0 || req
->alignment
< 0 || req
->vol_type
< 0 ||
113 if ((req
->vol_id
< 0 || req
->vol_id
>= ubi
->vtbl_slots
) &&
114 req
->vol_id
!= UBI_VOL_NUM_AUTO
)
117 if (req
->alignment
== 0)
120 if (req
->bytes
== 0) {
121 printf("No space left in UBI device!\n");
126 if (req
->vol_type
!= UBI_DYNAMIC_VOLUME
&&
127 req
->vol_type
!= UBI_STATIC_VOLUME
)
130 if (req
->alignment
> ubi
->leb_size
)
133 n
= req
->alignment
% ubi
->min_io_size
;
134 if (req
->alignment
!= 1 && n
)
137 if (req
->name_len
> UBI_VOL_NAME_MAX
) {
138 printf("Name too long!\n");
148 static int ubi_create_vol(char *volume
, int64_t size
, int dynamic
, int vol_id
)
150 struct ubi_mkvol_req req
;
154 req
.vol_type
= UBI_DYNAMIC_VOLUME
;
156 req
.vol_type
= UBI_STATIC_VOLUME
;
162 strcpy(req
.name
, volume
);
163 req
.name_len
= strlen(volume
);
164 req
.name
[req
.name_len
] = '\0';
166 /* It's duplicated at drivers/mtd/ubi/cdev.c */
167 err
= verify_mkvol_req(ubi
, &req
);
169 printf("verify_mkvol_req failed %d\n", err
);
172 printf("Creating %s volume %s of size %lld\n",
173 dynamic
? "dynamic" : "static", volume
, size
);
174 /* Call real ubi create volume */
175 return ubi_create_volume(ubi
, &req
);
178 static struct ubi_volume
*ubi_find_volume(char *volume
)
180 struct ubi_volume
*vol
= NULL
;
183 for (i
= 0; i
< ubi
->vtbl_slots
; i
++) {
184 vol
= ubi
->volumes
[i
];
185 if (vol
&& !strcmp(vol
->name
, volume
))
189 printf("Volume %s not found!\n", volume
);
193 static int ubi_remove_vol(char *volume
)
195 int err
, reserved_pebs
, i
;
196 struct ubi_volume
*vol
;
198 vol
= ubi_find_volume(volume
);
202 printf("Remove UBI volume %s (id %d)\n", vol
->name
, vol
->vol_id
);
205 printf("It's read-only mode\n");
210 err
= ubi_change_vtbl_record(ubi
, vol
->vol_id
, NULL
);
212 printf("Error changing Vol tabel record err=%x\n", err
);
215 reserved_pebs
= vol
->reserved_pebs
;
216 for (i
= 0; i
< vol
->reserved_pebs
; i
++) {
217 err
= ubi_eba_unmap_leb(ubi
, vol
, i
);
223 ubi
->volumes
[vol
->vol_id
]->eba_tbl
= NULL
;
224 ubi
->volumes
[vol
->vol_id
] = NULL
;
226 ubi
->rsvd_pebs
-= reserved_pebs
;
227 ubi
->avail_pebs
+= reserved_pebs
;
228 i
= ubi
->beb_rsvd_level
- ubi
->beb_rsvd_pebs
;
230 i
= ubi
->avail_pebs
>= i
? i
: ubi
->avail_pebs
;
231 ubi
->avail_pebs
-= i
;
233 ubi
->beb_rsvd_pebs
+= i
;
235 ubi_msg("reserve more %d PEBs", i
);
241 ubi_err(ubi
, "cannot remove volume %s, error %d", volume
, err
);
247 static int ubi_volume_continue_write(char *volume
, void *buf
, size_t size
)
250 struct ubi_volume
*vol
;
252 vol
= ubi_find_volume(volume
);
256 err
= ubi_more_update_data(ubi
, vol
, buf
, size
);
258 printf("Couldnt or partially wrote data\n");
265 err
= ubi_check_volume(ubi
, vol
->vol_id
);
270 ubi_warn(ubi
, "volume %d on UBI device %d is corrupt",
271 vol
->vol_id
, ubi
->ubi_num
);
276 ubi_gluebi_updated(vol
);
282 int ubi_volume_begin_write(char *volume
, void *buf
, size_t size
,
287 struct ubi_volume
*vol
;
289 vol
= ubi_find_volume(volume
);
293 rsvd_bytes
= vol
->reserved_pebs
* (ubi
->leb_size
- vol
->data_pad
);
294 if (size
> rsvd_bytes
) {
295 printf("size > volume size! Aborting!\n");
299 err
= ubi_start_update(ubi
, vol
, full_size
);
301 printf("Cannot start volume update\n");
305 return ubi_volume_continue_write(volume
, buf
, size
);
308 int ubi_volume_write(char *volume
, void *buf
, size_t size
)
310 return ubi_volume_begin_write(volume
, buf
, size
, size
);
313 int ubi_volume_read(char *volume
, char *buf
, size_t size
)
315 int err
, lnum
, off
, len
, tbuf_size
;
317 unsigned long long tmp
;
318 struct ubi_volume
*vol
;
322 vol
= ubi_find_volume(volume
);
330 if (vol
->upd_marker
) {
331 printf("damaged volume, update marker is set");
334 if (offp
== vol
->used_bytes
)
338 printf("No size specified -> Using max size (%lld)\n", vol
->used_bytes
);
339 size
= vol
->used_bytes
;
342 printf("Read %zu bytes from volume %s to %p\n", size
, volume
, buf
);
345 printf("read from corrupted volume %d", vol
->vol_id
);
346 if (offp
+ size
> vol
->used_bytes
)
347 size
= vol
->used_bytes
- offp
;
349 tbuf_size
= vol
->usable_leb_size
;
350 if (size
< tbuf_size
)
351 tbuf_size
= ALIGN(size
, ubi
->min_io_size
);
352 tbuf
= malloc_cache_aligned(tbuf_size
);
357 len
= size
> tbuf_size
? tbuf_size
: size
;
360 off
= do_div(tmp
, vol
->usable_leb_size
);
364 if (off
+ len
>= vol
->usable_leb_size
)
365 len
= vol
->usable_leb_size
- off
;
367 err
= ubi_eba_read_leb(ubi
, vol
, lnum
, tbuf
, off
, len
, 0);
369 printf("read err %x\n", err
);
374 if (off
== vol
->usable_leb_size
) {
376 off
-= vol
->usable_leb_size
;
382 memcpy(buf
, tbuf
, len
);
385 len
= size
> tbuf_size
? tbuf_size
: size
;
389 env_set_hex("filesize", len_read
);
395 static int ubi_dev_scan(struct mtd_info
*info
, const char *vid_header_offset
)
397 char ubi_mtd_param_buffer
[80];
400 if (!vid_header_offset
)
401 sprintf(ubi_mtd_param_buffer
, "%s", info
->name
);
403 sprintf(ubi_mtd_param_buffer
, "%s,%s", info
->name
,
406 err
= ubi_mtd_param_parse(ubi_mtd_param_buffer
, NULL
);
417 static int ubi_detach(void)
419 #ifdef CONFIG_CMD_UBIFS
421 * Automatically unmount UBIFS partition when user
422 * changes the UBI device. Otherwise the following
423 * UBIFS commands will crash.
425 if (ubifs_is_mounted())
430 * Call ubi_exit() before re-initializing the UBI subsystem
440 int ubi_part(char *part_name
, const char *vid_header_offset
)
442 struct mtd_info
*mtd
;
448 mtd
= get_mtd_device_nm(part_name
);
450 printf("Partition %s not found!\n", part_name
);
455 err
= ubi_dev_scan(mtd
, vid_header_offset
);
457 printf("UBI init error %d\n", err
);
458 printf("Please check, if the correct MTD partition is used (size big enough?)\n");
462 ubi
= ubi_devices
[0];
467 static int do_ubi(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
473 return CMD_RET_USAGE
;
475 if (strcmp(argv
[1], "detach") == 0)
478 if (strcmp(argv
[1], "part") == 0) {
479 const char *vid_header_offset
= NULL
;
481 /* Print current partition */
484 printf("Error, no UBI device selected!\n");
488 printf("Device %d: %s, MTD partition %s\n",
489 ubi
->ubi_num
, ubi
->ubi_name
, ubi
->mtd
->name
);
494 return CMD_RET_USAGE
;
497 vid_header_offset
= argv
[3];
499 return ubi_part(argv
[2], vid_header_offset
);
502 if ((strcmp(argv
[1], "part") != 0) && !ubi
) {
503 printf("Error, no UBI device selected!\n");
507 if (strcmp(argv
[1], "info") == 0) {
509 if (argc
> 2 && !strncmp(argv
[2], "l", 1))
511 return ubi_info(layout
);
514 if (strcmp(argv
[1], "check") == 0) {
516 return ubi_check(argv
[2]);
518 printf("Error, no volume name passed\n");
522 if (strncmp(argv
[1], "create", 6) == 0) {
523 int dynamic
= 1; /* default: dynamic volume */
524 int id
= UBI_VOL_NUM_AUTO
;
526 /* Use maximum available size */
529 /* E.g., create volume size type vol_id */
531 id
= simple_strtoull(argv
[5], NULL
, 16);
535 /* E.g., create volume size type */
537 if (strncmp(argv
[4], "s", 1) == 0)
539 else if (strncmp(argv
[4], "d", 1) != 0) {
540 printf("Incorrect type\n");
545 /* E.g., create volume size */
547 if (argv
[3][0] != '-')
548 size
= simple_strtoull(argv
[3], NULL
, 16);
551 /* Use maximum available size */
553 size
= (int64_t)ubi
->avail_pebs
* ubi
->leb_size
;
554 printf("No size specified -> Using max size (%lld)\n", size
);
556 /* E.g., create volume */
558 return ubi_create_vol(argv
[2], size
, dynamic
, id
);
561 if (strncmp(argv
[1], "remove", 6) == 0) {
562 /* E.g., remove volume */
564 return ubi_remove_vol(argv
[2]);
567 if (strncmp(argv
[1], "write", 5) == 0) {
571 printf("Please see usage\n");
575 addr
= simple_strtoul(argv
[2], NULL
, 16);
576 size
= simple_strtoul(argv
[4], NULL
, 16);
578 if (strlen(argv
[1]) == 10 &&
579 strncmp(argv
[1] + 5, ".part", 5) == 0) {
581 ret
= ubi_volume_continue_write(argv
[3],
585 full_size
= simple_strtoul(argv
[5], NULL
, 16);
586 ret
= ubi_volume_begin_write(argv
[3],
587 (void *)addr
, size
, full_size
);
590 ret
= ubi_volume_write(argv
[3], (void *)addr
, size
);
593 printf("%lld bytes written to volume %s\n", size
,
600 if (strncmp(argv
[1], "read", 4) == 0) {
603 /* E.g., read volume size */
605 size
= simple_strtoul(argv
[4], NULL
, 16);
609 /* E.g., read volume */
611 addr
= simple_strtoul(argv
[2], NULL
, 16);
616 return ubi_volume_read(argv
[3], (char *)addr
, size
);
620 printf("Please see usage\n");
628 " - detach ubi from a mtd partition\n"
629 "ubi part [part] [offset]\n"
630 " - Show or set current partition (with optional VID"
632 "ubi info [l[ayout]]"
633 " - Display volume and ubi layout information\n"
634 "ubi check volumename"
635 " - check if volumename exists\n"
636 "ubi create[vol] volume [size] [type] [id]\n"
637 " - create volume name with size ('-' for maximum"
639 "ubi write[vol] address volume size"
640 " - Write volume from address with size\n"
641 "ubi write.part address volume size [fullsize]\n"
642 " - Write part of a volume from address\n"
643 "ubi read[vol] address volume [size]"
644 " - Read volume to address with size\n"
645 "ubi remove[vol] volume"
648 " volume: character name\n"
649 " size: specified in bytes\n"
650 " type: s[tatic] or d[ynamic] (default=dynamic)"