2 * EFI device path from u-boot device-model mapping
4 * (C) Copyright 2017 Rob Clark
6 * SPDX-License-Identifier: GPL-2.0+
9 #define LOG_CATEGORY LOGL_ERR
16 #include <efi_loader.h>
20 /* template END node: */
21 static const struct efi_device_path END = {
22 .type = DEVICE_PATH_TYPE_END,
23 .sub_type = DEVICE_PATH_SUB_TYPE_END,
24 .length = sizeof(END),
28 EFI_GUID(0xe61d73b9, 0xa384, 0x4acc, \
29 0xae, 0xab, 0x82, 0xe8, 0x28, 0xf3, 0x62, 0x8b)
31 /* template ROOT node: */
32 static const struct efi_device_path_vendor ROOT = {
34 .type = DEVICE_PATH_TYPE_HARDWARE_DEVICE,
35 .sub_type = DEVICE_PATH_SUB_TYPE_VENDOR,
36 .length = sizeof(ROOT),
41 #if defined(CONFIG_DM_MMC) && defined(CONFIG_MMC)
43 * Determine if an MMC device is an SD card.
45 * @desc block device descriptor
46 * @return true if the device is an SD card
48 static bool is_sd(struct blk_desc *desc)
50 struct mmc *mmc = find_mmc_device(desc->devnum);
55 return IS_SD(mmc) != 0U;
59 static void *dp_alloc(size_t sz)
63 if (efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, sz, &buf) !=
65 debug("EFI: ERROR: out of memory in %s\n", __func__);
74 * Iterate to next block in device-path, terminating (returning NULL)
77 struct efi_device_path *efi_dp_next(const struct efi_device_path *dp)
81 if (dp->type == DEVICE_PATH_TYPE_END)
83 dp = ((void *)dp) + dp->length;
84 if (dp->type == DEVICE_PATH_TYPE_END)
86 return (struct efi_device_path *)dp;
90 * Compare two device-paths, stopping when the shorter of the two hits
91 * an End* node. This is useful to, for example, compare a device-path
92 * representing a device with one representing a file on the device, or
93 * a device with a parent device.
95 int efi_dp_match(const struct efi_device_path *a,
96 const struct efi_device_path *b)
101 ret = memcmp(&a->length, &b->length, sizeof(a->length));
105 ret = memcmp(a, b, a->length);
118 * See UEFI spec (section 3.1.2, about short-form device-paths..
119 * tl;dr: we can have a device-path that starts with a USB WWID
120 * or USB Class node, and a few other cases which don't encode
121 * the full device path with bus hierarchy:
123 * - MESSAGING:USB_WWID
124 * - MESSAGING:USB_CLASS
129 static struct efi_device_path *shorten_path(struct efi_device_path *dp)
133 * TODO: Add MESSAGING:USB_WWID and MESSAGING:URI..
134 * in practice fallback.efi just uses MEDIA:HARD_DRIVE
135 * so not sure when we would see these other cases.
137 if (EFI_DP_TYPE(dp, MESSAGING_DEVICE, MSG_USB_CLASS) ||
138 EFI_DP_TYPE(dp, MEDIA_DEVICE, HARD_DRIVE_PATH) ||
139 EFI_DP_TYPE(dp, MEDIA_DEVICE, FILE_PATH))
142 dp = efi_dp_next(dp);
148 static struct efi_object *find_obj(struct efi_device_path *dp, bool short_path,
149 struct efi_device_path **rem)
151 struct efi_object *efiobj;
152 unsigned int dp_size = efi_dp_size(dp);
154 list_for_each_entry(efiobj, &efi_obj_list, link) {
155 struct efi_handler *handler;
156 struct efi_device_path *obj_dp;
159 ret = efi_search_protocol(efiobj->handle,
160 &efi_guid_device_path, &handler);
161 if (ret != EFI_SUCCESS)
163 obj_dp = handler->protocol_interface;
166 if (efi_dp_match(dp, obj_dp) == 0) {
169 * Allow partial matches, but inform
172 *rem = ((void *)dp) +
176 /* Only return on exact matches */
177 if (efi_dp_size(obj_dp) == dp_size)
182 obj_dp = shorten_path(efi_dp_next(obj_dp));
183 } while (short_path && obj_dp);
190 * Find an efiobj from device-path, if 'rem' is not NULL, returns the
191 * remaining part of the device path after the matched object.
193 struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
194 struct efi_device_path **rem)
196 struct efi_object *efiobj;
198 /* Search for an exact match first */
199 efiobj = find_obj(dp, false, NULL);
201 /* Then for a fuzzy match */
203 efiobj = find_obj(dp, false, rem);
205 /* And now for a fuzzy short match */
207 efiobj = find_obj(dp, true, rem);
213 * Determine the last device path node that is not the end node.
216 * @return last node before the end node if it exists
219 const struct efi_device_path *efi_dp_last_node(const struct efi_device_path *dp)
221 struct efi_device_path *ret;
223 if (!dp || dp->type == DEVICE_PATH_TYPE_END)
226 ret = (struct efi_device_path *)dp;
227 dp = efi_dp_next(dp);
232 /* return size not including End node: */
233 unsigned efi_dp_size(const struct efi_device_path *dp)
239 dp = efi_dp_next(dp);
245 struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp)
247 struct efi_device_path *ndp;
248 unsigned sz = efi_dp_size(dp) + sizeof(END);
261 struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
262 const struct efi_device_path *dp2)
264 struct efi_device_path *ret;
267 ret = efi_dp_dup(dp2);
269 ret = efi_dp_dup(dp1);
271 /* both dp1 and dp2 are non-null */
272 unsigned sz1 = efi_dp_size(dp1);
273 unsigned sz2 = efi_dp_size(dp2);
274 void *p = dp_alloc(sz1 + sz2 + sizeof(END));
278 memcpy(p + sz1, dp2, sz2);
279 memcpy(p + sz1 + sz2, &END, sizeof(END));
286 struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
287 const struct efi_device_path *node)
289 struct efi_device_path *ret;
292 ret = efi_dp_dup(&END);
294 ret = efi_dp_dup(dp);
296 unsigned sz = node->length;
297 void *p = dp_alloc(sz + sizeof(END));
301 memcpy(p + sz, &END, sizeof(END));
304 /* both dp and node are non-null */
305 unsigned sz = efi_dp_size(dp);
306 void *p = dp_alloc(sz + node->length + sizeof(END));
310 memcpy(p + sz, node, node->length);
311 memcpy(p + sz + node->length, &END, sizeof(END));
319 /* size of device-path not including END node for device and all parents
320 * up to the root device.
322 static unsigned dp_size(struct udevice *dev)
324 if (!dev || !dev->driver)
327 switch (dev->driver->id) {
329 case UCLASS_SIMPLE_BUS:
330 /* stop traversing parents at this point: */
333 return dp_size(dev->parent) +
334 sizeof(struct efi_device_path_mac_addr);
337 switch (dev->parent->uclass->uc_drv->id) {
340 return dp_size(dev->parent) +
341 sizeof(struct efi_device_path_atapi);
343 #if defined(CONFIG_SCSI) && defined(CONFIG_DM_SCSI)
345 return dp_size(dev->parent) +
346 sizeof(struct efi_device_path_scsi);
348 #if defined(CONFIG_DM_MMC) && defined(CONFIG_MMC)
350 return dp_size(dev->parent) +
351 sizeof(struct efi_device_path_sd_mmc_path);
354 return dp_size(dev->parent);
357 #if defined(CONFIG_DM_MMC) && defined(CONFIG_MMC)
359 return dp_size(dev->parent) +
360 sizeof(struct efi_device_path_sd_mmc_path);
362 case UCLASS_MASS_STORAGE:
364 return dp_size(dev->parent) +
365 sizeof(struct efi_device_path_usb_class);
367 /* just skip over unknown classes: */
368 return dp_size(dev->parent);
373 * Recursively build a device path.
375 * @buf pointer to the end of the device path
377 * @return pointer to the end of the device path
379 static void *dp_fill(void *buf, struct udevice *dev)
381 if (!dev || !dev->driver)
384 switch (dev->driver->id) {
386 case UCLASS_SIMPLE_BUS: {
387 /* stop traversing parents at this point: */
388 struct efi_device_path_vendor *vdp = buf;
394 struct efi_device_path_mac_addr *dp =
395 dp_fill(buf, dev->parent);
396 struct eth_pdata *pdata = dev->platdata;
398 dp->dp.type = DEVICE_PATH_TYPE_MESSAGING_DEVICE;
399 dp->dp.sub_type = DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR;
400 dp->dp.length = sizeof(*dp);
401 memset(&dp->mac, 0, sizeof(dp->mac));
402 /* We only support IPv4 */
403 memcpy(&dp->mac, &pdata->enetaddr, ARP_HLEN);
411 switch (dev->parent->uclass->uc_drv->id) {
414 struct efi_device_path_atapi *dp =
415 dp_fill(buf, dev->parent);
416 struct blk_desc *desc = dev_get_uclass_platdata(dev);
418 dp->dp.type = DEVICE_PATH_TYPE_MESSAGING_DEVICE;
419 dp->dp.sub_type = DEVICE_PATH_SUB_TYPE_MSG_ATAPI;
420 dp->dp.length = sizeof(*dp);
421 dp->logical_unit_number = desc->devnum;
422 dp->primary_secondary = IDE_BUS(desc->devnum);
423 dp->slave_master = desc->devnum %
424 (CONFIG_SYS_IDE_MAXDEVICE /
425 CONFIG_SYS_IDE_MAXBUS);
429 #if defined(CONFIG_SCSI) && defined(CONFIG_DM_SCSI)
431 struct efi_device_path_scsi *dp =
432 dp_fill(buf, dev->parent);
433 struct blk_desc *desc = dev_get_uclass_platdata(dev);
435 dp->dp.type = DEVICE_PATH_TYPE_MESSAGING_DEVICE;
436 dp->dp.sub_type = DEVICE_PATH_SUB_TYPE_MSG_SCSI;
437 dp->dp.length = sizeof(*dp);
438 dp->logical_unit_number = desc->lun;
439 dp->target_id = desc->target;
443 #if defined(CONFIG_DM_MMC) && defined(CONFIG_MMC)
445 struct efi_device_path_sd_mmc_path *sddp =
446 dp_fill(buf, dev->parent);
447 struct blk_desc *desc = dev_get_uclass_platdata(dev);
449 sddp->dp.type = DEVICE_PATH_TYPE_MESSAGING_DEVICE;
450 sddp->dp.sub_type = is_sd(desc) ?
451 DEVICE_PATH_SUB_TYPE_MSG_SD :
452 DEVICE_PATH_SUB_TYPE_MSG_MMC;
453 sddp->dp.length = sizeof(*sddp);
454 sddp->slot_number = dev->seq;
459 debug("%s(%u) %s: unhandled parent class: %s (%u)\n",
460 __FILE__, __LINE__, __func__,
461 dev->name, dev->parent->uclass->uc_drv->id);
462 return dp_fill(buf, dev->parent);
465 #if defined(CONFIG_DM_MMC) && defined(CONFIG_MMC)
467 struct efi_device_path_sd_mmc_path *sddp =
468 dp_fill(buf, dev->parent);
469 struct mmc *mmc = mmc_get_mmc_dev(dev);
470 struct blk_desc *desc = mmc_get_blk_desc(mmc);
472 sddp->dp.type = DEVICE_PATH_TYPE_MESSAGING_DEVICE;
473 sddp->dp.sub_type = is_sd(desc) ?
474 DEVICE_PATH_SUB_TYPE_MSG_SD :
475 DEVICE_PATH_SUB_TYPE_MSG_MMC;
476 sddp->dp.length = sizeof(*sddp);
477 sddp->slot_number = dev->seq;
482 case UCLASS_MASS_STORAGE:
483 case UCLASS_USB_HUB: {
484 struct efi_device_path_usb_class *udp =
485 dp_fill(buf, dev->parent);
486 struct usb_device *udev = dev_get_parent_priv(dev);
487 struct usb_device_descriptor *desc = &udev->descriptor;
489 udp->dp.type = DEVICE_PATH_TYPE_MESSAGING_DEVICE;
490 udp->dp.sub_type = DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS;
491 udp->dp.length = sizeof(*udp);
492 udp->vendor_id = desc->idVendor;
493 udp->product_id = desc->idProduct;
494 udp->device_class = desc->bDeviceClass;
495 udp->device_subclass = desc->bDeviceSubClass;
496 udp->device_protocol = desc->bDeviceProtocol;
501 debug("%s(%u) %s: unhandled device class: %s (%u)\n",
502 __FILE__, __LINE__, __func__,
503 dev->name, dev->driver->id);
504 return dp_fill(buf, dev->parent);
508 /* Construct a device-path from a device: */
509 struct efi_device_path *efi_dp_from_dev(struct udevice *dev)
513 start = buf = dp_alloc(dp_size(dev) + sizeof(END));
516 buf = dp_fill(buf, dev);
517 *((struct efi_device_path *)buf) = END;
523 static unsigned dp_part_size(struct blk_desc *desc, int part)
530 int ret = blk_find_device(desc->if_type, desc->devnum, &dev);
533 dev = desc->bdev->parent;
534 dpsize = dp_size(dev);
537 dpsize = sizeof(ROOT) + sizeof(struct efi_device_path_usb);
540 if (part == 0) /* the actual disk, not a partition */
543 if (desc->part_type == PART_TYPE_ISO)
544 dpsize += sizeof(struct efi_device_path_cdrom_path);
546 dpsize += sizeof(struct efi_device_path_hard_drive_path);
552 * Create a device node for a block device partition.
554 * @buf buffer to which the device path is wirtten
555 * @desc block device descriptor
556 * @part partition number, 0 identifies a block device
558 static void *dp_part_node(void *buf, struct blk_desc *desc, int part)
560 disk_partition_t info;
562 part_get_info(desc, part, &info);
564 if (desc->part_type == PART_TYPE_ISO) {
565 struct efi_device_path_cdrom_path *cddp = buf;
567 cddp->boot_entry = part;
568 cddp->dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE;
569 cddp->dp.sub_type = DEVICE_PATH_SUB_TYPE_CDROM_PATH;
570 cddp->dp.length = sizeof(*cddp);
571 cddp->partition_start = info.start;
572 cddp->partition_end = info.size;
576 struct efi_device_path_hard_drive_path *hddp = buf;
578 hddp->dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE;
579 hddp->dp.sub_type = DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH;
580 hddp->dp.length = sizeof(*hddp);
581 hddp->partition_number = part;
582 hddp->partition_start = info.start;
583 hddp->partition_end = info.size;
584 if (desc->part_type == PART_TYPE_EFI)
585 hddp->partmap_type = 2;
587 hddp->partmap_type = 1;
589 switch (desc->sig_type) {
592 hddp->signature_type = 0;
593 memset(hddp->partition_signature, 0,
594 sizeof(hddp->partition_signature));
597 hddp->signature_type = 1;
598 memset(hddp->partition_signature, 0,
599 sizeof(hddp->partition_signature));
600 memcpy(hddp->partition_signature, &desc->mbr_sig,
601 sizeof(desc->mbr_sig));
604 hddp->signature_type = 2;
605 memcpy(hddp->partition_signature, &desc->guid_sig,
606 sizeof(hddp->partition_signature));
617 * Create a device path for a block device or one of its partitions.
619 * @buf buffer to which the device path is wirtten
620 * @desc block device descriptor
621 * @part partition number, 0 identifies a block device
623 static void *dp_part_fill(void *buf, struct blk_desc *desc, int part)
628 int ret = blk_find_device(desc->if_type, desc->devnum, &dev);
631 dev = desc->bdev->parent;
632 buf = dp_fill(buf, dev);
636 * We *could* make a more accurate path, by looking at if_type
637 * and handling all the different cases like we do for non-
638 * legacy (ie CONFIG_BLK=y) case. But most important thing
639 * is just to have a unique device-path for if_type+devnum.
640 * So map things to a fictitious USB device.
642 struct efi_device_path_usb *udp;
644 memcpy(buf, &ROOT, sizeof(ROOT));
648 udp->dp.type = DEVICE_PATH_TYPE_MESSAGING_DEVICE;
649 udp->dp.sub_type = DEVICE_PATH_SUB_TYPE_MSG_USB;
650 udp->dp.length = sizeof(*udp);
651 udp->parent_port_number = desc->if_type;
652 udp->usb_interface = desc->devnum;
656 if (part == 0) /* the actual disk, not a partition */
659 return dp_part_node(buf, desc, part);
662 /* Construct a device-path from a partition on a blk device: */
663 struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part)
667 start = buf = dp_alloc(dp_part_size(desc, part) + sizeof(END));
671 buf = dp_part_fill(buf, desc, part);
673 *((struct efi_device_path *)buf) = END;
679 * Create a device node for a block device partition.
681 * @buf buffer to which the device path is wirtten
682 * @desc block device descriptor
683 * @part partition number, 0 identifies a block device
685 struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part)
690 if (desc->part_type == PART_TYPE_ISO)
691 dpsize = sizeof(struct efi_device_path_cdrom_path);
693 dpsize = sizeof(struct efi_device_path_hard_drive_path);
694 buf = dp_alloc(dpsize);
696 dp_part_node(buf, desc, part);
701 /* convert path to an UEFI style path (ie. DOS style backslashes and utf16) */
702 static void path_to_uefi(u16 *uefi, const char *path)
714 * If desc is NULL, this creates a path with only the file component,
715 * otherwise it creates a full path with both device and file components
717 struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
720 struct efi_device_path_file_path *fp;
722 unsigned dpsize = 0, fpsize;
725 dpsize = dp_part_size(desc, part);
727 fpsize = sizeof(struct efi_device_path) + 2 * (strlen(path) + 1);
730 start = buf = dp_alloc(dpsize + sizeof(END));
735 buf = dp_part_fill(buf, desc, part);
739 fp->dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE;
740 fp->dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH;
741 fp->dp.length = fpsize;
742 path_to_uefi(fp->str, path);
745 *((struct efi_device_path *)buf) = END;
750 #ifdef CONFIG_CMD_NET
751 struct efi_device_path *efi_dp_from_eth(void)
753 #ifndef CONFIG_DM_ETH
754 struct efi_device_path_mac_addr *ndp;
759 assert(eth_get_dev());
762 dpsize += dp_size(eth_get_dev());
764 dpsize += sizeof(ROOT);
765 dpsize += sizeof(*ndp);
768 start = buf = dp_alloc(dpsize + sizeof(END));
773 buf = dp_fill(buf, eth_get_dev());
775 memcpy(buf, &ROOT, sizeof(ROOT));
779 ndp->dp.type = DEVICE_PATH_TYPE_MESSAGING_DEVICE;
780 ndp->dp.sub_type = DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR;
781 ndp->dp.length = sizeof(*ndp);
782 ndp->if_type = 1; /* Ethernet */
783 memcpy(ndp->mac.addr, eth_get_ethaddr(), ARP_HLEN);
787 *((struct efi_device_path *)buf) = END;
793 /* Construct a device-path for memory-mapped image */
794 struct efi_device_path *efi_dp_from_mem(uint32_t memory_type,
795 uint64_t start_address,
796 uint64_t end_address)
798 struct efi_device_path_memory *mdp;
801 start = buf = dp_alloc(sizeof(*mdp) + sizeof(END));
806 mdp->dp.type = DEVICE_PATH_TYPE_HARDWARE_DEVICE;
807 mdp->dp.sub_type = DEVICE_PATH_SUB_TYPE_MEMORY;
808 mdp->dp.length = sizeof(*mdp);
809 mdp->memory_type = memory_type;
810 mdp->start_address = start_address;
811 mdp->end_address = end_address;
814 *((struct efi_device_path *)buf) = END;
820 * Helper to split a full device path (containing both device and file
821 * parts) into it's constituent parts.
823 efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
824 struct efi_device_path **device_path,
825 struct efi_device_path **file_path)
827 struct efi_device_path *p, *dp, *fp;
831 dp = efi_dp_dup(full_path);
833 return EFI_OUT_OF_RESOURCES;
835 while (!EFI_DP_TYPE(p, MEDIA_DEVICE, FILE_PATH)) {
838 return EFI_OUT_OF_RESOURCES;
842 return EFI_OUT_OF_RESOURCES;
843 p->type = DEVICE_PATH_TYPE_END;
844 p->sub_type = DEVICE_PATH_SUB_TYPE_END;
845 p->length = sizeof(*p);