lib/efi_loader/efi_device_path.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * EFI device path from u-boot device-model mapping
   4  *
   5  * (C) Copyright 2017 Rob Clark
   6  */
   7
   8 #define LOG_CATEGORY LOGC_EFI
   9
  10 #include <common.h>
  11 #include <blk.h>
  12 #include <dm.h>
  13 #include <log.h>
  14 #include <net.h>
  15 #include <usb.h>
  16 #include <mmc.h>
  17 #include <nvme.h>
  18 #include <efi_loader.h>
  19 #include <part.h>
  20 #include <sandboxblockdev.h>
  21 #include <uuid.h>
  22 #include <asm-generic/unaligned.h>
  23 #include <linux/compat.h> /* U16_MAX */
  24
  25 #ifdef CONFIG_SANDBOX
  26 const efi_guid_t efi_guid_host_dev = U_BOOT_HOST_DEV_GUID;
  27 #endif
  28 #ifdef CONFIG_VIRTIO_BLK
  29 const efi_guid_t efi_guid_virtio_dev = U_BOOT_VIRTIO_DEV_GUID;
  30 #endif
  31
  32 /* template END node: */
  33 static const struct efi_device_path END = {
  34         .type     = DEVICE_PATH_TYPE_END,
  35         .sub_type = DEVICE_PATH_SUB_TYPE_END,
  36         .length   = sizeof(END),
  37 };
  38
  39 /* template ROOT node: */
  40 static const struct efi_device_path_vendor ROOT = {
  41         .dp = {
  42                 .type     = DEVICE_PATH_TYPE_HARDWARE_DEVICE,
  43                 .sub_type = DEVICE_PATH_SUB_TYPE_VENDOR,
  44                 .length   = sizeof(ROOT),
  45         },
  46         .guid = U_BOOT_GUID,
  47 };
  48
  49 #if defined(CONFIG_MMC)
  50 /*
  51  * Determine if an MMC device is an SD card.
  52  *
  53  * @desc        block device descriptor
  54  * @return      true if the device is an SD card
  55  */
  56 static bool is_sd(struct blk_desc *desc)
  57 {
  58         struct mmc *mmc = find_mmc_device(desc->devnum);
  59
  60         if (!mmc)
  61                 return false;
  62
  63         return IS_SD(mmc) != 0U;
  64 }
  65 #endif
  66
  67 static void *dp_alloc(size_t sz)
  68 {
  69         void *buf;
  70
  71         if (efi_allocate_pool(EFI_BOOT_SERVICES_DATA, sz, &buf) !=
  72             EFI_SUCCESS) {
  73                 debug("EFI: ERROR: out of memory in %s\n", __func__);
  74                 return NULL;
  75         }
  76
  77         memset(buf, 0, sz);
  78         return buf;
  79 }
  80
  81 /*
  82  * Iterate to next block in device-path, terminating (returning NULL)
  83  * at /End* node.
  84  */
  85 struct efi_device_path *efi_dp_next(const struct efi_device_path *dp)
  86 {
  87         if (dp == NULL)
  88                 return NULL;
  89         if (dp->type == DEVICE_PATH_TYPE_END)
  90                 return NULL;
  91         dp = ((void *)dp) + dp->length;
  92         if (dp->type == DEVICE_PATH_TYPE_END)
  93                 return NULL;
  94         return (struct efi_device_path *)dp;
  95 }
  96
  97 /*
  98  * Compare two device-paths, stopping when the shorter of the two hits
  99  * an End* node. This is useful to, for example, compare a device-path
 100  * representing a device with one representing a file on the device, or
 101  * a device with a parent device.
 102  */
 103 int efi_dp_match(const struct efi_device_path *a,
 104                  const struct efi_device_path *b)
 105 {
 106         while (1) {
 107                 int ret;
 108
 109                 ret = memcmp(&a->length, &b->length, sizeof(a->length));
 110                 if (ret)
 111                         return ret;
 112
 113                 ret = memcmp(a, b, a->length);
 114                 if (ret)
 115                         return ret;
 116
 117                 a = efi_dp_next(a);
 118                 b = efi_dp_next(b);
 119
 120                 if (!a || !b)
 121                         return 0;
 122         }
 123 }
 124
 125 /*
 126  * We can have device paths that start with a USB WWID or a USB Class node,
 127  * and a few other cases which don't encode the full device path with bus
 128  * hierarchy:
 129  *
 130  *   - MESSAGING:USB_WWID
 131  *   - MESSAGING:USB_CLASS
 132  *   - MEDIA:FILE_PATH
 133  *   - MEDIA:HARD_DRIVE
 134  *   - MESSAGING:URI
 135  *
 136  * See UEFI spec (section 3.1.2, about short-form device-paths)
 137  */
 138 static struct efi_device_path *shorten_path(struct efi_device_path *dp)
 139 {
 140         while (dp) {
 141                 /*
 142                  * TODO: Add MESSAGING:USB_WWID and MESSAGING:URI..
 143                  * in practice fallback.efi just uses MEDIA:HARD_DRIVE
 144                  * so not sure when we would see these other cases.
 145                  */
 146                 if (EFI_DP_TYPE(dp, MESSAGING_DEVICE, MSG_USB_CLASS) ||
 147                     EFI_DP_TYPE(dp, MEDIA_DEVICE, HARD_DRIVE_PATH) ||
 148                     EFI_DP_TYPE(dp, MEDIA_DEVICE, FILE_PATH))
 149                         return dp;
 150
 151                 dp = efi_dp_next(dp);
 152         }
 153
 154         return dp;
 155 }
 156
 157 static struct efi_object *find_obj(struct efi_device_path *dp, bool short_path,
 158                                    struct efi_device_path **rem)
 159 {
 160         struct efi_object *efiobj;
 161         efi_uintn_t dp_size = efi_dp_instance_size(dp);
 162
 163         list_for_each_entry(efiobj, &efi_obj_list, link) {
 164                 struct efi_handler *handler;
 165                 struct efi_device_path *obj_dp;
 166                 efi_status_t ret;
 167
 168                 ret = efi_search_protocol(efiobj,
 169                                           &efi_guid_device_path, &handler);
 170                 if (ret != EFI_SUCCESS)
 171                         continue;
 172                 obj_dp = handler->protocol_interface;
 173
 174                 do {
 175                         if (efi_dp_match(dp, obj_dp) == 0) {
 176                                 if (rem) {
 177                                         /*
 178                                          * Allow partial matches, but inform
 179                                          * the caller.
 180                                          */
 181                                         *rem = ((void *)dp) +
 182                                                 efi_dp_instance_size(obj_dp);
 183                                         return efiobj;
 184                                 } else {
 185                                         /* Only return on exact matches */
 186                                         if (efi_dp_instance_size(obj_dp) ==
 187                                             dp_size)
 188                                                 return efiobj;
 189                                 }
 190                         }
 191
 192                         obj_dp = shorten_path(efi_dp_next(obj_dp));
 193                 } while (short_path && obj_dp);
 194         }
 195
 196         return NULL;
 197 }
 198
 199 /*
 200  * Find an efiobj from device-path, if 'rem' is not NULL, returns the
 201  * remaining part of the device path after the matched object.
 202  */
 203 struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
 204                                    struct efi_device_path **rem)
 205 {
 206         struct efi_object *efiobj;
 207
 208         /* Search for an exact match first */
 209         efiobj = find_obj(dp, false, NULL);
 210
 211         /* Then for a fuzzy match */
 212         if (!efiobj)
 213                 efiobj = find_obj(dp, false, rem);
 214
 215         /* And now for a fuzzy short match */
 216         if (!efiobj)
 217                 efiobj = find_obj(dp, true, rem);
 218
 219         return efiobj;
 220 }
 221
 222 /*
 223  * Determine the last device path node that is not the end node.
 224  *
 225  * @dp          device path
 226  * @return      last node before the end node if it exists
 227  *              otherwise NULL
 228  */
 229 const struct efi_device_path *efi_dp_last_node(const struct efi_device_path *dp)
 230 {
 231         struct efi_device_path *ret;
 232
 233         if (!dp || dp->type == DEVICE_PATH_TYPE_END)
 234                 return NULL;
 235         while (dp) {
 236                 ret = (struct efi_device_path *)dp;
 237                 dp = efi_dp_next(dp);
 238         }
 239         return ret;
 240 }
 241
 242 /* get size of the first device path instance excluding end node */
 243 efi_uintn_t efi_dp_instance_size(const struct efi_device_path *dp)
 244 {
 245         efi_uintn_t sz = 0;
 246
 247         if (!dp || dp->type == DEVICE_PATH_TYPE_END)
 248                 return 0;
 249         while (dp) {
 250                 sz += dp->length;
 251                 dp = efi_dp_next(dp);
 252         }
 253
 254         return sz;
 255 }
 256
 257 /* get size of multi-instance device path excluding end node */
 258 efi_uintn_t efi_dp_size(const struct efi_device_path *dp)
 259 {
 260         const struct efi_device_path *p = dp;
 261
 262         if (!p)
 263                 return 0;
 264         while (p->type != DEVICE_PATH_TYPE_END ||
 265                p->sub_type != DEVICE_PATH_SUB_TYPE_END)
 266                 p = (void *)p + p->length;
 267
 268         return (void *)p - (void *)dp;
 269 }
 270
 271 /* copy multi-instance device path */
 272 struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp)
 273 {
 274         struct efi_device_path *ndp;
 275         size_t sz = efi_dp_size(dp) + sizeof(END);
 276
 277         if (!dp)
 278                 return NULL;
 279
 280         ndp = dp_alloc(sz);
 281         if (!ndp)
 282                 return NULL;
 283         memcpy(ndp, dp, sz);
 284
 285         return ndp;
 286 }
 287
 288 /**
 289  * efi_dp_append_or_concatenate() - Append or concatenate two device paths.
 290  *                                  Concatenated device path will be separated
 291  *                                  by a sub-type 0xff end node
 292  *
 293  * @dp1:        First device path
 294  * @dp2:        Second device path
 295  * @concat:     If true the two device paths will be concatenated and separated
 296  *              by an end of entrire device path sub-type 0xff end node.
 297  *              If true the second device path will be appended to the first and
 298  *              terminated by an end node
 299  *
 300  * Return:
 301  * concatenated device path or NULL. Caller must free the returned value
 302  */
 303 static struct
 304 efi_device_path *efi_dp_append_or_concatenate(const struct efi_device_path *dp1,
 305                                               const struct efi_device_path *dp2,
 306                                               bool concat)
 307 {
 308         struct efi_device_path *ret;
 309         size_t end_size = sizeof(END);
 310
 311         if (concat)
 312                 end_size = 2 * sizeof(END);
 313         if (!dp1 && !dp2) {
 314                 /* return an end node */
 315                 ret = efi_dp_dup(&END);
 316         } else if (!dp1) {
 317                 ret = efi_dp_dup(dp2);
 318         } else if (!dp2) {
 319                 ret = efi_dp_dup(dp1);
 320         } else {
 321                 /* both dp1 and dp2 are non-null */
 322                 unsigned sz1 = efi_dp_size(dp1);
 323                 unsigned sz2 = efi_dp_size(dp2);
 324                 void *p = dp_alloc(sz1 + sz2 + end_size);
 325                 if (!p)
 326                         return NULL;
 327                 ret = p;
 328                 memcpy(p, dp1, sz1);
 329                 p += sz1;
 330
 331                 if (concat) {
 332                         memcpy(p, &END, sizeof(END));
 333                         p += sizeof(END);
 334                 }
 335
 336                 /* the end node of the second device path has to be retained */
 337                 memcpy(p, dp2, sz2);
 338                 p += sz2;
 339                 memcpy(p, &END, sizeof(END));
 340         }
 341
 342         return ret;
 343 }
 344
 345 /**
 346  * efi_dp_append() - Append a device to an existing device path.
 347  *
 348  * @dp1:        First device path
 349  * @dp2:        Second device path
 350  *
 351  * Return:
 352  * concatenated device path or NULL. Caller must free the returned value
 353  */
 354 struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
 355                                       const struct efi_device_path *dp2)
 356 {
 357         return efi_dp_append_or_concatenate(dp1, dp2, false);
 358 }
 359
 360 /**
 361  * efi_dp_concat() - Concatenate 2 device paths. The final device path will
 362  *                   contain two device paths separated by and end node (0xff).
 363  *
 364  * @dp1:        First device path
 365  * @dp2:        Second device path
 366  *
 367  * Return:
 368  * concatenated device path or NULL. Caller must free the returned value
 369  */
 370 struct efi_device_path *efi_dp_concat(const struct efi_device_path *dp1,
 371                                       const struct efi_device_path *dp2)
 372 {
 373         return efi_dp_append_or_concatenate(dp1, dp2, true);
 374 }
 375
 376 struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
 377                                            const struct efi_device_path *node)
 378 {
 379         struct efi_device_path *ret;
 380
 381         if (!node && !dp) {
 382                 ret = efi_dp_dup(&END);
 383         } else if (!node) {
 384                 ret = efi_dp_dup(dp);
 385         } else if (!dp) {
 386                 size_t sz = node->length;
 387                 void *p = dp_alloc(sz + sizeof(END));
 388                 if (!p)
 389                         return NULL;
 390                 memcpy(p, node, sz);
 391                 memcpy(p + sz, &END, sizeof(END));
 392                 ret = p;
 393         } else {
 394                 /* both dp and node are non-null */
 395                 size_t sz = efi_dp_size(dp);
 396                 void *p = dp_alloc(sz + node->length + sizeof(END));
 397                 if (!p)
 398                         return NULL;
 399                 memcpy(p, dp, sz);
 400                 memcpy(p + sz, node, node->length);
 401                 memcpy(p + sz + node->length, &END, sizeof(END));
 402                 ret = p;
 403         }
 404
 405         return ret;
 406 }
 407
 408 struct efi_device_path *efi_dp_create_device_node(const u8 type,
 409                                                   const u8 sub_type,
 410                                                   const u16 length)
 411 {
 412         struct efi_device_path *ret;
 413
 414         if (length < sizeof(struct efi_device_path))
 415                 return NULL;
 416
 417         ret = dp_alloc(length);
 418         if (!ret)
 419                 return ret;
 420         ret->type = type;
 421         ret->sub_type = sub_type;
 422         ret->length = length;
 423         return ret;
 424 }
 425
 426 struct efi_device_path *efi_dp_append_instance(
 427                 const struct efi_device_path *dp,
 428                 const struct efi_device_path *dpi)
 429 {
 430         size_t sz, szi;
 431         struct efi_device_path *p, *ret;
 432
 433         if (!dpi)
 434                 return NULL;
 435         if (!dp)
 436                 return efi_dp_dup(dpi);
 437         sz = efi_dp_size(dp);
 438         szi = efi_dp_instance_size(dpi);
 439         p = dp_alloc(sz + szi + 2 * sizeof(END));
 440         if (!p)
 441                 return NULL;
 442         ret = p;
 443         memcpy(p, dp, sz + sizeof(END));
 444         p = (void *)p + sz;
 445         p->sub_type = DEVICE_PATH_SUB_TYPE_INSTANCE_END;
 446         p = (void *)p + sizeof(END);
 447         memcpy(p, dpi, szi);
 448         p = (void *)p + szi;
 449         memcpy(p, &END, sizeof(END));
 450         return ret;
 451 }
 452
 453 struct efi_device_path *efi_dp_get_next_instance(struct efi_device_path **dp,
 454                                                  efi_uintn_t *size)
 455 {
 456         size_t sz;
 457         struct efi_device_path *p;
 458
 459         if (size)
 460                 *size = 0;
 461         if (!dp || !*dp)
 462                 return NULL;
 463         sz = efi_dp_instance_size(*dp);
 464         p = dp_alloc(sz + sizeof(END));
 465         if (!p)
 466                 return NULL;
 467         memcpy(p, *dp, sz + sizeof(END));
 468         *dp = (void *)*dp + sz;
 469         if ((*dp)->sub_type == DEVICE_PATH_SUB_TYPE_INSTANCE_END)
 470                 *dp = (void *)*dp + sizeof(END);
 471         else
 472                 *dp = NULL;
 473         if (size)
 474                 *size = sz + sizeof(END);
 475         return p;
 476 }
 477
 478 bool efi_dp_is_multi_instance(const struct efi_device_path *dp)
 479 {
 480         const struct efi_device_path *p = dp;
 481
 482         if (!p)
 483                 return false;
 484         while (p->type != DEVICE_PATH_TYPE_END)
 485                 p = (void *)p + p->length;
 486         return p->sub_type == DEVICE_PATH_SUB_TYPE_INSTANCE_END;
 487 }
 488
 489 /* size of device-path not including END node for device and all parents
 490  * up to the root device.
 491  */
 492 __maybe_unused static unsigned int dp_size(struct udevice *dev)
 493 {
 494         if (!dev || !dev->driver)
 495                 return sizeof(ROOT);
 496
 497         switch (dev->driver->id) {
 498         case UCLASS_ROOT:
 499         case UCLASS_SIMPLE_BUS:
 500                 /* stop traversing parents at this point: */
 501                 return sizeof(ROOT);
 502         case UCLASS_ETH:
 503                 return dp_size(dev->parent) +
 504                         sizeof(struct efi_device_path_mac_addr);
 505         case UCLASS_BLK:
 506                 switch (dev->parent->uclass->uc_drv->id) {
 507 #ifdef CONFIG_IDE
 508                 case UCLASS_IDE:
 509                         return dp_size(dev->parent) +
 510                                 sizeof(struct efi_device_path_atapi);
 511 #endif
 512 #if defined(CONFIG_SCSI)
 513                 case UCLASS_SCSI:
 514                         return dp_size(dev->parent) +
 515                                 sizeof(struct efi_device_path_scsi);
 516 #endif
 517 #if defined(CONFIG_MMC)
 518                 case UCLASS_MMC:
 519                         return dp_size(dev->parent) +
 520                                 sizeof(struct efi_device_path_sd_mmc_path);
 521 #endif
 522 #if defined(CONFIG_AHCI) || defined(CONFIG_SATA)
 523                 case UCLASS_AHCI:
 524                         return dp_size(dev->parent) +
 525                                 sizeof(struct efi_device_path_sata);
 526 #endif
 527 #if defined(CONFIG_NVME)
 528                 case UCLASS_NVME:
 529                         return dp_size(dev->parent) +
 530                                 sizeof(struct efi_device_path_nvme);
 531 #endif
 532 #ifdef CONFIG_SANDBOX
 533                 case UCLASS_ROOT:
 534                          /*
 535                           * Sandbox's host device will be represented
 536                           * as vendor device with extra one byte for
 537                           * device number
 538                           */
 539                         return dp_size(dev->parent)
 540                                 + sizeof(struct efi_device_path_vendor) + 1;
 541 #endif
 542 #ifdef CONFIG_VIRTIO_BLK
 543                 case UCLASS_VIRTIO:
 544                          /*
 545                           * Virtio devices will be represented as a vendor
 546                           * device node with an extra byte for the device
 547                           * number.
 548                           */
 549                         return dp_size(dev->parent)
 550                                 + sizeof(struct efi_device_path_vendor) + 1;
 551 #endif
 552                 default:
 553                         return dp_size(dev->parent);
 554                 }
 555 #if defined(CONFIG_MMC)
 556         case UCLASS_MMC:
 557                 return dp_size(dev->parent) +
 558                         sizeof(struct efi_device_path_sd_mmc_path);
 559 #endif
 560         case UCLASS_MASS_STORAGE:
 561         case UCLASS_USB_HUB:
 562                 return dp_size(dev->parent) +
 563                         sizeof(struct efi_device_path_usb_class);
 564         default:
 565                 /* just skip over unknown classes: */
 566                 return dp_size(dev->parent);
 567         }
 568 }
 569
 570 /*
 571  * Recursively build a device path.
 572  *
 573  * @buf         pointer to the end of the device path
 574  * @dev         device
 575  * @return      pointer to the end of the device path
 576  */
 577 __maybe_unused static void *dp_fill(void *buf, struct udevice *dev)
 578 {
 579         if (!dev || !dev->driver)
 580                 return buf;
 581
 582         switch (dev->driver->id) {
 583         case UCLASS_ROOT:
 584         case UCLASS_SIMPLE_BUS: {
 585                 /* stop traversing parents at this point: */
 586                 struct efi_device_path_vendor *vdp = buf;
 587                 *vdp = ROOT;
 588                 return &vdp[1];
 589         }
 590 #ifdef CONFIG_NET
 591         case UCLASS_ETH: {
 592                 struct efi_device_path_mac_addr *dp =
 593                         dp_fill(buf, dev->parent);
 594                 struct eth_pdata *pdata = dev_get_plat(dev);
 595
 596                 dp->dp.type = DEVICE_PATH_TYPE_MESSAGING_DEVICE;
 597                 dp->dp.sub_type = DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR;
 598                 dp->dp.length = sizeof(*dp);
 599                 memset(&dp->mac, 0, sizeof(dp->mac));
 600                 /* We only support IPv4 */
 601                 memcpy(&dp->mac, &pdata->enetaddr, ARP_HLEN);
 602                 /* Ethernet */
 603                 dp->if_type = 1;
 604                 return &dp[1];
 605         }
 606 #endif
 607         case UCLASS_BLK:
 608                 switch (dev->parent->uclass->uc_drv->id) {
 609 #ifdef CONFIG_SANDBOX
 610                 case UCLASS_ROOT: {
 611                         /* stop traversing parents at this point: */
 612                         struct efi_device_path_vendor *dp;
 613                         struct blk_desc *desc = dev_get_uclass_plat(dev);
 614
 615                         dp_fill(buf, dev->parent);
 616                         dp = buf;
 617                         ++dp;
 618                         dp->dp.type = DEVICE_PATH_TYPE_HARDWARE_DEVICE;
 619                         dp->dp.sub_type = DEVICE_PATH_SUB_TYPE_VENDOR;
 620                         dp->dp.length = sizeof(*dp) + 1;
 621                         memcpy(&dp->guid, &efi_guid_host_dev,
 622                                sizeof(efi_guid_t));
 623                         dp->vendor_data[0] = desc->devnum;
 624                         return &dp->vendor_data[1];
 625                         }
 626 #endif
 627 #ifdef CONFIG_VIRTIO_BLK
 628                 case UCLASS_VIRTIO: {
 629                         struct efi_device_path_vendor *dp;
 630                         struct blk_desc *desc = dev_get_uclass_plat(dev);
 631
 632                         dp_fill(buf, dev->parent);
 633                         dp = buf;
 634                         ++dp;
 635                         dp->dp.type = DEVICE_PATH_TYPE_HARDWARE_DEVICE;
 636                         dp->dp.sub_type = DEVICE_PATH_SUB_TYPE_VENDOR;
 637                         dp->dp.length = sizeof(*dp) + 1;
 638                         memcpy(&dp->guid, &efi_guid_virtio_dev,
 639                                sizeof(efi_guid_t));
 640                         dp->vendor_data[0] = desc->devnum;
 641                         return &dp->vendor_data[1];
 642                         }
 643 #endif
 644 #ifdef CONFIG_IDE
 645                 case UCLASS_IDE: {
 646                         struct efi_device_path_atapi *dp =
 647                         dp_fill(buf, dev->parent);
 648                         struct blk_desc *desc = dev_get_uclass_plat(dev);
 649
 650                         dp->dp.type = DEVICE_PATH_TYPE_MESSAGING_DEVICE;
 651                         dp->dp.sub_type = DEVICE_PATH_SUB_TYPE_MSG_ATAPI;
 652                         dp->dp.length = sizeof(*dp);
 653                         dp->logical_unit_number = desc->devnum;
 654                         dp->primary_secondary = IDE_BUS(desc->devnum);
 655                         dp->slave_master = desc->devnum %
 656                                 (CONFIG_SYS_IDE_MAXDEVICE /
 657                                  CONFIG_SYS_IDE_MAXBUS);
 658                         return &dp[1];
 659                         }
 660 #endif
 661 #if defined(CONFIG_SCSI)
 662                 case UCLASS_SCSI: {
 663                         struct efi_device_path_scsi *dp =
 664                                 dp_fill(buf, dev->parent);
 665                         struct blk_desc *desc = dev_get_uclass_plat(dev);
 666
 667                         dp->dp.type = DEVICE_PATH_TYPE_MESSAGING_DEVICE;
 668                         dp->dp.sub_type = DEVICE_PATH_SUB_TYPE_MSG_SCSI;
 669                         dp->dp.length = sizeof(*dp);
 670                         dp->logical_unit_number = desc->lun;
 671                         dp->target_id = desc->target;
 672                         return &dp[1];
 673                         }
 674 #endif
 675 #if defined(CONFIG_MMC)
 676                 case UCLASS_MMC: {
 677                         struct efi_device_path_sd_mmc_path *sddp =
 678                                 dp_fill(buf, dev->parent);
 679                         struct blk_desc *desc = dev_get_uclass_plat(dev);
 680
 681                         sddp->dp.type     = DEVICE_PATH_TYPE_MESSAGING_DEVICE;
 682                         sddp->dp.sub_type = is_sd(desc) ?
 683                                 DEVICE_PATH_SUB_TYPE_MSG_SD :
 684                                 DEVICE_PATH_SUB_TYPE_MSG_MMC;
 685                         sddp->dp.length   = sizeof(*sddp);
 686                         sddp->slot_number = dev_seq(dev);
 687                         return &sddp[1];
 688                         }
 689 #endif
 690 #if defined(CONFIG_AHCI) || defined(CONFIG_SATA)
 691                 case UCLASS_AHCI: {
 692                         struct efi_device_path_sata *dp =
 693                                 dp_fill(buf, dev->parent);
 694                         struct blk_desc *desc = dev_get_uclass_plat(dev);
 695
 696                         dp->dp.type     = DEVICE_PATH_TYPE_MESSAGING_DEVICE;
 697                         dp->dp.sub_type = DEVICE_PATH_SUB_TYPE_MSG_SATA;
 698                         dp->dp.length   = sizeof(*dp);
 699                         dp->hba_port = desc->devnum;
 700                         /* default 0xffff implies no port multiplier */
 701                         dp->port_multiplier_port = 0xffff;
 702                         dp->logical_unit_number = desc->lun;
 703                         return &dp[1];
 704                         }
 705 #endif
 706 #if defined(CONFIG_NVME)
 707                 case UCLASS_NVME: {
 708                         struct efi_device_path_nvme *dp =
 709                                 dp_fill(buf, dev->parent);
 710                         u32 ns_id;
 711
 712                         dp->dp.type     = DEVICE_PATH_TYPE_MESSAGING_DEVICE;
 713                         dp->dp.sub_type = DEVICE_PATH_SUB_TYPE_MSG_NVME;
 714                         dp->dp.length   = sizeof(*dp);
 715                         nvme_get_namespace_id(dev, &ns_id, dp->eui64);
 716                         memcpy(&dp->ns_id, &ns_id, sizeof(ns_id));
 717                         return &dp[1];
 718                         }
 719 #endif
 720                 default:
 721                         debug("%s(%u) %s: unhandled parent class: %s (%u)\n",
 722                               __FILE__, __LINE__, __func__,
 723                               dev->name, dev->parent->uclass->uc_drv->id);
 724                         return dp_fill(buf, dev->parent);
 725                 }
 726 #if defined(CONFIG_MMC)
 727         case UCLASS_MMC: {
 728                 struct efi_device_path_sd_mmc_path *sddp =
 729                         dp_fill(buf, dev->parent);
 730                 struct mmc *mmc = mmc_get_mmc_dev(dev);
 731                 struct blk_desc *desc = mmc_get_blk_desc(mmc);
 732
 733                 sddp->dp.type     = DEVICE_PATH_TYPE_MESSAGING_DEVICE;
 734                 sddp->dp.sub_type = is_sd(desc) ?
 735                         DEVICE_PATH_SUB_TYPE_MSG_SD :
 736                         DEVICE_PATH_SUB_TYPE_MSG_MMC;
 737                 sddp->dp.length   = sizeof(*sddp);
 738                 sddp->slot_number = dev_seq(dev);
 739
 740                 return &sddp[1];
 741         }
 742 #endif
 743         case UCLASS_MASS_STORAGE:
 744         case UCLASS_USB_HUB: {
 745                 struct efi_device_path_usb_class *udp =
 746                         dp_fill(buf, dev->parent);
 747                 struct usb_device *udev = dev_get_parent_priv(dev);
 748                 struct usb_device_descriptor *desc = &udev->descriptor;
 749
 750                 udp->dp.type     = DEVICE_PATH_TYPE_MESSAGING_DEVICE;
 751                 udp->dp.sub_type = DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS;
 752                 udp->dp.length   = sizeof(*udp);
 753                 udp->vendor_id   = desc->idVendor;
 754                 udp->product_id  = desc->idProduct;
 755                 udp->device_class    = desc->bDeviceClass;
 756                 udp->device_subclass = desc->bDeviceSubClass;
 757                 udp->device_protocol = desc->bDeviceProtocol;
 758
 759                 return &udp[1];
 760         }
 761         default:
 762                 debug("%s(%u) %s: unhandled device class: %s (%u)\n",
 763                       __FILE__, __LINE__, __func__,
 764                       dev->name, dev->driver->id);
 765                 return dp_fill(buf, dev->parent);
 766         }
 767 }
 768
 769 static unsigned dp_part_size(struct blk_desc *desc, int part)
 770 {
 771         unsigned dpsize;
 772         struct udevice *dev;
 773         int ret;
 774
 775         ret = blk_find_device(desc->if_type, desc->devnum, &dev);
 776
 777         if (ret)
 778                 dev = desc->bdev->parent;
 779         dpsize = dp_size(dev);
 780
 781         if (part == 0) /* the actual disk, not a partition */
 782                 return dpsize;
 783
 784         if (desc->part_type == PART_TYPE_ISO)
 785                 dpsize += sizeof(struct efi_device_path_cdrom_path);
 786         else
 787                 dpsize += sizeof(struct efi_device_path_hard_drive_path);
 788
 789         return dpsize;
 790 }
 791
 792 /*
 793  * Create a device node for a block device partition.
 794  *
 795  * @buf         buffer to which the device path is written
 796  * @desc        block device descriptor
 797  * @part        partition number, 0 identifies a block device
 798  */
 799 static void *dp_part_node(void *buf, struct blk_desc *desc, int part)
 800 {
 801         struct disk_partition info;
 802
 803         part_get_info(desc, part, &info);
 804
 805         if (desc->part_type == PART_TYPE_ISO) {
 806                 struct efi_device_path_cdrom_path *cddp = buf;
 807
 808                 cddp->boot_entry = part;
 809                 cddp->dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE;
 810                 cddp->dp.sub_type = DEVICE_PATH_SUB_TYPE_CDROM_PATH;
 811                 cddp->dp.length = sizeof(*cddp);
 812                 cddp->partition_start = info.start;
 813                 cddp->partition_size = info.size;
 814
 815                 buf = &cddp[1];
 816         } else {
 817                 struct efi_device_path_hard_drive_path *hddp = buf;
 818
 819                 hddp->dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE;
 820                 hddp->dp.sub_type = DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH;
 821                 hddp->dp.length = sizeof(*hddp);
 822                 hddp->partition_number = part;
 823                 hddp->partition_start = info.start;
 824                 hddp->partition_end = info.size;
 825                 if (desc->part_type == PART_TYPE_EFI)
 826                         hddp->partmap_type = 2;
 827                 else
 828                         hddp->partmap_type = 1;
 829
 830                 switch (desc->sig_type) {
 831                 case SIG_TYPE_NONE:
 832                 default:
 833                         hddp->signature_type = 0;
 834                         memset(hddp->partition_signature, 0,
 835                                sizeof(hddp->partition_signature));
 836                         break;
 837                 case SIG_TYPE_MBR:
 838                         hddp->signature_type = 1;
 839                         memset(hddp->partition_signature, 0,
 840                                sizeof(hddp->partition_signature));
 841                         memcpy(hddp->partition_signature, &desc->mbr_sig,
 842                                sizeof(desc->mbr_sig));
 843                         break;
 844                 case SIG_TYPE_GUID:
 845                         hddp->signature_type = 2;
 846                         if (uuid_str_to_bin(info.uuid,
 847                                             hddp->partition_signature, 1))
 848                                 log_warning(
 849                                         "Partition no. %d: invalid guid: %s\n",
 850                                         part, info.uuid);
 851                         break;
 852                 }
 853
 854                 buf = &hddp[1];
 855         }
 856
 857         return buf;
 858 }
 859
 860 /*
 861  * Create a device path for a block device or one of its partitions.
 862  *
 863  * @buf         buffer to which the device path is written
 864  * @desc        block device descriptor
 865  * @part        partition number, 0 identifies a block device
 866  */
 867 static void *dp_part_fill(void *buf, struct blk_desc *desc, int part)
 868 {
 869         struct udevice *dev;
 870         int ret;
 871
 872         ret = blk_find_device(desc->if_type, desc->devnum, &dev);
 873
 874         if (ret)
 875                 dev = desc->bdev->parent;
 876         buf = dp_fill(buf, dev);
 877
 878         if (part == 0) /* the actual disk, not a partition */
 879                 return buf;
 880
 881         return dp_part_node(buf, desc, part);
 882 }
 883
 884 /* Construct a device-path from a partition on a block device: */
 885 struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part)
 886 {
 887         void *buf, *start;
 888
 889         start = buf = dp_alloc(dp_part_size(desc, part) + sizeof(END));
 890         if (!buf)
 891                 return NULL;
 892
 893         buf = dp_part_fill(buf, desc, part);
 894
 895         *((struct efi_device_path *)buf) = END;
 896
 897         return start;
 898 }
 899
 900 /*
 901  * Create a device node for a block device partition.
 902  *
 903  * @buf         buffer to which the device path is written
 904  * @desc        block device descriptor
 905  * @part        partition number, 0 identifies a block device
 906  */
 907 struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part)
 908 {
 909         efi_uintn_t dpsize;
 910         void *buf;
 911
 912         if (desc->part_type == PART_TYPE_ISO)
 913                 dpsize = sizeof(struct efi_device_path_cdrom_path);
 914         else
 915                 dpsize = sizeof(struct efi_device_path_hard_drive_path);
 916         buf = dp_alloc(dpsize);
 917
 918         dp_part_node(buf, desc, part);
 919
 920         return buf;
 921 }
 922
 923 /**
 924  * path_to_uefi() - convert UTF-8 path to an UEFI style path
 925  *
 926  * Convert UTF-8 path to a UEFI style path (i.e. with backslashes as path
 927  * separators and UTF-16).
 928  *
 929  * @src:        source buffer
 930  * @uefi:       target buffer, possibly unaligned
 931  */
 932 static void path_to_uefi(void *uefi, const char *src)
 933 {
 934         u16 *pos = uefi;
 935
 936         /*
 937          * efi_set_bootdev() calls this routine indirectly before the UEFI
 938          * subsystem is initialized. So we cannot assume unaligned access to be
 939          * enabled.
 940          */
 941         allow_unaligned();
 942
 943         while (*src) {
 944                 s32 code = utf8_get(&src);
 945
 946                 if (code < 0)
 947                         code = '?';
 948                 else if (code == '/')
 949                         code = '\\';
 950                 utf16_put(code, &pos);
 951         }
 952         *pos = 0;
 953 }
 954
 955 /*
 956  * If desc is NULL, this creates a path with only the file component,
 957  * otherwise it creates a full path with both device and file components
 958  */
 959 struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
 960                 const char *path)
 961 {
 962         struct efi_device_path_file_path *fp;
 963         void *buf, *start;
 964         size_t dpsize = 0, fpsize;
 965
 966         if (desc)
 967                 dpsize = dp_part_size(desc, part);
 968
 969         fpsize = sizeof(struct efi_device_path) +
 970                  2 * (utf8_utf16_strlen(path) + 1);
 971         if (fpsize > U16_MAX)
 972                 return NULL;
 973
 974         dpsize += fpsize;
 975
 976         start = buf = dp_alloc(dpsize + sizeof(END));
 977         if (!buf)
 978                 return NULL;
 979
 980         if (desc)
 981                 buf = dp_part_fill(buf, desc, part);
 982
 983         /* add file-path: */
 984         fp = buf;
 985         fp->dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE;
 986         fp->dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH;
 987         fp->dp.length = (u16)fpsize;
 988         path_to_uefi(fp->str, path);
 989         buf += fpsize;
 990
 991         *((struct efi_device_path *)buf) = END;
 992
 993         return start;
 994 }
 995
 996 struct efi_device_path *efi_dp_from_uart(void)
 997 {
 998         void *buf, *pos;
 999         struct efi_device_path_uart *uart;
1000         size_t dpsize = sizeof(ROOT) + sizeof(*uart) + sizeof(END);
1001
1002         buf = dp_alloc(dpsize);
1003         if (!buf)
1004                 return NULL;
1005         pos = buf;
1006         memcpy(pos, &ROOT, sizeof(ROOT));
1007         pos += sizeof(ROOT);
1008         uart = pos;
1009         uart->dp.type = DEVICE_PATH_TYPE_MESSAGING_DEVICE;
1010         uart->dp.sub_type = DEVICE_PATH_SUB_TYPE_MSG_UART;
1011         uart->dp.length = sizeof(*uart);
1012         pos += sizeof(*uart);
1013         memcpy(pos, &END, sizeof(END));
1014
1015         return buf;
1016 }
1017
1018 #ifdef CONFIG_NET
1019 struct efi_device_path *efi_dp_from_eth(void)
1020 {
1021         void *buf, *start;
1022         unsigned dpsize = 0;
1023
1024         assert(eth_get_dev());
1025
1026         dpsize += dp_size(eth_get_dev());
1027
1028         start = buf = dp_alloc(dpsize + sizeof(END));
1029         if (!buf)
1030                 return NULL;
1031
1032         buf = dp_fill(buf, eth_get_dev());
1033
1034         *((struct efi_device_path *)buf) = END;
1035
1036         return start;
1037 }
1038 #endif
1039
1040 /* Construct a device-path for memory-mapped image */
1041 struct efi_device_path *efi_dp_from_mem(uint32_t memory_type,
1042                                         uint64_t start_address,
1043                                         uint64_t end_address)
1044 {
1045         struct efi_device_path_memory *mdp;
1046         void *buf, *start;
1047
1048         start = buf = dp_alloc(sizeof(*mdp) + sizeof(END));
1049         if (!buf)
1050                 return NULL;
1051
1052         mdp = buf;
1053         mdp->dp.type = DEVICE_PATH_TYPE_HARDWARE_DEVICE;
1054         mdp->dp.sub_type = DEVICE_PATH_SUB_TYPE_MEMORY;
1055         mdp->dp.length = sizeof(*mdp);
1056         mdp->memory_type = memory_type;
1057         mdp->start_address = start_address;
1058         mdp->end_address = end_address;
1059         buf = &mdp[1];
1060
1061         *((struct efi_device_path *)buf) = END;
1062
1063         return start;
1064 }
1065
1066 /**
1067  * efi_dp_split_file_path() - split of relative file path from device path
1068  *
1069  * Given a device path indicating a file on a device, separate the device
1070  * path in two: the device path of the actual device and the file path
1071  * relative to this device.
1072  *
1073  * @full_path:          device path including device and file path
1074  * @device_path:        path of the device
1075  * @file_path:          relative path of the file or NULL if there is none
1076  * Return:              status code
1077  */
1078 efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
1079                                     struct efi_device_path **device_path,
1080                                     struct efi_device_path **file_path)
1081 {
1082         struct efi_device_path *p, *dp, *fp = NULL;
1083
1084         *device_path = NULL;
1085         *file_path = NULL;
1086         dp = efi_dp_dup(full_path);
1087         if (!dp)
1088                 return EFI_OUT_OF_RESOURCES;
1089         p = dp;
1090         while (!EFI_DP_TYPE(p, MEDIA_DEVICE, FILE_PATH)) {
1091                 p = efi_dp_next(p);
1092                 if (!p)
1093                         goto out;
1094         }
1095         fp = efi_dp_dup(p);
1096         if (!fp)
1097                 return EFI_OUT_OF_RESOURCES;
1098         p->type = DEVICE_PATH_TYPE_END;
1099         p->sub_type = DEVICE_PATH_SUB_TYPE_END;
1100         p->length = sizeof(*p);
1101
1102 out:
1103         *device_path = dp;
1104         *file_path = fp;
1105         return EFI_SUCCESS;
1106 }
1107
1108 /**
1109  * efi_dp_from_name() - convert U-Boot device and file path to device path
1110  *
1111  * @dev:        U-Boot device, e.g. 'mmc'
1112  * @devnr:      U-Boot device number, e.g. 1 for 'mmc:1'
1113  * @path:       file path relative to U-Boot device, may be NULL
1114  * @device:     pointer to receive device path of the device
1115  * @file:       pointer to receive device path for the file
1116  * Return:      status code
1117  */
1118 efi_status_t efi_dp_from_name(const char *dev, const char *devnr,
1119                               const char *path,
1120                               struct efi_device_path **device,
1121                               struct efi_device_path **file)
1122 {
1123         struct blk_desc *desc = NULL;
1124         struct disk_partition fs_partition;
1125         int part = 0;
1126         char *filename;
1127         char *s;
1128
1129         if (path && !file)
1130                 return EFI_INVALID_PARAMETER;
1131
1132         if (!strcmp(dev, "Net")) {
1133 #ifdef CONFIG_NET
1134                 if (device)
1135                         *device = efi_dp_from_eth();
1136 #endif
1137         } else if (!strcmp(dev, "Uart")) {
1138                 if (device)
1139                         *device = efi_dp_from_uart();
1140         } else {
1141                 part = blk_get_device_part_str(dev, devnr, &desc, &fs_partition,
1142                                                1);
1143                 if (part < 0 || !desc)
1144                         return EFI_INVALID_PARAMETER;
1145
1146                 if (device)
1147                         *device = efi_dp_from_part(desc, part);
1148         }
1149
1150         if (!path)
1151                 return EFI_SUCCESS;
1152
1153         filename = calloc(1, strlen(path) + 1);
1154         if (!filename)
1155                 return EFI_OUT_OF_RESOURCES;
1156
1157         sprintf(filename, "%s", path);
1158         /* DOS style file path: */
1159         s = filename;
1160         while ((s = strchr(s, '/')))
1161                 *s++ = '\\';
1162         *file = efi_dp_from_file(desc, part, filename);
1163         free(filename);
1164
1165         if (!*file)
1166                 return EFI_INVALID_PARAMETER;
1167
1168         return EFI_SUCCESS;
1169 }
1170
1171 /**
1172  * efi_dp_check_length() - check length of a device path
1173  *
1174  * @dp:         pointer to device path
1175  * @maxlen:     maximum length of the device path
1176  * Return:
1177  * * length of the device path if it is less or equal @maxlen
1178  * * -1 if the device path is longer then @maxlen
1179  * * -1 if a device path node has a length of less than 4
1180  * * -EINVAL if maxlen exceeds SSIZE_MAX
1181  */
1182 ssize_t efi_dp_check_length(const struct efi_device_path *dp,
1183                             const size_t maxlen)
1184 {
1185         ssize_t ret = 0;
1186         u16 len;
1187
1188         if (maxlen > SSIZE_MAX)
1189                 return -EINVAL;
1190         for (;;) {
1191                 len = dp->length;
1192                 if (len < 4)
1193                         return -1;
1194                 ret += len;
1195                 if (ret > maxlen)
1196                         return -1;
1197                 if (dp->type == DEVICE_PATH_TYPE_END &&
1198                     dp->sub_type == DEVICE_PATH_SUB_TYPE_END)
1199                         return ret;
1200                 dp = (const struct efi_device_path *)((const u8 *)dp + len);
1201         }
1202 }
1203
1204 /**
1205  * efi_dp_from_lo() - Get the instance of a VenMedia node in a
1206  *                    multi-instance device path that matches
1207  *                    a specific GUID. This kind of device paths
1208  *                    is found in Boot#### options describing an
1209  *                    initrd location
1210  *
1211  * @lo:         EFI_LOAD_OPTION containing a valid device path
1212  * @guid:       guid to search for
1213  *
1214  * Return:
1215  * device path including the VenMedia node or NULL.
1216  * Caller must free the returned value.
1217  */
1218 struct
1219 efi_device_path *efi_dp_from_lo(struct efi_load_option *lo,
1220                                 const efi_guid_t *guid)
1221 {
1222         struct efi_device_path *fp = lo->file_path;
1223         struct efi_device_path_vendor *vendor;
1224         int lo_len = lo->file_path_length;
1225
1226         for (; lo_len >=  sizeof(struct efi_device_path);
1227              lo_len -= fp->length, fp = (void *)fp + fp->length) {
1228                 if (lo_len < 0 || efi_dp_check_length(fp, lo_len) < 0)
1229                         break;
1230                 if (fp->type != DEVICE_PATH_TYPE_MEDIA_DEVICE ||
1231                     fp->sub_type != DEVICE_PATH_SUB_TYPE_VENDOR_PATH)
1232                         continue;
1233
1234                 vendor = (struct efi_device_path_vendor *)fp;
1235                 if (!guidcmp(&vendor->guid, guid))
1236                         return efi_dp_dup(efi_dp_next(fp));
1237         }
1238         log_debug("VenMedia(%pUl) not found in %ls\n", &guid, lo->label);
1239
1240         return NULL;
1241 }