2 Library instance that implement UEFI Device Path Library class based on protocol
3 gEfiDevicePathUtilitiesProtocolGuid.
5 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php.
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 #include <Protocol/DevicePathUtilities.h>
20 #include <Protocol/DevicePathToText.h>
21 #include <Protocol/DevicePathFromText.h>
23 #include <Library/DevicePathLib.h>
24 #include <Library/DebugLib.h>
25 #include <Library/BaseLib.h>
26 #include <Library/MemoryAllocationLib.h>
27 #include <Library/BaseMemoryLib.h>
28 #include <Library/UefiBootServicesTableLib.h>
29 #include <Library/PcdLib.h>
31 GLOBAL_REMOVE_IF_UNREFERENCED EFI_DEVICE_PATH_UTILITIES_PROTOCOL
*mDevicePathLibDevicePathUtilities
= NULL
;
32 GLOBAL_REMOVE_IF_UNREFERENCED EFI_DEVICE_PATH_TO_TEXT_PROTOCOL
*mDevicePathLibDevicePathToText
= NULL
;
33 GLOBAL_REMOVE_IF_UNREFERENCED EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL
*mDevicePathLibDevicePathFromText
= NULL
;
36 // Template for an end-of-device path node.
38 GLOBAL_REMOVE_IF_UNREFERENCED CONST EFI_DEVICE_PATH_PROTOCOL mUefiDevicePathLibEndDevicePath
= {
40 END_ENTIRE_DEVICE_PATH_SUBTYPE
,
42 END_DEVICE_PATH_LENGTH
,
48 The constructor function caches the pointer to DevicePathUtilites protocol.
50 The constructor function locates DevicePathUtilities protocol from protocol database.
51 It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.
53 @param ImageHandle The firmware allocated handle for the EFI image.
54 @param SystemTable A pointer to the EFI System Table.
56 @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
61 DevicePathLibConstructor (
62 IN EFI_HANDLE ImageHandle
,
63 IN EFI_SYSTEM_TABLE
*SystemTable
68 Status
= gBS
->LocateProtocol (
69 &gEfiDevicePathUtilitiesProtocolGuid
,
71 (VOID
**) &mDevicePathLibDevicePathUtilities
73 ASSERT_EFI_ERROR (Status
);
74 ASSERT (mDevicePathLibDevicePathUtilities
!= NULL
);
79 Determine whether a given device path is valid.
80 If DevicePath is NULL, then ASSERT().
82 @param DevicePath A pointer to a device path data structure.
83 @param MaxSize The maximum size of the device path data structure.
85 @retval TRUE DevicePath is valid.
86 @retval FALSE The length of any node node in the DevicePath is less
87 than sizeof (EFI_DEVICE_PATH_PROTOCOL).
88 @retval FALSE If MaxSize is not zero, the size of the DevicePath
90 @retval FALSE If PcdMaximumDevicePathNodeCount is not zero, the node
91 count of the DevicePath exceeds PcdMaximumDevicePathNodeCount.
96 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
104 ASSERT (DevicePath
!= NULL
);
111 // Validate the input size big enough to touch the first node.
113 if (MaxSize
< sizeof (EFI_DEVICE_PATH_PROTOCOL
)) {
117 for (Count
= 0, Size
= 0; !IsDevicePathEnd (DevicePath
); DevicePath
= NextDevicePathNode (DevicePath
)) {
118 NodeLength
= DevicePathNodeLength (DevicePath
);
119 if (NodeLength
< sizeof (EFI_DEVICE_PATH_PROTOCOL
)) {
123 if (NodeLength
> MAX_UINTN
- Size
) {
129 // Validate next node before touch it.
131 if (Size
> MaxSize
- END_DEVICE_PATH_LENGTH
) {
135 if (PcdGet32 (PcdMaximumDevicePathNodeCount
) > 0) {
137 if (Count
>= PcdGet32 (PcdMaximumDevicePathNodeCount
)) {
143 // FilePath must be a NULL-terminated string.
145 if (DevicePathType (DevicePath
) == MEDIA_DEVICE_PATH
&&
146 DevicePathSubType (DevicePath
) == MEDIA_FILEPATH_DP
&&
147 *(CHAR16
*)((UINT8
*)DevicePath
+ NodeLength
- 2) != 0) {
153 // Only return TRUE when the End Device Path node is valid.
155 return (BOOLEAN
) (DevicePathNodeLength (DevicePath
) == END_DEVICE_PATH_LENGTH
);
159 Returns the Type field of a device path node.
161 Returns the Type field of the device path node specified by Node.
163 If Node is NULL, then ASSERT().
165 @param Node A pointer to a device path node data structure.
167 @return The Type field of the device path node specified by Node.
176 ASSERT (Node
!= NULL
);
177 return ((EFI_DEVICE_PATH_PROTOCOL
*)(Node
))->Type
;
181 Returns the SubType field of a device path node.
183 Returns the SubType field of the device path node specified by Node.
185 If Node is NULL, then ASSERT().
187 @param Node A pointer to a device path node data structure.
189 @return The SubType field of the device path node specified by Node.
198 ASSERT (Node
!= NULL
);
199 return ((EFI_DEVICE_PATH_PROTOCOL
*)(Node
))->SubType
;
203 Returns the 16-bit Length field of a device path node.
205 Returns the 16-bit Length field of the device path node specified by Node.
206 Node is not required to be aligned on a 16-bit boundary, so it is recommended
207 that a function such as ReadUnaligned16() be used to extract the contents of
210 If Node is NULL, then ASSERT().
212 @param Node A pointer to a device path node data structure.
214 @return The 16-bit Length field of the device path node specified by Node.
219 DevicePathNodeLength (
223 ASSERT (Node
!= NULL
);
224 return ReadUnaligned16 ((UINT16
*)&((EFI_DEVICE_PATH_PROTOCOL
*)(Node
))->Length
[0]);
228 Returns a pointer to the next node in a device path.
230 Returns a pointer to the device path node that follows the device path node
233 If Node is NULL, then ASSERT().
235 @param Node A pointer to a device path node data structure.
237 @return a pointer to the device path node that follows the device path node
241 EFI_DEVICE_PATH_PROTOCOL
*
247 ASSERT (Node
!= NULL
);
248 return (EFI_DEVICE_PATH_PROTOCOL
*)((UINT8
*)(Node
) + DevicePathNodeLength(Node
));
252 Determines if a device path node is an end node of a device path.
253 This includes nodes that are the end of a device path instance and nodes that
254 are the end of an entire device path.
256 Determines if the device path node specified by Node is an end node of a device path.
257 This includes nodes that are the end of a device path instance and nodes that are the
258 end of an entire device path. If Node represents an end node of a device path,
259 then TRUE is returned. Otherwise, FALSE is returned.
261 If Node is NULL, then ASSERT().
263 @param Node A pointer to a device path node data structure.
265 @retval TRUE The device path node specified by Node is an end node of a device path.
266 @retval FALSE The device path node specified by Node is not an end node of
272 IsDevicePathEndType (
276 ASSERT (Node
!= NULL
);
277 return (BOOLEAN
) (DevicePathType (Node
) == END_DEVICE_PATH_TYPE
);
281 Determines if a device path node is an end node of an entire device path.
283 Determines if a device path node specified by Node is an end node of an entire
285 If Node represents the end of an entire device path, then TRUE is returned.
286 Otherwise, FALSE is returned.
288 If Node is NULL, then ASSERT().
290 @param Node A pointer to a device path node data structure.
292 @retval TRUE The device path node specified by Node is the end of an entire device path.
293 @retval FALSE The device path node specified by Node is not the end of an entire device path.
302 ASSERT (Node
!= NULL
);
303 return (BOOLEAN
) (IsDevicePathEndType (Node
) && DevicePathSubType(Node
) == END_ENTIRE_DEVICE_PATH_SUBTYPE
);
307 Determines if a device path node is an end node of a device path instance.
309 Determines if a device path node specified by Node is an end node of a device
311 If Node represents the end of a device path instance, then TRUE is returned.
312 Otherwise, FALSE is returned.
314 If Node is NULL, then ASSERT().
316 @param Node A pointer to a device path node data structure.
318 @retval TRUE The device path node specified by Node is the end of a device
320 @retval FALSE The device path node specified by Node is not the end of a
321 device path instance.
326 IsDevicePathEndInstance (
330 ASSERT (Node
!= NULL
);
331 return (BOOLEAN
) (IsDevicePathEndType (Node
) && DevicePathSubType(Node
) == END_INSTANCE_DEVICE_PATH_SUBTYPE
);
335 Sets the length, in bytes, of a device path node.
337 Sets the length of the device path node specified by Node to the value specified
338 by NodeLength. NodeLength is returned. Node is not required to be aligned on
339 a 16-bit boundary, so it is recommended that a function such as WriteUnaligned16()
340 be used to set the contents of the Length field.
342 If Node is NULL, then ASSERT().
343 If NodeLength >= SIZE_64KB, then ASSERT().
344 If NodeLength < sizeof (EFI_DEVICE_PATH_PROTOCOL), then ASSERT().
346 @param Node A pointer to a device path node data structure.
347 @param Length The length, in bytes, of the device path node.
354 SetDevicePathNodeLength (
359 ASSERT (Node
!= NULL
);
360 ASSERT ((Length
>= sizeof (EFI_DEVICE_PATH_PROTOCOL
)) && (Length
< SIZE_64KB
));
361 return WriteUnaligned16 ((UINT16
*)&((EFI_DEVICE_PATH_PROTOCOL
*)(Node
))->Length
[0], (UINT16
)(Length
));
365 Fills in all the fields of a device path node that is the end of an entire device path.
367 Fills in all the fields of a device path node specified by Node so Node represents
368 the end of an entire device path. The Type field of Node is set to
369 END_DEVICE_PATH_TYPE, the SubType field of Node is set to
370 END_ENTIRE_DEVICE_PATH_SUBTYPE, and the Length field of Node is set to
371 END_DEVICE_PATH_LENGTH. Node is not required to be aligned on a 16-bit boundary,
372 so it is recommended that a function such as WriteUnaligned16() be used to set
373 the contents of the Length field.
375 If Node is NULL, then ASSERT().
377 @param Node A pointer to a device path node data structure.
382 SetDevicePathEndNode (
386 ASSERT (Node
!= NULL
);
387 CopyMem (Node
, &mUefiDevicePathLibEndDevicePath
, sizeof (mUefiDevicePathLibEndDevicePath
));
391 Returns the size of a device path in bytes.
393 This function returns the size, in bytes, of the device path data structure
394 specified by DevicePath including the end of device path node.
395 If DevicePath is NULL or invalid, then 0 is returned.
397 @param DevicePath A pointer to a device path data structure.
399 @retval 0 If DevicePath is NULL or invalid.
400 @retval Others The size of a device path in bytes.
406 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
409 return mDevicePathLibDevicePathUtilities
->GetDevicePathSize (DevicePath
);
413 Creates a new copy of an existing device path.
415 This function allocates space for a new copy of the device path specified by
416 DevicePath. If DevicePath is NULL, then NULL is returned.
417 If the memory is successfully allocated, then the
418 contents of DevicePath are copied to the newly allocated buffer, and a pointer to that buffer
419 is returned. Otherwise, NULL is returned.
420 The memory for the new device path is allocated from EFI boot services memory.
421 It is the responsibility of the caller to free the memory allocated.
423 @param DevicePath A pointer to a device path data structure.
425 @retval NULL If DevicePath is NULL or invalid.
426 @retval Others A pointer to the duplicated device path.
429 EFI_DEVICE_PATH_PROTOCOL
*
431 DuplicateDevicePath (
432 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
435 return mDevicePathLibDevicePathUtilities
->DuplicateDevicePath (DevicePath
);
439 Creates a new device path by appending a second device path to a first device path.
441 This function creates a new device path by appending a copy of SecondDevicePath to a copy of
442 FirstDevicePath in a newly allocated buffer. Only the end-of-device-path device node from
443 SecondDevicePath is retained. The newly created device path is returned.
444 If FirstDevicePath is NULL, then it is ignored, and a duplicate of SecondDevicePath is returned.
445 If SecondDevicePath is NULL, then it is ignored, and a duplicate of FirstDevicePath is returned.
446 If both FirstDevicePath and SecondDevicePath are NULL, then a copy of an end-of-device-path is
448 If there is not enough memory for the newly allocated buffer, then NULL is returned.
449 The memory for the new device path is allocated from EFI boot services memory. It is the
450 responsibility of the caller to free the memory allocated.
452 @param FirstDevicePath A pointer to a device path data structure.
453 @param SecondDevicePath A pointer to a device path data structure.
455 @retval NULL If there is not enough memory for the newly allocated buffer.
456 @retval NULL If FirstDevicePath or SecondDevicePath is invalid.
457 @retval Others A pointer to the new device path if success.
458 Or a copy an end-of-device-path if both FirstDevicePath and
459 SecondDevicePath are NULL.
462 EFI_DEVICE_PATH_PROTOCOL
*
465 IN CONST EFI_DEVICE_PATH_PROTOCOL
*FirstDevicePath
, OPTIONAL
466 IN CONST EFI_DEVICE_PATH_PROTOCOL
*SecondDevicePath OPTIONAL
469 return mDevicePathLibDevicePathUtilities
->AppendDevicePath (FirstDevicePath
, SecondDevicePath
);
473 Creates a new path by appending the device node to the device path.
475 This function creates a new device path by appending a copy of the device node
476 specified by DevicePathNode to a copy of the device path specified by DevicePath
477 in an allocated buffer.
478 The end-of-device-path device node is moved after the end of the appended device node.
479 If DevicePathNode is NULL then a copy of DevicePath is returned.
480 If DevicePath is NULL then a copy of DevicePathNode, followed by an end-of-device
481 path device node is returned.
482 If both DevicePathNode and DevicePath are NULL then a copy of an end-of-device-path
483 device node is returned.
484 If there is not enough memory to allocate space for the new device path, then
486 The memory is allocated from EFI boot services memory. It is the responsibility
487 of the caller to free the memory allocated.
489 @param DevicePath A pointer to a device path data structure.
490 @param DevicePathNode A pointer to a single device path node.
492 @retval NULL If there is not enough memory for the new device path.
493 @retval Others A pointer to the new device path if success.
494 A copy of DevicePathNode followed by an end-of-device-path node
495 if both FirstDevicePath and SecondDevicePath are NULL.
496 A copy of an end-of-device-path node if both FirstDevicePath
497 and SecondDevicePath are NULL.
500 EFI_DEVICE_PATH_PROTOCOL
*
502 AppendDevicePathNode (
503 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
, OPTIONAL
504 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePathNode OPTIONAL
507 return mDevicePathLibDevicePathUtilities
->AppendDeviceNode (DevicePath
, DevicePathNode
);
511 Creates a new device path by appending the specified device path instance to
512 the specified device path.
514 This function creates a new device path by appending a copy of the device path
515 instance specified by DevicePathInstance to a copy of the device path specified
516 by DevicePath in a allocated buffer.
517 The end-of-device-path device node is moved after the end of the appended device
518 path instance and a new end-of-device-path-instance node is inserted between.
519 If DevicePath is NULL, then a copy if DevicePathInstance is returned.
520 If DevicePathInstance is NULL, then NULL is returned.
521 If DevicePath or DevicePathInstance is invalid, then NULL is returned.
522 If there is not enough memory to allocate space for the new device path, then
524 The memory is allocated from EFI boot services memory. It is the responsibility
525 of the caller to free the memory allocated.
527 @param DevicePath A pointer to a device path data structure.
528 @param DevicePathInstance A pointer to a device path instance.
530 @return A pointer to the new device path.
533 EFI_DEVICE_PATH_PROTOCOL
*
535 AppendDevicePathInstance (
536 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
, OPTIONAL
537 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePathInstance OPTIONAL
540 return mDevicePathLibDevicePathUtilities
->AppendDevicePathInstance (DevicePath
, DevicePathInstance
);
544 Creates a copy of the current device path instance and returns a pointer to the
545 next device path instance.
547 This function creates a copy of the current device path instance. It also updates
548 DevicePath to point to the next device path instance in the device path (or NULL
549 if no more) and updates Size to hold the size of the device path instance copy.
550 If DevicePath is NULL, then NULL is returned.
551 If there is not enough memory to allocate space for the new device path, then
553 The memory is allocated from EFI boot services memory. It is the responsibility
554 of the caller to free the memory allocated.
555 If Size is NULL, then ASSERT().
557 @param DevicePath On input, this holds the pointer to the current
558 device path instance. On output, this holds
559 the pointer to the next device path instance
560 or NULL if there are no more device path
561 instances in the device path pointer to a
562 device path data structure.
563 @param Size On output, this holds the size of the device
564 path instance, in bytes or zero, if DevicePath
567 @return A pointer to the current device path instance.
570 EFI_DEVICE_PATH_PROTOCOL
*
572 GetNextDevicePathInstance (
573 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
,
577 ASSERT (Size
!= NULL
);
578 return mDevicePathLibDevicePathUtilities
->GetNextDevicePathInstance (DevicePath
, Size
);
582 Creates a device node.
584 This function creates a new device node in a newly allocated buffer of size
585 NodeLength and initializes the device path node header with NodeType and NodeSubType.
586 The new device path node is returned.
587 If NodeLength is smaller than a device path header, then NULL is returned.
588 If there is not enough memory to allocate space for the new device path, then
590 The memory is allocated from EFI boot services memory. It is the responsibility
591 of the caller to free the memory allocated.
593 @param NodeType The device node type for the new device node.
594 @param NodeSubType The device node sub-type for the new device node.
595 @param NodeLength The length of the new device node.
597 @return The new device path.
600 EFI_DEVICE_PATH_PROTOCOL
*
604 IN UINT8 NodeSubType
,
608 return mDevicePathLibDevicePathUtilities
->CreateDeviceNode (NodeType
, NodeSubType
, NodeLength
);
612 Determines if a device path is single or multi-instance.
614 This function returns TRUE if the device path specified by DevicePath is
616 Otherwise, FALSE is returned.
617 If DevicePath is NULL or invalid, then FALSE is returned.
619 @param DevicePath A pointer to a device path data structure.
621 @retval TRUE DevicePath is multi-instance.
622 @retval FALSE DevicePath is not multi-instance, or DevicePath
628 IsDevicePathMultiInstance (
629 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
632 return mDevicePathLibDevicePathUtilities
->IsDevicePathMultiInstance (DevicePath
);
636 Retrieves the device path protocol from a handle.
638 This function returns the device path protocol from the handle specified by Handle.
639 If Handle is NULL or Handle does not contain a device path protocol, then NULL
642 @param Handle The handle from which to retrieve the device
645 @return The device path protocol from the handle specified by Handle.
648 EFI_DEVICE_PATH_PROTOCOL
*
650 DevicePathFromHandle (
654 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
657 Status
= gBS
->HandleProtocol (
659 &gEfiDevicePathProtocolGuid
,
662 if (EFI_ERROR (Status
)) {
669 Allocates a device path for a file and appends it to an existing device path.
671 If Device is a valid device handle that contains a device path protocol, then
672 a device path for the file specified by FileName is allocated and appended to
673 the device path associated with the handle Device. The allocated device path
674 is returned. If Device is NULL or Device is a handle that does not support the
675 device path protocol, then a device path containing a single device path node
676 for the file specified by FileName is allocated and returned.
677 The memory for the new device path is allocated from EFI boot services memory.
678 It is the responsibility of the caller to free the memory allocated.
680 If FileName is NULL, then ASSERT().
681 If FileName is not aligned on a 16-bit boundary, then ASSERT().
683 @param Device A pointer to a device handle. This parameter
684 is optional and may be NULL.
685 @param FileName A pointer to a Null-terminated Unicode string.
687 @return The allocated device path.
690 EFI_DEVICE_PATH_PROTOCOL
*
693 IN EFI_HANDLE Device
, OPTIONAL
694 IN CONST CHAR16
*FileName
698 FILEPATH_DEVICE_PATH
*FilePath
;
699 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
700 EFI_DEVICE_PATH_PROTOCOL
*FileDevicePath
;
704 Size
= StrSize (FileName
);
705 FileDevicePath
= AllocatePool (Size
+ SIZE_OF_FILEPATH_DEVICE_PATH
+ END_DEVICE_PATH_LENGTH
);
706 if (FileDevicePath
!= NULL
) {
707 FilePath
= (FILEPATH_DEVICE_PATH
*) FileDevicePath
;
708 FilePath
->Header
.Type
= MEDIA_DEVICE_PATH
;
709 FilePath
->Header
.SubType
= MEDIA_FILEPATH_DP
;
710 CopyMem (&FilePath
->PathName
, FileName
, Size
);
711 SetDevicePathNodeLength (&FilePath
->Header
, Size
+ SIZE_OF_FILEPATH_DEVICE_PATH
);
712 SetDevicePathEndNode (NextDevicePathNode (&FilePath
->Header
));
714 if (Device
!= NULL
) {
715 DevicePath
= DevicePathFromHandle (Device
);
718 DevicePath
= AppendDevicePath (DevicePath
, FileDevicePath
);
719 FreePool (FileDevicePath
);
726 Locate and return the protocol instance identified by the ProtocolGuid.
728 @param ProtocolGuid The GUID of the protocol.
730 @return A pointer to the protocol instance or NULL when absent.
733 UefiDevicePathLibLocateProtocol (
734 EFI_GUID
*ProtocolGuid
739 Status
= gBS
->LocateProtocol (
744 if (EFI_ERROR (Status
)) {
752 Converts a device node to its string representation.
754 @param DeviceNode A Pointer to the device node to be converted.
755 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
756 of the display node is used, where applicable. If DisplayOnly
757 is FALSE, then the longer text representation of the display node
759 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
760 representation for a device node can be used, where applicable.
762 @return A pointer to the allocated text representation of the device node or NULL if DeviceNode
763 is NULL or there was insufficient memory.
768 ConvertDeviceNodeToText (
769 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DeviceNode
,
770 IN BOOLEAN DisplayOnly
,
771 IN BOOLEAN AllowShortcuts
774 if (mDevicePathLibDevicePathToText
== NULL
) {
775 mDevicePathLibDevicePathToText
= UefiDevicePathLibLocateProtocol (&gEfiDevicePathToTextProtocolGuid
);
777 if (mDevicePathLibDevicePathToText
!= NULL
) {
778 return mDevicePathLibDevicePathToText
->ConvertDeviceNodeToText (DeviceNode
, DisplayOnly
, AllowShortcuts
);
785 Converts a device path to its text representation.
787 @param DevicePath A Pointer to the device to be converted.
788 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
789 of the display node is used, where applicable. If DisplayOnly
790 is FALSE, then the longer text representation of the display node
792 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
793 representation for a device node can be used, where applicable.
795 @return A pointer to the allocated text representation of the device path or
796 NULL if DeviceNode is NULL or there was insufficient memory.
801 ConvertDevicePathToText (
802 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
803 IN BOOLEAN DisplayOnly
,
804 IN BOOLEAN AllowShortcuts
807 if (mDevicePathLibDevicePathToText
== NULL
) {
808 mDevicePathLibDevicePathToText
= UefiDevicePathLibLocateProtocol (&gEfiDevicePathToTextProtocolGuid
);
810 if (mDevicePathLibDevicePathToText
!= NULL
) {
811 return mDevicePathLibDevicePathToText
->ConvertDevicePathToText (DevicePath
, DisplayOnly
, AllowShortcuts
);
818 Convert text to the binary representation of a device node.
820 @param TextDeviceNode TextDeviceNode points to the text representation of a device
821 node. Conversion starts with the first character and continues
822 until the first non-device node character.
824 @return A pointer to the EFI device node or NULL if TextDeviceNode is NULL or there was
825 insufficient memory or text unsupported.
828 EFI_DEVICE_PATH_PROTOCOL
*
830 ConvertTextToDeviceNode (
831 IN CONST CHAR16
*TextDeviceNode
834 if (mDevicePathLibDevicePathFromText
== NULL
) {
835 mDevicePathLibDevicePathFromText
= UefiDevicePathLibLocateProtocol (&gEfiDevicePathFromTextProtocolGuid
);
837 if (mDevicePathLibDevicePathFromText
!= NULL
) {
838 return mDevicePathLibDevicePathFromText
->ConvertTextToDeviceNode (TextDeviceNode
);
845 Convert text to the binary representation of a device path.
848 @param TextDevicePath TextDevicePath points to the text representation of a device
849 path. Conversion starts with the first character and continues
850 until the first non-device node character.
852 @return A pointer to the allocated device path or NULL if TextDeviceNode is NULL or
853 there was insufficient memory.
856 EFI_DEVICE_PATH_PROTOCOL
*
858 ConvertTextToDevicePath (
859 IN CONST CHAR16
*TextDevicePath
862 if (mDevicePathLibDevicePathFromText
== NULL
) {
863 mDevicePathLibDevicePathFromText
= UefiDevicePathLibLocateProtocol (&gEfiDevicePathFromTextProtocolGuid
);
865 if (mDevicePathLibDevicePathFromText
!= NULL
) {
866 return mDevicePathLibDevicePathFromText
->ConvertTextToDevicePath (TextDevicePath
);