2 Provides interface to advanced shell functionality for parsing both handle and protocol database.
4 Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "UefiHandleParsingLib.h"
16 #include "IndustryStandard/Acpi10.h"
18 EFI_HANDLE mHandleParsingHiiHandle
;
19 HANDLE_INDEX_LIST mHandleList
= {{{NULL
,NULL
},0,0},0};
22 Constructor for the library.
24 @param[in] ImageHandle Ignored.
25 @param[in] SystemTable Ignored.
27 @retval EFI_SUCCESS The operation was successful.
31 HandleParsingLibConstructor (
32 IN EFI_HANDLE ImageHandle
,
33 IN EFI_SYSTEM_TABLE
*SystemTable
36 mHandleParsingHiiHandle
= HiiAddPackages (&gHandleParsingHiiGuid
, gImageHandle
, UefiHandleParsingLibStrings
, NULL
);
37 if (mHandleParsingHiiHandle
== NULL
) {
38 return (EFI_DEVICE_ERROR
);
45 Destructor for the library. free any resources.
47 @param[in] ImageHandle Ignored.
48 @param[in] SystemTable Ignored.
50 @retval EFI_SUCCESS The operation was successful.
54 HandleParsingLibDestructor (
55 IN EFI_HANDLE ImageHandle
,
56 IN EFI_SYSTEM_TABLE
*SystemTable
59 if (mHandleParsingHiiHandle
!= NULL
) {
60 HiiRemovePackages(mHandleParsingHiiHandle
);
68 LoadedImageProtocolDumpInformation(
69 IN CONST EFI_HANDLE TheHandle,
70 IN CONST BOOLEAN Verbose
73 EFI_LOADED_IMAGE_PROTOCOL *Image;
75 EFI_DEVICE_PATH_PROTOCOL *DevPath;
76 EFI_DEVICE_PATH_PROTOCOL *DevPathNode;
79 UINT32 AuthenticationStatus;
81 EFI_FIRMWARE_VOLUME_PROTOCOL *FV;
82 EFI_FIRMWARE_VOLUME2_PROTOCOL *FV2;
89 Status = HandleProtocol (
91 &gEfiLoadedImageProtocolGuid,
93 ASSERT_EFI_ERROR(Status);
95 DevPath = UnpackDevicePath (Image->FilePath);
97 if (DevPath == NULL) {
101 DevPathNode = DevPath;
103 while (!IsDevicePathEnd (DevPathNode)) {
105 // Find the Fv File path
107 NameGuid = GetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *)DevPathNode);
108 if (NameGuid != NULL) {
109 Status = BS->HandleProtocol (
111 &gEfiFirmwareVolumeProtocolGuid,
114 if (!EFI_ERROR (Status)) {
115 Status = FV->ReadSection (
118 EFI_SECTION_USER_INTERFACE,
122 &AuthenticationStatus
124 if (!EFI_ERROR (Status)) {
130 Status = BS->HandleProtocol (
132 &gEfiFirmwareVolume2ProtocolGuid,
135 if (!EFI_ERROR (Status)) {
136 Status = FV2->ReadSection (
139 EFI_SECTION_USER_INTERFACE,
143 &AuthenticationStatus
145 if (!EFI_ERROR (Status)) {
154 // Next device path node
156 DevPathNode = NextDevicePathNode (DevPathNode);
165 Function to dump information about PciRootBridgeIo.
167 This will allocate the return buffer from boot services pool.
169 @param[in] TheHandle The handle that has PciRootBridgeIo installed.
170 @param[in] Verbose TRUE for additional information, FALSE otherwise.
172 @retval A poitner to a string containing the information.
176 PciRootBridgeIoDumpInformation(
177 IN CONST EFI_HANDLE TheHandle
,
178 IN CONST BOOLEAN Verbose
181 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL
*PciRootBridgeIo
;
182 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR
*Configuration
;
193 return (CatSPrint(NULL
, L
"PciRootBridgeIo"));
196 Status
= gBS
->HandleProtocol(
198 &gEfiPciRootBridgeIoProtocolGuid
,
199 (VOID
**)&PciRootBridgeIo
);
201 if (EFI_ERROR(Status
)) {
205 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_PH
), NULL
);
206 ASSERT (Temp
!= NULL
);
207 Temp2
= CatSPrint(L
"\r\n", Temp
, PciRootBridgeIo
->ParentHandle
);
212 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_SEG
), NULL
);
213 ASSERT (Temp
!= NULL
);
214 Temp2
= CatSPrint(RetVal
, Temp
, PciRootBridgeIo
->SegmentNumber
);
222 Status
= PciRootBridgeIo
->GetAttributes (PciRootBridgeIo
, &Supports
, &Attributes
);
223 if (!EFI_ERROR(Status
)) {
224 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_ATT
), NULL
);
225 ASSERT (Temp
!= NULL
);
226 Temp2
= CatSPrint(RetVal
, Temp
, Attributes
);
232 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_SUPPORTS
), NULL
);
233 ASSERT (Temp
!= NULL
);
234 Temp2
= CatSPrint(RetVal
, Temp
, Supports
);
241 Configuration
= NULL
;
242 Status
= PciRootBridgeIo
->Configuration (PciRootBridgeIo
, (VOID
**) &Configuration
);
243 if (!EFI_ERROR(Status
) && Configuration
!= NULL
) {
244 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_TITLE
), NULL
);
245 ASSERT (Temp
!= NULL
);
246 Temp2
= CatSPrint(RetVal
, Temp
, Supports
);
251 while (Configuration
->Desc
== ACPI_ADDRESS_SPACE_DESCRIPTOR
) {
253 switch (Configuration
->ResType
) {
254 case ACPI_ADDRESS_SPACE_TYPE_MEM
:
255 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_MEM
), NULL
);
257 case ACPI_ADDRESS_SPACE_TYPE_IO
:
258 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_IO
), NULL
);
260 case ACPI_ADDRESS_SPACE_TYPE_BUS
:
261 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_PCIRB_DUMP_BUS
), NULL
);
265 Temp2
= CatSPrint(RetVal
, L
"%s", Temp
);
272 Temp2
= CatSPrint(RetVal
,
273 L
"%H%02x %016lx %016lx %02x%N\r\n",
274 Configuration
->SpecificFlag
,
275 Configuration
->AddrRangeMin
,
276 Configuration
->AddrRangeMax
,
277 Configuration
->AddrSpaceGranularity
289 Function to dump information about SimpleTextOut.
291 This will allocate the return buffer from boot services pool.
293 @param[in] TheHandle The handle that has SimpleTextOut installed.
294 @param[in] Verbose TRUE for additional information, FALSE otherwise.
296 @retval A poitner to a string containing the information.
300 TxtOutProtocolDumpInformation(
301 IN CONST EFI_HANDLE TheHandle
,
302 IN CONST BOOLEAN Verbose
305 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*Dev
;
322 Status
= gBS
->HandleProtocol(
324 &gEfiSimpleTextOutProtocolGuid
,
327 ASSERT_EFI_ERROR(Status
);
328 ASSERT (Dev
!= NULL
&& Dev
->Mode
!= NULL
);
330 Size
= (Dev
->Mode
->MaxMode
+ 1) * 80;
331 RetVal
= AllocateZeroPool(Size
);
333 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_TXT_OUT_DUMP_HEADER
), NULL
);
335 UnicodeSPrint(RetVal
, Size
, Temp
, Dev
, Dev
->Mode
->Attribute
);
342 Temp
= HiiGetString(mHandleParsingHiiHandle
, STRING_TOKEN(STR_TXT_OUT_DUMP_LINE
), NULL
);
343 for (Index
= 0; Index
< Dev
->Mode
->MaxMode
; Index
++) {
344 Status
= Dev
->QueryMode (Dev
, Index
, &Col
, &Row
);
345 NewSize
= Size
- StrSize(RetVal
);
347 RetVal
+ StrLen(RetVal
),
349 Temp
== NULL
?L
"":Temp
,
350 Index
== Dev
->Mode
->Mode
? L
'*' : L
' ',
352 !EFI_ERROR(Status
)?(INTN
)Col
:-1,
353 !EFI_ERROR(Status
)?(INTN
)Row
:-1
360 STATIC CONST UINTN VersionStringSize
= 60;
363 Function to dump information about EfiDriverSupportedEfiVersion protocol.
365 This will allocate the return buffer from boot services pool.
367 @param[in] TheHandle The handle that has the protocol installed.
368 @param[in] Verbose TRUE for additional information, FALSE otherwise.
370 @retval A poitner to a string containing the information.
374 DriverEfiVersionProtocolDumpInformation(
375 IN CONST EFI_HANDLE TheHandle
,
376 IN CONST BOOLEAN Verbose
379 EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL
*DriverEfiVersion
;
383 Status
= gBS
->HandleProtocol(
385 &gEfiDriverSupportedEfiVersionProtocolGuid
,
386 (VOID
**)&DriverEfiVersion
);
388 ASSERT_EFI_ERROR(Status
);
390 RetVal
= AllocateZeroPool(VersionStringSize
);
391 ASSERT(RetVal
!= NULL
);
392 UnicodeSPrint(RetVal
, VersionStringSize
, L
"0x%08x", DriverEfiVersion
->FirmwareVersion
);
397 Function to dump information about DevicePath protocol.
399 This will allocate the return buffer from boot services pool.
401 @param[in] TheHandle The handle that has the protocol installed.
402 @param[in] Verbose TRUE for additional information, FALSE otherwise.
404 @retval A poitner to a string containing the information.
408 DevicePathProtocolDumpInformation(
409 IN CONST EFI_HANDLE TheHandle
,
410 IN CONST BOOLEAN Verbose
413 EFI_DEVICE_PATH_PROTOCOL
*DevPath
;
417 EFI_DEVICE_PATH_TO_TEXT_PROTOCOL
*DevPathToText
;
420 Status
= gBS
->LocateProtocol(&gEfiDevicePathToTextProtocolGuid
, NULL
, (VOID
**)&DevPathToText
);
421 if (!EFI_ERROR(Status
)) {
422 Status
= gBS
->OpenProtocol(TheHandle
, &gEfiDevicePathProtocolGuid
, (VOID
**)&DevPath
, gImageHandle
, NULL
, EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
423 if (!EFI_ERROR(Status
)) {
425 // I cannot decide whether to allow shortcuts here (the second BOOLEAN on the next line)
427 Temp
= DevPathToText
->ConvertDevicePathToText(DevPath
, TRUE
, TRUE
);
428 gBS
->CloseProtocol(TheHandle
, &gEfiDevicePathProtocolGuid
, gImageHandle
, NULL
);
431 if (!Verbose
&& Temp
!= NULL
&& StrLen(Temp
) > 30) {
433 Temp2
= StrnCatGrow(&Temp2
, NULL
, Temp
+(StrLen(Temp
) - 30), 30);
441 // Put the information on the NT32 protocol GUIDs here so we are not dependant on the Nt32Pkg
443 #define LOCAL_EFI_WIN_NT_THUNK_PROTOCOL_GUID \
445 0x58c518b1, 0x76f3, 0x11d4, { 0xbc, 0xea, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
448 #define LOCAL_EFI_WIN_NT_BUS_DRIVER_IO_PROTOCOL_GUID \
450 0x96eb4ad6, 0xa32a, 0x11d4, { 0xbc, 0xfd, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
453 #define LOCAL_EFI_WIN_NT_SERIAL_PORT_GUID \
455 0xc95a93d, 0xa006, 0x11d4, { 0xbc, 0xfa, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
457 STATIC CONST EFI_GUID WinNtThunkProtocolGuid
= LOCAL_EFI_WIN_NT_THUNK_PROTOCOL_GUID
;
458 STATIC CONST EFI_GUID WinNtIoProtocolGuid
= LOCAL_EFI_WIN_NT_BUS_DRIVER_IO_PROTOCOL_GUID
;
459 STATIC CONST EFI_GUID WinNtSerialPortGuid
= LOCAL_EFI_WIN_NT_SERIAL_PORT_GUID
;
461 STATIC CONST GUID_INFO_BLOCK mGuidStringListNT
[] = {
462 {STRING_TOKEN(STR_WINNT_THUNK
), (EFI_GUID
*)&WinNtThunkProtocolGuid
, NULL
},
463 {STRING_TOKEN(STR_WINNT_DRIVER_IO
), (EFI_GUID
*)&WinNtIoProtocolGuid
, NULL
},
464 {STRING_TOKEN(STR_WINNT_SERIAL_PORT
), (EFI_GUID
*)&WinNtSerialPortGuid
, NULL
},
465 {STRING_TOKEN(STR_UNKNOWN_DEVICE
), NULL
, NULL
},
468 STATIC CONST GUID_INFO_BLOCK mGuidStringList
[] = {
469 {STRING_TOKEN(STR_LOADED_IMAGE
), &gEfiLoadedImageProtocolGuid
, NULL
},
470 {STRING_TOKEN(STR_DEVICE_PATH
), &gEfiDevicePathProtocolGuid
, DevicePathProtocolDumpInformation
},
471 {STRING_TOKEN(STR_IMAGE_PATH
), &gEfiLoadedImageDevicePathProtocolGuid
, DevicePathProtocolDumpInformation
},
472 {STRING_TOKEN(STR_DEVICE_PATH_UTIL
), &gEfiDevicePathUtilitiesProtocolGuid
, NULL
},
473 {STRING_TOKEN(STR_DEVICE_PATH_TXT
), &gEfiDevicePathToTextProtocolGuid
, NULL
},
474 {STRING_TOKEN(STR_DEVICE_PATH_FTXT
), &gEfiDevicePathFromTextProtocolGuid
, NULL
},
475 {STRING_TOKEN(STR_DEVICE_PATH_PC
), &gEfiPcAnsiGuid
, NULL
},
476 {STRING_TOKEN(STR_DEVICE_PATH_VT100
), &gEfiVT100Guid
, NULL
},
477 {STRING_TOKEN(STR_DEVICE_PATH_VT100P
), &gEfiVT100PlusGuid
, NULL
},
478 {STRING_TOKEN(STR_DEVICE_PATH_VTUTF8
), &gEfiVTUTF8Guid
, NULL
},
479 {STRING_TOKEN(STR_DRIVER_BINDING
), &gEfiDriverBindingProtocolGuid
, NULL
},
480 {STRING_TOKEN(STR_PLATFORM_OVERRIDE
), &gEfiPlatformDriverOverrideProtocolGuid
, NULL
},
481 {STRING_TOKEN(STR_BUS_OVERRIDE
), &gEfiBusSpecificDriverOverrideProtocolGuid
, NULL
},
482 {STRING_TOKEN(STR_DRIVER_DIAG
), &gEfiDriverDiagnosticsProtocolGuid
, NULL
},
483 {STRING_TOKEN(STR_DRIVER_DIAG2
), &gEfiDriverDiagnostics2ProtocolGuid
, NULL
},
484 {STRING_TOKEN(STR_DRIVER_CN
), &gEfiComponentNameProtocolGuid
, NULL
},
485 {STRING_TOKEN(STR_DRIVER_CN2
), &gEfiComponentName2ProtocolGuid
, NULL
},
486 {STRING_TOKEN(STR_PLAT_DRV_CFG
), &gEfiPlatformToDriverConfigurationProtocolGuid
, NULL
},
487 {STRING_TOKEN(STR_DRIVER_VERSION
), &gEfiDriverSupportedEfiVersionProtocolGuid
, DriverEfiVersionProtocolDumpInformation
},
488 {STRING_TOKEN(STR_TXT_IN
), &gEfiSimpleTextInProtocolGuid
, NULL
},
489 {STRING_TOKEN(STR_TXT_IN_EX
), &gEfiSimpleTextInputExProtocolGuid
, NULL
},
490 {STRING_TOKEN(STR_TXT_OUT
), &gEfiSimpleTextOutProtocolGuid
, TxtOutProtocolDumpInformation
},
491 {STRING_TOKEN(STR_SIM_POINTER
), &gEfiSimplePointerProtocolGuid
, NULL
},
492 {STRING_TOKEN(STR_ABS_POINTER
), &gEfiAbsolutePointerProtocolGuid
, NULL
},
493 {STRING_TOKEN(STR_SERIAL_IO
), &gEfiSerialIoProtocolGuid
, NULL
},
494 {STRING_TOKEN(STR_GRAPHICS_OUTPUT
), &gEfiGraphicsOutputProtocolGuid
, NULL
},
495 {STRING_TOKEN(STR_EDID_DISCOVERED
), &gEfiEdidDiscoveredProtocolGuid
, NULL
},
496 {STRING_TOKEN(STR_EDID_ACTIVE
), &gEfiEdidActiveProtocolGuid
, NULL
},
497 {STRING_TOKEN(STR_EDID_OVERRIDE
), &gEfiEdidOverrideProtocolGuid
, NULL
},
498 {STRING_TOKEN(STR_CON_IN
), &gEfiConsoleInDeviceGuid
, NULL
},
499 {STRING_TOKEN(STR_CON_OUT
), &gEfiConsoleOutDeviceGuid
, NULL
},
500 {STRING_TOKEN(STR_STD_ERR
), &gEfiStandardErrorDeviceGuid
, NULL
},
501 {STRING_TOKEN(STR_LOAD_FILE
), &gEfiLoadFileProtocolGuid
, NULL
},
502 {STRING_TOKEN(STR_LOAD_FILE2
), &gEfiLoadFile2ProtocolGuid
, NULL
},
503 {STRING_TOKEN(STR_SIMPLE_FILE_SYS
), &gEfiSimpleFileSystemProtocolGuid
, NULL
},
504 {STRING_TOKEN(STR_TAPE_IO
), &gEfiTapeIoProtocolGuid
, NULL
},
505 {STRING_TOKEN(STR_DISK_IO
), &gEfiDiskIoProtocolGuid
, NULL
},
506 {STRING_TOKEN(STR_BLK_IO
), &gEfiBlockIoProtocolGuid
, NULL
},
507 {STRING_TOKEN(STR_UC
), &gEfiUnicodeCollationProtocolGuid
, NULL
},
508 {STRING_TOKEN(STR_UC2
), &gEfiUnicodeCollation2ProtocolGuid
, NULL
},
509 {STRING_TOKEN(STR_PCIRB_IO
), &gEfiPciRootBridgeIoProtocolGuid
, PciRootBridgeIoDumpInformation
},
510 {STRING_TOKEN(STR_PCI_IO
), &gEfiPciIoProtocolGuid
, NULL
},
511 {STRING_TOKEN(STR_SCSI_PT
), &gEfiScsiPassThruProtocolGuid
, NULL
},
512 {STRING_TOKEN(STR_SCSI_IO
), &gEfiScsiIoProtocolGuid
, NULL
},
513 {STRING_TOKEN(STR_SCSI_PT_EXT
), &gEfiExtScsiPassThruProtocolGuid
, NULL
},
514 {STRING_TOKEN(STR_ISCSI
), &gEfiIScsiInitiatorNameProtocolGuid
, NULL
},
515 {STRING_TOKEN(STR_USB_IO
), &gEfiUsbIoProtocolGuid
, NULL
},
516 {STRING_TOKEN(STR_USB_HC
), &gEfiUsbHcProtocolGuid
, NULL
},
517 {STRING_TOKEN(STR_USB_HC2
), &gEfiUsb2HcProtocolGuid
, NULL
},
518 {STRING_TOKEN(STR_DEBUG_SUPPORT
), &gEfiDebugSupportProtocolGuid
, NULL
},
519 {STRING_TOKEN(STR_DEBUG_PORT
), &gEfiDebugPortProtocolGuid
, NULL
},
520 {STRING_TOKEN(STR_DECOMPRESS
), &gEfiDecompressProtocolGuid
, NULL
},
521 {STRING_TOKEN(STR_ACPI_TABLE
), &gEfiAcpiTableProtocolGuid
, NULL
},
522 {STRING_TOKEN(STR_EBC_INTERPRETER
), &gEfiEbcProtocolGuid
, NULL
},
523 {STRING_TOKEN(STR_SNP
), &gEfiSimpleNetworkProtocolGuid
, NULL
},
524 {STRING_TOKEN(STR_NII
), &gEfiNetworkInterfaceIdentifierProtocolGuid
, NULL
},
525 {STRING_TOKEN(STR_NII_31
), &gEfiNetworkInterfaceIdentifierProtocolGuid_31
, NULL
},
526 {STRING_TOKEN(STR_PXE_BC
), &gEfiPxeBaseCodeProtocolGuid
, NULL
},
527 {STRING_TOKEN(STR_PXE_CB
), &gEfiPxeBaseCodeCallbackProtocolGuid
, NULL
},
528 {STRING_TOKEN(STR_BIS
), &gEfiBisProtocolGuid
, NULL
},
529 {STRING_TOKEN(STR_MNP_SB
), &gEfiManagedNetworkServiceBindingProtocolGuid
, NULL
},
530 {STRING_TOKEN(STR_MNP
), &gEfiManagedNetworkProtocolGuid
, NULL
},
531 {STRING_TOKEN(STR_ARP_SB
), &gEfiArpServiceBindingProtocolGuid
, NULL
},
532 {STRING_TOKEN(STR_ARP
), &gEfiArpProtocolGuid
, NULL
},
533 {STRING_TOKEN(STR_DHCPV4_SB
), &gEfiDhcp4ServiceBindingProtocolGuid
, NULL
},
534 {STRING_TOKEN(STR_DHCPV4
), &gEfiDhcp4ProtocolGuid
, NULL
},
535 {STRING_TOKEN(STR_TCPV4_SB
), &gEfiTcp4ServiceBindingProtocolGuid
, NULL
},
536 {STRING_TOKEN(STR_TCPV4
), &gEfiTcp4ProtocolGuid
, NULL
},
537 {STRING_TOKEN(STR_IPV4_SB
), &gEfiIp4ServiceBindingProtocolGuid
, NULL
},
538 {STRING_TOKEN(STR_IPV4
), &gEfiIp4ProtocolGuid
, NULL
},
539 {STRING_TOKEN(STR_IPV4_CFG
), &gEfiIp4ConfigProtocolGuid
, NULL
},
540 {STRING_TOKEN(STR_SHELL_PARAMETERS
), &gEfiShellParametersProtocolGuid
, NULL
},
541 {STRING_TOKEN(STR_SHELL
), &gEfiShellProtocolGuid
, NULL
},
542 {STRING_TOKEN(STR_UDPV4_SB
), &gEfiUdp4ServiceBindingProtocolGuid
, NULL
},
543 {STRING_TOKEN(STR_UDPV4
), &gEfiUdp4ProtocolGuid
, NULL
},
544 {STRING_TOKEN(STR_MTFTPV4_SB
), &gEfiMtftp4ServiceBindingProtocolGuid
, NULL
},
545 {STRING_TOKEN(STR_MTFTPV4
), &gEfiMtftp4ProtocolGuid
, NULL
},
546 {STRING_TOKEN(STR_AUTH_INFO
), &gEfiAuthenticationInfoProtocolGuid
, NULL
},
547 {STRING_TOKEN(STR_HASH_SB
), &gEfiHashServiceBindingProtocolGuid
, NULL
},
548 {STRING_TOKEN(STR_HASH
), &gEfiHashProtocolGuid
, NULL
},
549 {STRING_TOKEN(STR_HII_FONT
), &gEfiHiiFontProtocolGuid
, NULL
},
550 {STRING_TOKEN(STR_HII_STRING
), &gEfiHiiStringProtocolGuid
, NULL
},
551 {STRING_TOKEN(STR_HII_IMAGE
), &gEfiHiiImageProtocolGuid
, NULL
},
552 {STRING_TOKEN(STR_HII_DATABASE
), &gEfiHiiDatabaseProtocolGuid
, NULL
},
553 {STRING_TOKEN(STR_HII_CONFIG_ROUT
), &gEfiHiiConfigRoutingProtocolGuid
, NULL
},
554 {STRING_TOKEN(STR_HII_CONFIG_ACC
), &gEfiHiiConfigAccessProtocolGuid
, NULL
},
555 {STRING_TOKEN(STR_HII_FORM_BROWSER2
), &gEfiFormBrowser2ProtocolGuid
, NULL
},
556 {STRING_TOKEN(STR_DRIVER_FAM_OVERRIDE
), &gEfiDriverFamilyOverrideProtocolGuid
, NULL
},
557 {STRING_TOKEN(STR_PCD
), &gPcdProtocolGuid
, NULL
},
558 {STRING_TOKEN(STR_TCG
), &gEfiTcgProtocolGuid
, NULL
},
559 {STRING_TOKEN(STR_HII_PACKAGE_LIST
), &gEfiHiiPackageListProtocolGuid
, NULL
},
562 // the ones under this are deprecated by the current UEFI Spec, but may be found anyways...
564 {STRING_TOKEN(STR_SHELL_INTERFACE
), &gEfiShellInterfaceGuid
, NULL
},
565 {STRING_TOKEN(STR_SHELL_ENV2
), &gEfiShellEnvironment2Guid
, NULL
},
566 {STRING_TOKEN(STR_SHELL_ENV
), &gEfiShellEnvironment2Guid
, NULL
},
567 {STRING_TOKEN(STR_DEVICE_IO
), &gEfiDeviceIoProtocolGuid
, NULL
},
568 {STRING_TOKEN(STR_UGA_DRAW
), &gEfiUgaDrawProtocolGuid
, NULL
},
569 {STRING_TOKEN(STR_UGA_IO
), &gEfiUgaIoProtocolGuid
, NULL
},
570 {STRING_TOKEN(STR_ESP
), &gEfiPartTypeSystemPartGuid
, NULL
},
571 {STRING_TOKEN(STR_GPT_NBR
), &gEfiPartTypeLegacyMbrGuid
, NULL
},
572 {STRING_TOKEN(STR_DRIVER_CONFIG
), &gEfiDriverConfigurationProtocolGuid
, NULL
},
573 {STRING_TOKEN(STR_DRIVER_CONFIG2
), &gEfiDriverConfiguration2ProtocolGuid
, NULL
},
576 // the ones under this are GUID identified structs, not protocols
578 {STRING_TOKEN(STR_FILE_INFO
), &gEfiFileInfoGuid
, NULL
},
579 {STRING_TOKEN(STR_FILE_SYS_INFO
), &gEfiFileSystemInfoGuid
, NULL
},
582 // the ones under this are misc GUIDS.
584 {STRING_TOKEN(STR_EFI_GLOBAL_VARIABLE
), &gEfiGlobalVariableGuid
, NULL
},
589 {STRING_TOKEN(STR_IP6_SB
), &gEfiIp6ServiceBindingProtocolGuid
, NULL
},
590 {STRING_TOKEN(STR_IP6
), &gEfiIp6ProtocolGuid
, NULL
},
591 {STRING_TOKEN(STR_IP6_CONFIG
), &gEfiIp6ConfigProtocolGuid
, NULL
},
592 {STRING_TOKEN(STR_MTFTP6_SB
), &gEfiMtftp6ServiceBindingProtocolGuid
, NULL
},
593 {STRING_TOKEN(STR_MTFTP6
), &gEfiMtftp6ProtocolGuid
, NULL
},
594 {STRING_TOKEN(STR_DHCP6_SB
), &gEfiDhcp6ServiceBindingProtocolGuid
, NULL
},
595 {STRING_TOKEN(STR_DHCP6
), &gEfiDhcp6ProtocolGuid
, NULL
},
596 {STRING_TOKEN(STR_UDP6_SB
), &gEfiUdp6ServiceBindingProtocolGuid
, NULL
},
597 {STRING_TOKEN(STR_UDP6
), &gEfiUdp6ProtocolGuid
, NULL
},
598 {STRING_TOKEN(STR_TCP6_SB
), &gEfiTcp6ServiceBindingProtocolGuid
, NULL
},
599 {STRING_TOKEN(STR_TCP6
), &gEfiTcp6ProtocolGuid
, NULL
},
600 {STRING_TOKEN(STR_VLAN_CONFIG
), &gEfiVlanConfigProtocolGuid
, NULL
},
601 {STRING_TOKEN(STR_EAP
), &gEfiEapProtocolGuid
, NULL
},
602 {STRING_TOKEN(STR_EAP_MGMT
), &gEfiEapManagementProtocolGuid
, NULL
},
603 {STRING_TOKEN(STR_FTP4_SB
), &gEfiFtp4ServiceBindingProtocolGuid
, NULL
},
604 {STRING_TOKEN(STR_FTP4
), &gEfiFtp4ProtocolGuid
, NULL
},
605 {STRING_TOKEN(STR_IP_SEC_CONFIG
), &gEfiIpSecConfigProtocolGuid
, NULL
},
606 {STRING_TOKEN(STR_DH
), &gEfiDriverHealthProtocolGuid
, NULL
},
607 {STRING_TOKEN(STR_DEF_IMG_LOAD
), &gEfiDeferredImageLoadProtocolGuid
, NULL
},
608 {STRING_TOKEN(STR_USER_CRED
), &gEfiUserCredentialProtocolGuid
, NULL
},
609 {STRING_TOKEN(STR_USER_MNGR
), &gEfiUserManagerProtocolGuid
, NULL
},
610 {STRING_TOKEN(STR_ATA_PASS_THRU
), &gEfiAtaPassThruProtocolGuid
, NULL
},
615 {STRING_TOKEN(STR_FW_MGMT
), &gEfiFirmwareManagementProtocolGuid
, NULL
},
616 {STRING_TOKEN(STR_IP_SEC
), &gEfiIpSecProtocolGuid
, NULL
},
617 {STRING_TOKEN(STR_IP_SEC2
), &gEfiIpSec2ProtocolGuid
, NULL
},
622 {STRING_TOKEN(STR_KMS
), &gEfiKmsProtocolGuid
, NULL
},
623 {STRING_TOKEN(STR_BLK_IO2
), &gEfiBlockIo2ProtocolGuid
, NULL
},
624 {STRING_TOKEN(STR_SSC
), &gEfiStorageSecurityCommandProtocolGuid
, NULL
},
625 {STRING_TOKEN(STR_UC2
), &gEfiUserCredential2ProtocolGuid
, NULL
},
630 {STRING_TOKEN(STR_UNKNOWN_DEVICE
), NULL
, NULL
},
634 Function to get the node for a protocol or struct from it's GUID.
636 if Guid is NULL, then ASSERT.
638 @param[in] Guid The GUID to look for the name of.
642 CONST GUID_INFO_BLOCK
*
644 InternalShellGetNodeFromGuid(
645 IN CONST EFI_GUID
* Guid
648 CONST GUID_INFO_BLOCK
*ListWalker
;
650 ASSERT(Guid
!= NULL
);
652 if (PcdGetBool(PcdShellIncludeNtGuids
)) {
653 for (ListWalker
= mGuidStringListNT
; ListWalker
!= NULL
&& ListWalker
->GuidId
!= NULL
; ListWalker
++) {
654 if (CompareGuid(ListWalker
->GuidId
, Guid
)) {
659 for (ListWalker
= mGuidStringList
; ListWalker
!= NULL
&& ListWalker
->GuidId
!= NULL
; ListWalker
++) {
660 if (CompareGuid(ListWalker
->GuidId
, Guid
)) {
668 Function to get the name of a protocol or struct from it's GUID.
670 if Guid is NULL, then ASSERT.
672 @param[in] Guid The GUID to look for the name of.
673 @param[in] Lang The language to use.
675 @return pointer to string of the name. The caller
676 is responsible to free this memory.
680 GetStringNameFromGuid(
681 IN CONST EFI_GUID
*Guid
,
682 IN CONST CHAR8
*Lang OPTIONAL
685 CONST GUID_INFO_BLOCK
*Id
;
687 Id
= InternalShellGetNodeFromGuid(Guid
);
688 return (HiiGetString(mHandleParsingHiiHandle
, Id
->StringId
, Lang
));
692 Function to dump protocol information from a handle.
694 This function will return a allocated string buffer containing the
695 information. The caller is responsible for freeing the memory.
697 If Guid is NULL, ASSERT().
698 If TheHandle is NULL, ASSERT().
700 @param[in] TheHandle The handle to dump information from.
701 @param[in] Guid The GUID of the protocol to dump.
702 @param[in] Verbose TRUE for extra info. FALSE otherwise.
704 @return The pointer to string.
705 @retval NULL An error was encountered.
709 GetProtocolInformationDump(
710 IN CONST EFI_HANDLE TheHandle
,
711 IN CONST EFI_GUID
*Guid
,
712 IN CONST BOOLEAN Verbose
715 CONST GUID_INFO_BLOCK
*Id
;
717 ASSERT(TheHandle
!= NULL
);
718 ASSERT(Guid
!= NULL
);
720 if (TheHandle
== NULL
|| Guid
== NULL
) {
724 Id
= InternalShellGetNodeFromGuid(Guid
);
725 if (Id
!= NULL
&& Id
->DumpInfo
!= NULL
) {
726 return (Id
->DumpInfo(TheHandle
, Verbose
));
732 Function to get the Guid for a protocol or struct based on it's string name.
734 @param[in] Name The pointer to the string name.
735 @param[in] Lang The pointer to the language code.
736 @param[in] Guid The pointer to the Guid.
738 @retval EFI_SUCCESS The operation was sucessful.
742 GetGuidFromStringName(
743 IN CONST CHAR16
*Name
,
744 IN CONST CHAR8
*Lang OPTIONAL
,
748 CONST GUID_INFO_BLOCK
*ListWalker
;
751 ASSERT(Guid
!= NULL
);
753 return (EFI_INVALID_PARAMETER
);
757 if (PcdGetBool(PcdShellIncludeNtGuids
)) {
758 for (ListWalker
= mGuidStringListNT
; ListWalker
!= NULL
&& ListWalker
->GuidId
!= NULL
; ListWalker
++) {
759 String
= HiiGetString(mHandleParsingHiiHandle
, ListWalker
->StringId
, Lang
);
760 if (Name
!= NULL
&& String
!= NULL
&& StrCmp(Name
, String
)==0) {
761 *Guid
= ListWalker
->GuidId
;
763 SHELL_FREE_NON_NULL(String
);
765 return (EFI_SUCCESS
);
769 for (ListWalker
= mGuidStringList
; ListWalker
!= NULL
&& ListWalker
->GuidId
!= NULL
; ListWalker
++) {
770 String
= HiiGetString(mHandleParsingHiiHandle
, ListWalker
->StringId
, Lang
);
771 if (Name
!= NULL
&& String
!= NULL
&& StrCmp(Name
, String
)==0) {
772 *Guid
= ListWalker
->GuidId
;
774 SHELL_FREE_NON_NULL(String
);
776 return (EFI_SUCCESS
);
779 return (EFI_NOT_FOUND
);
783 Get best support language for this driver.
785 First base on the current platform used language to search,Second base on the
786 default language to search. The caller need to free the buffer of the best
789 @param[in] SupportedLanguages The support languages for this driver.
790 @param[in] Iso639Language Whether get language for ISO639.
792 @return The best support language for this driver.
795 GetBestLanguageForDriver (
796 IN CONST CHAR8
*SupportedLanguages
,
797 IN BOOLEAN Iso639Language
800 CHAR8
*LanguageVariable
;
803 LanguageVariable
= GetVariable (Iso639Language
? L
"Lang" : L
"PlatformLang", &gEfiGlobalVariableGuid
);
805 BestLanguage
= GetBestLanguage(
808 (LanguageVariable
!= NULL
) ? LanguageVariable
: "",
809 Iso639Language
? "en" : "en-US",
813 if (LanguageVariable
!= NULL
) {
814 FreePool (LanguageVariable
);
821 Function to retrieve the driver name (if possible) from the ComponentName or
822 ComponentName2 protocol
824 @param[in] TheHandle The driver handle to get the name of.
825 @param[in] Language The language to use.
827 @retval NULL The name could not be found.
828 @return A pointer to the string name. Do not de-allocate the memory.
832 GetStringNameFromHandle(
833 IN CONST EFI_HANDLE TheHandle
,
834 IN CONST CHAR8
*Language
837 EFI_COMPONENT_NAME2_PROTOCOL
*CompNameStruct
;
844 Status
= gBS
->OpenProtocol(
846 &gEfiComponentName2ProtocolGuid
,
847 (VOID
**)&CompNameStruct
,
850 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
851 if (!EFI_ERROR(Status
)) {
852 if (Language
== NULL
) {
853 BestLang
= GetBestLanguageForDriver (CompNameStruct
->SupportedLanguages
, FALSE
);
856 Status
= CompNameStruct
->GetDriverName(CompNameStruct
, (CHAR8
*)Language
, &RetVal
);
858 if (BestLang
!= NULL
) {
862 if (!EFI_ERROR(Status
)) {
866 Status
= gBS
->OpenProtocol(
868 &gEfiComponentNameProtocolGuid
,
869 (VOID
**)&CompNameStruct
,
872 EFI_OPEN_PROTOCOL_GET_PROTOCOL
);
873 if (!EFI_ERROR(Status
)) {
874 if (Language
== NULL
) {
875 BestLang
= GetBestLanguageForDriver (CompNameStruct
->SupportedLanguages
, FALSE
);
878 Status
= CompNameStruct
->GetDriverName(CompNameStruct
, (CHAR8
*)Language
, &RetVal
);
880 if (BestLang
!= NULL
) {
883 if (!EFI_ERROR(Status
)) {
891 Function to initialize the file global mHandleList object for use in
892 vonverting handles to index and index to handle.
894 @retval EFI_SUCCESS The operation was successful.
898 InternalShellInitHandleList(
903 EFI_HANDLE
*HandleBuffer
;
905 HANDLE_LIST
*ListWalker
;
907 if (mHandleList
.NextIndex
!= 0) {
910 InitializeListHead(&mHandleList
.List
.Link
);
911 mHandleList
.NextIndex
= 1;
912 Status
= gBS
->LocateHandleBuffer (
919 ASSERT_EFI_ERROR(Status
);
920 if (EFI_ERROR(Status
)) {
923 for (mHandleList
.NextIndex
= 1 ; mHandleList
.NextIndex
<= HandleCount
; mHandleList
.NextIndex
++){
924 ListWalker
= AllocateZeroPool(sizeof(HANDLE_LIST
));
925 ASSERT(ListWalker
!= NULL
);
926 ListWalker
->TheHandle
= HandleBuffer
[mHandleList
.NextIndex
-1];
927 ListWalker
->TheIndex
= mHandleList
.NextIndex
;
928 InsertTailList(&mHandleList
.List
.Link
,&ListWalker
->Link
);
930 FreePool(HandleBuffer
);
931 return (EFI_SUCCESS
);
935 Function to retrieve the human-friendly index of a given handle. If the handle
936 does not have a index one will be automatically assigned. The index value is valid
937 until the termination of the shell application.
939 @param[in] TheHandle The handle to retrieve an index for.
941 @retval 0 A memory allocation failed.
942 @return The index of the handle.
947 ConvertHandleToHandleIndex(
948 IN CONST EFI_HANDLE TheHandle
952 EFI_GUID
**ProtocolBuffer
;
954 HANDLE_LIST
*ListWalker
;
956 if (TheHandle
== NULL
) {
960 InternalShellInitHandleList();
962 for (ListWalker
= (HANDLE_LIST
*)GetFirstNode(&mHandleList
.List
.Link
)
963 ; !IsNull(&mHandleList
.List
.Link
,&ListWalker
->Link
)
964 ; ListWalker
= (HANDLE_LIST
*)GetNextNode(&mHandleList
.List
.Link
,&ListWalker
->Link
)
966 if (ListWalker
->TheHandle
== TheHandle
) {
968 // Verify that TheHandle is still present in the Handle Database
970 Status
= gBS
->ProtocolsPerHandle(TheHandle
, &ProtocolBuffer
, &ProtocolCount
);
971 if (EFI_ERROR (Status
)) {
973 // TheHandle is not present in the Handle Database, so delete from the handle list
975 RemoveEntryList (&ListWalker
->Link
);
978 FreePool (ProtocolBuffer
);
979 return (ListWalker
->TheIndex
);
984 // Verify that TheHandle is valid handle
986 Status
= gBS
->ProtocolsPerHandle(TheHandle
, &ProtocolBuffer
, &ProtocolCount
);
987 if (EFI_ERROR (Status
)) {
989 // TheHandle is not valid, so do not add to handle list
993 FreePool (ProtocolBuffer
);
995 ListWalker
= AllocateZeroPool(sizeof(HANDLE_LIST
));
996 ASSERT(ListWalker
!= NULL
);
997 ListWalker
->TheHandle
= TheHandle
;
998 ListWalker
->TheIndex
= mHandleList
.NextIndex
++;
999 InsertTailList(&mHandleList
.List
.Link
,&ListWalker
->Link
);
1000 return (ListWalker
->TheIndex
);
1006 Function to retrieve the EFI_HANDLE from the human-friendly index.
1008 @param[in] TheIndex The index to retrieve the EFI_HANDLE for.
1010 @retval NULL The index was invalid.
1011 @return The EFI_HANDLE that index represents.
1016 ConvertHandleIndexToHandle(
1017 IN CONST UINTN TheIndex
1021 EFI_GUID
**ProtocolBuffer
;
1022 UINTN ProtocolCount
;
1023 HANDLE_LIST
*ListWalker
;
1025 InternalShellInitHandleList();
1027 if (TheIndex
>= mHandleList
.NextIndex
) {
1031 for (ListWalker
= (HANDLE_LIST
*)GetFirstNode(&mHandleList
.List
.Link
)
1032 ; !IsNull(&mHandleList
.List
.Link
,&ListWalker
->Link
)
1033 ; ListWalker
= (HANDLE_LIST
*)GetNextNode(&mHandleList
.List
.Link
,&ListWalker
->Link
)
1035 if (ListWalker
->TheIndex
== TheIndex
&& ListWalker
->TheHandle
!= NULL
) {
1037 // Verify that LinkWalker->TheHandle is valid handle
1039 Status
= gBS
->ProtocolsPerHandle(ListWalker
->TheHandle
, &ProtocolBuffer
, &ProtocolCount
);
1040 if (EFI_ERROR (Status
)) {
1042 // TheHandle is not valid, so do not add to handle list
1044 ListWalker
->TheHandle
= NULL
;
1046 return (ListWalker
->TheHandle
);
1053 Gets all the related EFI_HANDLEs based on the mask supplied.
1055 This function scans all EFI_HANDLES in the UEFI environment's handle database
1056 and returns the ones with the specified relationship (Mask) to the specified
1059 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.
1060 If MatchingHandleCount is NULL, then ASSERT.
1062 If MatchingHandleBuffer is not NULL upon a successful return the memory must be
1065 @param[in] DriverBindingHandle The handle with Driver Binding protocol on it.
1066 @param[in] ControllerHandle The handle with Device Path protocol on it.
1067 @param[in] MatchingHandleCount The pointer to UINTN that specifies the number of HANDLES in
1068 MatchingHandleBuffer.
1069 @param[out] MatchingHandleBuffer On a successful return, a buffer of MatchingHandleCount
1070 EFI_HANDLEs with a terminating NULL EFI_HANDLE.
1071 @param[out] HandleType An array of type information.
1073 @retval EFI_SUCCESS The operation was successful, and any related handles
1074 are in MatchingHandleBuffer.
1075 @retval EFI_NOT_FOUND No matching handles were found.
1076 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.
1080 ParseHandleDatabaseByRelationshipWithType (
1081 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL
,
1082 IN CONST EFI_HANDLE ControllerHandle OPTIONAL
,
1083 IN UINTN
*HandleCount
,
1084 OUT EFI_HANDLE
**HandleBuffer
,
1085 OUT UINTN
**HandleType
1090 EFI_GUID
**ProtocolGuidArray
;
1092 UINTN ProtocolIndex
;
1093 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY
*OpenInfo
;
1094 UINTN OpenInfoCount
;
1095 UINTN OpenInfoIndex
;
1097 INTN DriverBindingHandleIndex
;
1099 ASSERT(HandleCount
!= NULL
);
1100 ASSERT(HandleBuffer
!= NULL
);
1101 ASSERT(HandleType
!= NULL
);
1102 ASSERT(DriverBindingHandle
!= NULL
|| ControllerHandle
!= NULL
);
1105 *HandleBuffer
= NULL
;
1109 // Retrieve the list of all handles from the handle database
1111 Status
= gBS
->LocateHandleBuffer (
1118 if (EFI_ERROR (Status
)) {
1122 *HandleType
= AllocateZeroPool (*HandleCount
* sizeof (UINTN
));
1123 ASSERT(*HandleType
!= NULL
);
1125 DriverBindingHandleIndex
= -1;
1126 for (HandleIndex
= 0; HandleIndex
< *HandleCount
; HandleIndex
++) {
1127 if (DriverBindingHandle
!= NULL
&& (*HandleBuffer
)[HandleIndex
] == DriverBindingHandle
) {
1128 DriverBindingHandleIndex
= (INTN
)HandleIndex
;
1132 for (HandleIndex
= 0; HandleIndex
< *HandleCount
; HandleIndex
++) {
1134 // Retrieve the list of all the protocols on each handle
1136 Status
= gBS
->ProtocolsPerHandle (
1137 (*HandleBuffer
)[HandleIndex
],
1141 if (EFI_ERROR (Status
)) {
1145 for (ProtocolIndex
= 0; ProtocolIndex
< ArrayCount
; ProtocolIndex
++) {
1148 // Set the bit describing what this handle has
1150 if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiLoadedImageProtocolGuid
) ) {
1151 (*HandleType
)[HandleIndex
] |= HR_IMAGE_HANDLE
;
1152 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiDriverBindingProtocolGuid
) ) {
1153 (*HandleType
)[HandleIndex
] |= HR_DRIVER_BINDING_HANDLE
;
1154 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiDriverConfiguration2ProtocolGuid
)) {
1155 (*HandleType
)[HandleIndex
] |= HR_DRIVER_CONFIGURATION_HANDLE
;
1156 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiDriverConfigurationProtocolGuid
) ) {
1157 (*HandleType
)[HandleIndex
] |= HR_DRIVER_CONFIGURATION_HANDLE
;
1158 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiDriverDiagnostics2ProtocolGuid
) ) {
1159 (*HandleType
)[HandleIndex
] |= HR_DRIVER_DIAGNOSTICS_HANDLE
;
1160 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiDriverDiagnosticsProtocolGuid
) ) {
1161 (*HandleType
)[HandleIndex
] |= HR_DRIVER_DIAGNOSTICS_HANDLE
;
1162 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiComponentName2ProtocolGuid
) ) {
1163 (*HandleType
)[HandleIndex
] |= HR_COMPONENT_NAME_HANDLE
;
1164 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiComponentNameProtocolGuid
) ) {
1165 (*HandleType
)[HandleIndex
] |= HR_COMPONENT_NAME_HANDLE
;
1166 } else if (CompareGuid (ProtocolGuidArray
[ProtocolIndex
], &gEfiDevicePathProtocolGuid
) ) {
1167 (*HandleType
)[HandleIndex
] |= HR_DEVICE_HANDLE
;
1170 ASSERT((*HandleType
)[HandleIndex
] == (*HandleType
)[HandleIndex
]);
1174 // Retrieve the list of agents that have opened each protocol
1176 Status
= gBS
->OpenProtocolInformation (
1177 (*HandleBuffer
)[HandleIndex
],
1178 ProtocolGuidArray
[ProtocolIndex
],
1182 if (EFI_ERROR (Status
)) {
1186 if (ControllerHandle
== NULL
) {
1188 // ControllerHandle == NULL and DriverBindingHandle != NULL.
1189 // Return information on all the controller handles that the driver specified by DriverBindingHandle is managing
1191 for (OpenInfoIndex
= 0; OpenInfoIndex
< OpenInfoCount
; OpenInfoIndex
++) {
1192 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== DriverBindingHandle
&& (OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_DRIVER
) != 0) {
1193 (*HandleType
)[HandleIndex
] |= (HR_DEVICE_HANDLE
| HR_CONTROLLER_HANDLE
);
1194 if (DriverBindingHandleIndex
!= -1) {
1195 (*HandleType
)[DriverBindingHandleIndex
] |= HR_DEVICE_DRIVER
;
1198 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== DriverBindingHandle
&& (OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) != 0) {
1199 (*HandleType
)[HandleIndex
] |= (HR_DEVICE_HANDLE
| HR_CONTROLLER_HANDLE
);
1200 if (DriverBindingHandleIndex
!= -1) {
1201 (*HandleType
)[DriverBindingHandleIndex
] |= (HR_BUS_DRIVER
| HR_DEVICE_DRIVER
);
1203 for (ChildIndex
= 0; ChildIndex
< *HandleCount
; ChildIndex
++) {
1204 if (OpenInfo
[OpenInfoIndex
].ControllerHandle
== (*HandleBuffer
)[ChildIndex
]) {
1205 (*HandleType
)[ChildIndex
] |= (HR_DEVICE_HANDLE
| HR_CHILD_HANDLE
);
1211 if (DriverBindingHandle
== NULL
&& ControllerHandle
!= NULL
) {
1212 if (ControllerHandle
== (*HandleBuffer
)[HandleIndex
]) {
1213 (*HandleType
)[HandleIndex
] |= (HR_DEVICE_HANDLE
| HR_CONTROLLER_HANDLE
);
1214 for (OpenInfoIndex
= 0; OpenInfoIndex
< OpenInfoCount
; OpenInfoIndex
++) {
1215 if ((OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_DRIVER
) != 0) {
1216 for (ChildIndex
= 0; ChildIndex
< *HandleCount
; ChildIndex
++) {
1217 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== (*HandleBuffer
)[ChildIndex
]) {
1218 (*HandleType
)[ChildIndex
] |= HR_DEVICE_DRIVER
;
1222 if ((OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) != 0) {
1223 for (ChildIndex
= 0; ChildIndex
< *HandleCount
; ChildIndex
++) {
1224 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== (*HandleBuffer
)[ChildIndex
]) {
1225 (*HandleType
)[ChildIndex
] |= (HR_BUS_DRIVER
| HR_DEVICE_DRIVER
);
1227 if (OpenInfo
[OpenInfoIndex
].ControllerHandle
== (*HandleBuffer
)[ChildIndex
]) {
1228 (*HandleType
)[ChildIndex
] |= (HR_DEVICE_HANDLE
| HR_CHILD_HANDLE
);
1234 for (OpenInfoIndex
= 0; OpenInfoIndex
< OpenInfoCount
; OpenInfoIndex
++) {
1235 if ((OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) != 0) {
1236 if (OpenInfo
[OpenInfoIndex
].ControllerHandle
== ControllerHandle
) {
1237 (*HandleType
)[HandleIndex
] |= (HR_DEVICE_HANDLE
| HR_PARENT_HANDLE
);
1243 if (DriverBindingHandle
!= NULL
&& ControllerHandle
!= NULL
) {
1244 if (ControllerHandle
== (*HandleBuffer
)[HandleIndex
]) {
1245 (*HandleType
)[HandleIndex
] |= (HR_DEVICE_HANDLE
| HR_CONTROLLER_HANDLE
);
1246 for (OpenInfoIndex
= 0; OpenInfoIndex
< OpenInfoCount
; OpenInfoIndex
++) {
1247 if ((OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_DRIVER
) != 0) {
1248 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== DriverBindingHandle
) {
1249 if (DriverBindingHandleIndex
!= -1) {
1250 (*HandleType
)[DriverBindingHandleIndex
] |= HR_DEVICE_DRIVER
;
1254 if ((OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) != 0) {
1255 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== DriverBindingHandle
) {
1256 for (ChildIndex
= 0; ChildIndex
< *HandleCount
; ChildIndex
++) {
1257 if (OpenInfo
[OpenInfoIndex
].ControllerHandle
== (*HandleBuffer
)[ChildIndex
]) {
1258 (*HandleType
)[ChildIndex
] |= (HR_DEVICE_HANDLE
| HR_CHILD_HANDLE
);
1263 for (ChildIndex
= 0; ChildIndex
< *HandleCount
; ChildIndex
++) {
1264 if (OpenInfo
[OpenInfoIndex
].AgentHandle
== (*HandleBuffer
)[ChildIndex
]) {
1265 (*HandleType
)[ChildIndex
] |= (HR_BUS_DRIVER
| HR_DEVICE_DRIVER
);
1271 for (OpenInfoIndex
= 0; OpenInfoIndex
< OpenInfoCount
; OpenInfoIndex
++) {
1272 if ((OpenInfo
[OpenInfoIndex
].Attributes
& EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
) != 0) {
1273 if (OpenInfo
[OpenInfoIndex
].ControllerHandle
== ControllerHandle
) {
1274 (*HandleType
)[HandleIndex
] |= (HR_DEVICE_HANDLE
| HR_PARENT_HANDLE
);
1280 FreePool (OpenInfo
);
1282 FreePool (ProtocolGuidArray
);
1288 Gets all the related EFI_HANDLEs based on the single EFI_HANDLE and the mask
1291 This function will scan all EFI_HANDLES in the UEFI environment's handle database
1292 and return all the ones with the specified relationship (Mask) to the specified
1295 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.
1296 If MatchingHandleCount is NULL, then ASSERT.
1298 If MatchingHandleBuffer is not NULL upon a sucessful return the memory must be
1301 @param[in] DriverBindingHandle Handle to a object with Driver Binding protocol
1303 @param[in] ControllerHandle Handle to a device with Device Path protocol on it.
1304 @param[in] Mask Mask of what relationship(s) is desired.
1305 @param[in] MatchingHandleCount Poitner to UINTN specifying number of HANDLES in
1306 MatchingHandleBuffer.
1307 @param[out] MatchingHandleBuffer On a sucessful return a buffer of MatchingHandleCount
1308 EFI_HANDLEs and a terminating NULL EFI_HANDLE.
1310 @retval EFI_SUCCESS The operation was sucessful and any related handles
1311 are in MatchingHandleBuffer;
1312 @retval EFI_NOT_FOUND No matching handles were found.
1313 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.
1317 ParseHandleDatabaseByRelationship (
1318 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL
,
1319 IN CONST EFI_HANDLE ControllerHandle OPTIONAL
,
1320 IN CONST UINTN Mask
,
1321 IN UINTN
*MatchingHandleCount
,
1322 OUT EFI_HANDLE
**MatchingHandleBuffer OPTIONAL
1327 EFI_HANDLE
*HandleBuffer
;
1331 ASSERT(MatchingHandleCount
!= NULL
);
1332 ASSERT(DriverBindingHandle
!= NULL
|| ControllerHandle
!= NULL
);
1334 if ((Mask
& HR_VALID_MASK
) != Mask
) {
1335 return (EFI_INVALID_PARAMETER
);
1338 if ((Mask
& HR_CHILD_HANDLE
) != 0 && DriverBindingHandle
== NULL
) {
1339 return (EFI_INVALID_PARAMETER
);
1342 *MatchingHandleCount
= 0;
1343 if (MatchingHandleBuffer
!= NULL
) {
1344 *MatchingHandleBuffer
= NULL
;
1347 HandleBuffer
= NULL
;
1350 Status
= ParseHandleDatabaseByRelationshipWithType (
1351 DriverBindingHandle
,
1357 if (!EFI_ERROR (Status
)) {
1359 // Count the number of handles that match the attributes in Mask
1361 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
1362 if ((HandleType
[HandleIndex
] & Mask
) == Mask
) {
1363 (*MatchingHandleCount
)++;
1367 // If no handles match the attributes in Mask then return EFI_NOT_FOUND
1369 if (*MatchingHandleCount
== 0) {
1370 Status
= EFI_NOT_FOUND
;
1373 if (MatchingHandleBuffer
== NULL
) {
1375 // Someone just wanted the count...
1377 Status
= EFI_SUCCESS
;
1380 // Allocate a handle buffer for the number of handles that matched the attributes in Mask
1382 *MatchingHandleBuffer
= AllocateZeroPool ((*MatchingHandleCount
+1)* sizeof (EFI_HANDLE
));
1383 ASSERT(*MatchingHandleBuffer
!= NULL
);
1385 for (HandleIndex
= 0,*MatchingHandleCount
= 0
1386 ; HandleIndex
< HandleCount
1390 // Fill the allocated buffer with the handles that matched the attributes in Mask
1392 if ((HandleType
[HandleIndex
] & Mask
) == Mask
) {
1393 (*MatchingHandleBuffer
)[(*MatchingHandleCount
)++] = HandleBuffer
[HandleIndex
];
1398 // Make the last one NULL
1400 (*MatchingHandleBuffer
)[*MatchingHandleCount
] = NULL
;
1402 Status
= EFI_SUCCESS
;
1403 } // MacthingHandleBuffer == NULL (ELSE)
1404 } // *MatchingHandleCount == 0 (ELSE)
1405 } // no error on ParseHandleDatabaseByRelationshipWithType
1407 if (HandleBuffer
!= NULL
) {
1408 FreePool (HandleBuffer
);
1411 if (HandleType
!= NULL
) {
1412 FreePool (HandleType
);
1419 Gets handles for any child controllers of the passed in controller.
1421 @param[in] ControllerHandle The handle of the "parent controller"
1422 @param[in] MatchingHandleCount Pointer to the number of handles in
1423 MatchingHandleBuffer on return.
1424 @param[out] MatchingHandleBuffer Buffer containing handles on a successful
1428 @retval EFI_SUCCESS The operation was sucessful.
1432 ParseHandleDatabaseForChildControllers(
1433 IN CONST EFI_HANDLE ControllerHandle
,
1434 IN UINTN
*MatchingHandleCount
,
1435 OUT EFI_HANDLE
**MatchingHandleBuffer OPTIONAL
1440 UINTN DriverBindingHandleCount
;
1441 EFI_HANDLE
*DriverBindingHandleBuffer
;
1442 UINTN DriverBindingHandleIndex
;
1443 UINTN ChildControllerHandleCount
;
1444 EFI_HANDLE
*ChildControllerHandleBuffer
;
1445 UINTN ChildControllerHandleIndex
;
1446 EFI_HANDLE
*HandleBufferForReturn
;
1448 if (MatchingHandleCount
== NULL
) {
1449 return (EFI_INVALID_PARAMETER
);
1451 *MatchingHandleCount
= 0;
1453 Status
= PARSE_HANDLE_DATABASE_UEFI_DRIVERS (
1455 &DriverBindingHandleCount
,
1456 &DriverBindingHandleBuffer
1458 if (EFI_ERROR (Status
)) {
1463 // Get a buffer big enough for all the controllers.
1465 HandleBufferForReturn
= GetHandleListByProtocol(NULL
);
1466 if (HandleBufferForReturn
== NULL
) {
1467 FreePool (DriverBindingHandleBuffer
);
1468 return (EFI_NOT_FOUND
);
1471 for (DriverBindingHandleIndex
= 0; DriverBindingHandleIndex
< DriverBindingHandleCount
; DriverBindingHandleIndex
++) {
1472 Status
= PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (
1473 DriverBindingHandleBuffer
[DriverBindingHandleIndex
],
1475 &ChildControllerHandleCount
,
1476 &ChildControllerHandleBuffer
1478 if (EFI_ERROR (Status
)) {
1482 for (ChildControllerHandleIndex
= 0;
1483 ChildControllerHandleIndex
< ChildControllerHandleCount
;
1484 ChildControllerHandleIndex
++
1486 for (HandleIndex
= 0; HandleIndex
< *MatchingHandleCount
; HandleIndex
++) {
1487 if (HandleBufferForReturn
[HandleIndex
] == ChildControllerHandleBuffer
[ChildControllerHandleIndex
]) {
1491 if (HandleIndex
>= *MatchingHandleCount
) {
1492 HandleBufferForReturn
[(*MatchingHandleCount
)++] = ChildControllerHandleBuffer
[ChildControllerHandleIndex
];
1496 FreePool (ChildControllerHandleBuffer
);
1499 FreePool (DriverBindingHandleBuffer
);
1501 if (MatchingHandleBuffer
!= NULL
) {
1502 *MatchingHandleBuffer
= HandleBufferForReturn
;
1504 FreePool(HandleBufferForReturn
);
1507 return (EFI_SUCCESS
);
1511 Appends 1 buffer to another buffer. This will re-allocate the destination buffer
1512 if necessary to fit all of the data.
1514 If DestinationBuffer is NULL, then ASSERT().
1516 @param[in, out] DestinationBuffer The pointer to the pointer to the buffer to append onto.
1517 @param[in, out] DestinationSize The pointer to the size of DestinationBuffer.
1518 @param[in] SourceBuffer The pointer to the buffer to append onto DestinationBuffer.
1519 @param[in] SourceSize The number of bytes of SourceBuffer to append.
1521 @retval NULL A memory allocation failed.
1522 @retval NULL A parameter was invalid.
1523 @return A pointer to (*DestinationBuffer).
1528 IN OUT VOID
**DestinationBuffer
,
1529 IN OUT UINTN
*DestinationSize
,
1530 IN VOID
*SourceBuffer
,
1534 UINTN LocalDestinationSize
;
1535 UINTN LocalDestinationFinalSize
;
1537 ASSERT(DestinationBuffer
!= NULL
);
1539 if (SourceSize
== 0 || SourceBuffer
== NULL
) {
1540 return (*DestinationBuffer
);
1543 if (DestinationSize
== NULL
) {
1544 LocalDestinationSize
= 0;
1546 LocalDestinationSize
= *DestinationSize
;
1549 LocalDestinationFinalSize
= LocalDestinationSize
+ SourceSize
;
1551 if (DestinationSize
!= NULL
) {
1552 *DestinationSize
= LocalDestinationSize
;
1555 if (LocalDestinationSize
== 0) {
1557 *DestinationBuffer
= AllocateZeroPool(LocalDestinationFinalSize
);
1560 *DestinationBuffer
= ReallocatePool(LocalDestinationSize
, LocalDestinationFinalSize
, *DestinationBuffer
);
1563 ASSERT(*DestinationBuffer
!= NULL
);
1566 return (CopyMem(((UINT8
*)(*DestinationBuffer
)) + LocalDestinationSize
, SourceBuffer
, SourceSize
));
1570 Gets handles for any child devices produced by the passed in driver.
1572 @param[in] DriverHandle The handle of the driver.
1573 @param[in] MatchingHandleCount Pointer to the number of handles in
1574 MatchingHandleBuffer on return.
1575 @param[out] MatchingHandleBuffer Buffer containing handles on a successful
1577 @retval EFI_SUCCESS The operation was sucessful.
1578 @sa ParseHandleDatabaseByRelationship
1582 ParseHandleDatabaseForChildDevices(
1583 IN CONST EFI_HANDLE DriverHandle
,
1584 IN UINTN
*MatchingHandleCount
,
1585 OUT EFI_HANDLE
**MatchingHandleBuffer OPTIONAL
1589 EFI_HANDLE
*Buffer2
;
1594 UINTN HandleBufferSize
;
1596 ASSERT(MatchingHandleCount
!= NULL
);
1598 HandleBufferSize
= 0;
1601 *MatchingHandleCount
= 0;
1603 Status
= PARSE_HANDLE_DATABASE_DEVICES (
1608 if (!EFI_ERROR (Status
)) {
1609 for (HandleIndex
= 0; HandleIndex
< Count1
; HandleIndex
++) {
1611 // now find the children
1613 Status
= PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (
1615 Buffer
[HandleIndex
],
1619 if (EFI_ERROR(Status
)) {
1623 // save out required and optional data elements
1625 *MatchingHandleCount
+= Count2
;
1626 if (MatchingHandleBuffer
!= NULL
) {
1627 *MatchingHandleBuffer
= BuffernCatGrow((VOID
**)MatchingHandleBuffer
, &HandleBufferSize
, Buffer2
, Count2
* sizeof(Buffer2
[0]));
1633 if (Buffer2
!= NULL
) {
1639 if (Buffer
!= NULL
) {
1646 Function to get all handles that support a given protocol or all handles.
1648 @param[in] ProtocolGuid The guid of the protocol to get handles for. If NULL
1649 then the function will return all handles.
1651 @retval NULL A memory allocation failed.
1652 @return A NULL terminated list of handles.
1656 GetHandleListByProtocol (
1657 IN CONST EFI_GUID
*ProtocolGuid OPTIONAL
1660 EFI_HANDLE
*HandleList
;
1668 // We cannot use LocateHandleBuffer since we need that NULL item on the ends of the list!
1670 if (ProtocolGuid
== NULL
) {
1671 Status
= gBS
->LocateHandle(AllHandles
, NULL
, NULL
, &Size
, HandleList
);
1672 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1673 HandleList
= AllocateZeroPool(Size
+ sizeof(EFI_HANDLE
));
1674 if (HandleList
== NULL
) {
1677 Status
= gBS
->LocateHandle(AllHandles
, NULL
, NULL
, &Size
, HandleList
);
1678 HandleList
[Size
/sizeof(EFI_HANDLE
)] = NULL
;
1681 Status
= gBS
->LocateHandle(ByProtocol
, (EFI_GUID
*)ProtocolGuid
, NULL
, &Size
, HandleList
);
1682 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1683 HandleList
= AllocateZeroPool(Size
+ sizeof(EFI_HANDLE
));
1684 if (HandleList
== NULL
) {
1687 Status
= gBS
->LocateHandle(ByProtocol
, (EFI_GUID
*)ProtocolGuid
, NULL
, &Size
, HandleList
);
1688 HandleList
[Size
/sizeof(EFI_HANDLE
)] = NULL
;
1691 if (EFI_ERROR(Status
)) {
1692 if (HandleList
!= NULL
) {
1693 FreePool(HandleList
);
1697 return (HandleList
);
1701 Function to get all handles that support some protocols.
1703 @param[in] ProtocolGuids A NULL terminated list of protocol GUIDs.
1705 @retval NULL A memory allocation failed.
1706 @retval NULL ProtocolGuids was NULL.
1707 @return A NULL terminated list of EFI_HANDLEs.
1711 GetHandleListByProtocolList (
1712 IN CONST EFI_GUID
**ProtocolGuids
1715 EFI_HANDLE
*HandleList
;
1720 CONST EFI_GUID
**GuidWalker
;
1721 EFI_HANDLE
*HandleWalker1
;
1722 EFI_HANDLE
*HandleWalker2
;
1726 TotalSize
= sizeof(EFI_HANDLE
);
1728 for (GuidWalker
= ProtocolGuids
; GuidWalker
!= NULL
&& *GuidWalker
!= NULL
; GuidWalker
++,Size
= 0){
1729 Status
= gBS
->LocateHandle(ByProtocol
, (EFI_GUID
*)(*GuidWalker
), NULL
, &Size
, NULL
);
1730 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1736 // No handles were found...
1738 if (TotalSize
== sizeof(EFI_HANDLE
)) {
1742 HandleList
= AllocateZeroPool(TotalSize
);
1743 if (HandleList
== NULL
) {
1748 for (GuidWalker
= ProtocolGuids
; GuidWalker
!= NULL
&& *GuidWalker
!= NULL
; GuidWalker
++){
1749 TempSize
= TotalSize
- Size
;
1750 Status
= gBS
->LocateHandle(ByProtocol
, (EFI_GUID
*)(*GuidWalker
), NULL
, &TempSize
, HandleList
+(Size
/sizeof(EFI_HANDLE
)));
1753 // Allow for missing protocols... Only update the 'used' size upon success.
1755 if (!EFI_ERROR(Status
)) {
1759 ASSERT(HandleList
[(TotalSize
/sizeof(EFI_HANDLE
))-1] == NULL
);
1761 for (HandleWalker1
= HandleList
; HandleWalker1
!= NULL
&& *HandleWalker1
!= NULL
; HandleWalker1
++) {
1762 for (HandleWalker2
= HandleWalker1
+ 1; HandleWalker2
!= NULL
&& *HandleWalker2
!= NULL
; HandleWalker2
++) {
1763 if (*HandleWalker1
== *HandleWalker2
) {
1765 // copy memory back 1 handle width.
1767 CopyMem(HandleWalker2
, HandleWalker2
+ 1, TotalSize
- ((HandleWalker2
-HandleList
+1)*sizeof(EFI_HANDLE
)));
1772 return (HandleList
);