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