2 * EFI device path from u-boot device-model mapping
4 * (C) Copyright 2017 Rob Clark
6 * SPDX-License-Identifier: GPL-2.0+
14 #include <efi_loader.h>
18 /* template END node: */
19 static const struct efi_device_path END
= {
20 .type
= DEVICE_PATH_TYPE_END
,
21 .sub_type
= DEVICE_PATH_SUB_TYPE_END
,
22 .length
= sizeof(END
),
26 EFI_GUID(0xe61d73b9, 0xa384, 0x4acc, \
27 0xae, 0xab, 0x82, 0xe8, 0x28, 0xf3, 0x62, 0x8b)
29 /* template ROOT node: */
30 static const struct efi_device_path_vendor ROOT
= {
32 .type
= DEVICE_PATH_TYPE_HARDWARE_DEVICE
,
33 .sub_type
= DEVICE_PATH_SUB_TYPE_VENDOR
,
34 .length
= sizeof(ROOT
),
39 #if defined(CONFIG_DM_MMC) && defined(CONFIG_MMC)
41 * Determine if an MMC device is an SD card.
43 * @desc block device descriptor
44 * @return true if the device is an SD card
46 static bool is_sd(struct blk_desc
*desc
)
48 struct mmc
*mmc
= find_mmc_device(desc
->devnum
);
53 return IS_SD(mmc
) != 0U;
57 static void *dp_alloc(size_t sz
)
61 if (efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES
, sz
, &buf
) != EFI_SUCCESS
)
68 * Iterate to next block in device-path, terminating (returning NULL)
71 struct efi_device_path
*efi_dp_next(const struct efi_device_path
*dp
)
75 if (dp
->type
== DEVICE_PATH_TYPE_END
)
77 dp
= ((void *)dp
) + dp
->length
;
78 if (dp
->type
== DEVICE_PATH_TYPE_END
)
80 return (struct efi_device_path
*)dp
;
84 * Compare two device-paths, stopping when the shorter of the two hits
85 * an End* node. This is useful to, for example, compare a device-path
86 * representing a device with one representing a file on the device, or
87 * a device with a parent device.
89 int efi_dp_match(const struct efi_device_path
*a
,
90 const struct efi_device_path
*b
)
95 ret
= memcmp(&a
->length
, &b
->length
, sizeof(a
->length
));
99 ret
= memcmp(a
, b
, a
->length
);
113 * See UEFI spec (section 3.1.2, about short-form device-paths..
114 * tl;dr: we can have a device-path that starts with a USB WWID
115 * or USB Class node, and a few other cases which don't encode
116 * the full device path with bus hierarchy:
118 * - MESSAGING:USB_WWID
119 * - MESSAGING:USB_CLASS
124 static struct efi_device_path
*shorten_path(struct efi_device_path
*dp
)
128 * TODO: Add MESSAGING:USB_WWID and MESSAGING:URI..
129 * in practice fallback.efi just uses MEDIA:HARD_DRIVE
130 * so not sure when we would see these other cases.
132 if (EFI_DP_TYPE(dp
, MESSAGING_DEVICE
, MSG_USB_CLASS
) ||
133 EFI_DP_TYPE(dp
, MEDIA_DEVICE
, HARD_DRIVE_PATH
) ||
134 EFI_DP_TYPE(dp
, MEDIA_DEVICE
, FILE_PATH
))
137 dp
= efi_dp_next(dp
);
143 static struct efi_object
*find_obj(struct efi_device_path
*dp
, bool short_path
,
144 struct efi_device_path
**rem
)
146 struct efi_object
*efiobj
;
147 unsigned int dp_size
= efi_dp_size(dp
);
149 list_for_each_entry(efiobj
, &efi_obj_list
, link
) {
150 struct efi_handler
*handler
;
151 struct efi_device_path
*obj_dp
;
154 ret
= efi_search_protocol(efiobj
->handle
,
155 &efi_guid_device_path
, &handler
);
156 if (ret
!= EFI_SUCCESS
)
158 obj_dp
= handler
->protocol_interface
;
161 if (efi_dp_match(dp
, obj_dp
) == 0) {
164 * Allow partial matches, but inform
167 *rem
= ((void *)dp
) +
171 /* Only return on exact matches */
172 if (efi_dp_size(obj_dp
) == dp_size
)
177 obj_dp
= shorten_path(efi_dp_next(obj_dp
));
178 } while (short_path
&& obj_dp
);
186 * Find an efiobj from device-path, if 'rem' is not NULL, returns the
187 * remaining part of the device path after the matched object.
189 struct efi_object
*efi_dp_find_obj(struct efi_device_path
*dp
,
190 struct efi_device_path
**rem
)
192 struct efi_object
*efiobj
;
194 /* Search for an exact match first */
195 efiobj
= find_obj(dp
, false, NULL
);
197 /* Then for a fuzzy match */
199 efiobj
= find_obj(dp
, false, rem
);
201 /* And now for a fuzzy short match */
203 efiobj
= find_obj(dp
, true, rem
);
208 /* return size not including End node: */
209 unsigned efi_dp_size(const struct efi_device_path
*dp
)
215 dp
= efi_dp_next(dp
);
221 struct efi_device_path
*efi_dp_dup(const struct efi_device_path
*dp
)
223 struct efi_device_path
*ndp
;
224 unsigned sz
= efi_dp_size(dp
) + sizeof(END
);
235 struct efi_device_path
*efi_dp_append(const struct efi_device_path
*dp1
,
236 const struct efi_device_path
*dp2
)
238 struct efi_device_path
*ret
;
241 ret
= efi_dp_dup(dp2
);
243 ret
= efi_dp_dup(dp1
);
245 /* both dp1 and dp2 are non-null */
246 unsigned sz1
= efi_dp_size(dp1
);
247 unsigned sz2
= efi_dp_size(dp2
);
248 void *p
= dp_alloc(sz1
+ sz2
+ sizeof(END
));
250 memcpy(p
+ sz1
, dp2
, sz2
);
251 memcpy(p
+ sz1
+ sz2
, &END
, sizeof(END
));
258 struct efi_device_path
*efi_dp_append_node(const struct efi_device_path
*dp
,
259 const struct efi_device_path
*node
)
261 struct efi_device_path
*ret
;
264 ret
= efi_dp_dup(&END
);
266 ret
= efi_dp_dup(dp
);
268 unsigned sz
= node
->length
;
269 void *p
= dp_alloc(sz
+ sizeof(END
));
271 memcpy(p
+ sz
, &END
, sizeof(END
));
274 /* both dp and node are non-null */
275 unsigned sz
= efi_dp_size(dp
);
276 void *p
= dp_alloc(sz
+ node
->length
+ sizeof(END
));
278 memcpy(p
+ sz
, node
, node
->length
);
279 memcpy(p
+ sz
+ node
->length
, &END
, sizeof(END
));
287 /* size of device-path not including END node for device and all parents
288 * up to the root device.
290 static unsigned dp_size(struct udevice
*dev
)
292 if (!dev
|| !dev
->driver
)
295 switch (dev
->driver
->id
) {
297 case UCLASS_SIMPLE_BUS
:
298 /* stop traversing parents at this point: */
302 switch (dev
->parent
->uclass
->uc_drv
->id
) {
305 return dp_size(dev
->parent
) +
306 sizeof(struct efi_device_path_atapi
);
308 #if defined(CONFIG_SCSI) && defined(CONFIG_DM_SCSI)
310 return dp_size(dev
->parent
) +
311 sizeof(struct efi_device_path_scsi
);
314 return dp_size(dev
->parent
);
318 return dp_size(dev
->parent
) +
319 sizeof(struct efi_device_path_sd_mmc_path
);
320 case UCLASS_MASS_STORAGE
:
322 return dp_size(dev
->parent
) +
323 sizeof(struct efi_device_path_usb_class
);
325 /* just skip over unknown classes: */
326 return dp_size(dev
->parent
);
331 * Recursively build a device path.
333 * @buf pointer to the end of the device path
335 * @return pointer to the end of the device path
337 static void *dp_fill(void *buf
, struct udevice
*dev
)
339 if (!dev
|| !dev
->driver
)
342 switch (dev
->driver
->id
) {
344 case UCLASS_SIMPLE_BUS
: {
345 /* stop traversing parents at this point: */
346 struct efi_device_path_vendor
*vdp
= buf
;
352 switch (dev
->parent
->uclass
->uc_drv
->id
) {
355 struct efi_device_path_atapi
*dp
=
356 dp_fill(buf
, dev
->parent
);
357 struct blk_desc
*desc
= dev_get_uclass_platdata(dev
);
359 dp
->dp
.type
= DEVICE_PATH_TYPE_MESSAGING_DEVICE
;
360 dp
->dp
.sub_type
= DEVICE_PATH_SUB_TYPE_MSG_ATAPI
;
361 dp
->dp
.length
= sizeof(*dp
);
362 dp
->logical_unit_number
= desc
->devnum
;
363 dp
->primary_secondary
= IDE_BUS(desc
->devnum
);
364 dp
->slave_master
= desc
->devnum
%
365 (CONFIG_SYS_IDE_MAXDEVICE
/
366 CONFIG_SYS_IDE_MAXBUS
);
370 #if defined(CONFIG_SCSI) && defined(CONFIG_DM_SCSI)
372 struct efi_device_path_scsi
*dp
=
373 dp_fill(buf
, dev
->parent
);
374 struct blk_desc
*desc
= dev_get_uclass_platdata(dev
);
376 dp
->dp
.type
= DEVICE_PATH_TYPE_MESSAGING_DEVICE
;
377 dp
->dp
.sub_type
= DEVICE_PATH_SUB_TYPE_MSG_SCSI
;
378 dp
->dp
.length
= sizeof(*dp
);
379 dp
->logical_unit_number
= desc
->lun
;
380 dp
->target_id
= desc
->target
;
385 printf("unhandled parent class: %s (%u)\n",
386 dev
->name
, dev
->driver
->id
);
387 return dp_fill(buf
, dev
->parent
);
390 #if defined(CONFIG_DM_MMC) && defined(CONFIG_MMC)
392 struct efi_device_path_sd_mmc_path
*sddp
=
393 dp_fill(buf
, dev
->parent
);
394 struct mmc
*mmc
= mmc_get_mmc_dev(dev
);
395 struct blk_desc
*desc
= mmc_get_blk_desc(mmc
);
397 sddp
->dp
.type
= DEVICE_PATH_TYPE_MESSAGING_DEVICE
;
398 sddp
->dp
.sub_type
= is_sd(desc
) ?
399 DEVICE_PATH_SUB_TYPE_MSG_SD
:
400 DEVICE_PATH_SUB_TYPE_MSG_MMC
;
401 sddp
->dp
.length
= sizeof(*sddp
);
402 sddp
->slot_number
= dev
->seq
;
407 case UCLASS_MASS_STORAGE
:
408 case UCLASS_USB_HUB
: {
409 struct efi_device_path_usb_class
*udp
=
410 dp_fill(buf
, dev
->parent
);
411 struct usb_device
*udev
= dev_get_parent_priv(dev
);
412 struct usb_device_descriptor
*desc
= &udev
->descriptor
;
414 udp
->dp
.type
= DEVICE_PATH_TYPE_MESSAGING_DEVICE
;
415 udp
->dp
.sub_type
= DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS
;
416 udp
->dp
.length
= sizeof(*udp
);
417 udp
->vendor_id
= desc
->idVendor
;
418 udp
->product_id
= desc
->idProduct
;
419 udp
->device_class
= desc
->bDeviceClass
;
420 udp
->device_subclass
= desc
->bDeviceSubClass
;
421 udp
->device_protocol
= desc
->bDeviceProtocol
;
426 debug("unhandled device class: %s (%u)\n",
427 dev
->name
, dev
->driver
->id
);
428 return dp_fill(buf
, dev
->parent
);
432 /* Construct a device-path from a device: */
433 struct efi_device_path
*efi_dp_from_dev(struct udevice
*dev
)
437 start
= buf
= dp_alloc(dp_size(dev
) + sizeof(END
));
438 buf
= dp_fill(buf
, dev
);
439 *((struct efi_device_path
*)buf
) = END
;
445 static unsigned dp_part_size(struct blk_desc
*desc
, int part
)
452 int ret
= blk_find_device(desc
->if_type
, desc
->devnum
, &dev
);
455 dev
= desc
->bdev
->parent
;
456 dpsize
= dp_size(dev
);
459 dpsize
= sizeof(ROOT
) + sizeof(struct efi_device_path_usb
);
462 if (part
== 0) /* the actual disk, not a partition */
465 if (desc
->part_type
== PART_TYPE_ISO
)
466 dpsize
+= sizeof(struct efi_device_path_cdrom_path
);
468 dpsize
+= sizeof(struct efi_device_path_hard_drive_path
);
474 * Create a device path for a block device or one of its partitions.
476 * @buf buffer to which the device path is wirtten
477 * @desc block device descriptor
478 * @part partition number, 0 identifies a block device
480 static void *dp_part_fill(void *buf
, struct blk_desc
*desc
, int part
)
482 disk_partition_t info
;
487 int ret
= blk_find_device(desc
->if_type
, desc
->devnum
, &dev
);
490 dev
= desc
->bdev
->parent
;
491 buf
= dp_fill(buf
, dev
);
495 * We *could* make a more accurate path, by looking at if_type
496 * and handling all the different cases like we do for non-
497 * legacy (ie CONFIG_BLK=y) case. But most important thing
498 * is just to have a unique device-path for if_type+devnum.
499 * So map things to a fictitious USB device.
501 struct efi_device_path_usb
*udp
;
503 memcpy(buf
, &ROOT
, sizeof(ROOT
));
507 udp
->dp
.type
= DEVICE_PATH_TYPE_MESSAGING_DEVICE
;
508 udp
->dp
.sub_type
= DEVICE_PATH_SUB_TYPE_MSG_USB
;
509 udp
->dp
.length
= sizeof(*udp
);
510 udp
->parent_port_number
= desc
->if_type
;
511 udp
->usb_interface
= desc
->devnum
;
515 if (part
== 0) /* the actual disk, not a partition */
518 part_get_info(desc
, part
, &info
);
520 if (desc
->part_type
== PART_TYPE_ISO
) {
521 struct efi_device_path_cdrom_path
*cddp
= buf
;
523 cddp
->boot_entry
= part
;
524 cddp
->dp
.type
= DEVICE_PATH_TYPE_MEDIA_DEVICE
;
525 cddp
->dp
.sub_type
= DEVICE_PATH_SUB_TYPE_CDROM_PATH
;
526 cddp
->dp
.length
= sizeof(*cddp
);
527 cddp
->partition_start
= info
.start
;
528 cddp
->partition_end
= info
.size
;
532 struct efi_device_path_hard_drive_path
*hddp
= buf
;
534 hddp
->dp
.type
= DEVICE_PATH_TYPE_MEDIA_DEVICE
;
535 hddp
->dp
.sub_type
= DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH
;
536 hddp
->dp
.length
= sizeof(*hddp
);
537 hddp
->partition_number
= part
;
538 hddp
->partition_start
= info
.start
;
539 hddp
->partition_end
= info
.size
;
540 if (desc
->part_type
== PART_TYPE_EFI
)
541 hddp
->partmap_type
= 2;
543 hddp
->partmap_type
= 1;
545 switch (desc
->sig_type
) {
548 hddp
->signature_type
= 0;
549 memset(hddp
->partition_signature
, 0,
550 sizeof(hddp
->partition_signature
));
553 hddp
->signature_type
= 1;
554 memset(hddp
->partition_signature
, 0,
555 sizeof(hddp
->partition_signature
));
556 memcpy(hddp
->partition_signature
, &desc
->mbr_sig
,
557 sizeof(desc
->mbr_sig
));
560 hddp
->signature_type
= 2;
561 memcpy(hddp
->partition_signature
, &desc
->guid_sig
,
562 sizeof(hddp
->partition_signature
));
573 /* Construct a device-path from a partition on a blk device: */
574 struct efi_device_path
*efi_dp_from_part(struct blk_desc
*desc
, int part
)
578 start
= buf
= dp_alloc(dp_part_size(desc
, part
) + sizeof(END
));
580 buf
= dp_part_fill(buf
, desc
, part
);
582 *((struct efi_device_path
*)buf
) = END
;
587 /* convert path to an UEFI style path (ie. DOS style backslashes and utf16) */
588 static void path_to_uefi(u16
*uefi
, const char *path
)
600 * If desc is NULL, this creates a path with only the file component,
601 * otherwise it creates a full path with both device and file components
603 struct efi_device_path
*efi_dp_from_file(struct blk_desc
*desc
, int part
,
606 struct efi_device_path_file_path
*fp
;
608 unsigned dpsize
= 0, fpsize
;
611 dpsize
= dp_part_size(desc
, part
);
613 fpsize
= sizeof(struct efi_device_path
) + 2 * (strlen(path
) + 1);
616 start
= buf
= dp_alloc(dpsize
+ sizeof(END
));
619 buf
= dp_part_fill(buf
, desc
, part
);
623 fp
->dp
.type
= DEVICE_PATH_TYPE_MEDIA_DEVICE
;
624 fp
->dp
.sub_type
= DEVICE_PATH_SUB_TYPE_FILE_PATH
;
625 fp
->dp
.length
= fpsize
;
626 path_to_uefi(fp
->str
, path
);
629 *((struct efi_device_path
*)buf
) = END
;
635 struct efi_device_path
*efi_dp_from_eth(void)
637 struct efi_device_path_mac_addr
*ndp
;
641 assert(eth_get_dev());
644 dpsize
+= dp_size(eth_get_dev());
646 dpsize
+= sizeof(ROOT
);
648 dpsize
+= sizeof(*ndp
);
650 start
= buf
= dp_alloc(dpsize
+ sizeof(END
));
653 buf
= dp_fill(buf
, eth_get_dev());
655 memcpy(buf
, &ROOT
, sizeof(ROOT
));
660 ndp
->dp
.type
= DEVICE_PATH_TYPE_MESSAGING_DEVICE
;
661 ndp
->dp
.sub_type
= DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR
;
662 ndp
->dp
.length
= sizeof(*ndp
);
663 memcpy(ndp
->mac
.addr
, eth_get_ethaddr(), ARP_HLEN
);
666 *((struct efi_device_path
*)buf
) = END
;
672 /* Construct a device-path for memory-mapped image */
673 struct efi_device_path
*efi_dp_from_mem(uint32_t memory_type
,
674 uint64_t start_address
,
675 uint64_t end_address
)
677 struct efi_device_path_memory
*mdp
;
680 start
= buf
= dp_alloc(sizeof(*mdp
) + sizeof(END
));
683 mdp
->dp
.type
= DEVICE_PATH_TYPE_HARDWARE_DEVICE
;
684 mdp
->dp
.sub_type
= DEVICE_PATH_SUB_TYPE_MEMORY
;
685 mdp
->dp
.length
= sizeof(*mdp
);
686 mdp
->memory_type
= memory_type
;
687 mdp
->start_address
= start_address
;
688 mdp
->end_address
= end_address
;
691 *((struct efi_device_path
*)buf
) = END
;
697 * Helper to split a full device path (containing both device and file
698 * parts) into it's constituent parts.
700 void efi_dp_split_file_path(struct efi_device_path
*full_path
,
701 struct efi_device_path
**device_path
,
702 struct efi_device_path
**file_path
)
704 struct efi_device_path
*p
, *dp
, *fp
;
706 dp
= efi_dp_dup(full_path
);
708 while (!EFI_DP_TYPE(p
, MEDIA_DEVICE
, FILE_PATH
))
712 p
->type
= DEVICE_PATH_TYPE_END
;
713 p
->sub_type
= DEVICE_PATH_SUB_TYPE_END
;
714 p
->length
= sizeof(*p
);