disk/part.c

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