2 Library instance that implement UEFI Device Path Library class based on protocol
3 gEfiDevicePathUtilitiesProtocolGuid.
5 Copyright (c) 2006 - 2013, 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
);
106 for (Count
= 0, Size
= 0; !IsDevicePathEnd (DevicePath
); DevicePath
= NextDevicePathNode (DevicePath
)) {
107 NodeLength
= DevicePathNodeLength (DevicePath
);
108 if (NodeLength
< sizeof (EFI_DEVICE_PATH_PROTOCOL
)) {
114 if (Size
+ END_DEVICE_PATH_LENGTH
> MaxSize
) {
119 if (PcdGet32 (PcdMaximumDevicePathNodeCount
) > 0) {
121 if (Count
>= PcdGet32 (PcdMaximumDevicePathNodeCount
)) {
128 // Only return TRUE when the End Device Path node is valid.
130 return (BOOLEAN
) (DevicePathNodeLength (DevicePath
) == END_DEVICE_PATH_LENGTH
);
134 Returns the Type field of a device path node.
136 Returns the Type field of the device path node specified by Node.
138 If Node is NULL, then ASSERT().
140 @param Node A pointer to a device path node data structure.
142 @return The Type field of the device path node specified by Node.
151 ASSERT (Node
!= NULL
);
152 return ((EFI_DEVICE_PATH_PROTOCOL
*)(Node
))->Type
;
156 Returns the SubType field of a device path node.
158 Returns the SubType field of the device path node specified by Node.
160 If Node is NULL, then ASSERT().
162 @param Node A pointer to a device path node data structure.
164 @return The SubType field of the device path node specified by Node.
173 ASSERT (Node
!= NULL
);
174 return ((EFI_DEVICE_PATH_PROTOCOL
*)(Node
))->SubType
;
178 Returns the 16-bit Length field of a device path node.
180 Returns the 16-bit Length field of the device path node specified by Node.
181 Node is not required to be aligned on a 16-bit boundary, so it is recommended
182 that a function such as ReadUnaligned16() be used to extract the contents of
185 If Node is NULL, then ASSERT().
187 @param Node A pointer to a device path node data structure.
189 @return The 16-bit Length field of the device path node specified by Node.
194 DevicePathNodeLength (
200 ASSERT (Node
!= NULL
);
201 Length
= ReadUnaligned16 ((UINT16
*)&((EFI_DEVICE_PATH_PROTOCOL
*)(Node
))->Length
[0]);
202 ASSERT (Length
>= sizeof (EFI_DEVICE_PATH_PROTOCOL
));
207 Returns a pointer to the next node in a device path.
209 Returns a pointer to the device path node that follows the device path node
212 If Node is NULL, then ASSERT().
214 @param Node A pointer to a device path node data structure.
216 @return a pointer to the device path node that follows the device path node
220 EFI_DEVICE_PATH_PROTOCOL
*
226 ASSERT (Node
!= NULL
);
227 return (EFI_DEVICE_PATH_PROTOCOL
*)((UINT8
*)(Node
) + DevicePathNodeLength(Node
));
231 Determines if a device path node is an end node of a device path.
232 This includes nodes that are the end of a device path instance and nodes that
233 are the end of an entire device path.
235 Determines if the device path node specified by Node is an end node of a device path.
236 This includes nodes that are the end of a device path instance and nodes that are the
237 end of an entire device path. If Node represents an end node of a device path,
238 then TRUE is returned. Otherwise, FALSE is returned.
240 If Node is NULL, then ASSERT().
242 @param Node A pointer to a device path node data structure.
244 @retval TRUE The device path node specified by Node is an end node of a device path.
245 @retval FALSE The device path node specified by Node is not an end node of
251 IsDevicePathEndType (
255 ASSERT (Node
!= NULL
);
256 return (BOOLEAN
) (DevicePathType (Node
) == END_DEVICE_PATH_TYPE
);
260 Determines if a device path node is an end node of an entire device path.
262 Determines if a device path node specified by Node is an end node of an entire
264 If Node represents the end of an entire device path, then TRUE is returned.
265 Otherwise, FALSE is returned.
267 If Node is NULL, then ASSERT().
269 @param Node A pointer to a device path node data structure.
271 @retval TRUE The device path node specified by Node is the end of an entire device path.
272 @retval FALSE The device path node specified by Node is not the end of an entire device path.
281 ASSERT (Node
!= NULL
);
282 return (BOOLEAN
) (IsDevicePathEndType (Node
) && DevicePathSubType(Node
) == END_ENTIRE_DEVICE_PATH_SUBTYPE
);
286 Determines if a device path node is an end node of a device path instance.
288 Determines if a device path node specified by Node is an end node of a device
290 If Node represents the end of a device path instance, then TRUE is returned.
291 Otherwise, FALSE is returned.
293 If Node is NULL, then ASSERT().
295 @param Node A pointer to a device path node data structure.
297 @retval TRUE The device path node specified by Node is the end of a device
299 @retval FALSE The device path node specified by Node is not the end of a
300 device path instance.
305 IsDevicePathEndInstance (
309 ASSERT (Node
!= NULL
);
310 return (BOOLEAN
) (IsDevicePathEndType (Node
) && DevicePathSubType(Node
) == END_INSTANCE_DEVICE_PATH_SUBTYPE
);
314 Sets the length, in bytes, of a device path node.
316 Sets the length of the device path node specified by Node to the value specified
317 by NodeLength. NodeLength is returned. Node is not required to be aligned on
318 a 16-bit boundary, so it is recommended that a function such as WriteUnaligned16()
319 be used to set the contents of the Length field.
321 If Node is NULL, then ASSERT().
322 If NodeLength >= SIZE_64KB, then ASSERT().
323 If NodeLength < sizeof (EFI_DEVICE_PATH_PROTOCOL), then ASSERT().
325 @param Node A pointer to a device path node data structure.
326 @param Length The length, in bytes, of the device path node.
333 SetDevicePathNodeLength (
338 ASSERT (Node
!= NULL
);
339 ASSERT ((Length
>= sizeof (EFI_DEVICE_PATH_PROTOCOL
)) && (Length
< SIZE_64KB
));
340 return WriteUnaligned16 ((UINT16
*)&((EFI_DEVICE_PATH_PROTOCOL
*)(Node
))->Length
[0], (UINT16
)(Length
));
344 Fills in all the fields of a device path node that is the end of an entire device path.
346 Fills in all the fields of a device path node specified by Node so Node represents
347 the end of an entire device path. The Type field of Node is set to
348 END_DEVICE_PATH_TYPE, the SubType field of Node is set to
349 END_ENTIRE_DEVICE_PATH_SUBTYPE, and the Length field of Node is set to
350 END_DEVICE_PATH_LENGTH. Node is not required to be aligned on a 16-bit boundary,
351 so it is recommended that a function such as WriteUnaligned16() be used to set
352 the contents of the Length field.
354 If Node is NULL, then ASSERT().
356 @param Node A pointer to a device path node data structure.
361 SetDevicePathEndNode (
365 ASSERT (Node
!= NULL
);
366 CopyMem (Node
, &mUefiDevicePathLibEndDevicePath
, sizeof (mUefiDevicePathLibEndDevicePath
));
370 Returns the size of a device path in bytes.
372 This function returns the size, in bytes, of the device path data structure
373 specified by DevicePath including the end of device path node.
374 If DevicePath is NULL or invalid, then 0 is returned.
376 @param DevicePath A pointer to a device path data structure.
378 @retval 0 If DevicePath is NULL or invalid.
379 @retval Others The size of a device path in bytes.
385 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
388 return mDevicePathLibDevicePathUtilities
->GetDevicePathSize (DevicePath
);
392 Creates a new copy of an existing device path.
394 This function allocates space for a new copy of the device path specified by
395 DevicePath. If DevicePath is NULL, then NULL is returned.
396 If the memory is successfully allocated, then the
397 contents of DevicePath are copied to the newly allocated buffer, and a pointer to that buffer
398 is returned. Otherwise, NULL is returned.
399 The memory for the new device path is allocated from EFI boot services memory.
400 It is the responsibility of the caller to free the memory allocated.
402 @param DevicePath A pointer to a device path data structure.
404 @retval NULL If DevicePath is NULL or invalid.
405 @retval Others A pointer to the duplicated device path.
408 EFI_DEVICE_PATH_PROTOCOL
*
410 DuplicateDevicePath (
411 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
414 return mDevicePathLibDevicePathUtilities
->DuplicateDevicePath (DevicePath
);
418 Creates a new device path by appending a second device path to a first device path.
420 This function creates a new device path by appending a copy of SecondDevicePath to a copy of
421 FirstDevicePath in a newly allocated buffer. Only the end-of-device-path device node from
422 SecondDevicePath is retained. The newly created device path is returned.
423 If FirstDevicePath is NULL, then it is ignored, and a duplicate of SecondDevicePath is returned.
424 If SecondDevicePath is NULL, then it is ignored, and a duplicate of FirstDevicePath is returned.
425 If both FirstDevicePath and SecondDevicePath are NULL, then a copy of an end-of-device-path is
427 If there is not enough memory for the newly allocated buffer, then NULL is returned.
428 The memory for the new device path is allocated from EFI boot services memory. It is the
429 responsibility of the caller to free the memory allocated.
431 @param FirstDevicePath A pointer to a device path data structure.
432 @param SecondDevicePath A pointer to a device path data structure.
434 @retval NULL If there is not enough memory for the newly allocated buffer.
435 @retval NULL If FirstDevicePath or SecondDevicePath is invalid.
436 @retval Others A pointer to the new device path if success.
437 Or a copy an end-of-device-path if both FirstDevicePath and
438 SecondDevicePath are NULL.
441 EFI_DEVICE_PATH_PROTOCOL
*
444 IN CONST EFI_DEVICE_PATH_PROTOCOL
*FirstDevicePath
, OPTIONAL
445 IN CONST EFI_DEVICE_PATH_PROTOCOL
*SecondDevicePath OPTIONAL
448 return mDevicePathLibDevicePathUtilities
->AppendDevicePath (FirstDevicePath
, SecondDevicePath
);
452 Creates a new path by appending the device node to the device path.
454 This function creates a new device path by appending a copy of the device node
455 specified by DevicePathNode to a copy of the device path specified by DevicePath
456 in an allocated buffer.
457 The end-of-device-path device node is moved after the end of the appended device node.
458 If DevicePathNode is NULL then a copy of DevicePath is returned.
459 If DevicePath is NULL then a copy of DevicePathNode, followed by an end-of-device
460 path device node is returned.
461 If both DevicePathNode and DevicePath are NULL then a copy of an end-of-device-path
462 device node is returned.
463 If there is not enough memory to allocate space for the new device path, then
465 The memory is allocated from EFI boot services memory. It is the responsibility
466 of the caller to free the memory allocated.
468 @param DevicePath A pointer to a device path data structure.
469 @param DevicePathNode A pointer to a single device path node.
471 @retval NULL If there is not enough memory for the new device path.
472 @retval Others A pointer to the new device path if success.
473 A copy of DevicePathNode followed by an end-of-device-path node
474 if both FirstDevicePath and SecondDevicePath are NULL.
475 A copy of an end-of-device-path node if both FirstDevicePath
476 and SecondDevicePath are NULL.
479 EFI_DEVICE_PATH_PROTOCOL
*
481 AppendDevicePathNode (
482 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
, OPTIONAL
483 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePathNode OPTIONAL
486 return mDevicePathLibDevicePathUtilities
->AppendDeviceNode (DevicePath
, DevicePathNode
);
490 Creates a new device path by appending the specified device path instance to
491 the specified device path.
493 This function creates a new device path by appending a copy of the device path
494 instance specified by DevicePathInstance to a copy of the device path specified
495 by DevicePath in a allocated buffer.
496 The end-of-device-path device node is moved after the end of the appended device
497 path instance and a new end-of-device-path-instance node is inserted between.
498 If DevicePath is NULL, then a copy if DevicePathInstance is returned.
499 If DevicePathInstance is NULL, then NULL is returned.
500 If DevicePath or DevicePathInstance is invalid, then NULL is returned.
501 If there is not enough memory to allocate space for the new device path, then
503 The memory is allocated from EFI boot services memory. It is the responsibility
504 of the caller to free the memory allocated.
506 @param DevicePath A pointer to a device path data structure.
507 @param DevicePathInstance A pointer to a device path instance.
509 @return A pointer to the new device path.
512 EFI_DEVICE_PATH_PROTOCOL
*
514 AppendDevicePathInstance (
515 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
, OPTIONAL
516 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePathInstance OPTIONAL
519 return mDevicePathLibDevicePathUtilities
->AppendDevicePathInstance (DevicePath
, DevicePathInstance
);
523 Creates a copy of the current device path instance and returns a pointer to the
524 next device path instance.
526 This function creates a copy of the current device path instance. It also updates
527 DevicePath to point to the next device path instance in the device path (or NULL
528 if no more) and updates Size to hold the size of the device path instance copy.
529 If DevicePath is NULL, then NULL is returned.
530 If there is not enough memory to allocate space for the new device path, then
532 The memory is allocated from EFI boot services memory. It is the responsibility
533 of the caller to free the memory allocated.
534 If Size is NULL, then ASSERT().
536 @param DevicePath On input, this holds the pointer to the current
537 device path instance. On output, this holds
538 the pointer to the next device path instance
539 or NULL if there are no more device path
540 instances in the device path pointer to a
541 device path data structure.
542 @param Size On output, this holds the size of the device
543 path instance, in bytes or zero, if DevicePath
546 @return A pointer to the current device path instance.
549 EFI_DEVICE_PATH_PROTOCOL
*
551 GetNextDevicePathInstance (
552 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevicePath
,
556 ASSERT (Size
!= NULL
);
557 return mDevicePathLibDevicePathUtilities
->GetNextDevicePathInstance (DevicePath
, Size
);
561 Creates a device node.
563 This function creates a new device node in a newly allocated buffer of size
564 NodeLength and initializes the device path node header with NodeType and NodeSubType.
565 The new device path node is returned.
566 If NodeLength is smaller than a device path header, then NULL is returned.
567 If there is not enough memory to allocate space for the new device path, then
569 The memory is allocated from EFI boot services memory. It is the responsibility
571 free the memory allocated.
573 @param NodeType The device node type for the new device node.
574 @param NodeSubType The device node sub-type for the new device node.
575 @param NodeLength The length of the new device node.
577 @return The new device path.
580 EFI_DEVICE_PATH_PROTOCOL
*
584 IN UINT8 NodeSubType
,
588 return mDevicePathLibDevicePathUtilities
->CreateDeviceNode (NodeType
, NodeSubType
, NodeLength
);
592 Determines if a device path is single or multi-instance.
594 This function returns TRUE if the device path specified by DevicePath is
596 Otherwise, FALSE is returned.
597 If DevicePath is NULL or invalid, then FALSE is returned.
599 @param DevicePath A pointer to a device path data structure.
601 @retval TRUE DevicePath is multi-instance.
602 @retval FALSE DevicePath is not multi-instance, or DevicePath
608 IsDevicePathMultiInstance (
609 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
612 return mDevicePathLibDevicePathUtilities
->IsDevicePathMultiInstance (DevicePath
);
616 Retrieves the device path protocol from a handle.
618 This function returns the device path protocol from the handle specified by Handle.
619 If Handle is NULL or Handle does not contain a device path protocol, then NULL
622 @param Handle The handle from which to retrieve the device
625 @return The device path protocol from the handle specified by Handle.
628 EFI_DEVICE_PATH_PROTOCOL
*
630 DevicePathFromHandle (
634 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
637 Status
= gBS
->HandleProtocol (
639 &gEfiDevicePathProtocolGuid
,
642 if (EFI_ERROR (Status
)) {
649 Allocates a device path for a file and appends it to an existing device path.
651 If Device is a valid device handle that contains a device path protocol, then
652 a device path for the file specified by FileName is allocated and appended to
653 the device path associated with the handle Device. The allocated device path
654 is returned. If Device is NULL or Device is a handle that does not support the
655 device path protocol, then a device path containing a single device path node
656 for the file specified by FileName is allocated and returned.
657 The memory for the new device path is allocated from EFI boot services memory.
658 It is the responsibility of the caller to free the memory allocated.
660 If FileName is NULL, then ASSERT().
661 If FileName is not aligned on a 16-bit boundary, then ASSERT().
663 @param Device A pointer to a device handle. This parameter
664 is optional and may be NULL.
665 @param FileName A pointer to a Null-terminated Unicode string.
667 @return The allocated device path.
670 EFI_DEVICE_PATH_PROTOCOL
*
673 IN EFI_HANDLE Device
, OPTIONAL
674 IN CONST CHAR16
*FileName
678 FILEPATH_DEVICE_PATH
*FilePath
;
679 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
680 EFI_DEVICE_PATH_PROTOCOL
*FileDevicePath
;
684 Size
= StrSize (FileName
);
685 FileDevicePath
= AllocatePool (Size
+ SIZE_OF_FILEPATH_DEVICE_PATH
+ END_DEVICE_PATH_LENGTH
);
686 if (FileDevicePath
!= NULL
) {
687 FilePath
= (FILEPATH_DEVICE_PATH
*) FileDevicePath
;
688 FilePath
->Header
.Type
= MEDIA_DEVICE_PATH
;
689 FilePath
->Header
.SubType
= MEDIA_FILEPATH_DP
;
690 CopyMem (&FilePath
->PathName
, FileName
, Size
);
691 SetDevicePathNodeLength (&FilePath
->Header
, Size
+ SIZE_OF_FILEPATH_DEVICE_PATH
);
692 SetDevicePathEndNode (NextDevicePathNode (&FilePath
->Header
));
694 if (Device
!= NULL
) {
695 DevicePath
= DevicePathFromHandle (Device
);
698 DevicePath
= AppendDevicePath (DevicePath
, FileDevicePath
);
699 FreePool (FileDevicePath
);
706 Locate and return the protocol instance identified by the ProtocolGuid.
708 @param ProtocolGuid The GUID of the protocol.
710 @return A pointer to the protocol instance or NULL when absent.
713 UefiDevicePathLibLocateProtocol (
714 EFI_GUID
*ProtocolGuid
719 Status
= gBS
->LocateProtocol (
724 if (EFI_ERROR (Status
)) {
732 Converts a device node to its string representation.
734 @param DeviceNode A Pointer to the device node to be converted.
735 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
736 of the display node is used, where applicable. If DisplayOnly
737 is FALSE, then the longer text representation of the display node
739 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
740 representation for a device node can be used, where applicable.
742 @return A pointer to the allocated text representation of the device node or NULL if DeviceNode
743 is NULL or there was insufficient memory.
748 ConvertDeviceNodeToText (
749 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DeviceNode
,
750 IN BOOLEAN DisplayOnly
,
751 IN BOOLEAN AllowShortcuts
754 if (mDevicePathLibDevicePathToText
== NULL
) {
755 mDevicePathLibDevicePathToText
= UefiDevicePathLibLocateProtocol (&gEfiDevicePathToTextProtocolGuid
);
757 if (mDevicePathLibDevicePathToText
!= NULL
) {
758 return mDevicePathLibDevicePathToText
->ConvertDeviceNodeToText (DeviceNode
, DisplayOnly
, AllowShortcuts
);
765 Converts a device path to its text representation.
767 @param DevicePath A Pointer to the device to be converted.
768 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
769 of the display node is used, where applicable. If DisplayOnly
770 is FALSE, then the longer text representation of the display node
772 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
773 representation for a device node can be used, where applicable.
775 @return A pointer to the allocated text representation of the device path or
776 NULL if DeviceNode is NULL or there was insufficient memory.
781 ConvertDevicePathToText (
782 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
783 IN BOOLEAN DisplayOnly
,
784 IN BOOLEAN AllowShortcuts
787 if (mDevicePathLibDevicePathToText
== NULL
) {
788 mDevicePathLibDevicePathToText
= UefiDevicePathLibLocateProtocol (&gEfiDevicePathToTextProtocolGuid
);
790 if (mDevicePathLibDevicePathToText
!= NULL
) {
791 return mDevicePathLibDevicePathToText
->ConvertDevicePathToText (DevicePath
, DisplayOnly
, AllowShortcuts
);
798 Convert text to the binary representation of a device node.
800 @param TextDeviceNode TextDeviceNode points to the text representation of a device
801 node. Conversion starts with the first character and continues
802 until the first non-device node character.
804 @return A pointer to the EFI device node or NULL if TextDeviceNode is NULL or there was
805 insufficient memory or text unsupported.
808 EFI_DEVICE_PATH_PROTOCOL
*
810 ConvertTextToDeviceNode (
811 IN CONST CHAR16
*TextDeviceNode
814 if (mDevicePathLibDevicePathFromText
== NULL
) {
815 mDevicePathLibDevicePathFromText
= UefiDevicePathLibLocateProtocol (&gEfiDevicePathFromTextProtocolGuid
);
817 if (mDevicePathLibDevicePathFromText
!= NULL
) {
818 return mDevicePathLibDevicePathFromText
->ConvertTextToDeviceNode (TextDeviceNode
);
825 Convert text to the binary representation of a device path.
828 @param TextDevicePath TextDevicePath points to the text representation of a device
829 path. Conversion starts with the first character and continues
830 until the first non-device node character.
832 @return A pointer to the allocated device path or NULL if TextDeviceNode is NULL or
833 there was insufficient memory.
836 EFI_DEVICE_PATH_PROTOCOL
*
838 ConvertTextToDevicePath (
839 IN CONST CHAR16
*TextDevicePath
842 if (mDevicePathLibDevicePathFromText
== NULL
) {
843 mDevicePathLibDevicePathFromText
= UefiDevicePathLibLocateProtocol (&gEfiDevicePathFromTextProtocolGuid
);
845 if (mDevicePathLibDevicePathFromText
!= NULL
) {
846 return mDevicePathLibDevicePathFromText
->ConvertTextToDevicePath (TextDevicePath
);