2 * Unsorted Block Image commands
4 * Copyright (C) 2008 Samsung Electronics
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.
21 #include <onenand_uboot.h>
22 #include <dm/devres.h>
23 #include <linux/mtd/mtd.h>
24 #include <linux/mtd/partitions.h>
25 #include <linux/err.h>
26 #include <ubi_uboot.h>
27 #include <linux/errno.h>
28 #include <jffs2/load_kernel.h>
29 #include <linux/log2.h>
32 #define ubi_msg(fmt, ...) printf("UBI: " fmt "\n", ##__VA_ARGS__)
34 /* Private own data */
35 static struct ubi_device *ubi;
37 #ifdef CONFIG_CMD_UBIFS
38 #include <ubifs_uboot.h>
41 static void display_volume_info(struct ubi_device *ubi)
45 for (i = 0; i < (ubi->vtbl_slots + 1); i++) {
47 continue; /* Empty record */
48 ubi_dump_vol_info(ubi->volumes[i]);
52 static void display_ubi_info(struct ubi_device *ubi)
54 ubi_msg("MTD device name: \"%s\"", ubi->mtd->name);
55 ubi_msg("MTD device size: %llu MiB", ubi->flash_size >> 20);
56 ubi_msg("physical eraseblock size: %d bytes (%d KiB)",
57 ubi->peb_size, ubi->peb_size >> 10);
58 ubi_msg("logical eraseblock size: %d bytes", ubi->leb_size);
59 ubi_msg("number of good PEBs: %d", ubi->good_peb_count);
60 ubi_msg("number of bad PEBs: %d", ubi->bad_peb_count);
61 ubi_msg("smallest flash I/O unit: %d", ubi->min_io_size);
62 ubi_msg("VID header offset: %d (aligned %d)",
63 ubi->vid_hdr_offset, ubi->vid_hdr_aloffset);
64 ubi_msg("data offset: %d", ubi->leb_start);
65 ubi_msg("max. allowed volumes: %d", ubi->vtbl_slots);
66 ubi_msg("wear-leveling threshold: %d", CONFIG_MTD_UBI_WL_THRESHOLD);
67 ubi_msg("number of internal volumes: %d", UBI_INT_VOL_COUNT);
68 ubi_msg("number of user volumes: %d",
69 ubi->vol_count - UBI_INT_VOL_COUNT);
70 ubi_msg("available PEBs: %d", ubi->avail_pebs);
71 ubi_msg("total number of reserved PEBs: %d", ubi->rsvd_pebs);
72 ubi_msg("number of PEBs reserved for bad PEB handling: %d",
74 ubi_msg("max/mean erase counter: %d/%d", ubi->max_ec, ubi->mean_ec);
77 static int ubi_info(int layout)
80 display_volume_info(ubi);
82 display_ubi_info(ubi);
87 static int ubi_list(const char *var, int numeric)
89 size_t namelen, len, size;
94 for (i = 0; i < (ubi->vtbl_slots + 1); i++) {
97 if (ubi->volumes[i]->vol_id >= UBI_INTERNAL_VOL_START)
100 ubi->volumes[i]->vol_id,
101 ubi->volumes[i]->name);
112 for (i = 0; i < (ubi->vtbl_slots + 1); i++) {
113 if (!ubi->volumes[i])
115 if (ubi->volumes[i]->vol_id >= UBI_INTERNAL_VOL_START)
119 namelen = 10; /* strlen(stringify(INT_MAX)) */
121 namelen = strlen(ubi->volumes[i]->name);
123 if (len + namelen + 1 > size) {
124 size = roundup_pow_of_two(len + namelen + 1) * 2;
125 str2 = realloc(str, size);
137 len += sprintf(str + len, "%d", ubi->volumes[i]->vol_id) + 1;
139 memcpy(str + len, ubi->volumes[i]->name, namelen);
151 static int ubi_check_volumename(const struct ubi_volume *vol, char *name)
153 return strcmp(vol->name, name);
156 static int ubi_check(char *name)
160 for (i = 0; i < (ubi->vtbl_slots + 1); i++) {
161 if (!ubi->volumes[i])
162 continue; /* Empty record */
164 if (!ubi_check_volumename(ubi->volumes[i], name))
171 static int verify_mkvol_req(const struct ubi_device *ubi,
172 const struct ubi_mkvol_req *req)
176 if (req->bytes < 0 || req->alignment < 0 || req->vol_type < 0 ||
180 if ((req->vol_id < 0 || req->vol_id >= ubi->vtbl_slots) &&
181 req->vol_id != UBI_VOL_NUM_AUTO)
184 if (req->alignment == 0)
187 if (req->bytes == 0) {
188 printf("No space left in UBI device!\n");
193 if (req->vol_type != UBI_DYNAMIC_VOLUME &&
194 req->vol_type != UBI_STATIC_VOLUME)
197 if (req->alignment > ubi->leb_size)
200 n = req->alignment % ubi->min_io_size;
201 if (req->alignment != 1 && n)
204 if (req->name_len > UBI_VOL_NAME_MAX) {
205 printf("Name too long!\n");
215 static int ubi_create_vol(char *volume, int64_t size, int dynamic, int vol_id,
218 struct ubi_mkvol_req req;
222 req.vol_type = UBI_DYNAMIC_VOLUME;
224 req.vol_type = UBI_STATIC_VOLUME;
230 strcpy(req.name, volume);
231 req.name_len = strlen(volume);
232 req.name[req.name_len] = '\0';
235 req.flags |= UBI_VOL_SKIP_CRC_CHECK_FLG;
237 /* It's duplicated at drivers/mtd/ubi/cdev.c */
238 err = verify_mkvol_req(ubi, &req);
240 printf("verify_mkvol_req failed %d\n", err);
243 printf("Creating %s volume %s of size %lld\n",
244 dynamic ? "dynamic" : "static", volume, size);
245 /* Call real ubi create volume */
246 return ubi_create_volume(ubi, &req);
249 static struct ubi_volume *ubi_find_volume(char *volume)
251 struct ubi_volume *vol = NULL;
254 for (i = 0; i < ubi->vtbl_slots; i++) {
255 vol = ubi->volumes[i];
256 if (vol && !strcmp(vol->name, volume))
260 printf("Volume %s not found!\n", volume);
264 static int ubi_remove_vol(char *volume)
266 int err, reserved_pebs, i;
267 struct ubi_volume *vol;
269 vol = ubi_find_volume(volume);
273 printf("Remove UBI volume %s (id %d)\n", vol->name, vol->vol_id);
276 printf("It's read-only mode\n");
281 err = ubi_change_vtbl_record(ubi, vol->vol_id, NULL);
283 printf("Error changing Vol tabel record err=%x\n", err);
286 reserved_pebs = vol->reserved_pebs;
287 for (i = 0; i < vol->reserved_pebs; i++) {
288 err = ubi_eba_unmap_leb(ubi, vol, i);
294 ubi->volumes[vol->vol_id]->eba_tbl = NULL;
295 ubi->volumes[vol->vol_id] = NULL;
297 ubi->rsvd_pebs -= reserved_pebs;
298 ubi->avail_pebs += reserved_pebs;
299 i = ubi->beb_rsvd_level - ubi->beb_rsvd_pebs;
301 i = ubi->avail_pebs >= i ? i : ubi->avail_pebs;
302 ubi->avail_pebs -= i;
304 ubi->beb_rsvd_pebs += i;
306 ubi_msg("reserve more %d PEBs", i);
312 ubi_err(ubi, "cannot remove volume %s, error %d", volume, err);
318 static int ubi_rename_vol(char *oldname, char *newname)
320 struct ubi_volume *vol;
321 struct ubi_rename_entry rename;
322 struct ubi_volume_desc desc;
323 struct list_head list;
325 vol = ubi_find_volume(oldname);
327 printf("%s: volume %s doesn't exist\n", __func__, oldname);
331 if (!ubi_check(newname)) {
332 printf("%s: volume %s already exist\n", __func__, newname);
336 printf("Rename UBI volume %s to %s\n", oldname, newname);
339 printf("%s: ubi device is in read-only mode\n", __func__);
343 rename.new_name_len = strlen(newname);
344 strcpy(rename.new_name, newname);
349 INIT_LIST_HEAD(&rename.list);
350 INIT_LIST_HEAD(&list);
351 list_add(&rename.list, &list);
353 return ubi_rename_volumes(ubi, &list);
356 static int ubi_volume_continue_write(char *volume, void *buf, size_t size)
359 struct ubi_volume *vol;
361 vol = ubi_find_volume(volume);
365 err = ubi_more_update_data(ubi, vol, buf, size);
367 printf("Couldnt or partially wrote data\n");
374 err = ubi_check_volume(ubi, vol->vol_id);
379 ubi_warn(ubi, "volume %d on UBI device %d is corrupt",
380 vol->vol_id, ubi->ubi_num);
385 ubi_gluebi_updated(vol);
391 int ubi_volume_begin_write(char *volume, void *buf, size_t size,
396 struct ubi_volume *vol;
398 vol = ubi_find_volume(volume);
402 rsvd_bytes = vol->reserved_pebs * (ubi->leb_size - vol->data_pad);
403 if (size > rsvd_bytes) {
404 printf("size > volume size! Aborting!\n");
408 err = ubi_start_update(ubi, vol, full_size);
410 printf("Cannot start volume update\n");
414 return ubi_volume_continue_write(volume, buf, size);
417 int ubi_volume_write(char *volume, void *buf, size_t size)
419 return ubi_volume_begin_write(volume, buf, size, size);
422 int ubi_volume_read(char *volume, char *buf, size_t size)
424 int err, lnum, off, len, tbuf_size;
426 unsigned long long tmp;
427 struct ubi_volume *vol;
431 vol = ubi_find_volume(volume);
439 if (vol->upd_marker) {
440 printf("damaged volume, update marker is set");
443 if (offp == vol->used_bytes)
447 printf("No size specified -> Using max size (%lld)\n", vol->used_bytes);
448 size = vol->used_bytes;
451 printf("Read %zu bytes from volume %s to %p\n", size, volume, buf);
454 printf("read from corrupted volume %d", vol->vol_id);
455 if (offp + size > vol->used_bytes)
456 size = vol->used_bytes - offp;
458 tbuf_size = vol->usable_leb_size;
459 if (size < tbuf_size)
460 tbuf_size = ALIGN(size, ubi->min_io_size);
461 tbuf = malloc_cache_aligned(tbuf_size);
466 len = size > tbuf_size ? tbuf_size : size;
469 off = do_div(tmp, vol->usable_leb_size);
473 if (off + len >= vol->usable_leb_size)
474 len = vol->usable_leb_size - off;
476 err = ubi_eba_read_leb(ubi, vol, lnum, tbuf, off, len, 0);
478 printf("read err %x\n", err);
483 if (off == vol->usable_leb_size) {
485 off -= vol->usable_leb_size;
491 memcpy(buf, tbuf, len);
494 len = size > tbuf_size ? tbuf_size : size;
498 env_set_hex("filesize", len_read);
504 static int ubi_dev_scan(struct mtd_info *info, const char *vid_header_offset)
506 char ubi_mtd_param_buffer[80];
509 if (!vid_header_offset)
510 sprintf(ubi_mtd_param_buffer, "%s", info->name);
512 sprintf(ubi_mtd_param_buffer, "%s,%s", info->name,
515 err = ubi_mtd_param_parse(ubi_mtd_param_buffer, NULL);
526 static int ubi_set_skip_check(char *volume, bool skip_check)
528 struct ubi_vtbl_record vtbl_rec;
529 struct ubi_volume *vol;
531 vol = ubi_find_volume(volume);
535 printf("%sing skip_check on volume %s\n",
536 skip_check ? "Sett" : "Clear", volume);
538 vtbl_rec = ubi->vtbl[vol->vol_id];
540 vtbl_rec.flags |= UBI_VTBL_SKIP_CRC_CHECK_FLG;
543 vtbl_rec.flags &= ~UBI_VTBL_SKIP_CRC_CHECK_FLG;
547 return ubi_change_vtbl_record(ubi, vol->vol_id, &vtbl_rec);
550 static int ubi_detach(void)
552 #ifdef CONFIG_CMD_UBIFS
554 * Automatically unmount UBIFS partition when user
555 * changes the UBI device. Otherwise the following
556 * UBIFS commands will crash.
558 if (ubifs_is_mounted())
563 * Call ubi_exit() before re-initializing the UBI subsystem
573 int ubi_part(char *part_name, const char *vid_header_offset)
575 struct mtd_info *mtd;
578 if (ubi && ubi->mtd && !strcmp(ubi->mtd->name, part_name)) {
579 printf("UBI partition '%s' already selected\n", part_name);
586 mtd = get_mtd_device_nm(part_name);
588 printf("Partition %s not found!\n", part_name);
593 err = ubi_dev_scan(mtd, vid_header_offset);
595 printf("UBI init error %d\n", err);
596 printf("Please check, if the correct MTD partition is used (size big enough?)\n");
600 ubi = ubi_devices[0];
605 static int do_ubi(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
609 bool skipcheck = false;
612 return CMD_RET_USAGE;
614 if (strcmp(argv[1], "detach") == 0)
617 if (strcmp(argv[1], "part") == 0) {
618 const char *vid_header_offset = NULL;
620 /* Print current partition */
623 printf("Error, no UBI device selected!\n");
627 printf("Device %d: %s, MTD partition %s\n",
628 ubi->ubi_num, ubi->ubi_name, ubi->mtd->name);
633 return CMD_RET_USAGE;
636 vid_header_offset = argv[3];
638 return ubi_part(argv[2], vid_header_offset);
641 if ((strcmp(argv[1], "part") != 0) && !ubi) {
642 printf("Error, no UBI device selected!\n");
646 if (strcmp(argv[1], "info") == 0) {
648 if (argc > 2 && !strncmp(argv[2], "l", 1))
650 return ubi_info(layout);
653 if (strcmp(argv[1], "list") == 0) {
655 if (argc >= 3 && argv[2][0] == '-') {
656 if (strcmp(argv[2], "-numeric") == 0)
659 return CMD_RET_USAGE;
661 if (!numeric && argc != 2 && argc != 3)
662 return CMD_RET_USAGE;
663 if (numeric && argc != 3 && argc != 4)
664 return CMD_RET_USAGE;
665 return ubi_list(argv[numeric ? 3 : 2], numeric);
668 if (strcmp(argv[1], "check") == 0) {
670 return ubi_check(argv[2]);
672 printf("Error, no volume name passed\n");
676 if (strncmp(argv[1], "create", 6) == 0) {
677 int dynamic = 1; /* default: dynamic volume */
678 int id = UBI_VOL_NUM_AUTO;
680 /* Use maximum available size */
683 /* E.g., create volume with "skipcheck" bit set */
685 skipcheck = strncmp(argv[6], "--skipcheck", 11) == 0;
689 /* E.g., create volume size type vol_id */
691 id = simple_strtoull(argv[5], NULL, 16);
695 /* E.g., create volume size type */
697 if (strncmp(argv[4], "s", 1) == 0)
699 else if (strncmp(argv[4], "d", 1) != 0) {
700 printf("Incorrect type\n");
705 /* E.g., create volume size */
707 if (argv[3][0] != '-')
708 size = simple_strtoull(argv[3], NULL, 16);
711 /* Use maximum available size */
713 size = (int64_t)ubi->avail_pebs * ubi->leb_size;
714 printf("No size specified -> Using max size (%lld)\n", size);
716 /* E.g., create volume */
718 return ubi_create_vol(argv[2], size, dynamic, id,
723 if (strncmp(argv[1], "remove", 6) == 0) {
724 /* E.g., remove volume */
726 return ubi_remove_vol(argv[2]);
729 if (IS_ENABLED(CONFIG_CMD_UBI_RENAME) && !strncmp(argv[1], "rename", 6))
730 return ubi_rename_vol(argv[2], argv[3]);
732 if (strncmp(argv[1], "skipcheck", 9) == 0) {
733 /* E.g., change skip_check flag */
735 skipcheck = strncmp(argv[3], "on", 2) == 0;
736 return ubi_set_skip_check(argv[2], skipcheck);
740 if (strncmp(argv[1], "write", 5) == 0) {
744 printf("Please see usage\n");
748 addr = hextoul(argv[2], NULL);
749 size = hextoul(argv[4], NULL);
751 if (strlen(argv[1]) == 10 &&
752 strncmp(argv[1] + 5, ".part", 5) == 0) {
754 ret = ubi_volume_continue_write(argv[3],
758 full_size = hextoul(argv[5], NULL);
759 ret = ubi_volume_begin_write(argv[3],
760 (void *)addr, size, full_size);
763 ret = ubi_volume_write(argv[3], (void *)addr, size);
766 printf("%lld bytes written to volume %s\n", size,
773 if (strncmp(argv[1], "read", 4) == 0) {
776 /* E.g., read volume size */
778 size = hextoul(argv[4], NULL);
782 /* E.g., read volume */
784 addr = hextoul(argv[2], NULL);
789 return ubi_volume_read(argv[3], (char *)addr, size);
793 printf("Please see usage\n");
801 " - detach ubi from a mtd partition\n"
802 "ubi part [part] [offset]\n"
803 " - Show or set current partition (with optional VID"
805 "ubi info [l[ayout]]"
806 " - Display volume and ubi layout information\n"
808 " - print the list of volumes\n"
809 "ubi list [flags] <varname>"
810 " - set environment variable to the list of volumes"
811 " (flags can be -numeric)\n"
812 "ubi check volumename"
813 " - check if volumename exists\n"
814 "ubi create[vol] volume [size] [type] [id] [--skipcheck]\n"
815 " - create volume name with size ('-' for maximum"
817 "ubi write[vol] address volume size"
818 " - Write volume from address with size\n"
819 "ubi write.part address volume size [fullsize]\n"
820 " - Write part of a volume from address\n"
821 "ubi read[vol] address volume [size]"
822 " - Read volume to address with size\n"
823 "ubi remove[vol] volume"
825 #if IS_ENABLED(CONFIG_CMD_UBI_RENAME)
826 "ubi rename oldname newname\n"
828 "ubi skipcheck volume on/off - Set or clear skip_check flag in volume header\n"
830 " volume: character name\n"
831 " size: specified in bytes\n"
832 " type: s[tatic] or d[ynamic] (default=dynamic)"