]> git.proxmox.com Git - mirror_edk2.git/blob - ShellPkg/Library/UefiHandleParsingLib/UefiHandleParsingLib.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
update error handling to use less ASSERT.
[mirror_edk2.git] / ShellPkg / Library / UefiHandleParsingLib / UefiHandleParsingLib.c
1 /** @file
2 Provides interface to advanced shell functionality for parsing both handle and protocol database.
3
4 Copyright (c) 2010, 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
9
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.
12
13 **/
14
15 #include "UefiHandleParsingLib.h"
16
17
18 STATIC CONST EFI_GUID mHandleParsingHiiGuid = \
19 { \
20 0xb8969637, 0x81de, 0x43af, { 0xbc, 0x9a, 0x24, 0xd9, 0x89, 0x13, 0xf2, 0xf6 } \
21 };
22 EFI_HANDLE mHandleParsingHiiHandle;
23 HANDLE_INDEX_LIST mHandleList = {{{NULL,NULL},0,0},0};
24
25 /**
26 Constructor for the library.
27
28 @param[in] ImageHandle Ignored.
29 @param[in] SystemTable Ignored.
30
31 @retval EFI_SUCCESS The operation was successful.
32 **/
33 EFI_STATUS
34 EFIAPI
35 HandleParsingLibConstructor (
36 IN EFI_HANDLE ImageHandle,
37 IN EFI_SYSTEM_TABLE *SystemTable
38 )
39 {
40 mHandleParsingHiiHandle = HiiAddPackages (&mHandleParsingHiiGuid, gImageHandle, UefiHandleParsingLibStrings, NULL);
41 if (mHandleParsingHiiHandle == NULL) {
42 return (EFI_DEVICE_ERROR);
43 }
44
45 return (EFI_SUCCESS);
46 }
47
48 /**
49 Destructor for the library. free any resources.
50
51 @param[in] ImageHandle Ignored.
52 @param[in] SystemTable Ignored.
53
54 @retval EFI_SUCCESS The operation was successful.
55 **/
56 EFI_STATUS
57 EFIAPI
58 HandleParsingLibDestructor (
59 IN EFI_HANDLE ImageHandle,
60 IN EFI_SYSTEM_TABLE *SystemTable
61 )
62 {
63 if (mHandleParsingHiiHandle != NULL) {
64 HiiRemovePackages(mHandleParsingHiiHandle);
65 }
66 return (EFI_SUCCESS);
67 }
68
69 /*
70 CHAR16*
71 EFIAPI
72 LoadedImageProtocolDumpInformation(
73 IN CONST EFI_HANDLE TheHandle,
74 IN CONST BOOLEAN Verbose
75 )
76 {
77 EFI_LOADED_IMAGE_PROTOCOL *Image;
78 EFI_STATUS Status;
79 EFI_DEVICE_PATH_PROTOCOL *DevPath;
80 EFI_DEVICE_PATH_PROTOCOL *DevPathNode;
81 VOID *Buffer;
82 UINTN BufferSize;
83 UINT32 AuthenticationStatus;
84 EFI_GUID *NameGuid;
85 EFI_FIRMWARE_VOLUME_PROTOCOL *FV;
86 EFI_FIRMWARE_VOLUME2_PROTOCOL *FV2;
87
88 FV = NULL;
89 FV2 = NULL;
90 Buffer = NULL;
91 BufferSize = 0;
92
93 Status = HandleProtocol (
94 TheHandle,
95 &gEfiLoadedImageProtocolGuid,
96 &Image);
97 ASSERT_EFI_ERROR(Status);
98
99 DevPath = UnpackDevicePath (Image->FilePath);
100
101 if (DevPath == NULL) {
102 return NULL;
103 }
104
105 DevPathNode = DevPath;
106
107 while (!IsDevicePathEnd (DevPathNode)) {
108 //
109 // Find the Fv File path
110 //
111 NameGuid = GetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *)DevPathNode);
112 if (NameGuid != NULL) {
113 Status = BS->HandleProtocol (
114 Image->DeviceHandle,
115 &gEfiFirmwareVolumeProtocolGuid,
116 &FV
117 );
118 if (!EFI_ERROR (Status)) {
119 Status = FV->ReadSection (
120 FV,
121 NameGuid,
122 EFI_SECTION_USER_INTERFACE,
123 0,
124 &Buffer,
125 &BufferSize,
126 &AuthenticationStatus
127 );
128 if (!EFI_ERROR (Status)) {
129 break;
130 }
131
132 Buffer = NULL;
133 } else {
134 Status = BS->HandleProtocol (
135 Image->DeviceHandle,
136 &gEfiFirmwareVolume2ProtocolGuid,
137 &FV2
138 );
139 if (!EFI_ERROR (Status)) {
140 Status = FV2->ReadSection (
141 FV2,
142 NameGuid,
143 EFI_SECTION_USER_INTERFACE,
144 0,
145 &Buffer,
146 &BufferSize,
147 &AuthenticationStatus
148 );
149 if (!EFI_ERROR (Status)) {
150 break;
151 }
152
153 Buffer = NULL;
154 }
155 }
156 }
157 //
158 // Next device path node
159 //
160 DevPathNode = NextDevicePathNode (DevPathNode);
161 }
162
163 FreePool (DevPath);
164 return Buffer;
165 }
166 */
167
168 /**
169 Function to dump information about SimpleTextOut.
170
171 This will allocate the return buffer from boot services pool.
172
173 @param[in] TheHandle The handle that has SimpleTextOut installed.
174 @param[in] Verbose TRUE for additional information, FALSE otherwise.
175
176 @retval A poitner to a string containing the information.
177 **/
178 CHAR16*
179 EFIAPI
180 TxtOutProtocolDumpInformation(
181 IN CONST EFI_HANDLE TheHandle,
182 IN CONST BOOLEAN Verbose
183 )
184 {
185 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *Dev;
186 INTN Index;
187 UINTN Col;
188 UINTN Row;
189 EFI_STATUS Status;
190 CHAR16 *RetVal;
191 UINTN Size;
192 CHAR16 *Temp;
193 UINTN NewSize;
194
195 if (!Verbose) {
196 return (NULL);
197 }
198
199 RetVal = NULL;
200 Size = 0;
201
202 Status = gBS->HandleProtocol(
203 TheHandle,
204 &gEfiSimpleTextOutProtocolGuid,
205 (VOID**)&Dev);
206
207 ASSERT_EFI_ERROR(Status);
208 ASSERT (Dev != NULL && Dev->Mode != NULL);
209
210 Size = (Dev->Mode->MaxMode + 1) * 80;
211 RetVal = AllocateZeroPool(Size);
212
213 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_TXT_OUT_DUMP_HEADER), NULL);
214 UnicodeSPrint(RetVal, Size, Temp, Dev, Dev->Mode->Attribute);
215 FreePool(Temp);
216
217 //
218 // Dump TextOut Info
219 //
220 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_TXT_OUT_DUMP_LINE), NULL);
221 for (Index = 0; Index < Dev->Mode->MaxMode; Index++) {
222 Status = Dev->QueryMode (Dev, Index, &Col, &Row);
223 NewSize = Size - StrSize(RetVal);
224 UnicodeSPrint(
225 RetVal + StrLen(RetVal),
226 NewSize,
227 Temp,
228 Index == Dev->Mode->Mode ? L'*' : L' ',
229 Index,
230 !EFI_ERROR(Status)?Col:-1,
231 !EFI_ERROR(Status)?Row:-1
232 );
233 }
234 FreePool(Temp);
235 return (RetVal);
236 }
237
238 STATIC CONST UINTN VersionStringSize = 60;
239
240 /**
241 Function to dump information about EfiDriverSupportedEfiVersion protocol.
242
243 This will allocate the return buffer from boot services pool.
244
245 @param[in] TheHandle The handle that has the protocol installed.
246 @param[in] Verbose TRUE for additional information, FALSE otherwise.
247
248 @retval A poitner to a string containing the information.
249 **/
250 CHAR16*
251 EFIAPI
252 DriverEfiVersionProtocolDumpInformation(
253 IN CONST EFI_HANDLE TheHandle,
254 IN CONST BOOLEAN Verbose
255 )
256 {
257 EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL *DriverEfiVersion;
258 EFI_STATUS Status;
259 CHAR16 *RetVal;
260
261 Status = gBS->HandleProtocol(
262 TheHandle,
263 &gEfiDriverSupportedEfiVersionProtocolGuid,
264 (VOID**)&DriverEfiVersion);
265
266 ASSERT_EFI_ERROR(Status);
267
268 RetVal = AllocatePool(VersionStringSize);
269 ASSERT(RetVal != NULL);
270 UnicodeSPrint(RetVal, VersionStringSize, L"0x%08x", DriverEfiVersion->FirmwareVersion);
271 return (RetVal);
272 }
273
274 /**
275 Function to dump information about DevicePath protocol.
276
277 This will allocate the return buffer from boot services pool.
278
279 @param[in] TheHandle The handle that has the protocol installed.
280 @param[in] Verbose TRUE for additional information, FALSE otherwise.
281
282 @retval A poitner to a string containing the information.
283 **/
284 CHAR16*
285 EFIAPI
286 DevicePathProtocolDumpInformation(
287 IN CONST EFI_HANDLE TheHandle,
288 IN CONST BOOLEAN Verbose
289 )
290 {
291 EFI_DEVICE_PATH_PROTOCOL *DevPath;
292 CHAR16 *Temp;
293 CHAR16 *Temp2;
294 EFI_STATUS Status;
295 EFI_DEVICE_PATH_TO_TEXT_PROTOCOL *DevPathToText;
296 Temp = NULL;
297
298 Status = gBS->LocateProtocol(&gEfiDevicePathToTextProtocolGuid, NULL, (VOID**)&DevPathToText);
299 if (!EFI_ERROR(Status)) {
300 Status = gBS->OpenProtocol(TheHandle, &gEfiDevicePathProtocolGuid, (VOID**)&DevPath, gImageHandle, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL);
301 if (!EFI_ERROR(Status)) {
302 //
303 // I cannot decide whether to allow shortcuts here (the second BOOLEAN on the next line)
304 //
305 Temp = DevPathToText->ConvertDevicePathToText(DevPath, TRUE, TRUE);
306 gBS->CloseProtocol(TheHandle, &gEfiDevicePathProtocolGuid, gImageHandle, NULL);
307 }
308 }
309 if (Verbose && Temp != NULL && StrLen(Temp) > 30) {
310 Temp2 = NULL;
311 Temp2 = StrnCatGrow(&Temp2, NULL, Temp+(StrLen(Temp) - 30), 30);
312 FreePool(Temp);
313 Temp = Temp2;
314 }
315 return (Temp);
316 }
317
318 //
319 // Put the information on the NT32 protocol GUIDs here so we are not dependant on the Nt32Pkg
320 //
321 #define LOCAL_EFI_WIN_NT_THUNK_PROTOCOL_GUID \
322 { \
323 0x58c518b1, 0x76f3, 0x11d4, 0xbc, 0xea, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 \
324 }
325
326 #define LOCAL_EFI_WIN_NT_BUS_DRIVER_IO_PROTOCOL_GUID \
327 { \
328 0x96eb4ad6, 0xa32a, 0x11d4, 0xbc, 0xfd, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 \
329 }
330
331 #define LOCAL_EFI_WIN_NT_SERIAL_PORT_GUID \
332 { \
333 0xc95a93d, 0xa006, 0x11d4, 0xbc, 0xfa, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 \
334 }
335 STATIC CONST EFI_GUID WinNtThunkProtocolGuid = LOCAL_EFI_WIN_NT_THUNK_PROTOCOL_GUID;
336 STATIC CONST EFI_GUID WinNtIoProtocolGuid = LOCAL_EFI_WIN_NT_BUS_DRIVER_IO_PROTOCOL_GUID;
337 STATIC CONST EFI_GUID WinNtSerialPortGuid = LOCAL_EFI_WIN_NT_SERIAL_PORT_GUID;
338
339 STATIC CONST PROTOCOL_INFO_BLOCK mGuidStringListNT[] = {
340 {STRING_TOKEN(STR_WINNT_THUNK), (EFI_GUID*)&WinNtThunkProtocolGuid, NULL},
341 {STRING_TOKEN(STR_WINNT_DRIVER_IO), (EFI_GUID*)&WinNtIoProtocolGuid, NULL},
342 {STRING_TOKEN(STR_WINNT_SERIAL_PORT), (EFI_GUID*)&WinNtSerialPortGuid, NULL},
343 {STRING_TOKEN(STR_UNKNOWN_DEVICE), NULL, NULL},
344 };
345
346 STATIC CONST PROTOCOL_INFO_BLOCK mGuidStringList[] = {
347 {STRING_TOKEN(STR_LOADED_IMAGE), &gEfiLoadedImageProtocolGuid, NULL},
348 {STRING_TOKEN(STR_DEVICE_PATH), &gEfiDevicePathProtocolGuid, DevicePathProtocolDumpInformation},
349 {STRING_TOKEN(STR_IMAGE_PATH), &gEfiLoadedImageDevicePathProtocolGuid, DevicePathProtocolDumpInformation},
350 {STRING_TOKEN(STR_DEVICE_PATH_UTIL), &gEfiDevicePathUtilitiesProtocolGuid, NULL},
351 {STRING_TOKEN(STR_DEVICE_PATH_TXT), &gEfiDevicePathToTextProtocolGuid, NULL},
352 {STRING_TOKEN(STR_DEVICE_PATH_FTXT), &gEfiDevicePathFromTextProtocolGuid, NULL},
353 {STRING_TOKEN(STR_DEVICE_PATH_PC), &gEfiPcAnsiGuid, NULL},
354 {STRING_TOKEN(STR_DEVICE_PATH_VT100), &gEfiVT100Guid, NULL},
355 {STRING_TOKEN(STR_DEVICE_PATH_VT100P), &gEfiVT100PlusGuid, NULL},
356 {STRING_TOKEN(STR_DEVICE_PATH_VTUTF8), &gEfiVTUTF8Guid, NULL},
357 {STRING_TOKEN(STR_DRIVER_BINDING), &gEfiDriverBindingProtocolGuid, NULL},
358 {STRING_TOKEN(STR_PLATFORM_OVERRIDE), &gEfiPlatformDriverOverrideProtocolGuid, NULL},
359 {STRING_TOKEN(STR_BUS_OVERRIDE), &gEfiBusSpecificDriverOverrideProtocolGuid, NULL},
360 {STRING_TOKEN(STR_DRIVER_DIAG), &gEfiDriverDiagnosticsProtocolGuid, NULL},
361 {STRING_TOKEN(STR_DRIVER_DIAG2), &gEfiDriverDiagnostics2ProtocolGuid, NULL},
362 {STRING_TOKEN(STR_DRIVER_CN), &gEfiComponentNameProtocolGuid, NULL},
363 {STRING_TOKEN(STR_DRIVER_CN2), &gEfiComponentName2ProtocolGuid, NULL},
364 {STRING_TOKEN(STR_PLAT_DRV_CFG), &gEfiPlatformToDriverConfigurationProtocolGuid, NULL},
365 {STRING_TOKEN(STR_DRIVER_VERSION), &gEfiDriverSupportedEfiVersionProtocolGuid, DriverEfiVersionProtocolDumpInformation},
366 {STRING_TOKEN(STR_TXT_IN), &gEfiSimpleTextInProtocolGuid, NULL},
367 {STRING_TOKEN(STR_TXT_IN_EX), &gEfiSimpleTextInputExProtocolGuid, NULL},
368 {STRING_TOKEN(STR_TXT_OUT), &gEfiSimpleTextOutProtocolGuid, TxtOutProtocolDumpInformation},
369 {STRING_TOKEN(STR_SIM_POINTER), &gEfiSimplePointerProtocolGuid, NULL},
370 {STRING_TOKEN(STR_ABS_POINTER), &gEfiAbsolutePointerProtocolGuid, NULL},
371 {STRING_TOKEN(STR_SERIAL_IO), &gEfiSerialIoProtocolGuid, NULL},
372 {STRING_TOKEN(STR_GRAPHICS_OUTPUT), &gEfiGraphicsOutputProtocolGuid, NULL},
373 {STRING_TOKEN(STR_EDID_DISCOVERED), &gEfiEdidDiscoveredProtocolGuid, NULL},
374 {STRING_TOKEN(STR_EDID_ACTIVE), &gEfiEdidActiveProtocolGuid, NULL},
375 {STRING_TOKEN(STR_EDID_OVERRIDE), &gEfiEdidOverrideProtocolGuid, NULL},
376 {STRING_TOKEN(STR_CON_IN), &gEfiConsoleInDeviceGuid, NULL},
377 {STRING_TOKEN(STR_CON_OUT), &gEfiConsoleOutDeviceGuid, NULL},
378 {STRING_TOKEN(STR_STD_ERR), &gEfiStandardErrorDeviceGuid, NULL},
379 {STRING_TOKEN(STR_LOAD_FILE), &gEfiLoadFileProtocolGuid, NULL},
380 {STRING_TOKEN(STR_LOAD_FILE2), &gEfiLoadFile2ProtocolGuid, NULL},
381 {STRING_TOKEN(STR_SIMPLE_FILE_SYS), &gEfiSimpleFileSystemProtocolGuid, NULL},
382 {STRING_TOKEN(STR_FILE_INFO), &gEfiFileInfoGuid, NULL},
383 {STRING_TOKEN(STR_FILE_SYS_INFO), &gEfiFileSystemInfoGuid, NULL},
384 {STRING_TOKEN(STR_TAPE_IO), &gEfiTapeIoProtocolGuid, NULL},
385 {STRING_TOKEN(STR_DISK_IO), &gEfiDiskIoProtocolGuid, NULL},
386 {STRING_TOKEN(STR_BLK_IO), &gEfiBlockIoProtocolGuid, NULL},
387 {STRING_TOKEN(STR_UC), &gEfiUnicodeCollationProtocolGuid, NULL},
388 {STRING_TOKEN(STR_UC2), &gEfiUnicodeCollation2ProtocolGuid, NULL},
389 {STRING_TOKEN(STR_PCIRB_IO), &gEfiPciRootBridgeIoProtocolGuid, NULL},
390 {STRING_TOKEN(STR_PCI_IO), &gEfiPciIoProtocolGuid, NULL},
391 {STRING_TOKEN(STR_SCSI_PT), &gEfiScsiPassThruProtocolGuid, NULL},
392 {STRING_TOKEN(STR_SCSI_IO), &gEfiScsiIoProtocolGuid, NULL},
393 {STRING_TOKEN(STR_SCSI_PT_EXT), &gEfiExtScsiPassThruProtocolGuid, NULL},
394 {STRING_TOKEN(STR_ISCSI), &gEfiIScsiInitiatorNameProtocolGuid, NULL},
395 {STRING_TOKEN(STR_USB_IO), &gEfiUsbIoProtocolGuid, NULL},
396 {STRING_TOKEN(STR_USB_HC), &gEfiUsbHcProtocolGuid, NULL},
397 {STRING_TOKEN(STR_USB_HC2), &gEfiUsb2HcProtocolGuid, NULL},
398 {STRING_TOKEN(STR_DEBUG_SUPPORT), &gEfiDebugSupportProtocolGuid, NULL},
399 {STRING_TOKEN(STR_DEBUG_PORT), &gEfiDebugPortProtocolGuid, NULL},
400 {STRING_TOKEN(STR_DECOMPRESS), &gEfiDecompressProtocolGuid, NULL},
401 {STRING_TOKEN(STR_ACPI_TABLE), &gEfiAcpiTableProtocolGuid, NULL},
402 {STRING_TOKEN(STR_EBC_INTERPRETER), &gEfiEbcProtocolGuid, NULL},
403 {STRING_TOKEN(STR_SNP), &gEfiSimpleNetworkProtocolGuid, NULL},
404 {STRING_TOKEN(STR_NII), &gEfiNetworkInterfaceIdentifierProtocolGuid, NULL},
405 {STRING_TOKEN(STR_NII_31), &gEfiNetworkInterfaceIdentifierProtocolGuid_31, NULL},
406 {STRING_TOKEN(STR_PXE_BC), &gEfiPxeBaseCodeProtocolGuid, NULL},
407 {STRING_TOKEN(STR_PXE_CB), &gEfiPxeBaseCodeCallbackProtocolGuid, NULL},
408 {STRING_TOKEN(STR_BIS), &gEfiBisProtocolGuid, NULL},
409 {STRING_TOKEN(STR_MNP_SB), &gEfiManagedNetworkServiceBindingProtocolGuid, NULL},
410 {STRING_TOKEN(STR_MNP), &gEfiManagedNetworkProtocolGuid, NULL},
411 {STRING_TOKEN(STR_ARP_SB), &gEfiArpServiceBindingProtocolGuid, NULL},
412 {STRING_TOKEN(STR_ARP), &gEfiArpProtocolGuid, NULL},
413 {STRING_TOKEN(STR_DHCPV4_SB), &gEfiDhcp4ServiceBindingProtocolGuid, NULL},
414 {STRING_TOKEN(STR_DHCPV4), &gEfiDhcp4ProtocolGuid, NULL},
415 {STRING_TOKEN(STR_TCPV4_SB), &gEfiTcp4ServiceBindingProtocolGuid, NULL},
416 {STRING_TOKEN(STR_TCPV4), &gEfiTcp4ProtocolGuid, NULL},
417 {STRING_TOKEN(STR_IPV4_SB), &gEfiIp4ServiceBindingProtocolGuid, NULL},
418 {STRING_TOKEN(STR_IPV4), &gEfiIp4ProtocolGuid, NULL},
419 {STRING_TOKEN(STR_IPV4_CFG), &gEfiIp4ConfigProtocolGuid, NULL},
420 {STRING_TOKEN(STR_SHELL_PARAMETERS), &gEfiShellParametersProtocolGuid, NULL},
421 {STRING_TOKEN(STR_SHELL), &gEfiShellProtocolGuid, NULL},
422 {STRING_TOKEN(STR_EFI_GLOBAL_VARIABLE), &gEfiGlobalVariableGuid, NULL},
423 {STRING_TOKEN(STR_UDPV4_SB), &gEfiUdp4ServiceBindingProtocolGuid, NULL},
424 {STRING_TOKEN(STR_UDPV4), &gEfiUdp4ProtocolGuid, NULL},
425 {STRING_TOKEN(STR_MTFTPV4_SB), &gEfiMtftp4ServiceBindingProtocolGuid, NULL},
426 {STRING_TOKEN(STR_MTFTPV4), &gEfiMtftp4ProtocolGuid, NULL},
427 {STRING_TOKEN(STR_AUTH_INFO), &gEfiAuthenticationInfoProtocolGuid, NULL},
428 {STRING_TOKEN(STR_HASH_SB), &gEfiHashServiceBindingProtocolGuid, NULL},
429 {STRING_TOKEN(STR_HASH), &gEfiHashProtocolGuid, NULL},
430 {STRING_TOKEN(STR_HII_FONT), &gEfiHiiFontProtocolGuid, NULL},
431 {STRING_TOKEN(STR_HII_STRING), &gEfiHiiStringProtocolGuid, NULL},
432 {STRING_TOKEN(STR_HII_IMAGE), &gEfiHiiImageProtocolGuid, NULL},
433 {STRING_TOKEN(STR_HII_DATABASE), &gEfiHiiDatabaseProtocolGuid, NULL},
434 {STRING_TOKEN(STR_HII_CONFIG_ROUT), &gEfiHiiConfigRoutingProtocolGuid, NULL},
435 {STRING_TOKEN(STR_HII_CONFIG_ACC), &gEfiHiiConfigAccessProtocolGuid, NULL},
436 {STRING_TOKEN(STR_HII_FORM_BROWSER2), &gEfiFormBrowser2ProtocolGuid, NULL},
437 {STRING_TOKEN(STR_SHELL_INTERFACE), &gEfiShellInterfaceGuid, NULL},
438 {STRING_TOKEN(STR_SHELL_ENV2), &gEfiShellEnvironment2Guid, NULL},
439 {STRING_TOKEN(STR_SHELL_ENV), &gEfiShellEnvironment2Guid, NULL},
440 {STRING_TOKEN(STR_DEVICE_IO), &gEfiDeviceIoProtocolGuid, NULL},
441 {STRING_TOKEN(STR_UGA_DRAW), &gEfiUgaDrawProtocolGuid, NULL},
442 {STRING_TOKEN(STR_UGA_IO), &gEfiUgaIoProtocolGuid, NULL},
443 {STRING_TOKEN(STR_ESP), &gEfiPartTypeSystemPartGuid, NULL},
444 {STRING_TOKEN(STR_GPT_NBR), &gEfiPartTypeLegacyMbrGuid, NULL},
445 {STRING_TOKEN(STR_DRIVER_CONFIG), &gEfiDriverConfigurationProtocolGuid, NULL},
446 {STRING_TOKEN(STR_DRIVER_CONFIG2), &gEfiDriverConfiguration2ProtocolGuid, NULL},
447 {STRING_TOKEN(STR_UNKNOWN_DEVICE), NULL, NULL},
448 };
449
450 /**
451 Function to get the node for a protocol or struct from it's GUID.
452
453 if Guid is NULL, then ASSERT.
454
455 @param[in] Guid The GUID to look for the name of.
456
457 @return The node.
458 **/
459 CONST PROTOCOL_INFO_BLOCK *
460 EFIAPI
461 InternalShellGetNodeFromGuid(
462 IN CONST EFI_GUID* Guid
463 )
464 {
465 CONST PROTOCOL_INFO_BLOCK *ListWalker;
466
467 ASSERT(Guid != NULL);
468
469 if (PcdGetBool(PcdShellIncludeNtGuids)) {
470 for (ListWalker = mGuidStringListNT ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {
471 if (CompareGuid(ListWalker->GuidId, Guid)) {
472 return (ListWalker);
473 }
474 }
475 }
476 for (ListWalker = mGuidStringList ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {
477 if (CompareGuid(ListWalker->GuidId, Guid)) {
478 return (ListWalker);
479 }
480 }
481 return (ListWalker);
482 }
483
484 /**
485 Function to get the name of a protocol or struct from it's GUID.
486
487 if Guid is NULL, then ASSERT.
488
489 @param[in] Guid The GUID to look for the name of.
490 @param[in] Lang The language to use.
491
492 @return pointer to string of the name. The caller
493 is responsible to free this memory.
494 **/
495 CHAR16*
496 EFIAPI
497 GetStringNameFromGuid(
498 IN CONST EFI_GUID *Guid,
499 IN CONST CHAR8 *Lang OPTIONAL
500 )
501 {
502 CONST PROTOCOL_INFO_BLOCK *Id;
503
504 Id = InternalShellGetNodeFromGuid(Guid);
505 return (HiiGetString(mHandleParsingHiiHandle, Id->StringId, Lang));
506 }
507
508 /**
509 Function to dump protocol information from a handle.
510
511 This function will return a allocated string buffer containing the
512 information. The caller is responsible for freeing the memory.
513
514 If Guid is NULL, ASSERT().
515 If TheHandle is NULL, ASSERT().
516
517 @param[in] TheHandle The handle to dump information from.
518 @param[in] Guid The GUID of the protocol to dump.
519 @param[in] Verbose TRUE for extra info. FALSE otherwise.
520
521 @return The pointer to string.
522 @retval NULL An error was encountered.
523 **/
524 CHAR16*
525 EFIAPI
526 GetProtocolInformationDump(
527 IN CONST EFI_HANDLE TheHandle,
528 IN CONST EFI_GUID *Guid,
529 IN CONST BOOLEAN Verbose
530 )
531 {
532 CONST PROTOCOL_INFO_BLOCK *Id;
533
534 ASSERT(TheHandle != NULL);
535 ASSERT(Guid != NULL);
536
537 if (TheHandle == NULL || Guid == NULL) {
538 return (NULL);
539 }
540
541 Id = InternalShellGetNodeFromGuid(Guid);
542 if (Id != NULL && Id->DumpInfo != NULL) {
543 return (Id->DumpInfo(TheHandle, Verbose));
544 }
545 return (NULL);
546 }
547
548 /**
549 Function to get the Guid for a protocol or struct based on it's string name.
550
551 @param[in] Name The pointer to the string name.
552 @param[in] Lang The pointer to the language code.
553 @param[in] Guid The pointer to the Guid.
554
555 @retval EFI_SUCCESS The operation was sucessful.
556 **/
557 EFI_STATUS
558 EFIAPI
559 GetGuidFromStringName(
560 IN CONST CHAR16 *Name,
561 IN CONST CHAR8 *Lang OPTIONAL,
562 IN EFI_GUID **Guid
563 )
564 {
565 CONST PROTOCOL_INFO_BLOCK *ListWalker;
566 CHAR16 *String;
567
568 ASSERT(Guid != NULL);
569 if (Guid == NULL) {
570 return (EFI_INVALID_PARAMETER);
571 }
572 *Guid = NULL;
573
574 if (PcdGetBool(PcdShellIncludeNtGuids)) {
575 for (ListWalker = mGuidStringListNT ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {
576 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);
577 if (Name != NULL && String != NULL && StrCmp(Name, String)==0) {
578 *Guid = ListWalker->GuidId;
579 }
580 SHELL_FREE_NON_NULL(String);
581 if (*Guid != NULL) {
582 return (EFI_SUCCESS);
583 }
584 }
585 }
586 for (ListWalker = mGuidStringList ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {
587 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);
588 if (Name != NULL && String != NULL && StrCmp(Name, String)==0) {
589 *Guid = ListWalker->GuidId;
590 }
591 SHELL_FREE_NON_NULL(String);
592 if (*Guid != NULL) {
593 return (EFI_SUCCESS);
594 }
595 }
596 return (EFI_NOT_FOUND);
597 }
598
599 /**
600 Function to retrieve the driver name (if possible) from the ComponentName or
601 ComponentName2 protocol
602
603 @param[in] TheHandle The driver handle to get the name of.
604 @param[in] Language The language to use.
605
606 @retval NULL The name could not be found.
607 @return A pointer to the string name. Do not de-allocate the memory.
608 **/
609 CONST CHAR16*
610 EFIAPI
611 GetStringNameFromHandle(
612 IN CONST EFI_HANDLE TheHandle,
613 IN CONST CHAR8 *Language
614 )
615 {
616 EFI_COMPONENT_NAME2_PROTOCOL *CompNameStruct;
617 EFI_STATUS Status;
618 CHAR16 *RetVal;
619
620 Status = gBS->OpenProtocol(
621 TheHandle,
622 &gEfiComponentName2ProtocolGuid,
623 (VOID**)&CompNameStruct,
624 gImageHandle,
625 NULL,
626 EFI_OPEN_PROTOCOL_GET_PROTOCOL);
627 if (!EFI_ERROR(Status)) {
628 Status = CompNameStruct->GetDriverName(CompNameStruct, (CHAR8*)Language, &RetVal);
629 if (!EFI_ERROR(Status)) {
630 return (RetVal);
631 }
632 }
633 Status = gBS->OpenProtocol(
634 TheHandle,
635 &gEfiComponentNameProtocolGuid,
636 (VOID**)&CompNameStruct,
637 gImageHandle,
638 NULL,
639 EFI_OPEN_PROTOCOL_GET_PROTOCOL);
640 if (!EFI_ERROR(Status)) {
641 Status = CompNameStruct->GetDriverName(CompNameStruct, (CHAR8*)Language, &RetVal);
642 if (!EFI_ERROR(Status)) {
643 return (RetVal);
644 }
645 }
646 return (NULL);
647 }
648
649 /**
650 Function to initialize the file global mHandleList object for use in
651 vonverting handles to index and index to handle.
652
653 @retval EFI_SUCCESS The operation was successful.
654 **/
655 EFI_STATUS
656 EFIAPI
657 InternalShellInitHandleList(
658 VOID
659 )
660 {
661 EFI_STATUS Status;
662 EFI_HANDLE *HandleBuffer;
663 UINTN HandleCount;
664 HANDLE_LIST *ListWalker;
665
666 if (mHandleList.NextIndex != 0) {
667 return EFI_SUCCESS;
668 }
669 InitializeListHead(&mHandleList.List.Link);
670 mHandleList.NextIndex = 1;
671 Status = gBS->LocateHandleBuffer (
672 AllHandles,
673 NULL,
674 NULL,
675 &HandleCount,
676 &HandleBuffer
677 );
678 ASSERT_EFI_ERROR(Status);
679 if (EFI_ERROR(Status)) {
680 return (Status);
681 }
682 for (mHandleList.NextIndex = 1 ; mHandleList.NextIndex <= HandleCount ; mHandleList.NextIndex++){
683 ListWalker = AllocatePool(sizeof(HANDLE_LIST));
684 ASSERT(ListWalker != NULL);
685 ListWalker->TheHandle = HandleBuffer[mHandleList.NextIndex-1];
686 ListWalker->TheIndex = mHandleList.NextIndex;
687 InsertTailList(&mHandleList.List.Link,&ListWalker->Link);
688 }
689 FreePool(HandleBuffer);
690 return (EFI_SUCCESS);
691 }
692
693 /**
694 Function to retrieve the human-friendly index of a given handle. If the handle
695 does not have a index one will be automatically assigned. The index value is valid
696 until the termination of the shell application.
697
698 @param[in] TheHandle The handle to retrieve an index for.
699
700 @retval 0 A memory allocation failed.
701 @return The index of the handle.
702
703 **/
704 UINTN
705 EFIAPI
706 ConvertHandleToHandleIndex(
707 IN CONST EFI_HANDLE TheHandle
708 )
709 {
710 HANDLE_LIST *ListWalker;
711 ASSERT(TheHandle!=NULL);
712
713 InternalShellInitHandleList();
714
715 for (ListWalker = (HANDLE_LIST*)GetFirstNode(&mHandleList.List.Link)
716 ; !IsNull(&mHandleList.List.Link,&ListWalker->Link)
717 ; ListWalker = (HANDLE_LIST*)GetNextNode(&mHandleList.List.Link,&ListWalker->Link)
718 ){
719 if (ListWalker->TheHandle == TheHandle) {
720 return (ListWalker->TheIndex);
721 }
722 }
723 ListWalker = AllocatePool(sizeof(HANDLE_LIST));
724 ASSERT(ListWalker != NULL);
725 ListWalker->TheHandle = TheHandle;
726 ListWalker->TheIndex = mHandleList.NextIndex++;
727 InsertTailList(&mHandleList.List.Link,&ListWalker->Link);
728 return (ListWalker->TheIndex);
729 }
730
731
732
733 /**
734 Function to retrieve the EFI_HANDLE from the human-friendly index.
735
736 @param[in] TheIndex The index to retrieve the EFI_HANDLE for.
737
738 @retval NULL The index was invalid.
739 @return The EFI_HANDLE that index represents.
740
741 **/
742 EFI_HANDLE
743 EFIAPI
744 ConvertHandleIndexToHandle(
745 IN CONST UINTN TheIndex
746 )
747 {
748 HANDLE_LIST *ListWalker;
749
750 InternalShellInitHandleList();
751
752 if (TheIndex >= mHandleList.NextIndex) {
753 return (NULL);
754 }
755
756 for (ListWalker = (HANDLE_LIST*)GetFirstNode(&mHandleList.List.Link)
757 ; !IsNull(&mHandleList.List.Link,&ListWalker->Link)
758 ; ListWalker = (HANDLE_LIST*)GetNextNode(&mHandleList.List.Link,&ListWalker->Link)
759 ){
760 if (ListWalker->TheIndex == TheIndex) {
761 return (ListWalker->TheHandle);
762 }
763 }
764 return (NULL);
765 }
766
767 /**
768 Gets all the related EFI_HANDLEs based on the mask supplied.
769
770 This function scans all EFI_HANDLES in the UEFI environment's handle database
771 and returns the ones with the specified relationship (Mask) to the specified
772 controller handle.
773
774 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.
775 If MatchingHandleCount is NULL, then ASSERT.
776
777 If MatchingHandleBuffer is not NULL upon a successful return the memory must be
778 caller freed.
779
780 @param[in] DriverBindingHandle The handle with Driver Binding protocol on it.
781 @param[in] ControllerHandle The handle with Device Path protocol on it.
782 @param[in] MatchingHandleCount The pointer to UINTN that specifies the number of HANDLES in
783 MatchingHandleBuffer.
784 @param[out] MatchingHandleBuffer On a successful return, a buffer of MatchingHandleCount
785 EFI_HANDLEs with a terminating NULL EFI_HANDLE.
786 @param[out] HandleType An array of type information.
787
788 @retval EFI_SUCCESS The operation was successful, and any related handles
789 are in MatchingHandleBuffer.
790 @retval EFI_NOT_FOUND No matching handles were found.
791 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.
792 **/
793 EFI_STATUS
794 EFIAPI
795 ParseHandleDatabaseByRelationshipWithType (
796 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL,
797 IN CONST EFI_HANDLE ControllerHandle OPTIONAL,
798 IN UINTN *HandleCount,
799 OUT EFI_HANDLE **HandleBuffer,
800 OUT UINTN **HandleType
801 )
802 {
803 EFI_STATUS Status;
804 UINTN HandleIndex;
805 EFI_GUID **ProtocolGuidArray;
806 UINTN ArrayCount;
807 UINTN ProtocolIndex;
808 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *OpenInfo;
809 UINTN OpenInfoCount;
810 UINTN OpenInfoIndex;
811 UINTN ChildIndex;
812
813 ASSERT(HandleCount != NULL);
814 ASSERT(HandleBuffer != NULL);
815 ASSERT(HandleType != NULL);
816 ASSERT(DriverBindingHandle != NULL || ControllerHandle != NULL);
817
818 *HandleCount = 0;
819 *HandleBuffer = NULL;
820 *HandleType = NULL;
821
822 //
823 // Retrieve the list of all handles from the handle database
824 //
825 Status = gBS->LocateHandleBuffer (
826 AllHandles,
827 NULL,
828 NULL,
829 HandleCount,
830 HandleBuffer
831 );
832 if (EFI_ERROR (Status)) {
833 return (Status);
834 }
835
836 *HandleType = AllocateZeroPool (*HandleCount * sizeof (UINTN));
837 ASSERT(*HandleType != NULL);
838
839 for (HandleIndex = 0; HandleIndex < *HandleCount; HandleIndex++) {
840 //
841 // Retrieve the list of all the protocols on each handle
842 //
843 Status = gBS->ProtocolsPerHandle (
844 (*HandleBuffer)[HandleIndex],
845 &ProtocolGuidArray,
846 &ArrayCount
847 );
848 if (!EFI_ERROR (Status)) {
849
850 for (ProtocolIndex = 0; ProtocolIndex < ArrayCount; ProtocolIndex++) {
851
852 //
853 // Set the bit describing what this handle has
854 //
855 if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiLoadedImageProtocolGuid) ) {
856 (*HandleType)[HandleIndex] |= HR_IMAGE_HANDLE;
857 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverBindingProtocolGuid) ) {
858 (*HandleType)[HandleIndex] |= HR_DRIVER_BINDING_HANDLE;
859 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverConfiguration2ProtocolGuid)) {
860 (*HandleType)[HandleIndex] |= HR_DRIVER_CONFIGURATION_HANDLE;
861 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverConfigurationProtocolGuid) ) {
862 (*HandleType)[HandleIndex] |= HR_DRIVER_CONFIGURATION_HANDLE;
863 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverDiagnostics2ProtocolGuid) ) {
864 (*HandleType)[HandleIndex] |= HR_DRIVER_DIAGNOSTICS_HANDLE;
865 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverDiagnosticsProtocolGuid) ) {
866 (*HandleType)[HandleIndex] |= HR_DRIVER_DIAGNOSTICS_HANDLE;
867 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiComponentName2ProtocolGuid) ) {
868 (*HandleType)[HandleIndex] |= HR_COMPONENT_NAME_HANDLE;
869 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiComponentNameProtocolGuid) ) {
870 (*HandleType)[HandleIndex] |= HR_COMPONENT_NAME_HANDLE;
871 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDevicePathProtocolGuid) ) {
872 (*HandleType)[HandleIndex] |= HR_DEVICE_HANDLE;
873 } else {
874 DEBUG_CODE_BEGIN();
875 ASSERT((*HandleType)[HandleIndex] == (*HandleType)[HandleIndex]);
876 DEBUG_CODE_END();
877 }
878 //
879 // Retrieve the list of agents that have opened each protocol
880 //
881 Status = gBS->OpenProtocolInformation (
882 (*HandleBuffer)[HandleIndex],
883 ProtocolGuidArray[ProtocolIndex],
884 &OpenInfo,
885 &OpenInfoCount
886 );
887 if (!EFI_ERROR (Status)) {
888 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {
889 if (DriverBindingHandle != NULL && OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle) {
890 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) == EFI_OPEN_PROTOCOL_BY_DRIVER) {
891 (*HandleType)[HandleIndex] |= (HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);
892 }
893 if (ControllerHandle != NULL && (*HandleBuffer)[HandleIndex] == ControllerHandle) {
894 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) == EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
895 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {
896 if ((*HandleBuffer)[ChildIndex] == OpenInfo[OpenInfoIndex].ControllerHandle) {
897 (*HandleType)[ChildIndex] |= (HR_DEVICE_HANDLE | HR_CHILD_HANDLE);
898 }
899 }
900 }
901 }
902 }
903 if (DriverBindingHandle == NULL && OpenInfo[OpenInfoIndex].ControllerHandle == ControllerHandle) {
904 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) == EFI_OPEN_PROTOCOL_BY_DRIVER) {
905 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {
906 if ((*HandleBuffer)[ChildIndex] == OpenInfo[OpenInfoIndex].AgentHandle) {
907 (*HandleType)[ChildIndex] |= HR_DEVICE_DRIVER;
908 }
909 }
910 }
911 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) == EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {
912 (*HandleType)[HandleIndex] |= HR_PARENT_HANDLE;
913 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {
914 if ((*HandleBuffer)[ChildIndex] == OpenInfo[OpenInfoIndex].AgentHandle) {
915 (*HandleType)[ChildIndex] |= HR_BUS_DRIVER;
916 }
917 }
918 }
919 }
920 }
921
922 FreePool (OpenInfo);
923 }
924 }
925
926 FreePool (ProtocolGuidArray);
927 }
928 }
929
930 if (EFI_ERROR(Status)) {
931 if (*HandleType != NULL) {
932 FreePool (*HandleType);
933 }
934 if (*HandleBuffer != NULL) {
935 FreePool (*HandleBuffer);
936 }
937
938 *HandleCount = 0;
939 *HandleBuffer = NULL;
940 *HandleType = NULL;
941 }
942
943 return Status;
944 }
945
946 /**
947 Gets all the related EFI_HANDLEs based on the single EFI_HANDLE and the mask
948 supplied.
949
950 This function will scan all EFI_HANDLES in the UEFI environment's handle database
951 and return all the ones with the specified relationship (Mask) to the specified
952 controller handle.
953
954 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.
955 If MatchingHandleCount is NULL, then ASSERT.
956
957 If MatchingHandleBuffer is not NULL upon a sucessful return the memory must be
958 caller freed.
959
960 @param[in] DriverBindingHandle Handle to a object with Driver Binding protocol
961 on it.
962 @param[in] ControllerHandle Handle to a device with Device Path protocol on it.
963 @param[in] Mask Mask of what relationship(s) is desired.
964 @param[in] MatchingHandleCount Poitner to UINTN specifying number of HANDLES in
965 MatchingHandleBuffer.
966 @param[out] MatchingHandleBuffer On a sucessful return a buffer of MatchingHandleCount
967 EFI_HANDLEs and a terminating NULL EFI_HANDLE.
968
969 @retval EFI_SUCCESS The operation was sucessful and any related handles
970 are in MatchingHandleBuffer;
971 @retval EFI_NOT_FOUND No matching handles were found.
972 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.
973 **/
974 EFI_STATUS
975 EFIAPI
976 ParseHandleDatabaseByRelationship (
977 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL,
978 IN CONST EFI_HANDLE ControllerHandle OPTIONAL,
979 IN CONST UINTN Mask,
980 IN UINTN *MatchingHandleCount,
981 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL
982 )
983 {
984 EFI_STATUS Status;
985 UINTN HandleCount;
986 EFI_HANDLE *HandleBuffer;
987 UINTN *HandleType;
988 UINTN HandleIndex;
989
990 ASSERT(MatchingHandleCount != NULL);
991 ASSERT(DriverBindingHandle != NULL || ControllerHandle != NULL);
992
993 if ((Mask & HR_VALID_MASK) != Mask) {
994 return (EFI_INVALID_PARAMETER);
995 }
996
997 if ((Mask & HR_CHILD_HANDLE) != 0 && DriverBindingHandle == NULL) {
998 return (EFI_INVALID_PARAMETER);
999 }
1000
1001 *MatchingHandleCount = 0;
1002 if (MatchingHandleBuffer != NULL) {
1003 *MatchingHandleBuffer = NULL;
1004 }
1005
1006 HandleBuffer = NULL;
1007 HandleType = NULL;
1008
1009 Status = ParseHandleDatabaseByRelationshipWithType (
1010 DriverBindingHandle,
1011 ControllerHandle,
1012 &HandleCount,
1013 &HandleBuffer,
1014 &HandleType
1015 );
1016 if (!EFI_ERROR (Status)) {
1017 //
1018 // Count the number of handles that match the attributes in Mask
1019 //
1020 for (HandleIndex = 0; HandleIndex < HandleCount; HandleIndex++) {
1021 if ((HandleType[HandleIndex] & Mask) == Mask) {
1022 (*MatchingHandleCount)++;
1023 }
1024 }
1025 //
1026 // If no handles match the attributes in Mask then return EFI_NOT_FOUND
1027 //
1028 if (*MatchingHandleCount == 0) {
1029 Status = EFI_NOT_FOUND;
1030 } else {
1031
1032 if (MatchingHandleBuffer == NULL) {
1033 //
1034 // Someone just wanted the count...
1035 //
1036 Status = EFI_SUCCESS;
1037 } else {
1038 //
1039 // Allocate a handle buffer for the number of handles that matched the attributes in Mask
1040 //
1041 *MatchingHandleBuffer = AllocatePool ((*MatchingHandleCount +1)* sizeof (EFI_HANDLE));
1042 ASSERT(*MatchingHandleBuffer != NULL);
1043
1044 for (HandleIndex = 0,*MatchingHandleCount = 0
1045 ; HandleIndex < HandleCount
1046 ; HandleIndex++
1047 ){
1048 //
1049 // Fill the allocated buffer with the handles that matched the attributes in Mask
1050 //
1051 if ((HandleType[HandleIndex] & Mask) == Mask) {
1052 (*MatchingHandleBuffer)[(*MatchingHandleCount)++] = HandleBuffer[HandleIndex];
1053 }
1054 }
1055
1056 //
1057 // Make the last one NULL
1058 //
1059 (*MatchingHandleBuffer)[*MatchingHandleCount] = NULL;
1060
1061 Status = EFI_SUCCESS;
1062 } // MacthingHandleBuffer == NULL (ELSE)
1063 } // *MatchingHandleCount == 0 (ELSE)
1064 } // no error on ParseHandleDatabaseByRelationshipWithType
1065
1066 if (HandleBuffer != NULL) {
1067 FreePool (HandleBuffer);
1068 }
1069
1070 if (HandleType != NULL) {
1071 FreePool (HandleType);
1072 }
1073
1074 return Status;
1075 }
1076
1077 /**
1078 Gets handles for any child controllers of the passed in controller.
1079
1080 @param[in] ControllerHandle The handle of the "parent controller"
1081 @param[in] MatchingHandleCount Pointer to the number of handles in
1082 MatchingHandleBuffer on return.
1083 @param[out] MatchingHandleBuffer Buffer containing handles on a successful
1084 return.
1085
1086
1087 @retval EFI_SUCCESS The operation was sucessful.
1088 **/
1089 EFI_STATUS
1090 EFIAPI
1091 ParseHandleDatabaseForChildControllers(
1092 IN CONST EFI_HANDLE ControllerHandle,
1093 IN UINTN *MatchingHandleCount,
1094 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL
1095 )
1096 {
1097 EFI_STATUS Status;
1098 UINTN HandleIndex;
1099 UINTN DriverBindingHandleCount;
1100 EFI_HANDLE *DriverBindingHandleBuffer;
1101 UINTN DriverBindingHandleIndex;
1102 UINTN ChildControllerHandleCount;
1103 EFI_HANDLE *ChildControllerHandleBuffer;
1104 UINTN ChildControllerHandleIndex;
1105 BOOLEAN Found;
1106 EFI_HANDLE *HandleBufferForReturn;
1107
1108 if (MatchingHandleCount == NULL) {
1109 return (EFI_INVALID_PARAMETER);
1110 }
1111
1112 Status = PARSE_HANDLE_DATABASE_UEFI_DRIVERS (
1113 ControllerHandle,
1114 &DriverBindingHandleCount,
1115 &DriverBindingHandleBuffer
1116 );
1117 if (EFI_ERROR (Status)) {
1118 return Status;
1119 }
1120
1121 //
1122 // Get a buffer big enough for all the controllers.
1123 //
1124 HandleBufferForReturn = GetHandleListByProtocol(&gEfiDevicePathProtocolGuid);
1125 if (HandleBufferForReturn == NULL) {
1126 FreePool (DriverBindingHandleBuffer);
1127 return (EFI_NOT_FOUND);
1128 }
1129
1130 *MatchingHandleCount = 0;
1131 for (DriverBindingHandleIndex = 0; DriverBindingHandleIndex < DriverBindingHandleCount; DriverBindingHandleIndex++) {
1132 Status = PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (
1133 DriverBindingHandleBuffer[DriverBindingHandleIndex],
1134 ControllerHandle,
1135 &ChildControllerHandleCount,
1136 &ChildControllerHandleBuffer
1137 );
1138 if (EFI_ERROR (Status)) {
1139 continue;
1140 }
1141
1142 for (ChildControllerHandleIndex = 0;
1143 ChildControllerHandleIndex < ChildControllerHandleCount;
1144 ChildControllerHandleIndex++
1145 ) {
1146 Found = FALSE;
1147 for (HandleIndex = 0; HandleBufferForReturn[HandleIndex] != NULL; HandleIndex++) {
1148 if (HandleBufferForReturn[HandleIndex] == ChildControllerHandleBuffer[ChildControllerHandleIndex]) {
1149 Found = TRUE;
1150 break;
1151 }
1152 }
1153
1154 if (!Found) {
1155 HandleBufferForReturn[(*MatchingHandleCount)++] = ChildControllerHandleBuffer[ChildControllerHandleIndex];
1156 }
1157 }
1158
1159 FreePool (ChildControllerHandleBuffer);
1160 }
1161
1162 FreePool (DriverBindingHandleBuffer);
1163
1164 if (MatchingHandleBuffer != NULL) {
1165 *MatchingHandleBuffer = HandleBufferForReturn;
1166 } else {
1167 FreePool(HandleBufferForReturn);
1168 }
1169
1170 return (EFI_SUCCESS);
1171 }
1172
1173 /**
1174 Appends 1 buffer to another buffer. This will re-allocate the destination buffer
1175 if necessary to fit all of the data.
1176
1177 If DestinationBuffer is NULL, then ASSERT().
1178
1179 @param[in,out] DestinationBuffer The pointer to the pointer to the buffer to append onto.
1180 @param[in,out] DestinationSize The pointer to the size of DestinationBuffer.
1181 @param[in] SourceBuffer The pointer to the buffer to append onto DestinationBuffer.
1182 @param[in] SourceSize The number of bytes of SourceBuffer to append.
1183
1184 @retval NULL A memory allocation failed.
1185 @retval NULL A parameter was invalid.
1186 @return A pointer to (*DestinationBuffer).
1187 **/
1188 VOID*
1189 EFIAPI
1190 BuffernCatGrow (
1191 IN OUT VOID **DestinationBuffer,
1192 IN OUT UINTN *DestinationSize,
1193 IN VOID *SourceBuffer,
1194 IN UINTN SourceSize
1195 )
1196 {
1197 UINTN LocalDestinationSize;
1198 UINTN LocalDestinationFinalSize;
1199
1200 ASSERT(DestinationBuffer != NULL);
1201
1202 if (SourceSize == 0 || SourceBuffer == NULL) {
1203 return (*DestinationBuffer);
1204 }
1205
1206 if (DestinationSize == NULL) {
1207 LocalDestinationSize = 0;
1208 } else {
1209 LocalDestinationSize = *DestinationSize;
1210 }
1211
1212 LocalDestinationFinalSize = LocalDestinationSize + SourceSize;
1213
1214 if (DestinationSize != NULL) {
1215 *DestinationSize = LocalDestinationSize;
1216 }
1217
1218 if (LocalDestinationSize == 0) {
1219 // allcoate
1220 *DestinationBuffer = AllocatePool(LocalDestinationFinalSize);
1221 } else {
1222 // reallocate
1223 *DestinationBuffer = ReallocatePool(LocalDestinationSize, LocalDestinationFinalSize, *DestinationBuffer);
1224 }
1225
1226 ASSERT(*DestinationBuffer != NULL);
1227
1228 // copy
1229 return (CopyMem(((UINT8*)(*DestinationBuffer)) + LocalDestinationSize, SourceBuffer, SourceSize));
1230 }
1231
1232 /**
1233 Gets handles for any child devices produced by the passed in driver.
1234
1235 @param[in] DriverHandle The handle of the driver.
1236 @param[in] MatchingHandleCount Pointer to the number of handles in
1237 MatchingHandleBuffer on return.
1238 @param[out] MatchingHandleBuffer Buffer containing handles on a successful
1239 return.
1240 @retval EFI_SUCCESS The operation was sucessful.
1241 @sa ParseHandleDatabaseByRelationship
1242 **/
1243 EFI_STATUS
1244 EFIAPI
1245 ParseHandleDatabaseForChildDevices(
1246 IN CONST EFI_HANDLE DriverHandle,
1247 IN UINTN *MatchingHandleCount,
1248 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL
1249 )
1250 {
1251 EFI_HANDLE *Buffer;
1252 EFI_HANDLE *Buffer2;
1253 UINTN Count1;
1254 UINTN Count2;
1255 UINTN HandleIndex;
1256 EFI_STATUS Status;
1257 UINTN HandleBufferSize;
1258
1259 ASSERT(MatchingHandleCount != NULL);
1260
1261 HandleBufferSize = 0;
1262 Buffer = NULL;
1263 Buffer2 = NULL;
1264 *MatchingHandleCount = 0;
1265
1266 Status = PARSE_HANDLE_DATABASE_DEVICES (
1267 DriverHandle,
1268 &Count1,
1269 &Buffer
1270 );
1271 if (!EFI_ERROR (Status)) {
1272 for (HandleIndex = 0; HandleIndex < Count1; HandleIndex++) {
1273 //
1274 // now find the children
1275 //
1276 Status = PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (
1277 DriverHandle,
1278 Buffer[HandleIndex],
1279 &Count2,
1280 &Buffer2
1281 );
1282 if (EFI_ERROR(Status)) {
1283 break;
1284 }
1285 //
1286 // save out required and optional data elements
1287 //
1288 *MatchingHandleCount += Count2;
1289 if (MatchingHandleBuffer != NULL) {
1290 *MatchingHandleBuffer = BuffernCatGrow((VOID**)MatchingHandleBuffer, &HandleBufferSize, Buffer2, Count2 * sizeof(Buffer2[0]));
1291 }
1292
1293 //
1294 // free the memory
1295 //
1296 if (Buffer2 != NULL) {
1297 FreePool(Buffer2);
1298 }
1299 }
1300 }
1301
1302 if (Buffer != NULL) {
1303 FreePool(Buffer);
1304 }
1305 return (Status);
1306 }
1307
1308 /**
1309 Function to get all handles that support a given protocol or all handles.
1310
1311 @param[in] ProtocolGuid The guid of the protocol to get handles for. If NULL
1312 then the function will return all handles.
1313
1314 @retval NULL A memory allocation failed.
1315 @return A NULL terminated list of handles.
1316 **/
1317 EFI_HANDLE*
1318 EFIAPI
1319 GetHandleListByProtocol (
1320 IN CONST EFI_GUID *ProtocolGuid OPTIONAL
1321 )
1322 {
1323 EFI_HANDLE *HandleList;
1324 UINTN Size;
1325 EFI_STATUS Status;
1326
1327 Size = 0;
1328 HandleList = NULL;
1329
1330 //
1331 // We cannot use LocateHandleBuffer since we need that NULL item on the ends of the list!
1332 //
1333 if (ProtocolGuid == NULL) {
1334 Status = gBS->LocateHandle(AllHandles, NULL, NULL, &Size, HandleList);
1335 if (Status == EFI_BUFFER_TOO_SMALL) {
1336 HandleList = AllocatePool(Size + sizeof(EFI_HANDLE));
1337 if (HandleList == NULL) {
1338 return (NULL);
1339 }
1340 Status = gBS->LocateHandle(AllHandles, NULL, NULL, &Size, HandleList);
1341 HandleList[Size/sizeof(EFI_HANDLE)] = NULL;
1342 }
1343 } else {
1344 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)ProtocolGuid, NULL, &Size, HandleList);
1345 if (Status == EFI_BUFFER_TOO_SMALL) {
1346 HandleList = AllocatePool(Size + sizeof(EFI_HANDLE));
1347 if (HandleList == NULL) {
1348 return (NULL);
1349 }
1350 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)ProtocolGuid, NULL, &Size, HandleList);
1351 HandleList[Size/sizeof(EFI_HANDLE)] = NULL;
1352 }
1353 }
1354 if (EFI_ERROR(Status)) {
1355 if (HandleList != NULL) {
1356 FreePool(HandleList);
1357 }
1358 return (NULL);
1359 }
1360 return (HandleList);
1361 }
1362
1363 /**
1364 Function to get all handles that support some protocols.
1365
1366 @param[in] ProtocolGuids A NULL terminated list of protocol GUIDs.
1367
1368 @retval NULL A memory allocation failed.
1369 @retval NULL ProtocolGuids was NULL.
1370 @return A NULL terminated list of EFI_HANDLEs.
1371 **/
1372 EFI_HANDLE*
1373 EFIAPI
1374 GetHandleListByProtocolList (
1375 IN CONST EFI_GUID **ProtocolGuids
1376 )
1377 {
1378 EFI_HANDLE *HandleList;
1379 UINTN Size;
1380 UINTN TotalSize;
1381 UINTN TempSize;
1382 EFI_STATUS Status;
1383 CONST EFI_GUID **GuidWalker;
1384 EFI_HANDLE *HandleWalker1;
1385 EFI_HANDLE *HandleWalker2;
1386
1387 Size = 0;
1388 HandleList = NULL;
1389 TotalSize = sizeof(EFI_HANDLE);
1390
1391 for (GuidWalker = ProtocolGuids ; GuidWalker != NULL && *GuidWalker != NULL ; GuidWalker++,Size = 0){
1392 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)(*GuidWalker), NULL, &Size, NULL);
1393 if (Status == EFI_BUFFER_TOO_SMALL) {
1394 TotalSize += Size;
1395 }
1396 }
1397
1398 //
1399 // No handles were found...
1400 //
1401 if (TotalSize == sizeof(EFI_HANDLE)) {
1402 return (NULL);
1403 }
1404
1405 HandleList = AllocateZeroPool(TotalSize);
1406 if (HandleList == NULL) {
1407 return (NULL);
1408 }
1409
1410 Size = 0;
1411 for (GuidWalker = ProtocolGuids ; GuidWalker != NULL && *GuidWalker != NULL ; GuidWalker++){
1412 TempSize = TotalSize - Size;
1413 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)(*GuidWalker), NULL, &TempSize, HandleList+(Size/sizeof(EFI_HANDLE)));
1414
1415 //
1416 // Allow for missing protocols... Only update the 'used' size upon success.
1417 //
1418 if (!EFI_ERROR(Status)) {
1419 Size += TempSize;
1420 }
1421 }
1422 ASSERT(HandleList[(TotalSize/sizeof(EFI_HANDLE))-1] == NULL);
1423
1424 for (HandleWalker1 = HandleList ; HandleWalker1 != NULL && *HandleWalker1 != NULL ; HandleWalker1++) {
1425 for (HandleWalker2 = HandleWalker1 + 1; HandleWalker2 != NULL && *HandleWalker2 != NULL ; HandleWalker2++) {
1426 if (*HandleWalker1 == *HandleWalker2) {
1427 //
1428 // copy memory back 1 handle width.
1429 //
1430 CopyMem(HandleWalker2, HandleWalker2 + 1, TotalSize - ((HandleWalker2-HandleList+1)*sizeof(EFI_HANDLE)));
1431 }
1432 }
1433 }
1434
1435 return (HandleList);
1436 }
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
EFI Development Kit II mirror for PVE