]> git.proxmox.com Git - mirror_edk2.git/blame - ShellPkg/Library/UefiHandleParsingLib/UefiHandleParsingLib.c
Fix a bug in DebugAgent that hang happens when the ACK for GO is lost.
[mirror_edk2.git] / ShellPkg / Library / UefiHandleParsingLib / UefiHandleParsingLib.c
CommitLineData
a405b86d 1/** @file\r
2 Provides interface to advanced shell functionality for parsing both handle and protocol database.\r
3\r
0fb7e718 4 Copyright (c) 2013 - 2014, Hewlett-Packard Development Company, L.P.\r
efb76d1a 5 Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>\r
a405b86d 6 This program and the accompanying materials\r
7 are licensed and made available under the terms and conditions of the BSD License\r
8 which accompanies this distribution. The full text of the license may be found at\r
9 http://opensource.org/licenses/bsd-license.php\r
10\r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16#include "UefiHandleParsingLib.h"\r
f4f3c6bf 17#include "IndustryStandard/Acpi10.h"\r
a405b86d 18\r
e7e0e42b 19EFI_HANDLE mHandleParsingHiiHandle = NULL;\r
a405b86d 20HANDLE_INDEX_LIST mHandleList = {{{NULL,NULL},0,0},0};\r
6306fd90
JC
21GUID_INFO_BLOCK *GuidList;\r
22UINTN GuidListCount;\r
efb76d1a
JC
23/**\r
24 Function to translate the EFI_MEMORY_TYPE into a string.\r
25\r
26 @param[in] Memory The memory type.\r
27\r
28 @retval A string representation of the type allocated from BS Pool.\r
29**/\r
30CHAR16*\r
31EFIAPI\r
32ConvertMemoryType (\r
33 IN CONST EFI_MEMORY_TYPE Memory\r
34 )\r
35{\r
36 CHAR16 *RetVal;\r
37 RetVal = NULL;\r
38\r
39 switch (Memory) {\r
40 case EfiReservedMemoryType: StrnCatGrow(&RetVal, NULL, L"EfiReservedMemoryType", 0); break;\r
41 case EfiLoaderCode: StrnCatGrow(&RetVal, NULL, L"EfiLoaderCode", 0); break;\r
42 case EfiLoaderData: StrnCatGrow(&RetVal, NULL, L"EfiLoaderData", 0); break;\r
43 case EfiBootServicesCode: StrnCatGrow(&RetVal, NULL, L"EfiBootServicesCode", 0); break;\r
44 case EfiBootServicesData: StrnCatGrow(&RetVal, NULL, L"EfiBootServicesData", 0); break;\r
45 case EfiRuntimeServicesCode: StrnCatGrow(&RetVal, NULL, L"EfiRuntimeServicesCode", 0); break;\r
46 case EfiRuntimeServicesData: StrnCatGrow(&RetVal, NULL, L"EfiRuntimeServicesData", 0); break;\r
47 case EfiConventionalMemory: StrnCatGrow(&RetVal, NULL, L"EfiConventionalMemory", 0); break;\r
48 case EfiUnusableMemory: StrnCatGrow(&RetVal, NULL, L"EfiUnusableMemory", 0); break;\r
49 case EfiACPIReclaimMemory: StrnCatGrow(&RetVal, NULL, L"EfiACPIReclaimMemory", 0); break;\r
50 case EfiACPIMemoryNVS: StrnCatGrow(&RetVal, NULL, L"EfiACPIMemoryNVS", 0); break;\r
51 case EfiMemoryMappedIO: StrnCatGrow(&RetVal, NULL, L"EfiMemoryMappedIO", 0); break;\r
52 case EfiMemoryMappedIOPortSpace: StrnCatGrow(&RetVal, NULL, L"EfiMemoryMappedIOPortSpace", 0); break;\r
53 case EfiPalCode: StrnCatGrow(&RetVal, NULL, L"EfiPalCode", 0); break;\r
54 case EfiMaxMemoryType: StrnCatGrow(&RetVal, NULL, L"EfiMaxMemoryType", 0); break;\r
55 default: ASSERT(FALSE);\r
56 }\r
57 return (RetVal);\r
58}\r
59\r
609e0c58
JC
60/**\r
61 Function to translate the EFI_GRAPHICS_PIXEL_FORMAT into a string.\r
62\r
9145d314 63 @param[in] Fmt The format type.\r
609e0c58
JC
64\r
65 @retval A string representation of the type allocated from BS Pool.\r
66**/\r
67CHAR16*\r
68EFIAPI\r
69ConvertPixelFormat (\r
70 IN CONST EFI_GRAPHICS_PIXEL_FORMAT Fmt\r
71 )\r
72{\r
73 CHAR16 *RetVal;\r
74 RetVal = NULL;\r
75\r
76 switch (Fmt) {\r
77 case PixelRedGreenBlueReserved8BitPerColor: StrnCatGrow(&RetVal, NULL, L"PixelRedGreenBlueReserved8BitPerColor", 0); break;\r
78 case PixelBlueGreenRedReserved8BitPerColor: StrnCatGrow(&RetVal, NULL, L"PixelBlueGreenRedReserved8BitPerColor", 0); break;\r
79 case PixelBitMask: StrnCatGrow(&RetVal, NULL, L"PixelBitMask", 0); break;\r
80 case PixelBltOnly: StrnCatGrow(&RetVal, NULL, L"PixelBltOnly", 0); break;\r
81 case PixelFormatMax: StrnCatGrow(&RetVal, NULL, L"PixelFormatMax", 0); break;\r
82 default: ASSERT(FALSE);\r
83 }\r
84 return (RetVal);\r
85}\r
86\r
a405b86d 87/**\r
88 Constructor for the library.\r
89\r
90 @param[in] ImageHandle Ignored.\r
91 @param[in] SystemTable Ignored.\r
92\r
93 @retval EFI_SUCCESS The operation was successful.\r
94**/\r
95EFI_STATUS\r
96EFIAPI\r
97HandleParsingLibConstructor (\r
98 IN EFI_HANDLE ImageHandle,\r
99 IN EFI_SYSTEM_TABLE *SystemTable\r
100 )\r
101{\r
6306fd90
JC
102 GuidListCount = 0;\r
103 GuidList = NULL;\r
104\r
e7e0e42b
CP
105 //\r
106 // Do nothing with mHandleParsingHiiHandle. Initialize HII as needed.\r
107 //\r
108 return (EFI_SUCCESS);\r
109}\r
110\r
111/** \r
112 Initialization function for HII packages.\r
113 \r
114**/\r
115VOID\r
116HandleParsingHiiInit (VOID)\r
117{\r
a405b86d 118 if (mHandleParsingHiiHandle == NULL) {\r
e7e0e42b
CP
119 mHandleParsingHiiHandle = HiiAddPackages (&gHandleParsingHiiGuid, gImageHandle, UefiHandleParsingLibStrings, NULL);\r
120 ASSERT (mHandleParsingHiiHandle != NULL);\r
a405b86d 121 }\r
a405b86d 122}\r
123\r
124/**\r
125 Destructor for the library. free any resources.\r
126\r
127 @param[in] ImageHandle Ignored.\r
128 @param[in] SystemTable Ignored.\r
129\r
130 @retval EFI_SUCCESS The operation was successful.\r
131**/\r
132EFI_STATUS\r
133EFIAPI\r
134HandleParsingLibDestructor (\r
135 IN EFI_HANDLE ImageHandle,\r
136 IN EFI_SYSTEM_TABLE *SystemTable\r
137 )\r
138{\r
6306fd90
JC
139 UINTN LoopCount;\r
140\r
141 for (LoopCount = 0; GuidList != NULL && LoopCount < GuidListCount; LoopCount++) {\r
142 SHELL_FREE_NON_NULL(GuidList[LoopCount].GuidId);\r
143 }\r
144\r
145 SHELL_FREE_NON_NULL(GuidList);\r
a405b86d 146 if (mHandleParsingHiiHandle != NULL) {\r
147 HiiRemovePackages(mHandleParsingHiiHandle);\r
148 }\r
149 return (EFI_SUCCESS);\r
150}\r
151\r
efb76d1a
JC
152/**\r
153 Function to dump information about LoadedImage.\r
154\r
155 This will allocate the return buffer from boot services pool.\r
156\r
157 @param[in] TheHandle The handle that has LoadedImage installed.\r
158 @param[in] Verbose TRUE for additional information, FALSE otherwise.\r
159\r
160 @retval A poitner to a string containing the information.\r
161**/\r
a405b86d 162CHAR16*\r
163EFIAPI\r
164LoadedImageProtocolDumpInformation(\r
165 IN CONST EFI_HANDLE TheHandle,\r
166 IN CONST BOOLEAN Verbose\r
167 )\r
168{\r
efb76d1a 169 EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;\r
a405b86d 170 EFI_STATUS Status;\r
efb76d1a
JC
171 CHAR16 *RetVal;\r
172 CHAR16 *Temp;\r
173 CHAR16 *CodeType;\r
174 CHAR16 *DataType;\r
a405b86d 175\r
efb76d1a
JC
176 if (!Verbose) {\r
177 return (CatSPrint(NULL, L"LoadedImage"));\r
a405b86d 178 }\r
179\r
e7e0e42b
CP
180 HandleParsingHiiInit();\r
181\r
efb76d1a
JC
182 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_LI_DUMP_MAIN), NULL);\r
183 RetVal = AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize));\r
184 if (Temp == NULL || RetVal == NULL) {\r
185 SHELL_FREE_NON_NULL(Temp);\r
186 SHELL_FREE_NON_NULL(RetVal);\r
187 return NULL;\r
a405b86d 188 }\r
189\r
efb76d1a
JC
190 Status = gBS->OpenProtocol (\r
191 TheHandle,\r
192 &gEfiLoadedImageProtocolGuid,\r
193 (VOID**)&LoadedImage,\r
194 gImageHandle,\r
195 NULL,\r
196 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
197 );\r
198\r
5f119dfc
HL
199 if (EFI_ERROR (Status)) {\r
200 SHELL_FREE_NON_NULL (Temp);\r
201 SHELL_FREE_NON_NULL (RetVal);\r
202 return NULL;\r
203 }\r
204\r
efb76d1a
JC
205 DataType = ConvertMemoryType(LoadedImage->ImageDataType);\r
206 CodeType = ConvertMemoryType(LoadedImage->ImageCodeType);\r
207\r
208 RetVal = CatSPrint(RetVal,\r
209 Temp,\r
210 LoadedImage->Revision,\r
211 LoadedImage->ParentHandle,\r
212 LoadedImage->SystemTable,\r
213 LoadedImage->DeviceHandle,\r
214 LoadedImage->FilePath,\r
215 LoadedImage->LoadOptionsSize,\r
216 LoadedImage->LoadOptions,\r
217 LoadedImage->ImageBase,\r
218 LoadedImage->ImageSize,\r
219 CodeType,\r
220 DataType,\r
221 LoadedImage->Unload);\r
222\r
223 \r
224 SHELL_FREE_NON_NULL(Temp);\r
225 SHELL_FREE_NON_NULL(CodeType);\r
226 SHELL_FREE_NON_NULL(DataType);\r
227\r
228 return RetVal;\r
a405b86d 229}\r
a405b86d 230\r
609e0c58
JC
231/**\r
232 Function to dump information about GOP.\r
233\r
234 This will allocate the return buffer from boot services pool.\r
235\r
236 @param[in] TheHandle The handle that has LoadedImage installed.\r
237 @param[in] Verbose TRUE for additional information, FALSE otherwise.\r
238\r
239 @retval A poitner to a string containing the information.\r
240**/\r
241CHAR16*\r
242EFIAPI\r
243GraphicsOutputProtocolDumpInformation(\r
244 IN CONST EFI_HANDLE TheHandle,\r
245 IN CONST BOOLEAN Verbose\r
246 )\r
247{\r
248 EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;\r
249 EFI_STATUS Status;\r
250 CHAR16 *RetVal;\r
251 CHAR16 *Temp;\r
252 CHAR16 *Fmt;\r
253\r
254 if (!Verbose) {\r
255 return (CatSPrint(NULL, L"GraphicsOutput"));\r
256 }\r
257\r
e7e0e42b
CP
258 HandleParsingHiiInit();\r
259\r
609e0c58
JC
260 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_GOP_DUMP_MAIN), NULL);\r
261 RetVal = AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize));\r
262 if (Temp == NULL || RetVal == NULL) {\r
263 SHELL_FREE_NON_NULL(Temp);\r
264 SHELL_FREE_NON_NULL(RetVal);\r
265 return NULL;\r
266 }\r
267\r
268 Status = gBS->OpenProtocol (\r
269 TheHandle,\r
270 &gEfiGraphicsOutputProtocolGuid,\r
271 (VOID**)&GraphicsOutput,\r
272 gImageHandle,\r
273 NULL,\r
274 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
275 );\r
276\r
277 if (EFI_ERROR (Status)) {\r
278 SHELL_FREE_NON_NULL (Temp);\r
279 SHELL_FREE_NON_NULL (RetVal);\r
280 return NULL;\r
281 }\r
282\r
283 Fmt = ConvertPixelFormat(GraphicsOutput->Mode->Info->PixelFormat);\r
284\r
285 RetVal = CatSPrint(RetVal,\r
286 Temp,\r
287 GraphicsOutput->Mode->MaxMode,\r
288 GraphicsOutput->Mode->Mode,\r
289 GraphicsOutput->Mode->FrameBufferBase,\r
290 (UINT64)GraphicsOutput->Mode->FrameBufferSize,\r
291 (UINT64)GraphicsOutput->Mode->SizeOfInfo,\r
292 GraphicsOutput->Mode->Info->Version,\r
293 GraphicsOutput->Mode->Info->HorizontalResolution,\r
294 GraphicsOutput->Mode->Info->VerticalResolution,\r
295 Fmt,\r
296 GraphicsOutput->Mode->Info->PixelsPerScanLine,\r
297 GraphicsOutput->Mode->Info->PixelFormat!=PixelBitMask?0:GraphicsOutput->Mode->Info->PixelInformation.RedMask,\r
298 GraphicsOutput->Mode->Info->PixelFormat!=PixelBitMask?0:GraphicsOutput->Mode->Info->PixelInformation.GreenMask,\r
299 GraphicsOutput->Mode->Info->PixelFormat!=PixelBitMask?0:GraphicsOutput->Mode->Info->PixelInformation.BlueMask\r
300 );\r
301 \r
302 SHELL_FREE_NON_NULL(Temp);\r
303 SHELL_FREE_NON_NULL(Fmt);\r
304\r
305 return RetVal;\r
306}\r
307\r
f4f3c6bf 308/**\r
309 Function to dump information about PciRootBridgeIo.\r
310\r
311 This will allocate the return buffer from boot services pool.\r
312\r
313 @param[in] TheHandle The handle that has PciRootBridgeIo installed.\r
314 @param[in] Verbose TRUE for additional information, FALSE otherwise.\r
315\r
316 @retval A poitner to a string containing the information.\r
317**/\r
318CHAR16*\r
319EFIAPI\r
320PciRootBridgeIoDumpInformation(\r
321 IN CONST EFI_HANDLE TheHandle,\r
322 IN CONST BOOLEAN Verbose\r
323 )\r
324{\r
325 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *PciRootBridgeIo;\r
326 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *Configuration;\r
327 UINT64 Supports;\r
328 UINT64 Attributes;\r
329 CHAR16 *Temp;\r
330 CHAR16 *Temp2;\r
331 CHAR16 *RetVal;\r
332 EFI_STATUS Status;\r
333\r
334 RetVal = NULL;\r
335\r
336 if (!Verbose) {\r
337 return (CatSPrint(NULL, L"PciRootBridgeIo"));\r
338 }\r
339\r
e7e0e42b
CP
340 HandleParsingHiiInit();\r
341\r
f4f3c6bf 342 Status = gBS->HandleProtocol(\r
343 TheHandle,\r
344 &gEfiPciRootBridgeIoProtocolGuid,\r
345 (VOID**)&PciRootBridgeIo);\r
346\r
347 if (EFI_ERROR(Status)) {\r
348 return NULL;\r
349 }\r
350\r
351 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_PH), NULL);\r
8d300003 352 ASSERT (Temp != NULL);\r
f4f3c6bf 353 Temp2 = CatSPrint(L"\r\n", Temp, PciRootBridgeIo->ParentHandle);\r
354 FreePool(Temp);\r
355 RetVal = Temp2;\r
356 Temp2 = NULL;\r
357 \r
358 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_SEG), NULL);\r
8d300003 359 ASSERT (Temp != NULL);\r
f4f3c6bf 360 Temp2 = CatSPrint(RetVal, Temp, PciRootBridgeIo->SegmentNumber);\r
361 FreePool(Temp);\r
362 FreePool(RetVal);\r
363 RetVal = Temp2;\r
364 Temp2 = NULL;\r
365\r
366 Supports = 0;\r
367 Attributes = 0;\r
368 Status = PciRootBridgeIo->GetAttributes (PciRootBridgeIo, &Supports, &Attributes);\r
369 if (!EFI_ERROR(Status)) {\r
370 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_ATT), NULL);\r
8d300003 371 ASSERT (Temp != NULL); \r
f4f3c6bf 372 Temp2 = CatSPrint(RetVal, Temp, Attributes);\r
373 FreePool(Temp);\r
374 FreePool(RetVal);\r
375 RetVal = Temp2;\r
376 Temp2 = NULL;\r
377 \r
378 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_SUPPORTS), NULL);\r
8d300003 379 ASSERT (Temp != NULL);\r
f4f3c6bf 380 Temp2 = CatSPrint(RetVal, Temp, Supports);\r
381 FreePool(Temp);\r
382 FreePool(RetVal);\r
383 RetVal = Temp2;\r
384 Temp2 = NULL;\r
385 }\r
386\r
387 Configuration = NULL;\r
388 Status = PciRootBridgeIo->Configuration (PciRootBridgeIo, (VOID **) &Configuration);\r
389 if (!EFI_ERROR(Status) && Configuration != NULL) {\r
390 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_TITLE), NULL);\r
8d300003 391 ASSERT (Temp != NULL);\r
f4f3c6bf 392 Temp2 = CatSPrint(RetVal, Temp, Supports);\r
393 FreePool(Temp);\r
394 FreePool(RetVal);\r
395 RetVal = Temp2;\r
396 Temp2 = NULL;\r
397 while (Configuration->Desc == ACPI_ADDRESS_SPACE_DESCRIPTOR) {\r
398 Temp = NULL;\r
399 switch (Configuration->ResType) {\r
400 case ACPI_ADDRESS_SPACE_TYPE_MEM:\r
401 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_MEM), NULL);\r
402 break;\r
403 case ACPI_ADDRESS_SPACE_TYPE_IO:\r
404 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_IO), NULL);\r
405 break;\r
406 case ACPI_ADDRESS_SPACE_TYPE_BUS:\r
407 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_BUS), NULL);\r
408 break;\r
409 }\r
410 if (Temp != NULL) {\r
411 Temp2 = CatSPrint(RetVal, L"%s", Temp);\r
412 FreePool(Temp);\r
413 FreePool(RetVal);\r
414 RetVal = Temp2;\r
415 Temp2 = NULL;\r
416 }\r
417\r
418 Temp2 = CatSPrint(RetVal, \r
419 L"%H%02x %016lx %016lx %02x%N\r\n",\r
420 Configuration->SpecificFlag,\r
421 Configuration->AddrRangeMin,\r
422 Configuration->AddrRangeMax,\r
423 Configuration->AddrSpaceGranularity\r
424 );\r
425 FreePool(RetVal);\r
426 RetVal = Temp2;\r
427 Temp2 = NULL;\r
428 Configuration++;\r
429 }\r
430 }\r
431 return (RetVal);\r
432}\r
433\r
a405b86d 434/**\r
435 Function to dump information about SimpleTextOut.\r
436\r
437 This will allocate the return buffer from boot services pool.\r
438\r
439 @param[in] TheHandle The handle that has SimpleTextOut installed.\r
440 @param[in] Verbose TRUE for additional information, FALSE otherwise.\r
441\r
442 @retval A poitner to a string containing the information.\r
443**/\r
444CHAR16*\r
445EFIAPI\r
446TxtOutProtocolDumpInformation(\r
447 IN CONST EFI_HANDLE TheHandle,\r
448 IN CONST BOOLEAN Verbose\r
449 )\r
450{\r
451 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *Dev;\r
452 INTN Index;\r
453 UINTN Col;\r
454 UINTN Row;\r
455 EFI_STATUS Status;\r
456 CHAR16 *RetVal;\r
457 UINTN Size;\r
458 CHAR16 *Temp;\r
459 UINTN NewSize;\r
460\r
461 if (!Verbose) {\r
462 return (NULL);\r
463 }\r
464\r
e7e0e42b
CP
465 HandleParsingHiiInit();\r
466\r
a405b86d 467 RetVal = NULL;\r
468 Size = 0;\r
469\r
470 Status = gBS->HandleProtocol(\r
471 TheHandle,\r
472 &gEfiSimpleTextOutProtocolGuid,\r
473 (VOID**)&Dev);\r
474\r
475 ASSERT_EFI_ERROR(Status);\r
476 ASSERT (Dev != NULL && Dev->Mode != NULL);\r
477\r
478 Size = (Dev->Mode->MaxMode + 1) * 80;\r
479 RetVal = AllocateZeroPool(Size);\r
480\r
481 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_TXT_OUT_DUMP_HEADER), NULL);\r
ecae5117 482 if (Temp != NULL) {\r
483 UnicodeSPrint(RetVal, Size, Temp, Dev, Dev->Mode->Attribute);\r
484 FreePool(Temp);\r
485 }\r
a405b86d 486\r
487 //\r
488 // Dump TextOut Info\r
489 //\r
490 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_TXT_OUT_DUMP_LINE), NULL);\r
491 for (Index = 0; Index < Dev->Mode->MaxMode; Index++) {\r
492 Status = Dev->QueryMode (Dev, Index, &Col, &Row);\r
493 NewSize = Size - StrSize(RetVal);\r
494 UnicodeSPrint(\r
495 RetVal + StrLen(RetVal),\r
496 NewSize,\r
ecae5117 497 Temp == NULL?L"":Temp,\r
a405b86d 498 Index == Dev->Mode->Mode ? L'*' : L' ',\r
499 Index,\r
28981267 500 !EFI_ERROR(Status)?(INTN)Col:-1,\r
501 !EFI_ERROR(Status)?(INTN)Row:-1\r
a405b86d 502 );\r
503 }\r
504 FreePool(Temp);\r
505 return (RetVal);\r
506}\r
507\r
508STATIC CONST UINTN VersionStringSize = 60;\r
509\r
510/**\r
511 Function to dump information about EfiDriverSupportedEfiVersion protocol.\r
512\r
513 This will allocate the return buffer from boot services pool.\r
514\r
515 @param[in] TheHandle The handle that has the protocol installed.\r
516 @param[in] Verbose TRUE for additional information, FALSE otherwise.\r
517\r
518 @retval A poitner to a string containing the information.\r
519**/\r
520CHAR16*\r
521EFIAPI\r
522DriverEfiVersionProtocolDumpInformation(\r
523 IN CONST EFI_HANDLE TheHandle,\r
524 IN CONST BOOLEAN Verbose\r
525 )\r
526{\r
527 EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL *DriverEfiVersion;\r
528 EFI_STATUS Status;\r
529 CHAR16 *RetVal;\r
530\r
531 Status = gBS->HandleProtocol(\r
532 TheHandle,\r
533 &gEfiDriverSupportedEfiVersionProtocolGuid,\r
534 (VOID**)&DriverEfiVersion);\r
535\r
536 ASSERT_EFI_ERROR(Status);\r
537\r
78ed876b 538 RetVal = AllocateZeroPool(VersionStringSize);\r
a405b86d 539 ASSERT(RetVal != NULL);\r
540 UnicodeSPrint(RetVal, VersionStringSize, L"0x%08x", DriverEfiVersion->FirmwareVersion);\r
541 return (RetVal);\r
542}\r
543\r
544/**\r
545 Function to dump information about DevicePath protocol.\r
546\r
547 This will allocate the return buffer from boot services pool.\r
548\r
549 @param[in] TheHandle The handle that has the protocol installed.\r
550 @param[in] Verbose TRUE for additional information, FALSE otherwise.\r
551\r
552 @retval A poitner to a string containing the information.\r
553**/\r
554CHAR16*\r
555EFIAPI\r
556DevicePathProtocolDumpInformation(\r
557 IN CONST EFI_HANDLE TheHandle,\r
558 IN CONST BOOLEAN Verbose\r
559 )\r
560{\r
561 EFI_DEVICE_PATH_PROTOCOL *DevPath;\r
562 CHAR16 *Temp;\r
563 CHAR16 *Temp2;\r
564 EFI_STATUS Status;\r
a405b86d 565 Temp = NULL;\r
566\r
863986b3 567 Status = gBS->OpenProtocol(TheHandle, &gEfiDevicePathProtocolGuid, (VOID**)&DevPath, gImageHandle, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
a405b86d 568 if (!EFI_ERROR(Status)) {\r
863986b3
RN
569 //\r
570 // I cannot decide whether to allow shortcuts here (the second BOOLEAN on the next line)\r
571 //\r
572 Temp = ConvertDevicePathToText(DevPath, TRUE, TRUE);\r
573 gBS->CloseProtocol(TheHandle, &gEfiDevicePathProtocolGuid, gImageHandle, NULL);\r
a405b86d 574 }\r
78ed876b 575 if (!Verbose && Temp != NULL && StrLen(Temp) > 30) {\r
a405b86d 576 Temp2 = NULL;\r
577 Temp2 = StrnCatGrow(&Temp2, NULL, Temp+(StrLen(Temp) - 30), 30);\r
578 FreePool(Temp);\r
579 Temp = Temp2;\r
580 }\r
581 return (Temp);\r
582}\r
583\r
584//\r
585// Put the information on the NT32 protocol GUIDs here so we are not dependant on the Nt32Pkg\r
586//\r
587#define LOCAL_EFI_WIN_NT_THUNK_PROTOCOL_GUID \\r
588 { \\r
ce68d3bc 589 0x58c518b1, 0x76f3, 0x11d4, { 0xbc, 0xea, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
a405b86d 590 }\r
591\r
592#define LOCAL_EFI_WIN_NT_BUS_DRIVER_IO_PROTOCOL_GUID \\r
593 { \\r
ce68d3bc 594 0x96eb4ad6, 0xa32a, 0x11d4, { 0xbc, 0xfd, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
a405b86d 595 }\r
596\r
597#define LOCAL_EFI_WIN_NT_SERIAL_PORT_GUID \\r
598 { \\r
ce68d3bc 599 0xc95a93d, 0xa006, 0x11d4, { 0xbc, 0xfa, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
a405b86d 600 }\r
601STATIC CONST EFI_GUID WinNtThunkProtocolGuid = LOCAL_EFI_WIN_NT_THUNK_PROTOCOL_GUID;\r
602STATIC CONST EFI_GUID WinNtIoProtocolGuid = LOCAL_EFI_WIN_NT_BUS_DRIVER_IO_PROTOCOL_GUID;\r
603STATIC CONST EFI_GUID WinNtSerialPortGuid = LOCAL_EFI_WIN_NT_SERIAL_PORT_GUID;\r
604\r
dee34318 605STATIC CONST GUID_INFO_BLOCK mGuidStringListNT[] = {\r
a405b86d 606 {STRING_TOKEN(STR_WINNT_THUNK), (EFI_GUID*)&WinNtThunkProtocolGuid, NULL},\r
607 {STRING_TOKEN(STR_WINNT_DRIVER_IO), (EFI_GUID*)&WinNtIoProtocolGuid, NULL},\r
608 {STRING_TOKEN(STR_WINNT_SERIAL_PORT), (EFI_GUID*)&WinNtSerialPortGuid, NULL},\r
609 {STRING_TOKEN(STR_UNKNOWN_DEVICE), NULL, NULL},\r
610};\r
611\r
dee34318 612STATIC CONST GUID_INFO_BLOCK mGuidStringList[] = {\r
efb76d1a 613 {STRING_TOKEN(STR_LOADED_IMAGE), &gEfiLoadedImageProtocolGuid, LoadedImageProtocolDumpInformation},\r
a405b86d 614 {STRING_TOKEN(STR_DEVICE_PATH), &gEfiDevicePathProtocolGuid, DevicePathProtocolDumpInformation},\r
615 {STRING_TOKEN(STR_IMAGE_PATH), &gEfiLoadedImageDevicePathProtocolGuid, DevicePathProtocolDumpInformation},\r
616 {STRING_TOKEN(STR_DEVICE_PATH_UTIL), &gEfiDevicePathUtilitiesProtocolGuid, NULL},\r
617 {STRING_TOKEN(STR_DEVICE_PATH_TXT), &gEfiDevicePathToTextProtocolGuid, NULL},\r
618 {STRING_TOKEN(STR_DEVICE_PATH_FTXT), &gEfiDevicePathFromTextProtocolGuid, NULL},\r
619 {STRING_TOKEN(STR_DEVICE_PATH_PC), &gEfiPcAnsiGuid, NULL},\r
620 {STRING_TOKEN(STR_DEVICE_PATH_VT100), &gEfiVT100Guid, NULL},\r
621 {STRING_TOKEN(STR_DEVICE_PATH_VT100P), &gEfiVT100PlusGuid, NULL},\r
622 {STRING_TOKEN(STR_DEVICE_PATH_VTUTF8), &gEfiVTUTF8Guid, NULL},\r
623 {STRING_TOKEN(STR_DRIVER_BINDING), &gEfiDriverBindingProtocolGuid, NULL},\r
624 {STRING_TOKEN(STR_PLATFORM_OVERRIDE), &gEfiPlatformDriverOverrideProtocolGuid, NULL},\r
625 {STRING_TOKEN(STR_BUS_OVERRIDE), &gEfiBusSpecificDriverOverrideProtocolGuid, NULL},\r
626 {STRING_TOKEN(STR_DRIVER_DIAG), &gEfiDriverDiagnosticsProtocolGuid, NULL},\r
627 {STRING_TOKEN(STR_DRIVER_DIAG2), &gEfiDriverDiagnostics2ProtocolGuid, NULL},\r
628 {STRING_TOKEN(STR_DRIVER_CN), &gEfiComponentNameProtocolGuid, NULL},\r
629 {STRING_TOKEN(STR_DRIVER_CN2), &gEfiComponentName2ProtocolGuid, NULL},\r
630 {STRING_TOKEN(STR_PLAT_DRV_CFG), &gEfiPlatformToDriverConfigurationProtocolGuid, NULL},\r
631 {STRING_TOKEN(STR_DRIVER_VERSION), &gEfiDriverSupportedEfiVersionProtocolGuid, DriverEfiVersionProtocolDumpInformation},\r
632 {STRING_TOKEN(STR_TXT_IN), &gEfiSimpleTextInProtocolGuid, NULL},\r
633 {STRING_TOKEN(STR_TXT_IN_EX), &gEfiSimpleTextInputExProtocolGuid, NULL},\r
634 {STRING_TOKEN(STR_TXT_OUT), &gEfiSimpleTextOutProtocolGuid, TxtOutProtocolDumpInformation},\r
635 {STRING_TOKEN(STR_SIM_POINTER), &gEfiSimplePointerProtocolGuid, NULL},\r
636 {STRING_TOKEN(STR_ABS_POINTER), &gEfiAbsolutePointerProtocolGuid, NULL},\r
637 {STRING_TOKEN(STR_SERIAL_IO), &gEfiSerialIoProtocolGuid, NULL},\r
609e0c58 638 {STRING_TOKEN(STR_GRAPHICS_OUTPUT), &gEfiGraphicsOutputProtocolGuid, GraphicsOutputProtocolDumpInformation},\r
a405b86d 639 {STRING_TOKEN(STR_EDID_DISCOVERED), &gEfiEdidDiscoveredProtocolGuid, NULL},\r
640 {STRING_TOKEN(STR_EDID_ACTIVE), &gEfiEdidActiveProtocolGuid, NULL},\r
641 {STRING_TOKEN(STR_EDID_OVERRIDE), &gEfiEdidOverrideProtocolGuid, NULL},\r
642 {STRING_TOKEN(STR_CON_IN), &gEfiConsoleInDeviceGuid, NULL},\r
643 {STRING_TOKEN(STR_CON_OUT), &gEfiConsoleOutDeviceGuid, NULL},\r
644 {STRING_TOKEN(STR_STD_ERR), &gEfiStandardErrorDeviceGuid, NULL},\r
645 {STRING_TOKEN(STR_LOAD_FILE), &gEfiLoadFileProtocolGuid, NULL},\r
646 {STRING_TOKEN(STR_LOAD_FILE2), &gEfiLoadFile2ProtocolGuid, NULL},\r
647 {STRING_TOKEN(STR_SIMPLE_FILE_SYS), &gEfiSimpleFileSystemProtocolGuid, NULL},\r
a405b86d 648 {STRING_TOKEN(STR_TAPE_IO), &gEfiTapeIoProtocolGuid, NULL},\r
649 {STRING_TOKEN(STR_DISK_IO), &gEfiDiskIoProtocolGuid, NULL},\r
650 {STRING_TOKEN(STR_BLK_IO), &gEfiBlockIoProtocolGuid, NULL},\r
651 {STRING_TOKEN(STR_UC), &gEfiUnicodeCollationProtocolGuid, NULL},\r
652 {STRING_TOKEN(STR_UC2), &gEfiUnicodeCollation2ProtocolGuid, NULL},\r
f4f3c6bf 653 {STRING_TOKEN(STR_PCIRB_IO), &gEfiPciRootBridgeIoProtocolGuid, PciRootBridgeIoDumpInformation},\r
a405b86d 654 {STRING_TOKEN(STR_PCI_IO), &gEfiPciIoProtocolGuid, NULL},\r
655 {STRING_TOKEN(STR_SCSI_PT), &gEfiScsiPassThruProtocolGuid, NULL},\r
656 {STRING_TOKEN(STR_SCSI_IO), &gEfiScsiIoProtocolGuid, NULL},\r
657 {STRING_TOKEN(STR_SCSI_PT_EXT), &gEfiExtScsiPassThruProtocolGuid, NULL},\r
658 {STRING_TOKEN(STR_ISCSI), &gEfiIScsiInitiatorNameProtocolGuid, NULL},\r
659 {STRING_TOKEN(STR_USB_IO), &gEfiUsbIoProtocolGuid, NULL},\r
660 {STRING_TOKEN(STR_USB_HC), &gEfiUsbHcProtocolGuid, NULL},\r
661 {STRING_TOKEN(STR_USB_HC2), &gEfiUsb2HcProtocolGuid, NULL},\r
662 {STRING_TOKEN(STR_DEBUG_SUPPORT), &gEfiDebugSupportProtocolGuid, NULL},\r
663 {STRING_TOKEN(STR_DEBUG_PORT), &gEfiDebugPortProtocolGuid, NULL},\r
664 {STRING_TOKEN(STR_DECOMPRESS), &gEfiDecompressProtocolGuid, NULL},\r
665 {STRING_TOKEN(STR_ACPI_TABLE), &gEfiAcpiTableProtocolGuid, NULL},\r
666 {STRING_TOKEN(STR_EBC_INTERPRETER), &gEfiEbcProtocolGuid, NULL},\r
667 {STRING_TOKEN(STR_SNP), &gEfiSimpleNetworkProtocolGuid, NULL},\r
668 {STRING_TOKEN(STR_NII), &gEfiNetworkInterfaceIdentifierProtocolGuid, NULL},\r
669 {STRING_TOKEN(STR_NII_31), &gEfiNetworkInterfaceIdentifierProtocolGuid_31, NULL},\r
670 {STRING_TOKEN(STR_PXE_BC), &gEfiPxeBaseCodeProtocolGuid, NULL},\r
671 {STRING_TOKEN(STR_PXE_CB), &gEfiPxeBaseCodeCallbackProtocolGuid, NULL},\r
672 {STRING_TOKEN(STR_BIS), &gEfiBisProtocolGuid, NULL},\r
673 {STRING_TOKEN(STR_MNP_SB), &gEfiManagedNetworkServiceBindingProtocolGuid, NULL},\r
674 {STRING_TOKEN(STR_MNP), &gEfiManagedNetworkProtocolGuid, NULL},\r
675 {STRING_TOKEN(STR_ARP_SB), &gEfiArpServiceBindingProtocolGuid, NULL},\r
676 {STRING_TOKEN(STR_ARP), &gEfiArpProtocolGuid, NULL},\r
677 {STRING_TOKEN(STR_DHCPV4_SB), &gEfiDhcp4ServiceBindingProtocolGuid, NULL},\r
678 {STRING_TOKEN(STR_DHCPV4), &gEfiDhcp4ProtocolGuid, NULL},\r
679 {STRING_TOKEN(STR_TCPV4_SB), &gEfiTcp4ServiceBindingProtocolGuid, NULL},\r
680 {STRING_TOKEN(STR_TCPV4), &gEfiTcp4ProtocolGuid, NULL},\r
681 {STRING_TOKEN(STR_IPV4_SB), &gEfiIp4ServiceBindingProtocolGuid, NULL},\r
682 {STRING_TOKEN(STR_IPV4), &gEfiIp4ProtocolGuid, NULL},\r
683 {STRING_TOKEN(STR_IPV4_CFG), &gEfiIp4ConfigProtocolGuid, NULL},\r
a405b86d 684 {STRING_TOKEN(STR_UDPV4_SB), &gEfiUdp4ServiceBindingProtocolGuid, NULL},\r
685 {STRING_TOKEN(STR_UDPV4), &gEfiUdp4ProtocolGuid, NULL},\r
686 {STRING_TOKEN(STR_MTFTPV4_SB), &gEfiMtftp4ServiceBindingProtocolGuid, NULL},\r
687 {STRING_TOKEN(STR_MTFTPV4), &gEfiMtftp4ProtocolGuid, NULL},\r
688 {STRING_TOKEN(STR_AUTH_INFO), &gEfiAuthenticationInfoProtocolGuid, NULL},\r
689 {STRING_TOKEN(STR_HASH_SB), &gEfiHashServiceBindingProtocolGuid, NULL},\r
690 {STRING_TOKEN(STR_HASH), &gEfiHashProtocolGuid, NULL},\r
691 {STRING_TOKEN(STR_HII_FONT), &gEfiHiiFontProtocolGuid, NULL},\r
692 {STRING_TOKEN(STR_HII_STRING), &gEfiHiiStringProtocolGuid, NULL},\r
693 {STRING_TOKEN(STR_HII_IMAGE), &gEfiHiiImageProtocolGuid, NULL},\r
694 {STRING_TOKEN(STR_HII_DATABASE), &gEfiHiiDatabaseProtocolGuid, NULL},\r
695 {STRING_TOKEN(STR_HII_CONFIG_ROUT), &gEfiHiiConfigRoutingProtocolGuid, NULL},\r
696 {STRING_TOKEN(STR_HII_CONFIG_ACC), &gEfiHiiConfigAccessProtocolGuid, NULL},\r
697 {STRING_TOKEN(STR_HII_FORM_BROWSER2), &gEfiFormBrowser2ProtocolGuid, NULL},\r
dee34318 698 {STRING_TOKEN(STR_DRIVER_FAM_OVERRIDE), &gEfiDriverFamilyOverrideProtocolGuid, NULL},\r
699 {STRING_TOKEN(STR_PCD), &gPcdProtocolGuid, NULL},\r
700 {STRING_TOKEN(STR_TCG), &gEfiTcgProtocolGuid, NULL},\r
701 {STRING_TOKEN(STR_HII_PACKAGE_LIST), &gEfiHiiPackageListProtocolGuid, NULL},\r
702\r
703//\r
704// the ones under this are deprecated by the current UEFI Spec, but may be found anyways...\r
705//\r
a405b86d 706 {STRING_TOKEN(STR_SHELL_INTERFACE), &gEfiShellInterfaceGuid, NULL},\r
707 {STRING_TOKEN(STR_SHELL_ENV2), &gEfiShellEnvironment2Guid, NULL},\r
708 {STRING_TOKEN(STR_SHELL_ENV), &gEfiShellEnvironment2Guid, NULL},\r
709 {STRING_TOKEN(STR_DEVICE_IO), &gEfiDeviceIoProtocolGuid, NULL},\r
710 {STRING_TOKEN(STR_UGA_DRAW), &gEfiUgaDrawProtocolGuid, NULL},\r
711 {STRING_TOKEN(STR_UGA_IO), &gEfiUgaIoProtocolGuid, NULL},\r
712 {STRING_TOKEN(STR_ESP), &gEfiPartTypeSystemPartGuid, NULL},\r
713 {STRING_TOKEN(STR_GPT_NBR), &gEfiPartTypeLegacyMbrGuid, NULL},\r
714 {STRING_TOKEN(STR_DRIVER_CONFIG), &gEfiDriverConfigurationProtocolGuid, NULL},\r
715 {STRING_TOKEN(STR_DRIVER_CONFIG2), &gEfiDriverConfiguration2ProtocolGuid, NULL},\r
dee34318 716\r
717//\r
718// the ones under this are GUID identified structs, not protocols\r
719//\r
720 {STRING_TOKEN(STR_FILE_INFO), &gEfiFileInfoGuid, NULL},\r
721 {STRING_TOKEN(STR_FILE_SYS_INFO), &gEfiFileSystemInfoGuid, NULL},\r
722\r
723//\r
724// the ones under this are misc GUIDS.\r
725//\r
726 {STRING_TOKEN(STR_EFI_GLOBAL_VARIABLE), &gEfiGlobalVariableGuid, NULL},\r
727\r
728//\r
729// UEFI 2.2\r
730//\r
731 {STRING_TOKEN(STR_IP6_SB), &gEfiIp6ServiceBindingProtocolGuid, NULL},\r
732 {STRING_TOKEN(STR_IP6), &gEfiIp6ProtocolGuid, NULL},\r
733 {STRING_TOKEN(STR_IP6_CONFIG), &gEfiIp6ConfigProtocolGuid, NULL},\r
734 {STRING_TOKEN(STR_MTFTP6_SB), &gEfiMtftp6ServiceBindingProtocolGuid, NULL},\r
735 {STRING_TOKEN(STR_MTFTP6), &gEfiMtftp6ProtocolGuid, NULL},\r
736 {STRING_TOKEN(STR_DHCP6_SB), &gEfiDhcp6ServiceBindingProtocolGuid, NULL},\r
737 {STRING_TOKEN(STR_DHCP6), &gEfiDhcp6ProtocolGuid, NULL},\r
738 {STRING_TOKEN(STR_UDP6_SB), &gEfiUdp6ServiceBindingProtocolGuid, NULL},\r
739 {STRING_TOKEN(STR_UDP6), &gEfiUdp6ProtocolGuid, NULL},\r
740 {STRING_TOKEN(STR_TCP6_SB), &gEfiTcp6ServiceBindingProtocolGuid, NULL},\r
741 {STRING_TOKEN(STR_TCP6), &gEfiTcp6ProtocolGuid, NULL},\r
742 {STRING_TOKEN(STR_VLAN_CONFIG), &gEfiVlanConfigProtocolGuid, NULL},\r
743 {STRING_TOKEN(STR_EAP), &gEfiEapProtocolGuid, NULL},\r
744 {STRING_TOKEN(STR_EAP_MGMT), &gEfiEapManagementProtocolGuid, NULL},\r
745 {STRING_TOKEN(STR_FTP4_SB), &gEfiFtp4ServiceBindingProtocolGuid, NULL},\r
746 {STRING_TOKEN(STR_FTP4), &gEfiFtp4ProtocolGuid, NULL},\r
747 {STRING_TOKEN(STR_IP_SEC_CONFIG), &gEfiIpSecConfigProtocolGuid, NULL},\r
748 {STRING_TOKEN(STR_DH), &gEfiDriverHealthProtocolGuid, NULL},\r
749 {STRING_TOKEN(STR_DEF_IMG_LOAD), &gEfiDeferredImageLoadProtocolGuid, NULL},\r
750 {STRING_TOKEN(STR_USER_CRED), &gEfiUserCredentialProtocolGuid, NULL},\r
751 {STRING_TOKEN(STR_USER_MNGR), &gEfiUserManagerProtocolGuid, NULL},\r
752 {STRING_TOKEN(STR_ATA_PASS_THRU), &gEfiAtaPassThruProtocolGuid, NULL},\r
753\r
754//\r
755// UEFI 2.3\r
756//\r
757 {STRING_TOKEN(STR_FW_MGMT), &gEfiFirmwareManagementProtocolGuid, NULL},\r
758 {STRING_TOKEN(STR_IP_SEC), &gEfiIpSecProtocolGuid, NULL},\r
759 {STRING_TOKEN(STR_IP_SEC2), &gEfiIpSec2ProtocolGuid, NULL},\r
760\r
761//\r
762// UEFI 2.3.1\r
763//\r
764 {STRING_TOKEN(STR_KMS), &gEfiKmsProtocolGuid, NULL},\r
765 {STRING_TOKEN(STR_BLK_IO2), &gEfiBlockIo2ProtocolGuid, NULL},\r
766 {STRING_TOKEN(STR_SSC), &gEfiStorageSecurityCommandProtocolGuid, NULL},\r
12f1a36c 767 {STRING_TOKEN(STR_UCRED2), &gEfiUserCredential2ProtocolGuid, NULL},\r
dee34318 768\r
28cdb62b
CP
769//\r
770// UEFI 2.4\r
771//\r
772 {STRING_TOKEN(STR_DISK_IO2), &gEfiDiskIo2ProtocolGuid, NULL},\r
0fb7e718 773 {STRING_TOKEN(STR_ADAPTER_INFO), &gEfiAdapterInformationProtocolGuid, NULL},\r
28cdb62b 774\r
6b640b4a
JC
775//\r
776// PI Spec ones\r
777//\r
778 {STRING_TOKEN(STR_IDE_CONT_INIT), &gEfiIdeControllerInitProtocolGuid, NULL},\r
779\r
0a1eb97d
JC
780//\r
781// UEFI Shell Spec 2.0\r
782//\r
783 {STRING_TOKEN(STR_SHELL_PARAMETERS), &gEfiShellParametersProtocolGuid, NULL},\r
784 {STRING_TOKEN(STR_SHELL), &gEfiShellProtocolGuid, NULL},\r
785\r
786//\r
787// UEFI Shell Spec 2.1\r
788//\r
789 {STRING_TOKEN(STR_SHELL_DYNAMIC), &gEfiShellDynamicCommandProtocolGuid, NULL},\r
790\r
dee34318 791//\r
792// terminator\r
793//\r
a405b86d 794 {STRING_TOKEN(STR_UNKNOWN_DEVICE), NULL, NULL},\r
795};\r
796\r
797/**\r
798 Function to get the node for a protocol or struct from it's GUID.\r
799\r
800 if Guid is NULL, then ASSERT.\r
801\r
802 @param[in] Guid The GUID to look for the name of.\r
803\r
804 @return The node.\r
805**/\r
dee34318 806CONST GUID_INFO_BLOCK *\r
a405b86d 807EFIAPI\r
808InternalShellGetNodeFromGuid(\r
809 IN CONST EFI_GUID* Guid\r
810 )\r
811{\r
dee34318 812 CONST GUID_INFO_BLOCK *ListWalker;\r
6306fd90 813 UINTN LoopCount;\r
a405b86d 814\r
815 ASSERT(Guid != NULL);\r
816\r
6306fd90
JC
817 for (LoopCount = 0, ListWalker = GuidList; GuidList != NULL && LoopCount < GuidListCount; LoopCount++, ListWalker++) {\r
818 if (CompareGuid(ListWalker->GuidId, Guid)) {\r
819 return (ListWalker);\r
820 }\r
821 }\r
822\r
a405b86d 823 if (PcdGetBool(PcdShellIncludeNtGuids)) {\r
824 for (ListWalker = mGuidStringListNT ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {\r
825 if (CompareGuid(ListWalker->GuidId, Guid)) {\r
826 return (ListWalker);\r
827 }\r
828 }\r
829 }\r
830 for (ListWalker = mGuidStringList ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {\r
831 if (CompareGuid(ListWalker->GuidId, Guid)) {\r
832 return (ListWalker);\r
833 }\r
834 }\r
6306fd90
JC
835 return (NULL);\r
836}\r
837\r
838/**\r
839Function to add a new GUID/Name mapping.\r
840\r
841@param[in] Guid The Guid\r
f5ba4007
QS
842@param[in] NameID The STRING id of the HII string to use\r
843@param[in] DumpFunc The pointer to the dump function\r
6306fd90
JC
844\r
845\r
846@retval EFI_SUCCESS The operation was sucessful\r
847@retval EFI_OUT_OF_RESOURCES A memory allocation failed\r
848@retval EFI_INVALID_PARAMETER Guid NameId was invalid\r
849**/\r
6306fd90
JC
850EFI_STATUS\r
851EFIAPI\r
852InsertNewGuidNameMapping(\r
853 IN CONST EFI_GUID *Guid,\r
854 IN CONST EFI_STRING_ID NameID,\r
855 IN CONST DUMP_PROTOCOL_INFO DumpFunc OPTIONAL\r
856 )\r
857{\r
858 ASSERT(Guid != NULL);\r
859 ASSERT(NameID != 0);\r
860\r
861 GuidList = ReallocatePool(GuidListCount * sizeof(GUID_INFO_BLOCK), GuidListCount+1 * sizeof(GUID_INFO_BLOCK), GuidList);\r
862 if (GuidList == NULL) {\r
863 GuidListCount = 0;\r
864 return (EFI_OUT_OF_RESOURCES);\r
865 }\r
866 GuidListCount++;\r
867\r
868 GuidList[GuidListCount - 1].GuidId = AllocateCopyPool(sizeof(EFI_GUID), Guid);\r
869 GuidList[GuidListCount - 1].StringId = NameID;\r
870 GuidList[GuidListCount - 1].DumpInfo = DumpFunc;\r
871\r
872 if (GuidList[GuidListCount - 1].GuidId == NULL) {\r
873 return (EFI_OUT_OF_RESOURCES);\r
874 }\r
875\r
876 return (EFI_SUCCESS);\r
877}\r
878\r
879/**\r
880 Function to add a new GUID/Name mapping.\r
881\r
882 This cannot overwrite an existing mapping.\r
883\r
884 @param[in] Guid The Guid\r
885 @param[in] TheName The Guid's name\r
886 @param[in] Lang RFC4646 language code list or NULL\r
887\r
888 @retval EFI_SUCCESS The operation was sucessful\r
889 @retval EFI_ACCESS_DENIED There was a duplicate\r
890 @retval EFI_OUT_OF_RESOURCES A memory allocation failed\r
891 @retval EFI_INVALID_PARAMETER Guid or TheName was NULL\r
892**/\r
893EFI_STATUS\r
894EFIAPI\r
895AddNewGuidNameMapping(\r
896 IN CONST EFI_GUID *Guid,\r
897 IN CONST CHAR16 *TheName,\r
898 IN CONST CHAR8 *Lang OPTIONAL\r
899 )\r
900{\r
901 CONST GUID_INFO_BLOCK *Temp;\r
902 EFI_STRING_ID NameID;\r
903\r
e7e0e42b
CP
904 HandleParsingHiiInit();\r
905\r
6306fd90
JC
906 if (Guid == NULL || TheName == NULL){\r
907 return (EFI_INVALID_PARAMETER);\r
908 }\r
909\r
910 if ((Temp = InternalShellGetNodeFromGuid(Guid)) != NULL) {\r
911 return (EFI_ACCESS_DENIED);\r
912 }\r
913\r
914 NameID = HiiSetString(mHandleParsingHiiHandle, 0, (CHAR16*)TheName, Lang);\r
915 if (NameID == 0) {\r
916 return (EFI_OUT_OF_RESOURCES);\r
917 }\r
918\r
919 return (InsertNewGuidNameMapping(Guid, NameID, NULL));\r
a405b86d 920}\r
921\r
922/**\r
923 Function to get the name of a protocol or struct from it's GUID.\r
924\r
925 if Guid is NULL, then ASSERT.\r
926\r
927 @param[in] Guid The GUID to look for the name of.\r
928 @param[in] Lang The language to use.\r
929\r
930 @return pointer to string of the name. The caller\r
931 is responsible to free this memory.\r
932**/\r
933CHAR16*\r
934EFIAPI\r
935GetStringNameFromGuid(\r
936 IN CONST EFI_GUID *Guid,\r
937 IN CONST CHAR8 *Lang OPTIONAL\r
938 )\r
939{\r
dee34318 940 CONST GUID_INFO_BLOCK *Id;\r
a405b86d 941\r
e7e0e42b
CP
942 HandleParsingHiiInit();\r
943\r
a405b86d 944 Id = InternalShellGetNodeFromGuid(Guid);\r
6306fd90 945 return (HiiGetString(mHandleParsingHiiHandle, Id==NULL?STRING_TOKEN(STR_UNKNOWN_DEVICE):Id->StringId, Lang));\r
a405b86d 946}\r
947\r
948/**\r
949 Function to dump protocol information from a handle.\r
950\r
951 This function will return a allocated string buffer containing the\r
952 information. The caller is responsible for freeing the memory.\r
953\r
954 If Guid is NULL, ASSERT().\r
955 If TheHandle is NULL, ASSERT().\r
956\r
957 @param[in] TheHandle The handle to dump information from.\r
958 @param[in] Guid The GUID of the protocol to dump.\r
959 @param[in] Verbose TRUE for extra info. FALSE otherwise.\r
960\r
961 @return The pointer to string.\r
962 @retval NULL An error was encountered.\r
963**/\r
964CHAR16*\r
965EFIAPI\r
966GetProtocolInformationDump(\r
967 IN CONST EFI_HANDLE TheHandle,\r
968 IN CONST EFI_GUID *Guid,\r
969 IN CONST BOOLEAN Verbose\r
970 )\r
971{\r
dee34318 972 CONST GUID_INFO_BLOCK *Id;\r
a405b86d 973\r
974 ASSERT(TheHandle != NULL);\r
975 ASSERT(Guid != NULL);\r
976\r
977 if (TheHandle == NULL || Guid == NULL) {\r
978 return (NULL);\r
979 }\r
980\r
981 Id = InternalShellGetNodeFromGuid(Guid);\r
982 if (Id != NULL && Id->DumpInfo != NULL) {\r
983 return (Id->DumpInfo(TheHandle, Verbose));\r
984 }\r
985 return (NULL);\r
986}\r
987\r
988/**\r
989 Function to get the Guid for a protocol or struct based on it's string name.\r
990\r
0a1eb97d
JC
991 do not modify the returned Guid.\r
992\r
a405b86d 993 @param[in] Name The pointer to the string name.\r
994 @param[in] Lang The pointer to the language code.\r
0a1eb97d 995 @param[out] Guid The pointer to the Guid.\r
a405b86d 996\r
997 @retval EFI_SUCCESS The operation was sucessful.\r
998**/\r
999EFI_STATUS\r
1000EFIAPI\r
1001GetGuidFromStringName(\r
1002 IN CONST CHAR16 *Name,\r
1003 IN CONST CHAR8 *Lang OPTIONAL,\r
0a1eb97d 1004 OUT EFI_GUID **Guid\r
a405b86d 1005 )\r
1006{\r
dee34318 1007 CONST GUID_INFO_BLOCK *ListWalker;\r
a405b86d 1008 CHAR16 *String;\r
6306fd90 1009 UINTN LoopCount;\r
a405b86d 1010\r
e7e0e42b
CP
1011 HandleParsingHiiInit();\r
1012\r
a405b86d 1013 ASSERT(Guid != NULL);\r
1014 if (Guid == NULL) {\r
1015 return (EFI_INVALID_PARAMETER);\r
1016 }\r
1017 *Guid = NULL;\r
1018\r
1019 if (PcdGetBool(PcdShellIncludeNtGuids)) {\r
1020 for (ListWalker = mGuidStringListNT ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {\r
1021 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);\r
28cdb62b 1022 if (Name != NULL && String != NULL && StringNoCaseCompare (&Name, &String) == 0) {\r
a405b86d 1023 *Guid = ListWalker->GuidId;\r
1024 }\r
1025 SHELL_FREE_NON_NULL(String);\r
1026 if (*Guid != NULL) {\r
1027 return (EFI_SUCCESS);\r
1028 }\r
1029 }\r
1030 }\r
1031 for (ListWalker = mGuidStringList ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {\r
1032 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);\r
28cdb62b 1033 if (Name != NULL && String != NULL && StringNoCaseCompare (&Name, &String) == 0) {\r
a405b86d 1034 *Guid = ListWalker->GuidId;\r
1035 }\r
1036 SHELL_FREE_NON_NULL(String);\r
1037 if (*Guid != NULL) {\r
1038 return (EFI_SUCCESS);\r
1039 }\r
1040 }\r
6306fd90
JC
1041\r
1042 for (LoopCount = 0, ListWalker = GuidList; GuidList != NULL && LoopCount < GuidListCount; LoopCount++, ListWalker++) {\r
1043 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);\r
1044 if (Name != NULL && String != NULL && StringNoCaseCompare (&Name, &String) == 0) {\r
1045 *Guid = ListWalker->GuidId;\r
1046 }\r
1047 SHELL_FREE_NON_NULL(String);\r
1048 if (*Guid != NULL) {\r
1049 return (EFI_SUCCESS);\r
1050 }\r
1051 }\r
1052\r
a405b86d 1053 return (EFI_NOT_FOUND);\r
1054}\r
1055\r
36384ceb
ED
1056/**\r
1057 Get best support language for this driver.\r
1058 \r
a71003f2
ED
1059 First base on the user input language to search, second base on the current \r
1060 platform used language to search, third get the first language from the \r
1061 support language list. The caller need to free the buffer of the best language.\r
36384ceb
ED
1062\r
1063 @param[in] SupportedLanguages The support languages for this driver.\r
a71003f2 1064 @param[in] InputLanguage The user input language.\r
36384ceb
ED
1065 @param[in] Iso639Language Whether get language for ISO639.\r
1066\r
1067 @return The best support language for this driver.\r
1068**/\r
1069CHAR8 *\r
a71003f2 1070EFIAPI\r
36384ceb 1071GetBestLanguageForDriver (\r
a71003f2
ED
1072 IN CONST CHAR8 *SupportedLanguages,\r
1073 IN CONST CHAR8 *InputLanguage,\r
36384ceb
ED
1074 IN BOOLEAN Iso639Language\r
1075 )\r
1076{\r
1077 CHAR8 *LanguageVariable;\r
1078 CHAR8 *BestLanguage;\r
1079\r
1080 LanguageVariable = GetVariable (Iso639Language ? L"Lang" : L"PlatformLang", &gEfiGlobalVariableGuid);\r
1081\r
1082 BestLanguage = GetBestLanguage(\r
1083 SupportedLanguages,\r
1084 Iso639Language,\r
a71003f2 1085 (InputLanguage != NULL) ? InputLanguage : "",\r
36384ceb 1086 (LanguageVariable != NULL) ? LanguageVariable : "",\r
a71003f2 1087 SupportedLanguages,\r
36384ceb
ED
1088 NULL\r
1089 );\r
1090\r
1091 if (LanguageVariable != NULL) {\r
1092 FreePool (LanguageVariable);\r
1093 }\r
1094\r
1095 return BestLanguage;\r
1096}\r
1097\r
a405b86d 1098/**\r
1099 Function to retrieve the driver name (if possible) from the ComponentName or\r
1100 ComponentName2 protocol\r
1101\r
1102 @param[in] TheHandle The driver handle to get the name of.\r
1103 @param[in] Language The language to use.\r
1104\r
1105 @retval NULL The name could not be found.\r
1106 @return A pointer to the string name. Do not de-allocate the memory.\r
1107**/\r
1108CONST CHAR16*\r
1109EFIAPI\r
1110GetStringNameFromHandle(\r
1111 IN CONST EFI_HANDLE TheHandle,\r
1112 IN CONST CHAR8 *Language\r
1113 )\r
1114{\r
1115 EFI_COMPONENT_NAME2_PROTOCOL *CompNameStruct;\r
1116 EFI_STATUS Status;\r
1117 CHAR16 *RetVal;\r
36384ceb
ED
1118 CHAR8 *BestLang;\r
1119\r
1120 BestLang = NULL;\r
a405b86d 1121\r
1122 Status = gBS->OpenProtocol(\r
1123 TheHandle,\r
1124 &gEfiComponentName2ProtocolGuid,\r
1125 (VOID**)&CompNameStruct,\r
1126 gImageHandle,\r
1127 NULL,\r
1128 EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
1129 if (!EFI_ERROR(Status)) {\r
a71003f2
ED
1130 BestLang = GetBestLanguageForDriver (CompNameStruct->SupportedLanguages, Language, FALSE);\r
1131 Status = CompNameStruct->GetDriverName(CompNameStruct, BestLang, &RetVal);\r
36384ceb
ED
1132 if (BestLang != NULL) {\r
1133 FreePool (BestLang);\r
1134 BestLang = NULL;\r
1135 }\r
a405b86d 1136 if (!EFI_ERROR(Status)) {\r
1137 return (RetVal);\r
1138 }\r
1139 }\r
1140 Status = gBS->OpenProtocol(\r
1141 TheHandle,\r
1142 &gEfiComponentNameProtocolGuid,\r
1143 (VOID**)&CompNameStruct,\r
1144 gImageHandle,\r
1145 NULL,\r
1146 EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
1147 if (!EFI_ERROR(Status)) {\r
a71003f2
ED
1148 BestLang = GetBestLanguageForDriver (CompNameStruct->SupportedLanguages, Language, FALSE);\r
1149 Status = CompNameStruct->GetDriverName(CompNameStruct, BestLang, &RetVal);\r
36384ceb
ED
1150 if (BestLang != NULL) {\r
1151 FreePool (BestLang);\r
1152 }\r
a405b86d 1153 if (!EFI_ERROR(Status)) {\r
1154 return (RetVal);\r
1155 }\r
1156 }\r
1157 return (NULL);\r
1158}\r
1159\r
1160/**\r
1161 Function to initialize the file global mHandleList object for use in\r
1162 vonverting handles to index and index to handle.\r
1163\r
1164 @retval EFI_SUCCESS The operation was successful.\r
1165**/\r
1166EFI_STATUS\r
1167EFIAPI\r
1168InternalShellInitHandleList(\r
1169 VOID\r
1170 )\r
1171{\r
1172 EFI_STATUS Status;\r
1173 EFI_HANDLE *HandleBuffer;\r
1174 UINTN HandleCount;\r
1175 HANDLE_LIST *ListWalker;\r
1176\r
1177 if (mHandleList.NextIndex != 0) {\r
1178 return EFI_SUCCESS;\r
1179 }\r
1180 InitializeListHead(&mHandleList.List.Link);\r
1181 mHandleList.NextIndex = 1;\r
1182 Status = gBS->LocateHandleBuffer (\r
1183 AllHandles,\r
1184 NULL,\r
1185 NULL,\r
1186 &HandleCount,\r
1187 &HandleBuffer\r
1188 );\r
1189 ASSERT_EFI_ERROR(Status);\r
1190 if (EFI_ERROR(Status)) {\r
1191 return (Status);\r
1192 }\r
1193 for (mHandleList.NextIndex = 1 ; mHandleList.NextIndex <= HandleCount ; mHandleList.NextIndex++){\r
78ed876b 1194 ListWalker = AllocateZeroPool(sizeof(HANDLE_LIST));\r
a405b86d 1195 ASSERT(ListWalker != NULL);\r
1196 ListWalker->TheHandle = HandleBuffer[mHandleList.NextIndex-1];\r
1197 ListWalker->TheIndex = mHandleList.NextIndex;\r
1198 InsertTailList(&mHandleList.List.Link,&ListWalker->Link);\r
1199 }\r
1200 FreePool(HandleBuffer);\r
1201 return (EFI_SUCCESS);\r
1202}\r
1203\r
1204/**\r
1205 Function to retrieve the human-friendly index of a given handle. If the handle\r
1206 does not have a index one will be automatically assigned. The index value is valid\r
1207 until the termination of the shell application.\r
1208\r
1209 @param[in] TheHandle The handle to retrieve an index for.\r
1210\r
1211 @retval 0 A memory allocation failed.\r
1212 @return The index of the handle.\r
1213\r
1214**/\r
1215UINTN\r
1216EFIAPI\r
1217ConvertHandleToHandleIndex(\r
1218 IN CONST EFI_HANDLE TheHandle\r
1219 )\r
1220{\r
f330ff35 1221 EFI_STATUS Status;\r
1222 EFI_GUID **ProtocolBuffer;\r
1223 UINTN ProtocolCount;\r
1224 HANDLE_LIST *ListWalker;\r
1225\r
78ed876b 1226 if (TheHandle == NULL) {\r
1227 return 0;\r
1228 }\r
a405b86d 1229\r
1230 InternalShellInitHandleList();\r
1231\r
1232 for (ListWalker = (HANDLE_LIST*)GetFirstNode(&mHandleList.List.Link)\r
1233 ; !IsNull(&mHandleList.List.Link,&ListWalker->Link)\r
1234 ; ListWalker = (HANDLE_LIST*)GetNextNode(&mHandleList.List.Link,&ListWalker->Link)\r
1235 ){\r
1236 if (ListWalker->TheHandle == TheHandle) {\r
f330ff35 1237 //\r
1238 // Verify that TheHandle is still present in the Handle Database\r
1239 //\r
1240 Status = gBS->ProtocolsPerHandle(TheHandle, &ProtocolBuffer, &ProtocolCount);\r
1241 if (EFI_ERROR (Status)) {\r
1242 //\r
1243 // TheHandle is not present in the Handle Database, so delete from the handle list\r
1244 //\r
1245 RemoveEntryList (&ListWalker->Link);\r
1246 return 0;\r
1247 }\r
1248 FreePool (ProtocolBuffer);\r
a405b86d 1249 return (ListWalker->TheIndex);\r
1250 }\r
1251 }\r
f330ff35 1252\r
1253 //\r
1254 // Verify that TheHandle is valid handle\r
1255 //\r
1256 Status = gBS->ProtocolsPerHandle(TheHandle, &ProtocolBuffer, &ProtocolCount);\r
1257 if (EFI_ERROR (Status)) {\r
1258 //\r
1259 // TheHandle is not valid, so do not add to handle list\r
1260 //\r
1261 return 0;\r
1262 }\r
1263 FreePool (ProtocolBuffer);\r
1264\r
78ed876b 1265 ListWalker = AllocateZeroPool(sizeof(HANDLE_LIST));\r
a405b86d 1266 ASSERT(ListWalker != NULL);\r
1267 ListWalker->TheHandle = TheHandle;\r
1268 ListWalker->TheIndex = mHandleList.NextIndex++;\r
1269 InsertTailList(&mHandleList.List.Link,&ListWalker->Link);\r
1270 return (ListWalker->TheIndex);\r
1271}\r
1272\r
1273\r
1274\r
1275/**\r
1276 Function to retrieve the EFI_HANDLE from the human-friendly index.\r
1277\r
1278 @param[in] TheIndex The index to retrieve the EFI_HANDLE for.\r
1279\r
1280 @retval NULL The index was invalid.\r
1281 @return The EFI_HANDLE that index represents.\r
1282\r
1283**/\r
1284EFI_HANDLE\r
1285EFIAPI\r
1286ConvertHandleIndexToHandle(\r
1287 IN CONST UINTN TheIndex\r
1288 )\r
1289{\r
f330ff35 1290 EFI_STATUS Status;\r
1291 EFI_GUID **ProtocolBuffer;\r
1292 UINTN ProtocolCount;\r
a405b86d 1293 HANDLE_LIST *ListWalker;\r
1294\r
1295 InternalShellInitHandleList();\r
1296\r
1297 if (TheIndex >= mHandleList.NextIndex) {\r
f330ff35 1298 return NULL;\r
a405b86d 1299 }\r
1300\r
1301 for (ListWalker = (HANDLE_LIST*)GetFirstNode(&mHandleList.List.Link)\r
1302 ; !IsNull(&mHandleList.List.Link,&ListWalker->Link)\r
1303 ; ListWalker = (HANDLE_LIST*)GetNextNode(&mHandleList.List.Link,&ListWalker->Link)\r
1304 ){\r
f330ff35 1305 if (ListWalker->TheIndex == TheIndex && ListWalker->TheHandle != NULL) {\r
1306 //\r
1307 // Verify that LinkWalker->TheHandle is valid handle\r
1308 //\r
1309 Status = gBS->ProtocolsPerHandle(ListWalker->TheHandle, &ProtocolBuffer, &ProtocolCount);\r
1310 if (EFI_ERROR (Status)) {\r
1311 //\r
1312 // TheHandle is not valid, so do not add to handle list\r
1313 //\r
1314 ListWalker->TheHandle = NULL;\r
1315 }\r
a405b86d 1316 return (ListWalker->TheHandle);\r
1317 }\r
1318 }\r
f330ff35 1319 return NULL;\r
a405b86d 1320}\r
1321\r
1322/**\r
1323 Gets all the related EFI_HANDLEs based on the mask supplied.\r
1324\r
1325 This function scans all EFI_HANDLES in the UEFI environment's handle database\r
1326 and returns the ones with the specified relationship (Mask) to the specified\r
1327 controller handle.\r
1328\r
1329 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.\r
1330 If MatchingHandleCount is NULL, then ASSERT.\r
1331\r
1332 If MatchingHandleBuffer is not NULL upon a successful return the memory must be\r
1333 caller freed.\r
1334\r
1335 @param[in] DriverBindingHandle The handle with Driver Binding protocol on it.\r
1336 @param[in] ControllerHandle The handle with Device Path protocol on it.\r
1337 @param[in] MatchingHandleCount The pointer to UINTN that specifies the number of HANDLES in\r
1338 MatchingHandleBuffer.\r
1339 @param[out] MatchingHandleBuffer On a successful return, a buffer of MatchingHandleCount\r
1340 EFI_HANDLEs with a terminating NULL EFI_HANDLE.\r
1341 @param[out] HandleType An array of type information.\r
1342\r
1343 @retval EFI_SUCCESS The operation was successful, and any related handles\r
1344 are in MatchingHandleBuffer.\r
1345 @retval EFI_NOT_FOUND No matching handles were found.\r
1346 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.\r
1347**/\r
1348EFI_STATUS\r
1349EFIAPI\r
1350ParseHandleDatabaseByRelationshipWithType (\r
1351 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL,\r
1352 IN CONST EFI_HANDLE ControllerHandle OPTIONAL,\r
1353 IN UINTN *HandleCount,\r
1354 OUT EFI_HANDLE **HandleBuffer,\r
1355 OUT UINTN **HandleType\r
1356 )\r
1357{\r
1358 EFI_STATUS Status;\r
1359 UINTN HandleIndex;\r
1360 EFI_GUID **ProtocolGuidArray;\r
1361 UINTN ArrayCount;\r
1362 UINTN ProtocolIndex;\r
1363 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *OpenInfo;\r
1364 UINTN OpenInfoCount;\r
1365 UINTN OpenInfoIndex;\r
1366 UINTN ChildIndex;\r
f330ff35 1367 INTN DriverBindingHandleIndex;\r
a405b86d 1368\r
1369 ASSERT(HandleCount != NULL);\r
1370 ASSERT(HandleBuffer != NULL);\r
1371 ASSERT(HandleType != NULL);\r
1372 ASSERT(DriverBindingHandle != NULL || ControllerHandle != NULL);\r
1373\r
1374 *HandleCount = 0;\r
1375 *HandleBuffer = NULL;\r
1376 *HandleType = NULL;\r
1377\r
1378 //\r
1379 // Retrieve the list of all handles from the handle database\r
1380 //\r
1381 Status = gBS->LocateHandleBuffer (\r
1382 AllHandles,\r
1383 NULL,\r
1384 NULL,\r
1385 HandleCount,\r
1386 HandleBuffer\r
1387 );\r
1388 if (EFI_ERROR (Status)) {\r
1389 return (Status);\r
1390 }\r
1391\r
1392 *HandleType = AllocateZeroPool (*HandleCount * sizeof (UINTN));\r
1393 ASSERT(*HandleType != NULL);\r
1394\r
f330ff35 1395 DriverBindingHandleIndex = -1;\r
1396 for (HandleIndex = 0; HandleIndex < *HandleCount; HandleIndex++) {\r
1397 if (DriverBindingHandle != NULL && (*HandleBuffer)[HandleIndex] == DriverBindingHandle) {\r
1398 DriverBindingHandleIndex = (INTN)HandleIndex;\r
1399 }\r
1400 }\r
1401\r
a405b86d 1402 for (HandleIndex = 0; HandleIndex < *HandleCount; HandleIndex++) {\r
1403 //\r
1404 // Retrieve the list of all the protocols on each handle\r
1405 //\r
1406 Status = gBS->ProtocolsPerHandle (\r
1407 (*HandleBuffer)[HandleIndex],\r
1408 &ProtocolGuidArray,\r
1409 &ArrayCount\r
1410 );\r
f330ff35 1411 if (EFI_ERROR (Status)) {\r
1412 continue;\r
1413 }\r
a405b86d 1414\r
f330ff35 1415 for (ProtocolIndex = 0; ProtocolIndex < ArrayCount; ProtocolIndex++) {\r
a405b86d 1416\r
f330ff35 1417 //\r
1418 // Set the bit describing what this handle has\r
1419 //\r
1420 if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiLoadedImageProtocolGuid) ) {\r
7aae3c35 1421 (*HandleType)[HandleIndex] |= (UINTN)HR_IMAGE_HANDLE;\r
f330ff35 1422 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverBindingProtocolGuid) ) {\r
7aae3c35 1423 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_BINDING_HANDLE;\r
f330ff35 1424 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverConfiguration2ProtocolGuid)) {\r
7aae3c35 1425 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_CONFIGURATION_HANDLE;\r
f330ff35 1426 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverConfigurationProtocolGuid) ) {\r
7aae3c35 1427 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_CONFIGURATION_HANDLE;\r
f330ff35 1428 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverDiagnostics2ProtocolGuid) ) {\r
7aae3c35 1429 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_DIAGNOSTICS_HANDLE;\r
f330ff35 1430 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverDiagnosticsProtocolGuid) ) {\r
7aae3c35 1431 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_DIAGNOSTICS_HANDLE;\r
f330ff35 1432 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiComponentName2ProtocolGuid) ) {\r
7aae3c35 1433 (*HandleType)[HandleIndex] |= (UINTN)HR_COMPONENT_NAME_HANDLE;\r
f330ff35 1434 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiComponentNameProtocolGuid) ) {\r
7aae3c35 1435 (*HandleType)[HandleIndex] |= (UINTN)HR_COMPONENT_NAME_HANDLE;\r
f330ff35 1436 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDevicePathProtocolGuid) ) {\r
7aae3c35 1437 (*HandleType)[HandleIndex] |= (UINTN)HR_DEVICE_HANDLE;\r
f330ff35 1438 } else {\r
1439 DEBUG_CODE_BEGIN();\r
1440 ASSERT((*HandleType)[HandleIndex] == (*HandleType)[HandleIndex]);\r
1441 DEBUG_CODE_END();\r
1442 }\r
1443 //\r
1444 // Retrieve the list of agents that have opened each protocol\r
1445 //\r
1446 Status = gBS->OpenProtocolInformation (\r
a405b86d 1447 (*HandleBuffer)[HandleIndex],\r
1448 ProtocolGuidArray[ProtocolIndex],\r
1449 &OpenInfo,\r
1450 &OpenInfoCount\r
1451 );\r
f330ff35 1452 if (EFI_ERROR (Status)) {\r
1453 continue;\r
1454 }\r
1455\r
1456 if (ControllerHandle == NULL) {\r
1457 //\r
1458 // ControllerHandle == NULL and DriverBindingHandle != NULL. \r
1459 // Return information on all the controller handles that the driver specified by DriverBindingHandle is managing\r
1460 //\r
1461 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
1462 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle && (OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
7aae3c35 1463 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);\r
f330ff35 1464 if (DriverBindingHandleIndex != -1) {\r
7aae3c35 1465 (*HandleType)[DriverBindingHandleIndex] |= (UINTN)HR_DEVICE_DRIVER;\r
f330ff35 1466 }\r
1467 }\r
1468 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle && (OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
7aae3c35 1469 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);\r
f330ff35 1470 if (DriverBindingHandleIndex != -1) {\r
7aae3c35 1471 (*HandleType)[DriverBindingHandleIndex] |= (UINTN)(HR_BUS_DRIVER | HR_DEVICE_DRIVER);\r
f330ff35 1472 }\r
1473 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
1474 if (OpenInfo[OpenInfoIndex].ControllerHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 1475 (*HandleType)[ChildIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CHILD_HANDLE);\r
f330ff35 1476 }\r
1477 }\r
1478 }\r
1479 }\r
1480 }\r
1481 if (DriverBindingHandle == NULL && ControllerHandle != NULL) {\r
1482 if (ControllerHandle == (*HandleBuffer)[HandleIndex]) {\r
7aae3c35 1483 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);\r
a405b86d 1484 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
f330ff35 1485 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
1486 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
1487 if (OpenInfo[OpenInfoIndex].AgentHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 1488 (*HandleType)[ChildIndex] |= (UINTN)HR_DEVICE_DRIVER;\r
f330ff35 1489 }\r
a405b86d 1490 }\r
f330ff35 1491 }\r
1492 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
1493 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
1494 if (OpenInfo[OpenInfoIndex].AgentHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 1495 (*HandleType)[ChildIndex] |= (UINTN)(HR_BUS_DRIVER | HR_DEVICE_DRIVER);\r
f330ff35 1496 }\r
1497 if (OpenInfo[OpenInfoIndex].ControllerHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 1498 (*HandleType)[ChildIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CHILD_HANDLE);\r
a405b86d 1499 }\r
1500 }\r
1501 }\r
f330ff35 1502 }\r
1503 } else {\r
1504 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
1505 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
1506 if (OpenInfo[OpenInfoIndex].ControllerHandle == ControllerHandle) {\r
7aae3c35 1507 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_PARENT_HANDLE);\r
f330ff35 1508 }\r
1509 }\r
1510 }\r
1511 }\r
1512 }\r
1513 if (DriverBindingHandle != NULL && ControllerHandle != NULL) {\r
1514 if (ControllerHandle == (*HandleBuffer)[HandleIndex]) {\r
7aae3c35 1515 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);\r
f330ff35 1516 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
1517 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
1518 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle) {\r
1519 if (DriverBindingHandleIndex != -1) {\r
7aae3c35 1520 (*HandleType)[DriverBindingHandleIndex] |= (UINTN)HR_DEVICE_DRIVER;\r
a405b86d 1521 }\r
1522 }\r
f330ff35 1523 }\r
1524 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
1525 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle) {\r
a405b86d 1526 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
f330ff35 1527 if (OpenInfo[OpenInfoIndex].ControllerHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 1528 (*HandleType)[ChildIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CHILD_HANDLE);\r
a405b86d 1529 }\r
1530 }\r
1531 }\r
f330ff35 1532\r
1533 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
1534 if (OpenInfo[OpenInfoIndex].AgentHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 1535 (*HandleType)[ChildIndex] |= (UINTN)(HR_BUS_DRIVER | HR_DEVICE_DRIVER);\r
f330ff35 1536 }\r
1537 }\r
1538 }\r
1539 }\r
1540 } else {\r
1541 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
1542 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
1543 if (OpenInfo[OpenInfoIndex].ControllerHandle == ControllerHandle) {\r
7aae3c35 1544 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_PARENT_HANDLE);\r
f330ff35 1545 }\r
a405b86d 1546 }\r
1547 }\r
a405b86d 1548 }\r
1549 }\r
f330ff35 1550 FreePool (OpenInfo);\r
a405b86d 1551 }\r
f330ff35 1552 FreePool (ProtocolGuidArray);\r
a405b86d 1553 }\r
f330ff35 1554 return EFI_SUCCESS;\r
a405b86d 1555}\r
1556\r
1557/**\r
1558 Gets all the related EFI_HANDLEs based on the single EFI_HANDLE and the mask\r
1559 supplied.\r
1560\r
1561 This function will scan all EFI_HANDLES in the UEFI environment's handle database\r
1562 and return all the ones with the specified relationship (Mask) to the specified\r
1563 controller handle.\r
1564\r
1565 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.\r
1566 If MatchingHandleCount is NULL, then ASSERT.\r
1567\r
1568 If MatchingHandleBuffer is not NULL upon a sucessful return the memory must be\r
1569 caller freed.\r
1570\r
1571 @param[in] DriverBindingHandle Handle to a object with Driver Binding protocol\r
1572 on it.\r
1573 @param[in] ControllerHandle Handle to a device with Device Path protocol on it.\r
1574 @param[in] Mask Mask of what relationship(s) is desired.\r
1575 @param[in] MatchingHandleCount Poitner to UINTN specifying number of HANDLES in\r
1576 MatchingHandleBuffer.\r
1577 @param[out] MatchingHandleBuffer On a sucessful return a buffer of MatchingHandleCount\r
1578 EFI_HANDLEs and a terminating NULL EFI_HANDLE.\r
1579\r
1580 @retval EFI_SUCCESS The operation was sucessful and any related handles\r
1581 are in MatchingHandleBuffer;\r
1582 @retval EFI_NOT_FOUND No matching handles were found.\r
1583 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.\r
1584**/\r
1585EFI_STATUS\r
1586EFIAPI\r
1587ParseHandleDatabaseByRelationship (\r
1588 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL,\r
1589 IN CONST EFI_HANDLE ControllerHandle OPTIONAL,\r
1590 IN CONST UINTN Mask,\r
1591 IN UINTN *MatchingHandleCount,\r
1592 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL\r
1593 )\r
1594{\r
1595 EFI_STATUS Status;\r
1596 UINTN HandleCount;\r
1597 EFI_HANDLE *HandleBuffer;\r
1598 UINTN *HandleType;\r
1599 UINTN HandleIndex;\r
1600\r
1601 ASSERT(MatchingHandleCount != NULL);\r
1602 ASSERT(DriverBindingHandle != NULL || ControllerHandle != NULL);\r
1603\r
1604 if ((Mask & HR_VALID_MASK) != Mask) {\r
1605 return (EFI_INVALID_PARAMETER);\r
1606 }\r
1607\r
1608 if ((Mask & HR_CHILD_HANDLE) != 0 && DriverBindingHandle == NULL) {\r
1609 return (EFI_INVALID_PARAMETER);\r
1610 }\r
1611\r
1612 *MatchingHandleCount = 0;\r
1613 if (MatchingHandleBuffer != NULL) {\r
1614 *MatchingHandleBuffer = NULL;\r
1615 }\r
1616\r
1617 HandleBuffer = NULL;\r
1618 HandleType = NULL;\r
1619\r
1620 Status = ParseHandleDatabaseByRelationshipWithType (\r
1621 DriverBindingHandle,\r
1622 ControllerHandle,\r
1623 &HandleCount,\r
1624 &HandleBuffer,\r
1625 &HandleType\r
1626 );\r
1627 if (!EFI_ERROR (Status)) {\r
1628 //\r
1629 // Count the number of handles that match the attributes in Mask\r
1630 //\r
1631 for (HandleIndex = 0; HandleIndex < HandleCount; HandleIndex++) {\r
1632 if ((HandleType[HandleIndex] & Mask) == Mask) {\r
1633 (*MatchingHandleCount)++;\r
1634 }\r
1635 }\r
1636 //\r
1637 // If no handles match the attributes in Mask then return EFI_NOT_FOUND\r
1638 //\r
1639 if (*MatchingHandleCount == 0) {\r
1640 Status = EFI_NOT_FOUND;\r
1641 } else {\r
1642\r
1643 if (MatchingHandleBuffer == NULL) {\r
1644 //\r
1645 // Someone just wanted the count...\r
1646 //\r
1647 Status = EFI_SUCCESS;\r
1648 } else {\r
1649 //\r
1650 // Allocate a handle buffer for the number of handles that matched the attributes in Mask\r
1651 //\r
78ed876b 1652 *MatchingHandleBuffer = AllocateZeroPool ((*MatchingHandleCount +1)* sizeof (EFI_HANDLE));\r
a405b86d 1653 ASSERT(*MatchingHandleBuffer != NULL);\r
1654\r
1655 for (HandleIndex = 0,*MatchingHandleCount = 0\r
1656 ; HandleIndex < HandleCount\r
1657 ; HandleIndex++\r
1658 ){\r
1659 //\r
1660 // Fill the allocated buffer with the handles that matched the attributes in Mask\r
1661 //\r
1662 if ((HandleType[HandleIndex] & Mask) == Mask) {\r
1663 (*MatchingHandleBuffer)[(*MatchingHandleCount)++] = HandleBuffer[HandleIndex];\r
1664 }\r
1665 }\r
1666\r
1667 //\r
1668 // Make the last one NULL\r
1669 //\r
1670 (*MatchingHandleBuffer)[*MatchingHandleCount] = NULL;\r
1671\r
1672 Status = EFI_SUCCESS;\r
1673 } // MacthingHandleBuffer == NULL (ELSE)\r
1674 } // *MatchingHandleCount == 0 (ELSE)\r
1675 } // no error on ParseHandleDatabaseByRelationshipWithType\r
1676\r
1677 if (HandleBuffer != NULL) {\r
1678 FreePool (HandleBuffer);\r
1679 }\r
1680\r
1681 if (HandleType != NULL) {\r
1682 FreePool (HandleType);\r
1683 }\r
1684\r
1685 return Status;\r
1686}\r
1687\r
1688/**\r
1689 Gets handles for any child controllers of the passed in controller.\r
1690\r
1691 @param[in] ControllerHandle The handle of the "parent controller"\r
1692 @param[in] MatchingHandleCount Pointer to the number of handles in\r
1693 MatchingHandleBuffer on return.\r
1694 @param[out] MatchingHandleBuffer Buffer containing handles on a successful\r
1695 return.\r
1696\r
1697\r
1698 @retval EFI_SUCCESS The operation was sucessful.\r
1699**/\r
1700EFI_STATUS\r
1701EFIAPI\r
1702ParseHandleDatabaseForChildControllers(\r
1703 IN CONST EFI_HANDLE ControllerHandle,\r
1704 IN UINTN *MatchingHandleCount,\r
1705 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL\r
1706 )\r
1707{\r
1708 EFI_STATUS Status;\r
f330ff35 1709 UINTN HandleIndex;\r
a405b86d 1710 UINTN DriverBindingHandleCount;\r
1711 EFI_HANDLE *DriverBindingHandleBuffer;\r
1712 UINTN DriverBindingHandleIndex;\r
1713 UINTN ChildControllerHandleCount;\r
1714 EFI_HANDLE *ChildControllerHandleBuffer;\r
1715 UINTN ChildControllerHandleIndex;\r
a405b86d 1716 EFI_HANDLE *HandleBufferForReturn;\r
1717\r
ff51746b 1718 if (MatchingHandleCount == NULL) {\r
1719 return (EFI_INVALID_PARAMETER);\r
1720 }\r
64d753f1 1721 *MatchingHandleCount = 0;\r
a405b86d 1722\r
1723 Status = PARSE_HANDLE_DATABASE_UEFI_DRIVERS (\r
1724 ControllerHandle,\r
1725 &DriverBindingHandleCount,\r
1726 &DriverBindingHandleBuffer\r
1727 );\r
1728 if (EFI_ERROR (Status)) {\r
1729 return Status;\r
1730 }\r
1731\r
ff51746b 1732 //\r
1733 // Get a buffer big enough for all the controllers.\r
1734 //\r
f330ff35 1735 HandleBufferForReturn = GetHandleListByProtocol(NULL);\r
a405b86d 1736 if (HandleBufferForReturn == NULL) {\r
1737 FreePool (DriverBindingHandleBuffer);\r
ff51746b 1738 return (EFI_NOT_FOUND);\r
a405b86d 1739 }\r
1740\r
a405b86d 1741 for (DriverBindingHandleIndex = 0; DriverBindingHandleIndex < DriverBindingHandleCount; DriverBindingHandleIndex++) {\r
1742 Status = PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (\r
1743 DriverBindingHandleBuffer[DriverBindingHandleIndex],\r
1744 ControllerHandle,\r
1745 &ChildControllerHandleCount,\r
1746 &ChildControllerHandleBuffer\r
1747 );\r
1748 if (EFI_ERROR (Status)) {\r
1749 continue;\r
1750 }\r
1751\r
1752 for (ChildControllerHandleIndex = 0;\r
1753 ChildControllerHandleIndex < ChildControllerHandleCount;\r
1754 ChildControllerHandleIndex++\r
1755 ) {\r
f330ff35 1756 for (HandleIndex = 0; HandleIndex < *MatchingHandleCount; HandleIndex++) {\r
1757 if (HandleBufferForReturn[HandleIndex] == ChildControllerHandleBuffer[ChildControllerHandleIndex]) {\r
1758 break;\r
1759 }\r
1760 }\r
1761 if (HandleIndex >= *MatchingHandleCount) {\r
1762 HandleBufferForReturn[(*MatchingHandleCount)++] = ChildControllerHandleBuffer[ChildControllerHandleIndex];\r
1763 }\r
a405b86d 1764 }\r
1765\r
1766 FreePool (ChildControllerHandleBuffer);\r
1767 }\r
1768\r
1769 FreePool (DriverBindingHandleBuffer);\r
1770\r
1771 if (MatchingHandleBuffer != NULL) {\r
1772 *MatchingHandleBuffer = HandleBufferForReturn;\r
1773 } else {\r
1774 FreePool(HandleBufferForReturn);\r
1775 }\r
1776\r
1777 return (EFI_SUCCESS);\r
1778}\r
1779\r
1780/**\r
1781 Appends 1 buffer to another buffer. This will re-allocate the destination buffer\r
1782 if necessary to fit all of the data.\r
1783\r
1784 If DestinationBuffer is NULL, then ASSERT().\r
1785\r
4ff7e37b
ED
1786 @param[in, out] DestinationBuffer The pointer to the pointer to the buffer to append onto.\r
1787 @param[in, out] DestinationSize The pointer to the size of DestinationBuffer.\r
1788 @param[in] SourceBuffer The pointer to the buffer to append onto DestinationBuffer.\r
1789 @param[in] SourceSize The number of bytes of SourceBuffer to append.\r
a405b86d 1790\r
1791 @retval NULL A memory allocation failed.\r
1792 @retval NULL A parameter was invalid.\r
1793 @return A pointer to (*DestinationBuffer).\r
1794**/\r
1795VOID*\r
1796EFIAPI\r
1797BuffernCatGrow (\r
1798 IN OUT VOID **DestinationBuffer,\r
1799 IN OUT UINTN *DestinationSize,\r
1800 IN VOID *SourceBuffer,\r
1801 IN UINTN SourceSize\r
1802 )\r
1803{\r
1804 UINTN LocalDestinationSize;\r
1805 UINTN LocalDestinationFinalSize;\r
1806\r
1807 ASSERT(DestinationBuffer != NULL);\r
1808\r
1809 if (SourceSize == 0 || SourceBuffer == NULL) {\r
1810 return (*DestinationBuffer);\r
1811 }\r
1812\r
1813 if (DestinationSize == NULL) {\r
1814 LocalDestinationSize = 0;\r
1815 } else {\r
1816 LocalDestinationSize = *DestinationSize;\r
1817 }\r
1818\r
1819 LocalDestinationFinalSize = LocalDestinationSize + SourceSize;\r
1820\r
1821 if (DestinationSize != NULL) {\r
1822 *DestinationSize = LocalDestinationSize;\r
1823 }\r
1824\r
1825 if (LocalDestinationSize == 0) {\r
1826 // allcoate\r
78ed876b 1827 *DestinationBuffer = AllocateZeroPool(LocalDestinationFinalSize);\r
a405b86d 1828 } else {\r
1829 // reallocate\r
1830 *DestinationBuffer = ReallocatePool(LocalDestinationSize, LocalDestinationFinalSize, *DestinationBuffer);\r
1831 }\r
1832\r
1833 ASSERT(*DestinationBuffer != NULL);\r
1834\r
1835 // copy\r
1836 return (CopyMem(((UINT8*)(*DestinationBuffer)) + LocalDestinationSize, SourceBuffer, SourceSize));\r
1837}\r
1838\r
1839/**\r
1840 Gets handles for any child devices produced by the passed in driver.\r
1841\r
1842 @param[in] DriverHandle The handle of the driver.\r
1843 @param[in] MatchingHandleCount Pointer to the number of handles in\r
1844 MatchingHandleBuffer on return.\r
1845 @param[out] MatchingHandleBuffer Buffer containing handles on a successful\r
1846 return.\r
1847 @retval EFI_SUCCESS The operation was sucessful.\r
1848 @sa ParseHandleDatabaseByRelationship\r
1849**/\r
1850EFI_STATUS\r
1851EFIAPI\r
1852ParseHandleDatabaseForChildDevices(\r
1853 IN CONST EFI_HANDLE DriverHandle,\r
1854 IN UINTN *MatchingHandleCount,\r
1855 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL\r
1856 )\r
1857{\r
1858 EFI_HANDLE *Buffer;\r
1859 EFI_HANDLE *Buffer2;\r
1860 UINTN Count1;\r
1861 UINTN Count2;\r
1862 UINTN HandleIndex;\r
1863 EFI_STATUS Status;\r
1864 UINTN HandleBufferSize;\r
1865\r
1866 ASSERT(MatchingHandleCount != NULL);\r
1867\r
1868 HandleBufferSize = 0;\r
1869 Buffer = NULL;\r
1870 Buffer2 = NULL;\r
1871 *MatchingHandleCount = 0;\r
1872\r
1873 Status = PARSE_HANDLE_DATABASE_DEVICES (\r
1874 DriverHandle,\r
1875 &Count1,\r
1876 &Buffer\r
1877 );\r
1878 if (!EFI_ERROR (Status)) {\r
1879 for (HandleIndex = 0; HandleIndex < Count1; HandleIndex++) {\r
1880 //\r
1881 // now find the children\r
1882 //\r
1883 Status = PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (\r
1884 DriverHandle,\r
1885 Buffer[HandleIndex],\r
1886 &Count2,\r
1887 &Buffer2\r
1888 );\r
1889 if (EFI_ERROR(Status)) {\r
1890 break;\r
1891 }\r
1892 //\r
1893 // save out required and optional data elements\r
1894 //\r
1895 *MatchingHandleCount += Count2;\r
1896 if (MatchingHandleBuffer != NULL) {\r
1897 *MatchingHandleBuffer = BuffernCatGrow((VOID**)MatchingHandleBuffer, &HandleBufferSize, Buffer2, Count2 * sizeof(Buffer2[0]));\r
1898 }\r
1899\r
1900 //\r
1901 // free the memory\r
1902 //\r
1903 if (Buffer2 != NULL) {\r
1904 FreePool(Buffer2);\r
1905 }\r
1906 }\r
1907 }\r
1908\r
1909 if (Buffer != NULL) {\r
1910 FreePool(Buffer);\r
1911 }\r
1912 return (Status);\r
1913}\r
1914\r
1915/**\r
1916 Function to get all handles that support a given protocol or all handles.\r
1917\r
1918 @param[in] ProtocolGuid The guid of the protocol to get handles for. If NULL\r
1919 then the function will return all handles.\r
1920\r
1921 @retval NULL A memory allocation failed.\r
1922 @return A NULL terminated list of handles.\r
1923**/\r
1924EFI_HANDLE*\r
1925EFIAPI\r
40d7a9cf 1926GetHandleListByProtocol (\r
a405b86d 1927 IN CONST EFI_GUID *ProtocolGuid OPTIONAL\r
1928 )\r
1929{\r
1930 EFI_HANDLE *HandleList;\r
1931 UINTN Size;\r
1932 EFI_STATUS Status;\r
1933\r
1934 Size = 0;\r
1935 HandleList = NULL;\r
1936\r
1937 //\r
1938 // We cannot use LocateHandleBuffer since we need that NULL item on the ends of the list!\r
1939 //\r
1940 if (ProtocolGuid == NULL) {\r
1941 Status = gBS->LocateHandle(AllHandles, NULL, NULL, &Size, HandleList);\r
1942 if (Status == EFI_BUFFER_TOO_SMALL) {\r
78ed876b 1943 HandleList = AllocateZeroPool(Size + sizeof(EFI_HANDLE));\r
40d7a9cf 1944 if (HandleList == NULL) {\r
1945 return (NULL);\r
1946 }\r
a405b86d 1947 Status = gBS->LocateHandle(AllHandles, NULL, NULL, &Size, HandleList);\r
1948 HandleList[Size/sizeof(EFI_HANDLE)] = NULL;\r
1949 }\r
1950 } else {\r
1951 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)ProtocolGuid, NULL, &Size, HandleList);\r
1952 if (Status == EFI_BUFFER_TOO_SMALL) {\r
78ed876b 1953 HandleList = AllocateZeroPool(Size + sizeof(EFI_HANDLE));\r
40d7a9cf 1954 if (HandleList == NULL) {\r
1955 return (NULL);\r
1956 }\r
a405b86d 1957 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)ProtocolGuid, NULL, &Size, HandleList);\r
1958 HandleList[Size/sizeof(EFI_HANDLE)] = NULL;\r
1959 }\r
1960 }\r
1961 if (EFI_ERROR(Status)) {\r
1962 if (HandleList != NULL) {\r
1963 FreePool(HandleList);\r
1964 }\r
1965 return (NULL);\r
1966 }\r
1967 return (HandleList);\r
1968}\r
1969\r
1970/**\r
1971 Function to get all handles that support some protocols.\r
1972\r
1973 @param[in] ProtocolGuids A NULL terminated list of protocol GUIDs.\r
1974\r
1975 @retval NULL A memory allocation failed.\r
ff51746b 1976 @retval NULL ProtocolGuids was NULL.\r
1977 @return A NULL terminated list of EFI_HANDLEs.\r
a405b86d 1978**/\r
1979EFI_HANDLE*\r
1980EFIAPI\r
40d7a9cf 1981GetHandleListByProtocolList (\r
a405b86d 1982 IN CONST EFI_GUID **ProtocolGuids\r
1983 )\r
1984{\r
1985 EFI_HANDLE *HandleList;\r
1986 UINTN Size;\r
1987 UINTN TotalSize;\r
40d7a9cf 1988 UINTN TempSize;\r
a405b86d 1989 EFI_STATUS Status;\r
1990 CONST EFI_GUID **GuidWalker;\r
1991 EFI_HANDLE *HandleWalker1;\r
1992 EFI_HANDLE *HandleWalker2;\r
1993\r
1994 Size = 0;\r
1995 HandleList = NULL;\r
1996 TotalSize = sizeof(EFI_HANDLE);\r
1997\r
1998 for (GuidWalker = ProtocolGuids ; GuidWalker != NULL && *GuidWalker != NULL ; GuidWalker++,Size = 0){\r
1999 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)(*GuidWalker), NULL, &Size, NULL);\r
2000 if (Status == EFI_BUFFER_TOO_SMALL) {\r
2001 TotalSize += Size;\r
2002 }\r
2003 }\r
40d7a9cf 2004\r
2005 //\r
2006 // No handles were found... \r
2007 //\r
2008 if (TotalSize == sizeof(EFI_HANDLE)) {\r
2009 return (NULL);\r
2010 }\r
2011\r
2012 HandleList = AllocateZeroPool(TotalSize);\r
a405b86d 2013 if (HandleList == NULL) {\r
2014 return (NULL);\r
2015 }\r
2016\r
2017 Size = 0;\r
2018 for (GuidWalker = ProtocolGuids ; GuidWalker != NULL && *GuidWalker != NULL ; GuidWalker++){\r
40d7a9cf 2019 TempSize = TotalSize - Size;\r
ff51746b 2020 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)(*GuidWalker), NULL, &TempSize, HandleList+(Size/sizeof(EFI_HANDLE)));\r
40d7a9cf 2021\r
2022 //\r
2023 // Allow for missing protocols... Only update the 'used' size upon success.\r
2024 //\r
2025 if (!EFI_ERROR(Status)) {\r
ff51746b 2026 Size += TempSize;\r
40d7a9cf 2027 }\r
a405b86d 2028 }\r
ff51746b 2029 ASSERT(HandleList[(TotalSize/sizeof(EFI_HANDLE))-1] == NULL);\r
a405b86d 2030\r
2031 for (HandleWalker1 = HandleList ; HandleWalker1 != NULL && *HandleWalker1 != NULL ; HandleWalker1++) {\r
2032 for (HandleWalker2 = HandleWalker1 + 1; HandleWalker2 != NULL && *HandleWalker2 != NULL ; HandleWalker2++) {\r
2033 if (*HandleWalker1 == *HandleWalker2) {\r
2034 //\r
2035 // copy memory back 1 handle width.\r
2036 //\r
2037 CopyMem(HandleWalker2, HandleWalker2 + 1, TotalSize - ((HandleWalker2-HandleList+1)*sizeof(EFI_HANDLE)));\r
2038 }\r
2039 }\r
2040 }\r
2041\r
2042 return (HandleList);\r
2043}\r
2044\r
2045\r
2046\r
2047\r
2048\r
2049\r
2050\r
2051\r
2052\r
2053\r