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