disk/part.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2001
   4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   5  */
   6
   7 #include <common.h>
   8 #include <command.h>
   9 #include <errno.h>
  10 #include <ide.h>
  11 #include <malloc.h>
  12 #include <part.h>
  13 #include <ubifs_uboot.h>
  14
  15 #undef  PART_DEBUG
  16
  17 #ifdef  PART_DEBUG
  18 #define PRINTF(fmt,args...)     printf (fmt ,##args)
  19 #else
  20 #define PRINTF(fmt,args...)
  21 #endif
  22
  23 /* Check all partition types */
  24 #define PART_TYPE_ALL           -1
  25
  26 static struct part_driver *part_driver_lookup_type(struct blk_desc *dev_desc)
  27 {
  28         struct part_driver *drv =
  29                 ll_entry_start(struct part_driver, part_driver);
  30         const int n_ents = ll_entry_count(struct part_driver, part_driver);
  31         struct part_driver *entry;
  32
  33         if (dev_desc->part_type == PART_TYPE_UNKNOWN) {
  34                 for (entry = drv; entry != drv + n_ents; entry++) {
  35                         int ret;
  36
  37                         ret = entry->test(dev_desc);
  38                         if (!ret) {
  39                                 dev_desc->part_type = entry->part_type;
  40                                 return entry;
  41                         }
  42                 }
  43         } else {
  44                 for (entry = drv; entry != drv + n_ents; entry++) {
  45                         if (dev_desc->part_type == entry->part_type)
  46                                 return entry;
  47                 }
  48         }
  49
  50         /* Not found */
  51         return NULL;
  52 }
  53
  54 #ifdef CONFIG_HAVE_BLOCK_DEVICE
  55 static struct blk_desc *get_dev_hwpart(const char *ifname, int dev, int hwpart)
  56 {
  57         struct blk_desc *dev_desc;
  58         int ret;
  59
  60         dev_desc = blk_get_devnum_by_typename(ifname, dev);
  61         if (!dev_desc) {
  62                 debug("%s: No device for iface '%s', dev %d\n", __func__,
  63                       ifname, dev);
  64                 return NULL;
  65         }
  66         ret = blk_dselect_hwpart(dev_desc, hwpart);
  67         if (ret) {
  68                 debug("%s: Failed to select h/w partition: err-%d\n", __func__,
  69                       ret);
  70                 return NULL;
  71         }
  72
  73         return dev_desc;
  74 }
  75
  76 struct blk_desc *blk_get_dev(const char *ifname, int dev)
  77 {
  78         return get_dev_hwpart(ifname, dev, 0);
  79 }
  80 #else
  81 struct blk_desc *get_dev_hwpart(const char *ifname, int dev, int hwpart)
  82 {
  83         return NULL;
  84 }
  85
  86 struct blk_desc *blk_get_dev(const char *ifname, int dev)
  87 {
  88         return NULL;
  89 }
  90 #endif
  91
  92 #ifdef CONFIG_HAVE_BLOCK_DEVICE
  93
  94 /* ------------------------------------------------------------------------- */
  95 /*
  96  * reports device info to the user
  97  */
  98
  99 #ifdef CONFIG_LBA48
 100 typedef uint64_t lba512_t;
 101 #else
 102 typedef lbaint_t lba512_t;
 103 #endif
 104
 105 /*
 106  * Overflowless variant of (block_count * mul_by / 2**div_by)
 107  * when div_by > mul_by
 108  */
 109 static lba512_t lba512_muldiv(lba512_t block_count, lba512_t mul_by, int div_by)
 110 {
 111         lba512_t bc_quot, bc_rem;
 112
 113         /* x * m / d == x / d * m + (x % d) * m / d */
 114         bc_quot = block_count >> div_by;
 115         bc_rem  = block_count - (bc_quot << div_by);
 116         return bc_quot * mul_by + ((bc_rem * mul_by) >> div_by);
 117 }
 118
 119 void dev_print (struct blk_desc *dev_desc)
 120 {
 121         lba512_t lba512; /* number of blocks if 512bytes block size */
 122
 123         if (dev_desc->type == DEV_TYPE_UNKNOWN) {
 124                 puts ("not available\n");
 125                 return;
 126         }
 127
 128         switch (dev_desc->if_type) {
 129         case IF_TYPE_SCSI:
 130                 printf ("(%d:%d) Vendor: %s Prod.: %s Rev: %s\n",
 131                         dev_desc->target,dev_desc->lun,
 132                         dev_desc->vendor,
 133                         dev_desc->product,
 134                         dev_desc->revision);
 135                 break;
 136         case IF_TYPE_ATAPI:
 137         case IF_TYPE_IDE:
 138         case IF_TYPE_SATA:
 139                 printf ("Model: %s Firm: %s Ser#: %s\n",
 140                         dev_desc->vendor,
 141                         dev_desc->revision,
 142                         dev_desc->product);
 143                 break;
 144         case IF_TYPE_SD:
 145         case IF_TYPE_MMC:
 146         case IF_TYPE_USB:
 147         case IF_TYPE_NVME:
 148                 printf ("Vendor: %s Rev: %s Prod: %s\n",
 149                         dev_desc->vendor,
 150                         dev_desc->revision,
 151                         dev_desc->product);
 152                 break;
 153         case IF_TYPE_VIRTIO:
 154                 printf("%s VirtIO Block Device\n", dev_desc->vendor);
 155                 break;
 156         case IF_TYPE_DOC:
 157                 puts("device type DOC\n");
 158                 return;
 159         case IF_TYPE_UNKNOWN:
 160                 puts("device type unknown\n");
 161                 return;
 162         default:
 163                 printf("Unhandled device type: %i\n", dev_desc->if_type);
 164                 return;
 165         }
 166         puts ("            Type: ");
 167         if (dev_desc->removable)
 168                 puts ("Removable ");
 169         switch (dev_desc->type & 0x1F) {
 170         case DEV_TYPE_HARDDISK:
 171                 puts ("Hard Disk");
 172                 break;
 173         case DEV_TYPE_CDROM:
 174                 puts ("CD ROM");
 175                 break;
 176         case DEV_TYPE_OPDISK:
 177                 puts ("Optical Device");
 178                 break;
 179         case DEV_TYPE_TAPE:
 180                 puts ("Tape");
 181                 break;
 182         default:
 183                 printf ("# %02X #", dev_desc->type & 0x1F);
 184                 break;
 185         }
 186         puts ("\n");
 187         if (dev_desc->lba > 0L && dev_desc->blksz > 0L) {
 188                 ulong mb, mb_quot, mb_rem, gb, gb_quot, gb_rem;
 189                 lbaint_t lba;
 190
 191                 lba = dev_desc->lba;
 192
 193                 lba512 = (lba * (dev_desc->blksz/512));
 194                 /* round to 1 digit */
 195                 /* 2048 = (1024 * 1024) / 512 MB */
 196                 mb = lba512_muldiv(lba512, 10, 11);
 197
 198                 mb_quot = mb / 10;
 199                 mb_rem  = mb - (10 * mb_quot);
 200
 201                 gb = mb / 1024;
 202                 gb_quot = gb / 10;
 203                 gb_rem  = gb - (10 * gb_quot);
 204 #ifdef CONFIG_LBA48
 205                 if (dev_desc->lba48)
 206                         printf ("            Supports 48-bit addressing\n");
 207 #endif
 208 #if defined(CONFIG_SYS_64BIT_LBA)
 209                 printf ("            Capacity: %lu.%lu MB = %lu.%lu GB (%llu x %lu)\n",
 210                         mb_quot, mb_rem,
 211                         gb_quot, gb_rem,
 212                         lba,
 213                         dev_desc->blksz);
 214 #else
 215                 printf ("            Capacity: %lu.%lu MB = %lu.%lu GB (%lu x %lu)\n",
 216                         mb_quot, mb_rem,
 217                         gb_quot, gb_rem,
 218                         (ulong)lba,
 219                         dev_desc->blksz);
 220 #endif
 221         } else {
 222                 puts ("            Capacity: not available\n");
 223         }
 224 }
 225 #endif
 226
 227 #ifdef CONFIG_HAVE_BLOCK_DEVICE
 228
 229 void part_init(struct blk_desc *dev_desc)
 230 {
 231         struct part_driver *drv =
 232                 ll_entry_start(struct part_driver, part_driver);
 233         const int n_ents = ll_entry_count(struct part_driver, part_driver);
 234         struct part_driver *entry;
 235
 236         blkcache_invalidate(dev_desc->if_type, dev_desc->devnum);
 237
 238         dev_desc->part_type = PART_TYPE_UNKNOWN;
 239         for (entry = drv; entry != drv + n_ents; entry++) {
 240                 int ret;
 241
 242                 ret = entry->test(dev_desc);
 243                 debug("%s: try '%s': ret=%d\n", __func__, entry->name, ret);
 244                 if (!ret) {
 245                         dev_desc->part_type = entry->part_type;
 246                         break;
 247                 }
 248         }
 249 }
 250
 251 static void print_part_header(const char *type, struct blk_desc *dev_desc)
 252 {
 253 #if CONFIG_IS_ENABLED(MAC_PARTITION) || \
 254         CONFIG_IS_ENABLED(DOS_PARTITION) || \
 255         CONFIG_IS_ENABLED(ISO_PARTITION) || \
 256         CONFIG_IS_ENABLED(AMIGA_PARTITION) || \
 257         CONFIG_IS_ENABLED(EFI_PARTITION)
 258         puts ("\nPartition Map for ");
 259         switch (dev_desc->if_type) {
 260         case IF_TYPE_IDE:
 261                 puts ("IDE");
 262                 break;
 263         case IF_TYPE_SATA:
 264                 puts ("SATA");
 265                 break;
 266         case IF_TYPE_SCSI:
 267                 puts ("SCSI");
 268                 break;
 269         case IF_TYPE_ATAPI:
 270                 puts ("ATAPI");
 271                 break;
 272         case IF_TYPE_USB:
 273                 puts ("USB");
 274                 break;
 275         case IF_TYPE_DOC:
 276                 puts ("DOC");
 277                 break;
 278         case IF_TYPE_MMC:
 279                 puts ("MMC");
 280                 break;
 281         case IF_TYPE_HOST:
 282                 puts ("HOST");
 283                 break;
 284         case IF_TYPE_NVME:
 285                 puts ("NVMe");
 286                 break;
 287         case IF_TYPE_VIRTIO:
 288                 puts("VirtIO");
 289                 break;
 290         default:
 291                 puts ("UNKNOWN");
 292                 break;
 293         }
 294         printf (" device %d  --   Partition Type: %s\n\n",
 295                         dev_desc->devnum, type);
 296 #endif /* any CONFIG_..._PARTITION */
 297 }
 298
 299 void part_print(struct blk_desc *dev_desc)
 300 {
 301         struct part_driver *drv;
 302
 303         drv = part_driver_lookup_type(dev_desc);
 304         if (!drv) {
 305                 printf("## Unknown partition table type %x\n",
 306                        dev_desc->part_type);
 307                 return;
 308         }
 309
 310         PRINTF("## Testing for valid %s partition ##\n", drv->name);
 311         print_part_header(drv->name, dev_desc);
 312         if (drv->print)
 313                 drv->print(dev_desc);
 314 }
 315
 316 #endif /* CONFIG_HAVE_BLOCK_DEVICE */
 317
 318 int part_get_info(struct blk_desc *dev_desc, int part,
 319                        disk_partition_t *info)
 320 {
 321 #ifdef CONFIG_HAVE_BLOCK_DEVICE
 322         struct part_driver *drv;
 323
 324 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
 325         /* The common case is no UUID support */
 326         info->uuid[0] = 0;
 327 #endif
 328 #ifdef CONFIG_PARTITION_TYPE_GUID
 329         info->type_guid[0] = 0;
 330 #endif
 331
 332         drv = part_driver_lookup_type(dev_desc);
 333         if (!drv) {
 334                 debug("## Unknown partition table type %x\n",
 335                       dev_desc->part_type);
 336                 return -EPROTONOSUPPORT;
 337         }
 338         if (!drv->get_info) {
 339                 PRINTF("## Driver %s does not have the get_info() method\n",
 340                        drv->name);
 341                 return -ENOSYS;
 342         }
 343         if (drv->get_info(dev_desc, part, info) == 0) {
 344                 PRINTF("## Valid %s partition found ##\n", drv->name);
 345                 return 0;
 346         }
 347 #endif /* CONFIG_HAVE_BLOCK_DEVICE */
 348
 349         return -1;
 350 }
 351
 352 int part_get_info_whole_disk(struct blk_desc *dev_desc, disk_partition_t *info)
 353 {
 354         info->start = 0;
 355         info->size = dev_desc->lba;
 356         info->blksz = dev_desc->blksz;
 357         info->bootable = 0;
 358         strcpy((char *)info->type, BOOT_PART_TYPE);
 359         strcpy((char *)info->name, "Whole Disk");
 360 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
 361         info->uuid[0] = 0;
 362 #endif
 363 #ifdef CONFIG_PARTITION_TYPE_GUID
 364         info->type_guid[0] = 0;
 365 #endif
 366
 367         return 0;
 368 }
 369
 370 int blk_get_device_by_str(const char *ifname, const char *dev_hwpart_str,
 371                           struct blk_desc **dev_desc)
 372 {
 373         char *ep;
 374         char *dup_str = NULL;
 375         const char *dev_str, *hwpart_str;
 376         int dev, hwpart;
 377
 378         hwpart_str = strchr(dev_hwpart_str, '.');
 379         if (hwpart_str) {
 380                 dup_str = strdup(dev_hwpart_str);
 381                 dup_str[hwpart_str - dev_hwpart_str] = 0;
 382                 dev_str = dup_str;
 383                 hwpart_str++;
 384         } else {
 385                 dev_str = dev_hwpart_str;
 386                 hwpart = 0;
 387         }
 388
 389         dev = simple_strtoul(dev_str, &ep, 16);
 390         if (*ep) {
 391                 printf("** Bad device specification %s %s **\n",
 392                        ifname, dev_str);
 393                 dev = -EINVAL;
 394                 goto cleanup;
 395         }
 396
 397         if (hwpart_str) {
 398                 hwpart = simple_strtoul(hwpart_str, &ep, 16);
 399                 if (*ep) {
 400                         printf("** Bad HW partition specification %s %s **\n",
 401                             ifname, hwpart_str);
 402                         dev = -EINVAL;
 403                         goto cleanup;
 404                 }
 405         }
 406
 407         *dev_desc = get_dev_hwpart(ifname, dev, hwpart);
 408         if (!(*dev_desc) || ((*dev_desc)->type == DEV_TYPE_UNKNOWN)) {
 409                 debug("** Bad device %s %s **\n", ifname, dev_hwpart_str);
 410                 dev = -ENOENT;
 411                 goto cleanup;
 412         }
 413
 414 #ifdef CONFIG_HAVE_BLOCK_DEVICE
 415         /*
 416          * Updates the partition table for the specified hw partition.
 417          * Always should be done, otherwise hw partition 0 will return stale
 418          * data after displaying a non-zero hw partition.
 419          */
 420         part_init(*dev_desc);
 421 #endif
 422
 423 cleanup:
 424         free(dup_str);
 425         return dev;
 426 }
 427
 428 #define PART_UNSPECIFIED -2
 429 #define PART_AUTO -1
 430 int blk_get_device_part_str(const char *ifname, const char *dev_part_str,
 431                              struct blk_desc **dev_desc,
 432                              disk_partition_t *info, int allow_whole_dev)
 433 {
 434         int ret = -1;
 435         const char *part_str;
 436         char *dup_str = NULL;
 437         const char *dev_str;
 438         int dev;
 439         char *ep;
 440         int p;
 441         int part;
 442         disk_partition_t tmpinfo;
 443
 444 #ifdef CONFIG_SANDBOX
 445         /*
 446          * Special-case a pseudo block device "hostfs", to allow access to the
 447          * host's own filesystem.
 448          */
 449         if (0 == strcmp(ifname, "hostfs")) {
 450                 *dev_desc = NULL;
 451                 info->start = 0;
 452                 info->size = 0;
 453                 info->blksz = 0;
 454                 info->bootable = 0;
 455                 strcpy((char *)info->type, BOOT_PART_TYPE);
 456                 strcpy((char *)info->name, "Sandbox host");
 457 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
 458                 info->uuid[0] = 0;
 459 #endif
 460 #ifdef CONFIG_PARTITION_TYPE_GUID
 461                 info->type_guid[0] = 0;
 462 #endif
 463
 464                 return 0;
 465         }
 466 #endif
 467
 468 #ifdef CONFIG_CMD_UBIFS
 469         /*
 470          * Special-case ubi, ubi goes through a mtd, rather than through
 471          * a regular block device.
 472          */
 473         if (0 == strcmp(ifname, "ubi")) {
 474                 if (!ubifs_is_mounted()) {
 475                         printf("UBIFS not mounted, use ubifsmount to mount volume first!\n");
 476                         return -1;
 477                 }
 478
 479                 *dev_desc = NULL;
 480                 memset(info, 0, sizeof(*info));
 481                 strcpy((char *)info->type, BOOT_PART_TYPE);
 482                 strcpy((char *)info->name, "UBI");
 483 #if CONFIG_IS_ENABLED(PARTITION_UUIDS)
 484                 info->uuid[0] = 0;
 485 #endif
 486                 return 0;
 487         }
 488 #endif
 489
 490         /* If no dev_part_str, use bootdevice environment variable */
 491         if (!dev_part_str || !strlen(dev_part_str) ||
 492             !strcmp(dev_part_str, "-"))
 493                 dev_part_str = env_get("bootdevice");
 494
 495         /* If still no dev_part_str, it's an error */
 496         if (!dev_part_str) {
 497                 printf("** No device specified **\n");
 498                 goto cleanup;
 499         }
 500
 501         /* Separate device and partition ID specification */
 502         part_str = strchr(dev_part_str, ':');
 503         if (part_str) {
 504                 dup_str = strdup(dev_part_str);
 505                 dup_str[part_str - dev_part_str] = 0;
 506                 dev_str = dup_str;
 507                 part_str++;
 508         } else {
 509                 dev_str = dev_part_str;
 510         }
 511
 512         /* Look up the device */
 513         dev = blk_get_device_by_str(ifname, dev_str, dev_desc);
 514         if (dev < 0)
 515                 goto cleanup;
 516
 517         /* Convert partition ID string to number */
 518         if (!part_str || !*part_str) {
 519                 part = PART_UNSPECIFIED;
 520         } else if (!strcmp(part_str, "auto")) {
 521                 part = PART_AUTO;
 522         } else {
 523                 /* Something specified -> use exactly that */
 524                 part = (int)simple_strtoul(part_str, &ep, 16);
 525                 /*
 526                  * Less than whole string converted,
 527                  * or request for whole device, but caller requires partition.
 528                  */
 529                 if (*ep || (part == 0 && !allow_whole_dev)) {
 530                         printf("** Bad partition specification %s %s **\n",
 531                             ifname, dev_part_str);
 532                         goto cleanup;
 533                 }
 534         }
 535
 536         /*
 537          * No partition table on device,
 538          * or user requested partition 0 (entire device).
 539          */
 540         if (((*dev_desc)->part_type == PART_TYPE_UNKNOWN) ||
 541             (part == 0)) {
 542                 if (!(*dev_desc)->lba) {
 543                         printf("** Bad device size - %s %s **\n", ifname,
 544                                dev_str);
 545                         goto cleanup;
 546                 }
 547
 548                 /*
 549                  * If user specified a partition ID other than 0,
 550                  * or the calling command only accepts partitions,
 551                  * it's an error.
 552                  */
 553                 if ((part > 0) || (!allow_whole_dev)) {
 554                         printf("** No partition table - %s %s **\n", ifname,
 555                                dev_str);
 556                         goto cleanup;
 557                 }
 558
 559                 (*dev_desc)->log2blksz = LOG2((*dev_desc)->blksz);
 560
 561                 part_get_info_whole_disk(*dev_desc, info);
 562
 563                 ret = 0;
 564                 goto cleanup;
 565         }
 566
 567         /*
 568          * Now there's known to be a partition table,
 569          * not specifying a partition means to pick partition 1.
 570          */
 571         if (part == PART_UNSPECIFIED)
 572                 part = 1;
 573
 574         /*
 575          * If user didn't specify a partition number, or did specify something
 576          * other than "auto", use that partition number directly.
 577          */
 578         if (part != PART_AUTO) {
 579                 ret = part_get_info(*dev_desc, part, info);
 580                 if (ret) {
 581                         printf("** Invalid partition %d **\n", part);
 582                         goto cleanup;
 583                 }
 584         } else {
 585                 /*
 586                  * Find the first bootable partition.
 587                  * If none are bootable, fall back to the first valid partition.
 588                  */
 589                 part = 0;
 590                 for (p = 1; p <= MAX_SEARCH_PARTITIONS; p++) {
 591                         ret = part_get_info(*dev_desc, p, info);
 592                         if (ret)
 593                                 continue;
 594
 595                         /*
 596                          * First valid partition, or new better partition?
 597                          * If so, save partition ID.
 598                          */
 599                         if (!part || info->bootable)
 600                                 part = p;
 601
 602                         /* Best possible partition? Stop searching. */
 603                         if (info->bootable)
 604                                 break;
 605
 606                         /*
 607                          * We now need to search further for best possible.
 608                          * If we what we just queried was the best so far,
 609                          * save the info since we over-write it next loop.
 610                          */
 611                         if (part == p)
 612                                 tmpinfo = *info;
 613                 }
 614                 /* If we found any acceptable partition */
 615                 if (part) {
 616                         /*
 617                          * If we searched all possible partition IDs,
 618                          * return the first valid partition we found.
 619                          */
 620                         if (p == MAX_SEARCH_PARTITIONS + 1)
 621                                 *info = tmpinfo;
 622                 } else {
 623                         printf("** No valid partitions found **\n");
 624                         ret = -1;
 625                         goto cleanup;
 626                 }
 627         }
 628         if (strncmp((char *)info->type, BOOT_PART_TYPE, sizeof(info->type)) != 0) {
 629                 printf("** Invalid partition type \"%.32s\""
 630                         " (expect \"" BOOT_PART_TYPE "\")\n",
 631                         info->type);
 632                 ret  = -1;
 633                 goto cleanup;
 634         }
 635
 636         (*dev_desc)->log2blksz = LOG2((*dev_desc)->blksz);
 637
 638         ret = part;
 639         goto cleanup;
 640
 641 cleanup:
 642         free(dup_str);
 643         return ret;
 644 }
 645
 646 int part_get_info_by_name_type(struct blk_desc *dev_desc, const char *name,
 647                                disk_partition_t *info, int part_type)
 648 {
 649         struct part_driver *part_drv;
 650         int ret;
 651         int i;
 652
 653         part_drv = part_driver_lookup_type(dev_desc);
 654         if (!part_drv)
 655                 return -1;
 656         for (i = 1; i < part_drv->max_entries; i++) {
 657                 ret = part_drv->get_info(dev_desc, i, info);
 658                 if (ret != 0) {
 659                         /* no more entries in table */
 660                         break;
 661                 }
 662                 if (strcmp(name, (const char *)info->name) == 0) {
 663                         /* matched */
 664                         return i;
 665                 }
 666         }
 667
 668         return -1;
 669 }
 670
 671 int part_get_info_by_name(struct blk_desc *dev_desc, const char *name,
 672                           disk_partition_t *info)
 673 {
 674         return part_get_info_by_name_type(dev_desc, name, info, PART_TYPE_ALL);
 675 }
 676
 677 void part_set_generic_name(const struct blk_desc *dev_desc,
 678         int part_num, char *name)
 679 {
 680         char *devtype;
 681
 682         switch (dev_desc->if_type) {
 683         case IF_TYPE_IDE:
 684         case IF_TYPE_SATA:
 685         case IF_TYPE_ATAPI:
 686                 devtype = "hd";
 687                 break;
 688         case IF_TYPE_SCSI:
 689                 devtype = "sd";
 690                 break;
 691         case IF_TYPE_USB:
 692                 devtype = "usbd";
 693                 break;
 694         case IF_TYPE_DOC:
 695                 devtype = "docd";
 696                 break;
 697         case IF_TYPE_MMC:
 698         case IF_TYPE_SD:
 699                 devtype = "mmcsd";
 700                 break;
 701         default:
 702                 devtype = "xx";
 703                 break;
 704         }
 705
 706         sprintf(name, "%s%c%d", devtype, 'a' + dev_desc->devnum, part_num);
 707 }