2 Provides interface to advanced shell functionality for parsing both handle and protocol database.
4 (C) Copyright 2013-2015 Hewlett-Packard Development Company, L.P.<BR>
5 Copyright (c) 2010 - 2014, 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.
16 #include "UefiHandleParsingLib.h"
17 #include "IndustryStandard/Acpi10.h"
19 EFI_HANDLE mHandleParsingHiiHandle
= NULL
;
20 HANDLE_INDEX_LIST mHandleList
= {{{NULL
,NULL
},0,0},0};
21 GUID_INFO_BLOCK
*GuidList
;
24 Function to translate the EFI_MEMORY_TYPE into a string.
26 @param[in] Memory The memory type.
28 @retval A string representation of the type allocated from BS Pool.
33 IN CONST EFI_MEMORY_TYPE Memory
40 case EfiReservedMemoryType
: StrnCatGrow(&RetVal
, NULL
, L
"EfiReservedMemoryType", 0); break;
41 case EfiLoaderCode
: StrnCatGrow(&RetVal
, NULL
, L
"EfiLoaderCode", 0); break;
42 case EfiLoaderData
: StrnCatGrow(&RetVal
, NULL
, L
"EfiLoaderData", 0); break;
43 case EfiBootServicesCode
: StrnCatGrow(&RetVal
, NULL
, L
"EfiBootServicesCode", 0); break;
44 case EfiBootServicesData
: StrnCatGrow(&RetVal
, NULL
, L
"EfiBootServicesData", 0); break;
45 case EfiRuntimeServicesCode
: StrnCatGrow(&RetVal
, NULL
, L
"EfiRuntimeServicesCode", 0); break;
46 case EfiRuntimeServicesData
: StrnCatGrow(&RetVal
, NULL
, L
"EfiRuntimeServicesData", 0); break;
47 case EfiConventionalMemory
: StrnCatGrow(&RetVal
, NULL
, L
"EfiConventionalMemory", 0); break;
48 case EfiUnusableMemory
: StrnCatGrow(&RetVal
, NULL
, L
"EfiUnusableMemory", 0); break;
49 case EfiACPIReclaimMemory
: StrnCatGrow(&RetVal
, NULL
, L
"EfiACPIReclaimMemory", 0); break;
50 case EfiACPIMemoryNVS
: StrnCatGrow(&RetVal
, NULL
, L
"EfiACPIMemoryNVS", 0); break;
51 case EfiMemoryMappedIO
: StrnCatGrow(&RetVal
, NULL
, L
"EfiMemoryMappedIO", 0); break;
52 case EfiMemoryMappedIOPortSpace
: StrnCatGrow(&RetVal
, NULL
, L
"EfiMemoryMappedIOPortSpace", 0); break;
53 case EfiPalCode
: StrnCatGrow(&RetVal
, NULL
, L
"EfiPalCode", 0); break;
54 case EfiMaxMemoryType
: StrnCatGrow(&RetVal
, NULL
, L
"EfiMaxMemoryType", 0); break;
55 default: ASSERT(FALSE
);
61 Function to translate the EFI_GRAPHICS_PIXEL_FORMAT into a string.
63 @param[in] Fmt The format type.
65 @retval A string representation of the type allocated from BS Pool.
70 IN CONST EFI_GRAPHICS_PIXEL_FORMAT Fmt
77 case PixelRedGreenBlueReserved8BitPerColor
: StrnCatGrow(&RetVal
, NULL
, L
"PixelRedGreenBlueReserved8BitPerColor", 0); break;
78 case PixelBlueGreenRedReserved8BitPerColor
: StrnCatGrow(&RetVal
, NULL
, L
"PixelBlueGreenRedReserved8BitPerColor", 0); break;
79 case PixelBitMask
: StrnCatGrow(&RetVal
, NULL
, L
"PixelBitMask", 0); break;
80 case PixelBltOnly
: StrnCatGrow(&RetVal
, NULL
, L
"PixelBltOnly", 0); break;
81 case PixelFormatMax
: StrnCatGrow(&RetVal
, NULL
, L
"PixelFormatMax", 0); break;
82 default: ASSERT(FALSE
);
88 Constructor for the library.
90 @param[in] ImageHandle Ignored.
91 @param[in] SystemTable Ignored.
93 @retval EFI_SUCCESS The operation was successful.
97 HandleParsingLibConstructor (
98 IN EFI_HANDLE ImageHandle
,
99 IN EFI_SYSTEM_TABLE
*SystemTable
106 // Do nothing with mHandleParsingHiiHandle. Initialize HII as needed.
108 return (EFI_SUCCESS
);
112 Initialization function for HII packages.
116 HandleParsingHiiInit (VOID
)
118 if (mHandleParsingHiiHandle
== NULL
) {
119 mHandleParsingHiiHandle
= HiiAddPackages (&gHandleParsingHiiGuid
, gImageHandle
, UefiHandleParsingLibStrings
, NULL
);
120 ASSERT (mHandleParsingHiiHandle
!= NULL
);
125 Destructor for the library. free any resources.
127 @param[in] ImageHandle Ignored.
128 @param[in] SystemTable Ignored.
130 @retval EFI_SUCCESS The operation was successful.
134 HandleParsingLibDestructor (
135 IN EFI_HANDLE ImageHandle
,
136 IN EFI_SYSTEM_TABLE
*SystemTable
141 for (LoopCount
= 0; GuidList
!= NULL
&& LoopCount
< GuidListCount
; LoopCount
++) {
142 SHELL_FREE_NON_NULL(GuidList
[LoopCount
].GuidId
);
145 SHELL_FREE_NON_NULL(GuidList
);
146 if (mHandleParsingHiiHandle
!= NULL
) {
147 HiiRemovePackages(mHandleParsingHiiHandle
);
149 return (EFI_SUCCESS
);
153 Function to dump information about LoadedImage.
155 This will allocate the return buffer from boot services pool.
157 @param[in] TheHandle The handle that has LoadedImage installed.
158 @param[in] Verbose TRUE for additional information, FALSE otherwise.
160 @retval A poitner to a string containing the information.
164 LoadedImageProtocolDumpInformation(
165 IN CONST EFI_HANDLE TheHandle
,
166 IN CONST BOOLEAN Verbose
169 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
177 return (CatSPrint(NULL
, L
"LoadedImage"));
180 HandleParsingHiiInit();
182 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_LI_DUMP_MAIN
), NULL
);
183 RetVal
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
184 if (Temp
== NULL
|| RetVal
== NULL
) {
185 SHELL_FREE_NON_NULL(Temp
);
186 SHELL_FREE_NON_NULL(RetVal
);
190 Status
= gBS
->OpenProtocol (
192 &gEfiLoadedImageProtocolGuid
,
193 (VOID
**)&LoadedImage
,
196 EFI_OPEN_PROTOCOL_GET_PROTOCOL
199 if (EFI_ERROR (Status
)) {
200 SHELL_FREE_NON_NULL (Temp
);
201 SHELL_FREE_NON_NULL (RetVal
);
205 DataType
= ConvertMemoryType(LoadedImage
->ImageDataType
);
206 CodeType
= ConvertMemoryType(LoadedImage
->ImageCodeType
);
208 RetVal
= CatSPrint(RetVal
,
210 LoadedImage
->Revision
,
211 LoadedImage
->ParentHandle
,
212 LoadedImage
->SystemTable
,
213 LoadedImage
->DeviceHandle
,
214 LoadedImage
->FilePath
,
215 LoadedImage
->LoadOptionsSize
,
216 LoadedImage
->LoadOptions
,
217 LoadedImage
->ImageBase
,
218 LoadedImage
->ImageSize
,
221 LoadedImage
->Unload
);
224 SHELL_FREE_NON_NULL(Temp
);
225 SHELL_FREE_NON_NULL(CodeType
);
226 SHELL_FREE_NON_NULL(DataType
);
232 Function to dump information about GOP.
234 This will allocate the return buffer from boot services pool.
236 @param[in] TheHandle The handle that has LoadedImage installed.
237 @param[in] Verbose TRUE for additional information, FALSE otherwise.
239 @retval A poitner to a string containing the information.
243 GraphicsOutputProtocolDumpInformation(
244 IN CONST EFI_HANDLE TheHandle
,
245 IN CONST BOOLEAN Verbose
248 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
255 return (CatSPrint(NULL
, L
"GraphicsOutput"));
258 HandleParsingHiiInit();
260 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_GOP_DUMP_MAIN
), NULL
);
261 RetVal
= AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize
));
262 if (Temp
== NULL
|| RetVal
== NULL
) {
263 SHELL_FREE_NON_NULL(Temp
);
264 SHELL_FREE_NON_NULL(RetVal
);
268 Status
= gBS
->OpenProtocol (
270 &gEfiGraphicsOutputProtocolGuid
,
271 (VOID
**)&GraphicsOutput
,
274 EFI_OPEN_PROTOCOL_GET_PROTOCOL
277 if (EFI_ERROR (Status
)) {
278 SHELL_FREE_NON_NULL (Temp
);
279 SHELL_FREE_NON_NULL (RetVal
);
283 Fmt
= ConvertPixelFormat(GraphicsOutput
->Mode
->Info
->PixelFormat
);
285 RetVal
= CatSPrint(RetVal
,
287 GraphicsOutput
->Mode
->MaxMode
,
288 GraphicsOutput
->Mode
->Mode
,
289 GraphicsOutput
->Mode
->FrameBufferBase
,
290 (UINT64
)GraphicsOutput
->Mode
->FrameBufferSize
,
291 (UINT64
)GraphicsOutput
->Mode
->SizeOfInfo
,
292 GraphicsOutput
->Mode
->Info
->Version
,
293 GraphicsOutput
->Mode
->Info
->HorizontalResolution
,
294 GraphicsOutput
->Mode
->Info
->VerticalResolution
,
296 GraphicsOutput
->Mode
->Info
->PixelsPerScanLine
,
297 GraphicsOutput
->Mode
->Info
->PixelFormat
!=PixelBitMask
?0:GraphicsOutput
->Mode
->Info
->PixelInformation
.RedMask
,
298 GraphicsOutput
->Mode
->Info
->PixelFormat
!=PixelBitMask
?0:GraphicsOutput
->Mode
->Info
->PixelInformation
.GreenMask
,
299 GraphicsOutput
->Mode
->Info
->PixelFormat
!=PixelBitMask
?0:GraphicsOutput
->Mode
->Info
->PixelInformation
.BlueMask
302 SHELL_FREE_NON_NULL(Temp
);
303 SHELL_FREE_NON_NULL(Fmt
);
309 Function to dump information about PciRootBridgeIo.
311 This will allocate the return buffer from boot services pool.
313 @param[in] TheHandle The handle that has PciRootBridgeIo installed.
314 @param[in] Verbose TRUE for additional information, FALSE otherwise.
316 @retval A poitner to a string containing the information.
320 PciRootBridgeIoDumpInformation(
321 IN CONST EFI_HANDLE TheHandle
,
322 IN CONST BOOLEAN Verbose
325 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*PciRootBridgeIo
;
326 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*Configuration
;
337 return (CatSPrint(NULL
, L
"PciRootBridgeIo"));
340 HandleParsingHiiInit();
342 Status
= gBS
->HandleProtocol(
344 &gEfiPciRootBridgeIoProtocolGuid
,
345 (VOID
**)&PciRootBridgeIo
);
347 if (EFI_ERROR(Status
)) {
351 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_PH
), NULL
);
355 Temp2
= CatSPrint(L
"\r\n", Temp
, PciRootBridgeIo
->ParentHandle
);
360 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_SEG
), NULL
);
362 SHELL_FREE_NON_NULL(RetVal
);
365 Temp2
= CatSPrint(RetVal
, Temp
, PciRootBridgeIo
->SegmentNumber
);
373 Status
= PciRootBridgeIo
->GetAttributes (PciRootBridgeIo
, &Supports
, &Attributes
);
374 if (!EFI_ERROR(Status
)) {
375 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_ATT
), NULL
);
377 SHELL_FREE_NON_NULL(RetVal
);
380 Temp2
= CatSPrint(RetVal
, Temp
, Attributes
);
386 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_SUPPORTS
), NULL
);
388 SHELL_FREE_NON_NULL(RetVal
);
391 Temp2
= CatSPrint(RetVal
, Temp
, Supports
);
398 Configuration
= NULL
;
399 Status
= PciRootBridgeIo
->Configuration (PciRootBridgeIo
, (VOID
**) &Configuration
);
400 if (!EFI_ERROR(Status
) && Configuration
!= NULL
) {
401 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_TITLE
), NULL
);
403 SHELL_FREE_NON_NULL(RetVal
);
406 Temp2
= CatSPrint(RetVal
, Temp
, Supports
);
411 while (Configuration
->Desc
== ACPI_ADDRESS_SPACE_DESCRIPTOR
) {
413 switch (Configuration
->ResType
) {
414 case ACPI_ADDRESS_SPACE_TYPE_MEM
:
415 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_MEM
), NULL
);
417 case ACPI_ADDRESS_SPACE_TYPE_IO
:
418 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_IO
), NULL
);
420 case ACPI_ADDRESS_SPACE_TYPE_BUS
:
421 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_BUS
), NULL
);
425 Temp2
= CatSPrint(RetVal
, L
"%s", Temp
);
432 Temp2
= CatSPrint(RetVal
,
433 L
"%H%02x %016lx %016lx %02x%N\r\n",
434 Configuration
->SpecificFlag
,
435 Configuration
->AddrRangeMin
,
436 Configuration
->AddrRangeMax
,
437 Configuration
->AddrSpaceGranularity
449 Function to dump information about SimpleTextOut.
451 This will allocate the return buffer from boot services pool.
453 @param[in] TheHandle The handle that has SimpleTextOut installed.
454 @param[in] Verbose TRUE for additional information, FALSE otherwise.
456 @retval A poitner to a string containing the information.
460 TxtOutProtocolDumpInformation(
461 IN CONST EFI_HANDLE TheHandle
,
462 IN CONST BOOLEAN Verbose
465 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*Dev
;
479 HandleParsingHiiInit();
484 Status
= gBS
->HandleProtocol(
486 &gEfiSimpleTextOutProtocolGuid
,
489 ASSERT_EFI_ERROR(Status
);
490 ASSERT (Dev
!= NULL
&& Dev
->Mode
!= NULL
);
492 Size
= (Dev
->Mode
->MaxMode
+ 1) * 80;
493 RetVal
= AllocateZeroPool(Size
);
495 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_TXT_OUT_DUMP_HEADER
), NULL
);
497 UnicodeSPrint(RetVal
, Size
, Temp
, Dev
, Dev
->Mode
->Attribute
);
504 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_TXT_OUT_DUMP_LINE
), NULL
);
505 for (Index
= 0; Index
< Dev
->Mode
->MaxMode
; Index
++) {
506 Status
= Dev
->QueryMode (Dev
, Index
, &Col
, &Row
);
507 NewSize
= Size
- StrSize(RetVal
);
509 RetVal
+ StrLen(RetVal
),
511 Temp
== NULL
?L
"":Temp
,
512 Index
== Dev
->Mode
->Mode
? L
'*' : L
' ',
514 !EFI_ERROR(Status
)?(INTN
)Col
:-1,
515 !EFI_ERROR(Status
)?(INTN
)Row
:-1
522 STATIC CONST UINTN VersionStringSize
= 60;
525 Function to dump information about EfiDriverSupportedEfiVersion protocol.
527 This will allocate the return buffer from boot services pool.
529 @param[in] TheHandle The handle that has the protocol installed.
530 @param[in] Verbose TRUE for additional information, FALSE otherwise.
532 @retval A poitner to a string containing the information.
536 DriverEfiVersionProtocolDumpInformation(
537 IN CONST EFI_HANDLE TheHandle
,
538 IN CONST BOOLEAN Verbose
541 EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL
*DriverEfiVersion
;
545 Status
= gBS
->HandleProtocol(
547 &gEfiDriverSupportedEfiVersionProtocolGuid
,
548 (VOID
**)&DriverEfiVersion
);
550 ASSERT_EFI_ERROR(Status
);
552 RetVal
= AllocateZeroPool(VersionStringSize
);
553 ASSERT(RetVal
!= NULL
);
554 UnicodeSPrint(RetVal
, VersionStringSize
, L
"0x%08x", DriverEfiVersion
->FirmwareVersion
);
559 Function to dump information about DevicePath protocol.
561 This will allocate the return buffer from boot services pool.
563 @param[in] TheHandle The handle that has the protocol installed.
564 @param[in] Verbose TRUE for additional information, FALSE otherwise.
566 @retval A poitner to a string containing the information.
570 DevicePathProtocolDumpInformation(
571 IN CONST EFI_HANDLE TheHandle
,
572 IN CONST BOOLEAN Verbose
575 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
581 Status
= gBS
->OpenProtocol(TheHandle
, &gEfiDevicePathProtocolGuid
, (VOID
**)&DevPath
, gImageHandle
, NULL
, EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
582 if (!EFI_ERROR(Status
)) {
584 // I cannot decide whether to allow shortcuts here (the second BOOLEAN on the next line)
586 Temp
= ConvertDevicePathToText(DevPath
, TRUE
, TRUE
);
587 gBS
->CloseProtocol(TheHandle
, &gEfiDevicePathProtocolGuid
, gImageHandle
, NULL
);
589 if (!Verbose
&& Temp
!= NULL
&& StrLen(Temp
) > 30) {
591 Temp2
= StrnCatGrow(&Temp2
, NULL
, Temp
+(StrLen(Temp
) - 30), 30);
599 Function to dump information about EfiAdapterInformation Protocol.
601 @param[in] TheHandle The handle that has the protocol installed.
602 @param[in] Verbose TRUE for additional information, FALSE otherwise.
604 @retval A pointer to a string containing the information.
608 AdapterInformationDumpInformation (
609 IN CONST EFI_HANDLE TheHandle
,
610 IN CONST BOOLEAN Verbose
614 EFI_ADAPTER_INFORMATION_PROTOCOL
*EfiAdptrInfoProtocol
;
615 UINTN InfoTypesBufferCount
;
617 EFI_GUID
*InfoTypesBuffer
;
621 VOID
*InformationBlock
;
622 UINTN InformationBlockSize
;
625 return (CatSPrint(NULL
, L
"AdapterInfo"));
628 InfoTypesBuffer
= NULL
;
629 InformationBlock
= NULL
;
632 // Allocate print buffer to store data
634 RetVal
= AllocateZeroPool (PcdGet16(PcdShellPrintBufferSize
));
635 if (RetVal
== NULL
) {
639 Status
= gBS
->OpenProtocol (
640 (EFI_HANDLE
) (TheHandle
),
641 &gEfiAdapterInformationProtocolGuid
,
642 (VOID
**) &EfiAdptrInfoProtocol
,
645 EFI_OPEN_PROTOCOL_GET_PROTOCOL
648 if (EFI_ERROR (Status
)) {
649 SHELL_FREE_NON_NULL (RetVal
);
654 // Get a list of supported information types for this instance of the protocol.
656 Status
= EfiAdptrInfoProtocol
->GetSupportedTypes (
657 EfiAdptrInfoProtocol
,
659 &InfoTypesBufferCount
661 if (EFI_ERROR (Status
)) {
662 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_GET_SUPP_TYPES_FAILED
), NULL
);
663 if (TempStr
!= NULL
) {
664 RetVal
= CatSPrint (RetVal
, TempStr
, Status
);
669 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_SUPP_TYPE_HEADER
), NULL
);
670 if (TempStr
== NULL
) {
673 RetVal
= CatSPrint (RetVal
, TempStr
);
674 SHELL_FREE_NON_NULL (TempStr
);
676 for (GuidIndex
= 0; GuidIndex
< InfoTypesBufferCount
; GuidIndex
++) {
677 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_GUID_NUMBER
), NULL
);
678 if (TempStr
== NULL
) {
681 RetVal
= CatSPrint (RetVal
, TempStr
, (GuidIndex
+ 1), InfoTypesBuffer
[GuidIndex
]);
682 SHELL_FREE_NON_NULL (TempStr
);
684 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_GUID_STRING
), NULL
);
685 if (TempStr
== NULL
) {
689 if (CompareGuid (&InfoTypesBuffer
[GuidIndex
], &gEfiAdapterInfoMediaStateGuid
)) {
690 RetVal
= CatSPrint (RetVal
, TempStr
, L
"gEfiAdapterInfoMediaStateGuid");
691 } else if (CompareGuid (&InfoTypesBuffer
[GuidIndex
], &gEfiAdapterInfoNetworkBootGuid
)) {
692 RetVal
= CatSPrint (RetVal
, TempStr
, L
"gEfiAdapterInfoNetworkBootGuid");
693 } else if (CompareGuid (&InfoTypesBuffer
[GuidIndex
], &gEfiAdapterInfoSanMacAddressGuid
)) {
694 RetVal
= CatSPrint (RetVal
, TempStr
, L
"gEfiAdapterInfoSanMacAddressGuid");
697 GuidStr
= GetStringNameFromGuid (&InfoTypesBuffer
[GuidIndex
], NULL
);
699 if (GuidStr
!= NULL
) {
700 if (StrCmp(GuidStr
, L
"UnknownDevice") == 0) {
701 RetVal
= CatSPrint (RetVal
, TempStr
, L
"UnknownInfoType");
703 SHELL_FREE_NON_NULL (TempStr
);
704 SHELL_FREE_NON_NULL(GuidStr
);
706 // So that we never have to pass this UnknownInfoType to the parsing function "GetInformation" service of AIP
710 RetVal
= CatSPrint (RetVal
, TempStr
, GuidStr
);
711 SHELL_FREE_NON_NULL(GuidStr
);
716 SHELL_FREE_NON_NULL (TempStr
);
718 Status
= EfiAdptrInfoProtocol
->GetInformation (
719 EfiAdptrInfoProtocol
,
720 &InfoTypesBuffer
[GuidIndex
],
722 &InformationBlockSize
725 if (EFI_ERROR (Status
)) {
726 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_GETINFO_FAILED
), NULL
);
727 if (TempStr
== NULL
) {
730 RetVal
= CatSPrint (RetVal
, TempStr
, Status
);
732 if (CompareGuid (&InfoTypesBuffer
[GuidIndex
], &gEfiAdapterInfoMediaStateGuid
)) {
733 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_MEDIA_STATE
), NULL
);
734 if (TempStr
== NULL
) {
740 ((EFI_ADAPTER_INFO_MEDIA_STATE
*)InformationBlock
)->MediaState
,
741 ((EFI_ADAPTER_INFO_MEDIA_STATE
*)InformationBlock
)->MediaState
743 } else if (CompareGuid (&InfoTypesBuffer
[GuidIndex
], &gEfiAdapterInfoNetworkBootGuid
)) {
744 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_NETWORK_BOOT_INFO
), NULL
);
745 if (TempStr
== NULL
) {
751 ((EFI_ADAPTER_INFO_NETWORK_BOOT
*)InformationBlock
)->iScsiIpv4BootCapablity
,
752 ((EFI_ADAPTER_INFO_NETWORK_BOOT
*)InformationBlock
)->iScsiIpv6BootCapablity
,
753 ((EFI_ADAPTER_INFO_NETWORK_BOOT
*)InformationBlock
)->FCoeBootCapablity
,
754 ((EFI_ADAPTER_INFO_NETWORK_BOOT
*)InformationBlock
)->OffloadCapability
,
755 ((EFI_ADAPTER_INFO_NETWORK_BOOT
*)InformationBlock
)->iScsiMpioCapability
,
756 ((EFI_ADAPTER_INFO_NETWORK_BOOT
*)InformationBlock
)->iScsiIpv4Boot
,
757 ((EFI_ADAPTER_INFO_NETWORK_BOOT
*)InformationBlock
)->iScsiIpv6Boot
,
758 ((EFI_ADAPTER_INFO_NETWORK_BOOT
*)InformationBlock
)->FCoeBoot
760 } else if (CompareGuid (&InfoTypesBuffer
[GuidIndex
], &gEfiAdapterInfoSanMacAddressGuid
) == TRUE
) {
761 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_SAN_MAC_ADDRESS_INFO
), NULL
);
762 if (TempStr
== NULL
) {
768 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS
*)InformationBlock
)->SanMacAddress
.Addr
[0],
769 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS
*)InformationBlock
)->SanMacAddress
.Addr
[1],
770 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS
*)InformationBlock
)->SanMacAddress
.Addr
[2],
771 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS
*)InformationBlock
)->SanMacAddress
.Addr
[3],
772 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS
*)InformationBlock
)->SanMacAddress
.Addr
[4],
773 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS
*)InformationBlock
)->SanMacAddress
.Addr
[5]
776 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_UNKNOWN_INFO_TYPE
), NULL
);
777 if (TempStr
== NULL
) {
780 RetVal
= CatSPrint (RetVal
, TempStr
, &InfoTypesBuffer
[GuidIndex
]);
783 SHELL_FREE_NON_NULL (TempStr
);
784 SHELL_FREE_NON_NULL (InformationBlock
);
788 SHELL_FREE_NON_NULL (InfoTypesBuffer
);
792 SHELL_FREE_NON_NULL (RetVal
);
793 SHELL_FREE_NON_NULL (InfoTypesBuffer
);
794 SHELL_FREE_NON_NULL (InformationBlock
);
798 // Put the information on the NT32 protocol GUIDs here so we are not dependant on the Nt32Pkg
800 #define LOCAL_EFI_WIN_NT_THUNK_PROTOCOL_GUID \
802 0x58c518b1, 0x76f3, 0x11d4, { 0xbc, 0xea, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
805 #define LOCAL_EFI_WIN_NT_BUS_DRIVER_IO_PROTOCOL_GUID \
807 0x96eb4ad6, 0xa32a, 0x11d4, { 0xbc, 0xfd, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
810 #define LOCAL_EFI_WIN_NT_SERIAL_PORT_GUID \
812 0xc95a93d, 0xa006, 0x11d4, { 0xbc, 0xfa, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
814 STATIC CONST EFI_GUID WinNtThunkProtocolGuid
= LOCAL_EFI_WIN_NT_THUNK_PROTOCOL_GUID
;
815 STATIC CONST EFI_GUID WinNtIoProtocolGuid
= LOCAL_EFI_WIN_NT_BUS_DRIVER_IO_PROTOCOL_GUID
;
816 STATIC CONST EFI_GUID WinNtSerialPortGuid
= LOCAL_EFI_WIN_NT_SERIAL_PORT_GUID
;
819 // Deprecated protocols we dont want to link from IntelFrameworkModulePkg
821 #define LOCAL_EFI_ISA_IO_PROTOCOL_GUID \
823 0x7ee2bd44, 0x3da0, 0x11d4, { 0x9a, 0x38, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
825 #define LOCAL_EFI_ISA_ACPI_PROTOCOL_GUID \
827 0x64a892dc, 0x5561, 0x4536, { 0x92, 0xc7, 0x79, 0x9b, 0xfc, 0x18, 0x33, 0x55 } \
829 STATIC CONST EFI_GUID EfiIsaIoProtocolGuid
= LOCAL_EFI_ISA_IO_PROTOCOL_GUID
;
830 STATIC CONST EFI_GUID EfiIsaAcpiProtocolGuid
= LOCAL_EFI_ISA_ACPI_PROTOCOL_GUID
;
833 STATIC CONST GUID_INFO_BLOCK mGuidStringListNT
[] = {
834 {STRING_TOKEN(STR_WINNT_THUNK
), (EFI_GUID
*)&WinNtThunkProtocolGuid
, NULL
},
835 {STRING_TOKEN(STR_WINNT_DRIVER_IO
), (EFI_GUID
*)&WinNtIoProtocolGuid
, NULL
},
836 {STRING_TOKEN(STR_WINNT_SERIAL_PORT
), (EFI_GUID
*)&WinNtSerialPortGuid
, NULL
},
837 {STRING_TOKEN(STR_UNKNOWN_DEVICE
), NULL
, NULL
},
840 STATIC CONST GUID_INFO_BLOCK mGuidStringList
[] = {
841 {STRING_TOKEN(STR_LOADED_IMAGE
), &gEfiLoadedImageProtocolGuid
, LoadedImageProtocolDumpInformation
},
842 {STRING_TOKEN(STR_DEVICE_PATH
), &gEfiDevicePathProtocolGuid
, DevicePathProtocolDumpInformation
},
843 {STRING_TOKEN(STR_IMAGE_PATH
), &gEfiLoadedImageDevicePathProtocolGuid
, DevicePathProtocolDumpInformation
},
844 {STRING_TOKEN(STR_DEVICE_PATH_UTIL
), &gEfiDevicePathUtilitiesProtocolGuid
, NULL
},
845 {STRING_TOKEN(STR_DEVICE_PATH_TXT
), &gEfiDevicePathToTextProtocolGuid
, NULL
},
846 {STRING_TOKEN(STR_DEVICE_PATH_FTXT
), &gEfiDevicePathFromTextProtocolGuid
, NULL
},
847 {STRING_TOKEN(STR_DEVICE_PATH_PC
), &gEfiPcAnsiGuid
, NULL
},
848 {STRING_TOKEN(STR_DEVICE_PATH_VT100
), &gEfiVT100Guid
, NULL
},
849 {STRING_TOKEN(STR_DEVICE_PATH_VT100P
), &gEfiVT100PlusGuid
, NULL
},
850 {STRING_TOKEN(STR_DEVICE_PATH_VTUTF8
), &gEfiVTUTF8Guid
, NULL
},
851 {STRING_TOKEN(STR_DRIVER_BINDING
), &gEfiDriverBindingProtocolGuid
, NULL
},
852 {STRING_TOKEN(STR_PLATFORM_OVERRIDE
), &gEfiPlatformDriverOverrideProtocolGuid
, NULL
},
853 {STRING_TOKEN(STR_BUS_OVERRIDE
), &gEfiBusSpecificDriverOverrideProtocolGuid
, NULL
},
854 {STRING_TOKEN(STR_DRIVER_DIAG
), &gEfiDriverDiagnosticsProtocolGuid
, NULL
},
855 {STRING_TOKEN(STR_DRIVER_DIAG2
), &gEfiDriverDiagnostics2ProtocolGuid
, NULL
},
856 {STRING_TOKEN(STR_DRIVER_CN
), &gEfiComponentNameProtocolGuid
, NULL
},
857 {STRING_TOKEN(STR_DRIVER_CN2
), &gEfiComponentName2ProtocolGuid
, NULL
},
858 {STRING_TOKEN(STR_PLAT_DRV_CFG
), &gEfiPlatformToDriverConfigurationProtocolGuid
, NULL
},
859 {STRING_TOKEN(STR_DRIVER_VERSION
), &gEfiDriverSupportedEfiVersionProtocolGuid
, DriverEfiVersionProtocolDumpInformation
},
860 {STRING_TOKEN(STR_TXT_IN
), &gEfiSimpleTextInProtocolGuid
, NULL
},
861 {STRING_TOKEN(STR_TXT_IN_EX
), &gEfiSimpleTextInputExProtocolGuid
, NULL
},
862 {STRING_TOKEN(STR_TXT_OUT
), &gEfiSimpleTextOutProtocolGuid
, TxtOutProtocolDumpInformation
},
863 {STRING_TOKEN(STR_SIM_POINTER
), &gEfiSimplePointerProtocolGuid
, NULL
},
864 {STRING_TOKEN(STR_ABS_POINTER
), &gEfiAbsolutePointerProtocolGuid
, NULL
},
865 {STRING_TOKEN(STR_SERIAL_IO
), &gEfiSerialIoProtocolGuid
, NULL
},
866 {STRING_TOKEN(STR_GRAPHICS_OUTPUT
), &gEfiGraphicsOutputProtocolGuid
, GraphicsOutputProtocolDumpInformation
},
867 {STRING_TOKEN(STR_EDID_DISCOVERED
), &gEfiEdidDiscoveredProtocolGuid
, NULL
},
868 {STRING_TOKEN(STR_EDID_ACTIVE
), &gEfiEdidActiveProtocolGuid
, NULL
},
869 {STRING_TOKEN(STR_EDID_OVERRIDE
), &gEfiEdidOverrideProtocolGuid
, NULL
},
870 {STRING_TOKEN(STR_CON_IN
), &gEfiConsoleInDeviceGuid
, NULL
},
871 {STRING_TOKEN(STR_CON_OUT
), &gEfiConsoleOutDeviceGuid
, NULL
},
872 {STRING_TOKEN(STR_STD_ERR
), &gEfiStandardErrorDeviceGuid
, NULL
},
873 {STRING_TOKEN(STR_LOAD_FILE
), &gEfiLoadFileProtocolGuid
, NULL
},
874 {STRING_TOKEN(STR_LOAD_FILE2
), &gEfiLoadFile2ProtocolGuid
, NULL
},
875 {STRING_TOKEN(STR_SIMPLE_FILE_SYS
), &gEfiSimpleFileSystemProtocolGuid
, NULL
},
876 {STRING_TOKEN(STR_TAPE_IO
), &gEfiTapeIoProtocolGuid
, NULL
},
877 {STRING_TOKEN(STR_DISK_IO
), &gEfiDiskIoProtocolGuid
, NULL
},
878 {STRING_TOKEN(STR_BLK_IO
), &gEfiBlockIoProtocolGuid
, NULL
},
879 {STRING_TOKEN(STR_UC
), &gEfiUnicodeCollationProtocolGuid
, NULL
},
880 {STRING_TOKEN(STR_UC2
), &gEfiUnicodeCollation2ProtocolGuid
, NULL
},
881 {STRING_TOKEN(STR_PCIRB_IO
), &gEfiPciRootBridgeIoProtocolGuid
, PciRootBridgeIoDumpInformation
},
882 {STRING_TOKEN(STR_PCI_IO
), &gEfiPciIoProtocolGuid
, NULL
},
883 {STRING_TOKEN(STR_SCSI_PT
), &gEfiScsiPassThruProtocolGuid
, NULL
},
884 {STRING_TOKEN(STR_SCSI_IO
), &gEfiScsiIoProtocolGuid
, NULL
},
885 {STRING_TOKEN(STR_SCSI_PT_EXT
), &gEfiExtScsiPassThruProtocolGuid
, NULL
},
886 {STRING_TOKEN(STR_ISCSI
), &gEfiIScsiInitiatorNameProtocolGuid
, NULL
},
887 {STRING_TOKEN(STR_USB_IO
), &gEfiUsbIoProtocolGuid
, NULL
},
888 {STRING_TOKEN(STR_USB_HC
), &gEfiUsbHcProtocolGuid
, NULL
},
889 {STRING_TOKEN(STR_USB_HC2
), &gEfiUsb2HcProtocolGuid
, NULL
},
890 {STRING_TOKEN(STR_DEBUG_SUPPORT
), &gEfiDebugSupportProtocolGuid
, NULL
},
891 {STRING_TOKEN(STR_DEBUG_PORT
), &gEfiDebugPortProtocolGuid
, NULL
},
892 {STRING_TOKEN(STR_DECOMPRESS
), &gEfiDecompressProtocolGuid
, NULL
},
893 {STRING_TOKEN(STR_ACPI_TABLE
), &gEfiAcpiTableProtocolGuid
, NULL
},
894 {STRING_TOKEN(STR_EBC_INTERPRETER
), &gEfiEbcProtocolGuid
, NULL
},
895 {STRING_TOKEN(STR_SNP
), &gEfiSimpleNetworkProtocolGuid
, NULL
},
896 {STRING_TOKEN(STR_NII
), &gEfiNetworkInterfaceIdentifierProtocolGuid
, NULL
},
897 {STRING_TOKEN(STR_NII_31
), &gEfiNetworkInterfaceIdentifierProtocolGuid_31
, NULL
},
898 {STRING_TOKEN(STR_PXE_BC
), &gEfiPxeBaseCodeProtocolGuid
, NULL
},
899 {STRING_TOKEN(STR_PXE_CB
), &gEfiPxeBaseCodeCallbackProtocolGuid
, NULL
},
900 {STRING_TOKEN(STR_BIS
), &gEfiBisProtocolGuid
, NULL
},
901 {STRING_TOKEN(STR_MNP_SB
), &gEfiManagedNetworkServiceBindingProtocolGuid
, NULL
},
902 {STRING_TOKEN(STR_MNP
), &gEfiManagedNetworkProtocolGuid
, NULL
},
903 {STRING_TOKEN(STR_ARP_SB
), &gEfiArpServiceBindingProtocolGuid
, NULL
},
904 {STRING_TOKEN(STR_ARP
), &gEfiArpProtocolGuid
, NULL
},
905 {STRING_TOKEN(STR_DHCPV4_SB
), &gEfiDhcp4ServiceBindingProtocolGuid
, NULL
},
906 {STRING_TOKEN(STR_DHCPV4
), &gEfiDhcp4ProtocolGuid
, NULL
},
907 {STRING_TOKEN(STR_TCPV4_SB
), &gEfiTcp4ServiceBindingProtocolGuid
, NULL
},
908 {STRING_TOKEN(STR_TCPV4
), &gEfiTcp4ProtocolGuid
, NULL
},
909 {STRING_TOKEN(STR_IPV4_SB
), &gEfiIp4ServiceBindingProtocolGuid
, NULL
},
910 {STRING_TOKEN(STR_IPV4
), &gEfiIp4ProtocolGuid
, NULL
},
911 {STRING_TOKEN(STR_IPV4_CFG
), &gEfiIp4ConfigProtocolGuid
, NULL
},
912 {STRING_TOKEN(STR_UDPV4_SB
), &gEfiUdp4ServiceBindingProtocolGuid
, NULL
},
913 {STRING_TOKEN(STR_UDPV4
), &gEfiUdp4ProtocolGuid
, NULL
},
914 {STRING_TOKEN(STR_MTFTPV4_SB
), &gEfiMtftp4ServiceBindingProtocolGuid
, NULL
},
915 {STRING_TOKEN(STR_MTFTPV4
), &gEfiMtftp4ProtocolGuid
, NULL
},
916 {STRING_TOKEN(STR_AUTH_INFO
), &gEfiAuthenticationInfoProtocolGuid
, NULL
},
917 {STRING_TOKEN(STR_HASH_SB
), &gEfiHashServiceBindingProtocolGuid
, NULL
},
918 {STRING_TOKEN(STR_HASH
), &gEfiHashProtocolGuid
, NULL
},
919 {STRING_TOKEN(STR_HII_FONT
), &gEfiHiiFontProtocolGuid
, NULL
},
920 {STRING_TOKEN(STR_HII_STRING
), &gEfiHiiStringProtocolGuid
, NULL
},
921 {STRING_TOKEN(STR_HII_IMAGE
), &gEfiHiiImageProtocolGuid
, NULL
},
922 {STRING_TOKEN(STR_HII_DATABASE
), &gEfiHiiDatabaseProtocolGuid
, NULL
},
923 {STRING_TOKEN(STR_HII_CONFIG_ROUT
), &gEfiHiiConfigRoutingProtocolGuid
, NULL
},
924 {STRING_TOKEN(STR_HII_CONFIG_ACC
), &gEfiHiiConfigAccessProtocolGuid
, NULL
},
925 {STRING_TOKEN(STR_HII_FORM_BROWSER2
), &gEfiFormBrowser2ProtocolGuid
, NULL
},
926 {STRING_TOKEN(STR_DRIVER_FAM_OVERRIDE
), &gEfiDriverFamilyOverrideProtocolGuid
, NULL
},
927 {STRING_TOKEN(STR_PCD
), &gPcdProtocolGuid
, NULL
},
928 {STRING_TOKEN(STR_TCG
), &gEfiTcgProtocolGuid
, NULL
},
929 {STRING_TOKEN(STR_HII_PACKAGE_LIST
), &gEfiHiiPackageListProtocolGuid
, NULL
},
932 // the ones under this are deprecated by the current UEFI Spec, but may be found anyways...
934 {STRING_TOKEN(STR_SHELL_INTERFACE
), &gEfiShellInterfaceGuid
, NULL
},
935 {STRING_TOKEN(STR_SHELL_ENV2
), &gEfiShellEnvironment2Guid
, NULL
},
936 {STRING_TOKEN(STR_SHELL_ENV
), &gEfiShellEnvironment2Guid
, NULL
},
937 {STRING_TOKEN(STR_DEVICE_IO
), &gEfiDeviceIoProtocolGuid
, NULL
},
938 {STRING_TOKEN(STR_UGA_DRAW
), &gEfiUgaDrawProtocolGuid
, NULL
},
939 {STRING_TOKEN(STR_UGA_IO
), &gEfiUgaIoProtocolGuid
, NULL
},
940 {STRING_TOKEN(STR_ESP
), &gEfiPartTypeSystemPartGuid
, NULL
},
941 {STRING_TOKEN(STR_GPT_NBR
), &gEfiPartTypeLegacyMbrGuid
, NULL
},
942 {STRING_TOKEN(STR_DRIVER_CONFIG
), &gEfiDriverConfigurationProtocolGuid
, NULL
},
943 {STRING_TOKEN(STR_DRIVER_CONFIG2
), &gEfiDriverConfiguration2ProtocolGuid
, NULL
},
946 // these are using local (non-global) definitions to reduce package dependancy.
948 {STRING_TOKEN(STR_ISA_IO
), (EFI_GUID
*)&EfiIsaIoProtocolGuid
, NULL
},
949 {STRING_TOKEN(STR_ISA_ACPI
), (EFI_GUID
*)&EfiIsaAcpiProtocolGuid
, NULL
},
952 // the ones under this are GUID identified structs, not protocols
954 {STRING_TOKEN(STR_FILE_INFO
), &gEfiFileInfoGuid
, NULL
},
955 {STRING_TOKEN(STR_FILE_SYS_INFO
), &gEfiFileSystemInfoGuid
, NULL
},
958 // the ones under this are misc GUIDS.
960 {STRING_TOKEN(STR_EFI_GLOBAL_VARIABLE
), &gEfiGlobalVariableGuid
, NULL
},
965 {STRING_TOKEN(STR_IP6_SB
), &gEfiIp6ServiceBindingProtocolGuid
, NULL
},
966 {STRING_TOKEN(STR_IP6
), &gEfiIp6ProtocolGuid
, NULL
},
967 {STRING_TOKEN(STR_IP6_CONFIG
), &gEfiIp6ConfigProtocolGuid
, NULL
},
968 {STRING_TOKEN(STR_MTFTP6_SB
), &gEfiMtftp6ServiceBindingProtocolGuid
, NULL
},
969 {STRING_TOKEN(STR_MTFTP6
), &gEfiMtftp6ProtocolGuid
, NULL
},
970 {STRING_TOKEN(STR_DHCP6_SB
), &gEfiDhcp6ServiceBindingProtocolGuid
, NULL
},
971 {STRING_TOKEN(STR_DHCP6
), &gEfiDhcp6ProtocolGuid
, NULL
},
972 {STRING_TOKEN(STR_UDP6_SB
), &gEfiUdp6ServiceBindingProtocolGuid
, NULL
},
973 {STRING_TOKEN(STR_UDP6
), &gEfiUdp6ProtocolGuid
, NULL
},
974 {STRING_TOKEN(STR_TCP6_SB
), &gEfiTcp6ServiceBindingProtocolGuid
, NULL
},
975 {STRING_TOKEN(STR_TCP6
), &gEfiTcp6ProtocolGuid
, NULL
},
976 {STRING_TOKEN(STR_VLAN_CONFIG
), &gEfiVlanConfigProtocolGuid
, NULL
},
977 {STRING_TOKEN(STR_EAP
), &gEfiEapProtocolGuid
, NULL
},
978 {STRING_TOKEN(STR_EAP_MGMT
), &gEfiEapManagementProtocolGuid
, NULL
},
979 {STRING_TOKEN(STR_FTP4_SB
), &gEfiFtp4ServiceBindingProtocolGuid
, NULL
},
980 {STRING_TOKEN(STR_FTP4
), &gEfiFtp4ProtocolGuid
, NULL
},
981 {STRING_TOKEN(STR_IP_SEC_CONFIG
), &gEfiIpSecConfigProtocolGuid
, NULL
},
982 {STRING_TOKEN(STR_DH
), &gEfiDriverHealthProtocolGuid
, NULL
},
983 {STRING_TOKEN(STR_DEF_IMG_LOAD
), &gEfiDeferredImageLoadProtocolGuid
, NULL
},
984 {STRING_TOKEN(STR_USER_CRED
), &gEfiUserCredentialProtocolGuid
, NULL
},
985 {STRING_TOKEN(STR_USER_MNGR
), &gEfiUserManagerProtocolGuid
, NULL
},
986 {STRING_TOKEN(STR_ATA_PASS_THRU
), &gEfiAtaPassThruProtocolGuid
, NULL
},
991 {STRING_TOKEN(STR_FW_MGMT
), &gEfiFirmwareManagementProtocolGuid
, NULL
},
992 {STRING_TOKEN(STR_IP_SEC
), &gEfiIpSecProtocolGuid
, NULL
},
993 {STRING_TOKEN(STR_IP_SEC2
), &gEfiIpSec2ProtocolGuid
, NULL
},
998 {STRING_TOKEN(STR_KMS
), &gEfiKmsProtocolGuid
, NULL
},
999 {STRING_TOKEN(STR_BLK_IO2
), &gEfiBlockIo2ProtocolGuid
, NULL
},
1000 {STRING_TOKEN(STR_SSC
), &gEfiStorageSecurityCommandProtocolGuid
, NULL
},
1001 {STRING_TOKEN(STR_UCRED2
), &gEfiUserCredential2ProtocolGuid
, NULL
},
1006 {STRING_TOKEN(STR_DISK_IO2
), &gEfiDiskIo2ProtocolGuid
, NULL
},
1007 {STRING_TOKEN(STR_ADAPTER_INFO
), &gEfiAdapterInformationProtocolGuid
, AdapterInformationDumpInformation
},
1012 {STRING_TOKEN(STR_IDE_CONT_INIT
), &gEfiIdeControllerInitProtocolGuid
, NULL
},
1013 {STRING_TOKEN(STR_DISK_INFO
), &gEfiDiskInfoProtocolGuid
, NULL
},
1016 // UEFI Shell Spec 2.0
1018 {STRING_TOKEN(STR_SHELL_PARAMETERS
), &gEfiShellParametersProtocolGuid
, NULL
},
1019 {STRING_TOKEN(STR_SHELL
), &gEfiShellProtocolGuid
, NULL
},
1022 // UEFI Shell Spec 2.1
1024 {STRING_TOKEN(STR_SHELL_DYNAMIC
), &gEfiShellDynamicCommandProtocolGuid
, NULL
},
1029 {STRING_TOKEN(STR_UNKNOWN_DEVICE
), NULL
, NULL
},
1033 Function to get the node for a protocol or struct from it's GUID.
1035 if Guid is NULL, then ASSERT.
1037 @param[in] Guid The GUID to look for the name of.
1041 CONST GUID_INFO_BLOCK
*
1043 InternalShellGetNodeFromGuid(
1044 IN CONST EFI_GUID
* Guid
1047 CONST GUID_INFO_BLOCK
*ListWalker
;
1050 ASSERT(Guid
!= NULL
);
1052 for (LoopCount
= 0, ListWalker
= GuidList
; GuidList
!= NULL
&& LoopCount
< GuidListCount
; LoopCount
++, ListWalker
++) {
1053 if (CompareGuid(ListWalker
->GuidId
, Guid
)) {
1054 return (ListWalker
);
1058 if (PcdGetBool(PcdShellIncludeNtGuids
)) {
1059 for (ListWalker
= mGuidStringListNT
; ListWalker
!= NULL
&& ListWalker
->GuidId
!= NULL
; ListWalker
++) {
1060 if (CompareGuid(ListWalker
->GuidId
, Guid
)) {
1061 return (ListWalker
);
1065 for (ListWalker
= mGuidStringList
; ListWalker
!= NULL
&& ListWalker
->GuidId
!= NULL
; ListWalker
++) {
1066 if (CompareGuid(ListWalker
->GuidId
, Guid
)) {
1067 return (ListWalker
);
1074 Function to add a new GUID/Name mapping.
1076 @param[in] Guid The Guid
1077 @param[in] NameID The STRING id of the HII string to use
1078 @param[in] DumpFunc The pointer to the dump function
1081 @retval EFI_SUCCESS The operation was sucessful
1082 @retval EFI_OUT_OF_RESOURCES A memory allocation failed
1083 @retval EFI_INVALID_PARAMETER Guid NameId was invalid
1087 InsertNewGuidNameMapping(
1088 IN CONST EFI_GUID
*Guid
,
1089 IN CONST EFI_STRING_ID NameID
,
1090 IN CONST DUMP_PROTOCOL_INFO DumpFunc OPTIONAL
1093 ASSERT(Guid
!= NULL
);
1094 ASSERT(NameID
!= 0);
1096 GuidList
= ReallocatePool(GuidListCount
* sizeof(GUID_INFO_BLOCK
), GuidListCount
+1 * sizeof(GUID_INFO_BLOCK
), GuidList
);
1097 if (GuidList
== NULL
) {
1099 return (EFI_OUT_OF_RESOURCES
);
1103 GuidList
[GuidListCount
- 1].GuidId
= AllocateCopyPool(sizeof(EFI_GUID
), Guid
);
1104 GuidList
[GuidListCount
- 1].StringId
= NameID
;
1105 GuidList
[GuidListCount
- 1].DumpInfo
= DumpFunc
;
1107 if (GuidList
[GuidListCount
- 1].GuidId
== NULL
) {
1108 return (EFI_OUT_OF_RESOURCES
);
1111 return (EFI_SUCCESS
);
1115 Function to add a new GUID/Name mapping.
1117 This cannot overwrite an existing mapping.
1119 @param[in] Guid The Guid
1120 @param[in] TheName The Guid's name
1121 @param[in] Lang RFC4646 language code list or NULL
1123 @retval EFI_SUCCESS The operation was sucessful
1124 @retval EFI_ACCESS_DENIED There was a duplicate
1125 @retval EFI_OUT_OF_RESOURCES A memory allocation failed
1126 @retval EFI_INVALID_PARAMETER Guid or TheName was NULL
1130 AddNewGuidNameMapping(
1131 IN CONST EFI_GUID
*Guid
,
1132 IN CONST CHAR16
*TheName
,
1133 IN CONST CHAR8
*Lang OPTIONAL
1136 EFI_STRING_ID NameID
;
1138 HandleParsingHiiInit();
1140 if (Guid
== NULL
|| TheName
== NULL
){
1141 return (EFI_INVALID_PARAMETER
);
1144 if ((InternalShellGetNodeFromGuid(Guid
)) != NULL
) {
1145 return (EFI_ACCESS_DENIED
);
1148 NameID
= HiiSetString(mHandleParsingHiiHandle
, 0, (CHAR16
*)TheName
, Lang
);
1150 return (EFI_OUT_OF_RESOURCES
);
1153 return (InsertNewGuidNameMapping(Guid
, NameID
, NULL
));
1157 Function to get the name of a protocol or struct from it's GUID.
1159 if Guid is NULL, then ASSERT.
1161 @param[in] Guid The GUID to look for the name of.
1162 @param[in] Lang The language to use.
1164 @return pointer to string of the name. The caller
1165 is responsible to free this memory.
1169 GetStringNameFromGuid(
1170 IN CONST EFI_GUID
*Guid
,
1171 IN CONST CHAR8
*Lang OPTIONAL
1174 CONST GUID_INFO_BLOCK
*Id
;
1176 HandleParsingHiiInit();
1178 Id
= InternalShellGetNodeFromGuid(Guid
);
1179 return (HiiGetString(mHandleParsingHiiHandle
, Id
==NULL
?STRING_TOKEN(STR_UNKNOWN_DEVICE
):Id
->StringId
, Lang
));
1183 Function to dump protocol information from a handle.
1185 This function will return a allocated string buffer containing the
1186 information. The caller is responsible for freeing the memory.
1188 If Guid is NULL, ASSERT().
1189 If TheHandle is NULL, ASSERT().
1191 @param[in] TheHandle The handle to dump information from.
1192 @param[in] Guid The GUID of the protocol to dump.
1193 @param[in] Verbose TRUE for extra info. FALSE otherwise.
1195 @return The pointer to string.
1196 @retval NULL An error was encountered.
1200 GetProtocolInformationDump(
1201 IN CONST EFI_HANDLE TheHandle
,
1202 IN CONST EFI_GUID
*Guid
,
1203 IN CONST BOOLEAN Verbose
1206 CONST GUID_INFO_BLOCK
*Id
;
1208 ASSERT(TheHandle
!= NULL
);
1209 ASSERT(Guid
!= NULL
);
1211 if (TheHandle
== NULL
|| Guid
== NULL
) {
1215 Id
= InternalShellGetNodeFromGuid(Guid
);
1216 if (Id
!= NULL
&& Id
->DumpInfo
!= NULL
) {
1217 return (Id
->DumpInfo(TheHandle
, Verbose
));
1223 Function to get the Guid for a protocol or struct based on it's string name.
1225 do not modify the returned Guid.
1227 @param[in] Name The pointer to the string name.
1228 @param[in] Lang The pointer to the language code.
1229 @param[out] Guid The pointer to the Guid.
1231 @retval EFI_SUCCESS The operation was sucessful.
1235 GetGuidFromStringName(
1236 IN CONST CHAR16
*Name
,
1237 IN CONST CHAR8
*Lang OPTIONAL
,
1241 CONST GUID_INFO_BLOCK
*ListWalker
;
1245 HandleParsingHiiInit();
1247 ASSERT(Guid
!= NULL
);
1249 return (EFI_INVALID_PARAMETER
);
1253 if (PcdGetBool(PcdShellIncludeNtGuids
)) {
1254 for (ListWalker
= mGuidStringListNT
; ListWalker
!= NULL
&& ListWalker
->GuidId
!= NULL
; ListWalker
++) {
1255 String
= HiiGetString(mHandleParsingHiiHandle
, ListWalker
->StringId
, Lang
);
1256 if (Name
!= NULL
&& String
!= NULL
&& StringNoCaseCompare (&Name
, &String
) == 0) {
1257 *Guid
= ListWalker
->GuidId
;
1259 SHELL_FREE_NON_NULL(String
);
1260 if (*Guid
!= NULL
) {
1261 return (EFI_SUCCESS
);
1265 for (ListWalker
= mGuidStringList
; ListWalker
!= NULL
&& ListWalker
->GuidId
!= NULL
; ListWalker
++) {
1266 String
= HiiGetString(mHandleParsingHiiHandle
, ListWalker
->StringId
, Lang
);
1267 if (Name
!= NULL
&& String
!= NULL
&& StringNoCaseCompare (&Name
, &String
) == 0) {
1268 *Guid
= ListWalker
->GuidId
;
1270 SHELL_FREE_NON_NULL(String
);
1271 if (*Guid
!= NULL
) {
1272 return (EFI_SUCCESS
);
1276 for (LoopCount
= 0, ListWalker
= GuidList
; GuidList
!= NULL
&& LoopCount
< GuidListCount
; LoopCount
++, ListWalker
++) {
1277 String
= HiiGetString(mHandleParsingHiiHandle
, ListWalker
->StringId
, Lang
);
1278 if (Name
!= NULL
&& String
!= NULL
&& StringNoCaseCompare (&Name
, &String
) == 0) {
1279 *Guid
= ListWalker
->GuidId
;
1281 SHELL_FREE_NON_NULL(String
);
1282 if (*Guid
!= NULL
) {
1283 return (EFI_SUCCESS
);
1287 return (EFI_NOT_FOUND
);
1291 Get best support language for this driver.
1293 First base on the user input language to search, second base on the current
1294 platform used language to search, third get the first language from the
1295 support language list. The caller need to free the buffer of the best language.
1297 @param[in] SupportedLanguages The support languages for this driver.
1298 @param[in] InputLanguage The user input language.
1299 @param[in] Iso639Language Whether get language for ISO639.
1301 @return The best support language for this driver.
1305 GetBestLanguageForDriver (
1306 IN CONST CHAR8
*SupportedLanguages
,
1307 IN CONST CHAR8
*InputLanguage
,
1308 IN BOOLEAN Iso639Language
1311 CHAR8
*LanguageVariable
;
1312 CHAR8
*BestLanguage
;
1314 LanguageVariable
= GetVariable (Iso639Language
? L
"Lang" : L
"PlatformLang", &gEfiGlobalVariableGuid
);
1316 BestLanguage
= GetBestLanguage(
1319 (InputLanguage
!= NULL
) ? InputLanguage
: "",
1320 (LanguageVariable
!= NULL
) ? LanguageVariable
: "",
1325 if (LanguageVariable
!= NULL
) {
1326 FreePool (LanguageVariable
);
1329 return BestLanguage
;
1333 Function to retrieve the driver name (if possible) from the ComponentName or
1334 ComponentName2 protocol
1336 @param[in] TheHandle The driver handle to get the name of.
1337 @param[in] Language The language to use.
1339 @retval NULL The name could not be found.
1340 @return A pointer to the string name. Do not de-allocate the memory.
1344 GetStringNameFromHandle(
1345 IN CONST EFI_HANDLE TheHandle
,
1346 IN CONST CHAR8
*Language
1349 EFI_COMPONENT_NAME2_PROTOCOL
*CompNameStruct
;
1356 Status
= gBS
->OpenProtocol(
1358 &gEfiComponentName2ProtocolGuid
,
1359 (VOID
**)&CompNameStruct
,
1362 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
1363 if (!EFI_ERROR(Status
)) {
1364 BestLang
= GetBestLanguageForDriver (CompNameStruct
->SupportedLanguages
, Language
, FALSE
);
1365 Status
= CompNameStruct
->GetDriverName(CompNameStruct
, BestLang
, &RetVal
);
1366 if (BestLang
!= NULL
) {
1367 FreePool (BestLang
);
1370 if (!EFI_ERROR(Status
)) {
1374 Status
= gBS
->OpenProtocol(
1376 &gEfiComponentNameProtocolGuid
,
1377 (VOID
**)&CompNameStruct
,
1380 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
1381 if (!EFI_ERROR(Status
)) {
1382 BestLang
= GetBestLanguageForDriver (CompNameStruct
->SupportedLanguages
, Language
, FALSE
);
1383 Status
= CompNameStruct
->GetDriverName(CompNameStruct
, BestLang
, &RetVal
);
1384 if (BestLang
!= NULL
) {
1385 FreePool (BestLang
);
1387 if (!EFI_ERROR(Status
)) {
1395 Function to initialize the file global mHandleList object for use in
1396 vonverting handles to index and index to handle.
1398 @retval EFI_SUCCESS The operation was successful.
1402 InternalShellInitHandleList(
1407 EFI_HANDLE
*HandleBuffer
;
1409 HANDLE_LIST
*ListWalker
;
1411 if (mHandleList
.NextIndex
!= 0) {
1414 InitializeListHead(&mHandleList
.List
.Link
);
1415 mHandleList
.NextIndex
= 1;
1416 Status
= gBS
->LocateHandleBuffer (
1423 ASSERT_EFI_ERROR(Status
);
1424 if (EFI_ERROR(Status
)) {
1427 for (mHandleList
.NextIndex
= 1 ; mHandleList
.NextIndex
<= HandleCount
; mHandleList
.NextIndex
++){
1428 ListWalker
= AllocateZeroPool(sizeof(HANDLE_LIST
));
1429 ASSERT(ListWalker
!= NULL
);
1430 ListWalker
->TheHandle
= HandleBuffer
[mHandleList
.NextIndex
-1];
1431 ListWalker
->TheIndex
= mHandleList
.NextIndex
;
1432 InsertTailList(&mHandleList
.List
.Link
,&ListWalker
->Link
);
1434 FreePool(HandleBuffer
);
1435 return (EFI_SUCCESS
);
1439 Function to retrieve the human-friendly index of a given handle. If the handle
1440 does not have a index one will be automatically assigned. The index value is valid
1441 until the termination of the shell application.
1443 @param[in] TheHandle The handle to retrieve an index for.
1445 @retval 0 A memory allocation failed.
1446 @return The index of the handle.
1451 ConvertHandleToHandleIndex(
1452 IN CONST EFI_HANDLE TheHandle
1456 EFI_GUID
**ProtocolBuffer
;
1457 UINTN ProtocolCount
;
1458 HANDLE_LIST
*ListWalker
;
1460 if (TheHandle
== NULL
) {
1464 InternalShellInitHandleList();
1466 for (ListWalker
= (HANDLE_LIST
*)GetFirstNode(&mHandleList
.List
.Link
)
1467 ; !IsNull(&mHandleList
.List
.Link
,&ListWalker
->Link
)
1468 ; ListWalker
= (HANDLE_LIST
*)GetNextNode(&mHandleList
.List
.Link
,&ListWalker
->Link
)
1470 if (ListWalker
->TheHandle
== TheHandle
) {
1472 // Verify that TheHandle is still present in the Handle Database
1474 Status
= gBS
->ProtocolsPerHandle(TheHandle
, &ProtocolBuffer
, &ProtocolCount
);
1475 if (EFI_ERROR (Status
)) {
1477 // TheHandle is not present in the Handle Database, so delete from the handle list
1479 RemoveEntryList (&ListWalker
->Link
);
1482 FreePool (ProtocolBuffer
);
1483 return (ListWalker
->TheIndex
);
1488 // Verify that TheHandle is valid handle
1490 Status
= gBS
->ProtocolsPerHandle(TheHandle
, &ProtocolBuffer
, &ProtocolCount
);
1491 if (EFI_ERROR (Status
)) {
1493 // TheHandle is not valid, so do not add to handle list
1497 FreePool (ProtocolBuffer
);
1499 ListWalker
= AllocateZeroPool(sizeof(HANDLE_LIST
));
1500 ASSERT(ListWalker
!= NULL
);
1501 ListWalker
->TheHandle
= TheHandle
;
1502 ListWalker
->TheIndex
= mHandleList
.NextIndex
++;
1503 InsertTailList(&mHandleList
.List
.Link
,&ListWalker
->Link
);
1504 return (ListWalker
->TheIndex
);
1510 Function to retrieve the EFI_HANDLE from the human-friendly index.
1512 @param[in] TheIndex The index to retrieve the EFI_HANDLE for.
1514 @retval NULL The index was invalid.
1515 @return The EFI_HANDLE that index represents.
1520 ConvertHandleIndexToHandle(
1521 IN CONST UINTN TheIndex
1525 EFI_GUID
**ProtocolBuffer
;
1526 UINTN ProtocolCount
;
1527 HANDLE_LIST
*ListWalker
;
1529 InternalShellInitHandleList();
1531 if (TheIndex
>= mHandleList
.NextIndex
) {
1535 for (ListWalker
= (HANDLE_LIST
*)GetFirstNode(&mHandleList
.List
.Link
)
1536 ; !IsNull(&mHandleList
.List
.Link
,&ListWalker
->Link
)
1537 ; ListWalker
= (HANDLE_LIST
*)GetNextNode(&mHandleList
.List
.Link
,&ListWalker
->Link
)
1539 if (ListWalker
->TheIndex
== TheIndex
&& ListWalker
->TheHandle
!= NULL
) {
1541 // Verify that LinkWalker->TheHandle is valid handle
1543 Status
= gBS
->ProtocolsPerHandle(ListWalker
->TheHandle
, &ProtocolBuffer
, &ProtocolCount
);
1544 if (EFI_ERROR (Status
)) {
1546 // TheHandle is not valid, so do not add to handle list
1548 ListWalker
->TheHandle
= NULL
;
1550 return (ListWalker
->TheHandle
);
1557 Gets all the related EFI_HANDLEs based on the mask supplied.
1559 This function scans all EFI_HANDLES in the UEFI environment's handle database
1560 and returns the ones with the specified relationship (Mask) to the specified
1563 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.
1564 If MatchingHandleCount is NULL, then ASSERT.
1566 If MatchingHandleBuffer is not NULL upon a successful return the memory must be
1569 @param[in] DriverBindingHandle The handle with Driver Binding protocol on it.
1570 @param[in] ControllerHandle The handle with Device Path protocol on it.
1571 @param[in] MatchingHandleCount The pointer to UINTN that specifies the number of HANDLES in
1572 MatchingHandleBuffer.
1573 @param[out] MatchingHandleBuffer On a successful return, a buffer of MatchingHandleCount
1574 EFI_HANDLEs with a terminating NULL EFI_HANDLE.
1575 @param[out] HandleType An array of type information.
1577 @retval EFI_SUCCESS The operation was successful, and any related handles
1578 are in MatchingHandleBuffer.
1579 @retval EFI_NOT_FOUND No matching handles were found.
1580 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.
1584 ParseHandleDatabaseByRelationshipWithType (
1585 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL
,
1586 IN CONST EFI_HANDLE ControllerHandle OPTIONAL
,
1587 IN UINTN
*HandleCount
,
1588 OUT EFI_HANDLE
**HandleBuffer
,
1589 OUT UINTN
**HandleType
1594 EFI_GUID
**ProtocolGuidArray
;
1596 UINTN ProtocolIndex
;
1597 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
*OpenInfo
;
1598 UINTN OpenInfoCount
;
1599 UINTN OpenInfoIndex
;
1601 INTN DriverBindingHandleIndex
;
1603 ASSERT(HandleCount
!= NULL
);
1604 ASSERT(HandleBuffer
!= NULL
);
1605 ASSERT(HandleType
!= NULL
);
1606 ASSERT(DriverBindingHandle
!= NULL
|| ControllerHandle
!= NULL
);
1609 *HandleBuffer
= NULL
;
1613 // Retrieve the list of all handles from the handle database
1615 Status
= gBS
->LocateHandleBuffer (
1622 if (EFI_ERROR (Status
)) {
1626 *HandleType
= AllocateZeroPool (*HandleCount
* sizeof (UINTN
));
1627 ASSERT(*HandleType
!= NULL
);
1629 DriverBindingHandleIndex
= -1;
1630 for (HandleIndex
= 0; HandleIndex
< *HandleCount
; HandleIndex
++) {
1631 if (DriverBindingHandle
!= NULL
&& (*HandleBuffer
)[HandleIndex
] == DriverBindingHandle
) {
1632 DriverBindingHandleIndex
= (INTN
)HandleIndex
;
1636 for (HandleIndex
= 0; HandleIndex
< *HandleCount
; HandleIndex
++) {
1638 // Retrieve the list of all the protocols on each handle
1640 Status
= gBS
->ProtocolsPerHandle (
1641 (*HandleBuffer
)[HandleIndex
],
1645 if (EFI_ERROR (Status
)) {
1649 for (ProtocolIndex
= 0; ProtocolIndex
< ArrayCount
; ProtocolIndex
++) {
1652 // Set the bit describing what this handle has
1654 if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiLoadedImageProtocolGuid
) ) {
1655 (*HandleType
)[HandleIndex
] |= (UINTN
)HR_IMAGE_HANDLE
;
1656 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiDriverBindingProtocolGuid
) ) {
1657 (*HandleType
)[HandleIndex
] |= (UINTN
)HR_DRIVER_BINDING_HANDLE
;
1658 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiDriverConfiguration2ProtocolGuid
)) {
1659 (*HandleType
)[HandleIndex
] |= (UINTN
)HR_DRIVER_CONFIGURATION_HANDLE
;
1660 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiDriverConfigurationProtocolGuid
) ) {
1661 (*HandleType
)[HandleIndex
] |= (UINTN
)HR_DRIVER_CONFIGURATION_HANDLE
;
1662 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiDriverDiagnostics2ProtocolGuid
) ) {
1663 (*HandleType
)[HandleIndex
] |= (UINTN
)HR_DRIVER_DIAGNOSTICS_HANDLE
;
1664 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiDriverDiagnosticsProtocolGuid
) ) {
1665 (*HandleType
)[HandleIndex
] |= (UINTN
)HR_DRIVER_DIAGNOSTICS_HANDLE
;
1666 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiComponentName2ProtocolGuid
) ) {
1667 (*HandleType
)[HandleIndex
] |= (UINTN
)HR_COMPONENT_NAME_HANDLE
;
1668 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiComponentNameProtocolGuid
) ) {
1669 (*HandleType
)[HandleIndex
] |= (UINTN
)HR_COMPONENT_NAME_HANDLE
;
1670 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiDevicePathProtocolGuid
) ) {
1671 (*HandleType
)[HandleIndex
] |= (UINTN
)HR_DEVICE_HANDLE
;
1674 ASSERT((*HandleType
)[HandleIndex
] == (*HandleType
)[HandleIndex
]);
1678 // Retrieve the list of agents that have opened each protocol
1680 Status
= gBS
->OpenProtocolInformation (
1681 (*HandleBuffer
)[HandleIndex
],
1682 ProtocolGuidArray
[ProtocolIndex
],
1686 if (EFI_ERROR (Status
)) {
1690 if (ControllerHandle
== NULL
) {
1692 // ControllerHandle == NULL and DriverBindingHandle != NULL.
1693 // Return information on all the controller handles that the driver specified by DriverBindingHandle is managing
1695 for (OpenInfoIndex
= 0; OpenInfoIndex
< OpenInfoCount
; OpenInfoIndex
++) {
1696 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== DriverBindingHandle
&& (OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_DRIVER
) != 0) {
1697 (*HandleType
)[HandleIndex
] |= (UINTN
)(HR_DEVICE_HANDLE
| HR_CONTROLLER_HANDLE
);
1698 if (DriverBindingHandleIndex
!= -1) {
1699 (*HandleType
)[DriverBindingHandleIndex
] |= (UINTN
)HR_DEVICE_DRIVER
;
1702 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== DriverBindingHandle
&& (OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) != 0) {
1703 (*HandleType
)[HandleIndex
] |= (UINTN
)(HR_DEVICE_HANDLE
| HR_CONTROLLER_HANDLE
);
1704 if (DriverBindingHandleIndex
!= -1) {
1705 (*HandleType
)[DriverBindingHandleIndex
] |= (UINTN
)(HR_BUS_DRIVER
| HR_DEVICE_DRIVER
);
1707 for (ChildIndex
= 0; ChildIndex
< *HandleCount
; ChildIndex
++) {
1708 if (OpenInfo
[OpenInfoIndex
].ControllerHandle
== (*HandleBuffer
)[ChildIndex
]) {
1709 (*HandleType
)[ChildIndex
] |= (UINTN
)(HR_DEVICE_HANDLE
| HR_CHILD_HANDLE
);
1715 if (DriverBindingHandle
== NULL
&& ControllerHandle
!= NULL
) {
1716 if (ControllerHandle
== (*HandleBuffer
)[HandleIndex
]) {
1717 (*HandleType
)[HandleIndex
] |= (UINTN
)(HR_DEVICE_HANDLE
| HR_CONTROLLER_HANDLE
);
1718 for (OpenInfoIndex
= 0; OpenInfoIndex
< OpenInfoCount
; OpenInfoIndex
++) {
1719 if ((OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_DRIVER
) != 0) {
1720 for (ChildIndex
= 0; ChildIndex
< *HandleCount
; ChildIndex
++) {
1721 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== (*HandleBuffer
)[ChildIndex
]) {
1722 (*HandleType
)[ChildIndex
] |= (UINTN
)HR_DEVICE_DRIVER
;
1726 if ((OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) != 0) {
1727 for (ChildIndex
= 0; ChildIndex
< *HandleCount
; ChildIndex
++) {
1728 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== (*HandleBuffer
)[ChildIndex
]) {
1729 (*HandleType
)[ChildIndex
] |= (UINTN
)(HR_BUS_DRIVER
| HR_DEVICE_DRIVER
);
1731 if (OpenInfo
[OpenInfoIndex
].ControllerHandle
== (*HandleBuffer
)[ChildIndex
]) {
1732 (*HandleType
)[ChildIndex
] |= (UINTN
)(HR_DEVICE_HANDLE
| HR_CHILD_HANDLE
);
1738 for (OpenInfoIndex
= 0; OpenInfoIndex
< OpenInfoCount
; OpenInfoIndex
++) {
1739 if ((OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) != 0) {
1740 if (OpenInfo
[OpenInfoIndex
].ControllerHandle
== ControllerHandle
) {
1741 (*HandleType
)[HandleIndex
] |= (UINTN
)(HR_DEVICE_HANDLE
| HR_PARENT_HANDLE
);
1747 if (DriverBindingHandle
!= NULL
&& ControllerHandle
!= NULL
) {
1748 if (ControllerHandle
== (*HandleBuffer
)[HandleIndex
]) {
1749 (*HandleType
)[HandleIndex
] |= (UINTN
)(HR_DEVICE_HANDLE
| HR_CONTROLLER_HANDLE
);
1750 for (OpenInfoIndex
= 0; OpenInfoIndex
< OpenInfoCount
; OpenInfoIndex
++) {
1751 if ((OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_DRIVER
) != 0) {
1752 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== DriverBindingHandle
) {
1753 if (DriverBindingHandleIndex
!= -1) {
1754 (*HandleType
)[DriverBindingHandleIndex
] |= (UINTN
)HR_DEVICE_DRIVER
;
1758 if ((OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) != 0) {
1759 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== DriverBindingHandle
) {
1760 for (ChildIndex
= 0; ChildIndex
< *HandleCount
; ChildIndex
++) {
1761 if (OpenInfo
[OpenInfoIndex
].ControllerHandle
== (*HandleBuffer
)[ChildIndex
]) {
1762 (*HandleType
)[ChildIndex
] |= (UINTN
)(HR_DEVICE_HANDLE
| HR_CHILD_HANDLE
);
1767 for (ChildIndex
= 0; ChildIndex
< *HandleCount
; ChildIndex
++) {
1768 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== (*HandleBuffer
)[ChildIndex
]) {
1769 (*HandleType
)[ChildIndex
] |= (UINTN
)(HR_BUS_DRIVER
| HR_DEVICE_DRIVER
);
1775 for (OpenInfoIndex
= 0; OpenInfoIndex
< OpenInfoCount
; OpenInfoIndex
++) {
1776 if ((OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) != 0) {
1777 if (OpenInfo
[OpenInfoIndex
].ControllerHandle
== ControllerHandle
) {
1778 (*HandleType
)[HandleIndex
] |= (UINTN
)(HR_DEVICE_HANDLE
| HR_PARENT_HANDLE
);
1784 FreePool (OpenInfo
);
1786 FreePool (ProtocolGuidArray
);
1792 Gets all the related EFI_HANDLEs based on the single EFI_HANDLE and the mask
1795 This function will scan all EFI_HANDLES in the UEFI environment's handle database
1796 and return all the ones with the specified relationship (Mask) to the specified
1799 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.
1800 If MatchingHandleCount is NULL, then ASSERT.
1802 If MatchingHandleBuffer is not NULL upon a sucessful return the memory must be
1805 @param[in] DriverBindingHandle Handle to a object with Driver Binding protocol
1807 @param[in] ControllerHandle Handle to a device with Device Path protocol on it.
1808 @param[in] Mask Mask of what relationship(s) is desired.
1809 @param[in] MatchingHandleCount Poitner to UINTN specifying number of HANDLES in
1810 MatchingHandleBuffer.
1811 @param[out] MatchingHandleBuffer On a sucessful return a buffer of MatchingHandleCount
1812 EFI_HANDLEs and a terminating NULL EFI_HANDLE.
1814 @retval EFI_SUCCESS The operation was sucessful and any related handles
1815 are in MatchingHandleBuffer;
1816 @retval EFI_NOT_FOUND No matching handles were found.
1817 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.
1821 ParseHandleDatabaseByRelationship (
1822 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL
,
1823 IN CONST EFI_HANDLE ControllerHandle OPTIONAL
,
1824 IN CONST UINTN Mask
,
1825 IN UINTN
*MatchingHandleCount
,
1826 OUT EFI_HANDLE
**MatchingHandleBuffer OPTIONAL
1831 EFI_HANDLE
*HandleBuffer
;
1835 ASSERT(MatchingHandleCount
!= NULL
);
1836 ASSERT(DriverBindingHandle
!= NULL
|| ControllerHandle
!= NULL
);
1838 if ((Mask
& HR_VALID_MASK
) != Mask
) {
1839 return (EFI_INVALID_PARAMETER
);
1842 if ((Mask
& HR_CHILD_HANDLE
) != 0 && DriverBindingHandle
== NULL
) {
1843 return (EFI_INVALID_PARAMETER
);
1846 *MatchingHandleCount
= 0;
1847 if (MatchingHandleBuffer
!= NULL
) {
1848 *MatchingHandleBuffer
= NULL
;
1851 HandleBuffer
= NULL
;
1854 Status
= ParseHandleDatabaseByRelationshipWithType (
1855 DriverBindingHandle
,
1861 if (!EFI_ERROR (Status
)) {
1863 // Count the number of handles that match the attributes in Mask
1865 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
1866 if ((HandleType
[HandleIndex
] & Mask
) == Mask
) {
1867 (*MatchingHandleCount
)++;
1871 // If no handles match the attributes in Mask then return EFI_NOT_FOUND
1873 if (*MatchingHandleCount
== 0) {
1874 Status
= EFI_NOT_FOUND
;
1877 if (MatchingHandleBuffer
== NULL
) {
1879 // Someone just wanted the count...
1881 Status
= EFI_SUCCESS
;
1884 // Allocate a handle buffer for the number of handles that matched the attributes in Mask
1886 *MatchingHandleBuffer
= AllocateZeroPool ((*MatchingHandleCount
+1)* sizeof (EFI_HANDLE
));
1887 ASSERT(*MatchingHandleBuffer
!= NULL
);
1889 for (HandleIndex
= 0,*MatchingHandleCount
= 0
1890 ; HandleIndex
< HandleCount
1894 // Fill the allocated buffer with the handles that matched the attributes in Mask
1896 if ((HandleType
[HandleIndex
] & Mask
) == Mask
) {
1897 (*MatchingHandleBuffer
)[(*MatchingHandleCount
)++] = HandleBuffer
[HandleIndex
];
1902 // Make the last one NULL
1904 (*MatchingHandleBuffer
)[*MatchingHandleCount
] = NULL
;
1906 Status
= EFI_SUCCESS
;
1907 } // MacthingHandleBuffer == NULL (ELSE)
1908 } // *MatchingHandleCount == 0 (ELSE)
1909 } // no error on ParseHandleDatabaseByRelationshipWithType
1911 if (HandleBuffer
!= NULL
) {
1912 FreePool (HandleBuffer
);
1915 if (HandleType
!= NULL
) {
1916 FreePool (HandleType
);
1923 Gets handles for any child controllers of the passed in controller.
1925 @param[in] ControllerHandle The handle of the "parent controller"
1926 @param[in] MatchingHandleCount Pointer to the number of handles in
1927 MatchingHandleBuffer on return.
1928 @param[out] MatchingHandleBuffer Buffer containing handles on a successful
1932 @retval EFI_SUCCESS The operation was sucessful.
1936 ParseHandleDatabaseForChildControllers(
1937 IN CONST EFI_HANDLE ControllerHandle
,
1938 IN UINTN
*MatchingHandleCount
,
1939 OUT EFI_HANDLE
**MatchingHandleBuffer OPTIONAL
1944 UINTN DriverBindingHandleCount
;
1945 EFI_HANDLE
*DriverBindingHandleBuffer
;
1946 UINTN DriverBindingHandleIndex
;
1947 UINTN ChildControllerHandleCount
;
1948 EFI_HANDLE
*ChildControllerHandleBuffer
;
1949 UINTN ChildControllerHandleIndex
;
1950 EFI_HANDLE
*HandleBufferForReturn
;
1952 if (MatchingHandleCount
== NULL
) {
1953 return (EFI_INVALID_PARAMETER
);
1955 *MatchingHandleCount
= 0;
1957 Status
= PARSE_HANDLE_DATABASE_UEFI_DRIVERS (
1959 &DriverBindingHandleCount
,
1960 &DriverBindingHandleBuffer
1962 if (EFI_ERROR (Status
)) {
1967 // Get a buffer big enough for all the controllers.
1969 HandleBufferForReturn
= GetHandleListByProtocol(NULL
);
1970 if (HandleBufferForReturn
== NULL
) {
1971 FreePool (DriverBindingHandleBuffer
);
1972 return (EFI_NOT_FOUND
);
1975 for (DriverBindingHandleIndex
= 0; DriverBindingHandleIndex
< DriverBindingHandleCount
; DriverBindingHandleIndex
++) {
1976 Status
= PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (
1977 DriverBindingHandleBuffer
[DriverBindingHandleIndex
],
1979 &ChildControllerHandleCount
,
1980 &ChildControllerHandleBuffer
1982 if (EFI_ERROR (Status
)) {
1986 for (ChildControllerHandleIndex
= 0;
1987 ChildControllerHandleIndex
< ChildControllerHandleCount
;
1988 ChildControllerHandleIndex
++
1990 for (HandleIndex
= 0; HandleIndex
< *MatchingHandleCount
; HandleIndex
++) {
1991 if (HandleBufferForReturn
[HandleIndex
] == ChildControllerHandleBuffer
[ChildControllerHandleIndex
]) {
1995 if (HandleIndex
>= *MatchingHandleCount
) {
1996 HandleBufferForReturn
[(*MatchingHandleCount
)++] = ChildControllerHandleBuffer
[ChildControllerHandleIndex
];
2000 FreePool (ChildControllerHandleBuffer
);
2003 FreePool (DriverBindingHandleBuffer
);
2005 if (MatchingHandleBuffer
!= NULL
) {
2006 *MatchingHandleBuffer
= HandleBufferForReturn
;
2008 FreePool(HandleBufferForReturn
);
2011 return (EFI_SUCCESS
);
2015 Appends 1 buffer to another buffer. This will re-allocate the destination buffer
2016 if necessary to fit all of the data.
2018 If DestinationBuffer is NULL, then ASSERT().
2020 @param[in, out] DestinationBuffer The pointer to the pointer to the buffer to append onto.
2021 @param[in, out] DestinationSize The pointer to the size of DestinationBuffer.
2022 @param[in] SourceBuffer The pointer to the buffer to append onto DestinationBuffer.
2023 @param[in] SourceSize The number of bytes of SourceBuffer to append.
2025 @retval NULL A memory allocation failed.
2026 @retval NULL A parameter was invalid.
2027 @return A pointer to (*DestinationBuffer).
2032 IN OUT VOID
**DestinationBuffer
,
2033 IN OUT UINTN
*DestinationSize
,
2034 IN VOID
*SourceBuffer
,
2038 UINTN LocalDestinationSize
;
2039 UINTN LocalDestinationFinalSize
;
2041 ASSERT(DestinationBuffer
!= NULL
);
2043 if (SourceSize
== 0 || SourceBuffer
== NULL
) {
2044 return (*DestinationBuffer
);
2047 if (DestinationSize
== NULL
) {
2048 LocalDestinationSize
= 0;
2050 LocalDestinationSize
= *DestinationSize
;
2053 LocalDestinationFinalSize
= LocalDestinationSize
+ SourceSize
;
2055 if (DestinationSize
!= NULL
) {
2056 *DestinationSize
= LocalDestinationSize
;
2059 if (LocalDestinationSize
== 0) {
2061 *DestinationBuffer
= AllocateZeroPool(LocalDestinationFinalSize
);
2064 *DestinationBuffer
= ReallocatePool(LocalDestinationSize
, LocalDestinationFinalSize
, *DestinationBuffer
);
2067 ASSERT(*DestinationBuffer
!= NULL
);
2070 return (CopyMem(((UINT8
*)(*DestinationBuffer
)) + LocalDestinationSize
, SourceBuffer
, SourceSize
));
2074 Gets handles for any child devices produced by the passed in driver.
2076 @param[in] DriverHandle The handle of the driver.
2077 @param[in] MatchingHandleCount Pointer to the number of handles in
2078 MatchingHandleBuffer on return.
2079 @param[out] MatchingHandleBuffer Buffer containing handles on a successful
2081 @retval EFI_SUCCESS The operation was sucessful.
2082 @sa ParseHandleDatabaseByRelationship
2086 ParseHandleDatabaseForChildDevices(
2087 IN CONST EFI_HANDLE DriverHandle
,
2088 IN UINTN
*MatchingHandleCount
,
2089 OUT EFI_HANDLE
**MatchingHandleBuffer OPTIONAL
2093 EFI_HANDLE
*Buffer2
;
2098 UINTN HandleBufferSize
;
2100 ASSERT(MatchingHandleCount
!= NULL
);
2102 HandleBufferSize
= 0;
2105 *MatchingHandleCount
= 0;
2107 Status
= PARSE_HANDLE_DATABASE_DEVICES (
2112 if (!EFI_ERROR (Status
)) {
2113 for (HandleIndex
= 0; HandleIndex
< Count1
; HandleIndex
++) {
2115 // now find the children
2117 Status
= PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (
2119 Buffer
[HandleIndex
],
2123 if (EFI_ERROR(Status
)) {
2127 // save out required and optional data elements
2129 *MatchingHandleCount
+= Count2
;
2130 if (MatchingHandleBuffer
!= NULL
) {
2131 *MatchingHandleBuffer
= BuffernCatGrow((VOID
**)MatchingHandleBuffer
, &HandleBufferSize
, Buffer2
, Count2
* sizeof(Buffer2
[0]));
2137 if (Buffer2
!= NULL
) {
2143 if (Buffer
!= NULL
) {
2150 Function to get all handles that support a given protocol or all handles.
2152 @param[in] ProtocolGuid The guid of the protocol to get handles for. If NULL
2153 then the function will return all handles.
2155 @retval NULL A memory allocation failed.
2156 @return A NULL terminated list of handles.
2160 GetHandleListByProtocol (
2161 IN CONST EFI_GUID
*ProtocolGuid OPTIONAL
2164 EFI_HANDLE
*HandleList
;
2172 // We cannot use LocateHandleBuffer since we need that NULL item on the ends of the list!
2174 if (ProtocolGuid
== NULL
) {
2175 Status
= gBS
->LocateHandle(AllHandles
, NULL
, NULL
, &Size
, HandleList
);
2176 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2177 HandleList
= AllocateZeroPool(Size
+ sizeof(EFI_HANDLE
));
2178 if (HandleList
== NULL
) {
2181 Status
= gBS
->LocateHandle(AllHandles
, NULL
, NULL
, &Size
, HandleList
);
2182 HandleList
[Size
/sizeof(EFI_HANDLE
)] = NULL
;
2185 Status
= gBS
->LocateHandle(ByProtocol
, (EFI_GUID
*)ProtocolGuid
, NULL
, &Size
, HandleList
);
2186 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2187 HandleList
= AllocateZeroPool(Size
+ sizeof(EFI_HANDLE
));
2188 if (HandleList
== NULL
) {
2191 Status
= gBS
->LocateHandle(ByProtocol
, (EFI_GUID
*)ProtocolGuid
, NULL
, &Size
, HandleList
);
2192 HandleList
[Size
/sizeof(EFI_HANDLE
)] = NULL
;
2195 if (EFI_ERROR(Status
)) {
2196 if (HandleList
!= NULL
) {
2197 FreePool(HandleList
);
2201 return (HandleList
);
2205 Function to get all handles that support some protocols.
2207 @param[in] ProtocolGuids A NULL terminated list of protocol GUIDs.
2209 @retval NULL A memory allocation failed.
2210 @retval NULL ProtocolGuids was NULL.
2211 @return A NULL terminated list of EFI_HANDLEs.
2215 GetHandleListByProtocolList (
2216 IN CONST EFI_GUID
**ProtocolGuids
2219 EFI_HANDLE
*HandleList
;
2224 CONST EFI_GUID
**GuidWalker
;
2225 EFI_HANDLE
*HandleWalker1
;
2226 EFI_HANDLE
*HandleWalker2
;
2230 TotalSize
= sizeof(EFI_HANDLE
);
2232 for (GuidWalker
= ProtocolGuids
; GuidWalker
!= NULL
&& *GuidWalker
!= NULL
; GuidWalker
++,Size
= 0){
2233 Status
= gBS
->LocateHandle(ByProtocol
, (EFI_GUID
*)(*GuidWalker
), NULL
, &Size
, NULL
);
2234 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2240 // No handles were found...
2242 if (TotalSize
== sizeof(EFI_HANDLE
)) {
2246 HandleList
= AllocateZeroPool(TotalSize
);
2247 if (HandleList
== NULL
) {
2252 for (GuidWalker
= ProtocolGuids
; GuidWalker
!= NULL
&& *GuidWalker
!= NULL
; GuidWalker
++){
2253 TempSize
= TotalSize
- Size
;
2254 Status
= gBS
->LocateHandle(ByProtocol
, (EFI_GUID
*)(*GuidWalker
), NULL
, &TempSize
, HandleList
+(Size
/sizeof(EFI_HANDLE
)));
2257 // Allow for missing protocols... Only update the 'used' size upon success.
2259 if (!EFI_ERROR(Status
)) {
2263 ASSERT(HandleList
[(TotalSize
/sizeof(EFI_HANDLE
))-1] == NULL
);
2265 for (HandleWalker1
= HandleList
; HandleWalker1
!= NULL
&& *HandleWalker1
!= NULL
; HandleWalker1
++) {
2266 for (HandleWalker2
= HandleWalker1
+ 1; HandleWalker2
!= NULL
&& *HandleWalker2
!= NULL
; HandleWalker2
++) {
2267 if (*HandleWalker1
== *HandleWalker2
) {
2269 // copy memory back 1 handle width.
2271 CopyMem(HandleWalker2
, HandleWalker2
+ 1, TotalSize
- ((HandleWalker2
-HandleList
+1)*sizeof(EFI_HANDLE
)));
2276 return (HandleList
);