common/cmd_ubi.c

   1 /*
   2  * Unsorted Block Image commands
   3  *
   4  *  Copyright (C) 2008 Samsung Electronics
   5  *  Kyungmin Park <kyungmin.park@samsung.com>
   6  *
   7  * Copyright 2008-2009 Stefan Roese <sr@denx.de>, DENX Software Engineering
   8  *
   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.
  12  */
  13
  14 #include <common.h>
  15 #include <command.h>
  16 #include <exports.h>
  17
  18 #include <nand.h>
  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>
  25
  26 #undef ubi_msg
  27 #define ubi_msg(fmt, ...) printf("UBI: " fmt "\n", ##__VA_ARGS__)
  28
  29 #define DEV_TYPE_NONE           0
  30 #define DEV_TYPE_NAND           1
  31 #define DEV_TYPE_ONENAND        2
  32 #define DEV_TYPE_NOR            3
  33
  34 /* Private own data */
  35 static struct ubi_device *ubi;
  36 static char buffer[80];
  37 static int ubi_initialized;
  38
  39 struct selected_dev {
  40         char part_name[80];
  41         int selected;
  42         int nr;
  43         struct mtd_info *mtd_info;
  44 };
  45
  46 static struct selected_dev ubi_dev;
  47
  48 #ifdef CONFIG_CMD_UBIFS
  49 int ubifs_is_mounted(void);
  50 void cmd_ubifs_umount(void);
  51 #endif
  52
  53 static void ubi_dump_vol_info(const struct ubi_volume *vol)
  54 {
  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);
  68
  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);
  72         } else {
  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]);
  76         }
  77         printf("\n");
  78 }
  79
  80 static void display_volume_info(struct ubi_device *ubi)
  81 {
  82         int i;
  83
  84         for (i = 0; i < (ubi->vtbl_slots + 1); i++) {
  85                 if (!ubi->volumes[i])
  86                         continue;       /* Empty record */
  87                 ubi_dump_vol_info(ubi->volumes[i]);
  88         }
  89 }
  90
  91 static void display_ubi_info(struct ubi_device *ubi)
  92 {
  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",
 112                         ubi->beb_rsvd_pebs);
 113         ubi_msg("max/mean erase counter: %d/%d", ubi->max_ec, ubi->mean_ec);
 114 }
 115
 116 static int ubi_info(int layout)
 117 {
 118         if (layout)
 119                 display_volume_info(ubi);
 120         else
 121                 display_ubi_info(ubi);
 122
 123         return 0;
 124 }
 125
 126 static int verify_mkvol_req(const struct ubi_device *ubi,
 127                             const struct ubi_mkvol_req *req)
 128 {
 129         int n, err = EINVAL;
 130
 131         if (req->bytes < 0 || req->alignment < 0 || req->vol_type < 0 ||
 132             req->name_len < 0)
 133                 goto bad;
 134
 135         if ((req->vol_id < 0 || req->vol_id >= ubi->vtbl_slots) &&
 136             req->vol_id != UBI_VOL_NUM_AUTO)
 137                 goto bad;
 138
 139         if (req->alignment == 0)
 140                 goto bad;
 141
 142         if (req->bytes == 0) {
 143                 printf("No space left in UBI device!\n");
 144                 err = ENOMEM;
 145                 goto bad;
 146         }
 147
 148         if (req->vol_type != UBI_DYNAMIC_VOLUME &&
 149             req->vol_type != UBI_STATIC_VOLUME)
 150                 goto bad;
 151
 152         if (req->alignment > ubi->leb_size)
 153                 goto bad;
 154
 155         n = req->alignment % ubi->min_io_size;
 156         if (req->alignment != 1 && n)
 157                 goto bad;
 158
 159         if (req->name_len > UBI_VOL_NAME_MAX) {
 160                 printf("Name too long!\n");
 161                 err = ENAMETOOLONG;
 162                 goto bad;
 163         }
 164
 165         return 0;
 166 bad:
 167         return err;
 168 }
 169
 170 static int ubi_create_vol(char *volume, int size, int dynamic)
 171 {
 172         struct ubi_mkvol_req req;
 173         int err;
 174
 175         if (dynamic)
 176                 req.vol_type = UBI_DYNAMIC_VOLUME;
 177         else
 178                 req.vol_type = UBI_STATIC_VOLUME;
 179
 180         req.vol_id = UBI_VOL_NUM_AUTO;
 181         req.alignment = 1;
 182         req.bytes = size;
 183
 184         strcpy(req.name, volume);
 185         req.name_len = strlen(volume);
 186         req.name[req.name_len] = '\0';
 187         req.padding1 = 0;
 188         /* It's duplicated at drivers/mtd/ubi/cdev.c */
 189         err = verify_mkvol_req(ubi, &req);
 190         if (err) {
 191                 printf("verify_mkvol_req failed %d\n", err);
 192                 return err;
 193         }
 194         printf("Creating %s volume %s of size %d\n",
 195                 dynamic ? "dynamic" : "static", volume, size);
 196         /* Call real ubi create volume */
 197         return ubi_create_volume(ubi, &req);
 198 }
 199
 200 static struct ubi_volume *ubi_find_volume(char *volume)
 201 {
 202         struct ubi_volume *vol = NULL;
 203         int i;
 204
 205         for (i = 0; i < ubi->vtbl_slots; i++) {
 206                 vol = ubi->volumes[i];
 207                 if (vol && !strcmp(vol->name, volume))
 208                         return vol;
 209         }
 210
 211         printf("Volume %s not found!\n", volume);
 212         return NULL;
 213 }
 214
 215 static int ubi_remove_vol(char *volume)
 216 {
 217         int err, reserved_pebs, i;
 218         struct ubi_volume *vol;
 219
 220         vol = ubi_find_volume(volume);
 221         if (vol == NULL)
 222                 return ENODEV;
 223
 224         printf("Remove UBI volume %s (id %d)\n", vol->name, vol->vol_id);
 225
 226         if (ubi->ro_mode) {
 227                 printf("It's read-only mode\n");
 228                 err = EROFS;
 229                 goto out_err;
 230         }
 231
 232         err = ubi_change_vtbl_record(ubi, vol->vol_id, NULL);
 233         if (err) {
 234                 printf("Error changing Vol tabel record err=%x\n", err);
 235                 goto out_err;
 236         }
 237         reserved_pebs = vol->reserved_pebs;
 238         for (i = 0; i < vol->reserved_pebs; i++) {
 239                 err = ubi_eba_unmap_leb(ubi, vol, i);
 240                 if (err)
 241                         goto out_err;
 242         }
 243
 244         kfree(vol->eba_tbl);
 245         ubi->volumes[vol->vol_id]->eba_tbl = NULL;
 246         ubi->volumes[vol->vol_id] = NULL;
 247
 248         ubi->rsvd_pebs -= reserved_pebs;
 249         ubi->avail_pebs += reserved_pebs;
 250         i = ubi->beb_rsvd_level - ubi->beb_rsvd_pebs;
 251         if (i > 0) {
 252                 i = ubi->avail_pebs >= i ? i : ubi->avail_pebs;
 253                 ubi->avail_pebs -= i;
 254                 ubi->rsvd_pebs += i;
 255                 ubi->beb_rsvd_pebs += i;
 256                 if (i > 0)
 257                         ubi_msg("reserve more %d PEBs", i);
 258         }
 259         ubi->vol_count -= 1;
 260
 261         return 0;
 262 out_err:
 263         ubi_err("cannot remove volume %s, error %d", volume, err);
 264         if (err < 0)
 265                 err = -err;
 266         return err;
 267 }
 268
 269 int ubi_volume_write(char *volume, void *buf, size_t size)
 270 {
 271         int err = 1;
 272         int rsvd_bytes = 0;
 273         struct ubi_volume *vol;
 274
 275         vol = ubi_find_volume(volume);
 276         if (vol == NULL)
 277                 return ENODEV;
 278
 279         rsvd_bytes = vol->reserved_pebs * (ubi->leb_size - vol->data_pad);
 280         if (size < 0 || size > rsvd_bytes) {
 281                 printf("size > volume size! Aborting!\n");
 282                 return EINVAL;
 283         }
 284
 285         err = ubi_start_update(ubi, vol, size);
 286         if (err < 0) {
 287                 printf("Cannot start volume update\n");
 288                 return -err;
 289         }
 290
 291         err = ubi_more_update_data(ubi, vol, buf, size);
 292         if (err < 0) {
 293                 printf("Couldnt or partially wrote data\n");
 294                 return -err;
 295         }
 296
 297         if (err) {
 298                 size = err;
 299
 300                 err = ubi_check_volume(ubi, vol->vol_id);
 301                 if (err < 0)
 302                         return -err;
 303
 304                 if (err) {
 305                         ubi_warn("volume %d on UBI device %d is corrupted",
 306                                         vol->vol_id, ubi->ubi_num);
 307                         vol->corrupted = 1;
 308                 }
 309
 310                 vol->checked = 1;
 311                 ubi_gluebi_updated(vol);
 312         }
 313
 314         return 0;
 315 }
 316
 317 int ubi_volume_read(char *volume, char *buf, size_t size)
 318 {
 319         int err, lnum, off, len, tbuf_size;
 320         void *tbuf;
 321         unsigned long long tmp;
 322         struct ubi_volume *vol;
 323         loff_t offp = 0;
 324
 325         vol = ubi_find_volume(volume);
 326         if (vol == NULL)
 327                 return ENODEV;
 328
 329         if (vol->updating) {
 330                 printf("updating");
 331                 return EBUSY;
 332         }
 333         if (vol->upd_marker) {
 334                 printf("damaged volume, update marker is set");
 335                 return EBADF;
 336         }
 337         if (offp == vol->used_bytes)
 338                 return 0;
 339
 340         if (size == 0) {
 341                 printf("No size specified -> Using max size (%lld)\n", vol->used_bytes);
 342                 size = vol->used_bytes;
 343         }
 344
 345         if (vol->corrupted)
 346                 printf("read from corrupted volume %d", vol->vol_id);
 347         if (offp + size > vol->used_bytes)
 348                 size = vol->used_bytes - offp;
 349
 350         tbuf_size = vol->usable_leb_size;
 351         if (size < tbuf_size)
 352                 tbuf_size = ALIGN(size, ubi->min_io_size);
 353         tbuf = malloc(tbuf_size);
 354         if (!tbuf) {
 355                 printf("NO MEM\n");
 356                 return ENOMEM;
 357         }
 358         len = size > tbuf_size ? tbuf_size : size;
 359
 360         tmp = offp;
 361         off = do_div(tmp, vol->usable_leb_size);
 362         lnum = tmp;
 363         do {
 364                 if (off + len >= vol->usable_leb_size)
 365                         len = vol->usable_leb_size - off;
 366
 367                 err = ubi_eba_read_leb(ubi, vol, lnum, tbuf, off, len, 0);
 368                 if (err) {
 369                         printf("read err %x\n", err);
 370                         err = -err;
 371                         break;
 372                 }
 373                 off += len;
 374                 if (off == vol->usable_leb_size) {
 375                         lnum += 1;
 376                         off -= vol->usable_leb_size;
 377                 }
 378
 379                 size -= len;
 380                 offp += len;
 381
 382                 memcpy(buf, tbuf, len);
 383
 384                 buf += len;
 385                 len = size > tbuf_size ? tbuf_size : size;
 386         } while (size);
 387
 388         free(tbuf);
 389         return err;
 390 }
 391
 392 static int ubi_dev_scan(struct mtd_info *info, char *ubidev,
 393                 const char *vid_header_offset)
 394 {
 395         struct mtd_device *dev;
 396         struct part_info *part;
 397         struct mtd_partition mtd_part;
 398         char ubi_mtd_param_buffer[80];
 399         u8 pnum;
 400         int err;
 401
 402         if (find_dev_and_part(ubidev, &dev, &pnum, &part) != 0)
 403                 return 1;
 404
 405         sprintf(buffer, "mtd=%d", pnum);
 406         memset(&mtd_part, 0, sizeof(mtd_part));
 407         mtd_part.name = buffer;
 408         mtd_part.size = part->size;
 409         mtd_part.offset = part->offset;
 410         add_mtd_partitions(info, &mtd_part, 1);
 411
 412         strcpy(ubi_mtd_param_buffer, buffer);
 413         if (vid_header_offset)
 414                 sprintf(ubi_mtd_param_buffer, "mtd=%d,%s", pnum,
 415                                 vid_header_offset);
 416         err = ubi_mtd_param_parse(ubi_mtd_param_buffer, NULL);
 417         if (err) {
 418                 del_mtd_partitions(info);
 419                 return -err;
 420         }
 421
 422         err = ubi_init();
 423         if (err) {
 424                 del_mtd_partitions(info);
 425                 return -err;
 426         }
 427
 428         ubi_initialized = 1;
 429
 430         return 0;
 431 }
 432
 433 int ubi_part(char *part_name, const char *vid_header_offset)
 434 {
 435         int err = 0;
 436         char mtd_dev[16];
 437         struct mtd_device *dev;
 438         struct part_info *part;
 439         u8 pnum;
 440
 441         if (mtdparts_init() != 0) {
 442                 printf("Error initializing mtdparts!\n");
 443                 return 1;
 444         }
 445
 446 #ifdef CONFIG_CMD_UBIFS
 447         /*
 448          * Automatically unmount UBIFS partition when user
 449          * changes the UBI device. Otherwise the following
 450          * UBIFS commands will crash.
 451          */
 452         if (ubifs_is_mounted())
 453                 cmd_ubifs_umount();
 454 #endif
 455
 456         /* todo: get dev number for NAND... */
 457         ubi_dev.nr = 0;
 458
 459         /*
 460          * Call ubi_exit() before re-initializing the UBI subsystem
 461          */
 462         if (ubi_initialized) {
 463                 ubi_exit();
 464                 del_mtd_partitions(ubi_dev.mtd_info);
 465         }
 466
 467         /*
 468          * Search the mtd device number where this partition
 469          * is located
 470          */
 471         if (find_dev_and_part(part_name, &dev, &pnum, &part)) {
 472                 printf("Partition %s not found!\n", part_name);
 473                 return 1;
 474         }
 475         sprintf(mtd_dev, "%s%d", MTD_DEV_TYPE(dev->id->type), dev->id->num);
 476         ubi_dev.mtd_info = get_mtd_device_nm(mtd_dev);
 477         if (IS_ERR(ubi_dev.mtd_info)) {
 478                 printf("Partition %s not found on device %s!\n", part_name,
 479                        mtd_dev);
 480                 return 1;
 481         }
 482
 483         ubi_dev.selected = 1;
 484
 485         strcpy(ubi_dev.part_name, part_name);
 486         err = ubi_dev_scan(ubi_dev.mtd_info, ubi_dev.part_name,
 487                         vid_header_offset);
 488         if (err) {
 489                 printf("UBI init error %d\n", err);
 490                 ubi_dev.selected = 0;
 491                 return err;
 492         }
 493
 494         ubi = ubi_devices[0];
 495
 496         return 0;
 497 }
 498
 499 static int do_ubi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 500 {
 501         size_t size = 0;
 502         ulong addr = 0;
 503
 504         if (argc < 2)
 505                 return CMD_RET_USAGE;
 506
 507         if (strcmp(argv[1], "part") == 0) {
 508                 const char *vid_header_offset = NULL;
 509
 510                 /* Print current partition */
 511                 if (argc == 2) {
 512                         if (!ubi_dev.selected) {
 513                                 printf("Error, no UBI device/partition selected!\n");
 514                                 return 1;
 515                         }
 516
 517                         printf("Device %d: %s, partition %s\n",
 518                                ubi_dev.nr, ubi_dev.mtd_info->name, ubi_dev.part_name);
 519                         return 0;
 520                 }
 521
 522                 if (argc < 3)
 523                         return CMD_RET_USAGE;
 524
 525                 if (argc > 3)
 526                         vid_header_offset = argv[3];
 527
 528                 return ubi_part(argv[2], vid_header_offset);
 529         }
 530
 531         if ((strcmp(argv[1], "part") != 0) && (!ubi_dev.selected)) {
 532                 printf("Error, no UBI device/partition selected!\n");
 533                 return 1;
 534         }
 535
 536         if (strcmp(argv[1], "info") == 0) {
 537                 int layout = 0;
 538                 if (argc > 2 && !strncmp(argv[2], "l", 1))
 539                         layout = 1;
 540                 return ubi_info(layout);
 541         }
 542
 543         if (strncmp(argv[1], "create", 6) == 0) {
 544                 int dynamic = 1;        /* default: dynamic volume */
 545
 546                 /* Use maximum available size */
 547                 size = 0;
 548
 549                 /* E.g., create volume size type */
 550                 if (argc == 5) {
 551                         if (strncmp(argv[4], "s", 1) == 0)
 552                                 dynamic = 0;
 553                         else if (strncmp(argv[4], "d", 1) != 0) {
 554                                 printf("Incorrect type\n");
 555                                 return 1;
 556                         }
 557                         argc--;
 558                 }
 559                 /* E.g., create volume size */
 560                 if (argc == 4) {
 561                         size = simple_strtoul(argv[3], NULL, 16);
 562                         argc--;
 563                 }
 564                 /* Use maximum available size */
 565                 if (!size) {
 566                         size = ubi->avail_pebs * ubi->leb_size;
 567                         printf("No size specified -> Using max size (%u)\n", size);
 568                 }
 569                 /* E.g., create volume */
 570                 if (argc == 3)
 571                         return ubi_create_vol(argv[2], size, dynamic);
 572         }
 573
 574         if (strncmp(argv[1], "remove", 6) == 0) {
 575                 /* E.g., remove volume */
 576                 if (argc == 3)
 577                         return ubi_remove_vol(argv[2]);
 578         }
 579
 580         if (strncmp(argv[1], "write", 5) == 0) {
 581                 int ret;
 582
 583                 if (argc < 5) {
 584                         printf("Please see usage\n");
 585                         return 1;
 586                 }
 587
 588                 addr = simple_strtoul(argv[2], NULL, 16);
 589                 size = simple_strtoul(argv[4], NULL, 16);
 590
 591                 ret = ubi_volume_write(argv[3], (void *)addr, size);
 592                 if (!ret) {
 593                         printf("%d bytes written to volume %s\n", size,
 594                                argv[3]);
 595                 }
 596
 597                 return ret;
 598         }
 599
 600         if (strncmp(argv[1], "read", 4) == 0) {
 601                 size = 0;
 602
 603                 /* E.g., read volume size */
 604                 if (argc == 5) {
 605                         size = simple_strtoul(argv[4], NULL, 16);
 606                         argc--;
 607                 }
 608
 609                 /* E.g., read volume */
 610                 if (argc == 4) {
 611                         addr = simple_strtoul(argv[2], NULL, 16);
 612                         argc--;
 613                 }
 614
 615                 if (argc == 3) {
 616                         printf("Read %d bytes from volume %s to %lx\n", size,
 617                                argv[3], addr);
 618
 619                         return ubi_volume_read(argv[3], (char *)addr, size);
 620                 }
 621         }
 622
 623         printf("Please see usage\n");
 624         return 1;
 625 }
 626
 627 U_BOOT_CMD(
 628         ubi, 6, 1, do_ubi,
 629         "ubi commands",
 630         "part [part] [offset]\n"
 631                 " - Show or set current partition (with optional VID"
 632                 " header offset)\n"
 633         "ubi info [l[ayout]]"
 634                 " - Display volume and ubi layout information\n"
 635         "ubi create[vol] volume [size] [type]"
 636                 " - create volume name with size\n"
 637         "ubi write[vol] address volume size"
 638                 " - Write volume from address with size\n"
 639         "ubi read[vol] address volume [size]"
 640                 " - Read volume to address with size\n"
 641         "ubi remove[vol] volume"
 642                 " - Remove volume\n"
 643         "[Legends]\n"
 644         " volume: character name\n"
 645         " size: specified in bytes\n"
 646         " type: s[tatic] or d[ynamic] (default=dynamic)"
 647 );