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