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