]> git.proxmox.com Git - mirror_edk2.git/blame - ShellPkg/Library/UefiHandleParsingLib/UefiHandleParsingLib.c
Change NT32 and DUET to use UEFI Shell by default. Use "-D USE_OLD_SHELL" for NT32...
[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
6306fd90
JC
901 EFI_STRING_ID NameID;\r
902\r
e7e0e42b
CP
903 HandleParsingHiiInit();\r
904\r
6306fd90
JC
905 if (Guid == NULL || TheName == NULL){\r
906 return (EFI_INVALID_PARAMETER);\r
907 }\r
908\r
931b2cff 909 if ((InternalShellGetNodeFromGuid(Guid)) != NULL) {\r
6306fd90
JC
910 return (EFI_ACCESS_DENIED);\r
911 }\r
912\r
913 NameID = HiiSetString(mHandleParsingHiiHandle, 0, (CHAR16*)TheName, Lang);\r
914 if (NameID == 0) {\r
915 return (EFI_OUT_OF_RESOURCES);\r
916 }\r
917\r
918 return (InsertNewGuidNameMapping(Guid, NameID, NULL));\r
a405b86d 919}\r
920\r
921/**\r
922 Function to get the name of a protocol or struct from it's GUID.\r
923\r
924 if Guid is NULL, then ASSERT.\r
925\r
926 @param[in] Guid The GUID to look for the name of.\r
927 @param[in] Lang The language to use.\r
928\r
929 @return pointer to string of the name. The caller\r
930 is responsible to free this memory.\r
931**/\r
932CHAR16*\r
933EFIAPI\r
934GetStringNameFromGuid(\r
935 IN CONST EFI_GUID *Guid,\r
936 IN CONST CHAR8 *Lang OPTIONAL\r
937 )\r
938{\r
dee34318 939 CONST GUID_INFO_BLOCK *Id;\r
a405b86d 940\r
e7e0e42b
CP
941 HandleParsingHiiInit();\r
942\r
a405b86d 943 Id = InternalShellGetNodeFromGuid(Guid);\r
6306fd90 944 return (HiiGetString(mHandleParsingHiiHandle, Id==NULL?STRING_TOKEN(STR_UNKNOWN_DEVICE):Id->StringId, Lang));\r
a405b86d 945}\r
946\r
947/**\r
948 Function to dump protocol information from a handle.\r
949\r
950 This function will return a allocated string buffer containing the\r
951 information. The caller is responsible for freeing the memory.\r
952\r
953 If Guid is NULL, ASSERT().\r
954 If TheHandle is NULL, ASSERT().\r
955\r
956 @param[in] TheHandle The handle to dump information from.\r
957 @param[in] Guid The GUID of the protocol to dump.\r
958 @param[in] Verbose TRUE for extra info. FALSE otherwise.\r
959\r
960 @return The pointer to string.\r
961 @retval NULL An error was encountered.\r
962**/\r
963CHAR16*\r
964EFIAPI\r
965GetProtocolInformationDump(\r
966 IN CONST EFI_HANDLE TheHandle,\r
967 IN CONST EFI_GUID *Guid,\r
968 IN CONST BOOLEAN Verbose\r
969 )\r
970{\r
dee34318 971 CONST GUID_INFO_BLOCK *Id;\r
a405b86d 972\r
973 ASSERT(TheHandle != NULL);\r
974 ASSERT(Guid != NULL);\r
975\r
976 if (TheHandle == NULL || Guid == NULL) {\r
977 return (NULL);\r
978 }\r
979\r
980 Id = InternalShellGetNodeFromGuid(Guid);\r
981 if (Id != NULL && Id->DumpInfo != NULL) {\r
982 return (Id->DumpInfo(TheHandle, Verbose));\r
983 }\r
984 return (NULL);\r
985}\r
986\r
987/**\r
988 Function to get the Guid for a protocol or struct based on it's string name.\r
989\r
0a1eb97d
JC
990 do not modify the returned Guid.\r
991\r
a405b86d 992 @param[in] Name The pointer to the string name.\r
993 @param[in] Lang The pointer to the language code.\r
0a1eb97d 994 @param[out] Guid The pointer to the Guid.\r
a405b86d 995\r
996 @retval EFI_SUCCESS The operation was sucessful.\r
997**/\r
998EFI_STATUS\r
999EFIAPI\r
1000GetGuidFromStringName(\r
1001 IN CONST CHAR16 *Name,\r
1002 IN CONST CHAR8 *Lang OPTIONAL,\r
0a1eb97d 1003 OUT EFI_GUID **Guid\r
a405b86d 1004 )\r
1005{\r
dee34318 1006 CONST GUID_INFO_BLOCK *ListWalker;\r
a405b86d 1007 CHAR16 *String;\r
6306fd90 1008 UINTN LoopCount;\r
a405b86d 1009\r
e7e0e42b
CP
1010 HandleParsingHiiInit();\r
1011\r
a405b86d 1012 ASSERT(Guid != NULL);\r
1013 if (Guid == NULL) {\r
1014 return (EFI_INVALID_PARAMETER);\r
1015 }\r
1016 *Guid = NULL;\r
1017\r
1018 if (PcdGetBool(PcdShellIncludeNtGuids)) {\r
1019 for (ListWalker = mGuidStringListNT ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {\r
1020 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);\r
28cdb62b 1021 if (Name != NULL && String != NULL && StringNoCaseCompare (&Name, &String) == 0) {\r
a405b86d 1022 *Guid = ListWalker->GuidId;\r
1023 }\r
1024 SHELL_FREE_NON_NULL(String);\r
1025 if (*Guid != NULL) {\r
1026 return (EFI_SUCCESS);\r
1027 }\r
1028 }\r
1029 }\r
1030 for (ListWalker = mGuidStringList ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {\r
1031 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);\r
28cdb62b 1032 if (Name != NULL && String != NULL && StringNoCaseCompare (&Name, &String) == 0) {\r
a405b86d 1033 *Guid = ListWalker->GuidId;\r
1034 }\r
1035 SHELL_FREE_NON_NULL(String);\r
1036 if (*Guid != NULL) {\r
1037 return (EFI_SUCCESS);\r
1038 }\r
1039 }\r
6306fd90
JC
1040\r
1041 for (LoopCount = 0, ListWalker = GuidList; GuidList != NULL && LoopCount < GuidListCount; LoopCount++, ListWalker++) {\r
1042 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);\r
1043 if (Name != NULL && String != NULL && StringNoCaseCompare (&Name, &String) == 0) {\r
1044 *Guid = ListWalker->GuidId;\r
1045 }\r
1046 SHELL_FREE_NON_NULL(String);\r
1047 if (*Guid != NULL) {\r
1048 return (EFI_SUCCESS);\r
1049 }\r
1050 }\r
1051\r
a405b86d 1052 return (EFI_NOT_FOUND);\r
1053}\r
1054\r
36384ceb
ED
1055/**\r
1056 Get best support language for this driver.\r
1057 \r
a71003f2
ED
1058 First base on the user input language to search, second base on the current \r
1059 platform used language to search, third get the first language from the \r
1060 support language list. The caller need to free the buffer of the best language.\r
36384ceb
ED
1061\r
1062 @param[in] SupportedLanguages The support languages for this driver.\r
a71003f2 1063 @param[in] InputLanguage The user input language.\r
36384ceb
ED
1064 @param[in] Iso639Language Whether get language for ISO639.\r
1065\r
1066 @return The best support language for this driver.\r
1067**/\r
1068CHAR8 *\r
a71003f2 1069EFIAPI\r
36384ceb 1070GetBestLanguageForDriver (\r
a71003f2
ED
1071 IN CONST CHAR8 *SupportedLanguages,\r
1072 IN CONST CHAR8 *InputLanguage,\r
36384ceb
ED
1073 IN BOOLEAN Iso639Language\r
1074 )\r
1075{\r
1076 CHAR8 *LanguageVariable;\r
1077 CHAR8 *BestLanguage;\r
1078\r
1079 LanguageVariable = GetVariable (Iso639Language ? L"Lang" : L"PlatformLang", &gEfiGlobalVariableGuid);\r
1080\r
1081 BestLanguage = GetBestLanguage(\r
1082 SupportedLanguages,\r
1083 Iso639Language,\r
a71003f2 1084 (InputLanguage != NULL) ? InputLanguage : "",\r
36384ceb 1085 (LanguageVariable != NULL) ? LanguageVariable : "",\r
a71003f2 1086 SupportedLanguages,\r
36384ceb
ED
1087 NULL\r
1088 );\r
1089\r
1090 if (LanguageVariable != NULL) {\r
1091 FreePool (LanguageVariable);\r
1092 }\r
1093\r
1094 return BestLanguage;\r
1095}\r
1096\r
a405b86d 1097/**\r
1098 Function to retrieve the driver name (if possible) from the ComponentName or\r
1099 ComponentName2 protocol\r
1100\r
1101 @param[in] TheHandle The driver handle to get the name of.\r
1102 @param[in] Language The language to use.\r
1103\r
1104 @retval NULL The name could not be found.\r
1105 @return A pointer to the string name. Do not de-allocate the memory.\r
1106**/\r
1107CONST CHAR16*\r
1108EFIAPI\r
1109GetStringNameFromHandle(\r
1110 IN CONST EFI_HANDLE TheHandle,\r
1111 IN CONST CHAR8 *Language\r
1112 )\r
1113{\r
1114 EFI_COMPONENT_NAME2_PROTOCOL *CompNameStruct;\r
1115 EFI_STATUS Status;\r
1116 CHAR16 *RetVal;\r
36384ceb
ED
1117 CHAR8 *BestLang;\r
1118\r
1119 BestLang = NULL;\r
a405b86d 1120\r
1121 Status = gBS->OpenProtocol(\r
1122 TheHandle,\r
1123 &gEfiComponentName2ProtocolGuid,\r
1124 (VOID**)&CompNameStruct,\r
1125 gImageHandle,\r
1126 NULL,\r
1127 EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
1128 if (!EFI_ERROR(Status)) {\r
a71003f2
ED
1129 BestLang = GetBestLanguageForDriver (CompNameStruct->SupportedLanguages, Language, FALSE);\r
1130 Status = CompNameStruct->GetDriverName(CompNameStruct, BestLang, &RetVal);\r
36384ceb
ED
1131 if (BestLang != NULL) {\r
1132 FreePool (BestLang);\r
1133 BestLang = NULL;\r
1134 }\r
a405b86d 1135 if (!EFI_ERROR(Status)) {\r
1136 return (RetVal);\r
1137 }\r
1138 }\r
1139 Status = gBS->OpenProtocol(\r
1140 TheHandle,\r
1141 &gEfiComponentNameProtocolGuid,\r
1142 (VOID**)&CompNameStruct,\r
1143 gImageHandle,\r
1144 NULL,\r
1145 EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
1146 if (!EFI_ERROR(Status)) {\r
a71003f2
ED
1147 BestLang = GetBestLanguageForDriver (CompNameStruct->SupportedLanguages, Language, FALSE);\r
1148 Status = CompNameStruct->GetDriverName(CompNameStruct, BestLang, &RetVal);\r
36384ceb
ED
1149 if (BestLang != NULL) {\r
1150 FreePool (BestLang);\r
1151 }\r
a405b86d 1152 if (!EFI_ERROR(Status)) {\r
1153 return (RetVal);\r
1154 }\r
1155 }\r
1156 return (NULL);\r
1157}\r
1158\r
1159/**\r
1160 Function to initialize the file global mHandleList object for use in\r
1161 vonverting handles to index and index to handle.\r
1162\r
1163 @retval EFI_SUCCESS The operation was successful.\r
1164**/\r
1165EFI_STATUS\r
1166EFIAPI\r
1167InternalShellInitHandleList(\r
1168 VOID\r
1169 )\r
1170{\r
1171 EFI_STATUS Status;\r
1172 EFI_HANDLE *HandleBuffer;\r
1173 UINTN HandleCount;\r
1174 HANDLE_LIST *ListWalker;\r
1175\r
1176 if (mHandleList.NextIndex != 0) {\r
1177 return EFI_SUCCESS;\r
1178 }\r
1179 InitializeListHead(&mHandleList.List.Link);\r
1180 mHandleList.NextIndex = 1;\r
1181 Status = gBS->LocateHandleBuffer (\r
1182 AllHandles,\r
1183 NULL,\r
1184 NULL,\r
1185 &HandleCount,\r
1186 &HandleBuffer\r
1187 );\r
1188 ASSERT_EFI_ERROR(Status);\r
1189 if (EFI_ERROR(Status)) {\r
1190 return (Status);\r
1191 }\r
1192 for (mHandleList.NextIndex = 1 ; mHandleList.NextIndex <= HandleCount ; mHandleList.NextIndex++){\r
78ed876b 1193 ListWalker = AllocateZeroPool(sizeof(HANDLE_LIST));\r
a405b86d 1194 ASSERT(ListWalker != NULL);\r
1195 ListWalker->TheHandle = HandleBuffer[mHandleList.NextIndex-1];\r
1196 ListWalker->TheIndex = mHandleList.NextIndex;\r
1197 InsertTailList(&mHandleList.List.Link,&ListWalker->Link);\r
1198 }\r
1199 FreePool(HandleBuffer);\r
1200 return (EFI_SUCCESS);\r
1201}\r
1202\r
1203/**\r
1204 Function to retrieve the human-friendly index of a given handle. If the handle\r
1205 does not have a index one will be automatically assigned. The index value is valid\r
1206 until the termination of the shell application.\r
1207\r
1208 @param[in] TheHandle The handle to retrieve an index for.\r
1209\r
1210 @retval 0 A memory allocation failed.\r
1211 @return The index of the handle.\r
1212\r
1213**/\r
1214UINTN\r
1215EFIAPI\r
1216ConvertHandleToHandleIndex(\r
1217 IN CONST EFI_HANDLE TheHandle\r
1218 )\r
1219{\r
f330ff35 1220 EFI_STATUS Status;\r
1221 EFI_GUID **ProtocolBuffer;\r
1222 UINTN ProtocolCount;\r
1223 HANDLE_LIST *ListWalker;\r
1224\r
78ed876b 1225 if (TheHandle == NULL) {\r
1226 return 0;\r
1227 }\r
a405b86d 1228\r
1229 InternalShellInitHandleList();\r
1230\r
1231 for (ListWalker = (HANDLE_LIST*)GetFirstNode(&mHandleList.List.Link)\r
1232 ; !IsNull(&mHandleList.List.Link,&ListWalker->Link)\r
1233 ; ListWalker = (HANDLE_LIST*)GetNextNode(&mHandleList.List.Link,&ListWalker->Link)\r
1234 ){\r
1235 if (ListWalker->TheHandle == TheHandle) {\r
f330ff35 1236 //\r
1237 // Verify that TheHandle is still present in the Handle Database\r
1238 //\r
1239 Status = gBS->ProtocolsPerHandle(TheHandle, &ProtocolBuffer, &ProtocolCount);\r
1240 if (EFI_ERROR (Status)) {\r
1241 //\r
1242 // TheHandle is not present in the Handle Database, so delete from the handle list\r
1243 //\r
1244 RemoveEntryList (&ListWalker->Link);\r
1245 return 0;\r
1246 }\r
1247 FreePool (ProtocolBuffer);\r
a405b86d 1248 return (ListWalker->TheIndex);\r
1249 }\r
1250 }\r
f330ff35 1251\r
1252 //\r
1253 // Verify that TheHandle is valid handle\r
1254 //\r
1255 Status = gBS->ProtocolsPerHandle(TheHandle, &ProtocolBuffer, &ProtocolCount);\r
1256 if (EFI_ERROR (Status)) {\r
1257 //\r
1258 // TheHandle is not valid, so do not add to handle list\r
1259 //\r
1260 return 0;\r
1261 }\r
1262 FreePool (ProtocolBuffer);\r
1263\r
78ed876b 1264 ListWalker = AllocateZeroPool(sizeof(HANDLE_LIST));\r
a405b86d 1265 ASSERT(ListWalker != NULL);\r
1266 ListWalker->TheHandle = TheHandle;\r
1267 ListWalker->TheIndex = mHandleList.NextIndex++;\r
1268 InsertTailList(&mHandleList.List.Link,&ListWalker->Link);\r
1269 return (ListWalker->TheIndex);\r
1270}\r
1271\r
1272\r
1273\r
1274/**\r
1275 Function to retrieve the EFI_HANDLE from the human-friendly index.\r
1276\r
1277 @param[in] TheIndex The index to retrieve the EFI_HANDLE for.\r
1278\r
1279 @retval NULL The index was invalid.\r
1280 @return The EFI_HANDLE that index represents.\r
1281\r
1282**/\r
1283EFI_HANDLE\r
1284EFIAPI\r
1285ConvertHandleIndexToHandle(\r
1286 IN CONST UINTN TheIndex\r
1287 )\r
1288{\r
f330ff35 1289 EFI_STATUS Status;\r
1290 EFI_GUID **ProtocolBuffer;\r
1291 UINTN ProtocolCount;\r
a405b86d 1292 HANDLE_LIST *ListWalker;\r
1293\r
1294 InternalShellInitHandleList();\r
1295\r
1296 if (TheIndex >= mHandleList.NextIndex) {\r
f330ff35 1297 return NULL;\r
a405b86d 1298 }\r
1299\r
1300 for (ListWalker = (HANDLE_LIST*)GetFirstNode(&mHandleList.List.Link)\r
1301 ; !IsNull(&mHandleList.List.Link,&ListWalker->Link)\r
1302 ; ListWalker = (HANDLE_LIST*)GetNextNode(&mHandleList.List.Link,&ListWalker->Link)\r
1303 ){\r
f330ff35 1304 if (ListWalker->TheIndex == TheIndex && ListWalker->TheHandle != NULL) {\r
1305 //\r
1306 // Verify that LinkWalker->TheHandle is valid handle\r
1307 //\r
1308 Status = gBS->ProtocolsPerHandle(ListWalker->TheHandle, &ProtocolBuffer, &ProtocolCount);\r
1309 if (EFI_ERROR (Status)) {\r
1310 //\r
1311 // TheHandle is not valid, so do not add to handle list\r
1312 //\r
1313 ListWalker->TheHandle = NULL;\r
1314 }\r
a405b86d 1315 return (ListWalker->TheHandle);\r
1316 }\r
1317 }\r
f330ff35 1318 return NULL;\r
a405b86d 1319}\r
1320\r
1321/**\r
1322 Gets all the related EFI_HANDLEs based on the mask supplied.\r
1323\r
1324 This function scans all EFI_HANDLES in the UEFI environment's handle database\r
1325 and returns the ones with the specified relationship (Mask) to the specified\r
1326 controller handle.\r
1327\r
1328 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.\r
1329 If MatchingHandleCount is NULL, then ASSERT.\r
1330\r
1331 If MatchingHandleBuffer is not NULL upon a successful return the memory must be\r
1332 caller freed.\r
1333\r
1334 @param[in] DriverBindingHandle The handle with Driver Binding protocol on it.\r
1335 @param[in] ControllerHandle The handle with Device Path protocol on it.\r
1336 @param[in] MatchingHandleCount The pointer to UINTN that specifies the number of HANDLES in\r
1337 MatchingHandleBuffer.\r
1338 @param[out] MatchingHandleBuffer On a successful return, a buffer of MatchingHandleCount\r
1339 EFI_HANDLEs with a terminating NULL EFI_HANDLE.\r
1340 @param[out] HandleType An array of type information.\r
1341\r
1342 @retval EFI_SUCCESS The operation was successful, and any related handles\r
1343 are in MatchingHandleBuffer.\r
1344 @retval EFI_NOT_FOUND No matching handles were found.\r
1345 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.\r
1346**/\r
1347EFI_STATUS\r
1348EFIAPI\r
1349ParseHandleDatabaseByRelationshipWithType (\r
1350 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL,\r
1351 IN CONST EFI_HANDLE ControllerHandle OPTIONAL,\r
1352 IN UINTN *HandleCount,\r
1353 OUT EFI_HANDLE **HandleBuffer,\r
1354 OUT UINTN **HandleType\r
1355 )\r
1356{\r
1357 EFI_STATUS Status;\r
1358 UINTN HandleIndex;\r
1359 EFI_GUID **ProtocolGuidArray;\r
1360 UINTN ArrayCount;\r
1361 UINTN ProtocolIndex;\r
1362 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *OpenInfo;\r
1363 UINTN OpenInfoCount;\r
1364 UINTN OpenInfoIndex;\r
1365 UINTN ChildIndex;\r
f330ff35 1366 INTN DriverBindingHandleIndex;\r
a405b86d 1367\r
1368 ASSERT(HandleCount != NULL);\r
1369 ASSERT(HandleBuffer != NULL);\r
1370 ASSERT(HandleType != NULL);\r
1371 ASSERT(DriverBindingHandle != NULL || ControllerHandle != NULL);\r
1372\r
1373 *HandleCount = 0;\r
1374 *HandleBuffer = NULL;\r
1375 *HandleType = NULL;\r
1376\r
1377 //\r
1378 // Retrieve the list of all handles from the handle database\r
1379 //\r
1380 Status = gBS->LocateHandleBuffer (\r
1381 AllHandles,\r
1382 NULL,\r
1383 NULL,\r
1384 HandleCount,\r
1385 HandleBuffer\r
1386 );\r
1387 if (EFI_ERROR (Status)) {\r
1388 return (Status);\r
1389 }\r
1390\r
1391 *HandleType = AllocateZeroPool (*HandleCount * sizeof (UINTN));\r
1392 ASSERT(*HandleType != NULL);\r
1393\r
f330ff35 1394 DriverBindingHandleIndex = -1;\r
1395 for (HandleIndex = 0; HandleIndex < *HandleCount; HandleIndex++) {\r
1396 if (DriverBindingHandle != NULL && (*HandleBuffer)[HandleIndex] == DriverBindingHandle) {\r
1397 DriverBindingHandleIndex = (INTN)HandleIndex;\r
1398 }\r
1399 }\r
1400\r
a405b86d 1401 for (HandleIndex = 0; HandleIndex < *HandleCount; HandleIndex++) {\r
1402 //\r
1403 // Retrieve the list of all the protocols on each handle\r
1404 //\r
1405 Status = gBS->ProtocolsPerHandle (\r
1406 (*HandleBuffer)[HandleIndex],\r
1407 &ProtocolGuidArray,\r
1408 &ArrayCount\r
1409 );\r
f330ff35 1410 if (EFI_ERROR (Status)) {\r
1411 continue;\r
1412 }\r
a405b86d 1413\r
f330ff35 1414 for (ProtocolIndex = 0; ProtocolIndex < ArrayCount; ProtocolIndex++) {\r
a405b86d 1415\r
f330ff35 1416 //\r
1417 // Set the bit describing what this handle has\r
1418 //\r
1419 if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiLoadedImageProtocolGuid) ) {\r
7aae3c35 1420 (*HandleType)[HandleIndex] |= (UINTN)HR_IMAGE_HANDLE;\r
f330ff35 1421 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverBindingProtocolGuid) ) {\r
7aae3c35 1422 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_BINDING_HANDLE;\r
f330ff35 1423 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverConfiguration2ProtocolGuid)) {\r
7aae3c35 1424 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_CONFIGURATION_HANDLE;\r
f330ff35 1425 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverConfigurationProtocolGuid) ) {\r
7aae3c35 1426 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_CONFIGURATION_HANDLE;\r
f330ff35 1427 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverDiagnostics2ProtocolGuid) ) {\r
7aae3c35 1428 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_DIAGNOSTICS_HANDLE;\r
f330ff35 1429 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverDiagnosticsProtocolGuid) ) {\r
7aae3c35 1430 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_DIAGNOSTICS_HANDLE;\r
f330ff35 1431 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiComponentName2ProtocolGuid) ) {\r
7aae3c35 1432 (*HandleType)[HandleIndex] |= (UINTN)HR_COMPONENT_NAME_HANDLE;\r
f330ff35 1433 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiComponentNameProtocolGuid) ) {\r
7aae3c35 1434 (*HandleType)[HandleIndex] |= (UINTN)HR_COMPONENT_NAME_HANDLE;\r
f330ff35 1435 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDevicePathProtocolGuid) ) {\r
7aae3c35 1436 (*HandleType)[HandleIndex] |= (UINTN)HR_DEVICE_HANDLE;\r
f330ff35 1437 } else {\r
1438 DEBUG_CODE_BEGIN();\r
1439 ASSERT((*HandleType)[HandleIndex] == (*HandleType)[HandleIndex]);\r
1440 DEBUG_CODE_END();\r
1441 }\r
1442 //\r
1443 // Retrieve the list of agents that have opened each protocol\r
1444 //\r
1445 Status = gBS->OpenProtocolInformation (\r
a405b86d 1446 (*HandleBuffer)[HandleIndex],\r
1447 ProtocolGuidArray[ProtocolIndex],\r
1448 &OpenInfo,\r
1449 &OpenInfoCount\r
1450 );\r
f330ff35 1451 if (EFI_ERROR (Status)) {\r
1452 continue;\r
1453 }\r
1454\r
1455 if (ControllerHandle == NULL) {\r
1456 //\r
1457 // ControllerHandle == NULL and DriverBindingHandle != NULL. \r
1458 // Return information on all the controller handles that the driver specified by DriverBindingHandle is managing\r
1459 //\r
1460 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
1461 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle && (OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
7aae3c35 1462 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);\r
f330ff35 1463 if (DriverBindingHandleIndex != -1) {\r
7aae3c35 1464 (*HandleType)[DriverBindingHandleIndex] |= (UINTN)HR_DEVICE_DRIVER;\r
f330ff35 1465 }\r
1466 }\r
1467 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle && (OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
7aae3c35 1468 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);\r
f330ff35 1469 if (DriverBindingHandleIndex != -1) {\r
7aae3c35 1470 (*HandleType)[DriverBindingHandleIndex] |= (UINTN)(HR_BUS_DRIVER | HR_DEVICE_DRIVER);\r
f330ff35 1471 }\r
1472 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
1473 if (OpenInfo[OpenInfoIndex].ControllerHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 1474 (*HandleType)[ChildIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CHILD_HANDLE);\r
f330ff35 1475 }\r
1476 }\r
1477 }\r
1478 }\r
1479 }\r
1480 if (DriverBindingHandle == NULL && ControllerHandle != NULL) {\r
1481 if (ControllerHandle == (*HandleBuffer)[HandleIndex]) {\r
7aae3c35 1482 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);\r
a405b86d 1483 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
f330ff35 1484 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
1485 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
1486 if (OpenInfo[OpenInfoIndex].AgentHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 1487 (*HandleType)[ChildIndex] |= (UINTN)HR_DEVICE_DRIVER;\r
f330ff35 1488 }\r
a405b86d 1489 }\r
f330ff35 1490 }\r
1491 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
1492 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
1493 if (OpenInfo[OpenInfoIndex].AgentHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 1494 (*HandleType)[ChildIndex] |= (UINTN)(HR_BUS_DRIVER | HR_DEVICE_DRIVER);\r
f330ff35 1495 }\r
1496 if (OpenInfo[OpenInfoIndex].ControllerHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 1497 (*HandleType)[ChildIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CHILD_HANDLE);\r
a405b86d 1498 }\r
1499 }\r
1500 }\r
f330ff35 1501 }\r
1502 } else {\r
1503 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
1504 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
1505 if (OpenInfo[OpenInfoIndex].ControllerHandle == ControllerHandle) {\r
7aae3c35 1506 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_PARENT_HANDLE);\r
f330ff35 1507 }\r
1508 }\r
1509 }\r
1510 }\r
1511 }\r
1512 if (DriverBindingHandle != NULL && ControllerHandle != NULL) {\r
1513 if (ControllerHandle == (*HandleBuffer)[HandleIndex]) {\r
7aae3c35 1514 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);\r
f330ff35 1515 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
1516 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
1517 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle) {\r
1518 if (DriverBindingHandleIndex != -1) {\r
7aae3c35 1519 (*HandleType)[DriverBindingHandleIndex] |= (UINTN)HR_DEVICE_DRIVER;\r
a405b86d 1520 }\r
1521 }\r
f330ff35 1522 }\r
1523 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
1524 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle) {\r
a405b86d 1525 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
f330ff35 1526 if (OpenInfo[OpenInfoIndex].ControllerHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 1527 (*HandleType)[ChildIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CHILD_HANDLE);\r
a405b86d 1528 }\r
1529 }\r
1530 }\r
f330ff35 1531\r
1532 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
1533 if (OpenInfo[OpenInfoIndex].AgentHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 1534 (*HandleType)[ChildIndex] |= (UINTN)(HR_BUS_DRIVER | HR_DEVICE_DRIVER);\r
f330ff35 1535 }\r
1536 }\r
1537 }\r
1538 }\r
1539 } else {\r
1540 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
1541 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
1542 if (OpenInfo[OpenInfoIndex].ControllerHandle == ControllerHandle) {\r
7aae3c35 1543 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_PARENT_HANDLE);\r
f330ff35 1544 }\r
a405b86d 1545 }\r
1546 }\r
a405b86d 1547 }\r
1548 }\r
f330ff35 1549 FreePool (OpenInfo);\r
a405b86d 1550 }\r
f330ff35 1551 FreePool (ProtocolGuidArray);\r
a405b86d 1552 }\r
f330ff35 1553 return EFI_SUCCESS;\r
a405b86d 1554}\r
1555\r
1556/**\r
1557 Gets all the related EFI_HANDLEs based on the single EFI_HANDLE and the mask\r
1558 supplied.\r
1559\r
1560 This function will scan all EFI_HANDLES in the UEFI environment's handle database\r
1561 and return all the ones with the specified relationship (Mask) to the specified\r
1562 controller handle.\r
1563\r
1564 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.\r
1565 If MatchingHandleCount is NULL, then ASSERT.\r
1566\r
1567 If MatchingHandleBuffer is not NULL upon a sucessful return the memory must be\r
1568 caller freed.\r
1569\r
1570 @param[in] DriverBindingHandle Handle to a object with Driver Binding protocol\r
1571 on it.\r
1572 @param[in] ControllerHandle Handle to a device with Device Path protocol on it.\r
1573 @param[in] Mask Mask of what relationship(s) is desired.\r
1574 @param[in] MatchingHandleCount Poitner to UINTN specifying number of HANDLES in\r
1575 MatchingHandleBuffer.\r
1576 @param[out] MatchingHandleBuffer On a sucessful return a buffer of MatchingHandleCount\r
1577 EFI_HANDLEs and a terminating NULL EFI_HANDLE.\r
1578\r
1579 @retval EFI_SUCCESS The operation was sucessful and any related handles\r
1580 are in MatchingHandleBuffer;\r
1581 @retval EFI_NOT_FOUND No matching handles were found.\r
1582 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.\r
1583**/\r
1584EFI_STATUS\r
1585EFIAPI\r
1586ParseHandleDatabaseByRelationship (\r
1587 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL,\r
1588 IN CONST EFI_HANDLE ControllerHandle OPTIONAL,\r
1589 IN CONST UINTN Mask,\r
1590 IN UINTN *MatchingHandleCount,\r
1591 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL\r
1592 )\r
1593{\r
1594 EFI_STATUS Status;\r
1595 UINTN HandleCount;\r
1596 EFI_HANDLE *HandleBuffer;\r
1597 UINTN *HandleType;\r
1598 UINTN HandleIndex;\r
1599\r
1600 ASSERT(MatchingHandleCount != NULL);\r
1601 ASSERT(DriverBindingHandle != NULL || ControllerHandle != NULL);\r
1602\r
1603 if ((Mask & HR_VALID_MASK) != Mask) {\r
1604 return (EFI_INVALID_PARAMETER);\r
1605 }\r
1606\r
1607 if ((Mask & HR_CHILD_HANDLE) != 0 && DriverBindingHandle == NULL) {\r
1608 return (EFI_INVALID_PARAMETER);\r
1609 }\r
1610\r
1611 *MatchingHandleCount = 0;\r
1612 if (MatchingHandleBuffer != NULL) {\r
1613 *MatchingHandleBuffer = NULL;\r
1614 }\r
1615\r
1616 HandleBuffer = NULL;\r
1617 HandleType = NULL;\r
1618\r
1619 Status = ParseHandleDatabaseByRelationshipWithType (\r
1620 DriverBindingHandle,\r
1621 ControllerHandle,\r
1622 &HandleCount,\r
1623 &HandleBuffer,\r
1624 &HandleType\r
1625 );\r
1626 if (!EFI_ERROR (Status)) {\r
1627 //\r
1628 // Count the number of handles that match the attributes in Mask\r
1629 //\r
1630 for (HandleIndex = 0; HandleIndex < HandleCount; HandleIndex++) {\r
1631 if ((HandleType[HandleIndex] & Mask) == Mask) {\r
1632 (*MatchingHandleCount)++;\r
1633 }\r
1634 }\r
1635 //\r
1636 // If no handles match the attributes in Mask then return EFI_NOT_FOUND\r
1637 //\r
1638 if (*MatchingHandleCount == 0) {\r
1639 Status = EFI_NOT_FOUND;\r
1640 } else {\r
1641\r
1642 if (MatchingHandleBuffer == NULL) {\r
1643 //\r
1644 // Someone just wanted the count...\r
1645 //\r
1646 Status = EFI_SUCCESS;\r
1647 } else {\r
1648 //\r
1649 // Allocate a handle buffer for the number of handles that matched the attributes in Mask\r
1650 //\r
78ed876b 1651 *MatchingHandleBuffer = AllocateZeroPool ((*MatchingHandleCount +1)* sizeof (EFI_HANDLE));\r
a405b86d 1652 ASSERT(*MatchingHandleBuffer != NULL);\r
1653\r
1654 for (HandleIndex = 0,*MatchingHandleCount = 0\r
1655 ; HandleIndex < HandleCount\r
1656 ; HandleIndex++\r
1657 ){\r
1658 //\r
1659 // Fill the allocated buffer with the handles that matched the attributes in Mask\r
1660 //\r
1661 if ((HandleType[HandleIndex] & Mask) == Mask) {\r
1662 (*MatchingHandleBuffer)[(*MatchingHandleCount)++] = HandleBuffer[HandleIndex];\r
1663 }\r
1664 }\r
1665\r
1666 //\r
1667 // Make the last one NULL\r
1668 //\r
1669 (*MatchingHandleBuffer)[*MatchingHandleCount] = NULL;\r
1670\r
1671 Status = EFI_SUCCESS;\r
1672 } // MacthingHandleBuffer == NULL (ELSE)\r
1673 } // *MatchingHandleCount == 0 (ELSE)\r
1674 } // no error on ParseHandleDatabaseByRelationshipWithType\r
1675\r
1676 if (HandleBuffer != NULL) {\r
1677 FreePool (HandleBuffer);\r
1678 }\r
1679\r
1680 if (HandleType != NULL) {\r
1681 FreePool (HandleType);\r
1682 }\r
1683\r
1684 return Status;\r
1685}\r
1686\r
1687/**\r
1688 Gets handles for any child controllers of the passed in controller.\r
1689\r
1690 @param[in] ControllerHandle The handle of the "parent controller"\r
1691 @param[in] MatchingHandleCount Pointer to the number of handles in\r
1692 MatchingHandleBuffer on return.\r
1693 @param[out] MatchingHandleBuffer Buffer containing handles on a successful\r
1694 return.\r
1695\r
1696\r
1697 @retval EFI_SUCCESS The operation was sucessful.\r
1698**/\r
1699EFI_STATUS\r
1700EFIAPI\r
1701ParseHandleDatabaseForChildControllers(\r
1702 IN CONST EFI_HANDLE ControllerHandle,\r
1703 IN UINTN *MatchingHandleCount,\r
1704 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL\r
1705 )\r
1706{\r
1707 EFI_STATUS Status;\r
f330ff35 1708 UINTN HandleIndex;\r
a405b86d 1709 UINTN DriverBindingHandleCount;\r
1710 EFI_HANDLE *DriverBindingHandleBuffer;\r
1711 UINTN DriverBindingHandleIndex;\r
1712 UINTN ChildControllerHandleCount;\r
1713 EFI_HANDLE *ChildControllerHandleBuffer;\r
1714 UINTN ChildControllerHandleIndex;\r
a405b86d 1715 EFI_HANDLE *HandleBufferForReturn;\r
1716\r
ff51746b 1717 if (MatchingHandleCount == NULL) {\r
1718 return (EFI_INVALID_PARAMETER);\r
1719 }\r
64d753f1 1720 *MatchingHandleCount = 0;\r
a405b86d 1721\r
1722 Status = PARSE_HANDLE_DATABASE_UEFI_DRIVERS (\r
1723 ControllerHandle,\r
1724 &DriverBindingHandleCount,\r
1725 &DriverBindingHandleBuffer\r
1726 );\r
1727 if (EFI_ERROR (Status)) {\r
1728 return Status;\r
1729 }\r
1730\r
ff51746b 1731 //\r
1732 // Get a buffer big enough for all the controllers.\r
1733 //\r
f330ff35 1734 HandleBufferForReturn = GetHandleListByProtocol(NULL);\r
a405b86d 1735 if (HandleBufferForReturn == NULL) {\r
1736 FreePool (DriverBindingHandleBuffer);\r
ff51746b 1737 return (EFI_NOT_FOUND);\r
a405b86d 1738 }\r
1739\r
a405b86d 1740 for (DriverBindingHandleIndex = 0; DriverBindingHandleIndex < DriverBindingHandleCount; DriverBindingHandleIndex++) {\r
1741 Status = PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (\r
1742 DriverBindingHandleBuffer[DriverBindingHandleIndex],\r
1743 ControllerHandle,\r
1744 &ChildControllerHandleCount,\r
1745 &ChildControllerHandleBuffer\r
1746 );\r
1747 if (EFI_ERROR (Status)) {\r
1748 continue;\r
1749 }\r
1750\r
1751 for (ChildControllerHandleIndex = 0;\r
1752 ChildControllerHandleIndex < ChildControllerHandleCount;\r
1753 ChildControllerHandleIndex++\r
1754 ) {\r
f330ff35 1755 for (HandleIndex = 0; HandleIndex < *MatchingHandleCount; HandleIndex++) {\r
1756 if (HandleBufferForReturn[HandleIndex] == ChildControllerHandleBuffer[ChildControllerHandleIndex]) {\r
1757 break;\r
1758 }\r
1759 }\r
1760 if (HandleIndex >= *MatchingHandleCount) {\r
1761 HandleBufferForReturn[(*MatchingHandleCount)++] = ChildControllerHandleBuffer[ChildControllerHandleIndex];\r
1762 }\r
a405b86d 1763 }\r
1764\r
1765 FreePool (ChildControllerHandleBuffer);\r
1766 }\r
1767\r
1768 FreePool (DriverBindingHandleBuffer);\r
1769\r
1770 if (MatchingHandleBuffer != NULL) {\r
1771 *MatchingHandleBuffer = HandleBufferForReturn;\r
1772 } else {\r
1773 FreePool(HandleBufferForReturn);\r
1774 }\r
1775\r
1776 return (EFI_SUCCESS);\r
1777}\r
1778\r
1779/**\r
1780 Appends 1 buffer to another buffer. This will re-allocate the destination buffer\r
1781 if necessary to fit all of the data.\r
1782\r
1783 If DestinationBuffer is NULL, then ASSERT().\r
1784\r
4ff7e37b
ED
1785 @param[in, out] DestinationBuffer The pointer to the pointer to the buffer to append onto.\r
1786 @param[in, out] DestinationSize The pointer to the size of DestinationBuffer.\r
1787 @param[in] SourceBuffer The pointer to the buffer to append onto DestinationBuffer.\r
1788 @param[in] SourceSize The number of bytes of SourceBuffer to append.\r
a405b86d 1789\r
1790 @retval NULL A memory allocation failed.\r
1791 @retval NULL A parameter was invalid.\r
1792 @return A pointer to (*DestinationBuffer).\r
1793**/\r
1794VOID*\r
1795EFIAPI\r
1796BuffernCatGrow (\r
1797 IN OUT VOID **DestinationBuffer,\r
1798 IN OUT UINTN *DestinationSize,\r
1799 IN VOID *SourceBuffer,\r
1800 IN UINTN SourceSize\r
1801 )\r
1802{\r
1803 UINTN LocalDestinationSize;\r
1804 UINTN LocalDestinationFinalSize;\r
1805\r
1806 ASSERT(DestinationBuffer != NULL);\r
1807\r
1808 if (SourceSize == 0 || SourceBuffer == NULL) {\r
1809 return (*DestinationBuffer);\r
1810 }\r
1811\r
1812 if (DestinationSize == NULL) {\r
1813 LocalDestinationSize = 0;\r
1814 } else {\r
1815 LocalDestinationSize = *DestinationSize;\r
1816 }\r
1817\r
1818 LocalDestinationFinalSize = LocalDestinationSize + SourceSize;\r
1819\r
1820 if (DestinationSize != NULL) {\r
1821 *DestinationSize = LocalDestinationSize;\r
1822 }\r
1823\r
1824 if (LocalDestinationSize == 0) {\r
1825 // allcoate\r
78ed876b 1826 *DestinationBuffer = AllocateZeroPool(LocalDestinationFinalSize);\r
a405b86d 1827 } else {\r
1828 // reallocate\r
1829 *DestinationBuffer = ReallocatePool(LocalDestinationSize, LocalDestinationFinalSize, *DestinationBuffer);\r
1830 }\r
1831\r
1832 ASSERT(*DestinationBuffer != NULL);\r
1833\r
1834 // copy\r
1835 return (CopyMem(((UINT8*)(*DestinationBuffer)) + LocalDestinationSize, SourceBuffer, SourceSize));\r
1836}\r
1837\r
1838/**\r
1839 Gets handles for any child devices produced by the passed in driver.\r
1840\r
1841 @param[in] DriverHandle The handle of the driver.\r
1842 @param[in] MatchingHandleCount Pointer to the number of handles in\r
1843 MatchingHandleBuffer on return.\r
1844 @param[out] MatchingHandleBuffer Buffer containing handles on a successful\r
1845 return.\r
1846 @retval EFI_SUCCESS The operation was sucessful.\r
1847 @sa ParseHandleDatabaseByRelationship\r
1848**/\r
1849EFI_STATUS\r
1850EFIAPI\r
1851ParseHandleDatabaseForChildDevices(\r
1852 IN CONST EFI_HANDLE DriverHandle,\r
1853 IN UINTN *MatchingHandleCount,\r
1854 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL\r
1855 )\r
1856{\r
1857 EFI_HANDLE *Buffer;\r
1858 EFI_HANDLE *Buffer2;\r
1859 UINTN Count1;\r
1860 UINTN Count2;\r
1861 UINTN HandleIndex;\r
1862 EFI_STATUS Status;\r
1863 UINTN HandleBufferSize;\r
1864\r
1865 ASSERT(MatchingHandleCount != NULL);\r
1866\r
1867 HandleBufferSize = 0;\r
1868 Buffer = NULL;\r
1869 Buffer2 = NULL;\r
1870 *MatchingHandleCount = 0;\r
1871\r
1872 Status = PARSE_HANDLE_DATABASE_DEVICES (\r
1873 DriverHandle,\r
1874 &Count1,\r
1875 &Buffer\r
1876 );\r
1877 if (!EFI_ERROR (Status)) {\r
1878 for (HandleIndex = 0; HandleIndex < Count1; HandleIndex++) {\r
1879 //\r
1880 // now find the children\r
1881 //\r
1882 Status = PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (\r
1883 DriverHandle,\r
1884 Buffer[HandleIndex],\r
1885 &Count2,\r
1886 &Buffer2\r
1887 );\r
1888 if (EFI_ERROR(Status)) {\r
1889 break;\r
1890 }\r
1891 //\r
1892 // save out required and optional data elements\r
1893 //\r
1894 *MatchingHandleCount += Count2;\r
1895 if (MatchingHandleBuffer != NULL) {\r
1896 *MatchingHandleBuffer = BuffernCatGrow((VOID**)MatchingHandleBuffer, &HandleBufferSize, Buffer2, Count2 * sizeof(Buffer2[0]));\r
1897 }\r
1898\r
1899 //\r
1900 // free the memory\r
1901 //\r
1902 if (Buffer2 != NULL) {\r
1903 FreePool(Buffer2);\r
1904 }\r
1905 }\r
1906 }\r
1907\r
1908 if (Buffer != NULL) {\r
1909 FreePool(Buffer);\r
1910 }\r
1911 return (Status);\r
1912}\r
1913\r
1914/**\r
1915 Function to get all handles that support a given protocol or all handles.\r
1916\r
1917 @param[in] ProtocolGuid The guid of the protocol to get handles for. If NULL\r
1918 then the function will return all handles.\r
1919\r
1920 @retval NULL A memory allocation failed.\r
1921 @return A NULL terminated list of handles.\r
1922**/\r
1923EFI_HANDLE*\r
1924EFIAPI\r
40d7a9cf 1925GetHandleListByProtocol (\r
a405b86d 1926 IN CONST EFI_GUID *ProtocolGuid OPTIONAL\r
1927 )\r
1928{\r
1929 EFI_HANDLE *HandleList;\r
1930 UINTN Size;\r
1931 EFI_STATUS Status;\r
1932\r
1933 Size = 0;\r
1934 HandleList = NULL;\r
1935\r
1936 //\r
1937 // We cannot use LocateHandleBuffer since we need that NULL item on the ends of the list!\r
1938 //\r
1939 if (ProtocolGuid == NULL) {\r
1940 Status = gBS->LocateHandle(AllHandles, NULL, NULL, &Size, HandleList);\r
1941 if (Status == EFI_BUFFER_TOO_SMALL) {\r
78ed876b 1942 HandleList = AllocateZeroPool(Size + sizeof(EFI_HANDLE));\r
40d7a9cf 1943 if (HandleList == NULL) {\r
1944 return (NULL);\r
1945 }\r
a405b86d 1946 Status = gBS->LocateHandle(AllHandles, NULL, NULL, &Size, HandleList);\r
1947 HandleList[Size/sizeof(EFI_HANDLE)] = NULL;\r
1948 }\r
1949 } else {\r
1950 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)ProtocolGuid, NULL, &Size, HandleList);\r
1951 if (Status == EFI_BUFFER_TOO_SMALL) {\r
78ed876b 1952 HandleList = AllocateZeroPool(Size + sizeof(EFI_HANDLE));\r
40d7a9cf 1953 if (HandleList == NULL) {\r
1954 return (NULL);\r
1955 }\r
a405b86d 1956 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)ProtocolGuid, NULL, &Size, HandleList);\r
1957 HandleList[Size/sizeof(EFI_HANDLE)] = NULL;\r
1958 }\r
1959 }\r
1960 if (EFI_ERROR(Status)) {\r
1961 if (HandleList != NULL) {\r
1962 FreePool(HandleList);\r
1963 }\r
1964 return (NULL);\r
1965 }\r
1966 return (HandleList);\r
1967}\r
1968\r
1969/**\r
1970 Function to get all handles that support some protocols.\r
1971\r
1972 @param[in] ProtocolGuids A NULL terminated list of protocol GUIDs.\r
1973\r
1974 @retval NULL A memory allocation failed.\r
ff51746b 1975 @retval NULL ProtocolGuids was NULL.\r
1976 @return A NULL terminated list of EFI_HANDLEs.\r
a405b86d 1977**/\r
1978EFI_HANDLE*\r
1979EFIAPI\r
40d7a9cf 1980GetHandleListByProtocolList (\r
a405b86d 1981 IN CONST EFI_GUID **ProtocolGuids\r
1982 )\r
1983{\r
1984 EFI_HANDLE *HandleList;\r
1985 UINTN Size;\r
1986 UINTN TotalSize;\r
40d7a9cf 1987 UINTN TempSize;\r
a405b86d 1988 EFI_STATUS Status;\r
1989 CONST EFI_GUID **GuidWalker;\r
1990 EFI_HANDLE *HandleWalker1;\r
1991 EFI_HANDLE *HandleWalker2;\r
1992\r
1993 Size = 0;\r
1994 HandleList = NULL;\r
1995 TotalSize = sizeof(EFI_HANDLE);\r
1996\r
1997 for (GuidWalker = ProtocolGuids ; GuidWalker != NULL && *GuidWalker != NULL ; GuidWalker++,Size = 0){\r
1998 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)(*GuidWalker), NULL, &Size, NULL);\r
1999 if (Status == EFI_BUFFER_TOO_SMALL) {\r
2000 TotalSize += Size;\r
2001 }\r
2002 }\r
40d7a9cf 2003\r
2004 //\r
2005 // No handles were found... \r
2006 //\r
2007 if (TotalSize == sizeof(EFI_HANDLE)) {\r
2008 return (NULL);\r
2009 }\r
2010\r
2011 HandleList = AllocateZeroPool(TotalSize);\r
a405b86d 2012 if (HandleList == NULL) {\r
2013 return (NULL);\r
2014 }\r
2015\r
2016 Size = 0;\r
2017 for (GuidWalker = ProtocolGuids ; GuidWalker != NULL && *GuidWalker != NULL ; GuidWalker++){\r
40d7a9cf 2018 TempSize = TotalSize - Size;\r
ff51746b 2019 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)(*GuidWalker), NULL, &TempSize, HandleList+(Size/sizeof(EFI_HANDLE)));\r
40d7a9cf 2020\r
2021 //\r
2022 // Allow for missing protocols... Only update the 'used' size upon success.\r
2023 //\r
2024 if (!EFI_ERROR(Status)) {\r
ff51746b 2025 Size += TempSize;\r
40d7a9cf 2026 }\r
a405b86d 2027 }\r
ff51746b 2028 ASSERT(HandleList[(TotalSize/sizeof(EFI_HANDLE))-1] == NULL);\r
a405b86d 2029\r
2030 for (HandleWalker1 = HandleList ; HandleWalker1 != NULL && *HandleWalker1 != NULL ; HandleWalker1++) {\r
2031 for (HandleWalker2 = HandleWalker1 + 1; HandleWalker2 != NULL && *HandleWalker2 != NULL ; HandleWalker2++) {\r
2032 if (*HandleWalker1 == *HandleWalker2) {\r
2033 //\r
2034 // copy memory back 1 handle width.\r
2035 //\r
2036 CopyMem(HandleWalker2, HandleWalker2 + 1, TotalSize - ((HandleWalker2-HandleList+1)*sizeof(EFI_HANDLE)));\r
2037 }\r
2038 }\r
2039 }\r
2040\r
2041 return (HandleList);\r
2042}\r
2043\r
2044\r
2045\r
2046\r
2047\r
2048\r
2049\r
2050\r
2051\r
2052\r