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
)
237 if (!dp
|| dp
->type
== DEVICE_PATH_TYPE_END
)
241 dp
= efi_dp_next(dp
);
247 struct efi_device_path
*efi_dp_dup(const struct efi_device_path
*dp
)
249 struct efi_device_path
*ndp
;
250 unsigned sz
= efi_dp_size(dp
) + sizeof(END
);
263 struct efi_device_path
*efi_dp_append(const struct efi_device_path
*dp1
,
264 const struct efi_device_path
*dp2
)
266 struct efi_device_path
*ret
;
269 /* return an end node */
270 ret
= efi_dp_dup(&END
);
272 ret
= efi_dp_dup(dp2
);
274 ret
= efi_dp_dup(dp1
);
276 /* both dp1 and dp2 are non-null */
277 unsigned sz1
= efi_dp_size(dp1
);
278 unsigned sz2
= efi_dp_size(dp2
);
279 void *p
= dp_alloc(sz1
+ sz2
+ sizeof(END
));
283 /* the end node of the second device path has to be retained */
284 memcpy(p
+ sz1
, dp2
, sz2
+ sizeof(END
));
291 struct efi_device_path
*efi_dp_append_node(const struct efi_device_path
*dp
,
292 const struct efi_device_path
*node
)
294 struct efi_device_path
*ret
;
297 ret
= efi_dp_dup(&END
);
299 ret
= efi_dp_dup(dp
);
301 unsigned sz
= node
->length
;
302 void *p
= dp_alloc(sz
+ sizeof(END
));
306 memcpy(p
+ sz
, &END
, sizeof(END
));
309 /* both dp and node are non-null */
310 unsigned sz
= efi_dp_size(dp
);
311 void *p
= dp_alloc(sz
+ node
->length
+ sizeof(END
));
315 memcpy(p
+ sz
, node
, node
->length
);
316 memcpy(p
+ sz
+ node
->length
, &END
, sizeof(END
));
323 struct efi_device_path
*efi_dp_create_device_node(const u8 type
,
327 struct efi_device_path
*ret
;
329 ret
= dp_alloc(length
);
333 ret
->sub_type
= sub_type
;
334 ret
->length
= length
;
339 /* size of device-path not including END node for device and all parents
340 * up to the root device.
342 static unsigned dp_size(struct udevice
*dev
)
344 if (!dev
|| !dev
->driver
)
347 switch (dev
->driver
->id
) {
349 case UCLASS_SIMPLE_BUS
:
350 /* stop traversing parents at this point: */
353 return dp_size(dev
->parent
) +
354 sizeof(struct efi_device_path_mac_addr
);
357 switch (dev
->parent
->uclass
->uc_drv
->id
) {
360 return dp_size(dev
->parent
) +
361 sizeof(struct efi_device_path_atapi
);
363 #if defined(CONFIG_SCSI) && defined(CONFIG_DM_SCSI)
365 return dp_size(dev
->parent
) +
366 sizeof(struct efi_device_path_scsi
);
368 #if defined(CONFIG_DM_MMC) && defined(CONFIG_MMC)
370 return dp_size(dev
->parent
) +
371 sizeof(struct efi_device_path_sd_mmc_path
);
374 return dp_size(dev
->parent
);
377 #if defined(CONFIG_DM_MMC) && defined(CONFIG_MMC)
379 return dp_size(dev
->parent
) +
380 sizeof(struct efi_device_path_sd_mmc_path
);
382 case UCLASS_MASS_STORAGE
:
384 return dp_size(dev
->parent
) +
385 sizeof(struct efi_device_path_usb_class
);
387 /* just skip over unknown classes: */
388 return dp_size(dev
->parent
);
393 * Recursively build a device path.
395 * @buf pointer to the end of the device path
397 * @return pointer to the end of the device path
399 static void *dp_fill(void *buf
, struct udevice
*dev
)
401 if (!dev
|| !dev
->driver
)
404 switch (dev
->driver
->id
) {
406 case UCLASS_SIMPLE_BUS
: {
407 /* stop traversing parents at this point: */
408 struct efi_device_path_vendor
*vdp
= buf
;
414 struct efi_device_path_mac_addr
*dp
=
415 dp_fill(buf
, dev
->parent
);
416 struct eth_pdata
*pdata
= dev
->platdata
;
418 dp
->dp
.type
= DEVICE_PATH_TYPE_MESSAGING_DEVICE
;
419 dp
->dp
.sub_type
= DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR
;
420 dp
->dp
.length
= sizeof(*dp
);
421 memset(&dp
->mac
, 0, sizeof(dp
->mac
));
422 /* We only support IPv4 */
423 memcpy(&dp
->mac
, &pdata
->enetaddr
, ARP_HLEN
);
431 switch (dev
->parent
->uclass
->uc_drv
->id
) {
434 struct efi_device_path_atapi
*dp
=
435 dp_fill(buf
, dev
->parent
);
436 struct blk_desc
*desc
= dev_get_uclass_platdata(dev
);
438 dp
->dp
.type
= DEVICE_PATH_TYPE_MESSAGING_DEVICE
;
439 dp
->dp
.sub_type
= DEVICE_PATH_SUB_TYPE_MSG_ATAPI
;
440 dp
->dp
.length
= sizeof(*dp
);
441 dp
->logical_unit_number
= desc
->devnum
;
442 dp
->primary_secondary
= IDE_BUS(desc
->devnum
);
443 dp
->slave_master
= desc
->devnum
%
444 (CONFIG_SYS_IDE_MAXDEVICE
/
445 CONFIG_SYS_IDE_MAXBUS
);
449 #if defined(CONFIG_SCSI) && defined(CONFIG_DM_SCSI)
451 struct efi_device_path_scsi
*dp
=
452 dp_fill(buf
, dev
->parent
);
453 struct blk_desc
*desc
= dev_get_uclass_platdata(dev
);
455 dp
->dp
.type
= DEVICE_PATH_TYPE_MESSAGING_DEVICE
;
456 dp
->dp
.sub_type
= DEVICE_PATH_SUB_TYPE_MSG_SCSI
;
457 dp
->dp
.length
= sizeof(*dp
);
458 dp
->logical_unit_number
= desc
->lun
;
459 dp
->target_id
= desc
->target
;
463 #if defined(CONFIG_DM_MMC) && defined(CONFIG_MMC)
465 struct efi_device_path_sd_mmc_path
*sddp
=
466 dp_fill(buf
, dev
->parent
);
467 struct blk_desc
*desc
= dev_get_uclass_platdata(dev
);
469 sddp
->dp
.type
= DEVICE_PATH_TYPE_MESSAGING_DEVICE
;
470 sddp
->dp
.sub_type
= is_sd(desc
) ?
471 DEVICE_PATH_SUB_TYPE_MSG_SD
:
472 DEVICE_PATH_SUB_TYPE_MSG_MMC
;
473 sddp
->dp
.length
= sizeof(*sddp
);
474 sddp
->slot_number
= dev
->seq
;
479 debug("%s(%u) %s: unhandled parent class: %s (%u)\n",
480 __FILE__
, __LINE__
, __func__
,
481 dev
->name
, dev
->parent
->uclass
->uc_drv
->id
);
482 return dp_fill(buf
, dev
->parent
);
485 #if defined(CONFIG_DM_MMC) && defined(CONFIG_MMC)
487 struct efi_device_path_sd_mmc_path
*sddp
=
488 dp_fill(buf
, dev
->parent
);
489 struct mmc
*mmc
= mmc_get_mmc_dev(dev
);
490 struct blk_desc
*desc
= mmc_get_blk_desc(mmc
);
492 sddp
->dp
.type
= DEVICE_PATH_TYPE_MESSAGING_DEVICE
;
493 sddp
->dp
.sub_type
= is_sd(desc
) ?
494 DEVICE_PATH_SUB_TYPE_MSG_SD
:
495 DEVICE_PATH_SUB_TYPE_MSG_MMC
;
496 sddp
->dp
.length
= sizeof(*sddp
);
497 sddp
->slot_number
= dev
->seq
;
502 case UCLASS_MASS_STORAGE
:
503 case UCLASS_USB_HUB
: {
504 struct efi_device_path_usb_class
*udp
=
505 dp_fill(buf
, dev
->parent
);
506 struct usb_device
*udev
= dev_get_parent_priv(dev
);
507 struct usb_device_descriptor
*desc
= &udev
->descriptor
;
509 udp
->dp
.type
= DEVICE_PATH_TYPE_MESSAGING_DEVICE
;
510 udp
->dp
.sub_type
= DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS
;
511 udp
->dp
.length
= sizeof(*udp
);
512 udp
->vendor_id
= desc
->idVendor
;
513 udp
->product_id
= desc
->idProduct
;
514 udp
->device_class
= desc
->bDeviceClass
;
515 udp
->device_subclass
= desc
->bDeviceSubClass
;
516 udp
->device_protocol
= desc
->bDeviceProtocol
;
521 debug("%s(%u) %s: unhandled device class: %s (%u)\n",
522 __FILE__
, __LINE__
, __func__
,
523 dev
->name
, dev
->driver
->id
);
524 return dp_fill(buf
, dev
->parent
);
528 /* Construct a device-path from a device: */
529 struct efi_device_path
*efi_dp_from_dev(struct udevice
*dev
)
533 start
= buf
= dp_alloc(dp_size(dev
) + sizeof(END
));
536 buf
= dp_fill(buf
, dev
);
537 *((struct efi_device_path
*)buf
) = END
;
543 static unsigned dp_part_size(struct blk_desc
*desc
, int part
)
550 int ret
= blk_find_device(desc
->if_type
, desc
->devnum
, &dev
);
553 dev
= desc
->bdev
->parent
;
554 dpsize
= dp_size(dev
);
557 dpsize
= sizeof(ROOT
) + sizeof(struct efi_device_path_usb
);
560 if (part
== 0) /* the actual disk, not a partition */
563 if (desc
->part_type
== PART_TYPE_ISO
)
564 dpsize
+= sizeof(struct efi_device_path_cdrom_path
);
566 dpsize
+= sizeof(struct efi_device_path_hard_drive_path
);
572 * Create a device node for a block device partition.
574 * @buf buffer to which the device path is wirtten
575 * @desc block device descriptor
576 * @part partition number, 0 identifies a block device
578 static void *dp_part_node(void *buf
, struct blk_desc
*desc
, int part
)
580 disk_partition_t info
;
582 part_get_info(desc
, part
, &info
);
584 if (desc
->part_type
== PART_TYPE_ISO
) {
585 struct efi_device_path_cdrom_path
*cddp
= buf
;
587 cddp
->boot_entry
= part
;
588 cddp
->dp
.type
= DEVICE_PATH_TYPE_MEDIA_DEVICE
;
589 cddp
->dp
.sub_type
= DEVICE_PATH_SUB_TYPE_CDROM_PATH
;
590 cddp
->dp
.length
= sizeof(*cddp
);
591 cddp
->partition_start
= info
.start
;
592 cddp
->partition_end
= info
.size
;
596 struct efi_device_path_hard_drive_path
*hddp
= buf
;
598 hddp
->dp
.type
= DEVICE_PATH_TYPE_MEDIA_DEVICE
;
599 hddp
->dp
.sub_type
= DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH
;
600 hddp
->dp
.length
= sizeof(*hddp
);
601 hddp
->partition_number
= part
;
602 hddp
->partition_start
= info
.start
;
603 hddp
->partition_end
= info
.size
;
604 if (desc
->part_type
== PART_TYPE_EFI
)
605 hddp
->partmap_type
= 2;
607 hddp
->partmap_type
= 1;
609 switch (desc
->sig_type
) {
612 hddp
->signature_type
= 0;
613 memset(hddp
->partition_signature
, 0,
614 sizeof(hddp
->partition_signature
));
617 hddp
->signature_type
= 1;
618 memset(hddp
->partition_signature
, 0,
619 sizeof(hddp
->partition_signature
));
620 memcpy(hddp
->partition_signature
, &desc
->mbr_sig
,
621 sizeof(desc
->mbr_sig
));
624 hddp
->signature_type
= 2;
625 memcpy(hddp
->partition_signature
, &desc
->guid_sig
,
626 sizeof(hddp
->partition_signature
));
637 * Create a device path for a block device or one of its partitions.
639 * @buf buffer to which the device path is wirtten
640 * @desc block device descriptor
641 * @part partition number, 0 identifies a block device
643 static void *dp_part_fill(void *buf
, struct blk_desc
*desc
, int part
)
648 int ret
= blk_find_device(desc
->if_type
, desc
->devnum
, &dev
);
651 dev
= desc
->bdev
->parent
;
652 buf
= dp_fill(buf
, dev
);
656 * We *could* make a more accurate path, by looking at if_type
657 * and handling all the different cases like we do for non-
658 * legacy (ie CONFIG_BLK=y) case. But most important thing
659 * is just to have a unique device-path for if_type+devnum.
660 * So map things to a fictitious USB device.
662 struct efi_device_path_usb
*udp
;
664 memcpy(buf
, &ROOT
, sizeof(ROOT
));
668 udp
->dp
.type
= DEVICE_PATH_TYPE_MESSAGING_DEVICE
;
669 udp
->dp
.sub_type
= DEVICE_PATH_SUB_TYPE_MSG_USB
;
670 udp
->dp
.length
= sizeof(*udp
);
671 udp
->parent_port_number
= desc
->if_type
;
672 udp
->usb_interface
= desc
->devnum
;
676 if (part
== 0) /* the actual disk, not a partition */
679 return dp_part_node(buf
, desc
, part
);
682 /* Construct a device-path from a partition on a blk device: */
683 struct efi_device_path
*efi_dp_from_part(struct blk_desc
*desc
, int part
)
687 start
= buf
= dp_alloc(dp_part_size(desc
, part
) + sizeof(END
));
691 buf
= dp_part_fill(buf
, desc
, part
);
693 *((struct efi_device_path
*)buf
) = END
;
699 * Create a device node for a block device partition.
701 * @buf buffer to which the device path is wirtten
702 * @desc block device descriptor
703 * @part partition number, 0 identifies a block device
705 struct efi_device_path
*efi_dp_part_node(struct blk_desc
*desc
, int part
)
710 if (desc
->part_type
== PART_TYPE_ISO
)
711 dpsize
= sizeof(struct efi_device_path_cdrom_path
);
713 dpsize
= sizeof(struct efi_device_path_hard_drive_path
);
714 buf
= dp_alloc(dpsize
);
716 dp_part_node(buf
, desc
, part
);
721 /* convert path to an UEFI style path (ie. DOS style backslashes and utf16) */
722 static void path_to_uefi(u16
*uefi
, const char *path
)
734 * If desc is NULL, this creates a path with only the file component,
735 * otherwise it creates a full path with both device and file components
737 struct efi_device_path
*efi_dp_from_file(struct blk_desc
*desc
, int part
,
740 struct efi_device_path_file_path
*fp
;
742 unsigned dpsize
= 0, fpsize
;
745 dpsize
= dp_part_size(desc
, part
);
747 fpsize
= sizeof(struct efi_device_path
) + 2 * (strlen(path
) + 1);
750 start
= buf
= dp_alloc(dpsize
+ sizeof(END
));
755 buf
= dp_part_fill(buf
, desc
, part
);
759 fp
->dp
.type
= DEVICE_PATH_TYPE_MEDIA_DEVICE
;
760 fp
->dp
.sub_type
= DEVICE_PATH_SUB_TYPE_FILE_PATH
;
761 fp
->dp
.length
= fpsize
;
762 path_to_uefi(fp
->str
, path
);
765 *((struct efi_device_path
*)buf
) = END
;
771 struct efi_device_path
*efi_dp_from_eth(void)
773 #ifndef CONFIG_DM_ETH
774 struct efi_device_path_mac_addr
*ndp
;
779 assert(eth_get_dev());
782 dpsize
+= dp_size(eth_get_dev());
784 dpsize
+= sizeof(ROOT
);
785 dpsize
+= sizeof(*ndp
);
788 start
= buf
= dp_alloc(dpsize
+ sizeof(END
));
793 buf
= dp_fill(buf
, eth_get_dev());
795 memcpy(buf
, &ROOT
, sizeof(ROOT
));
799 ndp
->dp
.type
= DEVICE_PATH_TYPE_MESSAGING_DEVICE
;
800 ndp
->dp
.sub_type
= DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR
;
801 ndp
->dp
.length
= sizeof(*ndp
);
802 ndp
->if_type
= 1; /* Ethernet */
803 memcpy(ndp
->mac
.addr
, eth_get_ethaddr(), ARP_HLEN
);
807 *((struct efi_device_path
*)buf
) = END
;
813 /* Construct a device-path for memory-mapped image */
814 struct efi_device_path
*efi_dp_from_mem(uint32_t memory_type
,
815 uint64_t start_address
,
816 uint64_t end_address
)
818 struct efi_device_path_memory
*mdp
;
821 start
= buf
= dp_alloc(sizeof(*mdp
) + sizeof(END
));
826 mdp
->dp
.type
= DEVICE_PATH_TYPE_HARDWARE_DEVICE
;
827 mdp
->dp
.sub_type
= DEVICE_PATH_SUB_TYPE_MEMORY
;
828 mdp
->dp
.length
= sizeof(*mdp
);
829 mdp
->memory_type
= memory_type
;
830 mdp
->start_address
= start_address
;
831 mdp
->end_address
= end_address
;
834 *((struct efi_device_path
*)buf
) = END
;
840 * Helper to split a full device path (containing both device and file
841 * parts) into it's constituent parts.
843 efi_status_t
efi_dp_split_file_path(struct efi_device_path
*full_path
,
844 struct efi_device_path
**device_path
,
845 struct efi_device_path
**file_path
)
847 struct efi_device_path
*p
, *dp
, *fp
;
851 dp
= efi_dp_dup(full_path
);
853 return EFI_OUT_OF_RESOURCES
;
855 while (!EFI_DP_TYPE(p
, MEDIA_DEVICE
, FILE_PATH
)) {
858 return EFI_OUT_OF_RESOURCES
;
862 return EFI_OUT_OF_RESOURCES
;
863 p
->type
= DEVICE_PATH_TYPE_END
;
864 p
->sub_type
= DEVICE_PATH_SUB_TYPE_END
;
865 p
->length
= sizeof(*p
);