projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
ArmPlatformPkg: Fixed build
[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
59febea1 4 Copyright (c) 2013 - 2014, Hewlett-Packard Development Company, L.P.<BR>\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
59febea1
SEHM		 584/**\r
585 Function to dump information about EfiAdapterInformation Protocol.\r
586\r
587 @param[in] TheHandle The handle that has the protocol installed.\r
588 @param[in] Verbose TRUE for additional information, FALSE otherwise.\r
589\r
590 @retval A pointer to a string containing the information.\r
591**/\r
592CHAR16*\r
593EFIAPI\r
594AdapterInformationDumpInformation (\r
595 IN CONST EFI_HANDLE TheHandle,\r
596 IN CONST BOOLEAN Verbose\r
597 )\r
598{\r
599 EFI_STATUS Status;\r
600 EFI_ADAPTER_INFORMATION_PROTOCOL *EfiAdptrInfoProtocol;\r
601 UINTN InfoTypesBufferCount;\r
602 UINTN GuidIndex;\r
603 EFI_GUID *InfoTypesBuffer;\r
604 CHAR16 *GuidStr;\r
605 CHAR16 *TempStr;\r
606 CHAR16 *RetVal;\r
607 VOID *InformationBlock;\r
608 UINTN InformationBlockSize;\r
609 \r
610 if (!Verbose) {\r
611 return (CatSPrint(NULL, L"AdapterInfo"));\r
612 }\r
613\r
614 //\r
615 // Allocate print buffer to store data\r
616 //\r
617 RetVal = AllocateZeroPool (PcdGet16(PcdShellPrintBufferSize));\r
618 if (RetVal == NULL) {\r
619 return NULL;\r
620 }\r
621\r
622 Status = gBS->OpenProtocol (\r
623 (EFI_HANDLE) (TheHandle),\r
624 &gEfiAdapterInformationProtocolGuid,\r
625 (VOID **) &EfiAdptrInfoProtocol,\r
626 NULL,\r
627 NULL,\r
628 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
629 );\r
630\r
631 if (EFI_ERROR (Status)) {\r
632 SHELL_FREE_NON_NULL (RetVal);\r
633 return NULL;\r
634 }\r
635\r
636 //\r
637 // Get a list of supported information types for this instance of the protocol.\r
638 //\r
639 Status = EfiAdptrInfoProtocol->GetSupportedTypes (\r
640 EfiAdptrInfoProtocol,\r
641 &InfoTypesBuffer, \r
642 &InfoTypesBufferCount\r
643 );\r
644 if (EFI_ERROR (Status)) {\r
645 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_GET_SUPP_TYPES_FAILED), NULL);\r
646 RetVal = CatSPrint (RetVal, TempStr, Status);\r
647 } else {\r
648 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_SUPP_TYPE_HEADER), NULL);\r
649 RetVal = CatSPrint (RetVal, TempStr);\r
650 SHELL_FREE_NON_NULL (TempStr);\r
651\r
652 for (GuidIndex = 0; GuidIndex < InfoTypesBufferCount; GuidIndex++) {\r
653 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_GUID_NUMBER), NULL);\r
654 RetVal = CatSPrint (RetVal, TempStr, (GuidIndex + 1), InfoTypesBuffer[GuidIndex]);\r
655 SHELL_FREE_NON_NULL (TempStr);\r
656\r
657 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_GUID_STRING), NULL);\r
658\r
659 if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoMediaStateGuid)) {\r
660 RetVal = CatSPrint (RetVal, TempStr, L"gEfiAdapterInfoMediaStateGuid");\r
661 } else if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoNetworkBootGuid)) {\r
662 RetVal = CatSPrint (RetVal, TempStr, L"gEfiAdapterInfoNetworkBootGuid");\r
663 } else if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoSanMacAddressGuid)) {\r
664 RetVal = CatSPrint (RetVal, TempStr, L"gEfiAdapterInfoSanMacAddressGuid");\r
665 } else {\r
666\r
667 GuidStr = GetStringNameFromGuid (&InfoTypesBuffer[GuidIndex], NULL);\r
668 \r
669 if (GuidStr != NULL) {\r
670 if (StrCmp(GuidStr, L"UnknownDevice") == 0) {\r
671 RetVal = CatSPrint (RetVal, TempStr, L"UnknownInfoType");\r
672 \r
673 SHELL_FREE_NON_NULL (TempStr);\r
674 SHELL_FREE_NON_NULL(GuidStr);\r
675 //\r
676 // So that we never have to pass this UnknownInfoType to the parsing function "GetInformation" service of AIP\r
677 //\r
678 continue; \r
679 } else {\r
680 RetVal = CatSPrint (RetVal, TempStr, GuidStr);\r
681 SHELL_FREE_NON_NULL(GuidStr);\r
682 }\r
683 }\r
684 }\r
685 \r
686 SHELL_FREE_NON_NULL (TempStr);\r
687\r
688 Status = EfiAdptrInfoProtocol->GetInformation (\r
689 EfiAdptrInfoProtocol,\r
690 &InfoTypesBuffer[GuidIndex],\r
691 &InformationBlock,\r
692 &InformationBlockSize\r
693 );\r
694\r
695 if (EFI_ERROR (Status)) {\r
696 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_GETINFO_FAILED), NULL);\r
697 RetVal = CatSPrint (RetVal, TempStr, Status);\r
698 } else {\r
699 if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoMediaStateGuid)) {\r
700 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_MEDIA_STATE), NULL);\r
701 RetVal = CatSPrint (\r
702 RetVal,\r
703 TempStr,\r
704 ((EFI_ADAPTER_INFO_MEDIA_STATE *)InformationBlock)->MediaState,\r
705 ((EFI_ADAPTER_INFO_MEDIA_STATE *)InformationBlock)->MediaState\r
706 );\r
707 } else if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoNetworkBootGuid)) {\r
708 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_NETWORK_BOOT_INFO), NULL);\r
709 RetVal = CatSPrint (\r
710 RetVal,\r
711 TempStr,\r
712 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->iScsiIpv4BootCapablity,\r
713 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->iScsiIpv6BootCapablity, \r
714 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->FCoeBootCapablity, \r
715 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->OffloadCapability, \r
716 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->iScsiMpioCapability, \r
717 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->iScsiIpv4Boot, \r
718 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->iScsiIpv6Boot,\r
719 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->FCoeBoot\r
720 );\r
721 } else if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoSanMacAddressGuid) == TRUE) { \r
722 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_SAN_MAC_ADDRESS_INFO), NULL);\r
723 RetVal = CatSPrint (\r
724 RetVal,\r
725 TempStr,\r
726 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[0], \r
727 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[1], \r
728 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[2],\r
729 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[3], \r
730 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[4], \r
731 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[5]\r
732 ); \r
733 } else {\r
734 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_UNKNOWN_INFO_TYPE), NULL);\r
735 RetVal = CatSPrint (RetVal, TempStr, &InfoTypesBuffer[GuidIndex]);\r
736 }\r
737 }\r
738 SHELL_FREE_NON_NULL (TempStr);\r
739 SHELL_FREE_NON_NULL (InformationBlock);\r
740 }\r
741 }\r
742\r
743 return RetVal;\r
744}\r
a405b86d 745//\r
746// Put the information on the NT32 protocol GUIDs here so we are not dependant on the Nt32Pkg\r
747//\r
748#define LOCAL_EFI_WIN_NT_THUNK_PROTOCOL_GUID \\r
749 { \\r
ce68d3bc 750 0x58c518b1, 0x76f3, 0x11d4, { 0xbc, 0xea, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
a405b86d 751 }\r
752\r
753#define LOCAL_EFI_WIN_NT_BUS_DRIVER_IO_PROTOCOL_GUID \\r
754 { \\r
ce68d3bc 755 0x96eb4ad6, 0xa32a, 0x11d4, { 0xbc, 0xfd, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
a405b86d 756 }\r
757\r
758#define LOCAL_EFI_WIN_NT_SERIAL_PORT_GUID \\r
759 { \\r
ce68d3bc 760 0xc95a93d, 0xa006, 0x11d4, { 0xbc, 0xfa, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
a405b86d 761 }\r
762STATIC CONST EFI_GUID WinNtThunkProtocolGuid = LOCAL_EFI_WIN_NT_THUNK_PROTOCOL_GUID;\r
763STATIC CONST EFI_GUID WinNtIoProtocolGuid = LOCAL_EFI_WIN_NT_BUS_DRIVER_IO_PROTOCOL_GUID;\r
764STATIC CONST EFI_GUID WinNtSerialPortGuid = LOCAL_EFI_WIN_NT_SERIAL_PORT_GUID;\r
765\r
dee34318 766STATIC CONST GUID_INFO_BLOCK mGuidStringListNT[] = {\r
a405b86d 767 {STRING_TOKEN(STR_WINNT_THUNK), (EFI_GUID*)&WinNtThunkProtocolGuid, NULL},\r
768 {STRING_TOKEN(STR_WINNT_DRIVER_IO), (EFI_GUID*)&WinNtIoProtocolGuid, NULL},\r
769 {STRING_TOKEN(STR_WINNT_SERIAL_PORT), (EFI_GUID*)&WinNtSerialPortGuid, NULL},\r
770 {STRING_TOKEN(STR_UNKNOWN_DEVICE), NULL, NULL},\r
771};\r
772\r
dee34318 773STATIC CONST GUID_INFO_BLOCK mGuidStringList[] = {\r
efb76d1a 774 {STRING_TOKEN(STR_LOADED_IMAGE), &gEfiLoadedImageProtocolGuid, LoadedImageProtocolDumpInformation},\r
a405b86d 775 {STRING_TOKEN(STR_DEVICE_PATH), &gEfiDevicePathProtocolGuid, DevicePathProtocolDumpInformation},\r
776 {STRING_TOKEN(STR_IMAGE_PATH), &gEfiLoadedImageDevicePathProtocolGuid, DevicePathProtocolDumpInformation},\r
777 {STRING_TOKEN(STR_DEVICE_PATH_UTIL), &gEfiDevicePathUtilitiesProtocolGuid, NULL},\r
778 {STRING_TOKEN(STR_DEVICE_PATH_TXT), &gEfiDevicePathToTextProtocolGuid, NULL},\r
779 {STRING_TOKEN(STR_DEVICE_PATH_FTXT), &gEfiDevicePathFromTextProtocolGuid, NULL},\r
780 {STRING_TOKEN(STR_DEVICE_PATH_PC), &gEfiPcAnsiGuid, NULL},\r
781 {STRING_TOKEN(STR_DEVICE_PATH_VT100), &gEfiVT100Guid, NULL},\r
782 {STRING_TOKEN(STR_DEVICE_PATH_VT100P), &gEfiVT100PlusGuid, NULL},\r
783 {STRING_TOKEN(STR_DEVICE_PATH_VTUTF8), &gEfiVTUTF8Guid, NULL},\r
784 {STRING_TOKEN(STR_DRIVER_BINDING), &gEfiDriverBindingProtocolGuid, NULL},\r
785 {STRING_TOKEN(STR_PLATFORM_OVERRIDE), &gEfiPlatformDriverOverrideProtocolGuid, NULL},\r
786 {STRING_TOKEN(STR_BUS_OVERRIDE), &gEfiBusSpecificDriverOverrideProtocolGuid, NULL},\r
787 {STRING_TOKEN(STR_DRIVER_DIAG), &gEfiDriverDiagnosticsProtocolGuid, NULL},\r
788 {STRING_TOKEN(STR_DRIVER_DIAG2), &gEfiDriverDiagnostics2ProtocolGuid, NULL},\r
789 {STRING_TOKEN(STR_DRIVER_CN), &gEfiComponentNameProtocolGuid, NULL},\r
790 {STRING_TOKEN(STR_DRIVER_CN2), &gEfiComponentName2ProtocolGuid, NULL},\r
791 {STRING_TOKEN(STR_PLAT_DRV_CFG), &gEfiPlatformToDriverConfigurationProtocolGuid, NULL},\r
792 {STRING_TOKEN(STR_DRIVER_VERSION), &gEfiDriverSupportedEfiVersionProtocolGuid, DriverEfiVersionProtocolDumpInformation},\r
793 {STRING_TOKEN(STR_TXT_IN), &gEfiSimpleTextInProtocolGuid, NULL},\r
794 {STRING_TOKEN(STR_TXT_IN_EX), &gEfiSimpleTextInputExProtocolGuid, NULL},\r
795 {STRING_TOKEN(STR_TXT_OUT), &gEfiSimpleTextOutProtocolGuid, TxtOutProtocolDumpInformation},\r
796 {STRING_TOKEN(STR_SIM_POINTER), &gEfiSimplePointerProtocolGuid, NULL},\r
797 {STRING_TOKEN(STR_ABS_POINTER), &gEfiAbsolutePointerProtocolGuid, NULL},\r
798 {STRING_TOKEN(STR_SERIAL_IO), &gEfiSerialIoProtocolGuid, NULL},\r
609e0c58 799 {STRING_TOKEN(STR_GRAPHICS_OUTPUT), &gEfiGraphicsOutputProtocolGuid, GraphicsOutputProtocolDumpInformation},\r
a405b86d 800 {STRING_TOKEN(STR_EDID_DISCOVERED), &gEfiEdidDiscoveredProtocolGuid, NULL},\r
801 {STRING_TOKEN(STR_EDID_ACTIVE), &gEfiEdidActiveProtocolGuid, NULL},\r
802 {STRING_TOKEN(STR_EDID_OVERRIDE), &gEfiEdidOverrideProtocolGuid, NULL},\r
803 {STRING_TOKEN(STR_CON_IN), &gEfiConsoleInDeviceGuid, NULL},\r
804 {STRING_TOKEN(STR_CON_OUT), &gEfiConsoleOutDeviceGuid, NULL},\r
805 {STRING_TOKEN(STR_STD_ERR), &gEfiStandardErrorDeviceGuid, NULL},\r
806 {STRING_TOKEN(STR_LOAD_FILE), &gEfiLoadFileProtocolGuid, NULL},\r
807 {STRING_TOKEN(STR_LOAD_FILE2), &gEfiLoadFile2ProtocolGuid, NULL},\r
808 {STRING_TOKEN(STR_SIMPLE_FILE_SYS), &gEfiSimpleFileSystemProtocolGuid, NULL},\r
a405b86d 809 {STRING_TOKEN(STR_TAPE_IO), &gEfiTapeIoProtocolGuid, NULL},\r
810 {STRING_TOKEN(STR_DISK_IO), &gEfiDiskIoProtocolGuid, NULL},\r
811 {STRING_TOKEN(STR_BLK_IO), &gEfiBlockIoProtocolGuid, NULL},\r
812 {STRING_TOKEN(STR_UC), &gEfiUnicodeCollationProtocolGuid, NULL},\r
813 {STRING_TOKEN(STR_UC2), &gEfiUnicodeCollation2ProtocolGuid, NULL},\r
f4f3c6bf 814 {STRING_TOKEN(STR_PCIRB_IO), &gEfiPciRootBridgeIoProtocolGuid, PciRootBridgeIoDumpInformation},\r
a405b86d 815 {STRING_TOKEN(STR_PCI_IO), &gEfiPciIoProtocolGuid, NULL},\r
816 {STRING_TOKEN(STR_SCSI_PT), &gEfiScsiPassThruProtocolGuid, NULL},\r
817 {STRING_TOKEN(STR_SCSI_IO), &gEfiScsiIoProtocolGuid, NULL},\r
818 {STRING_TOKEN(STR_SCSI_PT_EXT), &gEfiExtScsiPassThruProtocolGuid, NULL},\r
819 {STRING_TOKEN(STR_ISCSI), &gEfiIScsiInitiatorNameProtocolGuid, NULL},\r
820 {STRING_TOKEN(STR_USB_IO), &gEfiUsbIoProtocolGuid, NULL},\r
821 {STRING_TOKEN(STR_USB_HC), &gEfiUsbHcProtocolGuid, NULL},\r
822 {STRING_TOKEN(STR_USB_HC2), &gEfiUsb2HcProtocolGuid, NULL},\r
823 {STRING_TOKEN(STR_DEBUG_SUPPORT), &gEfiDebugSupportProtocolGuid, NULL},\r
824 {STRING_TOKEN(STR_DEBUG_PORT), &gEfiDebugPortProtocolGuid, NULL},\r
825 {STRING_TOKEN(STR_DECOMPRESS), &gEfiDecompressProtocolGuid, NULL},\r
826 {STRING_TOKEN(STR_ACPI_TABLE), &gEfiAcpiTableProtocolGuid, NULL},\r
827 {STRING_TOKEN(STR_EBC_INTERPRETER), &gEfiEbcProtocolGuid, NULL},\r
828 {STRING_TOKEN(STR_SNP), &gEfiSimpleNetworkProtocolGuid, NULL},\r
829 {STRING_TOKEN(STR_NII), &gEfiNetworkInterfaceIdentifierProtocolGuid, NULL},\r
830 {STRING_TOKEN(STR_NII_31), &gEfiNetworkInterfaceIdentifierProtocolGuid_31, NULL},\r
831 {STRING_TOKEN(STR_PXE_BC), &gEfiPxeBaseCodeProtocolGuid, NULL},\r
832 {STRING_TOKEN(STR_PXE_CB), &gEfiPxeBaseCodeCallbackProtocolGuid, NULL},\r
833 {STRING_TOKEN(STR_BIS), &gEfiBisProtocolGuid, NULL},\r
834 {STRING_TOKEN(STR_MNP_SB), &gEfiManagedNetworkServiceBindingProtocolGuid, NULL},\r
835 {STRING_TOKEN(STR_MNP), &gEfiManagedNetworkProtocolGuid, NULL},\r
836 {STRING_TOKEN(STR_ARP_SB), &gEfiArpServiceBindingProtocolGuid, NULL},\r
837 {STRING_TOKEN(STR_ARP), &gEfiArpProtocolGuid, NULL},\r
838 {STRING_TOKEN(STR_DHCPV4_SB), &gEfiDhcp4ServiceBindingProtocolGuid, NULL},\r
839 {STRING_TOKEN(STR_DHCPV4), &gEfiDhcp4ProtocolGuid, NULL},\r
840 {STRING_TOKEN(STR_TCPV4_SB), &gEfiTcp4ServiceBindingProtocolGuid, NULL},\r
841 {STRING_TOKEN(STR_TCPV4), &gEfiTcp4ProtocolGuid, NULL},\r
842 {STRING_TOKEN(STR_IPV4_SB), &gEfiIp4ServiceBindingProtocolGuid, NULL},\r
843 {STRING_TOKEN(STR_IPV4), &gEfiIp4ProtocolGuid, NULL},\r
844 {STRING_TOKEN(STR_IPV4_CFG), &gEfiIp4ConfigProtocolGuid, NULL},\r
a405b86d 845 {STRING_TOKEN(STR_UDPV4_SB), &gEfiUdp4ServiceBindingProtocolGuid, NULL},\r
846 {STRING_TOKEN(STR_UDPV4), &gEfiUdp4ProtocolGuid, NULL},\r
847 {STRING_TOKEN(STR_MTFTPV4_SB), &gEfiMtftp4ServiceBindingProtocolGuid, NULL},\r
848 {STRING_TOKEN(STR_MTFTPV4), &gEfiMtftp4ProtocolGuid, NULL},\r
849 {STRING_TOKEN(STR_AUTH_INFO), &gEfiAuthenticationInfoProtocolGuid, NULL},\r
850 {STRING_TOKEN(STR_HASH_SB), &gEfiHashServiceBindingProtocolGuid, NULL},\r
851 {STRING_TOKEN(STR_HASH), &gEfiHashProtocolGuid, NULL},\r
852 {STRING_TOKEN(STR_HII_FONT), &gEfiHiiFontProtocolGuid, NULL},\r
853 {STRING_TOKEN(STR_HII_STRING), &gEfiHiiStringProtocolGuid, NULL},\r
854 {STRING_TOKEN(STR_HII_IMAGE), &gEfiHiiImageProtocolGuid, NULL},\r
855 {STRING_TOKEN(STR_HII_DATABASE), &gEfiHiiDatabaseProtocolGuid, NULL},\r
856 {STRING_TOKEN(STR_HII_CONFIG_ROUT), &gEfiHiiConfigRoutingProtocolGuid, NULL},\r
857 {STRING_TOKEN(STR_HII_CONFIG_ACC), &gEfiHiiConfigAccessProtocolGuid, NULL},\r
858 {STRING_TOKEN(STR_HII_FORM_BROWSER2), &gEfiFormBrowser2ProtocolGuid, NULL},\r
dee34318 859 {STRING_TOKEN(STR_DRIVER_FAM_OVERRIDE), &gEfiDriverFamilyOverrideProtocolGuid, NULL},\r
860 {STRING_TOKEN(STR_PCD), &gPcdProtocolGuid, NULL},\r
861 {STRING_TOKEN(STR_TCG), &gEfiTcgProtocolGuid, NULL},\r
862 {STRING_TOKEN(STR_HII_PACKAGE_LIST), &gEfiHiiPackageListProtocolGuid, NULL},\r
863\r
864//\r
865// the ones under this are deprecated by the current UEFI Spec, but may be found anyways...\r
866//\r
a405b86d 867 {STRING_TOKEN(STR_SHELL_INTERFACE), &gEfiShellInterfaceGuid, NULL},\r
868 {STRING_TOKEN(STR_SHELL_ENV2), &gEfiShellEnvironment2Guid, NULL},\r
869 {STRING_TOKEN(STR_SHELL_ENV), &gEfiShellEnvironment2Guid, NULL},\r
870 {STRING_TOKEN(STR_DEVICE_IO), &gEfiDeviceIoProtocolGuid, NULL},\r
871 {STRING_TOKEN(STR_UGA_DRAW), &gEfiUgaDrawProtocolGuid, NULL},\r
872 {STRING_TOKEN(STR_UGA_IO), &gEfiUgaIoProtocolGuid, NULL},\r
873 {STRING_TOKEN(STR_ESP), &gEfiPartTypeSystemPartGuid, NULL},\r
874 {STRING_TOKEN(STR_GPT_NBR), &gEfiPartTypeLegacyMbrGuid, NULL},\r
875 {STRING_TOKEN(STR_DRIVER_CONFIG), &gEfiDriverConfigurationProtocolGuid, NULL},\r
876 {STRING_TOKEN(STR_DRIVER_CONFIG2), &gEfiDriverConfiguration2ProtocolGuid, NULL},\r
59febea1
SEHM		 877 {STRING_TOKEN(STR_ISA_IO), &gEfiIsaIoProtocolGuid, NULL},\r
878 {STRING_TOKEN(STR_ISA_ACPI), &gEfiIsaAcpiProtocolGuid, NULL},\r
dee34318 879\r
880//\r
881// the ones under this are GUID identified structs, not protocols\r
882//\r
883 {STRING_TOKEN(STR_FILE_INFO), &gEfiFileInfoGuid, NULL},\r
884 {STRING_TOKEN(STR_FILE_SYS_INFO), &gEfiFileSystemInfoGuid, NULL},\r
885\r
886//\r
887// the ones under this are misc GUIDS.\r
888//\r
889 {STRING_TOKEN(STR_EFI_GLOBAL_VARIABLE), &gEfiGlobalVariableGuid, NULL},\r
890\r
891//\r
892// UEFI 2.2\r
893//\r
894 {STRING_TOKEN(STR_IP6_SB), &gEfiIp6ServiceBindingProtocolGuid, NULL},\r
895 {STRING_TOKEN(STR_IP6), &gEfiIp6ProtocolGuid, NULL},\r
896 {STRING_TOKEN(STR_IP6_CONFIG), &gEfiIp6ConfigProtocolGuid, NULL},\r
897 {STRING_TOKEN(STR_MTFTP6_SB), &gEfiMtftp6ServiceBindingProtocolGuid, NULL},\r
898 {STRING_TOKEN(STR_MTFTP6), &gEfiMtftp6ProtocolGuid, NULL},\r
899 {STRING_TOKEN(STR_DHCP6_SB), &gEfiDhcp6ServiceBindingProtocolGuid, NULL},\r
900 {STRING_TOKEN(STR_DHCP6), &gEfiDhcp6ProtocolGuid, NULL},\r
901 {STRING_TOKEN(STR_UDP6_SB), &gEfiUdp6ServiceBindingProtocolGuid, NULL},\r
902 {STRING_TOKEN(STR_UDP6), &gEfiUdp6ProtocolGuid, NULL},\r
903 {STRING_TOKEN(STR_TCP6_SB), &gEfiTcp6ServiceBindingProtocolGuid, NULL},\r
904 {STRING_TOKEN(STR_TCP6), &gEfiTcp6ProtocolGuid, NULL},\r
905 {STRING_TOKEN(STR_VLAN_CONFIG), &gEfiVlanConfigProtocolGuid, NULL},\r
906 {STRING_TOKEN(STR_EAP), &gEfiEapProtocolGuid, NULL},\r
907 {STRING_TOKEN(STR_EAP_MGMT), &gEfiEapManagementProtocolGuid, NULL},\r
908 {STRING_TOKEN(STR_FTP4_SB), &gEfiFtp4ServiceBindingProtocolGuid, NULL},\r
909 {STRING_TOKEN(STR_FTP4), &gEfiFtp4ProtocolGuid, NULL},\r
910 {STRING_TOKEN(STR_IP_SEC_CONFIG), &gEfiIpSecConfigProtocolGuid, NULL},\r
911 {STRING_TOKEN(STR_DH), &gEfiDriverHealthProtocolGuid, NULL},\r
912 {STRING_TOKEN(STR_DEF_IMG_LOAD), &gEfiDeferredImageLoadProtocolGuid, NULL},\r
913 {STRING_TOKEN(STR_USER_CRED), &gEfiUserCredentialProtocolGuid, NULL},\r
914 {STRING_TOKEN(STR_USER_MNGR), &gEfiUserManagerProtocolGuid, NULL},\r
915 {STRING_TOKEN(STR_ATA_PASS_THRU), &gEfiAtaPassThruProtocolGuid, NULL},\r
916\r
917//\r
918// UEFI 2.3\r
919//\r
920 {STRING_TOKEN(STR_FW_MGMT), &gEfiFirmwareManagementProtocolGuid, NULL},\r
921 {STRING_TOKEN(STR_IP_SEC), &gEfiIpSecProtocolGuid, NULL},\r
922 {STRING_TOKEN(STR_IP_SEC2), &gEfiIpSec2ProtocolGuid, NULL},\r
923\r
924//\r
925// UEFI 2.3.1\r
926//\r
927 {STRING_TOKEN(STR_KMS), &gEfiKmsProtocolGuid, NULL},\r
928 {STRING_TOKEN(STR_BLK_IO2), &gEfiBlockIo2ProtocolGuid, NULL},\r
929 {STRING_TOKEN(STR_SSC), &gEfiStorageSecurityCommandProtocolGuid, NULL},\r
12f1a36c 930 {STRING_TOKEN(STR_UCRED2), &gEfiUserCredential2ProtocolGuid, NULL},\r
dee34318 931\r
28cdb62b
CP		 932//\r
933// UEFI 2.4\r
934//\r
935 {STRING_TOKEN(STR_DISK_IO2), &gEfiDiskIo2ProtocolGuid, NULL},\r
59febea1 936 {STRING_TOKEN(STR_ADAPTER_INFO), &gEfiAdapterInformationProtocolGuid, AdapterInformationDumpInformation},\r
28cdb62b 937\r
6b640b4a
JC		 938//\r
939// PI Spec ones\r
940//\r
941 {STRING_TOKEN(STR_IDE_CONT_INIT), &gEfiIdeControllerInitProtocolGuid, NULL},\r
942\r
0a1eb97d
JC		 943//\r
944// UEFI Shell Spec 2.0\r
945//\r
946 {STRING_TOKEN(STR_SHELL_PARAMETERS), &gEfiShellParametersProtocolGuid, NULL},\r
947 {STRING_TOKEN(STR_SHELL), &gEfiShellProtocolGuid, NULL},\r
948\r
949//\r
950// UEFI Shell Spec 2.1\r
951//\r
952 {STRING_TOKEN(STR_SHELL_DYNAMIC), &gEfiShellDynamicCommandProtocolGuid, NULL},\r
953\r
dee34318 954//\r
955// terminator\r
956//\r
a405b86d 957 {STRING_TOKEN(STR_UNKNOWN_DEVICE), NULL, NULL},\r
958};\r
959\r
960/**\r
961 Function to get the node for a protocol or struct from it's GUID.\r
962\r
963 if Guid is NULL, then ASSERT.\r
964\r
965 @param[in] Guid The GUID to look for the name of.\r
966\r
967 @return The node.\r
968**/\r
dee34318 969CONST GUID_INFO_BLOCK *\r
a405b86d 970EFIAPI\r
971InternalShellGetNodeFromGuid(\r
972 IN CONST EFI_GUID* Guid\r
973 )\r
974{\r
dee34318 975 CONST GUID_INFO_BLOCK *ListWalker;\r
6306fd90 976 UINTN LoopCount;\r
a405b86d 977\r
978 ASSERT(Guid != NULL);\r
979\r
6306fd90
JC		 980 for (LoopCount = 0, ListWalker = GuidList; GuidList != NULL && LoopCount < GuidListCount; LoopCount++, ListWalker++) {\r
981 if (CompareGuid(ListWalker->GuidId, Guid)) {\r
982 return (ListWalker);\r
983 }\r
984 }\r
985\r
a405b86d 986 if (PcdGetBool(PcdShellIncludeNtGuids)) {\r
987 for (ListWalker = mGuidStringListNT ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {\r
988 if (CompareGuid(ListWalker->GuidId, Guid)) {\r
989 return (ListWalker);\r
990 }\r
991 }\r
992 }\r
993 for (ListWalker = mGuidStringList ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {\r
994 if (CompareGuid(ListWalker->GuidId, Guid)) {\r
995 return (ListWalker);\r
996 }\r
997 }\r
6306fd90
JC		 998 return (NULL);\r
999}\r
1000\r
1001/**\r
1002Function to add a new GUID/Name mapping.\r
1003\r
1004@param[in] Guid The Guid\r
f5ba4007
QS		 1005@param[in] NameID The STRING id of the HII string to use\r
1006@param[in] DumpFunc The pointer to the dump function\r
6306fd90
JC		 1007\r
1008\r
1009@retval EFI_SUCCESS The operation was sucessful\r
1010@retval EFI_OUT_OF_RESOURCES A memory allocation failed\r
1011@retval EFI_INVALID_PARAMETER Guid NameId was invalid\r
1012**/\r
6306fd90
JC		 1013EFI_STATUS\r
1014EFIAPI\r
1015InsertNewGuidNameMapping(\r
1016 IN CONST EFI_GUID *Guid,\r
1017 IN CONST EFI_STRING_ID NameID,\r
1018 IN CONST DUMP_PROTOCOL_INFO DumpFunc OPTIONAL\r
1019 )\r
1020{\r
1021 ASSERT(Guid != NULL);\r
1022 ASSERT(NameID != 0);\r
1023\r
1024 GuidList = ReallocatePool(GuidListCount * sizeof(GUID_INFO_BLOCK), GuidListCount+1 * sizeof(GUID_INFO_BLOCK), GuidList);\r
1025 if (GuidList == NULL) {\r
1026 GuidListCount = 0;\r
1027 return (EFI_OUT_OF_RESOURCES);\r
1028 }\r
1029 GuidListCount++;\r
1030\r
1031 GuidList[GuidListCount - 1].GuidId = AllocateCopyPool(sizeof(EFI_GUID), Guid);\r
1032 GuidList[GuidListCount - 1].StringId = NameID;\r
1033 GuidList[GuidListCount - 1].DumpInfo = DumpFunc;\r
1034\r
1035 if (GuidList[GuidListCount - 1].GuidId == NULL) {\r
1036 return (EFI_OUT_OF_RESOURCES);\r
1037 }\r
1038\r
1039 return (EFI_SUCCESS);\r
1040}\r
1041\r
1042/**\r
1043 Function to add a new GUID/Name mapping.\r
1044\r
1045 This cannot overwrite an existing mapping.\r
1046\r
1047 @param[in] Guid The Guid\r
1048 @param[in] TheName The Guid's name\r
1049 @param[in] Lang RFC4646 language code list or NULL\r
1050\r
1051 @retval EFI_SUCCESS The operation was sucessful\r
1052 @retval EFI_ACCESS_DENIED There was a duplicate\r
1053 @retval EFI_OUT_OF_RESOURCES A memory allocation failed\r
1054 @retval EFI_INVALID_PARAMETER Guid or TheName was NULL\r
1055**/\r
1056EFI_STATUS\r
1057EFIAPI\r
1058AddNewGuidNameMapping(\r
1059 IN CONST EFI_GUID *Guid,\r
1060 IN CONST CHAR16 *TheName,\r
1061 IN CONST CHAR8 *Lang OPTIONAL\r
1062 )\r
1063{\r
6306fd90
JC		 1064 EFI_STRING_ID NameID;\r
1065\r
e7e0e42b
CP		 1066 HandleParsingHiiInit();\r
1067\r
6306fd90
JC		 1068 if (Guid == NULL || TheName == NULL){\r
1069 return (EFI_INVALID_PARAMETER);\r
1070 }\r
1071\r
931b2cff 1072 if ((InternalShellGetNodeFromGuid(Guid)) != NULL) {\r
6306fd90
JC		 1073 return (EFI_ACCESS_DENIED);\r
1074 }\r
1075\r
1076 NameID = HiiSetString(mHandleParsingHiiHandle, 0, (CHAR16*)TheName, Lang);\r
1077 if (NameID == 0) {\r
1078 return (EFI_OUT_OF_RESOURCES);\r
1079 }\r
1080\r
1081 return (InsertNewGuidNameMapping(Guid, NameID, NULL));\r
a405b86d 1082}\r
1083\r
1084/**\r
1085 Function to get the name of a protocol or struct from it's GUID.\r
1086\r
1087 if Guid is NULL, then ASSERT.\r
1088\r
1089 @param[in] Guid The GUID to look for the name of.\r
1090 @param[in] Lang The language to use.\r
1091\r
1092 @return pointer to string of the name. The caller\r
1093 is responsible to free this memory.\r
1094**/\r
1095CHAR16*\r
1096EFIAPI\r
1097GetStringNameFromGuid(\r
1098 IN CONST EFI_GUID *Guid,\r
1099 IN CONST CHAR8 *Lang OPTIONAL\r
1100 )\r
1101{\r
dee34318 1102 CONST GUID_INFO_BLOCK *Id;\r
a405b86d 1103\r
e7e0e42b
CP		 1104 HandleParsingHiiInit();\r
1105\r
a405b86d 1106 Id = InternalShellGetNodeFromGuid(Guid);\r
6306fd90 1107 return (HiiGetString(mHandleParsingHiiHandle, Id==NULL?STRING_TOKEN(STR_UNKNOWN_DEVICE):Id->StringId, Lang));\r
a405b86d 1108}\r
1109\r
1110/**\r
1111 Function to dump protocol information from a handle.\r
1112\r
1113 This function will return a allocated string buffer containing the\r
1114 information. The caller is responsible for freeing the memory.\r
1115\r
1116 If Guid is NULL, ASSERT().\r
1117 If TheHandle is NULL, ASSERT().\r
1118\r
1119 @param[in] TheHandle The handle to dump information from.\r
1120 @param[in] Guid The GUID of the protocol to dump.\r
1121 @param[in] Verbose TRUE for extra info. FALSE otherwise.\r
1122\r
1123 @return The pointer to string.\r
1124 @retval NULL An error was encountered.\r
1125**/\r
1126CHAR16*\r
1127EFIAPI\r
1128GetProtocolInformationDump(\r
1129 IN CONST EFI_HANDLE TheHandle,\r
1130 IN CONST EFI_GUID *Guid,\r
1131 IN CONST BOOLEAN Verbose\r
1132 )\r
1133{\r
dee34318 1134 CONST GUID_INFO_BLOCK *Id;\r
a405b86d 1135\r
1136 ASSERT(TheHandle != NULL);\r
1137 ASSERT(Guid != NULL);\r
1138\r
1139 if (TheHandle == NULL || Guid == NULL) {\r
1140 return (NULL);\r
1141 }\r
1142\r
1143 Id = InternalShellGetNodeFromGuid(Guid);\r
1144 if (Id != NULL && Id->DumpInfo != NULL) {\r
1145 return (Id->DumpInfo(TheHandle, Verbose));\r
1146 }\r
1147 return (NULL);\r
1148}\r
1149\r
1150/**\r
1151 Function to get the Guid for a protocol or struct based on it's string name.\r
1152\r
0a1eb97d
JC		 1153 do not modify the returned Guid.\r
1154\r
a405b86d 1155 @param[in] Name The pointer to the string name.\r
1156 @param[in] Lang The pointer to the language code.\r
0a1eb97d 1157 @param[out] Guid The pointer to the Guid.\r
a405b86d 1158\r
1159 @retval EFI_SUCCESS The operation was sucessful.\r
1160**/\r
1161EFI_STATUS\r
1162EFIAPI\r
1163GetGuidFromStringName(\r
1164 IN CONST CHAR16 *Name,\r
1165 IN CONST CHAR8 *Lang OPTIONAL,\r
0a1eb97d 1166 OUT EFI_GUID **Guid\r
a405b86d 1167 )\r
1168{\r
dee34318 1169 CONST GUID_INFO_BLOCK *ListWalker;\r
a405b86d 1170 CHAR16 *String;\r
6306fd90 1171 UINTN LoopCount;\r
a405b86d 1172\r
e7e0e42b
CP		 1173 HandleParsingHiiInit();\r
1174\r
a405b86d 1175 ASSERT(Guid != NULL);\r
1176 if (Guid == NULL) {\r
1177 return (EFI_INVALID_PARAMETER);\r
1178 }\r
1179 *Guid = NULL;\r
1180\r
1181 if (PcdGetBool(PcdShellIncludeNtGuids)) {\r
1182 for (ListWalker = mGuidStringListNT ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {\r
1183 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);\r
28cdb62b 1184 if (Name != NULL && String != NULL && StringNoCaseCompare (&Name, &String) == 0) {\r
a405b86d 1185 *Guid = ListWalker->GuidId;\r
1186 }\r
1187 SHELL_FREE_NON_NULL(String);\r
1188 if (*Guid != NULL) {\r
1189 return (EFI_SUCCESS);\r
1190 }\r
1191 }\r
1192 }\r
1193 for (ListWalker = mGuidStringList ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {\r
1194 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);\r
28cdb62b 1195 if (Name != NULL && String != NULL && StringNoCaseCompare (&Name, &String) == 0) {\r
a405b86d 1196 *Guid = ListWalker->GuidId;\r
1197 }\r
1198 SHELL_FREE_NON_NULL(String);\r
1199 if (*Guid != NULL) {\r
1200 return (EFI_SUCCESS);\r
1201 }\r
1202 }\r
6306fd90
JC		 1203\r
1204 for (LoopCount = 0, ListWalker = GuidList; GuidList != NULL && LoopCount < GuidListCount; LoopCount++, ListWalker++) {\r
1205 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);\r
1206 if (Name != NULL && String != NULL && StringNoCaseCompare (&Name, &String) == 0) {\r
1207 *Guid = ListWalker->GuidId;\r
1208 }\r
1209 SHELL_FREE_NON_NULL(String);\r
1210 if (*Guid != NULL) {\r
1211 return (EFI_SUCCESS);\r
1212 }\r
1213 }\r
1214\r
a405b86d 1215 return (EFI_NOT_FOUND);\r
1216}\r
1217\r
36384ceb
ED		 1218/**\r
1219 Get best support language for this driver.\r
1220 \r
a71003f2
ED		 1221 First base on the user input language to search, second base on the current \r
1222 platform used language to search, third get the first language from the \r
1223 support language list. The caller need to free the buffer of the best language.\r
36384ceb
ED		 1224\r
1225 @param[in] SupportedLanguages The support languages for this driver.\r
a71003f2 1226 @param[in] InputLanguage The user input language.\r
36384ceb
ED		 1227 @param[in] Iso639Language Whether get language for ISO639.\r
1228\r
1229 @return The best support language for this driver.\r
1230**/\r
1231CHAR8 *\r
a71003f2 1232EFIAPI\r
36384ceb 1233GetBestLanguageForDriver (\r
a71003f2
ED		 1234 IN CONST CHAR8 *SupportedLanguages,\r
1235 IN CONST CHAR8 *InputLanguage,\r
36384ceb
ED		 1236 IN BOOLEAN Iso639Language\r
1237 )\r
1238{\r
1239 CHAR8 *LanguageVariable;\r
1240 CHAR8 *BestLanguage;\r
1241\r
1242 LanguageVariable = GetVariable (Iso639Language ? L"Lang" : L"PlatformLang", &gEfiGlobalVariableGuid);\r
1243\r
1244 BestLanguage = GetBestLanguage(\r
1245 SupportedLanguages,\r
1246 Iso639Language,\r
a71003f2 1247 (InputLanguage != NULL) ? InputLanguage : "",\r
36384ceb 1248 (LanguageVariable != NULL) ? LanguageVariable : "",\r
a71003f2 1249 SupportedLanguages,\r
36384ceb
ED		 1250 NULL\r
1251 );\r
1252\r
1253 if (LanguageVariable != NULL) {\r
1254 FreePool (LanguageVariable);\r
1255 }\r
1256\r
1257 return BestLanguage;\r
1258}\r
1259\r
a405b86d 1260/**\r
1261 Function to retrieve the driver name (if possible) from the ComponentName or\r
1262 ComponentName2 protocol\r
1263\r
1264 @param[in] TheHandle The driver handle to get the name of.\r
1265 @param[in] Language The language to use.\r
1266\r
1267 @retval NULL The name could not be found.\r
1268 @return A pointer to the string name. Do not de-allocate the memory.\r
1269**/\r
1270CONST CHAR16*\r
1271EFIAPI\r
1272GetStringNameFromHandle(\r
1273 IN CONST EFI_HANDLE TheHandle,\r
1274 IN CONST CHAR8 *Language\r
1275 )\r
1276{\r
1277 EFI_COMPONENT_NAME2_PROTOCOL *CompNameStruct;\r
1278 EFI_STATUS Status;\r
1279 CHAR16 *RetVal;\r
36384ceb
ED		 1280 CHAR8 *BestLang;\r
1281\r
1282 BestLang = NULL;\r
a405b86d 1283\r
1284 Status = gBS->OpenProtocol(\r
1285 TheHandle,\r
1286 &gEfiComponentName2ProtocolGuid,\r
1287 (VOID**)&CompNameStruct,\r
1288 gImageHandle,\r
1289 NULL,\r
1290 EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
1291 if (!EFI_ERROR(Status)) {\r
a71003f2
ED		 1292 BestLang = GetBestLanguageForDriver (CompNameStruct->SupportedLanguages, Language, FALSE);\r
1293 Status = CompNameStruct->GetDriverName(CompNameStruct, BestLang, &RetVal);\r
36384ceb
ED		 1294 if (BestLang != NULL) {\r
1295 FreePool (BestLang);\r
1296 BestLang = NULL;\r
1297 }\r
a405b86d 1298 if (!EFI_ERROR(Status)) {\r
1299 return (RetVal);\r
1300 }\r
1301 }\r
1302 Status = gBS->OpenProtocol(\r
1303 TheHandle,\r
1304 &gEfiComponentNameProtocolGuid,\r
1305 (VOID**)&CompNameStruct,\r
1306 gImageHandle,\r
1307 NULL,\r
1308 EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
1309 if (!EFI_ERROR(Status)) {\r
a71003f2
ED		 1310 BestLang = GetBestLanguageForDriver (CompNameStruct->SupportedLanguages, Language, FALSE);\r
1311 Status = CompNameStruct->GetDriverName(CompNameStruct, BestLang, &RetVal);\r
36384ceb
ED		 1312 if (BestLang != NULL) {\r
1313 FreePool (BestLang);\r
1314 }\r
a405b86d 1315 if (!EFI_ERROR(Status)) {\r
1316 return (RetVal);\r
1317 }\r
1318 }\r
1319 return (NULL);\r
1320}\r
1321\r
1322/**\r
1323 Function to initialize the file global mHandleList object for use in\r
1324 vonverting handles to index and index to handle.\r
1325\r
1326 @retval EFI_SUCCESS The operation was successful.\r
1327**/\r
1328EFI_STATUS\r
1329EFIAPI\r
1330InternalShellInitHandleList(\r
1331 VOID\r
1332 )\r
1333{\r
1334 EFI_STATUS Status;\r
1335 EFI_HANDLE *HandleBuffer;\r
1336 UINTN HandleCount;\r
1337 HANDLE_LIST *ListWalker;\r
1338\r
1339 if (mHandleList.NextIndex != 0) {\r
1340 return EFI_SUCCESS;\r
1341 }\r
1342 InitializeListHead(&mHandleList.List.Link);\r
1343 mHandleList.NextIndex = 1;\r
1344 Status = gBS->LocateHandleBuffer (\r
1345 AllHandles,\r
1346 NULL,\r
1347 NULL,\r
1348 &HandleCount,\r
1349 &HandleBuffer\r
1350 );\r
1351 ASSERT_EFI_ERROR(Status);\r
1352 if (EFI_ERROR(Status)) {\r
1353 return (Status);\r
1354 }\r
1355 for (mHandleList.NextIndex = 1 ; mHandleList.NextIndex <= HandleCount ; mHandleList.NextIndex++){\r
78ed876b 1356 ListWalker = AllocateZeroPool(sizeof(HANDLE_LIST));\r
a405b86d 1357 ASSERT(ListWalker != NULL);\r
1358 ListWalker->TheHandle = HandleBuffer[mHandleList.NextIndex-1];\r
1359 ListWalker->TheIndex = mHandleList.NextIndex;\r
1360 InsertTailList(&mHandleList.List.Link,&ListWalker->Link);\r
1361 }\r
1362 FreePool(HandleBuffer);\r
1363 return (EFI_SUCCESS);\r
1364}\r
1365\r
1366/**\r
1367 Function to retrieve the human-friendly index of a given handle. If the handle\r
1368 does not have a index one will be automatically assigned. The index value is valid\r
1369 until the termination of the shell application.\r
1370\r
1371 @param[in] TheHandle The handle to retrieve an index for.\r
1372\r
1373 @retval 0 A memory allocation failed.\r
1374 @return The index of the handle.\r
1375\r
1376**/\r
1377UINTN\r
1378EFIAPI\r
1379ConvertHandleToHandleIndex(\r
1380 IN CONST EFI_HANDLE TheHandle\r
1381 )\r
1382{\r
f330ff35 1383 EFI_STATUS Status;\r
1384 EFI_GUID **ProtocolBuffer;\r
1385 UINTN ProtocolCount;\r
1386 HANDLE_LIST *ListWalker;\r
1387\r
78ed876b 1388 if (TheHandle == NULL) {\r
1389 return 0;\r
1390 }\r
a405b86d 1391\r
1392 InternalShellInitHandleList();\r
1393\r
1394 for (ListWalker = (HANDLE_LIST*)GetFirstNode(&mHandleList.List.Link)\r
1395 ; !IsNull(&mHandleList.List.Link,&ListWalker->Link)\r
1396 ; ListWalker = (HANDLE_LIST*)GetNextNode(&mHandleList.List.Link,&ListWalker->Link)\r
1397 ){\r
1398 if (ListWalker->TheHandle == TheHandle) {\r
f330ff35 1399 //\r
1400 // Verify that TheHandle is still present in the Handle Database\r
1401 //\r
1402 Status = gBS->ProtocolsPerHandle(TheHandle, &ProtocolBuffer, &ProtocolCount);\r
1403 if (EFI_ERROR (Status)) {\r
1404 //\r
1405 // TheHandle is not present in the Handle Database, so delete from the handle list\r
1406 //\r
1407 RemoveEntryList (&ListWalker->Link);\r
1408 return 0;\r
1409 }\r
1410 FreePool (ProtocolBuffer);\r
a405b86d 1411 return (ListWalker->TheIndex);\r
1412 }\r
1413 }\r
f330ff35 1414\r
1415 //\r
1416 // Verify that TheHandle is valid handle\r
1417 //\r
1418 Status = gBS->ProtocolsPerHandle(TheHandle, &ProtocolBuffer, &ProtocolCount);\r
1419 if (EFI_ERROR (Status)) {\r
1420 //\r
1421 // TheHandle is not valid, so do not add to handle list\r
1422 //\r
1423 return 0;\r
1424 }\r
1425 FreePool (ProtocolBuffer);\r
1426\r
78ed876b 1427 ListWalker = AllocateZeroPool(sizeof(HANDLE_LIST));\r
a405b86d 1428 ASSERT(ListWalker != NULL);\r
1429 ListWalker->TheHandle = TheHandle;\r
1430 ListWalker->TheIndex = mHandleList.NextIndex++;\r
1431 InsertTailList(&mHandleList.List.Link,&ListWalker->Link);\r
1432 return (ListWalker->TheIndex);\r
1433}\r
1434\r
1435\r
1436\r
1437/**\r
1438 Function to retrieve the EFI_HANDLE from the human-friendly index.\r
1439\r
1440 @param[in] TheIndex The index to retrieve the EFI_HANDLE for.\r
1441\r
1442 @retval NULL The index was invalid.\r
1443 @return The EFI_HANDLE that index represents.\r
1444\r
1445**/\r
1446EFI_HANDLE\r
1447EFIAPI\r
1448ConvertHandleIndexToHandle(\r
1449 IN CONST UINTN TheIndex\r
1450 )\r
1451{\r
f330ff35 1452 EFI_STATUS Status;\r
1453 EFI_GUID **ProtocolBuffer;\r
1454 UINTN ProtocolCount;\r
a405b86d 1455 HANDLE_LIST *ListWalker;\r
1456\r
1457 InternalShellInitHandleList();\r
1458\r
1459 if (TheIndex >= mHandleList.NextIndex) {\r
f330ff35 1460 return NULL;\r
a405b86d 1461 }\r
1462\r
1463 for (ListWalker = (HANDLE_LIST*)GetFirstNode(&mHandleList.List.Link)\r
1464 ; !IsNull(&mHandleList.List.Link,&ListWalker->Link)\r
1465 ; ListWalker = (HANDLE_LIST*)GetNextNode(&mHandleList.List.Link,&ListWalker->Link)\r
1466 ){\r
f330ff35 1467 if (ListWalker->TheIndex == TheIndex && ListWalker->TheHandle != NULL) {\r
1468 //\r
1469 // Verify that LinkWalker->TheHandle is valid handle\r
1470 //\r
1471 Status = gBS->ProtocolsPerHandle(ListWalker->TheHandle, &ProtocolBuffer, &ProtocolCount);\r
1472 if (EFI_ERROR (Status)) {\r
1473 //\r
1474 // TheHandle is not valid, so do not add to handle list\r
1475 //\r
1476 ListWalker->TheHandle = NULL;\r
1477 }\r
a405b86d 1478 return (ListWalker->TheHandle);\r
1479 }\r
1480 }\r
f330ff35 1481 return NULL;\r
a405b86d 1482}\r
1483\r
1484/**\r
1485 Gets all the related EFI_HANDLEs based on the mask supplied.\r
1486\r
1487 This function scans all EFI_HANDLES in the UEFI environment's handle database\r
1488 and returns the ones with the specified relationship (Mask) to the specified\r
1489 controller handle.\r
1490\r
1491 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.\r
1492 If MatchingHandleCount is NULL, then ASSERT.\r
1493\r
1494 If MatchingHandleBuffer is not NULL upon a successful return the memory must be\r
1495 caller freed.\r
1496\r
1497 @param[in] DriverBindingHandle The handle with Driver Binding protocol on it.\r
1498 @param[in] ControllerHandle The handle with Device Path protocol on it.\r
1499 @param[in] MatchingHandleCount The pointer to UINTN that specifies the number of HANDLES in\r
1500 MatchingHandleBuffer.\r
1501 @param[out] MatchingHandleBuffer On a successful return, a buffer of MatchingHandleCount\r
1502 EFI_HANDLEs with a terminating NULL EFI_HANDLE.\r
1503 @param[out] HandleType An array of type information.\r
1504\r
1505 @retval EFI_SUCCESS The operation was successful, and any related handles\r
1506 are in MatchingHandleBuffer.\r
1507 @retval EFI_NOT_FOUND No matching handles were found.\r
1508 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.\r
1509**/\r
1510EFI_STATUS\r
1511EFIAPI\r
1512ParseHandleDatabaseByRelationshipWithType (\r
1513 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL,\r
1514 IN CONST EFI_HANDLE ControllerHandle OPTIONAL,\r
1515 IN UINTN *HandleCount,\r
1516 OUT EFI_HANDLE **HandleBuffer,\r
1517 OUT UINTN **HandleType\r
1518 )\r
1519{\r
1520 EFI_STATUS Status;\r
1521 UINTN HandleIndex;\r
1522 EFI_GUID **ProtocolGuidArray;\r
1523 UINTN ArrayCount;\r
1524 UINTN ProtocolIndex;\r
1525 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *OpenInfo;\r
1526 UINTN OpenInfoCount;\r
1527 UINTN OpenInfoIndex;\r
1528 UINTN ChildIndex;\r
f330ff35 1529 INTN DriverBindingHandleIndex;\r
a405b86d 1530\r
1531 ASSERT(HandleCount != NULL);\r
1532 ASSERT(HandleBuffer != NULL);\r
1533 ASSERT(HandleType != NULL);\r
1534 ASSERT(DriverBindingHandle != NULL || ControllerHandle != NULL);\r
1535\r
1536 *HandleCount = 0;\r
1537 *HandleBuffer = NULL;\r
1538 *HandleType = NULL;\r
1539\r
1540 //\r
1541 // Retrieve the list of all handles from the handle database\r
1542 //\r
1543 Status = gBS->LocateHandleBuffer (\r
1544 AllHandles,\r
1545 NULL,\r
1546 NULL,\r
1547 HandleCount,\r
1548 HandleBuffer\r
1549 );\r
1550 if (EFI_ERROR (Status)) {\r
1551 return (Status);\r
1552 }\r
1553\r
1554 *HandleType = AllocateZeroPool (*HandleCount * sizeof (UINTN));\r
1555 ASSERT(*HandleType != NULL);\r
1556\r
f330ff35 1557 DriverBindingHandleIndex = -1;\r
1558 for (HandleIndex = 0; HandleIndex < *HandleCount; HandleIndex++) {\r
1559 if (DriverBindingHandle != NULL && (*HandleBuffer)[HandleIndex] == DriverBindingHandle) {\r
1560 DriverBindingHandleIndex = (INTN)HandleIndex;\r
1561 }\r
1562 }\r
1563\r
a405b86d 1564 for (HandleIndex = 0; HandleIndex < *HandleCount; HandleIndex++) {\r
1565 //\r
1566 // Retrieve the list of all the protocols on each handle\r
1567 //\r
1568 Status = gBS->ProtocolsPerHandle (\r
1569 (*HandleBuffer)[HandleIndex],\r
1570 &ProtocolGuidArray,\r
1571 &ArrayCount\r
1572 );\r
f330ff35 1573 if (EFI_ERROR (Status)) {\r
1574 continue;\r
1575 }\r
a405b86d 1576\r
f330ff35 1577 for (ProtocolIndex = 0; ProtocolIndex < ArrayCount; ProtocolIndex++) {\r
a405b86d 1578\r
f330ff35 1579 //\r
1580 // Set the bit describing what this handle has\r
1581 //\r
1582 if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiLoadedImageProtocolGuid) ) {\r
7aae3c35 1583 (*HandleType)[HandleIndex] |= (UINTN)HR_IMAGE_HANDLE;\r
f330ff35 1584 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverBindingProtocolGuid) ) {\r
7aae3c35 1585 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_BINDING_HANDLE;\r
f330ff35 1586 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverConfiguration2ProtocolGuid)) {\r
7aae3c35 1587 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_CONFIGURATION_HANDLE;\r
f330ff35 1588 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverConfigurationProtocolGuid) ) {\r
7aae3c35 1589 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_CONFIGURATION_HANDLE;\r
f330ff35 1590 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverDiagnostics2ProtocolGuid) ) {\r
7aae3c35 1591 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_DIAGNOSTICS_HANDLE;\r
f330ff35 1592 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverDiagnosticsProtocolGuid) ) {\r
7aae3c35 1593 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_DIAGNOSTICS_HANDLE;\r
f330ff35 1594 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiComponentName2ProtocolGuid) ) {\r
7aae3c35 1595 (*HandleType)[HandleIndex] |= (UINTN)HR_COMPONENT_NAME_HANDLE;\r
f330ff35 1596 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiComponentNameProtocolGuid) ) {\r
7aae3c35 1597 (*HandleType)[HandleIndex] |= (UINTN)HR_COMPONENT_NAME_HANDLE;\r
f330ff35 1598 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDevicePathProtocolGuid) ) {\r
7aae3c35 1599 (*HandleType)[HandleIndex] |= (UINTN)HR_DEVICE_HANDLE;\r
f330ff35 1600 } else {\r
1601 DEBUG_CODE_BEGIN();\r
1602 ASSERT((*HandleType)[HandleIndex] == (*HandleType)[HandleIndex]);\r
1603 DEBUG_CODE_END();\r
1604 }\r
1605 //\r
1606 // Retrieve the list of agents that have opened each protocol\r
1607 //\r
1608 Status = gBS->OpenProtocolInformation (\r
a405b86d 1609 (*HandleBuffer)[HandleIndex],\r
1610 ProtocolGuidArray[ProtocolIndex],\r
1611 &OpenInfo,\r
1612 &OpenInfoCount\r
1613 );\r
f330ff35 1614 if (EFI_ERROR (Status)) {\r
1615 continue;\r
1616 }\r
1617\r
1618 if (ControllerHandle == NULL) {\r
1619 //\r
1620 // ControllerHandle == NULL and DriverBindingHandle != NULL. \r
1621 // Return information on all the controller handles that the driver specified by DriverBindingHandle is managing\r
1622 //\r
1623 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
1624 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle && (OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
7aae3c35 1625 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);\r
f330ff35 1626 if (DriverBindingHandleIndex != -1) {\r
7aae3c35 1627 (*HandleType)[DriverBindingHandleIndex] |= (UINTN)HR_DEVICE_DRIVER;\r
f330ff35 1628 }\r
1629 }\r
1630 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle && (OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
7aae3c35 1631 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);\r
f330ff35 1632 if (DriverBindingHandleIndex != -1) {\r
7aae3c35 1633 (*HandleType)[DriverBindingHandleIndex] |= (UINTN)(HR_BUS_DRIVER | HR_DEVICE_DRIVER);\r
f330ff35 1634 }\r
1635 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
1636 if (OpenInfo[OpenInfoIndex].ControllerHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 1637 (*HandleType)[ChildIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CHILD_HANDLE);\r
f330ff35 1638 }\r
1639 }\r
1640 }\r
1641 }\r
1642 }\r
1643 if (DriverBindingHandle == NULL && ControllerHandle != NULL) {\r
1644 if (ControllerHandle == (*HandleBuffer)[HandleIndex]) {\r
7aae3c35 1645 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);\r
a405b86d 1646 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
f330ff35 1647 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
1648 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
1649 if (OpenInfo[OpenInfoIndex].AgentHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 1650 (*HandleType)[ChildIndex] |= (UINTN)HR_DEVICE_DRIVER;\r
f330ff35 1651 }\r
a405b86d 1652 }\r
f330ff35 1653 }\r
1654 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
1655 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
1656 if (OpenInfo[OpenInfoIndex].AgentHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 1657 (*HandleType)[ChildIndex] |= (UINTN)(HR_BUS_DRIVER | HR_DEVICE_DRIVER);\r
f330ff35 1658 }\r
1659 if (OpenInfo[OpenInfoIndex].ControllerHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 1660 (*HandleType)[ChildIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CHILD_HANDLE);\r
a405b86d 1661 }\r
1662 }\r
1663 }\r
f330ff35 1664 }\r
1665 } else {\r
1666 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
1667 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
1668 if (OpenInfo[OpenInfoIndex].ControllerHandle == ControllerHandle) {\r
7aae3c35 1669 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_PARENT_HANDLE);\r
f330ff35 1670 }\r
1671 }\r
1672 }\r
1673 }\r
1674 }\r
1675 if (DriverBindingHandle != NULL && ControllerHandle != NULL) {\r
1676 if (ControllerHandle == (*HandleBuffer)[HandleIndex]) {\r
7aae3c35 1677 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);\r
f330ff35 1678 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
1679 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
1680 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle) {\r
1681 if (DriverBindingHandleIndex != -1) {\r
7aae3c35 1682 (*HandleType)[DriverBindingHandleIndex] |= (UINTN)HR_DEVICE_DRIVER;\r
a405b86d 1683 }\r
1684 }\r
f330ff35 1685 }\r
1686 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
1687 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle) {\r
a405b86d 1688 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
f330ff35 1689 if (OpenInfo[OpenInfoIndex].ControllerHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 1690 (*HandleType)[ChildIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CHILD_HANDLE);\r
a405b86d 1691 }\r
1692 }\r
1693 }\r
f330ff35 1694\r
1695 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
1696 if (OpenInfo[OpenInfoIndex].AgentHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 1697 (*HandleType)[ChildIndex] |= (UINTN)(HR_BUS_DRIVER | HR_DEVICE_DRIVER);\r
f330ff35 1698 }\r
1699 }\r
1700 }\r
1701 }\r
1702 } else {\r
1703 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
1704 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
1705 if (OpenInfo[OpenInfoIndex].ControllerHandle == ControllerHandle) {\r
7aae3c35 1706 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_PARENT_HANDLE);\r
f330ff35 1707 }\r
a405b86d 1708 }\r
1709 }\r
a405b86d 1710 }\r
1711 }\r
f330ff35 1712 FreePool (OpenInfo);\r
a405b86d 1713 }\r
f330ff35 1714 FreePool (ProtocolGuidArray);\r
a405b86d 1715 }\r
f330ff35 1716 return EFI_SUCCESS;\r
a405b86d 1717}\r
1718\r
1719/**\r
1720 Gets all the related EFI_HANDLEs based on the single EFI_HANDLE and the mask\r
1721 supplied.\r
1722\r
1723 This function will scan all EFI_HANDLES in the UEFI environment's handle database\r
1724 and return all the ones with the specified relationship (Mask) to the specified\r
1725 controller handle.\r
1726\r
1727 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.\r
1728 If MatchingHandleCount is NULL, then ASSERT.\r
1729\r
1730 If MatchingHandleBuffer is not NULL upon a sucessful return the memory must be\r
1731 caller freed.\r
1732\r
1733 @param[in] DriverBindingHandle Handle to a object with Driver Binding protocol\r
1734 on it.\r
1735 @param[in] ControllerHandle Handle to a device with Device Path protocol on it.\r
1736 @param[in] Mask Mask of what relationship(s) is desired.\r
1737 @param[in] MatchingHandleCount Poitner to UINTN specifying number of HANDLES in\r
1738 MatchingHandleBuffer.\r
1739 @param[out] MatchingHandleBuffer On a sucessful return a buffer of MatchingHandleCount\r
1740 EFI_HANDLEs and a terminating NULL EFI_HANDLE.\r
1741\r
1742 @retval EFI_SUCCESS The operation was sucessful and any related handles\r
1743 are in MatchingHandleBuffer;\r
1744 @retval EFI_NOT_FOUND No matching handles were found.\r
1745 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.\r
1746**/\r
1747EFI_STATUS\r
1748EFIAPI\r
1749ParseHandleDatabaseByRelationship (\r
1750 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL,\r
1751 IN CONST EFI_HANDLE ControllerHandle OPTIONAL,\r
1752 IN CONST UINTN Mask,\r
1753 IN UINTN *MatchingHandleCount,\r
1754 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL\r
1755 )\r
1756{\r
1757 EFI_STATUS Status;\r
1758 UINTN HandleCount;\r
1759 EFI_HANDLE *HandleBuffer;\r
1760 UINTN *HandleType;\r
1761 UINTN HandleIndex;\r
1762\r
1763 ASSERT(MatchingHandleCount != NULL);\r
1764 ASSERT(DriverBindingHandle != NULL || ControllerHandle != NULL);\r
1765\r
1766 if ((Mask & HR_VALID_MASK) != Mask) {\r
1767 return (EFI_INVALID_PARAMETER);\r
1768 }\r
1769\r
1770 if ((Mask & HR_CHILD_HANDLE) != 0 && DriverBindingHandle == NULL) {\r
1771 return (EFI_INVALID_PARAMETER);\r
1772 }\r
1773\r
1774 *MatchingHandleCount = 0;\r
1775 if (MatchingHandleBuffer != NULL) {\r
1776 *MatchingHandleBuffer = NULL;\r
1777 }\r
1778\r
1779 HandleBuffer = NULL;\r
1780 HandleType = NULL;\r
1781\r
1782 Status = ParseHandleDatabaseByRelationshipWithType (\r
1783 DriverBindingHandle,\r
1784 ControllerHandle,\r
1785 &HandleCount,\r
1786 &HandleBuffer,\r
1787 &HandleType\r
1788 );\r
1789 if (!EFI_ERROR (Status)) {\r
1790 //\r
1791 // Count the number of handles that match the attributes in Mask\r
1792 //\r
1793 for (HandleIndex = 0; HandleIndex < HandleCount; HandleIndex++) {\r
1794 if ((HandleType[HandleIndex] & Mask) == Mask) {\r
1795 (*MatchingHandleCount)++;\r
1796 }\r
1797 }\r
1798 //\r
1799 // If no handles match the attributes in Mask then return EFI_NOT_FOUND\r
1800 //\r
1801 if (*MatchingHandleCount == 0) {\r
1802 Status = EFI_NOT_FOUND;\r
1803 } else {\r
1804\r
1805 if (MatchingHandleBuffer == NULL) {\r
1806 //\r
1807 // Someone just wanted the count...\r
1808 //\r
1809 Status = EFI_SUCCESS;\r
1810 } else {\r
1811 //\r
1812 // Allocate a handle buffer for the number of handles that matched the attributes in Mask\r
1813 //\r
78ed876b 1814 *MatchingHandleBuffer = AllocateZeroPool ((*MatchingHandleCount +1)* sizeof (EFI_HANDLE));\r
a405b86d 1815 ASSERT(*MatchingHandleBuffer != NULL);\r
1816\r
1817 for (HandleIndex = 0,*MatchingHandleCount = 0\r
1818 ; HandleIndex < HandleCount\r
1819 ; HandleIndex++\r
1820 ){\r
1821 //\r
1822 // Fill the allocated buffer with the handles that matched the attributes in Mask\r
1823 //\r
1824 if ((HandleType[HandleIndex] & Mask) == Mask) {\r
1825 (*MatchingHandleBuffer)[(*MatchingHandleCount)++] = HandleBuffer[HandleIndex];\r
1826 }\r
1827 }\r
1828\r
1829 //\r
1830 // Make the last one NULL\r
1831 //\r
1832 (*MatchingHandleBuffer)[*MatchingHandleCount] = NULL;\r
1833\r
1834 Status = EFI_SUCCESS;\r
1835 } // MacthingHandleBuffer == NULL (ELSE)\r
1836 } // *MatchingHandleCount == 0 (ELSE)\r
1837 } // no error on ParseHandleDatabaseByRelationshipWithType\r
1838\r
1839 if (HandleBuffer != NULL) {\r
1840 FreePool (HandleBuffer);\r
1841 }\r
1842\r
1843 if (HandleType != NULL) {\r
1844 FreePool (HandleType);\r
1845 }\r
1846\r
1847 return Status;\r
1848}\r
1849\r
1850/**\r
1851 Gets handles for any child controllers of the passed in controller.\r
1852\r
1853 @param[in] ControllerHandle The handle of the "parent controller"\r
1854 @param[in] MatchingHandleCount Pointer to the number of handles in\r
1855 MatchingHandleBuffer on return.\r
1856 @param[out] MatchingHandleBuffer Buffer containing handles on a successful\r
1857 return.\r
1858\r
1859\r
1860 @retval EFI_SUCCESS The operation was sucessful.\r
1861**/\r
1862EFI_STATUS\r
1863EFIAPI\r
1864ParseHandleDatabaseForChildControllers(\r
1865 IN CONST EFI_HANDLE ControllerHandle,\r
1866 IN UINTN *MatchingHandleCount,\r
1867 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL\r
1868 )\r
1869{\r
1870 EFI_STATUS Status;\r
f330ff35 1871 UINTN HandleIndex;\r
a405b86d 1872 UINTN DriverBindingHandleCount;\r
1873 EFI_HANDLE *DriverBindingHandleBuffer;\r
1874 UINTN DriverBindingHandleIndex;\r
1875 UINTN ChildControllerHandleCount;\r
1876 EFI_HANDLE *ChildControllerHandleBuffer;\r
1877 UINTN ChildControllerHandleIndex;\r
a405b86d 1878 EFI_HANDLE *HandleBufferForReturn;\r
1879\r
ff51746b 1880 if (MatchingHandleCount == NULL) {\r
1881 return (EFI_INVALID_PARAMETER);\r
1882 }\r
64d753f1 1883 *MatchingHandleCount = 0;\r
a405b86d 1884\r
1885 Status = PARSE_HANDLE_DATABASE_UEFI_DRIVERS (\r
1886 ControllerHandle,\r
1887 &DriverBindingHandleCount,\r
1888 &DriverBindingHandleBuffer\r
1889 );\r
1890 if (EFI_ERROR (Status)) {\r
1891 return Status;\r
1892 }\r
1893\r
ff51746b 1894 //\r
1895 // Get a buffer big enough for all the controllers.\r
1896 //\r
f330ff35 1897 HandleBufferForReturn = GetHandleListByProtocol(NULL);\r
a405b86d 1898 if (HandleBufferForReturn == NULL) {\r
1899 FreePool (DriverBindingHandleBuffer);\r
ff51746b 1900 return (EFI_NOT_FOUND);\r
a405b86d 1901 }\r
1902\r
a405b86d 1903 for (DriverBindingHandleIndex = 0; DriverBindingHandleIndex < DriverBindingHandleCount; DriverBindingHandleIndex++) {\r
1904 Status = PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (\r
1905 DriverBindingHandleBuffer[DriverBindingHandleIndex],\r
1906 ControllerHandle,\r
1907 &ChildControllerHandleCount,\r
1908 &ChildControllerHandleBuffer\r
1909 );\r
1910 if (EFI_ERROR (Status)) {\r
1911 continue;\r
1912 }\r
1913\r
1914 for (ChildControllerHandleIndex = 0;\r
1915 ChildControllerHandleIndex < ChildControllerHandleCount;\r
1916 ChildControllerHandleIndex++\r
1917 ) {\r
f330ff35 1918 for (HandleIndex = 0; HandleIndex < *MatchingHandleCount; HandleIndex++) {\r
1919 if (HandleBufferForReturn[HandleIndex] == ChildControllerHandleBuffer[ChildControllerHandleIndex]) {\r
1920 break;\r
1921 }\r
1922 }\r
1923 if (HandleIndex >= *MatchingHandleCount) {\r
1924 HandleBufferForReturn[(*MatchingHandleCount)++] = ChildControllerHandleBuffer[ChildControllerHandleIndex];\r
1925 }\r
a405b86d 1926 }\r
1927\r
1928 FreePool (ChildControllerHandleBuffer);\r
1929 }\r
1930\r
1931 FreePool (DriverBindingHandleBuffer);\r
1932\r
1933 if (MatchingHandleBuffer != NULL) {\r
1934 *MatchingHandleBuffer = HandleBufferForReturn;\r
1935 } else {\r
1936 FreePool(HandleBufferForReturn);\r
1937 }\r
1938\r
1939 return (EFI_SUCCESS);\r
1940}\r
1941\r
1942/**\r
1943 Appends 1 buffer to another buffer. This will re-allocate the destination buffer\r
1944 if necessary to fit all of the data.\r
1945\r
1946 If DestinationBuffer is NULL, then ASSERT().\r
1947\r
4ff7e37b
ED		 1948 @param[in, out] DestinationBuffer The pointer to the pointer to the buffer to append onto.\r
1949 @param[in, out] DestinationSize The pointer to the size of DestinationBuffer.\r
1950 @param[in] SourceBuffer The pointer to the buffer to append onto DestinationBuffer.\r
1951 @param[in] SourceSize The number of bytes of SourceBuffer to append.\r
a405b86d 1952\r
1953 @retval NULL A memory allocation failed.\r
1954 @retval NULL A parameter was invalid.\r
1955 @return A pointer to (*DestinationBuffer).\r
1956**/\r
1957VOID*\r
1958EFIAPI\r
1959BuffernCatGrow (\r
1960 IN OUT VOID **DestinationBuffer,\r
1961 IN OUT UINTN *DestinationSize,\r
1962 IN VOID *SourceBuffer,\r
1963 IN UINTN SourceSize\r
1964 )\r
1965{\r
1966 UINTN LocalDestinationSize;\r
1967 UINTN LocalDestinationFinalSize;\r
1968\r
1969 ASSERT(DestinationBuffer != NULL);\r
1970\r
1971 if (SourceSize == 0 || SourceBuffer == NULL) {\r
1972 return (*DestinationBuffer);\r
1973 }\r
1974\r
1975 if (DestinationSize == NULL) {\r
1976 LocalDestinationSize = 0;\r
1977 } else {\r
1978 LocalDestinationSize = *DestinationSize;\r
1979 }\r
1980\r
1981 LocalDestinationFinalSize = LocalDestinationSize + SourceSize;\r
1982\r
1983 if (DestinationSize != NULL) {\r
1984 *DestinationSize = LocalDestinationSize;\r
1985 }\r
1986\r
1987 if (LocalDestinationSize == 0) {\r
1988 // allcoate\r
78ed876b 1989 *DestinationBuffer = AllocateZeroPool(LocalDestinationFinalSize);\r
a405b86d 1990 } else {\r
1991 // reallocate\r
1992 *DestinationBuffer = ReallocatePool(LocalDestinationSize, LocalDestinationFinalSize, *DestinationBuffer);\r
1993 }\r
1994\r
1995 ASSERT(*DestinationBuffer != NULL);\r
1996\r
1997 // copy\r
1998 return (CopyMem(((UINT8*)(*DestinationBuffer)) + LocalDestinationSize, SourceBuffer, SourceSize));\r
1999}\r
2000\r
2001/**\r
2002 Gets handles for any child devices produced by the passed in driver.\r
2003\r
2004 @param[in] DriverHandle The handle of the driver.\r
2005 @param[in] MatchingHandleCount Pointer to the number of handles in\r
2006 MatchingHandleBuffer on return.\r
2007 @param[out] MatchingHandleBuffer Buffer containing handles on a successful\r
2008 return.\r
2009 @retval EFI_SUCCESS The operation was sucessful.\r
2010 @sa ParseHandleDatabaseByRelationship\r
2011**/\r
2012EFI_STATUS\r
2013EFIAPI\r
2014ParseHandleDatabaseForChildDevices(\r
2015 IN CONST EFI_HANDLE DriverHandle,\r
2016 IN UINTN *MatchingHandleCount,\r
2017 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL\r
2018 )\r
2019{\r
2020 EFI_HANDLE *Buffer;\r
2021 EFI_HANDLE *Buffer2;\r
2022 UINTN Count1;\r
2023 UINTN Count2;\r
2024 UINTN HandleIndex;\r
2025 EFI_STATUS Status;\r
2026 UINTN HandleBufferSize;\r
2027\r
2028 ASSERT(MatchingHandleCount != NULL);\r
2029\r
2030 HandleBufferSize = 0;\r
2031 Buffer = NULL;\r
2032 Buffer2 = NULL;\r
2033 *MatchingHandleCount = 0;\r
2034\r
2035 Status = PARSE_HANDLE_DATABASE_DEVICES (\r
2036 DriverHandle,\r
2037 &Count1,\r
2038 &Buffer\r
2039 );\r
2040 if (!EFI_ERROR (Status)) {\r
2041 for (HandleIndex = 0; HandleIndex < Count1; HandleIndex++) {\r
2042 //\r
2043 // now find the children\r
2044 //\r
2045 Status = PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (\r
2046 DriverHandle,\r
2047 Buffer[HandleIndex],\r
2048 &Count2,\r
2049 &Buffer2\r
2050 );\r
2051 if (EFI_ERROR(Status)) {\r
2052 break;\r
2053 }\r
2054 //\r
2055 // save out required and optional data elements\r
2056 //\r
2057 *MatchingHandleCount += Count2;\r
2058 if (MatchingHandleBuffer != NULL) {\r
2059 *MatchingHandleBuffer = BuffernCatGrow((VOID**)MatchingHandleBuffer, &HandleBufferSize, Buffer2, Count2 * sizeof(Buffer2[0]));\r
2060 }\r
2061\r
2062 //\r
2063 // free the memory\r
2064 //\r
2065 if (Buffer2 != NULL) {\r
2066 FreePool(Buffer2);\r
2067 }\r
2068 }\r
2069 }\r
2070\r
2071 if (Buffer != NULL) {\r
2072 FreePool(Buffer);\r
2073 }\r
2074 return (Status);\r
2075}\r
2076\r
2077/**\r
2078 Function to get all handles that support a given protocol or all handles.\r
2079\r
2080 @param[in] ProtocolGuid The guid of the protocol to get handles for. If NULL\r
2081 then the function will return all handles.\r
2082\r
2083 @retval NULL A memory allocation failed.\r
2084 @return A NULL terminated list of handles.\r
2085**/\r
2086EFI_HANDLE*\r
2087EFIAPI\r
40d7a9cf 2088GetHandleListByProtocol (\r
a405b86d 2089 IN CONST EFI_GUID *ProtocolGuid OPTIONAL\r
2090 )\r
2091{\r
2092 EFI_HANDLE *HandleList;\r
2093 UINTN Size;\r
2094 EFI_STATUS Status;\r
2095\r
2096 Size = 0;\r
2097 HandleList = NULL;\r
2098\r
2099 //\r
2100 // We cannot use LocateHandleBuffer since we need that NULL item on the ends of the list!\r
2101 //\r
2102 if (ProtocolGuid == NULL) {\r
2103 Status = gBS->LocateHandle(AllHandles, NULL, NULL, &Size, HandleList);\r
2104 if (Status == EFI_BUFFER_TOO_SMALL) {\r
78ed876b 2105 HandleList = AllocateZeroPool(Size + sizeof(EFI_HANDLE));\r
40d7a9cf 2106 if (HandleList == NULL) {\r
2107 return (NULL);\r
2108 }\r
a405b86d 2109 Status = gBS->LocateHandle(AllHandles, NULL, NULL, &Size, HandleList);\r
2110 HandleList[Size/sizeof(EFI_HANDLE)] = NULL;\r
2111 }\r
2112 } else {\r
2113 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)ProtocolGuid, NULL, &Size, HandleList);\r
2114 if (Status == EFI_BUFFER_TOO_SMALL) {\r
78ed876b 2115 HandleList = AllocateZeroPool(Size + sizeof(EFI_HANDLE));\r
40d7a9cf 2116 if (HandleList == NULL) {\r
2117 return (NULL);\r
2118 }\r
a405b86d 2119 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)ProtocolGuid, NULL, &Size, HandleList);\r
2120 HandleList[Size/sizeof(EFI_HANDLE)] = NULL;\r
2121 }\r
2122 }\r
2123 if (EFI_ERROR(Status)) {\r
2124 if (HandleList != NULL) {\r
2125 FreePool(HandleList);\r
2126 }\r
2127 return (NULL);\r
2128 }\r
2129 return (HandleList);\r
2130}\r
2131\r
2132/**\r
2133 Function to get all handles that support some protocols.\r
2134\r
2135 @param[in] ProtocolGuids A NULL terminated list of protocol GUIDs.\r
2136\r
2137 @retval NULL A memory allocation failed.\r
ff51746b 2138 @retval NULL ProtocolGuids was NULL.\r
2139 @return A NULL terminated list of EFI_HANDLEs.\r
a405b86d 2140**/\r
2141EFI_HANDLE*\r
2142EFIAPI\r
40d7a9cf 2143GetHandleListByProtocolList (\r
a405b86d 2144 IN CONST EFI_GUID **ProtocolGuids\r
2145 )\r
2146{\r
2147 EFI_HANDLE *HandleList;\r
2148 UINTN Size;\r
2149 UINTN TotalSize;\r
40d7a9cf 2150 UINTN TempSize;\r
a405b86d 2151 EFI_STATUS Status;\r
2152 CONST EFI_GUID **GuidWalker;\r
2153 EFI_HANDLE *HandleWalker1;\r
2154 EFI_HANDLE *HandleWalker2;\r
2155\r
2156 Size = 0;\r
2157 HandleList = NULL;\r
2158 TotalSize = sizeof(EFI_HANDLE);\r
2159\r
2160 for (GuidWalker = ProtocolGuids ; GuidWalker != NULL && *GuidWalker != NULL ; GuidWalker++,Size = 0){\r
2161 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)(*GuidWalker), NULL, &Size, NULL);\r
2162 if (Status == EFI_BUFFER_TOO_SMALL) {\r
2163 TotalSize += Size;\r
2164 }\r
2165 }\r
40d7a9cf 2166\r
2167 //\r
2168 // No handles were found... \r
2169 //\r
2170 if (TotalSize == sizeof(EFI_HANDLE)) {\r
2171 return (NULL);\r
2172 }\r
2173\r
2174 HandleList = AllocateZeroPool(TotalSize);\r
a405b86d 2175 if (HandleList == NULL) {\r
2176 return (NULL);\r
2177 }\r
2178\r
2179 Size = 0;\r
2180 for (GuidWalker = ProtocolGuids ; GuidWalker != NULL && *GuidWalker != NULL ; GuidWalker++){\r
40d7a9cf 2181 TempSize = TotalSize - Size;\r
ff51746b 2182 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)(*GuidWalker), NULL, &TempSize, HandleList+(Size/sizeof(EFI_HANDLE)));\r
40d7a9cf 2183\r
2184 //\r
2185 // Allow for missing protocols... Only update the 'used' size upon success.\r
2186 //\r
2187 if (!EFI_ERROR(Status)) {\r
ff51746b 2188 Size += TempSize;\r
40d7a9cf 2189 }\r
a405b86d 2190 }\r
ff51746b 2191 ASSERT(HandleList[(TotalSize/sizeof(EFI_HANDLE))-1] == NULL);\r
a405b86d 2192\r
2193 for (HandleWalker1 = HandleList ; HandleWalker1 != NULL && *HandleWalker1 != NULL ; HandleWalker1++) {\r
2194 for (HandleWalker2 = HandleWalker1 + 1; HandleWalker2 != NULL && *HandleWalker2 != NULL ; HandleWalker2++) {\r
2195 if (*HandleWalker1 == *HandleWalker2) {\r
2196 //\r
2197 // copy memory back 1 handle width.\r
2198 //\r
2199 CopyMem(HandleWalker2, HandleWalker2 + 1, TotalSize - ((HandleWalker2-HandleList+1)*sizeof(EFI_HANDLE)));\r
2200 }\r
2201 }\r
2202 }\r
2203\r
2204 return (HandleList);\r
2205}\r
2206\r
2207\r
2208\r
2209\r
2210\r
2211\r
2212\r
2213\r
2214\r
2215\r
EFI Development Kit II mirror for PVE