2 Provides interface to advanced shell functionality for parsing both handle and protocol database.
4 Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>
5 (C) Copyright 2013-2015 Hewlett-Packard Development Company, L.P.<BR>
6 (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #include "UefiHandleParsingLib.h"
18 #include "IndustryStandard/Acpi10.h"
20 EFI_HANDLE mHandleParsingHiiHandle
= NULL
;
21 HANDLE_INDEX_LIST mHandleList
= {{{NULL
,NULL
},0,0},0};
22 GUID_INFO_BLOCK
*mGuidList
;
25 Function to translate the EFI_MEMORY_TYPE into a string.
27 @param[in] Memory The memory type.
29 @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.
69 IN CONST EFI_GRAPHICS_PIXEL_FORMAT Fmt
76 case PixelRedGreenBlueReserved8BitPerColor
: StrnCatGrow(&RetVal
, NULL
, L
"PixelRedGreenBlueReserved8BitPerColor", 0); break;
77 case PixelBlueGreenRedReserved8BitPerColor
: StrnCatGrow(&RetVal
, NULL
, L
"PixelBlueGreenRedReserved8BitPerColor", 0); break;
78 case PixelBitMask
: StrnCatGrow(&RetVal
, NULL
, L
"PixelBitMask", 0); break;
79 case PixelBltOnly
: StrnCatGrow(&RetVal
, NULL
, L
"PixelBltOnly", 0); break;
80 case PixelFormatMax
: StrnCatGrow(&RetVal
, NULL
, L
"PixelFormatMax", 0); break;
81 default: ASSERT(FALSE
);
87 Constructor for the library.
89 @param[in] ImageHandle Ignored.
90 @param[in] SystemTable Ignored.
92 @retval EFI_SUCCESS The operation was successful.
96 HandleParsingLibConstructor (
97 IN EFI_HANDLE ImageHandle
,
98 IN EFI_SYSTEM_TABLE
*SystemTable
105 // Do nothing with mHandleParsingHiiHandle. Initialize HII as needed.
107 return (EFI_SUCCESS
);
111 Initialization function for HII packages.
115 HandleParsingHiiInit (VOID
)
117 if (mHandleParsingHiiHandle
== NULL
) {
118 mHandleParsingHiiHandle
= HiiAddPackages (&gHandleParsingHiiGuid
, gImageHandle
, UefiHandleParsingLibStrings
, NULL
);
119 ASSERT (mHandleParsingHiiHandle
!= NULL
);
124 Destructor for the library. free any resources.
126 @param[in] ImageHandle Ignored.
127 @param[in] SystemTable Ignored.
129 @retval EFI_SUCCESS The operation was successful.
133 HandleParsingLibDestructor (
134 IN EFI_HANDLE ImageHandle
,
135 IN EFI_SYSTEM_TABLE
*SystemTable
140 for (LoopCount
= 0; mGuidList
!= NULL
&& LoopCount
< mGuidListCount
; LoopCount
++) {
141 SHELL_FREE_NON_NULL(mGuidList
[LoopCount
].GuidId
);
144 SHELL_FREE_NON_NULL(mGuidList
);
145 if (mHandleParsingHiiHandle
!= NULL
) {
146 HiiRemovePackages(mHandleParsingHiiHandle
);
148 return (EFI_SUCCESS
);
152 Function to dump information about LoadedImage.
154 This will allocate the return buffer from boot services pool.
156 @param[in] TheHandle The handle that has LoadedImage installed.
157 @param[in] Verbose TRUE for additional information, FALSE otherwise.
159 @retval A poitner to a string containing the information.
163 LoadedImageProtocolDumpInformation(
164 IN CONST EFI_HANDLE TheHandle
,
165 IN CONST BOOLEAN Verbose
168 EFI_LOADED_IMAGE_PROTOCOL
*LoadedImage
;
177 return (CatSPrint(NULL
, L
"LoadedImage"));
180 HandleParsingHiiInit();
182 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_LI_DUMP_MAIN
), NULL
);
187 Status
= gBS
->OpenProtocol (
189 &gEfiLoadedImageProtocolGuid
,
190 (VOID
**)&LoadedImage
,
193 EFI_OPEN_PROTOCOL_GET_PROTOCOL
196 if (EFI_ERROR (Status
)) {
197 SHELL_FREE_NON_NULL (Temp
);
201 FilePath
= ConvertDevicePathToText(LoadedImage
->FilePath
, TRUE
, TRUE
);
203 DataType
= ConvertMemoryType(LoadedImage
->ImageDataType
);
204 CodeType
= ConvertMemoryType(LoadedImage
->ImageCodeType
);
209 LoadedImage
->Revision
,
210 LoadedImage
->ParentHandle
,
211 LoadedImage
->SystemTable
,
212 LoadedImage
->DeviceHandle
,
214 LoadedImage
->LoadOptionsSize
,
215 LoadedImage
->LoadOptions
,
216 LoadedImage
->ImageBase
,
217 LoadedImage
->ImageSize
,
224 SHELL_FREE_NON_NULL(Temp
);
225 SHELL_FREE_NON_NULL(FilePath
);
226 SHELL_FREE_NON_NULL(CodeType
);
227 SHELL_FREE_NON_NULL(DataType
);
233 Function to dump information about GOP.
235 This will allocate the return buffer from boot services pool.
237 @param[in] TheHandle The handle that has LoadedImage installed.
238 @param[in] Verbose TRUE for additional information, FALSE otherwise.
240 @retval A poitner to a string containing the information.
244 GraphicsOutputProtocolDumpInformation(
245 IN CONST EFI_HANDLE TheHandle
,
246 IN CONST BOOLEAN Verbose
249 EFI_GRAPHICS_OUTPUT_PROTOCOL
*GraphicsOutput
;
257 EFI_GRAPHICS_OUTPUT_MODE_INFORMATION
*GopInfo
;
260 return (CatSPrint(NULL
, L
"GraphicsOutput"));
263 HandleParsingHiiInit();
265 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_GOP_DUMP_MAIN
), NULL
);
270 Status
= gBS
->OpenProtocol (
272 &gEfiGraphicsOutputProtocolGuid
,
273 (VOID
**)&GraphicsOutput
,
276 EFI_OPEN_PROTOCOL_GET_PROTOCOL
279 if (EFI_ERROR (Status
)) {
280 SHELL_FREE_NON_NULL (Temp
);
284 Fmt
= ConvertPixelFormat(GraphicsOutput
->Mode
->Info
->PixelFormat
);
289 GraphicsOutput
->Mode
->MaxMode
,
290 GraphicsOutput
->Mode
->Mode
,
291 GraphicsOutput
->Mode
->FrameBufferBase
,
292 (UINT64
)GraphicsOutput
->Mode
->FrameBufferSize
,
293 (UINT64
)GraphicsOutput
->Mode
->SizeOfInfo
,
294 GraphicsOutput
->Mode
->Info
->Version
,
295 GraphicsOutput
->Mode
->Info
->HorizontalResolution
,
296 GraphicsOutput
->Mode
->Info
->VerticalResolution
,
298 GraphicsOutput
->Mode
->Info
->PixelsPerScanLine
,
299 GraphicsOutput
->Mode
->Info
->PixelFormat
!=PixelBitMask
?0:GraphicsOutput
->Mode
->Info
->PixelInformation
.RedMask
,
300 GraphicsOutput
->Mode
->Info
->PixelFormat
!=PixelBitMask
?0:GraphicsOutput
->Mode
->Info
->PixelInformation
.GreenMask
,
301 GraphicsOutput
->Mode
->Info
->PixelFormat
!=PixelBitMask
?0:GraphicsOutput
->Mode
->Info
->PixelInformation
.BlueMask
304 SHELL_FREE_NON_NULL (Temp
);
306 Temp
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN (STR_GOP_RES_LIST_MAIN
), NULL
);
308 SHELL_FREE_NON_NULL (RetVal
);
312 TempRetVal
= CatSPrint (RetVal
, Temp
);
313 SHELL_FREE_NON_NULL (RetVal
);
314 if (TempRetVal
== NULL
) {
318 SHELL_FREE_NON_NULL (Temp
);
320 Temp
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN (STR_GOP_RES_LIST_ENTRY
), NULL
);
322 SHELL_FREE_NON_NULL (RetVal
);
327 for (Mode
= 0; Mode
< GraphicsOutput
->Mode
->MaxMode
; Mode
++) {
328 Status
= GraphicsOutput
->QueryMode (
334 if (EFI_ERROR (Status
)) {
338 TempRetVal
= CatSPrint (
342 GopInfo
->HorizontalResolution
,
343 GopInfo
->VerticalResolution
346 SHELL_FREE_NON_NULL (GopInfo
);
347 SHELL_FREE_NON_NULL (RetVal
);
353 SHELL_FREE_NON_NULL(Temp
);
354 SHELL_FREE_NON_NULL(Fmt
);
360 Function to dump information about EDID Discovered Protocol.
362 This will allocate the return buffer from boot services pool.
364 @param[in] TheHandle The handle that has LoadedImage installed.
365 @param[in] Verbose TRUE for additional information, FALSE otherwise.
367 @retval A pointer to a string containing the information.
371 EdidDiscoveredProtocolDumpInformation (
372 IN CONST EFI_HANDLE TheHandle
,
373 IN CONST BOOLEAN Verbose
376 EFI_EDID_DISCOVERED_PROTOCOL
*EdidDiscovered
;
383 return (CatSPrint (NULL
, L
"EDIDDiscovered"));
386 Status
= gBS
->OpenProtocol (
388 &gEfiEdidDiscoveredProtocolGuid
,
389 (VOID
**)&EdidDiscovered
,
392 EFI_OPEN_PROTOCOL_GET_PROTOCOL
395 if (EFI_ERROR (Status
)) {
399 Temp
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN (STR_EDID_DISCOVERED_MAIN
), NULL
);
404 RetVal
= CatSPrint (NULL
, Temp
, EdidDiscovered
->SizeOfEdid
);
405 SHELL_FREE_NON_NULL (Temp
);
407 if (EdidDiscovered
->SizeOfEdid
!= 0) {
408 Temp
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN (STR_EDID_DISCOVERED_DATA
), NULL
);
410 SHELL_FREE_NON_NULL (RetVal
);
413 TempRetVal
= CatSPrint (RetVal
, Temp
);
414 SHELL_FREE_NON_NULL (RetVal
);
417 TempRetVal
= CatSDumpHex (RetVal
, 7, 0, EdidDiscovered
->SizeOfEdid
, EdidDiscovered
->Edid
);
424 Function to dump information about EDID Active Protocol.
426 This will allocate the return buffer from boot services pool.
428 @param[in] TheHandle The handle that has LoadedImage installed.
429 @param[in] Verbose TRUE for additional information, FALSE otherwise.
431 @retval A pointer to a string containing the information.
435 EdidActiveProtocolDumpInformation (
436 IN CONST EFI_HANDLE TheHandle
,
437 IN CONST BOOLEAN Verbose
440 EFI_EDID_ACTIVE_PROTOCOL
*EdidActive
;
447 return (CatSPrint (NULL
, L
"EDIDActive"));
450 Status
= gBS
->OpenProtocol (
452 &gEfiEdidActiveProtocolGuid
,
456 EFI_OPEN_PROTOCOL_GET_PROTOCOL
459 if (EFI_ERROR (Status
)) {
463 Temp
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN (STR_EDID_ACTIVE_MAIN
), NULL
);
468 RetVal
= CatSPrint (NULL
, Temp
, EdidActive
->SizeOfEdid
);
469 SHELL_FREE_NON_NULL (Temp
);
471 if (EdidActive
->SizeOfEdid
!= 0) {
472 Temp
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN (STR_EDID_ACTIVE_DATA
), NULL
);
474 SHELL_FREE_NON_NULL (RetVal
);
477 TempRetVal
= CatSPrint (RetVal
, Temp
);
478 SHELL_FREE_NON_NULL (RetVal
);
481 TempRetVal
= CatSDumpHex (RetVal
, 7, 0, EdidActive
->SizeOfEdid
, EdidActive
->Edid
);
488 Function to dump information about PciRootBridgeIo.
490 This will allocate the return buffer from boot services pool.
492 @param[in] TheHandle The handle that has PciRootBridgeIo installed.
493 @param[in] Verbose TRUE for additional information, FALSE otherwise.
495 @retval A poitner to a string containing the information.
499 PciRootBridgeIoDumpInformation(
500 IN CONST EFI_HANDLE TheHandle
,
501 IN CONST BOOLEAN Verbose
504 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*PciRootBridgeIo
;
505 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*Configuration
;
516 return (CatSPrint(NULL
, L
"PciRootBridgeIo"));
519 HandleParsingHiiInit();
521 Status
= gBS
->HandleProtocol(
523 &gEfiPciRootBridgeIoProtocolGuid
,
524 (VOID
**)&PciRootBridgeIo
);
526 if (EFI_ERROR(Status
)) {
530 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_PH
), NULL
);
534 Temp2
= CatSPrint(L
"\r\n", Temp
, PciRootBridgeIo
->ParentHandle
);
539 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_SEG
), NULL
);
541 SHELL_FREE_NON_NULL(RetVal
);
544 Temp2
= CatSPrint(RetVal
, Temp
, PciRootBridgeIo
->SegmentNumber
);
552 Status
= PciRootBridgeIo
->GetAttributes (PciRootBridgeIo
, &Supports
, &Attributes
);
553 if (!EFI_ERROR(Status
)) {
554 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_ATT
), NULL
);
556 SHELL_FREE_NON_NULL(RetVal
);
559 Temp2
= CatSPrint(RetVal
, Temp
, Attributes
);
565 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_SUPPORTS
), NULL
);
567 SHELL_FREE_NON_NULL(RetVal
);
570 Temp2
= CatSPrint(RetVal
, Temp
, Supports
);
577 Configuration
= NULL
;
578 Status
= PciRootBridgeIo
->Configuration (PciRootBridgeIo
, (VOID
**) &Configuration
);
579 if (!EFI_ERROR(Status
) && Configuration
!= NULL
) {
580 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_TITLE
), NULL
);
582 SHELL_FREE_NON_NULL(RetVal
);
585 Temp2
= CatSPrint(RetVal
, Temp
, Supports
);
590 while (Configuration
->Desc
== ACPI_ADDRESS_SPACE_DESCRIPTOR
) {
592 switch (Configuration
->ResType
) {
593 case ACPI_ADDRESS_SPACE_TYPE_MEM
:
594 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_MEM
), NULL
);
596 case ACPI_ADDRESS_SPACE_TYPE_IO
:
597 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_IO
), NULL
);
599 case ACPI_ADDRESS_SPACE_TYPE_BUS
:
600 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_BUS
), NULL
);
604 Temp2
= CatSPrint(RetVal
, L
"%s", Temp
);
611 Temp2
= CatSPrint(RetVal
,
612 L
"%H%02x %016lx %016lx %02x%N\r\n",
613 Configuration
->SpecificFlag
,
614 Configuration
->AddrRangeMin
,
615 Configuration
->AddrRangeMax
,
616 Configuration
->AddrSpaceGranularity
628 Function to dump information about SimpleTextOut.
630 This will allocate the return buffer from boot services pool.
632 @param[in] TheHandle The handle that has SimpleTextOut installed.
633 @param[in] Verbose TRUE for additional information, FALSE otherwise.
635 @retval A poitner to a string containing the information.
639 TxtOutProtocolDumpInformation(
640 IN CONST EFI_HANDLE TheHandle
,
641 IN CONST BOOLEAN Verbose
644 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*Dev
;
658 HandleParsingHiiInit();
663 Status
= gBS
->HandleProtocol(
665 &gEfiSimpleTextOutProtocolGuid
,
668 ASSERT_EFI_ERROR(Status
);
669 ASSERT (Dev
!= NULL
&& Dev
->Mode
!= NULL
);
671 Size
= (Dev
->Mode
->MaxMode
+ 1) * 80;
672 RetVal
= AllocateZeroPool(Size
);
674 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_TXT_OUT_DUMP_HEADER
), NULL
);
676 UnicodeSPrint(RetVal
, Size
, Temp
, Dev
, Dev
->Mode
->Attribute
);
683 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_TXT_OUT_DUMP_LINE
), NULL
);
684 for (Index
= 0; Index
< Dev
->Mode
->MaxMode
; Index
++) {
685 Status
= Dev
->QueryMode (Dev
, Index
, &Col
, &Row
);
686 NewSize
= Size
- StrSize(RetVal
);
688 RetVal
+ StrLen(RetVal
),
690 Temp
== NULL
?L
"":Temp
,
691 Index
== Dev
->Mode
->Mode
? L
'*' : L
' ',
693 !EFI_ERROR(Status
)?(INTN
)Col
:-1,
694 !EFI_ERROR(Status
)?(INTN
)Row
:-1
701 STATIC CONST UINTN VersionStringSize
= 60;
704 Function to dump information about EfiDriverSupportedEfiVersion protocol.
706 This will allocate the return buffer from boot services pool.
708 @param[in] TheHandle The handle that has the protocol installed.
709 @param[in] Verbose TRUE for additional information, FALSE otherwise.
711 @retval A poitner to a string containing the information.
715 DriverEfiVersionProtocolDumpInformation(
716 IN CONST EFI_HANDLE TheHandle
,
717 IN CONST BOOLEAN Verbose
720 EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL
*DriverEfiVersion
;
724 Status
= gBS
->HandleProtocol(
726 &gEfiDriverSupportedEfiVersionProtocolGuid
,
727 (VOID
**)&DriverEfiVersion
);
729 ASSERT_EFI_ERROR(Status
);
731 RetVal
= AllocateZeroPool(VersionStringSize
);
732 if (RetVal
!= NULL
) {
733 UnicodeSPrint (RetVal
, VersionStringSize
, L
"0x%08x", DriverEfiVersion
->FirmwareVersion
);
738 Function to convert device path to string.
740 This will allocate the return buffer from boot services pool.
742 @param[in] DevPath Pointer to device path instance.
743 @param[in] Verbose TRUE for additional information, FALSE otherwise.
744 @param[in] Length Maximum allowed text length of the device path.
746 @retval A pointer to a string containing the information.
749 ConvertDevicePathToShortText(
750 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevPath
,
751 IN CONST BOOLEAN Verbose
,
752 IN CONST UINTN Length
760 // I cannot decide whether to allow shortcuts here (the second BOOLEAN on the next line)
762 Temp
= ConvertDevicePathToText(DevPath
, TRUE
, TRUE
);
763 if (!Verbose
&& Temp
!= NULL
&& StrLen(Temp
) > Length
) {
766 Temp2
= StrnCatGrow(&Temp2
, &Size
, L
"..", 0);
767 Temp2
= StrnCatGrow(&Temp2
, &Size
, Temp
+(StrLen(Temp
) - (Length
- 2)), 0);
775 Function to dump information about DevicePath protocol.
777 This will allocate the return buffer from boot services pool.
779 @param[in] TheHandle The handle that has the protocol installed.
780 @param[in] Verbose TRUE for additional information, FALSE otherwise.
782 @retval A pointer to a string containing the information.
786 DevicePathProtocolDumpInformation(
787 IN CONST EFI_HANDLE TheHandle
,
788 IN CONST BOOLEAN Verbose
791 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
796 Status
= gBS
->OpenProtocol(TheHandle
, &gEfiDevicePathProtocolGuid
, (VOID
**)&DevPath
, gImageHandle
, NULL
, EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
797 if (!EFI_ERROR(Status
)) {
798 Temp
= ConvertDevicePathToShortText (DevPath
, Verbose
, 30);
799 gBS
->CloseProtocol(TheHandle
, &gEfiDevicePathProtocolGuid
, gImageHandle
, NULL
);
805 Function to dump information about LoadedImageDevicePath protocol.
807 This will allocate the return buffer from boot services pool.
809 @param[in] TheHandle The handle that has the protocol installed.
810 @param[in] Verbose TRUE for additional information, FALSE otherwise.
812 @retval A pointer to a string containing the information.
816 LoadedImageDevicePathProtocolDumpInformation(
817 IN CONST EFI_HANDLE TheHandle
,
818 IN CONST BOOLEAN Verbose
821 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
826 Status
= gBS
->OpenProtocol(TheHandle
, &gEfiLoadedImageDevicePathProtocolGuid
, (VOID
**)&DevPath
, gImageHandle
, NULL
, EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
827 if (!EFI_ERROR(Status
)) {
828 Temp
= ConvertDevicePathToShortText (DevPath
, Verbose
, 30);
829 gBS
->CloseProtocol(TheHandle
, &gEfiDevicePathProtocolGuid
, gImageHandle
, NULL
);
835 Function to dump information about EfiAdapterInformation Protocol.
837 @param[in] TheHandle The handle that has the protocol installed.
838 @param[in] Verbose TRUE for additional information, FALSE otherwise.
840 @retval A pointer to a string containing the information.
844 AdapterInformationDumpInformation (
845 IN CONST EFI_HANDLE TheHandle
,
846 IN CONST BOOLEAN Verbose
850 EFI_ADAPTER_INFORMATION_PROTOCOL
*EfiAdptrInfoProtocol
;
851 UINTN InfoTypesBufferCount
;
853 EFI_GUID
*InfoTypesBuffer
;
858 VOID
*InformationBlock
;
859 UINTN InformationBlockSize
;
862 return (CatSPrint(NULL
, L
"AdapterInfo"));
865 InfoTypesBuffer
= NULL
;
866 InformationBlock
= NULL
;
869 Status
= gBS
->OpenProtocol (
870 (EFI_HANDLE
) (TheHandle
),
871 &gEfiAdapterInformationProtocolGuid
,
872 (VOID
**) &EfiAdptrInfoProtocol
,
875 EFI_OPEN_PROTOCOL_GET_PROTOCOL
878 if (EFI_ERROR (Status
)) {
883 // Get a list of supported information types for this instance of the protocol.
885 Status
= EfiAdptrInfoProtocol
->GetSupportedTypes (
886 EfiAdptrInfoProtocol
,
888 &InfoTypesBufferCount
891 if (EFI_ERROR (Status
)) {
892 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_GET_SUPP_TYPES_FAILED
), NULL
);
893 if (TempStr
!= NULL
) {
894 RetVal
= CatSPrint (NULL
, TempStr
, Status
);
899 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_SUPP_TYPE_HEADER
), NULL
);
900 if (TempStr
== NULL
) {
903 RetVal
= CatSPrint (NULL
, TempStr
);
904 SHELL_FREE_NON_NULL (TempStr
);
906 for (GuidIndex
= 0; GuidIndex
< InfoTypesBufferCount
; GuidIndex
++) {
907 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_GUID_NUMBER
), NULL
);
908 if (TempStr
== NULL
) {
911 TempRetVal
= CatSPrint (RetVal
, TempStr
, (GuidIndex
+ 1), &InfoTypesBuffer
[GuidIndex
]);
912 SHELL_FREE_NON_NULL (RetVal
);
914 SHELL_FREE_NON_NULL (TempStr
);
916 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_GUID_STRING
), NULL
);
917 if (TempStr
== NULL
) {
921 if (CompareGuid (&InfoTypesBuffer
[GuidIndex
], &gEfiAdapterInfoMediaStateGuid
)) {
922 TempRetVal
= CatSPrint (RetVal
, TempStr
, L
"gEfiAdapterInfoMediaStateGuid");
923 SHELL_FREE_NON_NULL (RetVal
);
925 } else if (CompareGuid (&InfoTypesBuffer
[GuidIndex
], &gEfiAdapterInfoNetworkBootGuid
)) {
926 TempRetVal
= CatSPrint (RetVal
, TempStr
, L
"gEfiAdapterInfoNetworkBootGuid");
927 SHELL_FREE_NON_NULL (RetVal
);
929 } else if (CompareGuid (&InfoTypesBuffer
[GuidIndex
], &gEfiAdapterInfoSanMacAddressGuid
)) {
930 TempRetVal
= CatSPrint (RetVal
, TempStr
, L
"gEfiAdapterInfoSanMacAddressGuid");
931 SHELL_FREE_NON_NULL (RetVal
);
933 } else if (CompareGuid (&InfoTypesBuffer
[GuidIndex
], &gEfiAdapterInfoUndiIpv6SupportGuid
)) {
934 TempRetVal
= CatSPrint (RetVal
, TempStr
, L
"gEfiAdapterInfoUndiIpv6SupportGuid");
935 SHELL_FREE_NON_NULL (RetVal
);
939 GuidStr
= GetStringNameFromGuid (&InfoTypesBuffer
[GuidIndex
], NULL
);
940 if (GuidStr
== NULL
) {
941 TempRetVal
= CatSPrint (RetVal
, TempStr
, L
"UnknownInfoType");
942 SHELL_FREE_NON_NULL (RetVal
);
945 SHELL_FREE_NON_NULL (TempStr
);
946 SHELL_FREE_NON_NULL(GuidStr
);
948 // So that we never have to pass this UnknownInfoType to the parsing function "GetInformation" service of AIP
952 TempRetVal
= CatSPrint (RetVal
, TempStr
, GuidStr
);
953 SHELL_FREE_NON_NULL (RetVal
);
955 SHELL_FREE_NON_NULL(GuidStr
);
959 SHELL_FREE_NON_NULL (TempStr
);
961 Status
= EfiAdptrInfoProtocol
->GetInformation (
962 EfiAdptrInfoProtocol
,
963 &InfoTypesBuffer
[GuidIndex
],
965 &InformationBlockSize
968 if (EFI_ERROR (Status
)) {
969 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_GETINFO_FAILED
), NULL
);
970 if (TempStr
== NULL
) {
973 TempRetVal
= CatSPrint (RetVal
, TempStr
, Status
);
974 SHELL_FREE_NON_NULL (RetVal
);
977 if (CompareGuid (&InfoTypesBuffer
[GuidIndex
], &gEfiAdapterInfoMediaStateGuid
)) {
978 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_MEDIA_STATE
), NULL
);
979 if (TempStr
== NULL
) {
982 TempRetVal
= CatSPrint (
985 ((EFI_ADAPTER_INFO_MEDIA_STATE
*)InformationBlock
)->MediaState
,
986 ((EFI_ADAPTER_INFO_MEDIA_STATE
*)InformationBlock
)->MediaState
988 SHELL_FREE_NON_NULL (RetVal
);
990 } else if (CompareGuid (&InfoTypesBuffer
[GuidIndex
], &gEfiAdapterInfoNetworkBootGuid
)) {
991 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_NETWORK_BOOT_INFO
), NULL
);
992 if (TempStr
== NULL
) {
995 TempRetVal
= CatSPrint (
998 ((EFI_ADAPTER_INFO_NETWORK_BOOT
*)InformationBlock
)->iScsiIpv4BootCapablity
,
999 ((EFI_ADAPTER_INFO_NETWORK_BOOT
*)InformationBlock
)->iScsiIpv6BootCapablity
,
1000 ((EFI_ADAPTER_INFO_NETWORK_BOOT
*)InformationBlock
)->FCoeBootCapablity
,
1001 ((EFI_ADAPTER_INFO_NETWORK_BOOT
*)InformationBlock
)->OffloadCapability
,
1002 ((EFI_ADAPTER_INFO_NETWORK_BOOT
*)InformationBlock
)->iScsiMpioCapability
,
1003 ((EFI_ADAPTER_INFO_NETWORK_BOOT
*)InformationBlock
)->iScsiIpv4Boot
,
1004 ((EFI_ADAPTER_INFO_NETWORK_BOOT
*)InformationBlock
)->iScsiIpv6Boot
,
1005 ((EFI_ADAPTER_INFO_NETWORK_BOOT
*)InformationBlock
)->FCoeBoot
1007 SHELL_FREE_NON_NULL (RetVal
);
1008 RetVal
= TempRetVal
;
1009 } else if (CompareGuid (&InfoTypesBuffer
[GuidIndex
], &gEfiAdapterInfoSanMacAddressGuid
) == TRUE
) {
1010 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_SAN_MAC_ADDRESS_INFO
), NULL
);
1011 if (TempStr
== NULL
) {
1014 TempRetVal
= CatSPrint (
1017 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS
*)InformationBlock
)->SanMacAddress
.Addr
[0],
1018 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS
*)InformationBlock
)->SanMacAddress
.Addr
[1],
1019 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS
*)InformationBlock
)->SanMacAddress
.Addr
[2],
1020 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS
*)InformationBlock
)->SanMacAddress
.Addr
[3],
1021 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS
*)InformationBlock
)->SanMacAddress
.Addr
[4],
1022 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS
*)InformationBlock
)->SanMacAddress
.Addr
[5]
1024 SHELL_FREE_NON_NULL (RetVal
);
1025 RetVal
= TempRetVal
;
1026 } else if (CompareGuid (&InfoTypesBuffer
[GuidIndex
], &gEfiAdapterInfoUndiIpv6SupportGuid
) == TRUE
) {
1027 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_UNDI_IPV6_INFO
), NULL
);
1028 if (TempStr
== NULL
) {
1032 TempRetVal
= CatSPrint (
1035 ((EFI_ADAPTER_INFO_UNDI_IPV6_SUPPORT
*)InformationBlock
)->Ipv6Support
1037 SHELL_FREE_NON_NULL (RetVal
);
1038 RetVal
= TempRetVal
;
1040 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_UNKNOWN_INFO_TYPE
), NULL
);
1041 if (TempStr
== NULL
) {
1044 TempRetVal
= CatSPrint (RetVal
, TempStr
, &InfoTypesBuffer
[GuidIndex
]);
1045 SHELL_FREE_NON_NULL (RetVal
);
1046 RetVal
= TempRetVal
;
1049 SHELL_FREE_NON_NULL (TempStr
);
1050 SHELL_FREE_NON_NULL (InformationBlock
);
1054 SHELL_FREE_NON_NULL (InfoTypesBuffer
);
1058 SHELL_FREE_NON_NULL (RetVal
);
1059 SHELL_FREE_NON_NULL (InfoTypesBuffer
);
1060 SHELL_FREE_NON_NULL (InformationBlock
);
1065 Function to dump information about EFI_FIRMWARE_MANAGEMENT_PROTOCOL Protocol.
1067 @param[in] TheHandle The handle that has the protocol installed.
1068 @param[in] Verbose TRUE for additional information, FALSE otherwise.
1070 @retval A pointer to a string containing the information.
1074 FirmwareManagementDumpInformation (
1075 IN CONST EFI_HANDLE TheHandle
,
1076 IN CONST BOOLEAN Verbose
1080 EFI_FIRMWARE_MANAGEMENT_PROTOCOL
*EfiFwMgmtProtocol
;
1081 EFI_FIRMWARE_IMAGE_DESCRIPTOR
*ImageInfo
;
1082 EFI_FIRMWARE_IMAGE_DESCRIPTOR_V1
*ImageInfoV1
;
1083 EFI_FIRMWARE_IMAGE_DESCRIPTOR_V2
*ImageInfoV2
;
1084 UINT64 AttributeSetting
;
1085 UINTN ImageInfoSize
;
1086 UINTN DescriptorSize
;
1087 UINT32 DescriptorVersion
;
1088 UINT32 PackageVersion
;
1089 UINT8 DescriptorCount
;
1093 CHAR16
*PackageVersionName
;
1097 CHAR16
*AttributeSettingStr
;
1099 BOOLEAN AttributeSupported
;
1102 // Initialize local variables
1106 AttributeSetting
= 0;
1108 AttributeSupported
= FALSE
;
1112 PackageVersionName
= NULL
;
1116 AttributeSettingStr
= NULL
;
1119 return (CatSPrint(NULL
, L
"FirmwareManagement"));
1122 Status
= gBS
->OpenProtocol (
1123 (EFI_HANDLE
) (TheHandle
),
1124 &gEfiFirmwareManagementProtocolGuid
,
1125 (VOID
**) &EfiFwMgmtProtocol
,
1128 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1131 if (EFI_ERROR (Status
)) {
1135 Status
= EfiFwMgmtProtocol
->GetImageInfo (
1146 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1147 ImageInfo
= AllocateZeroPool (ImageInfoSize
);
1149 if (ImageInfo
== NULL
) {
1150 Status
= EFI_OUT_OF_RESOURCES
;
1152 Status
= EfiFwMgmtProtocol
->GetImageInfo (
1165 if (EFI_ERROR (Status
)) {
1170 // Decode Image Descriptor data only if its version is supported
1172 if (DescriptorVersion
<= EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION
) {
1174 if (ImageInfo
== NULL
) {
1178 ImageInfoV1
= (EFI_FIRMWARE_IMAGE_DESCRIPTOR_V1
*)ImageInfo
;
1179 ImageInfoV2
= (EFI_FIRMWARE_IMAGE_DESCRIPTOR_V2
*)ImageInfo
;
1182 // Set ImageInfoSize in return buffer
1184 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_FMP_IMAGE_INFO_SIZE
), NULL
);
1185 if (TempStr
== NULL
) {
1188 RetVal
= CatSPrint (NULL
, TempStr
, ImageInfoSize
);
1189 SHELL_FREE_NON_NULL (TempStr
);
1192 // Set DescriptorVersion in return buffer
1194 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_FMP_DESCRIPTOR_VERSION
), NULL
);
1195 if (TempStr
== NULL
) {
1198 TempRetVal
= CatSPrint (RetVal
, TempStr
, DescriptorVersion
);
1199 SHELL_FREE_NON_NULL (RetVal
);
1200 RetVal
= TempRetVal
;
1201 SHELL_FREE_NON_NULL (TempStr
);
1204 // Set DescriptorCount in return buffer
1206 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_FMP_DESCRIPTOR_COUNT
), NULL
);
1207 if (TempStr
== NULL
) {
1210 TempRetVal
= CatSPrint (RetVal
, TempStr
, DescriptorCount
);
1211 SHELL_FREE_NON_NULL (RetVal
);
1212 RetVal
= TempRetVal
;
1213 SHELL_FREE_NON_NULL (TempStr
);
1217 // Set DescriptorSize in return buffer
1219 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_FMP_DESCRIPTOR_SIZE
), NULL
);
1220 if (TempStr
== NULL
) {
1223 TempRetVal
= CatSPrint (RetVal
, TempStr
, DescriptorSize
);
1224 SHELL_FREE_NON_NULL (RetVal
);
1225 RetVal
= TempRetVal
;
1226 SHELL_FREE_NON_NULL (TempStr
);
1229 // Set PackageVersion in return buffer
1231 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_FMP_PACKAGE_VERSION
), NULL
);
1232 if (TempStr
== NULL
) {
1235 TempRetVal
= CatSPrint (RetVal
, TempStr
, PackageVersion
);
1236 SHELL_FREE_NON_NULL (RetVal
);
1237 RetVal
= TempRetVal
;
1238 SHELL_FREE_NON_NULL (TempStr
);
1241 // Set PackageVersionName in return buffer
1243 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_FMP_PACKAGE_VERSION_NAME
), NULL
);
1244 if (TempStr
== NULL
) {
1247 TempRetVal
= CatSPrint (RetVal
, TempStr
, PackageVersionName
);
1248 SHELL_FREE_NON_NULL (RetVal
);
1249 RetVal
= TempRetVal
;
1250 SHELL_FREE_NON_NULL (TempStr
);
1252 for (Index
= 0; Index
< DescriptorCount
; Index
++) {
1254 // First check if Attribute is supported
1255 // and generate a string for AttributeSetting field
1257 SHELL_FREE_NON_NULL (AttributeSettingStr
);
1258 AttributeSupported
= FALSE
;
1259 AttributeSetting
= 0;
1260 if (DescriptorVersion
== EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION_V1
) {
1261 if (ImageInfoV1
[Index
].AttributesSupported
!= 0x0) {
1262 AttributeSupported
= TRUE
;
1263 AttributeSetting
= ImageInfoV1
[Index
].AttributesSetting
;
1265 } else if (DescriptorVersion
== EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION_V2
) {
1266 if (ImageInfoV2
[Index
].AttributesSupported
!= 0x0) {
1267 AttributeSupported
= TRUE
;
1268 AttributeSetting
= ImageInfoV2
[Index
].AttributesSetting
;
1271 if (ImageInfo
[Index
].AttributesSupported
!= 0x0) {
1272 AttributeSupported
= TRUE
;
1273 AttributeSetting
= ImageInfo
[Index
].AttributesSetting
;
1277 if (!AttributeSupported
) {
1278 AttributeSettingStr
= CatSPrint (NULL
, L
"None");
1280 AttributeSettingStr
= CatSPrint (NULL
, L
"(");
1282 if ((AttributeSetting
& IMAGE_ATTRIBUTE_IMAGE_UPDATABLE
) != 0x0) {
1283 TempRetVal
= CatSPrint (AttributeSettingStr
, L
" IMAGE_ATTRIBUTE_IMAGE_UPDATABLE");
1284 SHELL_FREE_NON_NULL (AttributeSettingStr
);
1285 AttributeSettingStr
= TempRetVal
;
1287 if ((AttributeSetting
& IMAGE_ATTRIBUTE_RESET_REQUIRED
) != 0x0) {
1288 TempRetVal
= CatSPrint (AttributeSettingStr
, L
" IMAGE_ATTRIBUTE_RESET_REQUIRED");
1289 SHELL_FREE_NON_NULL (AttributeSettingStr
);
1290 AttributeSettingStr
= TempRetVal
;
1292 if ((AttributeSetting
& IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED
) != 0x0) {
1293 TempRetVal
= CatSPrint (AttributeSettingStr
, L
" IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED");
1294 SHELL_FREE_NON_NULL (AttributeSettingStr
);
1295 AttributeSettingStr
= TempRetVal
;
1297 if ((AttributeSetting
& IMAGE_ATTRIBUTE_IN_USE
) != 0x0) {
1298 TempRetVal
= CatSPrint (AttributeSettingStr
, L
" IMAGE_ATTRIBUTE_IN_USE");
1299 SHELL_FREE_NON_NULL (AttributeSettingStr
);
1300 AttributeSettingStr
= TempRetVal
;
1302 if ((AttributeSetting
& IMAGE_ATTRIBUTE_UEFI_IMAGE
) != 0x0) {
1303 TempRetVal
= CatSPrint (AttributeSettingStr
, L
" IMAGE_ATTRIBUTE_UEFI_IMAGE");
1304 SHELL_FREE_NON_NULL (AttributeSettingStr
);
1305 AttributeSettingStr
= TempRetVal
;
1307 TempRetVal
= CatSPrint (AttributeSettingStr
, L
" )");
1308 SHELL_FREE_NON_NULL (AttributeSettingStr
);
1309 AttributeSettingStr
= TempRetVal
;
1312 if (DescriptorVersion
== EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION_V1
) {
1313 if (ImageInfoV1
[Index
].ImageIndex
!= 0x0) {
1317 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_FMP_IMAGE_DESCRIPTOR_INFO_V1
), NULL
);
1318 if (TempStr
== NULL
) {
1321 TempRetVal
= CatSPrint (
1325 ImageInfoV1
[Index
].ImageIndex
,
1326 &ImageInfoV1
[Index
].ImageTypeId
,
1327 ImageInfoV1
[Index
].ImageId
,
1328 ImageInfoV1
[Index
].ImageIdName
,
1329 ImageInfoV1
[Index
].Version
,
1330 ImageInfoV1
[Index
].VersionName
,
1331 ImageInfoV1
[Index
].Size
,
1332 ImageInfoV1
[Index
].AttributesSupported
,
1333 AttributeSettingStr
,
1334 ImageInfoV1
[Index
].Compatibilities
1336 SHELL_FREE_NON_NULL (RetVal
);
1337 RetVal
= TempRetVal
;
1338 SHELL_FREE_NON_NULL (TempStr
);
1339 } else if (DescriptorVersion
== EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION_V2
) {
1340 if (ImageInfoV2
[Index
].ImageIndex
!= 0x0) {
1344 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_FMP_IMAGE_DESCRIPTOR_INFO_V2
), NULL
);
1345 if (TempStr
== NULL
) {
1348 TempRetVal
= CatSPrint (
1352 ImageInfoV2
[Index
].ImageIndex
,
1353 &ImageInfoV2
[Index
].ImageTypeId
,
1354 ImageInfoV2
[Index
].ImageId
,
1355 ImageInfoV2
[Index
].ImageIdName
,
1356 ImageInfoV2
[Index
].Version
,
1357 ImageInfoV2
[Index
].VersionName
,
1358 ImageInfoV2
[Index
].Size
,
1359 ImageInfoV2
[Index
].AttributesSupported
,
1360 AttributeSettingStr
,
1361 ImageInfoV2
[Index
].Compatibilities
,
1362 ImageInfoV2
[Index
].LowestSupportedImageVersion
1364 SHELL_FREE_NON_NULL (RetVal
);
1365 RetVal
= TempRetVal
;
1366 SHELL_FREE_NON_NULL (TempStr
);
1368 if (ImageInfo
[Index
].ImageIndex
!= 0x0) {
1372 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_FMP_IMAGE_DESCRIPTOR_INFO
), NULL
);
1373 if (TempStr
== NULL
) {
1376 TempRetVal
= CatSPrint (
1380 ImageInfo
[Index
].ImageIndex
,
1381 &ImageInfo
[Index
].ImageTypeId
,
1382 ImageInfo
[Index
].ImageId
,
1383 ImageInfo
[Index
].ImageIdName
,
1384 ImageInfo
[Index
].Version
,
1385 ImageInfo
[Index
].VersionName
,
1386 ImageInfo
[Index
].Size
,
1387 ImageInfo
[Index
].AttributesSupported
,
1388 AttributeSettingStr
,
1389 ImageInfo
[Index
].Compatibilities
,
1390 ImageInfo
[Index
].LowestSupportedImageVersion
,
1391 ImageInfo
[Index
].LastAttemptVersion
,
1392 ImageInfo
[Index
].LastAttemptStatus
,
1393 ImageInfo
[Index
].HardwareInstance
1395 SHELL_FREE_NON_NULL (RetVal
);
1396 RetVal
= TempRetVal
;
1397 SHELL_FREE_NON_NULL (TempStr
);
1402 if (ImageCount
> 0) {
1403 for (Index
=0; Index
<DescriptorCount
; Index
++) {
1404 for (Index1
=Index
+1; Index1
<DescriptorCount
; Index1
++) {
1405 if (DescriptorVersion
== EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION_V1
) {
1406 if (ImageInfoV1
[Index
].ImageId
== ImageInfoV1
[Index1
].ImageId
) {
1409 // At least one match found indicating presense of non unique ImageId values so no more comparisons needed
1413 } else if (DescriptorVersion
== EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION_V2
) {
1414 if (ImageInfoV2
[Index
].ImageId
== ImageInfoV2
[Index1
].ImageId
) {
1417 // At least one match found indicating presense of non unique ImageId values so no more comparisons needed
1422 if (ImageInfo
[Index
].ImageId
== ImageInfo
[Index1
].ImageId
) {
1425 // At least one match found indicating presense of non unique ImageId values so no more comparisons needed
1436 // Check if ImageId with duplicate value was found
1439 TempStr
= HiiGetString (mHandleParsingHiiHandle
, STRING_TOKEN(STR_FMP_IMAGEID_NON_UNIQUE
), NULL
);
1440 if (TempStr
== NULL
) {
1443 TempRetVal
= CatSPrint (RetVal
, TempStr
);
1444 SHELL_FREE_NON_NULL (RetVal
);
1445 RetVal
= TempRetVal
;
1446 SHELL_FREE_NON_NULL (TempStr
);
1449 SHELL_FREE_NON_NULL (ImageInfo
);
1450 SHELL_FREE_NON_NULL (PackageVersionName
);
1451 SHELL_FREE_NON_NULL (AttributeSettingStr
);
1456 SHELL_FREE_NON_NULL (RetVal
);
1457 SHELL_FREE_NON_NULL (ImageInfo
);
1458 SHELL_FREE_NON_NULL (PackageVersionName
);
1459 SHELL_FREE_NON_NULL (AttributeSettingStr
);
1465 // Put the information on the NT32 protocol GUIDs here so we are not dependant on the Nt32Pkg
1467 #define LOCAL_EFI_WIN_NT_THUNK_PROTOCOL_GUID \
1469 0x58c518b1, 0x76f3, 0x11d4, { 0xbc, 0xea, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
1472 #define LOCAL_EFI_WIN_NT_BUS_DRIVER_IO_PROTOCOL_GUID \
1474 0x96eb4ad6, 0xa32a, 0x11d4, { 0xbc, 0xfd, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
1477 #define LOCAL_EFI_WIN_NT_SERIAL_PORT_GUID \
1479 0xc95a93d, 0xa006, 0x11d4, { 0xbc, 0xfa, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
1481 STATIC CONST EFI_GUID WinNtThunkProtocolGuid
= LOCAL_EFI_WIN_NT_THUNK_PROTOCOL_GUID
;
1482 STATIC CONST EFI_GUID WinNtIoProtocolGuid
= LOCAL_EFI_WIN_NT_BUS_DRIVER_IO_PROTOCOL_GUID
;
1483 STATIC CONST EFI_GUID WinNtSerialPortGuid
= LOCAL_EFI_WIN_NT_SERIAL_PORT_GUID
;
1486 // Deprecated protocols we dont want to link from IntelFrameworkModulePkg
1488 #define LOCAL_EFI_ISA_IO_PROTOCOL_GUID \
1490 0x7ee2bd44, 0x3da0, 0x11d4, { 0x9a, 0x38, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
1492 #define LOCAL_EFI_ISA_ACPI_PROTOCOL_GUID \
1494 0x64a892dc, 0x5561, 0x4536, { 0x92, 0xc7, 0x79, 0x9b, 0xfc, 0x18, 0x33, 0x55 } \
1496 STATIC CONST EFI_GUID EfiIsaIoProtocolGuid
= LOCAL_EFI_ISA_IO_PROTOCOL_GUID
;
1497 STATIC CONST EFI_GUID EfiIsaAcpiProtocolGuid
= LOCAL_EFI_ISA_ACPI_PROTOCOL_GUID
;
1500 STATIC CONST GUID_INFO_BLOCK mGuidStringListNT
[] = {
1501 {STRING_TOKEN(STR_WINNT_THUNK
), (EFI_GUID
*)&WinNtThunkProtocolGuid
, NULL
},
1502 {STRING_TOKEN(STR_WINNT_DRIVER_IO
), (EFI_GUID
*)&WinNtIoProtocolGuid
, NULL
},
1503 {STRING_TOKEN(STR_WINNT_SERIAL_PORT
), (EFI_GUID
*)&WinNtSerialPortGuid
, NULL
},
1507 STATIC CONST GUID_INFO_BLOCK mGuidStringList
[] = {
1508 {STRING_TOKEN(STR_LOADED_IMAGE
), &gEfiLoadedImageProtocolGuid
, LoadedImageProtocolDumpInformation
},
1509 {STRING_TOKEN(STR_DEVICE_PATH
), &gEfiDevicePathProtocolGuid
, DevicePathProtocolDumpInformation
},
1510 {STRING_TOKEN(STR_IMAGE_PATH
), &gEfiLoadedImageDevicePathProtocolGuid
, LoadedImageDevicePathProtocolDumpInformation
},
1511 {STRING_TOKEN(STR_DEVICE_PATH_UTIL
), &gEfiDevicePathUtilitiesProtocolGuid
, NULL
},
1512 {STRING_TOKEN(STR_DEVICE_PATH_TXT
), &gEfiDevicePathToTextProtocolGuid
, NULL
},
1513 {STRING_TOKEN(STR_DEVICE_PATH_FTXT
), &gEfiDevicePathFromTextProtocolGuid
, NULL
},
1514 {STRING_TOKEN(STR_DEVICE_PATH_PC
), &gEfiPcAnsiGuid
, NULL
},
1515 {STRING_TOKEN(STR_DEVICE_PATH_VT100
), &gEfiVT100Guid
, NULL
},
1516 {STRING_TOKEN(STR_DEVICE_PATH_VT100P
), &gEfiVT100PlusGuid
, NULL
},
1517 {STRING_TOKEN(STR_DEVICE_PATH_VTUTF8
), &gEfiVTUTF8Guid
, NULL
},
1518 {STRING_TOKEN(STR_DRIVER_BINDING
), &gEfiDriverBindingProtocolGuid
, NULL
},
1519 {STRING_TOKEN(STR_PLATFORM_OVERRIDE
), &gEfiPlatformDriverOverrideProtocolGuid
, NULL
},
1520 {STRING_TOKEN(STR_BUS_OVERRIDE
), &gEfiBusSpecificDriverOverrideProtocolGuid
, NULL
},
1521 {STRING_TOKEN(STR_DRIVER_DIAG
), &gEfiDriverDiagnosticsProtocolGuid
, NULL
},
1522 {STRING_TOKEN(STR_DRIVER_DIAG2
), &gEfiDriverDiagnostics2ProtocolGuid
, NULL
},
1523 {STRING_TOKEN(STR_DRIVER_CN
), &gEfiComponentNameProtocolGuid
, NULL
},
1524 {STRING_TOKEN(STR_DRIVER_CN2
), &gEfiComponentName2ProtocolGuid
, NULL
},
1525 {STRING_TOKEN(STR_PLAT_DRV_CFG
), &gEfiPlatformToDriverConfigurationProtocolGuid
, NULL
},
1526 {STRING_TOKEN(STR_DRIVER_VERSION
), &gEfiDriverSupportedEfiVersionProtocolGuid
, DriverEfiVersionProtocolDumpInformation
},
1527 {STRING_TOKEN(STR_TXT_IN
), &gEfiSimpleTextInProtocolGuid
, NULL
},
1528 {STRING_TOKEN(STR_TXT_IN_EX
), &gEfiSimpleTextInputExProtocolGuid
, NULL
},
1529 {STRING_TOKEN(STR_TXT_OUT
), &gEfiSimpleTextOutProtocolGuid
, TxtOutProtocolDumpInformation
},
1530 {STRING_TOKEN(STR_SIM_POINTER
), &gEfiSimplePointerProtocolGuid
, NULL
},
1531 {STRING_TOKEN(STR_ABS_POINTER
), &gEfiAbsolutePointerProtocolGuid
, NULL
},
1532 {STRING_TOKEN(STR_SERIAL_IO
), &gEfiSerialIoProtocolGuid
, NULL
},
1533 {STRING_TOKEN(STR_GRAPHICS_OUTPUT
), &gEfiGraphicsOutputProtocolGuid
, GraphicsOutputProtocolDumpInformation
},
1534 {STRING_TOKEN(STR_EDID_DISCOVERED
), &gEfiEdidDiscoveredProtocolGuid
, EdidDiscoveredProtocolDumpInformation
},
1535 {STRING_TOKEN(STR_EDID_ACTIVE
), &gEfiEdidActiveProtocolGuid
, EdidActiveProtocolDumpInformation
},
1536 {STRING_TOKEN(STR_EDID_OVERRIDE
), &gEfiEdidOverrideProtocolGuid
, NULL
},
1537 {STRING_TOKEN(STR_CON_IN
), &gEfiConsoleInDeviceGuid
, NULL
},
1538 {STRING_TOKEN(STR_CON_OUT
), &gEfiConsoleOutDeviceGuid
, NULL
},
1539 {STRING_TOKEN(STR_STD_ERR
), &gEfiStandardErrorDeviceGuid
, NULL
},
1540 {STRING_TOKEN(STR_LOAD_FILE
), &gEfiLoadFileProtocolGuid
, NULL
},
1541 {STRING_TOKEN(STR_LOAD_FILE2
), &gEfiLoadFile2ProtocolGuid
, NULL
},
1542 {STRING_TOKEN(STR_SIMPLE_FILE_SYS
), &gEfiSimpleFileSystemProtocolGuid
, NULL
},
1543 {STRING_TOKEN(STR_TAPE_IO
), &gEfiTapeIoProtocolGuid
, NULL
},
1544 {STRING_TOKEN(STR_DISK_IO
), &gEfiDiskIoProtocolGuid
, NULL
},
1545 {STRING_TOKEN(STR_BLK_IO
), &gEfiBlockIoProtocolGuid
, NULL
},
1546 {STRING_TOKEN(STR_UC
), &gEfiUnicodeCollationProtocolGuid
, NULL
},
1547 {STRING_TOKEN(STR_UC2
), &gEfiUnicodeCollation2ProtocolGuid
, NULL
},
1548 {STRING_TOKEN(STR_PCIRB_IO
), &gEfiPciRootBridgeIoProtocolGuid
, PciRootBridgeIoDumpInformation
},
1549 {STRING_TOKEN(STR_PCI_IO
), &gEfiPciIoProtocolGuid
, NULL
},
1550 {STRING_TOKEN(STR_SCSI_PT
), &gEfiScsiPassThruProtocolGuid
, NULL
},
1551 {STRING_TOKEN(STR_SCSI_IO
), &gEfiScsiIoProtocolGuid
, NULL
},
1552 {STRING_TOKEN(STR_SCSI_PT_EXT
), &gEfiExtScsiPassThruProtocolGuid
, NULL
},
1553 {STRING_TOKEN(STR_ISCSI
), &gEfiIScsiInitiatorNameProtocolGuid
, NULL
},
1554 {STRING_TOKEN(STR_USB_IO
), &gEfiUsbIoProtocolGuid
, NULL
},
1555 {STRING_TOKEN(STR_USB_HC
), &gEfiUsbHcProtocolGuid
, NULL
},
1556 {STRING_TOKEN(STR_USB_HC2
), &gEfiUsb2HcProtocolGuid
, NULL
},
1557 {STRING_TOKEN(STR_DEBUG_SUPPORT
), &gEfiDebugSupportProtocolGuid
, NULL
},
1558 {STRING_TOKEN(STR_DEBUG_PORT
), &gEfiDebugPortProtocolGuid
, NULL
},
1559 {STRING_TOKEN(STR_DECOMPRESS
), &gEfiDecompressProtocolGuid
, NULL
},
1560 {STRING_TOKEN(STR_ACPI_TABLE
), &gEfiAcpiTableProtocolGuid
, NULL
},
1561 {STRING_TOKEN(STR_EBC_INTERPRETER
), &gEfiEbcProtocolGuid
, NULL
},
1562 {STRING_TOKEN(STR_SNP
), &gEfiSimpleNetworkProtocolGuid
, NULL
},
1563 {STRING_TOKEN(STR_NII
), &gEfiNetworkInterfaceIdentifierProtocolGuid
, NULL
},
1564 {STRING_TOKEN(STR_NII_31
), &gEfiNetworkInterfaceIdentifierProtocolGuid_31
, NULL
},
1565 {STRING_TOKEN(STR_PXE_BC
), &gEfiPxeBaseCodeProtocolGuid
, NULL
},
1566 {STRING_TOKEN(STR_PXE_CB
), &gEfiPxeBaseCodeCallbackProtocolGuid
, NULL
},
1567 {STRING_TOKEN(STR_BIS
), &gEfiBisProtocolGuid
, NULL
},
1568 {STRING_TOKEN(STR_MNP_SB
), &gEfiManagedNetworkServiceBindingProtocolGuid
, NULL
},
1569 {STRING_TOKEN(STR_MNP
), &gEfiManagedNetworkProtocolGuid
, NULL
},
1570 {STRING_TOKEN(STR_ARP_SB
), &gEfiArpServiceBindingProtocolGuid
, NULL
},
1571 {STRING_TOKEN(STR_ARP
), &gEfiArpProtocolGuid
, NULL
},
1572 {STRING_TOKEN(STR_DHCPV4_SB
), &gEfiDhcp4ServiceBindingProtocolGuid
, NULL
},
1573 {STRING_TOKEN(STR_DHCPV4
), &gEfiDhcp4ProtocolGuid
, NULL
},
1574 {STRING_TOKEN(STR_TCPV4_SB
), &gEfiTcp4ServiceBindingProtocolGuid
, NULL
},
1575 {STRING_TOKEN(STR_TCPV4
), &gEfiTcp4ProtocolGuid
, NULL
},
1576 {STRING_TOKEN(STR_IPV4_SB
), &gEfiIp4ServiceBindingProtocolGuid
, NULL
},
1577 {STRING_TOKEN(STR_IPV4
), &gEfiIp4ProtocolGuid
, NULL
},
1578 {STRING_TOKEN(STR_IPV4_CFG
), &gEfiIp4ConfigProtocolGuid
, NULL
},
1579 {STRING_TOKEN(STR_IPV4_CFG2
), &gEfiIp4Config2ProtocolGuid
, NULL
},
1580 {STRING_TOKEN(STR_UDPV4_SB
), &gEfiUdp4ServiceBindingProtocolGuid
, NULL
},
1581 {STRING_TOKEN(STR_UDPV4
), &gEfiUdp4ProtocolGuid
, NULL
},
1582 {STRING_TOKEN(STR_MTFTPV4_SB
), &gEfiMtftp4ServiceBindingProtocolGuid
, NULL
},
1583 {STRING_TOKEN(STR_MTFTPV4
), &gEfiMtftp4ProtocolGuid
, NULL
},
1584 {STRING_TOKEN(STR_AUTH_INFO
), &gEfiAuthenticationInfoProtocolGuid
, NULL
},
1585 {STRING_TOKEN(STR_HASH_SB
), &gEfiHashServiceBindingProtocolGuid
, NULL
},
1586 {STRING_TOKEN(STR_HASH
), &gEfiHashProtocolGuid
, NULL
},
1587 {STRING_TOKEN(STR_HII_FONT
), &gEfiHiiFontProtocolGuid
, NULL
},
1588 {STRING_TOKEN(STR_HII_STRING
), &gEfiHiiStringProtocolGuid
, NULL
},
1589 {STRING_TOKEN(STR_HII_IMAGE
), &gEfiHiiImageProtocolGuid
, NULL
},
1590 {STRING_TOKEN(STR_HII_DATABASE
), &gEfiHiiDatabaseProtocolGuid
, NULL
},
1591 {STRING_TOKEN(STR_HII_CONFIG_ROUT
), &gEfiHiiConfigRoutingProtocolGuid
, NULL
},
1592 {STRING_TOKEN(STR_HII_CONFIG_ACC
), &gEfiHiiConfigAccessProtocolGuid
, NULL
},
1593 {STRING_TOKEN(STR_HII_FORM_BROWSER2
), &gEfiFormBrowser2ProtocolGuid
, NULL
},
1594 {STRING_TOKEN(STR_DRIVER_FAM_OVERRIDE
), &gEfiDriverFamilyOverrideProtocolGuid
, NULL
},
1595 {STRING_TOKEN(STR_PCD
), &gPcdProtocolGuid
, NULL
},
1596 {STRING_TOKEN(STR_TCG
), &gEfiTcgProtocolGuid
, NULL
},
1597 {STRING_TOKEN(STR_HII_PACKAGE_LIST
), &gEfiHiiPackageListProtocolGuid
, NULL
},
1600 // the ones under this are deprecated by the current UEFI Spec, but may be found anyways...
1602 {STRING_TOKEN(STR_SHELL_INTERFACE
), &gEfiShellInterfaceGuid
, NULL
},
1603 {STRING_TOKEN(STR_SHELL_ENV2
), &gEfiShellEnvironment2Guid
, NULL
},
1604 {STRING_TOKEN(STR_SHELL_ENV
), &gEfiShellEnvironment2Guid
, NULL
},
1605 {STRING_TOKEN(STR_DEVICE_IO
), &gEfiDeviceIoProtocolGuid
, NULL
},
1606 {STRING_TOKEN(STR_UGA_DRAW
), &gEfiUgaDrawProtocolGuid
, NULL
},
1607 {STRING_TOKEN(STR_UGA_IO
), &gEfiUgaIoProtocolGuid
, NULL
},
1608 {STRING_TOKEN(STR_ESP
), &gEfiPartTypeSystemPartGuid
, NULL
},
1609 {STRING_TOKEN(STR_GPT_NBR
), &gEfiPartTypeLegacyMbrGuid
, NULL
},
1610 {STRING_TOKEN(STR_DRIVER_CONFIG
), &gEfiDriverConfigurationProtocolGuid
, NULL
},
1611 {STRING_TOKEN(STR_DRIVER_CONFIG2
), &gEfiDriverConfiguration2ProtocolGuid
, NULL
},
1614 // these are using local (non-global) definitions to reduce package dependancy.
1616 {STRING_TOKEN(STR_ISA_IO
), (EFI_GUID
*)&EfiIsaIoProtocolGuid
, NULL
},
1617 {STRING_TOKEN(STR_ISA_ACPI
), (EFI_GUID
*)&EfiIsaAcpiProtocolGuid
, NULL
},
1620 // the ones under this are GUID identified structs, not protocols
1622 {STRING_TOKEN(STR_FILE_INFO
), &gEfiFileInfoGuid
, NULL
},
1623 {STRING_TOKEN(STR_FILE_SYS_INFO
), &gEfiFileSystemInfoGuid
, NULL
},
1626 // the ones under this are misc GUIDS.
1628 {STRING_TOKEN(STR_EFI_GLOBAL_VARIABLE
), &gEfiGlobalVariableGuid
, NULL
},
1633 {STRING_TOKEN(STR_IP6_SB
), &gEfiIp6ServiceBindingProtocolGuid
, NULL
},
1634 {STRING_TOKEN(STR_IP6
), &gEfiIp6ProtocolGuid
, NULL
},
1635 {STRING_TOKEN(STR_IP6_CONFIG
), &gEfiIp6ConfigProtocolGuid
, NULL
},
1636 {STRING_TOKEN(STR_MTFTP6_SB
), &gEfiMtftp6ServiceBindingProtocolGuid
, NULL
},
1637 {STRING_TOKEN(STR_MTFTP6
), &gEfiMtftp6ProtocolGuid
, NULL
},
1638 {STRING_TOKEN(STR_DHCP6_SB
), &gEfiDhcp6ServiceBindingProtocolGuid
, NULL
},
1639 {STRING_TOKEN(STR_DHCP6
), &gEfiDhcp6ProtocolGuid
, NULL
},
1640 {STRING_TOKEN(STR_UDP6_SB
), &gEfiUdp6ServiceBindingProtocolGuid
, NULL
},
1641 {STRING_TOKEN(STR_UDP6
), &gEfiUdp6ProtocolGuid
, NULL
},
1642 {STRING_TOKEN(STR_TCP6_SB
), &gEfiTcp6ServiceBindingProtocolGuid
, NULL
},
1643 {STRING_TOKEN(STR_TCP6
), &gEfiTcp6ProtocolGuid
, NULL
},
1644 {STRING_TOKEN(STR_VLAN_CONFIG
), &gEfiVlanConfigProtocolGuid
, NULL
},
1645 {STRING_TOKEN(STR_EAP
), &gEfiEapProtocolGuid
, NULL
},
1646 {STRING_TOKEN(STR_EAP_MGMT
), &gEfiEapManagementProtocolGuid
, NULL
},
1647 {STRING_TOKEN(STR_FTP4_SB
), &gEfiFtp4ServiceBindingProtocolGuid
, NULL
},
1648 {STRING_TOKEN(STR_FTP4
), &gEfiFtp4ProtocolGuid
, NULL
},
1649 {STRING_TOKEN(STR_IP_SEC_CONFIG
), &gEfiIpSecConfigProtocolGuid
, NULL
},
1650 {STRING_TOKEN(STR_DH
), &gEfiDriverHealthProtocolGuid
, NULL
},
1651 {STRING_TOKEN(STR_DEF_IMG_LOAD
), &gEfiDeferredImageLoadProtocolGuid
, NULL
},
1652 {STRING_TOKEN(STR_USER_CRED
), &gEfiUserCredentialProtocolGuid
, NULL
},
1653 {STRING_TOKEN(STR_USER_MNGR
), &gEfiUserManagerProtocolGuid
, NULL
},
1654 {STRING_TOKEN(STR_ATA_PASS_THRU
), &gEfiAtaPassThruProtocolGuid
, NULL
},
1659 {STRING_TOKEN(STR_FW_MGMT
), &gEfiFirmwareManagementProtocolGuid
, FirmwareManagementDumpInformation
},
1660 {STRING_TOKEN(STR_IP_SEC
), &gEfiIpSecProtocolGuid
, NULL
},
1661 {STRING_TOKEN(STR_IP_SEC2
), &gEfiIpSec2ProtocolGuid
, NULL
},
1666 {STRING_TOKEN(STR_KMS
), &gEfiKmsProtocolGuid
, NULL
},
1667 {STRING_TOKEN(STR_BLK_IO2
), &gEfiBlockIo2ProtocolGuid
, NULL
},
1668 {STRING_TOKEN(STR_SSC
), &gEfiStorageSecurityCommandProtocolGuid
, NULL
},
1669 {STRING_TOKEN(STR_UCRED2
), &gEfiUserCredential2ProtocolGuid
, NULL
},
1674 {STRING_TOKEN(STR_DISK_IO2
), &gEfiDiskIo2ProtocolGuid
, NULL
},
1675 {STRING_TOKEN(STR_ADAPTER_INFO
), &gEfiAdapterInformationProtocolGuid
, AdapterInformationDumpInformation
},
1680 {STRING_TOKEN(STR_IDE_CONT_INIT
), &gEfiIdeControllerInitProtocolGuid
, NULL
},
1681 {STRING_TOKEN(STR_DISK_INFO
), &gEfiDiskInfoProtocolGuid
, NULL
},
1686 {STRING_TOKEN(STR_BDS_ARCH
), &gEfiBdsArchProtocolGuid
, NULL
},
1687 {STRING_TOKEN(STR_CPU_ARCH
), &gEfiCpuArchProtocolGuid
, NULL
},
1688 {STRING_TOKEN(STR_MET_ARCH
), &gEfiMetronomeArchProtocolGuid
, NULL
},
1689 {STRING_TOKEN(STR_MON_ARCH
), &gEfiMonotonicCounterArchProtocolGuid
, NULL
},
1690 {STRING_TOKEN(STR_RTC_ARCH
), &gEfiRealTimeClockArchProtocolGuid
, NULL
},
1691 {STRING_TOKEN(STR_RESET_ARCH
), &gEfiResetArchProtocolGuid
, NULL
},
1692 {STRING_TOKEN(STR_RT_ARCH
), &gEfiRuntimeArchProtocolGuid
, NULL
},
1693 {STRING_TOKEN(STR_SEC_ARCH
), &gEfiSecurityArchProtocolGuid
, NULL
},
1694 {STRING_TOKEN(STR_TIMER_ARCH
), &gEfiTimerArchProtocolGuid
, NULL
},
1695 {STRING_TOKEN(STR_VAR_ARCH
), &gEfiVariableWriteArchProtocolGuid
, NULL
},
1696 {STRING_TOKEN(STR_V_ARCH
), &gEfiVariableArchProtocolGuid
, NULL
},
1697 {STRING_TOKEN(STR_SECP
), &gEfiSecurityPolicyProtocolGuid
, NULL
},
1698 {STRING_TOKEN(STR_WDT_ARCH
), &gEfiWatchdogTimerArchProtocolGuid
, NULL
},
1699 {STRING_TOKEN(STR_SCR
), &gEfiStatusCodeRuntimeProtocolGuid
, NULL
},
1700 {STRING_TOKEN(STR_SMB_HC
), &gEfiSmbusHcProtocolGuid
, NULL
},
1701 {STRING_TOKEN(STR_FV_2
), &gEfiFirmwareVolume2ProtocolGuid
, NULL
},
1702 {STRING_TOKEN(STR_FV_BLOCK
), &gEfiFirmwareVolumeBlockProtocolGuid
, NULL
},
1703 {STRING_TOKEN(STR_CAP_ARCH
), &gEfiCapsuleArchProtocolGuid
, NULL
},
1704 {STRING_TOKEN(STR_MP_SERVICE
), &gEfiMpServiceProtocolGuid
, NULL
},
1705 {STRING_TOKEN(STR_HBRAP
), &gEfiPciHostBridgeResourceAllocationProtocolGuid
, NULL
},
1706 {STRING_TOKEN(STR_PCIP
), &gEfiPciPlatformProtocolGuid
, NULL
},
1707 {STRING_TOKEN(STR_PCIO
), &gEfiPciOverrideProtocolGuid
, NULL
},
1708 {STRING_TOKEN(STR_PCIE
), &gEfiPciEnumerationCompleteProtocolGuid
, NULL
},
1709 {STRING_TOKEN(STR_IPCID
), &gEfiIncompatiblePciDeviceSupportProtocolGuid
, NULL
},
1710 {STRING_TOKEN(STR_PCIHPI
), &gEfiPciHotPlugInitProtocolGuid
, NULL
},
1711 {STRING_TOKEN(STR_PCIHPR
), &gEfiPciHotPlugRequestProtocolGuid
, NULL
},
1712 {STRING_TOKEN(STR_SMBIOS
), &gEfiSmbiosProtocolGuid
, NULL
},
1713 {STRING_TOKEN(STR_S3_SAVE
), &gEfiS3SaveStateProtocolGuid
, NULL
},
1714 {STRING_TOKEN(STR_S3_S_SMM
), &gEfiS3SmmSaveStateProtocolGuid
, NULL
},
1715 {STRING_TOKEN(STR_RSC
), &gEfiRscHandlerProtocolGuid
, NULL
},
1716 {STRING_TOKEN(STR_S_RSC
), &gEfiSmmRscHandlerProtocolGuid
, NULL
},
1717 {STRING_TOKEN(STR_ACPI_SDT
), &gEfiAcpiSdtProtocolGuid
, NULL
},
1718 {STRING_TOKEN(STR_SIO
), &gEfiSioProtocolGuid
, NULL
},
1719 {STRING_TOKEN(STR_S_CPU2
), &gEfiSmmCpuIo2ProtocolGuid
, NULL
},
1720 {STRING_TOKEN(STR_S_BASE2
), &gEfiSmmBase2ProtocolGuid
, NULL
},
1721 {STRING_TOKEN(STR_S_ACC_2
), &gEfiSmmAccess2ProtocolGuid
, NULL
},
1722 {STRING_TOKEN(STR_S_CON_2
), &gEfiSmmControl2ProtocolGuid
, NULL
},
1723 {STRING_TOKEN(STR_S_CONFIG
), &gEfiSmmConfigurationProtocolGuid
, NULL
},
1724 {STRING_TOKEN(STR_S_RTL
), &gEfiSmmReadyToLockProtocolGuid
, NULL
},
1725 {STRING_TOKEN(STR_DS_RTL
), &gEfiDxeSmmReadyToLockProtocolGuid
, NULL
},
1726 {STRING_TOKEN(STR_S_COMM
), &gEfiSmmCommunicationProtocolGuid
, NULL
},
1727 {STRING_TOKEN(STR_S_STAT
), &gEfiSmmStatusCodeProtocolGuid
, NULL
},
1728 {STRING_TOKEN(STR_S_CPU
), &gEfiSmmCpuProtocolGuid
, NULL
},
1729 {STRING_TOKEN(STR_S_PCIRBIO
), &gEfiPciRootBridgeIoProtocolGuid
, NULL
},
1730 {STRING_TOKEN(STR_S_SWD
), &gEfiSmmSwDispatch2ProtocolGuid
, NULL
},
1731 {STRING_TOKEN(STR_S_SXD
), &gEfiSmmSxDispatch2ProtocolGuid
, NULL
},
1732 {STRING_TOKEN(STR_S_PTD2
), &gEfiSmmPeriodicTimerDispatch2ProtocolGuid
, NULL
},
1733 {STRING_TOKEN(STR_S_UD2
), &gEfiSmmUsbDispatch2ProtocolGuid
, NULL
},
1734 {STRING_TOKEN(STR_S_GD2
), &gEfiSmmGpiDispatch2ProtocolGuid
, NULL
},
1735 {STRING_TOKEN(STR_S_SBD2
), &gEfiSmmStandbyButtonDispatch2ProtocolGuid
, NULL
},
1736 {STRING_TOKEN(STR_S_PBD2
), &gEfiSmmPowerButtonDispatch2ProtocolGuid
, NULL
},
1737 {STRING_TOKEN(STR_S_ITD2
), &gEfiSmmIoTrapDispatch2ProtocolGuid
, NULL
},
1738 {STRING_TOKEN(STR_PCD
), &gEfiPcdProtocolGuid
, NULL
},
1739 {STRING_TOKEN(STR_FVB2
), &gEfiFirmwareVolumeBlock2ProtocolGuid
, NULL
},
1740 {STRING_TOKEN(STR_CPUIO2
), &gEfiCpuIo2ProtocolGuid
, NULL
},
1741 {STRING_TOKEN(STR_LEGACY_R2
), &gEfiLegacyRegion2ProtocolGuid
, NULL
},
1742 {STRING_TOKEN(STR_SAL_MIP
), &gEfiSalMcaInitPmiProtocolGuid
, NULL
},
1743 {STRING_TOKEN(STR_ES_BS
), &gEfiExtendedSalBootServiceProtocolGuid
, NULL
},
1744 {STRING_TOKEN(STR_ES_BIO
), &gEfiExtendedSalBaseIoServicesProtocolGuid
, NULL
},
1745 {STRING_TOKEN(STR_ES_STALL
), &gEfiExtendedSalStallServicesProtocolGuid
, NULL
},
1746 {STRING_TOKEN(STR_ES_RTC
), &gEfiExtendedSalRtcServicesProtocolGuid
, NULL
},
1747 {STRING_TOKEN(STR_ES_VS
), &gEfiExtendedSalVariableServicesProtocolGuid
, NULL
},
1748 {STRING_TOKEN(STR_ES_MTC
), &gEfiExtendedSalMtcServicesProtocolGuid
, NULL
},
1749 {STRING_TOKEN(STR_ES_RESET
), &gEfiExtendedSalResetServicesProtocolGuid
, NULL
},
1750 {STRING_TOKEN(STR_ES_SC
), &gEfiExtendedSalStatusCodeServicesProtocolGuid
, NULL
},
1751 {STRING_TOKEN(STR_ES_FBS
), &gEfiExtendedSalFvBlockServicesProtocolGuid
, NULL
},
1752 {STRING_TOKEN(STR_ES_MP
), &gEfiExtendedSalMpServicesProtocolGuid
, NULL
},
1753 {STRING_TOKEN(STR_ES_PAL
), &gEfiExtendedSalPalServicesProtocolGuid
, NULL
},
1754 {STRING_TOKEN(STR_ES_BASE
), &gEfiExtendedSalBaseServicesProtocolGuid
, NULL
},
1755 {STRING_TOKEN(STR_ES_MCA
), &gEfiExtendedSalMcaServicesProtocolGuid
, NULL
},
1756 {STRING_TOKEN(STR_ES_PCI
), &gEfiExtendedSalPciServicesProtocolGuid
, NULL
},
1757 {STRING_TOKEN(STR_ES_CACHE
), &gEfiExtendedSalCacheServicesProtocolGuid
, NULL
},
1758 {STRING_TOKEN(STR_ES_MCA_LOG
), &gEfiExtendedSalMcaLogServicesProtocolGuid
, NULL
},
1759 {STRING_TOKEN(STR_S2ARCH
), &gEfiSecurity2ArchProtocolGuid
, NULL
},
1760 {STRING_TOKEN(STR_EODXE
), &gEfiSmmEndOfDxeProtocolGuid
, NULL
},
1761 {STRING_TOKEN(STR_ISAHC
), &gEfiIsaHcProtocolGuid
, NULL
},
1762 {STRING_TOKEN(STR_ISAHC_B
), &gEfiIsaHcServiceBindingProtocolGuid
, NULL
},
1763 {STRING_TOKEN(STR_SIO_C
), &gEfiSioControlProtocolGuid
, NULL
},
1764 {STRING_TOKEN(STR_GET_PCD
), &gEfiGetPcdInfoProtocolGuid
, NULL
},
1765 {STRING_TOKEN(STR_I2C_M
), &gEfiI2cMasterProtocolGuid
, NULL
},
1766 {STRING_TOKEN(STR_I2CIO
), &gEfiI2cIoProtocolGuid
, NULL
},
1767 {STRING_TOKEN(STR_I2CEN
), &gEfiI2cEnumerateProtocolGuid
, NULL
},
1768 {STRING_TOKEN(STR_I2C_H
), &gEfiI2cHostProtocolGuid
, NULL
},
1769 {STRING_TOKEN(STR_I2C_BCM
), &gEfiI2cBusConfigurationManagementProtocolGuid
, NULL
},
1770 {STRING_TOKEN(STR_TREE
), &gEfiTrEEProtocolGuid
, NULL
},
1771 {STRING_TOKEN(STR_TCG2
), &gEfiTcg2ProtocolGuid
, NULL
},
1772 {STRING_TOKEN(STR_TIMESTAMP
), &gEfiTimestampProtocolGuid
, NULL
},
1773 {STRING_TOKEN(STR_RNG
), &gEfiRngProtocolGuid
, NULL
},
1774 {STRING_TOKEN(STR_NVMEPT
), &gEfiNvmExpressPassThruProtocolGuid
, NULL
},
1775 {STRING_TOKEN(STR_H2_SB
), &gEfiHash2ServiceBindingProtocolGuid
, NULL
},
1776 {STRING_TOKEN(STR_HASH2
), &gEfiHash2ProtocolGuid
, NULL
},
1777 {STRING_TOKEN(STR_BIO_C
), &gEfiBlockIoCryptoProtocolGuid
, NULL
},
1778 {STRING_TOKEN(STR_SCR
), &gEfiSmartCardReaderProtocolGuid
, NULL
},
1779 {STRING_TOKEN(STR_SCE
), &gEfiSmartCardEdgeProtocolGuid
, NULL
},
1780 {STRING_TOKEN(STR_USB_FIO
), &gEfiUsbFunctionIoProtocolGuid
, NULL
},
1781 {STRING_TOKEN(STR_BC_HC
), &gEfiBluetoothHcProtocolGuid
, NULL
},
1782 {STRING_TOKEN(STR_BC_IO_SB
), &gEfiBluetoothIoServiceBindingProtocolGuid
, NULL
},
1783 {STRING_TOKEN(STR_BC_IO
), &gEfiBluetoothIoProtocolGuid
, NULL
},
1784 {STRING_TOKEN(STR_BC_C
), &gEfiBluetoothConfigProtocolGuid
, NULL
},
1785 {STRING_TOKEN(STR_REG_EXP
), &gEfiRegularExpressionProtocolGuid
, NULL
},
1786 {STRING_TOKEN(STR_B_MGR_P
), &gEfiBootManagerPolicyProtocolGuid
, NULL
},
1787 {STRING_TOKEN(STR_CKH
), &gEfiConfigKeywordHandlerProtocolGuid
, NULL
},
1788 {STRING_TOKEN(STR_WIFI
), &gEfiWiFiProtocolGuid
, NULL
},
1789 {STRING_TOKEN(STR_EAP_M
), &gEfiEapManagement2ProtocolGuid
, NULL
},
1790 {STRING_TOKEN(STR_EAP_C
), &gEfiEapConfigurationProtocolGuid
, NULL
},
1791 {STRING_TOKEN(STR_PKCS7
), &gEfiPkcs7VerifyProtocolGuid
, NULL
},
1792 {STRING_TOKEN(STR_NET_DNS4_SB
), &gEfiDns4ServiceBindingProtocolGuid
, NULL
},
1793 {STRING_TOKEN(STR_NET_DNS4
), &gEfiDns4ProtocolGuid
, NULL
},
1794 {STRING_TOKEN(STR_NET_DNS6_SB
), &gEfiDns6ServiceBindingProtocolGuid
, NULL
},
1795 {STRING_TOKEN(STR_NET_DNS6
), &gEfiDns6ProtocolGuid
, NULL
},
1796 {STRING_TOKEN(STR_NET_HTTP_SB
), &gEfiHttpServiceBindingProtocolGuid
, NULL
},
1797 {STRING_TOKEN(STR_NET_HTTP
), &gEfiHttpProtocolGuid
, NULL
},
1798 {STRING_TOKEN(STR_NET_HTTP_U
), &gEfiHttpUtilitiesProtocolGuid
, NULL
},
1799 {STRING_TOKEN(STR_REST
), &gEfiRestProtocolGuid
, NULL
},
1802 // UEFI Shell Spec 2.0
1804 {STRING_TOKEN(STR_SHELL_PARAMETERS
), &gEfiShellParametersProtocolGuid
, NULL
},
1805 {STRING_TOKEN(STR_SHELL
), &gEfiShellProtocolGuid
, NULL
},
1808 // UEFI Shell Spec 2.1
1810 {STRING_TOKEN(STR_SHELL_DYNAMIC
), &gEfiShellDynamicCommandProtocolGuid
, NULL
},
1815 {STRING_TOKEN(STR_PCDINFOPROT
), &gGetPcdInfoProtocolGuid
, NULL
},
1824 Function to get the node for a protocol or struct from it's GUID.
1826 if Guid is NULL, then ASSERT.
1828 @param[in] Guid The GUID to look for the name of.
1832 CONST GUID_INFO_BLOCK
*
1833 InternalShellGetNodeFromGuid(
1834 IN CONST EFI_GUID
* Guid
1837 CONST GUID_INFO_BLOCK
*ListWalker
;
1840 ASSERT(Guid
!= NULL
);
1842 for (LoopCount
= 0, ListWalker
= mGuidList
; mGuidList
!= NULL
&& LoopCount
< mGuidListCount
; LoopCount
++, ListWalker
++) {
1843 if (CompareGuid(ListWalker
->GuidId
, Guid
)) {
1844 return (ListWalker
);
1848 if (PcdGetBool(PcdShellIncludeNtGuids
)) {
1849 for (ListWalker
= mGuidStringListNT
; ListWalker
!= NULL
&& ListWalker
->GuidId
!= NULL
; ListWalker
++) {
1850 if (CompareGuid(ListWalker
->GuidId
, Guid
)) {
1851 return (ListWalker
);
1855 for (ListWalker
= mGuidStringList
; ListWalker
!= NULL
&& ListWalker
->GuidId
!= NULL
; ListWalker
++) {
1856 if (CompareGuid(ListWalker
->GuidId
, Guid
)) {
1857 return (ListWalker
);
1864 Function to add a new GUID/Name mapping.
1866 @param[in] Guid The Guid
1867 @param[in] NameID The STRING id of the HII string to use
1868 @param[in] DumpFunc The pointer to the dump function
1871 @retval EFI_SUCCESS The operation was sucessful
1872 @retval EFI_OUT_OF_RESOURCES A memory allocation failed
1873 @retval EFI_INVALID_PARAMETER Guid NameId was invalid
1876 InsertNewGuidNameMapping(
1877 IN CONST EFI_GUID
*Guid
,
1878 IN CONST EFI_STRING_ID NameID
,
1879 IN CONST DUMP_PROTOCOL_INFO DumpFunc OPTIONAL
1882 ASSERT(Guid
!= NULL
);
1883 ASSERT(NameID
!= 0);
1885 mGuidList
= ReallocatePool(mGuidListCount
* sizeof(GUID_INFO_BLOCK
), mGuidListCount
+1 * sizeof(GUID_INFO_BLOCK
), mGuidList
);
1886 if (mGuidList
== NULL
) {
1888 return (EFI_OUT_OF_RESOURCES
);
1892 mGuidList
[mGuidListCount
- 1].GuidId
= AllocateCopyPool(sizeof(EFI_GUID
), Guid
);
1893 mGuidList
[mGuidListCount
- 1].StringId
= NameID
;
1894 mGuidList
[mGuidListCount
- 1].DumpInfo
= DumpFunc
;
1896 if (mGuidList
[mGuidListCount
- 1].GuidId
== NULL
) {
1897 return (EFI_OUT_OF_RESOURCES
);
1900 return (EFI_SUCCESS
);
1904 Function to add a new GUID/Name mapping.
1906 This cannot overwrite an existing mapping.
1908 @param[in] Guid The Guid
1909 @param[in] TheName The Guid's name
1910 @param[in] Lang RFC4646 language code list or NULL
1912 @retval EFI_SUCCESS The operation was sucessful
1913 @retval EFI_ACCESS_DENIED There was a duplicate
1914 @retval EFI_OUT_OF_RESOURCES A memory allocation failed
1915 @retval EFI_INVALID_PARAMETER Guid or TheName was NULL
1919 AddNewGuidNameMapping(
1920 IN CONST EFI_GUID
*Guid
,
1921 IN CONST CHAR16
*TheName
,
1922 IN CONST CHAR8
*Lang OPTIONAL
1925 EFI_STRING_ID NameID
;
1927 HandleParsingHiiInit();
1929 if (Guid
== NULL
|| TheName
== NULL
){
1930 return (EFI_INVALID_PARAMETER
);
1933 if ((InternalShellGetNodeFromGuid(Guid
)) != NULL
) {
1934 return (EFI_ACCESS_DENIED
);
1937 NameID
= HiiSetString(mHandleParsingHiiHandle
, 0, (CHAR16
*)TheName
, Lang
);
1939 return (EFI_OUT_OF_RESOURCES
);
1942 return (InsertNewGuidNameMapping(Guid
, NameID
, NULL
));
1946 Function to get the name of a protocol or struct from it's GUID.
1948 if Guid is NULL, then ASSERT.
1950 @param[in] Guid The GUID to look for the name of.
1951 @param[in] Lang The language to use.
1953 @return pointer to string of the name. The caller
1954 is responsible to free this memory.
1958 GetStringNameFromGuid(
1959 IN CONST EFI_GUID
*Guid
,
1960 IN CONST CHAR8
*Lang OPTIONAL
1963 CONST GUID_INFO_BLOCK
*Id
;
1965 HandleParsingHiiInit();
1967 Id
= InternalShellGetNodeFromGuid(Guid
);
1971 return HiiGetString (mHandleParsingHiiHandle
, Id
->StringId
, Lang
);
1975 Function to dump protocol information from a handle.
1977 This function will return a allocated string buffer containing the
1978 information. The caller is responsible for freeing the memory.
1980 If Guid is NULL, ASSERT().
1981 If TheHandle is NULL, ASSERT().
1983 @param[in] TheHandle The handle to dump information from.
1984 @param[in] Guid The GUID of the protocol to dump.
1985 @param[in] Verbose TRUE for extra info. FALSE otherwise.
1987 @return The pointer to string.
1988 @retval NULL An error was encountered.
1992 GetProtocolInformationDump(
1993 IN CONST EFI_HANDLE TheHandle
,
1994 IN CONST EFI_GUID
*Guid
,
1995 IN CONST BOOLEAN Verbose
1998 CONST GUID_INFO_BLOCK
*Id
;
2000 ASSERT(TheHandle
!= NULL
);
2001 ASSERT(Guid
!= NULL
);
2003 if (TheHandle
== NULL
|| Guid
== NULL
) {
2007 Id
= InternalShellGetNodeFromGuid(Guid
);
2008 if (Id
!= NULL
&& Id
->DumpInfo
!= NULL
) {
2009 return (Id
->DumpInfo(TheHandle
, Verbose
));
2015 Function to get the Guid for a protocol or struct based on it's string name.
2017 do not modify the returned Guid.
2019 @param[in] Name The pointer to the string name.
2020 @param[in] Lang The pointer to the language code.
2021 @param[out] Guid The pointer to the Guid.
2023 @retval EFI_SUCCESS The operation was sucessful.
2027 GetGuidFromStringName(
2028 IN CONST CHAR16
*Name
,
2029 IN CONST CHAR8
*Lang OPTIONAL
,
2033 CONST GUID_INFO_BLOCK
*ListWalker
;
2037 HandleParsingHiiInit();
2039 ASSERT(Guid
!= NULL
);
2041 return (EFI_INVALID_PARAMETER
);
2045 if (PcdGetBool(PcdShellIncludeNtGuids
)) {
2046 for (ListWalker
= mGuidStringListNT
; ListWalker
!= NULL
&& ListWalker
->GuidId
!= NULL
; ListWalker
++) {
2047 String
= HiiGetString(mHandleParsingHiiHandle
, ListWalker
->StringId
, Lang
);
2048 if (Name
!= NULL
&& String
!= NULL
&& StringNoCaseCompare (&Name
, &String
) == 0) {
2049 *Guid
= ListWalker
->GuidId
;
2051 SHELL_FREE_NON_NULL(String
);
2052 if (*Guid
!= NULL
) {
2053 return (EFI_SUCCESS
);
2057 for (ListWalker
= mGuidStringList
; ListWalker
!= NULL
&& ListWalker
->GuidId
!= NULL
; ListWalker
++) {
2058 String
= HiiGetString(mHandleParsingHiiHandle
, ListWalker
->StringId
, Lang
);
2059 if (Name
!= NULL
&& String
!= NULL
&& StringNoCaseCompare (&Name
, &String
) == 0) {
2060 *Guid
= ListWalker
->GuidId
;
2062 SHELL_FREE_NON_NULL(String
);
2063 if (*Guid
!= NULL
) {
2064 return (EFI_SUCCESS
);
2068 for (LoopCount
= 0, ListWalker
= mGuidList
; mGuidList
!= NULL
&& LoopCount
< mGuidListCount
; LoopCount
++, ListWalker
++) {
2069 String
= HiiGetString(mHandleParsingHiiHandle
, ListWalker
->StringId
, Lang
);
2070 if (Name
!= NULL
&& String
!= NULL
&& StringNoCaseCompare (&Name
, &String
) == 0) {
2071 *Guid
= ListWalker
->GuidId
;
2073 SHELL_FREE_NON_NULL(String
);
2074 if (*Guid
!= NULL
) {
2075 return (EFI_SUCCESS
);
2079 return (EFI_NOT_FOUND
);
2083 Get best support language for this driver.
2085 First base on the user input language to search, second base on the current
2086 platform used language to search, third get the first language from the
2087 support language list. The caller need to free the buffer of the best language.
2089 @param[in] SupportedLanguages The support languages for this driver.
2090 @param[in] InputLanguage The user input language.
2091 @param[in] Iso639Language Whether get language for ISO639.
2093 @return The best support language for this driver.
2097 GetBestLanguageForDriver (
2098 IN CONST CHAR8
*SupportedLanguages
,
2099 IN CONST CHAR8
*InputLanguage
,
2100 IN BOOLEAN Iso639Language
2103 CHAR8
*LanguageVariable
;
2104 CHAR8
*BestLanguage
;
2106 GetVariable2 (Iso639Language
? L
"Lang" : L
"PlatformLang", &gEfiGlobalVariableGuid
, (VOID
**)&LanguageVariable
, NULL
);
2108 BestLanguage
= GetBestLanguage(
2111 (InputLanguage
!= NULL
) ? InputLanguage
: "",
2112 (LanguageVariable
!= NULL
) ? LanguageVariable
: "",
2117 if (LanguageVariable
!= NULL
) {
2118 FreePool (LanguageVariable
);
2121 return BestLanguage
;
2125 Function to retrieve the driver name (if possible) from the ComponentName or
2126 ComponentName2 protocol
2128 @param[in] TheHandle The driver handle to get the name of.
2129 @param[in] Language The language to use.
2131 @retval NULL The name could not be found.
2132 @return A pointer to the string name. Do not de-allocate the memory.
2136 GetStringNameFromHandle(
2137 IN CONST EFI_HANDLE TheHandle
,
2138 IN CONST CHAR8
*Language
2141 EFI_COMPONENT_NAME2_PROTOCOL
*CompNameStruct
;
2148 Status
= gBS
->OpenProtocol(
2150 &gEfiComponentName2ProtocolGuid
,
2151 (VOID
**)&CompNameStruct
,
2154 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
2155 if (!EFI_ERROR(Status
)) {
2156 BestLang
= GetBestLanguageForDriver (CompNameStruct
->SupportedLanguages
, Language
, FALSE
);
2157 Status
= CompNameStruct
->GetDriverName(CompNameStruct
, BestLang
, &RetVal
);
2158 if (BestLang
!= NULL
) {
2159 FreePool (BestLang
);
2162 if (!EFI_ERROR(Status
)) {
2166 Status
= gBS
->OpenProtocol(
2168 &gEfiComponentNameProtocolGuid
,
2169 (VOID
**)&CompNameStruct
,
2172 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
2173 if (!EFI_ERROR(Status
)) {
2174 BestLang
= GetBestLanguageForDriver (CompNameStruct
->SupportedLanguages
, Language
, FALSE
);
2175 Status
= CompNameStruct
->GetDriverName(CompNameStruct
, BestLang
, &RetVal
);
2176 if (BestLang
!= NULL
) {
2177 FreePool (BestLang
);
2179 if (!EFI_ERROR(Status
)) {
2187 Function to initialize the file global mHandleList object for use in
2188 vonverting handles to index and index to handle.
2190 @retval EFI_SUCCESS The operation was successful.
2193 InternalShellInitHandleList(
2198 EFI_HANDLE
*HandleBuffer
;
2200 HANDLE_LIST
*ListWalker
;
2202 if (mHandleList
.NextIndex
!= 0) {
2205 InitializeListHead(&mHandleList
.List
.Link
);
2206 mHandleList
.NextIndex
= 1;
2207 Status
= gBS
->LocateHandleBuffer (
2214 ASSERT_EFI_ERROR(Status
);
2215 if (EFI_ERROR(Status
)) {
2218 for (mHandleList
.NextIndex
= 1 ; mHandleList
.NextIndex
<= HandleCount
; mHandleList
.NextIndex
++){
2219 ListWalker
= AllocateZeroPool(sizeof(HANDLE_LIST
));
2220 if (ListWalker
!= NULL
) {
2221 ListWalker
->TheHandle
= HandleBuffer
[mHandleList
.NextIndex
- 1];
2222 ListWalker
->TheIndex
= mHandleList
.NextIndex
;
2223 InsertTailList (&mHandleList
.List
.Link
, &ListWalker
->Link
);
2226 FreePool(HandleBuffer
);
2227 return (EFI_SUCCESS
);
2231 Function to retrieve the human-friendly index of a given handle. If the handle
2232 does not have a index one will be automatically assigned. The index value is valid
2233 until the termination of the shell application.
2235 @param[in] TheHandle The handle to retrieve an index for.
2237 @retval 0 A memory allocation failed.
2238 @return The index of the handle.
2243 ConvertHandleToHandleIndex(
2244 IN CONST EFI_HANDLE TheHandle
2248 EFI_GUID
**ProtocolBuffer
;
2249 UINTN ProtocolCount
;
2250 HANDLE_LIST
*ListWalker
;
2252 if (TheHandle
== NULL
) {
2256 InternalShellInitHandleList();
2258 for (ListWalker
= (HANDLE_LIST
*)GetFirstNode(&mHandleList
.List
.Link
)
2259 ; !IsNull(&mHandleList
.List
.Link
,&ListWalker
->Link
)
2260 ; ListWalker
= (HANDLE_LIST
*)GetNextNode(&mHandleList
.List
.Link
,&ListWalker
->Link
)
2262 if (ListWalker
->TheHandle
== TheHandle
) {
2264 // Verify that TheHandle is still present in the Handle Database
2266 Status
= gBS
->ProtocolsPerHandle(TheHandle
, &ProtocolBuffer
, &ProtocolCount
);
2267 if (EFI_ERROR (Status
)) {
2269 // TheHandle is not present in the Handle Database, so delete from the handle list
2271 RemoveEntryList (&ListWalker
->Link
);
2274 FreePool (ProtocolBuffer
);
2275 return (ListWalker
->TheIndex
);
2280 // Verify that TheHandle is valid handle
2282 Status
= gBS
->ProtocolsPerHandle(TheHandle
, &ProtocolBuffer
, &ProtocolCount
);
2283 if (EFI_ERROR (Status
)) {
2285 // TheHandle is not valid, so do not add to handle list
2289 FreePool (ProtocolBuffer
);
2291 ListWalker
= AllocateZeroPool(sizeof(HANDLE_LIST
));
2292 if (ListWalker
== NULL
) {
2295 ListWalker
->TheHandle
= TheHandle
;
2296 ListWalker
->TheIndex
= mHandleList
.NextIndex
++;
2297 InsertTailList(&mHandleList
.List
.Link
,&ListWalker
->Link
);
2298 return (ListWalker
->TheIndex
);
2304 Function to retrieve the EFI_HANDLE from the human-friendly index.
2306 @param[in] TheIndex The index to retrieve the EFI_HANDLE for.
2308 @retval NULL The index was invalid.
2309 @return The EFI_HANDLE that index represents.
2314 ConvertHandleIndexToHandle(
2315 IN CONST UINTN TheIndex
2319 EFI_GUID
**ProtocolBuffer
;
2320 UINTN ProtocolCount
;
2321 HANDLE_LIST
*ListWalker
;
2323 InternalShellInitHandleList();
2325 if (TheIndex
>= mHandleList
.NextIndex
) {
2329 for (ListWalker
= (HANDLE_LIST
*)GetFirstNode(&mHandleList
.List
.Link
)
2330 ; !IsNull(&mHandleList
.List
.Link
,&ListWalker
->Link
)
2331 ; ListWalker
= (HANDLE_LIST
*)GetNextNode(&mHandleList
.List
.Link
,&ListWalker
->Link
)
2333 if (ListWalker
->TheIndex
== TheIndex
&& ListWalker
->TheHandle
!= NULL
) {
2335 // Verify that LinkWalker->TheHandle is valid handle
2337 Status
= gBS
->ProtocolsPerHandle(ListWalker
->TheHandle
, &ProtocolBuffer
, &ProtocolCount
);
2338 if (!EFI_ERROR (Status
)) {
2339 FreePool (ProtocolBuffer
);
2342 // TheHandle is not valid, so do not add to handle list
2344 ListWalker
->TheHandle
= NULL
;
2346 return (ListWalker
->TheHandle
);
2353 Gets all the related EFI_HANDLEs based on the mask supplied.
2355 This function scans all EFI_HANDLES in the UEFI environment's handle database
2356 and returns the ones with the specified relationship (Mask) to the specified
2359 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.
2360 If MatchingHandleCount is NULL, then ASSERT.
2362 If MatchingHandleBuffer is not NULL upon a successful return the memory must be
2365 @param[in] DriverBindingHandle The handle with Driver Binding protocol on it.
2366 @param[in] ControllerHandle The handle with Device Path protocol on it.
2367 @param[in] MatchingHandleCount The pointer to UINTN that specifies the number of HANDLES in
2368 MatchingHandleBuffer.
2369 @param[out] MatchingHandleBuffer On a successful return, a buffer of MatchingHandleCount
2370 EFI_HANDLEs with a terminating NULL EFI_HANDLE.
2371 @param[out] HandleType An array of type information.
2373 @retval EFI_SUCCESS The operation was successful, and any related handles
2374 are in MatchingHandleBuffer.
2375 @retval EFI_NOT_FOUND No matching handles were found.
2376 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.
2380 ParseHandleDatabaseByRelationshipWithType (
2381 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL
,
2382 IN CONST EFI_HANDLE ControllerHandle OPTIONAL
,
2383 IN UINTN
*HandleCount
,
2384 OUT EFI_HANDLE
**HandleBuffer
,
2385 OUT UINTN
**HandleType
2390 EFI_GUID
**ProtocolGuidArray
;
2392 UINTN ProtocolIndex
;
2393 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
*OpenInfo
;
2394 UINTN OpenInfoCount
;
2395 UINTN OpenInfoIndex
;
2397 INTN DriverBindingHandleIndex
;
2399 ASSERT(HandleCount
!= NULL
);
2400 ASSERT(HandleBuffer
!= NULL
);
2401 ASSERT(HandleType
!= NULL
);
2402 ASSERT(DriverBindingHandle
!= NULL
|| ControllerHandle
!= NULL
);
2405 *HandleBuffer
= NULL
;
2409 // Retrieve the list of all handles from the handle database
2411 Status
= gBS
->LocateHandleBuffer (
2418 if (EFI_ERROR (Status
)) {
2422 *HandleType
= AllocateZeroPool (*HandleCount
* sizeof (UINTN
));
2423 if (*HandleType
== NULL
) {
2424 SHELL_FREE_NON_NULL (*HandleBuffer
);
2426 return EFI_OUT_OF_RESOURCES
;
2429 DriverBindingHandleIndex
= -1;
2430 for (HandleIndex
= 0; HandleIndex
< *HandleCount
; HandleIndex
++) {
2431 if (DriverBindingHandle
!= NULL
&& (*HandleBuffer
)[HandleIndex
] == DriverBindingHandle
) {
2432 DriverBindingHandleIndex
= (INTN
)HandleIndex
;
2436 for (HandleIndex
= 0; HandleIndex
< *HandleCount
; HandleIndex
++) {
2438 // Retrieve the list of all the protocols on each handle
2440 Status
= gBS
->ProtocolsPerHandle (
2441 (*HandleBuffer
)[HandleIndex
],
2445 if (EFI_ERROR (Status
)) {
2449 for (ProtocolIndex
= 0; ProtocolIndex
< ArrayCount
; ProtocolIndex
++) {
2452 // Set the bit describing what this handle has
2454 if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiLoadedImageProtocolGuid
) ) {
2455 (*HandleType
)[HandleIndex
] |= (UINTN
)HR_IMAGE_HANDLE
;
2456 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiDriverBindingProtocolGuid
) ) {
2457 (*HandleType
)[HandleIndex
] |= (UINTN
)HR_DRIVER_BINDING_HANDLE
;
2458 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiDriverConfiguration2ProtocolGuid
)) {
2459 (*HandleType
)[HandleIndex
] |= (UINTN
)HR_DRIVER_CONFIGURATION_HANDLE
;
2460 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiDriverConfigurationProtocolGuid
) ) {
2461 (*HandleType
)[HandleIndex
] |= (UINTN
)HR_DRIVER_CONFIGURATION_HANDLE
;
2462 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiDriverDiagnostics2ProtocolGuid
) ) {
2463 (*HandleType
)[HandleIndex
] |= (UINTN
)HR_DRIVER_DIAGNOSTICS_HANDLE
;
2464 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiDriverDiagnosticsProtocolGuid
) ) {
2465 (*HandleType
)[HandleIndex
] |= (UINTN
)HR_DRIVER_DIAGNOSTICS_HANDLE
;
2466 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiComponentName2ProtocolGuid
) ) {
2467 (*HandleType
)[HandleIndex
] |= (UINTN
)HR_COMPONENT_NAME_HANDLE
;
2468 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiComponentNameProtocolGuid
) ) {
2469 (*HandleType
)[HandleIndex
] |= (UINTN
)HR_COMPONENT_NAME_HANDLE
;
2470 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiDevicePathProtocolGuid
) ) {
2471 (*HandleType
)[HandleIndex
] |= (UINTN
)HR_DEVICE_HANDLE
;
2474 // Retrieve the list of agents that have opened each protocol
2476 Status
= gBS
->OpenProtocolInformation (
2477 (*HandleBuffer
)[HandleIndex
],
2478 ProtocolGuidArray
[ProtocolIndex
],
2482 if (EFI_ERROR (Status
)) {
2486 if (ControllerHandle
== NULL
) {
2488 // ControllerHandle == NULL and DriverBindingHandle != NULL.
2489 // Return information on all the controller handles that the driver specified by DriverBindingHandle is managing
2491 for (OpenInfoIndex
= 0; OpenInfoIndex
< OpenInfoCount
; OpenInfoIndex
++) {
2492 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== DriverBindingHandle
&& (OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_DRIVER
) != 0) {
2493 (*HandleType
)[HandleIndex
] |= (UINTN
)(HR_DEVICE_HANDLE
| HR_CONTROLLER_HANDLE
);
2494 if (DriverBindingHandleIndex
!= -1) {
2495 (*HandleType
)[DriverBindingHandleIndex
] |= (UINTN
)HR_DEVICE_DRIVER
;
2498 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== DriverBindingHandle
&& (OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) != 0) {
2499 (*HandleType
)[HandleIndex
] |= (UINTN
)(HR_DEVICE_HANDLE
| HR_CONTROLLER_HANDLE
);
2500 if (DriverBindingHandleIndex
!= -1) {
2501 (*HandleType
)[DriverBindingHandleIndex
] |= (UINTN
)(HR_BUS_DRIVER
| HR_DEVICE_DRIVER
);
2503 for (ChildIndex
= 0; ChildIndex
< *HandleCount
; ChildIndex
++) {
2504 if (OpenInfo
[OpenInfoIndex
].ControllerHandle
== (*HandleBuffer
)[ChildIndex
]) {
2505 (*HandleType
)[ChildIndex
] |= (UINTN
)(HR_DEVICE_HANDLE
| HR_CHILD_HANDLE
);
2511 if (DriverBindingHandle
== NULL
&& ControllerHandle
!= NULL
) {
2512 if (ControllerHandle
== (*HandleBuffer
)[HandleIndex
]) {
2513 (*HandleType
)[HandleIndex
] |= (UINTN
)(HR_DEVICE_HANDLE
| HR_CONTROLLER_HANDLE
);
2514 for (OpenInfoIndex
= 0; OpenInfoIndex
< OpenInfoCount
; OpenInfoIndex
++) {
2515 if ((OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_DRIVER
) != 0) {
2516 for (ChildIndex
= 0; ChildIndex
< *HandleCount
; ChildIndex
++) {
2517 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== (*HandleBuffer
)[ChildIndex
]) {
2518 (*HandleType
)[ChildIndex
] |= (UINTN
)HR_DEVICE_DRIVER
;
2522 if ((OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) != 0) {
2523 for (ChildIndex
= 0; ChildIndex
< *HandleCount
; ChildIndex
++) {
2524 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== (*HandleBuffer
)[ChildIndex
]) {
2525 (*HandleType
)[ChildIndex
] |= (UINTN
)(HR_BUS_DRIVER
| HR_DEVICE_DRIVER
);
2527 if (OpenInfo
[OpenInfoIndex
].ControllerHandle
== (*HandleBuffer
)[ChildIndex
]) {
2528 (*HandleType
)[ChildIndex
] |= (UINTN
)(HR_DEVICE_HANDLE
| HR_CHILD_HANDLE
);
2534 for (OpenInfoIndex
= 0; OpenInfoIndex
< OpenInfoCount
; OpenInfoIndex
++) {
2535 if ((OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) != 0) {
2536 if (OpenInfo
[OpenInfoIndex
].ControllerHandle
== ControllerHandle
) {
2537 (*HandleType
)[HandleIndex
] |= (UINTN
)(HR_DEVICE_HANDLE
| HR_PARENT_HANDLE
);
2543 if (DriverBindingHandle
!= NULL
&& ControllerHandle
!= NULL
) {
2544 if (ControllerHandle
== (*HandleBuffer
)[HandleIndex
]) {
2545 (*HandleType
)[HandleIndex
] |= (UINTN
)(HR_DEVICE_HANDLE
| HR_CONTROLLER_HANDLE
);
2546 for (OpenInfoIndex
= 0; OpenInfoIndex
< OpenInfoCount
; OpenInfoIndex
++) {
2547 if ((OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_DRIVER
) != 0) {
2548 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== DriverBindingHandle
) {
2549 if (DriverBindingHandleIndex
!= -1) {
2550 (*HandleType
)[DriverBindingHandleIndex
] |= (UINTN
)HR_DEVICE_DRIVER
;
2554 if ((OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) != 0) {
2555 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== DriverBindingHandle
) {
2556 for (ChildIndex
= 0; ChildIndex
< *HandleCount
; ChildIndex
++) {
2557 if (OpenInfo
[OpenInfoIndex
].ControllerHandle
== (*HandleBuffer
)[ChildIndex
]) {
2558 (*HandleType
)[ChildIndex
] |= (UINTN
)(HR_DEVICE_HANDLE
| HR_CHILD_HANDLE
);
2563 for (ChildIndex
= 0; ChildIndex
< *HandleCount
; ChildIndex
++) {
2564 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== (*HandleBuffer
)[ChildIndex
]) {
2565 (*HandleType
)[ChildIndex
] |= (UINTN
)(HR_BUS_DRIVER
| HR_DEVICE_DRIVER
);
2571 for (OpenInfoIndex
= 0; OpenInfoIndex
< OpenInfoCount
; OpenInfoIndex
++) {
2572 if ((OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) != 0) {
2573 if (OpenInfo
[OpenInfoIndex
].ControllerHandle
== ControllerHandle
) {
2574 (*HandleType
)[HandleIndex
] |= (UINTN
)(HR_DEVICE_HANDLE
| HR_PARENT_HANDLE
);
2580 FreePool (OpenInfo
);
2582 FreePool (ProtocolGuidArray
);
2588 Gets all the related EFI_HANDLEs based on the single EFI_HANDLE and the mask
2591 This function will scan all EFI_HANDLES in the UEFI environment's handle database
2592 and return all the ones with the specified relationship (Mask) to the specified
2595 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.
2596 If MatchingHandleCount is NULL, then ASSERT.
2598 If MatchingHandleBuffer is not NULL upon a sucessful return the memory must be
2601 @param[in] DriverBindingHandle Handle to a object with Driver Binding protocol
2603 @param[in] ControllerHandle Handle to a device with Device Path protocol on it.
2604 @param[in] Mask Mask of what relationship(s) is desired.
2605 @param[in] MatchingHandleCount Poitner to UINTN specifying number of HANDLES in
2606 MatchingHandleBuffer.
2607 @param[out] MatchingHandleBuffer On a sucessful return a buffer of MatchingHandleCount
2608 EFI_HANDLEs and a terminating NULL EFI_HANDLE.
2610 @retval EFI_SUCCESS The operation was sucessful and any related handles
2611 are in MatchingHandleBuffer;
2612 @retval EFI_NOT_FOUND No matching handles were found.
2613 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.
2617 ParseHandleDatabaseByRelationship (
2618 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL
,
2619 IN CONST EFI_HANDLE ControllerHandle OPTIONAL
,
2620 IN CONST UINTN Mask
,
2621 IN UINTN
*MatchingHandleCount
,
2622 OUT EFI_HANDLE
**MatchingHandleBuffer OPTIONAL
2627 EFI_HANDLE
*HandleBuffer
;
2631 ASSERT(MatchingHandleCount
!= NULL
);
2632 ASSERT(DriverBindingHandle
!= NULL
|| ControllerHandle
!= NULL
);
2634 if ((Mask
& HR_VALID_MASK
) != Mask
) {
2635 return (EFI_INVALID_PARAMETER
);
2638 if ((Mask
& HR_CHILD_HANDLE
) != 0 && DriverBindingHandle
== NULL
) {
2639 return (EFI_INVALID_PARAMETER
);
2642 *MatchingHandleCount
= 0;
2643 if (MatchingHandleBuffer
!= NULL
) {
2644 *MatchingHandleBuffer
= NULL
;
2647 HandleBuffer
= NULL
;
2650 Status
= ParseHandleDatabaseByRelationshipWithType (
2651 DriverBindingHandle
,
2657 if (!EFI_ERROR (Status
)) {
2659 // Count the number of handles that match the attributes in Mask
2661 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
2662 if ((HandleType
[HandleIndex
] & Mask
) == Mask
) {
2663 (*MatchingHandleCount
)++;
2667 // If no handles match the attributes in Mask then return EFI_NOT_FOUND
2669 if (*MatchingHandleCount
== 0) {
2670 Status
= EFI_NOT_FOUND
;
2673 if (MatchingHandleBuffer
== NULL
) {
2675 // Someone just wanted the count...
2677 Status
= EFI_SUCCESS
;
2680 // Allocate a handle buffer for the number of handles that matched the attributes in Mask
2682 *MatchingHandleBuffer
= AllocateZeroPool ((*MatchingHandleCount
+1)* sizeof (EFI_HANDLE
));
2683 if (*MatchingHandleBuffer
== NULL
) {
2684 Status
= EFI_OUT_OF_RESOURCES
;
2686 for (HandleIndex
= 0, *MatchingHandleCount
= 0
2687 ; HandleIndex
< HandleCount
2691 // Fill the allocated buffer with the handles that matched the attributes in Mask
2693 if ((HandleType
[HandleIndex
] & Mask
) == Mask
) {
2694 (*MatchingHandleBuffer
)[(*MatchingHandleCount
)++] = HandleBuffer
[HandleIndex
];
2699 // Make the last one NULL
2701 (*MatchingHandleBuffer
)[*MatchingHandleCount
] = NULL
;
2703 Status
= EFI_SUCCESS
;
2704 } // *MatchingHandleBuffer == NULL (ELSE)
2705 } // MacthingHandleBuffer == NULL (ELSE)
2706 } // *MatchingHandleCount == 0 (ELSE)
2707 } // no error on ParseHandleDatabaseByRelationshipWithType
2709 if (HandleBuffer
!= NULL
) {
2710 FreePool (HandleBuffer
);
2713 if (HandleType
!= NULL
) {
2714 FreePool (HandleType
);
2717 ASSERT ((MatchingHandleBuffer
== NULL
) ||
2718 (*MatchingHandleCount
== 0 && *MatchingHandleBuffer
== NULL
) ||
2719 (*MatchingHandleCount
!= 0 && *MatchingHandleBuffer
!= NULL
));
2724 Gets handles for any child controllers of the passed in controller.
2726 @param[in] ControllerHandle The handle of the "parent controller"
2727 @param[out] MatchingHandleCount Pointer to the number of handles in
2728 MatchingHandleBuffer on return.
2729 @param[out] MatchingHandleBuffer Buffer containing handles on a successful
2733 @retval EFI_SUCCESS The operation was sucessful.
2737 ParseHandleDatabaseForChildControllers(
2738 IN CONST EFI_HANDLE ControllerHandle
,
2739 OUT UINTN
*MatchingHandleCount
,
2740 OUT EFI_HANDLE
**MatchingHandleBuffer OPTIONAL
2745 UINTN DriverBindingHandleCount
;
2746 EFI_HANDLE
*DriverBindingHandleBuffer
;
2747 UINTN DriverBindingHandleIndex
;
2748 UINTN ChildControllerHandleCount
;
2749 EFI_HANDLE
*ChildControllerHandleBuffer
;
2750 UINTN ChildControllerHandleIndex
;
2751 EFI_HANDLE
*HandleBufferForReturn
;
2753 if (MatchingHandleCount
== NULL
) {
2754 return (EFI_INVALID_PARAMETER
);
2756 *MatchingHandleCount
= 0;
2758 Status
= PARSE_HANDLE_DATABASE_UEFI_DRIVERS (
2760 &DriverBindingHandleCount
,
2761 &DriverBindingHandleBuffer
2763 if (EFI_ERROR (Status
)) {
2768 // Get a buffer big enough for all the controllers.
2770 HandleBufferForReturn
= GetHandleListByProtocol(NULL
);
2771 if (HandleBufferForReturn
== NULL
) {
2772 FreePool (DriverBindingHandleBuffer
);
2773 return (EFI_NOT_FOUND
);
2776 for (DriverBindingHandleIndex
= 0; DriverBindingHandleIndex
< DriverBindingHandleCount
; DriverBindingHandleIndex
++) {
2777 Status
= PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (
2778 DriverBindingHandleBuffer
[DriverBindingHandleIndex
],
2780 &ChildControllerHandleCount
,
2781 &ChildControllerHandleBuffer
2783 if (EFI_ERROR (Status
)) {
2787 for (ChildControllerHandleIndex
= 0;
2788 ChildControllerHandleIndex
< ChildControllerHandleCount
;
2789 ChildControllerHandleIndex
++
2791 for (HandleIndex
= 0; HandleIndex
< *MatchingHandleCount
; HandleIndex
++) {
2792 if (HandleBufferForReturn
[HandleIndex
] == ChildControllerHandleBuffer
[ChildControllerHandleIndex
]) {
2796 if (HandleIndex
>= *MatchingHandleCount
) {
2797 HandleBufferForReturn
[(*MatchingHandleCount
)++] = ChildControllerHandleBuffer
[ChildControllerHandleIndex
];
2801 FreePool (ChildControllerHandleBuffer
);
2804 FreePool (DriverBindingHandleBuffer
);
2806 if (MatchingHandleBuffer
== NULL
|| *MatchingHandleCount
== 0) {
2808 // The caller is not interested in the actual handles, or we've found none.
2810 FreePool (HandleBufferForReturn
);
2811 HandleBufferForReturn
= NULL
;
2814 if (MatchingHandleBuffer
!= NULL
) {
2815 *MatchingHandleBuffer
= HandleBufferForReturn
;
2818 ASSERT ((MatchingHandleBuffer
== NULL
) ||
2819 (*MatchingHandleCount
== 0 && *MatchingHandleBuffer
== NULL
) ||
2820 (*MatchingHandleCount
!= 0 && *MatchingHandleBuffer
!= NULL
));
2822 return (EFI_SUCCESS
);
2826 Appends 1 buffer to another buffer. This will re-allocate the destination buffer
2827 if necessary to fit all of the data.
2829 If DestinationBuffer is NULL, then ASSERT().
2831 @param[in, out] DestinationBuffer The pointer to the pointer to the buffer to append onto.
2832 @param[in, out] DestinationSize The pointer to the size of DestinationBuffer.
2833 @param[in] SourceBuffer The pointer to the buffer to append onto DestinationBuffer.
2834 @param[in] SourceSize The number of bytes of SourceBuffer to append.
2836 @retval NULL A memory allocation failed.
2837 @retval NULL A parameter was invalid.
2838 @return A pointer to (*DestinationBuffer).
2842 IN OUT VOID
**DestinationBuffer
,
2843 IN OUT UINTN
*DestinationSize
,
2844 IN VOID
*SourceBuffer
,
2848 UINTN LocalDestinationSize
;
2849 UINTN LocalDestinationFinalSize
;
2851 ASSERT(DestinationBuffer
!= NULL
);
2853 if (SourceSize
== 0 || SourceBuffer
== NULL
) {
2854 return (*DestinationBuffer
);
2857 if (DestinationSize
== NULL
) {
2858 LocalDestinationSize
= 0;
2860 LocalDestinationSize
= *DestinationSize
;
2863 LocalDestinationFinalSize
= LocalDestinationSize
+ SourceSize
;
2865 if (DestinationSize
!= NULL
) {
2866 *DestinationSize
= LocalDestinationSize
;
2869 if (LocalDestinationSize
== 0) {
2871 *DestinationBuffer
= AllocateZeroPool(LocalDestinationFinalSize
);
2874 *DestinationBuffer
= ReallocatePool(LocalDestinationSize
, LocalDestinationFinalSize
, *DestinationBuffer
);
2877 ASSERT(*DestinationBuffer
!= NULL
);
2880 return (CopyMem(((UINT8
*)(*DestinationBuffer
)) + LocalDestinationSize
, SourceBuffer
, SourceSize
));
2884 Gets handles for any child devices produced by the passed in driver.
2886 @param[in] DriverHandle The handle of the driver.
2887 @param[in] MatchingHandleCount Pointer to the number of handles in
2888 MatchingHandleBuffer on return.
2889 @param[out] MatchingHandleBuffer Buffer containing handles on a successful
2891 @retval EFI_SUCCESS The operation was sucessful.
2892 @sa ParseHandleDatabaseByRelationship
2896 ParseHandleDatabaseForChildDevices(
2897 IN CONST EFI_HANDLE DriverHandle
,
2898 IN UINTN
*MatchingHandleCount
,
2899 OUT EFI_HANDLE
**MatchingHandleBuffer OPTIONAL
2903 EFI_HANDLE
*Buffer2
;
2908 UINTN HandleBufferSize
;
2910 ASSERT(MatchingHandleCount
!= NULL
);
2912 HandleBufferSize
= 0;
2915 *MatchingHandleCount
= 0;
2917 Status
= PARSE_HANDLE_DATABASE_DEVICES (
2922 if (!EFI_ERROR (Status
)) {
2923 for (HandleIndex
= 0; HandleIndex
< Count1
; HandleIndex
++) {
2925 // now find the children
2927 Status
= PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (
2929 Buffer
[HandleIndex
],
2933 if (EFI_ERROR(Status
)) {
2937 // save out required and optional data elements
2939 *MatchingHandleCount
+= Count2
;
2940 if (MatchingHandleBuffer
!= NULL
) {
2941 *MatchingHandleBuffer
= BuffernCatGrow((VOID
**)MatchingHandleBuffer
, &HandleBufferSize
, Buffer2
, Count2
* sizeof(Buffer2
[0]));
2947 if (Buffer2
!= NULL
) {
2953 if (Buffer
!= NULL
) {
2960 Function to get all handles that support a given protocol or all handles.
2962 @param[in] ProtocolGuid The guid of the protocol to get handles for. If NULL
2963 then the function will return all handles.
2965 @retval NULL A memory allocation failed.
2966 @return A NULL terminated list of handles.
2970 GetHandleListByProtocol (
2971 IN CONST EFI_GUID
*ProtocolGuid OPTIONAL
2974 EFI_HANDLE
*HandleList
;
2982 // We cannot use LocateHandleBuffer since we need that NULL item on the ends of the list!
2984 if (ProtocolGuid
== NULL
) {
2985 Status
= gBS
->LocateHandle(AllHandles
, NULL
, NULL
, &Size
, HandleList
);
2986 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2987 HandleList
= AllocateZeroPool(Size
+ sizeof(EFI_HANDLE
));
2988 if (HandleList
== NULL
) {
2991 Status
= gBS
->LocateHandle(AllHandles
, NULL
, NULL
, &Size
, HandleList
);
2992 HandleList
[Size
/sizeof(EFI_HANDLE
)] = NULL
;
2995 Status
= gBS
->LocateHandle(ByProtocol
, (EFI_GUID
*)ProtocolGuid
, NULL
, &Size
, HandleList
);
2996 if (Status
== EFI_BUFFER_TOO_SMALL
) {
2997 HandleList
= AllocateZeroPool(Size
+ sizeof(EFI_HANDLE
));
2998 if (HandleList
== NULL
) {
3001 Status
= gBS
->LocateHandle(ByProtocol
, (EFI_GUID
*)ProtocolGuid
, NULL
, &Size
, HandleList
);
3002 HandleList
[Size
/sizeof(EFI_HANDLE
)] = NULL
;
3005 if (EFI_ERROR(Status
)) {
3006 if (HandleList
!= NULL
) {
3007 FreePool(HandleList
);
3011 return (HandleList
);
3015 Function to get all handles that support some protocols.
3017 @param[in] ProtocolGuids A NULL terminated list of protocol GUIDs.
3019 @retval NULL A memory allocation failed.
3020 @retval NULL ProtocolGuids was NULL.
3021 @return A NULL terminated list of EFI_HANDLEs.
3025 GetHandleListByProtocolList (
3026 IN CONST EFI_GUID
**ProtocolGuids
3029 EFI_HANDLE
*HandleList
;
3034 CONST EFI_GUID
**GuidWalker
;
3035 EFI_HANDLE
*HandleWalker1
;
3036 EFI_HANDLE
*HandleWalker2
;
3040 TotalSize
= sizeof(EFI_HANDLE
);
3042 for (GuidWalker
= ProtocolGuids
; GuidWalker
!= NULL
&& *GuidWalker
!= NULL
; GuidWalker
++,Size
= 0){
3043 Status
= gBS
->LocateHandle(ByProtocol
, (EFI_GUID
*)(*GuidWalker
), NULL
, &Size
, NULL
);
3044 if (Status
== EFI_BUFFER_TOO_SMALL
) {
3050 // No handles were found...
3052 if (TotalSize
== sizeof(EFI_HANDLE
)) {
3056 HandleList
= AllocateZeroPool(TotalSize
);
3057 if (HandleList
== NULL
) {
3062 for (GuidWalker
= ProtocolGuids
; GuidWalker
!= NULL
&& *GuidWalker
!= NULL
; GuidWalker
++){
3063 TempSize
= TotalSize
- Size
;
3064 Status
= gBS
->LocateHandle(ByProtocol
, (EFI_GUID
*)(*GuidWalker
), NULL
, &TempSize
, HandleList
+(Size
/sizeof(EFI_HANDLE
)));
3067 // Allow for missing protocols... Only update the 'used' size upon success.
3069 if (!EFI_ERROR(Status
)) {
3073 ASSERT(HandleList
[(TotalSize
/sizeof(EFI_HANDLE
))-1] == NULL
);
3075 for (HandleWalker1
= HandleList
; HandleWalker1
!= NULL
&& *HandleWalker1
!= NULL
; HandleWalker1
++) {
3076 for (HandleWalker2
= HandleWalker1
+ 1; HandleWalker2
!= NULL
&& *HandleWalker2
!= NULL
; HandleWalker2
++) {
3077 if (*HandleWalker1
== *HandleWalker2
) {
3079 // copy memory back 1 handle width.
3081 CopyMem(HandleWalker2
, HandleWalker2
+ 1, TotalSize
- ((HandleWalker2
-HandleList
+1)*sizeof(EFI_HANDLE
)));
3086 return (HandleList
);
3090 Return all supported GUIDs.
3092 @param[out] Guids The buffer to return all supported GUIDs.
3093 @param[in, out] Count On input, the count of GUIDs the buffer can hold,
3094 On output, the count of GUIDs to return.
3096 @retval EFI_INVALID_PARAMETER Count is NULL.
3097 @retval EFI_BUFFER_TOO_SMALL Buffer is not enough to hold all GUIDs.
3098 @retval EFI_SUCCESS GUIDs are returned successfully.
3102 GetAllMappingGuids (
3103 OUT EFI_GUID
*Guids
,
3111 if (Count
== NULL
) {
3112 return EFI_INVALID_PARAMETER
;
3116 if (PcdGetBool (PcdShellIncludeNtGuids
)) {
3117 NtGuidCount
= ARRAY_SIZE (mGuidStringListNT
) - 1;
3119 GuidCount
= ARRAY_SIZE (mGuidStringList
) - 1;
3121 if (*Count
< NtGuidCount
+ GuidCount
+ mGuidListCount
) {
3122 *Count
= NtGuidCount
+ GuidCount
+ mGuidListCount
;
3123 return EFI_BUFFER_TOO_SMALL
;
3126 for (Index
= 0; Index
< NtGuidCount
; Index
++) {
3127 CopyGuid (&Guids
[Index
], mGuidStringListNT
[Index
].GuidId
);
3130 for (Index
= 0; Index
< GuidCount
; Index
++) {
3131 CopyGuid (&Guids
[NtGuidCount
+ Index
], mGuidStringList
[Index
].GuidId
);
3134 for (Index
= 0; Index
< mGuidListCount
; Index
++) {
3135 CopyGuid (&Guids
[NtGuidCount
+ GuidCount
+ Index
], mGuidList
[Index
].GuidId
);