2 DevicePathToText protocol as defined in the UEFI 2.0 specification.
4 Copyright (c) 2006 - 2008, Intel Corporation. <BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "DevicePath.h"
18 Concatenates a formatted unicode string to allocated pool. The caller must
19 free the resulting buffer.
21 @param Str Tracks the allocated pool, size in use, and
22 amount of pool allocated.
23 @param Fmt The format string
24 @param ... Variable arguments based on the format string.
26 @return Allocated buffer with the formatted string printed in it.
27 The caller must free the allocated buffer. The buffer
28 allocation is not packed.
33 IN OUT POOL_PRINT
*Str
,
42 AppendStr
= AllocateZeroPool (0x1000);
43 if (AppendStr
== NULL
) {
48 UnicodeVSPrint (AppendStr
, 0x1000, Fmt
, Args
);
50 if (NULL
== Str
->Str
) {
51 Size
= StrSize (AppendStr
);
52 Str
->Str
= AllocateZeroPool (Size
);
53 ASSERT (Str
->Str
!= NULL
);
55 Size
= StrSize (AppendStr
) - sizeof (UINT16
);
56 Size
= Size
+ StrSize (Str
->Str
);
57 Str
->Str
= ReallocatePool (
62 ASSERT (Str
->Str
!= NULL
);
65 Str
->MaxLen
= MAX_CHAR
* sizeof (UINT16
);
66 if (Size
< Str
->MaxLen
) {
67 StrCat (Str
->Str
, AppendStr
);
68 Str
->Len
= Size
- sizeof (UINT16
);
76 Converts a PCI device path structure to its string representative.
78 @param Str The string representative of input device.
79 @param DevPath The input device path structure.
80 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
81 of the display node is used, where applicable. If DisplayOnly
82 is FALSE, then the longer text representation of the display node
84 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
85 representation for a device node can be used, where applicable.
90 IN OUT POOL_PRINT
*Str
,
92 IN BOOLEAN DisplayOnly
,
93 IN BOOLEAN AllowShortcuts
99 CatPrint (Str
, L
"Pci(0x%x,0x%x)", (UINTN
) Pci
->Device
, (UINTN
) Pci
->Function
);
103 Converts a PC Card device path structure to its string representative.
105 @param Str The string representative of input device.
106 @param DevPath The input device path structure.
107 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
108 of the display node is used, where applicable. If DisplayOnly
109 is FALSE, then the longer text representation of the display node
111 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
112 representation for a device node can be used, where applicable.
116 DevPathToTextPccard (
117 IN OUT POOL_PRINT
*Str
,
119 IN BOOLEAN DisplayOnly
,
120 IN BOOLEAN AllowShortcuts
123 PCCARD_DEVICE_PATH
*Pccard
;
126 CatPrint (Str
, L
"PcCard(0x%x)", (UINTN
) Pccard
->FunctionNumber
);
130 Converts a Memory Map device path structure to its string representative.
132 @param Str The string representative of input device.
133 @param DevPath The input device path structure.
134 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
135 of the display node is used, where applicable. If DisplayOnly
136 is FALSE, then the longer text representation of the display node
138 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
139 representation for a device node can be used, where applicable.
143 DevPathToTextMemMap (
144 IN OUT POOL_PRINT
*Str
,
146 IN BOOLEAN DisplayOnly
,
147 IN BOOLEAN AllowShortcuts
150 MEMMAP_DEVICE_PATH
*MemMap
;
155 L
"MemoryMapped(0x%x,0x%lx,0x%lx)",
156 (UINTN
) MemMap
->MemoryType
,
157 MemMap
->StartingAddress
,
158 MemMap
->EndingAddress
163 Converts a Vendor device path structure to its string representative.
165 @param Str The string representative of input device.
166 @param DevPath The input device path structure.
167 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
168 of the display node is used, where applicable. If DisplayOnly
169 is FALSE, then the longer text representation of the display node
171 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
172 representation for a device node can be used, where applicable.
176 DevPathToTextVendor (
177 IN OUT POOL_PRINT
*Str
,
179 IN BOOLEAN DisplayOnly
,
180 IN BOOLEAN AllowShortcuts
183 VENDOR_DEVICE_PATH
*Vendor
;
187 UINT32 FlowControlMap
;
190 Vendor
= (VENDOR_DEVICE_PATH
*) DevPath
;
191 switch (DevicePathType (&Vendor
->Header
)) {
192 case HARDWARE_DEVICE_PATH
:
196 case MESSAGING_DEVICE_PATH
:
198 if (AllowShortcuts
) {
199 if (CompareGuid (&Vendor
->Guid
, &gEfiPcAnsiGuid
)) {
200 CatPrint (Str
, L
"VenPcAnsi()");
202 } else if (CompareGuid (&Vendor
->Guid
, &gEfiVT100Guid
)) {
203 CatPrint (Str
, L
"VenVt100()");
205 } else if (CompareGuid (&Vendor
->Guid
, &gEfiVT100PlusGuid
)) {
206 CatPrint (Str
, L
"VenVt100Plus()");
208 } else if (CompareGuid (&Vendor
->Guid
, &gEfiVTUTF8Guid
)) {
209 CatPrint (Str
, L
"VenUft8()");
211 } else if (CompareGuid (&Vendor
->Guid
, &gEfiUartDevicePathGuid
)) {
212 FlowControlMap
= (((UART_FLOW_CONTROL_DEVICE_PATH
*) Vendor
)->FlowControlMap
);
213 switch (FlowControlMap
& 0x00000003) {
215 CatPrint (Str
, L
"UartFlowCtrl(%s)", L
"None");
219 CatPrint (Str
, L
"UartFlowCtrl(%s)", L
"Hardware");
223 CatPrint (Str
, L
"UartFlowCtrl(%s)", L
"XonXoff");
231 } else if (CompareGuid (&Vendor
->Guid
, &gEfiSasDevicePathGuid
)) {
234 L
"SAS(0x%lx,0x%lx,0x%x,",
235 ((SAS_DEVICE_PATH
*) Vendor
)->SasAddress
,
236 ((SAS_DEVICE_PATH
*) Vendor
)->Lun
,
237 (UINTN
) ((SAS_DEVICE_PATH
*) Vendor
)->RelativeTargetPort
239 Info
= (((SAS_DEVICE_PATH
*) Vendor
)->DeviceTopology
);
240 if ((Info
& 0x0f) == 0) {
241 CatPrint (Str
, L
"NoTopology,0,0,0,");
242 } else if (((Info
& 0x0f) == 1) || ((Info
& 0x0f) == 2)) {
246 ((Info
& (0x1 << 4)) != 0) ? L
"SATA" : L
"SAS",
247 ((Info
& (0x1 << 5)) != 0) ? L
"External" : L
"Internal",
248 ((Info
& (0x1 << 6)) != 0) ? L
"Expanded" : L
"Direct"
250 if ((Info
& 0x0f) == 1) {
251 CatPrint (Str
, L
"0,");
253 CatPrint (Str
, L
"0x%x,",(UINTN
) (Info
>> 8) & 0xff);
256 CatPrint (Str
, L
"0,0,0,0,");
259 CatPrint (Str
, L
"0x%x)", (UINTN
) ((SAS_DEVICE_PATH
*) Vendor
)->Reserved
);
261 } else if (CompareGuid (&Vendor
->Guid
, &gEfiDebugPortProtocolGuid
)) {
262 CatPrint (Str
, L
"DebugPort()");
268 case MEDIA_DEVICE_PATH
:
277 DataLength
= DevicePathNodeLength (&Vendor
->Header
) - sizeof (VENDOR_DEVICE_PATH
);
278 CatPrint (Str
, L
"Ven%s(%g", Type
, &Vendor
->Guid
);
279 if (DataLength
!= 0) {
280 CatPrint (Str
, L
",");
281 for (Index
= 0; Index
< DataLength
; Index
++) {
282 CatPrint (Str
, L
"%02x", (UINTN
) ((VENDOR_DEVICE_PATH_WITH_DATA
*) Vendor
)->VendorDefinedData
[Index
]);
286 CatPrint (Str
, L
")");
290 Converts a Controller device path structure to its string representative.
292 @param Str The string representative of input device.
293 @param DevPath The input device path structure.
294 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
295 of the display node is used, where applicable. If DisplayOnly
296 is FALSE, then the longer text representation of the display node
298 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
299 representation for a device node can be used, where applicable.
303 DevPathToTextController (
304 IN OUT POOL_PRINT
*Str
,
306 IN BOOLEAN DisplayOnly
,
307 IN BOOLEAN AllowShortcuts
310 CONTROLLER_DEVICE_PATH
*Controller
;
312 Controller
= DevPath
;
316 (UINTN
) Controller
->ControllerNumber
321 Converts a ACPI device path structure to its string representative.
323 @param Str The string representative of input device.
324 @param DevPath The input device path structure.
325 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
326 of the display node is used, where applicable. If DisplayOnly
327 is FALSE, then the longer text representation of the display node
329 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
330 representation for a device node can be used, where applicable.
335 IN OUT POOL_PRINT
*Str
,
337 IN BOOLEAN DisplayOnly
,
338 IN BOOLEAN AllowShortcuts
341 ACPI_HID_DEVICE_PATH
*Acpi
;
344 if ((Acpi
->HID
& PNP_EISA_ID_MASK
) == PNP_EISA_ID_CONST
) {
345 switch (EISA_ID_TO_NUM (Acpi
->HID
)) {
347 CatPrint (Str
, L
"PciRoot(0x%x)", (UINTN
) Acpi
->UID
);
351 CatPrint (Str
, L
"Floppy(0x%x)", (UINTN
) Acpi
->UID
);
355 CatPrint (Str
, L
"Keyboard(0x%x)", (UINTN
) Acpi
->UID
);
359 CatPrint (Str
, L
"Serial(0x%x)", (UINTN
) Acpi
->UID
);
363 CatPrint (Str
, L
"ParallelPort(0x%x)", (UINTN
) Acpi
->UID
);
367 CatPrint (Str
, L
"Acpi(PNP%04x,0x%x)", (UINTN
) EISA_ID_TO_NUM (Acpi
->HID
), (UINTN
) Acpi
->UID
);
371 CatPrint (Str
, L
"Acpi(0x%08x,0x%x)", (UINTN
) Acpi
->HID
, (UINTN
) Acpi
->UID
);
376 Converts EISA identification to string.
378 @param EisaId The input EISA identification.
379 @param Text A pointer to the output string.
391 //UnicodeSPrint ("%X", 0x0a03) => "0000000000000A03"
393 UnicodeSPrint (PnpIdStr
, 17 * 2, L
"%16X", EisaId
>> 16);
397 sizeof (CHAR16
) + sizeof (CHAR16
) + sizeof (CHAR16
) + sizeof (PnpIdStr
),
399 '@' + ((EisaId
>> 10) & 0x1f),
400 '@' + ((EisaId
>> 5) & 0x1f),
401 '@' + ((EisaId
>> 0) & 0x1f),
407 Converts a ACPI extended HID device path structure to its string representative.
409 @param Str The string representative of input device.
410 @param DevPath The input device path structure.
411 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
412 of the display node is used, where applicable. If DisplayOnly
413 is FALSE, then the longer text representation of the display node
415 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
416 representation for a device node can be used, where applicable.
420 DevPathToTextAcpiEx (
421 IN OUT POOL_PRINT
*Str
,
423 IN BOOLEAN DisplayOnly
,
424 IN BOOLEAN AllowShortcuts
427 ACPI_EXTENDED_HID_DEVICE_PATH
*AcpiEx
;
435 HIDStr
= (CHAR8
*) (((UINT8
*) AcpiEx
) + sizeof (ACPI_EXTENDED_HID_DEVICE_PATH
));
436 UIDStr
= HIDStr
+ AsciiStrLen (HIDStr
) + 1;
437 CIDStr
= UIDStr
+ AsciiStrLen (UIDStr
) + 1;
439 EisaIdToText (AcpiEx
->HID
, HIDText
);
440 EisaIdToText (AcpiEx
->CID
, CIDText
);
442 if ((*HIDStr
== '\0') && (*CIDStr
== '\0') && (AcpiEx
->UID
== 0)) {
448 L
"AcpiExp(%s,%s,%a)",
454 if (AllowShortcuts
) {
458 if (AcpiEx
->HID
== 0) {
459 CatPrint (Str
, L
"AcpiEx(%a,", HIDStr
);
461 CatPrint (Str
, L
"AcpiEx(%s,", HIDText
);
464 if (AcpiEx
->UID
== 0) {
465 CatPrint (Str
, L
"%a,", UIDStr
);
467 CatPrint (Str
, L
"0x%x,", (UINTN
) AcpiEx
->UID
);
470 if (AcpiEx
->CID
== 0) {
471 CatPrint (Str
, L
"%a)", CIDStr
);
473 CatPrint (Str
, L
"%s)", CIDText
);
478 L
"AcpiEx(%s,%s,0x%x,%a,%a,%a)",
491 Converts a ACPI address device path structure to its string representative.
493 @param Str The string representative of input device.
494 @param DevPath The input device path structure.
495 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
496 of the display node is used, where applicable. If DisplayOnly
497 is FALSE, then the longer text representation of the display node
499 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
500 representation for a device node can be used, where applicable.
504 DevPathToTextAcpiAdr (
505 IN OUT POOL_PRINT
*Str
,
507 IN BOOLEAN DisplayOnly
,
508 IN BOOLEAN AllowShortcuts
511 ACPI_ADR_DEVICE_PATH
*AcpiAdr
;
514 UINT16 AdditionalAdrCount
;
517 Length
= (UINT16
) DevicePathNodeLength ((EFI_DEVICE_PATH_PROTOCOL
*) AcpiAdr
);
518 AdditionalAdrCount
= (UINT16
) ((Length
- 8) / 4);
520 CatPrint (Str
, L
"AcpiAdr(0x%x", (UINTN
) AcpiAdr
->ADR
);
521 for (Index
= 0; Index
< AdditionalAdrCount
; Index
++) {
522 CatPrint (Str
, L
",0x%x", (UINTN
) *(UINT32
*) ((UINT8
*) AcpiAdr
+ 8 + Index
* 4));
524 CatPrint (Str
, L
")");
528 Converts a ATAPI device path structure to its string representative.
530 @param Str The string representative of input device.
531 @param DevPath The input device path structure.
532 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
533 of the display node is used, where applicable. If DisplayOnly
534 is FALSE, then the longer text representation of the display node
536 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
537 representation for a device node can be used, where applicable.
542 IN OUT POOL_PRINT
*Str
,
544 IN BOOLEAN DisplayOnly
,
545 IN BOOLEAN AllowShortcuts
548 ATAPI_DEVICE_PATH
*Atapi
;
553 CatPrint (Str
, L
"Ata(0x%x)", (UINTN
) Atapi
->Lun
);
558 (Atapi
->PrimarySecondary
== 1) ? L
"Secondary" : L
"Primary",
559 (Atapi
->SlaveMaster
== 1) ? L
"Slave" : L
"Master",
566 Converts a SCSI device path structure to its string representative.
568 @param Str The string representative of input device.
569 @param DevPath The input device path structure.
570 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
571 of the display node is used, where applicable. If DisplayOnly
572 is FALSE, then the longer text representation of the display node
574 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
575 representation for a device node can be used, where applicable.
580 IN OUT POOL_PRINT
*Str
,
582 IN BOOLEAN DisplayOnly
,
583 IN BOOLEAN AllowShortcuts
586 SCSI_DEVICE_PATH
*Scsi
;
589 CatPrint (Str
, L
"Scsi(0x%x,0x%x)", (UINTN
) Scsi
->Pun
, (UINTN
) Scsi
->Lun
);
593 Converts a Fibre device path structure to its string representative.
595 @param Str The string representative of input device.
596 @param DevPath The input device path structure.
597 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
598 of the display node is used, where applicable. If DisplayOnly
599 is FALSE, then the longer text representation of the display node
601 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
602 representation for a device node can be used, where applicable.
607 IN OUT POOL_PRINT
*Str
,
609 IN BOOLEAN DisplayOnly
,
610 IN BOOLEAN AllowShortcuts
613 FIBRECHANNEL_DEVICE_PATH
*Fibre
;
616 CatPrint (Str
, L
"Fibre(0x%lx,0x%lx)", Fibre
->WWN
, Fibre
->Lun
);
620 Converts a 1394 device path structure to its string representative.
622 @param Str The string representative of input device.
623 @param DevPath The input device path structure.
624 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
625 of the display node is used, where applicable. If DisplayOnly
626 is FALSE, then the longer text representation of the display node
628 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
629 representation for a device node can be used, where applicable.
634 IN OUT POOL_PRINT
*Str
,
636 IN BOOLEAN DisplayOnly
,
637 IN BOOLEAN AllowShortcuts
640 F1394_DEVICE_PATH
*F1394DevPath
;
642 F1394DevPath
= DevPath
;
644 // Guid has format of IEEE-EUI64
646 CatPrint (Str
, L
"I1394(%016lx)", F1394DevPath
->Guid
);
650 Converts a USB device path structure to its string representative.
652 @param Str The string representative of input device.
653 @param DevPath The input device path structure.
654 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
655 of the display node is used, where applicable. If DisplayOnly
656 is FALSE, then the longer text representation of the display node
658 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
659 representation for a device node can be used, where applicable.
664 IN OUT POOL_PRINT
*Str
,
666 IN BOOLEAN DisplayOnly
,
667 IN BOOLEAN AllowShortcuts
670 USB_DEVICE_PATH
*Usb
;
673 CatPrint (Str
, L
"USB(0x%x,0x%x)", Usb
->ParentPortNumber
, Usb
->InterfaceNumber
);
677 Converts a USB WWID device path structure to its string representative.
679 @param Str The string representative of input device.
680 @param DevPath The input device path structure.
681 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
682 of the display node is used, where applicable. If DisplayOnly
683 is FALSE, then the longer text representation of the display node
685 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
686 representation for a device node can be used, where applicable.
690 DevPathToTextUsbWWID (
691 IN OUT POOL_PRINT
*Str
,
693 IN BOOLEAN DisplayOnly
,
694 IN BOOLEAN AllowShortcuts
697 USB_WWID_DEVICE_PATH
*UsbWWId
;
698 CHAR16
*SerialNumberStr
;
704 SerialNumberStr
= (CHAR16
*) ((UINT8
*) UsbWWId
+ sizeof (USB_WWID_DEVICE_PATH
));
705 Length
= (UINT16
) ((DevicePathNodeLength ((EFI_DEVICE_PATH_PROTOCOL
*) UsbWWId
) - sizeof (USB_WWID_DEVICE_PATH
)) / sizeof (CHAR16
));
706 if (SerialNumberStr
[Length
- 1] != 0) {
708 // In case no NULL terminator in SerialNumber, create a new one with NULL terminator
710 NewStr
= AllocateCopyPool ((Length
+ 1) * sizeof (CHAR16
), SerialNumberStr
);
711 ASSERT (NewStr
!= NULL
);
713 SerialNumberStr
= NewStr
;
718 L
"UsbWwid(0x%x,0x%x,0x%x,\"%s\")",
719 (UINTN
) UsbWWId
->VendorId
,
720 (UINTN
) UsbWWId
->ProductId
,
721 (UINTN
) UsbWWId
->InterfaceNumber
,
727 Converts a Logic Unit device path structure to its string representative.
729 @param Str The string representative of input device.
730 @param DevPath The input device path structure.
731 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
732 of the display node is used, where applicable. If DisplayOnly
733 is FALSE, then the longer text representation of the display node
735 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
736 representation for a device node can be used, where applicable.
740 DevPathToTextLogicalUnit (
741 IN OUT POOL_PRINT
*Str
,
743 IN BOOLEAN DisplayOnly
,
744 IN BOOLEAN AllowShortcuts
747 DEVICE_LOGICAL_UNIT_DEVICE_PATH
*LogicalUnit
;
749 LogicalUnit
= DevPath
;
750 CatPrint (Str
, L
"Unit(0x%x)", (UINTN
) LogicalUnit
->Lun
);
754 Converts a USB class device path structure to its string representative.
756 @param Str The string representative of input device.
757 @param DevPath The input device path structure.
758 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
759 of the display node is used, where applicable. If DisplayOnly
760 is FALSE, then the longer text representation of the display node
762 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
763 representation for a device node can be used, where applicable.
767 DevPathToTextUsbClass (
768 IN OUT POOL_PRINT
*Str
,
770 IN BOOLEAN DisplayOnly
,
771 IN BOOLEAN AllowShortcuts
774 USB_CLASS_DEVICE_PATH
*UsbClass
;
775 BOOLEAN IsKnownSubClass
;
780 IsKnownSubClass
= TRUE
;
781 switch (UsbClass
->DeviceClass
) {
782 case USB_CLASS_AUDIO
:
783 CatPrint (Str
, L
"UsbAudio");
786 case USB_CLASS_CDCCONTROL
:
787 CatPrint (Str
, L
"UsbCDCControl");
791 CatPrint (Str
, L
"UsbHID");
794 case USB_CLASS_IMAGE
:
795 CatPrint (Str
, L
"UsbImage");
798 case USB_CLASS_PRINTER
:
799 CatPrint (Str
, L
"UsbPrinter");
802 case USB_CLASS_MASS_STORAGE
:
803 CatPrint (Str
, L
"UsbMassStorage");
807 CatPrint (Str
, L
"UsbHub");
810 case USB_CLASS_CDCDATA
:
811 CatPrint (Str
, L
"UsbCDCData");
814 case USB_CLASS_SMART_CARD
:
815 CatPrint (Str
, L
"UsbSmartCard");
818 case USB_CLASS_VIDEO
:
819 CatPrint (Str
, L
"UsbVideo");
822 case USB_CLASS_DIAGNOSTIC
:
823 CatPrint (Str
, L
"UsbDiagnostic");
826 case USB_CLASS_WIRELESS
:
827 CatPrint (Str
, L
"UsbWireless");
831 IsKnownSubClass
= FALSE
;
835 if (IsKnownSubClass
) {
838 L
"(0x%x,0x%x,0x%x,0x%x)",
839 (UINTN
) UsbClass
->VendorId
,
840 (UINTN
) UsbClass
->ProductId
,
841 (UINTN
) UsbClass
->DeviceSubClass
,
842 (UINTN
) UsbClass
->DeviceProtocol
847 if (UsbClass
->DeviceClass
== USB_CLASS_RESERVE
) {
848 if (UsbClass
->DeviceSubClass
== USB_SUBCLASS_FW_UPDATE
) {
851 L
"UsbDeviceFirmwareUpdate(0x%x,0x%x,0x%x)",
852 (UINTN
) UsbClass
->VendorId
,
853 (UINTN
) UsbClass
->ProductId
,
854 (UINTN
) UsbClass
->DeviceProtocol
857 } else if (UsbClass
->DeviceSubClass
== USB_SUBCLASS_IRDA_BRIDGE
) {
860 L
"UsbIrdaBridge(0x%x,0x%x,0x%x)",
861 (UINTN
) UsbClass
->VendorId
,
862 (UINTN
) UsbClass
->ProductId
,
863 (UINTN
) UsbClass
->DeviceProtocol
866 } else if (UsbClass
->DeviceSubClass
== USB_SUBCLASS_TEST
) {
869 L
"UsbTestAndMeasurement(0x%x,0x%x,0x%x)",
870 (UINTN
) UsbClass
->VendorId
,
871 (UINTN
) UsbClass
->ProductId
,
872 (UINTN
) UsbClass
->DeviceProtocol
880 L
"UsbClass(0x%x,0x%x,0x%x,0x%x,0x%x)",
881 (UINTN
) UsbClass
->VendorId
,
882 (UINTN
) UsbClass
->ProductId
,
883 (UINTN
) UsbClass
->DeviceClass
,
884 (UINTN
) UsbClass
->DeviceSubClass
,
885 (UINTN
) UsbClass
->DeviceProtocol
890 Converts a SATA device path structure to its string representative.
892 @param Str The string representative of input device.
893 @param DevPath The input device path structure.
894 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
895 of the display node is used, where applicable. If DisplayOnly
896 is FALSE, then the longer text representation of the display node
898 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
899 representation for a device node can be used, where applicable.
904 IN OUT POOL_PRINT
*Str
,
906 IN BOOLEAN DisplayOnly
,
907 IN BOOLEAN AllowShortcuts
910 SATA_DEVICE_PATH
*Sata
;
913 if (Sata
->PortMultiplierPortNumber
& SATA_HBA_DIRECT_CONNECT_FLAG
) {
917 (UINTN
) Sata
->HBAPortNumber
,
923 L
"Sata(0x%x,0x%x,0x%x)",
924 (UINTN
) Sata
->HBAPortNumber
,
925 (UINTN
) Sata
->PortMultiplierPortNumber
,
932 Converts a I20 device path structure to its string representative.
934 @param Str The string representative of input device.
935 @param DevPath The input device path structure.
936 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
937 of the display node is used, where applicable. If DisplayOnly
938 is FALSE, then the longer text representation of the display node
940 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
941 representation for a device node can be used, where applicable.
946 IN OUT POOL_PRINT
*Str
,
948 IN BOOLEAN DisplayOnly
,
949 IN BOOLEAN AllowShortcuts
952 I2O_DEVICE_PATH
*I2ODevPath
;
954 I2ODevPath
= DevPath
;
955 CatPrint (Str
, L
"I2O(0x%x)", (UINTN
) I2ODevPath
->Tid
);
959 Converts a MAC address device path structure to its string representative.
961 @param Str The string representative of input device.
962 @param DevPath The input device path structure.
963 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
964 of the display node is used, where applicable. If DisplayOnly
965 is FALSE, then the longer text representation of the display node
967 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
968 representation for a device node can be used, where applicable.
972 DevPathToTextMacAddr (
973 IN OUT POOL_PRINT
*Str
,
975 IN BOOLEAN DisplayOnly
,
976 IN BOOLEAN AllowShortcuts
979 MAC_ADDR_DEVICE_PATH
*MacDevPath
;
983 MacDevPath
= DevPath
;
985 HwAddressSize
= sizeof (EFI_MAC_ADDRESS
);
986 if (MacDevPath
->IfType
== 0x01 || MacDevPath
->IfType
== 0x00) {
990 CatPrint (Str
, L
"MAC(");
992 for (Index
= 0; Index
< HwAddressSize
; Index
++) {
993 CatPrint (Str
, L
"%02x", (UINTN
) MacDevPath
->MacAddress
.Addr
[Index
]);
996 CatPrint (Str
, L
",0x%x)", (UINTN
) MacDevPath
->IfType
);
1000 Converts a IPv4 device path structure to its string representative.
1002 @param Str The string representative of input device.
1003 @param DevPath The input device path structure.
1004 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
1005 of the display node is used, where applicable. If DisplayOnly
1006 is FALSE, then the longer text representation of the display node
1008 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
1009 representation for a device node can be used, where applicable.
1014 IN OUT POOL_PRINT
*Str
,
1016 IN BOOLEAN DisplayOnly
,
1017 IN BOOLEAN AllowShortcuts
1020 IPv4_DEVICE_PATH
*IPDevPath
;
1022 IPDevPath
= DevPath
;
1026 L
"IPv4(%d.%d.%d.%d)",
1027 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[0],
1028 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[1],
1029 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[2],
1030 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[3]
1037 L
"IPv4(%d.%d.%d.%d,%s,%s,%d.%d.%d.%d)",
1038 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[0],
1039 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[1],
1040 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[2],
1041 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[3],
1042 (IPDevPath
->Protocol
== 1) ? L
"TCP" : L
"UDP",
1043 IPDevPath
->StaticIpAddress
? L
"Static" : L
"DHCP",
1044 (UINTN
) IPDevPath
->LocalIpAddress
.Addr
[0],
1045 (UINTN
) IPDevPath
->LocalIpAddress
.Addr
[1],
1046 (UINTN
) IPDevPath
->LocalIpAddress
.Addr
[2],
1047 (UINTN
) IPDevPath
->LocalIpAddress
.Addr
[3]
1052 Converts a IPv6 device path structure to its string representative.
1054 @param Str The string representative of input device.
1055 @param DevPath The input device path structure.
1056 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
1057 of the display node is used, where applicable. If DisplayOnly
1058 is FALSE, then the longer text representation of the display node
1060 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
1061 representation for a device node can be used, where applicable.
1066 IN OUT POOL_PRINT
*Str
,
1068 IN BOOLEAN DisplayOnly
,
1069 IN BOOLEAN AllowShortcuts
1072 IPv6_DEVICE_PATH
*IPDevPath
;
1074 IPDevPath
= DevPath
;
1078 L
"IPv6(%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x)",
1079 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[0],
1080 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[1],
1081 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[2],
1082 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[3],
1083 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[4],
1084 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[5],
1085 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[6],
1086 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[7],
1087 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[8],
1088 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[9],
1089 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[10],
1090 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[11],
1091 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[12],
1092 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[13],
1093 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[14],
1094 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[15]
1101 L
"IPv6(%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x,%s,%s,%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x:%02x%02x)",
1102 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[0],
1103 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[1],
1104 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[2],
1105 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[3],
1106 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[4],
1107 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[5],
1108 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[6],
1109 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[7],
1110 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[8],
1111 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[9],
1112 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[10],
1113 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[11],
1114 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[12],
1115 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[13],
1116 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[14],
1117 (UINTN
) IPDevPath
->RemoteIpAddress
.Addr
[15],
1118 (IPDevPath
->Protocol
== 1) ? L
"TCP" : L
"UDP",
1119 IPDevPath
->StaticIpAddress
? L
"Static" : L
"DHCP",
1120 (UINTN
) IPDevPath
->LocalIpAddress
.Addr
[0],
1121 (UINTN
) IPDevPath
->LocalIpAddress
.Addr
[1],
1122 (UINTN
) IPDevPath
->LocalIpAddress
.Addr
[2],
1123 (UINTN
) IPDevPath
->LocalIpAddress
.Addr
[3],
1124 (UINTN
) IPDevPath
->LocalIpAddress
.Addr
[4],
1125 (UINTN
) IPDevPath
->LocalIpAddress
.Addr
[5],
1126 (UINTN
) IPDevPath
->LocalIpAddress
.Addr
[6],
1127 (UINTN
) IPDevPath
->LocalIpAddress
.Addr
[7],
1128 (UINTN
) IPDevPath
->LocalIpAddress
.Addr
[8],
1129 (UINTN
) IPDevPath
->LocalIpAddress
.Addr
[9],
1130 (UINTN
) IPDevPath
->LocalIpAddress
.Addr
[10],
1131 (UINTN
) IPDevPath
->LocalIpAddress
.Addr
[11],
1132 (UINTN
) IPDevPath
->LocalIpAddress
.Addr
[12],
1133 (UINTN
) IPDevPath
->LocalIpAddress
.Addr
[13],
1134 (UINTN
) IPDevPath
->LocalIpAddress
.Addr
[14],
1135 (UINTN
) IPDevPath
->LocalIpAddress
.Addr
[15]
1140 Converts an Infini Band device path structure to its string representative.
1142 @param Str The string representative of input device.
1143 @param DevPath The input device path structure.
1144 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
1145 of the display node is used, where applicable. If DisplayOnly
1146 is FALSE, then the longer text representation of the display node
1148 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
1149 representation for a device node can be used, where applicable.
1153 DevPathToTextInfiniBand (
1154 IN OUT POOL_PRINT
*Str
,
1156 IN BOOLEAN DisplayOnly
,
1157 IN BOOLEAN AllowShortcuts
1160 INFINIBAND_DEVICE_PATH
*InfiniBand
;
1162 InfiniBand
= DevPath
;
1165 L
"Infiniband(0x%x,%g,0x%lx,0x%lx,0x%lx)",
1166 (UINTN
) InfiniBand
->ResourceFlags
,
1167 InfiniBand
->PortGid
,
1168 InfiniBand
->ServiceId
,
1169 InfiniBand
->TargetPortId
,
1170 InfiniBand
->DeviceId
1175 Converts a UART device path structure to its string representative.
1177 @param Str The string representative of input device.
1178 @param DevPath The input device path structure.
1179 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
1180 of the display node is used, where applicable. If DisplayOnly
1181 is FALSE, then the longer text representation of the display node
1183 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
1184 representation for a device node can be used, where applicable.
1189 IN OUT POOL_PRINT
*Str
,
1191 IN BOOLEAN DisplayOnly
,
1192 IN BOOLEAN AllowShortcuts
1195 UART_DEVICE_PATH
*Uart
;
1199 switch (Uart
->Parity
) {
1229 if (Uart
->BaudRate
== 0) {
1230 CatPrint (Str
, L
"Uart(DEFAULT,");
1232 CatPrint (Str
, L
"Uart(%ld,", Uart
->BaudRate
);
1235 if (Uart
->DataBits
== 0) {
1236 CatPrint (Str
, L
"DEFAULT,");
1238 CatPrint (Str
, L
"%d,", (UINTN
) Uart
->DataBits
);
1241 CatPrint (Str
, L
"%c,", Parity
);
1243 switch (Uart
->StopBits
) {
1245 CatPrint (Str
, L
"D)");
1249 CatPrint (Str
, L
"1)");
1253 CatPrint (Str
, L
"1.5)");
1257 CatPrint (Str
, L
"2)");
1261 CatPrint (Str
, L
"x)");
1267 Converts an iSCSI device path structure to its string representative.
1269 @param Str The string representative of input device.
1270 @param DevPath The input device path structure.
1271 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
1272 of the display node is used, where applicable. If DisplayOnly
1273 is FALSE, then the longer text representation of the display node
1275 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
1276 representation for a device node can be used, where applicable.
1280 DevPathToTextiSCSI (
1281 IN OUT POOL_PRINT
*Str
,
1283 IN BOOLEAN DisplayOnly
,
1284 IN BOOLEAN AllowShortcuts
1287 ISCSI_DEVICE_PATH_WITH_NAME
*ISCSIDevPath
;
1290 ISCSIDevPath
= DevPath
;
1293 L
"iSCSI(%a,0x%x,0x%lx,",
1294 ISCSIDevPath
->iSCSITargetName
,
1295 (UINTN
) ISCSIDevPath
->TargetPortalGroupTag
,
1299 Options
= ISCSIDevPath
->LoginOption
;
1300 CatPrint (Str
, L
"%s,", (((Options
>> 1) & 0x0001) != 0) ? L
"CRC32C" : L
"None");
1301 CatPrint (Str
, L
"%s,", (((Options
>> 3) & 0x0001) != 0) ? L
"CRC32C" : L
"None");
1302 if (((Options
>> 11) & 0x0001) != 0) {
1303 CatPrint (Str
, L
"%s,", L
"None");
1304 } else if (((Options
>> 12) & 0x0001) != 0) {
1305 CatPrint (Str
, L
"%s,", L
"CHAP_UNI");
1307 CatPrint (Str
, L
"%s,", L
"CHAP_BI");
1311 CatPrint (Str
, L
"%s)", (ISCSIDevPath
->NetworkProtocol
== 0) ? L
"TCP" : L
"reserved");
1315 Converts a Hard drive device path structure to its string representative.
1317 @param Str The string representative of input device.
1318 @param DevPath The input device path structure.
1319 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
1320 of the display node is used, where applicable. If DisplayOnly
1321 is FALSE, then the longer text representation of the display node
1323 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
1324 representation for a device node can be used, where applicable.
1328 DevPathToTextHardDrive (
1329 IN OUT POOL_PRINT
*Str
,
1331 IN BOOLEAN DisplayOnly
,
1332 IN BOOLEAN AllowShortcuts
1335 HARDDRIVE_DEVICE_PATH
*Hd
;
1338 switch (Hd
->SignatureType
) {
1339 case SIGNATURE_TYPE_MBR
:
1342 L
"HD(%d,%s,0x%08x,",
1343 (UINTN
) Hd
->PartitionNumber
,
1345 (UINTN
) *((UINT32
*) (&(Hd
->Signature
[0])))
1349 case SIGNATURE_TYPE_GUID
:
1353 (UINTN
) Hd
->PartitionNumber
,
1355 (EFI_GUID
*) &(Hd
->Signature
[0])
1363 (UINTN
) Hd
->PartitionNumber
,
1364 (UINTN
) Hd
->SignatureType
1369 CatPrint (Str
, L
"0x%lx,0x%lx)", Hd
->PartitionStart
, Hd
->PartitionSize
);
1373 Converts a CDROM device path structure to its string representative.
1375 @param Str The string representative of input device.
1376 @param DevPath The input device path structure.
1377 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
1378 of the display node is used, where applicable. If DisplayOnly
1379 is FALSE, then the longer text representation of the display node
1381 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
1382 representation for a device node can be used, where applicable.
1386 DevPathToTextCDROM (
1387 IN OUT POOL_PRINT
*Str
,
1389 IN BOOLEAN DisplayOnly
,
1390 IN BOOLEAN AllowShortcuts
1393 CDROM_DEVICE_PATH
*Cd
;
1397 CatPrint (Str
, L
"CDROM(0x%x)", (UINTN
) Cd
->BootEntry
);
1401 CatPrint (Str
, L
"CDROM(0x%x,0x%lx,0x%lx)", (UINTN
) Cd
->BootEntry
, Cd
->PartitionStart
, Cd
->PartitionSize
);
1405 Converts a File device path structure to its string representative.
1407 @param Str The string representative of input device.
1408 @param DevPath The input device path structure.
1409 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
1410 of the display node is used, where applicable. If DisplayOnly
1411 is FALSE, then the longer text representation of the display node
1413 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
1414 representation for a device node can be used, where applicable.
1418 DevPathToTextFilePath (
1419 IN OUT POOL_PRINT
*Str
,
1421 IN BOOLEAN DisplayOnly
,
1422 IN BOOLEAN AllowShortcuts
1425 FILEPATH_DEVICE_PATH
*Fp
;
1428 CatPrint (Str
, L
"%s", Fp
->PathName
);
1432 Converts a Media protocol device path structure to its string representative.
1434 @param Str The string representative of input device.
1435 @param DevPath The input device path structure.
1436 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
1437 of the display node is used, where applicable. If DisplayOnly
1438 is FALSE, then the longer text representation of the display node
1440 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
1441 representation for a device node can be used, where applicable.
1445 DevPathToTextMediaProtocol (
1446 IN OUT POOL_PRINT
*Str
,
1448 IN BOOLEAN DisplayOnly
,
1449 IN BOOLEAN AllowShortcuts
1452 MEDIA_PROTOCOL_DEVICE_PATH
*MediaProt
;
1454 MediaProt
= DevPath
;
1455 CatPrint (Str
, L
"Media(%g)", &MediaProt
->Protocol
);
1459 Converts a Firmware Volume device path structure to its string representative.
1461 @param Str The string representative of input device.
1462 @param DevPath The input device path structure.
1463 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
1464 of the display node is used, where applicable. If DisplayOnly
1465 is FALSE, then the longer text representation of the display node
1467 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
1468 representation for a device node can be used, where applicable.
1473 IN OUT POOL_PRINT
*Str
,
1475 IN BOOLEAN DisplayOnly
,
1476 IN BOOLEAN AllowShortcuts
1479 MEDIA_FW_VOL_DEVICE_PATH
*Fv
;
1482 CatPrint (Str
, L
"Fv(%g)", &Fv
->FvName
);
1486 Converts a Firmware Volume File device path structure to its string representative.
1488 @param Str The string representative of input device.
1489 @param DevPath The input device path structure.
1490 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
1491 of the display node is used, where applicable. If DisplayOnly
1492 is FALSE, then the longer text representation of the display node
1494 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
1495 representation for a device node can be used, where applicable.
1499 DevPathToTextFvFile (
1500 IN OUT POOL_PRINT
*Str
,
1502 IN BOOLEAN DisplayOnly
,
1503 IN BOOLEAN AllowShortcuts
1506 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH
*FvFile
;
1509 CatPrint (Str
, L
"FvFile(%g)", &FvFile
->FvFileName
);
1513 Converts a BIOS Boot Specification device path structure to its string representative.
1515 @param Str The string representative of input device.
1516 @param DevPath The input device path structure.
1517 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
1518 of the display node is used, where applicable. If DisplayOnly
1519 is FALSE, then the longer text representation of the display node
1521 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
1522 representation for a device node can be used, where applicable.
1527 IN OUT POOL_PRINT
*Str
,
1529 IN BOOLEAN DisplayOnly
,
1530 IN BOOLEAN AllowShortcuts
1533 BBS_BBS_DEVICE_PATH
*Bbs
;
1537 switch (Bbs
->DeviceType
) {
1538 case BBS_TYPE_FLOPPY
:
1542 case BBS_TYPE_HARDDRIVE
:
1546 case BBS_TYPE_CDROM
:
1550 case BBS_TYPE_PCMCIA
:
1558 case BBS_TYPE_EMBEDDED_NETWORK
:
1568 CatPrint (Str
, L
"BBS(%s,%a", Type
, Bbs
->String
);
1570 CatPrint (Str
, L
"BBS(0x%x,%a", (UINTN
) Bbs
->DeviceType
, Bbs
->String
);
1574 CatPrint (Str
, L
")");
1578 CatPrint (Str
, L
",0x%x)", (UINTN
) Bbs
->StatusFlag
);
1582 Converts an End-of-Device-Path structure to its string representative.
1584 @param Str The string representative of input device.
1585 @param DevPath The input device path structure.
1586 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
1587 of the display node is used, where applicable. If DisplayOnly
1588 is FALSE, then the longer text representation of the display node
1590 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
1591 representation for a device node can be used, where applicable.
1595 DevPathToTextEndInstance (
1596 IN OUT POOL_PRINT
*Str
,
1598 IN BOOLEAN DisplayOnly
,
1599 IN BOOLEAN AllowShortcuts
1602 CatPrint (Str
, L
",");
1606 Converts an unknown device path structure to its string representative.
1608 @param Str The string representative of input device.
1609 @param DevPath The input device path structure.
1610 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
1611 of the display node is used, where applicable. If DisplayOnly
1612 is FALSE, then the longer text representation of the display node
1614 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
1615 representation for a device node can be used, where applicable.
1619 DevPathToTextNodeUnknown (
1620 IN OUT POOL_PRINT
*Str
,
1622 IN BOOLEAN DisplayOnly
,
1623 IN BOOLEAN AllowShortcuts
1626 CatPrint (Str
, L
"?");
1629 GLOBAL_REMOVE_IF_UNREFERENCED
const DEVICE_PATH_TO_TEXT_TABLE DevPathToTextTable
[] = {
1630 {HARDWARE_DEVICE_PATH
, HW_PCI_DP
, DevPathToTextPci
},
1631 {HARDWARE_DEVICE_PATH
, HW_PCCARD_DP
, DevPathToTextPccard
},
1632 {HARDWARE_DEVICE_PATH
, HW_MEMMAP_DP
, DevPathToTextMemMap
},
1633 {HARDWARE_DEVICE_PATH
, HW_VENDOR_DP
, DevPathToTextVendor
},
1634 {HARDWARE_DEVICE_PATH
, HW_CONTROLLER_DP
, DevPathToTextController
},
1635 {ACPI_DEVICE_PATH
, ACPI_DP
, DevPathToTextAcpi
},
1636 {ACPI_DEVICE_PATH
, ACPI_EXTENDED_DP
, DevPathToTextAcpiEx
},
1637 {ACPI_DEVICE_PATH
, ACPI_ADR_DP
, DevPathToTextAcpiAdr
},
1638 {MESSAGING_DEVICE_PATH
, MSG_ATAPI_DP
, DevPathToTextAtapi
},
1639 {MESSAGING_DEVICE_PATH
, MSG_SCSI_DP
, DevPathToTextScsi
},
1640 {MESSAGING_DEVICE_PATH
, MSG_FIBRECHANNEL_DP
, DevPathToTextFibre
},
1641 {MESSAGING_DEVICE_PATH
, MSG_1394_DP
, DevPathToText1394
},
1642 {MESSAGING_DEVICE_PATH
, MSG_USB_DP
, DevPathToTextUsb
},
1643 {MESSAGING_DEVICE_PATH
, MSG_USB_WWID_DP
, DevPathToTextUsbWWID
},
1644 {MESSAGING_DEVICE_PATH
, MSG_DEVICE_LOGICAL_UNIT_DP
, DevPathToTextLogicalUnit
},
1645 {MESSAGING_DEVICE_PATH
, MSG_USB_CLASS_DP
, DevPathToTextUsbClass
},
1646 {MESSAGING_DEVICE_PATH
, MSG_SATA_DP
, DevPathToTextSata
},
1647 {MESSAGING_DEVICE_PATH
, MSG_I2O_DP
, DevPathToTextI2O
},
1648 {MESSAGING_DEVICE_PATH
, MSG_MAC_ADDR_DP
, DevPathToTextMacAddr
},
1649 {MESSAGING_DEVICE_PATH
, MSG_IPv4_DP
, DevPathToTextIPv4
},
1650 {MESSAGING_DEVICE_PATH
, MSG_IPv6_DP
, DevPathToTextIPv6
},
1651 {MESSAGING_DEVICE_PATH
, MSG_INFINIBAND_DP
, DevPathToTextInfiniBand
},
1652 {MESSAGING_DEVICE_PATH
, MSG_UART_DP
, DevPathToTextUart
},
1653 {MESSAGING_DEVICE_PATH
, MSG_VENDOR_DP
, DevPathToTextVendor
},
1654 {MESSAGING_DEVICE_PATH
, MSG_ISCSI_DP
, DevPathToTextiSCSI
},
1655 {MEDIA_DEVICE_PATH
, MEDIA_HARDDRIVE_DP
, DevPathToTextHardDrive
},
1656 {MEDIA_DEVICE_PATH
, MEDIA_CDROM_DP
, DevPathToTextCDROM
},
1657 {MEDIA_DEVICE_PATH
, MEDIA_VENDOR_DP
, DevPathToTextVendor
},
1658 {MEDIA_DEVICE_PATH
, MEDIA_PROTOCOL_DP
, DevPathToTextMediaProtocol
},
1659 {MEDIA_DEVICE_PATH
, MEDIA_FILEPATH_DP
, DevPathToTextFilePath
},
1660 {MEDIA_DEVICE_PATH
, MEDIA_PIWG_FW_VOL_DP
, DevPathToTextFv
},
1661 {MEDIA_DEVICE_PATH
, MEDIA_PIWG_FW_FILE_DP
, DevPathToTextFvFile
},
1662 {BBS_DEVICE_PATH
, BBS_BBS_DP
, DevPathToTextBBS
},
1663 {END_DEVICE_PATH_TYPE
, END_INSTANCE_DEVICE_PATH_SUBTYPE
, DevPathToTextEndInstance
},
1668 Converts a device node to its string representation.
1670 @param DeviceNode A Pointer to the device node to be converted.
1671 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
1672 of the display node is used, where applicable. If DisplayOnly
1673 is FALSE, then the longer text representation of the display node
1675 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
1676 representation for a device node can be used, where applicable.
1678 @return A pointer to the allocated text representation of the device node or NULL if DeviceNode
1679 is NULL or there was insufficient memory.
1684 ConvertDeviceNodeToText (
1685 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DeviceNode
,
1686 IN BOOLEAN DisplayOnly
,
1687 IN BOOLEAN AllowShortcuts
1693 VOID (*DumpNode
)(POOL_PRINT
*, VOID
*, BOOLEAN
, BOOLEAN
);
1695 if (DeviceNode
== NULL
) {
1699 ZeroMem (&Str
, sizeof (Str
));
1702 // Process the device path node
1705 for (Index
= 0; DevPathToTextTable
[Index
].Function
!= NULL
; Index
++) {
1706 if (DevicePathType (DeviceNode
) == DevPathToTextTable
[Index
].Type
&&
1707 DevicePathSubType (DeviceNode
) == DevPathToTextTable
[Index
].SubType
1709 DumpNode
= DevPathToTextTable
[Index
].Function
;
1714 // If not found, use a generic function
1716 if (DumpNode
== NULL
) {
1717 DumpNode
= DevPathToTextNodeUnknown
;
1723 DumpNode (&Str
, (VOID
*) DeviceNode
, DisplayOnly
, AllowShortcuts
);
1726 // Shrink pool used for string allocation
1728 NewSize
= (Str
.Len
+ 1) * sizeof (CHAR16
);
1729 Str
.Str
= ReallocatePool (NewSize
, NewSize
, Str
.Str
);
1730 ASSERT (Str
.Str
!= NULL
);
1731 Str
.Str
[Str
.Len
] = 0;
1736 Converts a device path to its text representation.
1738 @param DevicePath A Pointer to the device to be converted.
1739 @param DisplayOnly If DisplayOnly is TRUE, then the shorter text representation
1740 of the display node is used, where applicable. If DisplayOnly
1741 is FALSE, then the longer text representation of the display node
1743 @param AllowShortcuts If AllowShortcuts is TRUE, then the shortcut forms of text
1744 representation for a device node can be used, where applicable.
1746 @return A pointer to the allocated text representation of the device path or
1747 NULL if DeviceNode is NULL or there was insufficient memory.
1752 ConvertDevicePathToText (
1753 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
1754 IN BOOLEAN DisplayOnly
,
1755 IN BOOLEAN AllowShortcuts
1759 EFI_DEVICE_PATH_PROTOCOL
*DevPathNode
;
1760 EFI_DEVICE_PATH_PROTOCOL
*AlignedDevPathNode
;
1763 VOID (*DumpNode
) (POOL_PRINT
*, VOID
*, BOOLEAN
, BOOLEAN
);
1765 if (DevicePath
== NULL
) {
1769 ZeroMem (&Str
, sizeof (Str
));
1772 // Process each device path node
1774 DevPathNode
= (EFI_DEVICE_PATH_PROTOCOL
*) DevicePath
;
1775 while (!IsDevicePathEnd (DevPathNode
)) {
1777 // Find the handler to dump this device path node
1780 for (Index
= 0; DevPathToTextTable
[Index
].Function
!= NULL
; Index
+= 1) {
1782 if (DevicePathType (DevPathNode
) == DevPathToTextTable
[Index
].Type
&&
1783 DevicePathSubType (DevPathNode
) == DevPathToTextTable
[Index
].SubType
1785 DumpNode
= DevPathToTextTable
[Index
].Function
;
1790 // If not found, use a generic function
1793 DumpNode
= DevPathToTextNodeUnknown
;
1796 // Put a path separator in if needed
1798 if ((Str
.Len
!= 0) && DumpNode
!= DevPathToTextEndInstance
) {
1799 if (*(Str
.Str
+ Str
.Len
/ sizeof (CHAR16
) - 1) != L
',') {
1800 CatPrint (&Str
, L
"/");
1804 AlignedDevPathNode
= AllocateCopyPool (DevicePathNodeLength (DevPathNode
), DevPathNode
);
1806 // Print this node of the device path
1808 DumpNode (&Str
, AlignedDevPathNode
, DisplayOnly
, AllowShortcuts
);
1809 FreePool (AlignedDevPathNode
);
1812 // Next device path node
1814 DevPathNode
= NextDevicePathNode (DevPathNode
);
1817 NewSize
= (Str
.Len
+ 1) * sizeof (CHAR16
);
1818 Str
.Str
= ReallocatePool (NewSize
, NewSize
, Str
.Str
);
1819 ASSERT (Str
.Str
!= NULL
);
1820 Str
.Str
[Str
.Len
] = 0;