]> git.proxmox.com Git - mirror_edk2.git/blame - ShellPkg/Library/UefiHandleParsingLib/UefiHandleParsingLib.c
ArmPkg/Gic: Fix boundary checking bug
[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
ac14846a 4 Copyright (c) 2010 - 2016, Intel Corporation. All rights reserved.<BR>\r
256aa6d0 5 (C) Copyright 2013-2015 Hewlett-Packard Development Company, L.P.<BR>\r
8985d612 6 (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>\r
a405b86d 7 This program and the accompanying materials\r
8 are licensed and made available under the terms and conditions of the BSD License\r
9 which accompanies this distribution. The full text of the license may be found at\r
10 http://opensource.org/licenses/bsd-license.php\r
11\r
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
14\r
15**/\r
16\r
17#include "UefiHandleParsingLib.h"\r
f4f3c6bf 18#include "IndustryStandard/Acpi10.h"\r
a405b86d 19\r
e7e0e42b 20EFI_HANDLE mHandleParsingHiiHandle = NULL;\r
a405b86d 21HANDLE_INDEX_LIST mHandleList = {{{NULL,NULL},0,0},0};\r
6306fd90
JC
22GUID_INFO_BLOCK *GuidList;\r
23UINTN GuidListCount;\r
efb76d1a
JC
24/**\r
25 Function to translate the EFI_MEMORY_TYPE into a string.\r
26\r
27 @param[in] Memory The memory type.\r
28\r
29 @retval A string representation of the type allocated from BS Pool.\r
30**/\r
31CHAR16*\r
32EFIAPI\r
33ConvertMemoryType (\r
34 IN CONST EFI_MEMORY_TYPE Memory\r
35 )\r
36{\r
37 CHAR16 *RetVal;\r
38 RetVal = NULL;\r
39\r
40 switch (Memory) {\r
41 case EfiReservedMemoryType: StrnCatGrow(&RetVal, NULL, L"EfiReservedMemoryType", 0); break;\r
42 case EfiLoaderCode: StrnCatGrow(&RetVal, NULL, L"EfiLoaderCode", 0); break;\r
43 case EfiLoaderData: StrnCatGrow(&RetVal, NULL, L"EfiLoaderData", 0); break;\r
44 case EfiBootServicesCode: StrnCatGrow(&RetVal, NULL, L"EfiBootServicesCode", 0); break;\r
45 case EfiBootServicesData: StrnCatGrow(&RetVal, NULL, L"EfiBootServicesData", 0); break;\r
46 case EfiRuntimeServicesCode: StrnCatGrow(&RetVal, NULL, L"EfiRuntimeServicesCode", 0); break;\r
47 case EfiRuntimeServicesData: StrnCatGrow(&RetVal, NULL, L"EfiRuntimeServicesData", 0); break;\r
48 case EfiConventionalMemory: StrnCatGrow(&RetVal, NULL, L"EfiConventionalMemory", 0); break;\r
49 case EfiUnusableMemory: StrnCatGrow(&RetVal, NULL, L"EfiUnusableMemory", 0); break;\r
50 case EfiACPIReclaimMemory: StrnCatGrow(&RetVal, NULL, L"EfiACPIReclaimMemory", 0); break;\r
51 case EfiACPIMemoryNVS: StrnCatGrow(&RetVal, NULL, L"EfiACPIMemoryNVS", 0); break;\r
52 case EfiMemoryMappedIO: StrnCatGrow(&RetVal, NULL, L"EfiMemoryMappedIO", 0); break;\r
53 case EfiMemoryMappedIOPortSpace: StrnCatGrow(&RetVal, NULL, L"EfiMemoryMappedIOPortSpace", 0); break;\r
54 case EfiPalCode: StrnCatGrow(&RetVal, NULL, L"EfiPalCode", 0); break;\r
55 case EfiMaxMemoryType: StrnCatGrow(&RetVal, NULL, L"EfiMaxMemoryType", 0); break;\r
56 default: ASSERT(FALSE);\r
57 }\r
58 return (RetVal);\r
59}\r
60\r
609e0c58
JC
61/**\r
62 Function to translate the EFI_GRAPHICS_PIXEL_FORMAT into a string.\r
63\r
9145d314 64 @param[in] Fmt The format type.\r
609e0c58
JC
65\r
66 @retval A string representation of the type allocated from BS Pool.\r
67**/\r
68CHAR16*\r
69EFIAPI\r
70ConvertPixelFormat (\r
71 IN CONST EFI_GRAPHICS_PIXEL_FORMAT Fmt\r
72 )\r
73{\r
74 CHAR16 *RetVal;\r
75 RetVal = NULL;\r
76\r
77 switch (Fmt) {\r
78 case PixelRedGreenBlueReserved8BitPerColor: StrnCatGrow(&RetVal, NULL, L"PixelRedGreenBlueReserved8BitPerColor", 0); break;\r
79 case PixelBlueGreenRedReserved8BitPerColor: StrnCatGrow(&RetVal, NULL, L"PixelBlueGreenRedReserved8BitPerColor", 0); break;\r
80 case PixelBitMask: StrnCatGrow(&RetVal, NULL, L"PixelBitMask", 0); break;\r
81 case PixelBltOnly: StrnCatGrow(&RetVal, NULL, L"PixelBltOnly", 0); break;\r
82 case PixelFormatMax: StrnCatGrow(&RetVal, NULL, L"PixelFormatMax", 0); break;\r
83 default: ASSERT(FALSE);\r
84 }\r
85 return (RetVal);\r
86}\r
87\r
a405b86d 88/**\r
89 Constructor for the library.\r
90\r
91 @param[in] ImageHandle Ignored.\r
92 @param[in] SystemTable Ignored.\r
93\r
94 @retval EFI_SUCCESS The operation was successful.\r
95**/\r
96EFI_STATUS\r
97EFIAPI\r
98HandleParsingLibConstructor (\r
99 IN EFI_HANDLE ImageHandle,\r
100 IN EFI_SYSTEM_TABLE *SystemTable\r
101 )\r
102{\r
6306fd90
JC
103 GuidListCount = 0;\r
104 GuidList = NULL;\r
105\r
e7e0e42b
CP
106 //\r
107 // Do nothing with mHandleParsingHiiHandle. Initialize HII as needed.\r
108 //\r
109 return (EFI_SUCCESS);\r
110}\r
111\r
1a6f74d9 112/**\r
e7e0e42b 113 Initialization function for HII packages.\r
1a6f74d9 114\r
e7e0e42b
CP
115**/\r
116VOID\r
117HandleParsingHiiInit (VOID)\r
118{\r
a405b86d 119 if (mHandleParsingHiiHandle == NULL) {\r
e7e0e42b
CP
120 mHandleParsingHiiHandle = HiiAddPackages (&gHandleParsingHiiGuid, gImageHandle, UefiHandleParsingLibStrings, NULL);\r
121 ASSERT (mHandleParsingHiiHandle != NULL);\r
a405b86d 122 }\r
a405b86d 123}\r
124\r
125/**\r
126 Destructor for the library. free any resources.\r
127\r
128 @param[in] ImageHandle Ignored.\r
129 @param[in] SystemTable Ignored.\r
130\r
131 @retval EFI_SUCCESS The operation was successful.\r
132**/\r
133EFI_STATUS\r
134EFIAPI\r
135HandleParsingLibDestructor (\r
136 IN EFI_HANDLE ImageHandle,\r
137 IN EFI_SYSTEM_TABLE *SystemTable\r
138 )\r
139{\r
6306fd90
JC
140 UINTN LoopCount;\r
141\r
142 for (LoopCount = 0; GuidList != NULL && LoopCount < GuidListCount; LoopCount++) {\r
143 SHELL_FREE_NON_NULL(GuidList[LoopCount].GuidId);\r
144 }\r
145\r
146 SHELL_FREE_NON_NULL(GuidList);\r
a405b86d 147 if (mHandleParsingHiiHandle != NULL) {\r
148 HiiRemovePackages(mHandleParsingHiiHandle);\r
149 }\r
150 return (EFI_SUCCESS);\r
151}\r
152\r
efb76d1a
JC
153/**\r
154 Function to dump information about LoadedImage.\r
155\r
156 This will allocate the return buffer from boot services pool.\r
157\r
158 @param[in] TheHandle The handle that has LoadedImage installed.\r
159 @param[in] Verbose TRUE for additional information, FALSE otherwise.\r
160\r
161 @retval A poitner to a string containing the information.\r
162**/\r
a405b86d 163CHAR16*\r
164EFIAPI\r
165LoadedImageProtocolDumpInformation(\r
166 IN CONST EFI_HANDLE TheHandle,\r
167 IN CONST BOOLEAN Verbose\r
168 )\r
169{\r
efb76d1a 170 EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;\r
a405b86d 171 EFI_STATUS Status;\r
efb76d1a
JC
172 CHAR16 *RetVal;\r
173 CHAR16 *Temp;\r
174 CHAR16 *CodeType;\r
175 CHAR16 *DataType;\r
a405b86d 176\r
efb76d1a
JC
177 if (!Verbose) {\r
178 return (CatSPrint(NULL, L"LoadedImage"));\r
a405b86d 179 }\r
180\r
e7e0e42b
CP
181 HandleParsingHiiInit();\r
182\r
efb76d1a 183 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_LI_DUMP_MAIN), NULL);\r
1a6f74d9 184 if (Temp == NULL) {\r
efb76d1a 185 return NULL;\r
a405b86d 186 }\r
187\r
efb76d1a
JC
188 Status = gBS->OpenProtocol (\r
189 TheHandle,\r
190 &gEfiLoadedImageProtocolGuid,\r
191 (VOID**)&LoadedImage,\r
192 gImageHandle,\r
193 NULL,\r
194 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
195 );\r
196\r
5f119dfc
HL
197 if (EFI_ERROR (Status)) {\r
198 SHELL_FREE_NON_NULL (Temp);\r
5f119dfc
HL
199 return NULL;\r
200 }\r
201\r
efb76d1a
JC
202 DataType = ConvertMemoryType(LoadedImage->ImageDataType);\r
203 CodeType = ConvertMemoryType(LoadedImage->ImageCodeType);\r
204\r
1a6f74d9
CS
205 RetVal = CatSPrint(\r
206 NULL,\r
207 Temp,\r
208 LoadedImage->Revision,\r
209 LoadedImage->ParentHandle,\r
210 LoadedImage->SystemTable,\r
211 LoadedImage->DeviceHandle,\r
212 LoadedImage->FilePath,\r
213 LoadedImage->LoadOptionsSize,\r
214 LoadedImage->LoadOptions,\r
215 LoadedImage->ImageBase,\r
216 LoadedImage->ImageSize,\r
217 CodeType,\r
218 DataType,\r
219 LoadedImage->Unload\r
220 );\r
221\r
222\r
efb76d1a
JC
223 SHELL_FREE_NON_NULL(Temp);\r
224 SHELL_FREE_NON_NULL(CodeType);\r
225 SHELL_FREE_NON_NULL(DataType);\r
226\r
227 return RetVal;\r
a405b86d 228}\r
a405b86d 229\r
609e0c58
JC
230/**\r
231 Function to dump information about GOP.\r
232\r
233 This will allocate the return buffer from boot services pool.\r
234\r
235 @param[in] TheHandle The handle that has LoadedImage installed.\r
236 @param[in] Verbose TRUE for additional information, FALSE otherwise.\r
237\r
238 @retval A poitner to a string containing the information.\r
239**/\r
240CHAR16*\r
241EFIAPI\r
242GraphicsOutputProtocolDumpInformation(\r
243 IN CONST EFI_HANDLE TheHandle,\r
244 IN CONST BOOLEAN Verbose\r
245 )\r
246{\r
247 EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;\r
248 EFI_STATUS Status;\r
249 CHAR16 *RetVal;\r
250 CHAR16 *Temp;\r
251 CHAR16 *Fmt;\r
252\r
253 if (!Verbose) {\r
254 return (CatSPrint(NULL, L"GraphicsOutput"));\r
255 }\r
256\r
e7e0e42b
CP
257 HandleParsingHiiInit();\r
258\r
609e0c58 259 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_GOP_DUMP_MAIN), NULL);\r
1a6f74d9 260 if (Temp == NULL) {\r
609e0c58
JC
261 return NULL;\r
262 }\r
263\r
264 Status = gBS->OpenProtocol (\r
265 TheHandle,\r
266 &gEfiGraphicsOutputProtocolGuid,\r
267 (VOID**)&GraphicsOutput,\r
268 gImageHandle,\r
269 NULL,\r
270 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
271 );\r
272\r
273 if (EFI_ERROR (Status)) {\r
274 SHELL_FREE_NON_NULL (Temp);\r
609e0c58
JC
275 return NULL;\r
276 }\r
277\r
278 Fmt = ConvertPixelFormat(GraphicsOutput->Mode->Info->PixelFormat);\r
279\r
1a6f74d9
CS
280 RetVal = CatSPrint(\r
281 NULL,\r
282 Temp,\r
283 GraphicsOutput->Mode->MaxMode,\r
284 GraphicsOutput->Mode->Mode,\r
285 GraphicsOutput->Mode->FrameBufferBase,\r
286 (UINT64)GraphicsOutput->Mode->FrameBufferSize,\r
287 (UINT64)GraphicsOutput->Mode->SizeOfInfo,\r
288 GraphicsOutput->Mode->Info->Version,\r
289 GraphicsOutput->Mode->Info->HorizontalResolution,\r
290 GraphicsOutput->Mode->Info->VerticalResolution,\r
291 Fmt,\r
292 GraphicsOutput->Mode->Info->PixelsPerScanLine,\r
293 GraphicsOutput->Mode->Info->PixelFormat!=PixelBitMask?0:GraphicsOutput->Mode->Info->PixelInformation.RedMask,\r
294 GraphicsOutput->Mode->Info->PixelFormat!=PixelBitMask?0:GraphicsOutput->Mode->Info->PixelInformation.GreenMask,\r
295 GraphicsOutput->Mode->Info->PixelFormat!=PixelBitMask?0:GraphicsOutput->Mode->Info->PixelInformation.BlueMask\r
296 );\r
297\r
609e0c58
JC
298 SHELL_FREE_NON_NULL(Temp);\r
299 SHELL_FREE_NON_NULL(Fmt);\r
300\r
301 return RetVal;\r
302}\r
303\r
f4f3c6bf 304/**\r
305 Function to dump information about PciRootBridgeIo.\r
306\r
307 This will allocate the return buffer from boot services pool.\r
308\r
309 @param[in] TheHandle The handle that has PciRootBridgeIo installed.\r
310 @param[in] Verbose TRUE for additional information, FALSE otherwise.\r
311\r
312 @retval A poitner to a string containing the information.\r
313**/\r
314CHAR16*\r
315EFIAPI\r
316PciRootBridgeIoDumpInformation(\r
317 IN CONST EFI_HANDLE TheHandle,\r
318 IN CONST BOOLEAN Verbose\r
319 )\r
320{\r
321 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *PciRootBridgeIo;\r
322 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *Configuration;\r
323 UINT64 Supports;\r
324 UINT64 Attributes;\r
325 CHAR16 *Temp;\r
326 CHAR16 *Temp2;\r
327 CHAR16 *RetVal;\r
328 EFI_STATUS Status;\r
329\r
330 RetVal = NULL;\r
331\r
332 if (!Verbose) {\r
333 return (CatSPrint(NULL, L"PciRootBridgeIo"));\r
334 }\r
335\r
e7e0e42b
CP
336 HandleParsingHiiInit();\r
337\r
f4f3c6bf 338 Status = gBS->HandleProtocol(\r
339 TheHandle,\r
340 &gEfiPciRootBridgeIoProtocolGuid,\r
341 (VOID**)&PciRootBridgeIo);\r
342\r
343 if (EFI_ERROR(Status)) {\r
344 return NULL;\r
345 }\r
346\r
347 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_PH), NULL);\r
1d6ccad2
QS
348 if (Temp == NULL) {\r
349 return NULL;\r
350 }\r
f4f3c6bf 351 Temp2 = CatSPrint(L"\r\n", Temp, PciRootBridgeIo->ParentHandle);\r
352 FreePool(Temp);\r
353 RetVal = Temp2;\r
354 Temp2 = NULL;\r
1a6f74d9 355\r
f4f3c6bf 356 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_SEG), NULL);\r
1d6ccad2
QS
357 if (Temp == NULL) {\r
358 SHELL_FREE_NON_NULL(RetVal);\r
359 return NULL;\r
360 }\r
f4f3c6bf 361 Temp2 = CatSPrint(RetVal, Temp, PciRootBridgeIo->SegmentNumber);\r
362 FreePool(Temp);\r
363 FreePool(RetVal);\r
364 RetVal = Temp2;\r
365 Temp2 = NULL;\r
366\r
367 Supports = 0;\r
368 Attributes = 0;\r
369 Status = PciRootBridgeIo->GetAttributes (PciRootBridgeIo, &Supports, &Attributes);\r
370 if (!EFI_ERROR(Status)) {\r
371 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_ATT), NULL);\r
1d6ccad2
QS
372 if (Temp == NULL) {\r
373 SHELL_FREE_NON_NULL(RetVal);\r
374 return NULL;\r
1a6f74d9 375 }\r
f4f3c6bf 376 Temp2 = CatSPrint(RetVal, Temp, Attributes);\r
377 FreePool(Temp);\r
378 FreePool(RetVal);\r
379 RetVal = Temp2;\r
380 Temp2 = NULL;\r
1a6f74d9 381\r
f4f3c6bf 382 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_SUPPORTS), NULL);\r
1d6ccad2
QS
383 if (Temp == NULL) {\r
384 SHELL_FREE_NON_NULL(RetVal);\r
385 return NULL;\r
386 }\r
f4f3c6bf 387 Temp2 = CatSPrint(RetVal, Temp, Supports);\r
388 FreePool(Temp);\r
389 FreePool(RetVal);\r
390 RetVal = Temp2;\r
391 Temp2 = NULL;\r
392 }\r
393\r
394 Configuration = NULL;\r
395 Status = PciRootBridgeIo->Configuration (PciRootBridgeIo, (VOID **) &Configuration);\r
396 if (!EFI_ERROR(Status) && Configuration != NULL) {\r
397 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_TITLE), NULL);\r
1d6ccad2
QS
398 if (Temp == NULL) {\r
399 SHELL_FREE_NON_NULL(RetVal);\r
400 return NULL;\r
401 }\r
f4f3c6bf 402 Temp2 = CatSPrint(RetVal, Temp, Supports);\r
403 FreePool(Temp);\r
404 FreePool(RetVal);\r
405 RetVal = Temp2;\r
406 Temp2 = NULL;\r
407 while (Configuration->Desc == ACPI_ADDRESS_SPACE_DESCRIPTOR) {\r
408 Temp = NULL;\r
409 switch (Configuration->ResType) {\r
410 case ACPI_ADDRESS_SPACE_TYPE_MEM:\r
411 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_MEM), NULL);\r
412 break;\r
413 case ACPI_ADDRESS_SPACE_TYPE_IO:\r
414 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_IO), NULL);\r
415 break;\r
416 case ACPI_ADDRESS_SPACE_TYPE_BUS:\r
417 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_BUS), NULL);\r
418 break;\r
419 }\r
420 if (Temp != NULL) {\r
421 Temp2 = CatSPrint(RetVal, L"%s", Temp);\r
422 FreePool(Temp);\r
423 FreePool(RetVal);\r
424 RetVal = Temp2;\r
425 Temp2 = NULL;\r
426 }\r
427\r
1a6f74d9 428 Temp2 = CatSPrint(RetVal,\r
f4f3c6bf 429 L"%H%02x %016lx %016lx %02x%N\r\n",\r
430 Configuration->SpecificFlag,\r
431 Configuration->AddrRangeMin,\r
432 Configuration->AddrRangeMax,\r
433 Configuration->AddrSpaceGranularity\r
434 );\r
435 FreePool(RetVal);\r
436 RetVal = Temp2;\r
437 Temp2 = NULL;\r
438 Configuration++;\r
439 }\r
440 }\r
441 return (RetVal);\r
442}\r
443\r
a405b86d 444/**\r
445 Function to dump information about SimpleTextOut.\r
446\r
447 This will allocate the return buffer from boot services pool.\r
448\r
449 @param[in] TheHandle The handle that has SimpleTextOut installed.\r
450 @param[in] Verbose TRUE for additional information, FALSE otherwise.\r
451\r
452 @retval A poitner to a string containing the information.\r
453**/\r
454CHAR16*\r
455EFIAPI\r
456TxtOutProtocolDumpInformation(\r
457 IN CONST EFI_HANDLE TheHandle,\r
458 IN CONST BOOLEAN Verbose\r
459 )\r
460{\r
461 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *Dev;\r
462 INTN Index;\r
463 UINTN Col;\r
464 UINTN Row;\r
465 EFI_STATUS Status;\r
466 CHAR16 *RetVal;\r
467 UINTN Size;\r
468 CHAR16 *Temp;\r
469 UINTN NewSize;\r
470\r
471 if (!Verbose) {\r
472 return (NULL);\r
473 }\r
474\r
e7e0e42b
CP
475 HandleParsingHiiInit();\r
476\r
a405b86d 477 RetVal = NULL;\r
478 Size = 0;\r
479\r
480 Status = gBS->HandleProtocol(\r
481 TheHandle,\r
482 &gEfiSimpleTextOutProtocolGuid,\r
483 (VOID**)&Dev);\r
484\r
485 ASSERT_EFI_ERROR(Status);\r
486 ASSERT (Dev != NULL && Dev->Mode != NULL);\r
487\r
488 Size = (Dev->Mode->MaxMode + 1) * 80;\r
489 RetVal = AllocateZeroPool(Size);\r
490\r
491 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_TXT_OUT_DUMP_HEADER), NULL);\r
ecae5117 492 if (Temp != NULL) {\r
493 UnicodeSPrint(RetVal, Size, Temp, Dev, Dev->Mode->Attribute);\r
494 FreePool(Temp);\r
495 }\r
a405b86d 496\r
497 //\r
498 // Dump TextOut Info\r
499 //\r
500 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_TXT_OUT_DUMP_LINE), NULL);\r
501 for (Index = 0; Index < Dev->Mode->MaxMode; Index++) {\r
502 Status = Dev->QueryMode (Dev, Index, &Col, &Row);\r
503 NewSize = Size - StrSize(RetVal);\r
504 UnicodeSPrint(\r
505 RetVal + StrLen(RetVal),\r
506 NewSize,\r
ecae5117 507 Temp == NULL?L"":Temp,\r
a405b86d 508 Index == Dev->Mode->Mode ? L'*' : L' ',\r
509 Index,\r
28981267 510 !EFI_ERROR(Status)?(INTN)Col:-1,\r
511 !EFI_ERROR(Status)?(INTN)Row:-1\r
a405b86d 512 );\r
513 }\r
514 FreePool(Temp);\r
515 return (RetVal);\r
516}\r
517\r
518STATIC CONST UINTN VersionStringSize = 60;\r
519\r
520/**\r
521 Function to dump information about EfiDriverSupportedEfiVersion protocol.\r
522\r
523 This will allocate the return buffer from boot services pool.\r
524\r
525 @param[in] TheHandle The handle that has the protocol installed.\r
526 @param[in] Verbose TRUE for additional information, FALSE otherwise.\r
527\r
528 @retval A poitner to a string containing the information.\r
529**/\r
530CHAR16*\r
531EFIAPI\r
532DriverEfiVersionProtocolDumpInformation(\r
533 IN CONST EFI_HANDLE TheHandle,\r
534 IN CONST BOOLEAN Verbose\r
535 )\r
536{\r
537 EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL *DriverEfiVersion;\r
538 EFI_STATUS Status;\r
539 CHAR16 *RetVal;\r
540\r
541 Status = gBS->HandleProtocol(\r
542 TheHandle,\r
543 &gEfiDriverSupportedEfiVersionProtocolGuid,\r
544 (VOID**)&DriverEfiVersion);\r
545\r
546 ASSERT_EFI_ERROR(Status);\r
547\r
78ed876b 548 RetVal = AllocateZeroPool(VersionStringSize);\r
a405b86d 549 ASSERT(RetVal != NULL);\r
550 UnicodeSPrint(RetVal, VersionStringSize, L"0x%08x", DriverEfiVersion->FirmwareVersion);\r
551 return (RetVal);\r
552}\r
553\r
554/**\r
555 Function to dump information about DevicePath protocol.\r
556\r
557 This will allocate the return buffer from boot services pool.\r
558\r
559 @param[in] TheHandle The handle that has the protocol installed.\r
560 @param[in] Verbose TRUE for additional information, FALSE otherwise.\r
561\r
562 @retval A poitner to a string containing the information.\r
563**/\r
564CHAR16*\r
565EFIAPI\r
566DevicePathProtocolDumpInformation(\r
567 IN CONST EFI_HANDLE TheHandle,\r
568 IN CONST BOOLEAN Verbose\r
569 )\r
570{\r
571 EFI_DEVICE_PATH_PROTOCOL *DevPath;\r
572 CHAR16 *Temp;\r
573 CHAR16 *Temp2;\r
574 EFI_STATUS Status;\r
a405b86d 575 Temp = NULL;\r
576\r
863986b3 577 Status = gBS->OpenProtocol(TheHandle, &gEfiDevicePathProtocolGuid, (VOID**)&DevPath, gImageHandle, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
a405b86d 578 if (!EFI_ERROR(Status)) {\r
863986b3
RN
579 //\r
580 // I cannot decide whether to allow shortcuts here (the second BOOLEAN on the next line)\r
581 //\r
582 Temp = ConvertDevicePathToText(DevPath, TRUE, TRUE);\r
583 gBS->CloseProtocol(TheHandle, &gEfiDevicePathProtocolGuid, gImageHandle, NULL);\r
a405b86d 584 }\r
78ed876b 585 if (!Verbose && Temp != NULL && StrLen(Temp) > 30) {\r
a405b86d 586 Temp2 = NULL;\r
587 Temp2 = StrnCatGrow(&Temp2, NULL, Temp+(StrLen(Temp) - 30), 30);\r
588 FreePool(Temp);\r
589 Temp = Temp2;\r
590 }\r
591 return (Temp);\r
592}\r
593\r
59febea1
SEHM
594/**\r
595 Function to dump information about EfiAdapterInformation Protocol.\r
596\r
597 @param[in] TheHandle The handle that has the protocol installed.\r
598 @param[in] Verbose TRUE for additional information, FALSE otherwise.\r
599\r
600 @retval A pointer to a string containing the information.\r
601**/\r
602CHAR16*\r
603EFIAPI\r
604AdapterInformationDumpInformation (\r
605 IN CONST EFI_HANDLE TheHandle,\r
606 IN CONST BOOLEAN Verbose\r
607 )\r
608{\r
609 EFI_STATUS Status;\r
610 EFI_ADAPTER_INFORMATION_PROTOCOL *EfiAdptrInfoProtocol;\r
611 UINTN InfoTypesBufferCount;\r
612 UINTN GuidIndex;\r
613 EFI_GUID *InfoTypesBuffer;\r
614 CHAR16 *GuidStr;\r
615 CHAR16 *TempStr;\r
616 CHAR16 *RetVal;\r
1a6f74d9 617 CHAR16 *TempRetVal;\r
59febea1
SEHM
618 VOID *InformationBlock;\r
619 UINTN InformationBlockSize;\r
1a6f74d9 620\r
59febea1
SEHM
621 if (!Verbose) {\r
622 return (CatSPrint(NULL, L"AdapterInfo"));\r
623 }\r
624\r
1d6ccad2
QS
625 InfoTypesBuffer = NULL;\r
626 InformationBlock = NULL;\r
1a6f74d9 627\r
59febea1
SEHM
628\r
629 Status = gBS->OpenProtocol (\r
630 (EFI_HANDLE) (TheHandle),\r
631 &gEfiAdapterInformationProtocolGuid,\r
632 (VOID **) &EfiAdptrInfoProtocol,\r
633 NULL,\r
634 NULL,\r
635 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
636 );\r
637\r
638 if (EFI_ERROR (Status)) {\r
59febea1
SEHM
639 return NULL;\r
640 }\r
641\r
642 //\r
643 // Get a list of supported information types for this instance of the protocol.\r
644 //\r
645 Status = EfiAdptrInfoProtocol->GetSupportedTypes (\r
646 EfiAdptrInfoProtocol,\r
1a6f74d9 647 &InfoTypesBuffer,\r
59febea1
SEHM
648 &InfoTypesBufferCount\r
649 );\r
1a6f74d9 650 RetVal = NULL;\r
59febea1
SEHM
651 if (EFI_ERROR (Status)) {\r
652 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_GET_SUPP_TYPES_FAILED), NULL);\r
1d6ccad2 653 if (TempStr != NULL) {\r
1a6f74d9 654 RetVal = CatSPrint (NULL, TempStr, Status);\r
1d6ccad2
QS
655 } else {\r
656 goto ERROR_EXIT;\r
1a6f74d9 657 }\r
59febea1
SEHM
658 } else {\r
659 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_SUPP_TYPE_HEADER), NULL);\r
1d6ccad2
QS
660 if (TempStr == NULL) {\r
661 goto ERROR_EXIT;\r
662 }\r
1a6f74d9 663 RetVal = CatSPrint (NULL, TempStr);\r
59febea1
SEHM
664 SHELL_FREE_NON_NULL (TempStr);\r
665\r
666 for (GuidIndex = 0; GuidIndex < InfoTypesBufferCount; GuidIndex++) {\r
667 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_GUID_NUMBER), NULL);\r
1d6ccad2
QS
668 if (TempStr == NULL) {\r
669 goto ERROR_EXIT;\r
670 }\r
5d54bbec 671 TempRetVal = CatSPrint (RetVal, TempStr, (GuidIndex + 1), &InfoTypesBuffer[GuidIndex]);\r
1a6f74d9
CS
672 SHELL_FREE_NON_NULL (RetVal);\r
673 RetVal = TempRetVal;\r
59febea1
SEHM
674 SHELL_FREE_NON_NULL (TempStr);\r
675\r
676 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_GUID_STRING), NULL);\r
1d6ccad2
QS
677 if (TempStr == NULL) {\r
678 goto ERROR_EXIT;\r
679 }\r
59febea1
SEHM
680\r
681 if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoMediaStateGuid)) {\r
1a6f74d9
CS
682 TempRetVal = CatSPrint (RetVal, TempStr, L"gEfiAdapterInfoMediaStateGuid");\r
683 SHELL_FREE_NON_NULL (RetVal);\r
684 RetVal = TempRetVal;\r
59febea1 685 } else if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoNetworkBootGuid)) {\r
1a6f74d9
CS
686 TempRetVal = CatSPrint (RetVal, TempStr, L"gEfiAdapterInfoNetworkBootGuid");\r
687 SHELL_FREE_NON_NULL (RetVal);\r
688 RetVal = TempRetVal;\r
59febea1 689 } else if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoSanMacAddressGuid)) {\r
1a6f74d9
CS
690 TempRetVal = CatSPrint (RetVal, TempStr, L"gEfiAdapterInfoSanMacAddressGuid");\r
691 SHELL_FREE_NON_NULL (RetVal);\r
692 RetVal = TempRetVal;\r
256aa6d0
SEHM
693 } else if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoUndiIpv6SupportGuid)) {\r
694 TempRetVal = CatSPrint (RetVal, TempStr, L"gEfiAdapterInfoUndiIpv6SupportGuid");\r
695 SHELL_FREE_NON_NULL (RetVal);\r
696 RetVal = TempRetVal;\r
59febea1
SEHM
697 } else {\r
698\r
699 GuidStr = GetStringNameFromGuid (&InfoTypesBuffer[GuidIndex], NULL);\r
1a6f74d9 700\r
59febea1
SEHM
701 if (GuidStr != NULL) {\r
702 if (StrCmp(GuidStr, L"UnknownDevice") == 0) {\r
1a6f74d9
CS
703 TempRetVal = CatSPrint (RetVal, TempStr, L"UnknownInfoType");\r
704 SHELL_FREE_NON_NULL (RetVal);\r
705 RetVal = TempRetVal;\r
706\r
59febea1
SEHM
707 SHELL_FREE_NON_NULL (TempStr);\r
708 SHELL_FREE_NON_NULL(GuidStr);\r
709 //\r
710 // So that we never have to pass this UnknownInfoType to the parsing function "GetInformation" service of AIP\r
711 //\r
1a6f74d9 712 continue;\r
59febea1 713 } else {\r
1a6f74d9
CS
714 TempRetVal = CatSPrint (RetVal, TempStr, GuidStr);\r
715 SHELL_FREE_NON_NULL (RetVal);\r
716 RetVal = TempRetVal;\r
59febea1
SEHM
717 SHELL_FREE_NON_NULL(GuidStr);\r
718 }\r
719 }\r
720 }\r
1a6f74d9 721\r
59febea1
SEHM
722 SHELL_FREE_NON_NULL (TempStr);\r
723\r
724 Status = EfiAdptrInfoProtocol->GetInformation (\r
725 EfiAdptrInfoProtocol,\r
726 &InfoTypesBuffer[GuidIndex],\r
727 &InformationBlock,\r
728 &InformationBlockSize\r
729 );\r
730\r
731 if (EFI_ERROR (Status)) {\r
732 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_GETINFO_FAILED), NULL);\r
1d6ccad2
QS
733 if (TempStr == NULL) {\r
734 goto ERROR_EXIT;\r
735 }\r
1a6f74d9
CS
736 TempRetVal = CatSPrint (RetVal, TempStr, Status);\r
737 SHELL_FREE_NON_NULL (RetVal);\r
738 RetVal = TempRetVal;\r
59febea1
SEHM
739 } else {\r
740 if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoMediaStateGuid)) {\r
741 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_MEDIA_STATE), NULL);\r
1d6ccad2
QS
742 if (TempStr == NULL) {\r
743 goto ERROR_EXIT;\r
744 }\r
1a6f74d9
CS
745 TempRetVal = CatSPrint (\r
746 RetVal,\r
747 TempStr,\r
748 ((EFI_ADAPTER_INFO_MEDIA_STATE *)InformationBlock)->MediaState,\r
749 ((EFI_ADAPTER_INFO_MEDIA_STATE *)InformationBlock)->MediaState\r
750 );\r
751 SHELL_FREE_NON_NULL (RetVal);\r
752 RetVal = TempRetVal;\r
59febea1
SEHM
753 } else if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoNetworkBootGuid)) {\r
754 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_NETWORK_BOOT_INFO), NULL);\r
1d6ccad2
QS
755 if (TempStr == NULL) {\r
756 goto ERROR_EXIT;\r
757 }\r
1a6f74d9
CS
758 TempRetVal = CatSPrint (\r
759 RetVal,\r
760 TempStr,\r
761 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->iScsiIpv4BootCapablity,\r
762 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->iScsiIpv6BootCapablity,\r
763 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->FCoeBootCapablity,\r
764 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->OffloadCapability,\r
765 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->iScsiMpioCapability,\r
766 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->iScsiIpv4Boot,\r
767 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->iScsiIpv6Boot,\r
768 ((EFI_ADAPTER_INFO_NETWORK_BOOT *)InformationBlock)->FCoeBoot\r
769 );\r
770 SHELL_FREE_NON_NULL (RetVal);\r
771 RetVal = TempRetVal;\r
772 } else if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoSanMacAddressGuid) == TRUE) {\r
59febea1 773 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_SAN_MAC_ADDRESS_INFO), NULL);\r
1d6ccad2
QS
774 if (TempStr == NULL) {\r
775 goto ERROR_EXIT;\r
776 }\r
1a6f74d9
CS
777 TempRetVal = CatSPrint (\r
778 RetVal,\r
779 TempStr,\r
780 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[0],\r
781 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[1],\r
782 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[2],\r
783 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[3],\r
784 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[4],\r
785 ((EFI_ADAPTER_INFO_SAN_MAC_ADDRESS *)InformationBlock)->SanMacAddress.Addr[5]\r
786 );\r
787 SHELL_FREE_NON_NULL (RetVal);\r
788 RetVal = TempRetVal;\r
256aa6d0
SEHM
789 } else if (CompareGuid (&InfoTypesBuffer[GuidIndex], &gEfiAdapterInfoUndiIpv6SupportGuid) == TRUE) {\r
790 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_UNDI_IPV6_INFO), NULL);\r
791 if (TempStr == NULL) {\r
792 goto ERROR_EXIT;\r
793 }\r
794\r
795 TempRetVal = CatSPrint (\r
796 RetVal,\r
797 TempStr,\r
798 ((EFI_ADAPTER_INFO_UNDI_IPV6_SUPPORT *)InformationBlock)->Ipv6Support\r
799 ); \r
800 SHELL_FREE_NON_NULL (RetVal);\r
801 RetVal = TempRetVal;\r
59febea1
SEHM
802 } else {\r
803 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_UNKNOWN_INFO_TYPE), NULL);\r
1d6ccad2
QS
804 if (TempStr == NULL) {\r
805 goto ERROR_EXIT;\r
806 }\r
1a6f74d9
CS
807 TempRetVal = CatSPrint (RetVal, TempStr, &InfoTypesBuffer[GuidIndex]);\r
808 SHELL_FREE_NON_NULL (RetVal);\r
809 RetVal = TempRetVal;\r
59febea1
SEHM
810 }\r
811 }\r
812 SHELL_FREE_NON_NULL (TempStr);\r
813 SHELL_FREE_NON_NULL (InformationBlock);\r
814 }\r
815 }\r
816\r
1d6ccad2 817 SHELL_FREE_NON_NULL (InfoTypesBuffer);\r
59febea1 818 return RetVal;\r
1d6ccad2
QS
819\r
820ERROR_EXIT:\r
821 SHELL_FREE_NON_NULL (RetVal);\r
822 SHELL_FREE_NON_NULL (InfoTypesBuffer);\r
823 SHELL_FREE_NON_NULL (InformationBlock);\r
824 return NULL;\r
59febea1 825}\r
8985d612
TS
826\r
827/**\r
828 Function to dump information about EFI_FIRMWARE_MANAGEMENT_PROTOCOL Protocol.\r
829\r
830 @param[in] TheHandle The handle that has the protocol installed.\r
831 @param[in] Verbose TRUE for additional information, FALSE otherwise.\r
832\r
833 @retval A pointer to a string containing the information.\r
834**/\r
835CHAR16*\r
836EFIAPI\r
837FirmwareManagementDumpInformation (\r
838 IN CONST EFI_HANDLE TheHandle,\r
839 IN CONST BOOLEAN Verbose\r
840 )\r
841{\r
842 EFI_STATUS Status;\r
843 EFI_FIRMWARE_MANAGEMENT_PROTOCOL *EfiFwMgmtProtocol;\r
844 EFI_FIRMWARE_IMAGE_DESCRIPTOR *ImageInfo;\r
845 EFI_FIRMWARE_IMAGE_DESCRIPTOR_V1 *ImageInfoV1;\r
846 EFI_FIRMWARE_IMAGE_DESCRIPTOR_V2 *ImageInfoV2;\r
847 UINT64 AttributeSetting;\r
848 UINTN ImageInfoSize;\r
849 UINTN DescriptorSize;\r
850 UINT32 DescriptorVersion;\r
851 UINT32 PackageVersion;\r
852 UINT8 DescriptorCount;\r
853 UINT8 Index;\r
854 UINT8 Index1;\r
855 UINT8 ImageCount;\r
856 CHAR16 *PackageVersionName;\r
857 CHAR16 *TempStr;\r
858 CHAR16 *RetVal;\r
859 CHAR16 *TempRetVal;\r
860 CHAR16 *AttributeSettingStr;\r
861 BOOLEAN Found;\r
862 BOOLEAN AttributeSupported;\r
863\r
864 //\r
865 // Initialize local variables\r
866 //\r
867 ImageCount = 0;\r
868 ImageInfoSize = 1;\r
869 AttributeSetting = 0;\r
870 Found = FALSE;\r
871 AttributeSupported = FALSE;\r
872 ImageInfo = NULL;\r
873 ImageInfoV1 = NULL;\r
874 ImageInfoV2 = NULL;\r
875 PackageVersionName = NULL;\r
876 RetVal = NULL;\r
877 TempRetVal = NULL;\r
878 TempStr = NULL;\r
879 AttributeSettingStr = NULL;\r
880\r
881 if (!Verbose) {\r
882 return (CatSPrint(NULL, L"FirmwareManagement"));\r
883 }\r
884\r
885 Status = gBS->OpenProtocol (\r
886 (EFI_HANDLE) (TheHandle),\r
887 &gEfiFirmwareManagementProtocolGuid,\r
888 (VOID **) &EfiFwMgmtProtocol,\r
889 NULL,\r
890 NULL,\r
891 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
892 );\r
893\r
894 if (EFI_ERROR (Status)) {\r
895 return NULL;\r
896 }\r
897\r
898 Status = EfiFwMgmtProtocol->GetImageInfo (\r
899 EfiFwMgmtProtocol,\r
900 &ImageInfoSize,\r
901 ImageInfo,\r
902 &DescriptorVersion,\r
903 &DescriptorCount,\r
904 &DescriptorSize,\r
905 &PackageVersion,\r
906 &PackageVersionName\r
907 );\r
908\r
909 if (Status == EFI_BUFFER_TOO_SMALL) {\r
910 ImageInfo = AllocateZeroPool (ImageInfoSize);\r
911\r
912 if (ImageInfo == NULL) {\r
913 Status = EFI_OUT_OF_RESOURCES;\r
914 } else {\r
915 Status = EfiFwMgmtProtocol->GetImageInfo (\r
916 EfiFwMgmtProtocol,\r
917 &ImageInfoSize,\r
918 ImageInfo,\r
919 &DescriptorVersion,\r
920 &DescriptorCount,\r
921 &DescriptorSize,\r
922 &PackageVersion,\r
923 &PackageVersionName\r
924 );\r
925 }\r
926 }\r
927\r
928 if (EFI_ERROR (Status)) {\r
929 goto ERROR_EXIT;\r
930 }\r
931\r
932 //\r
933 // Decode Image Descriptor data only if its version is supported\r
934 //\r
935 if (DescriptorVersion <= EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION) {\r
936\r
937 if (ImageInfo == NULL) {\r
938 goto ERROR_EXIT;\r
939 }\r
940\r
941 ImageInfoV1 = (EFI_FIRMWARE_IMAGE_DESCRIPTOR_V1 *)ImageInfo;\r
942 ImageInfoV2 = (EFI_FIRMWARE_IMAGE_DESCRIPTOR_V2 *)ImageInfo;\r
943\r
944 //\r
945 // Set ImageInfoSize in return buffer\r
946 //\r
947 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_FMP_IMAGE_INFO_SIZE), NULL);\r
948 if (TempStr == NULL) {\r
949 goto ERROR_EXIT;\r
950 }\r
951 RetVal = CatSPrint (NULL, TempStr, ImageInfoSize);\r
952 SHELL_FREE_NON_NULL (TempStr);\r
953\r
954 //\r
955 // Set DescriptorVersion in return buffer\r
956 //\r
957 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_FMP_DESCRIPTOR_VERSION), NULL);\r
958 if (TempStr == NULL) {\r
959 goto ERROR_EXIT;\r
960 }\r
961 TempRetVal = CatSPrint (RetVal, TempStr, DescriptorVersion);\r
962 SHELL_FREE_NON_NULL (RetVal);\r
963 RetVal = TempRetVal;\r
964 SHELL_FREE_NON_NULL (TempStr);\r
965\r
966 //\r
967 // Set DescriptorCount in return buffer\r
968 //\r
969 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_FMP_DESCRIPTOR_COUNT), NULL);\r
970 if (TempStr == NULL) {\r
971 goto ERROR_EXIT;\r
972 }\r
973 TempRetVal = CatSPrint (RetVal, TempStr, DescriptorCount);\r
974 SHELL_FREE_NON_NULL (RetVal);\r
975 RetVal = TempRetVal;\r
976 SHELL_FREE_NON_NULL (TempStr);\r
977\r
978\r
979 //\r
980 // Set DescriptorSize in return buffer\r
981 //\r
982 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_FMP_DESCRIPTOR_SIZE), NULL);\r
983 if (TempStr == NULL) {\r
984 goto ERROR_EXIT;\r
985 }\r
986 TempRetVal = CatSPrint (RetVal, TempStr, DescriptorSize);\r
987 SHELL_FREE_NON_NULL (RetVal);\r
988 RetVal = TempRetVal;\r
989 SHELL_FREE_NON_NULL (TempStr);\r
990\r
991 //\r
992 // Set PackageVersion in return buffer\r
993 //\r
994 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_FMP_PACKAGE_VERSION), NULL);\r
995 if (TempStr == NULL) {\r
996 goto ERROR_EXIT;\r
997 }\r
998 TempRetVal = CatSPrint (RetVal, TempStr, PackageVersion);\r
999 SHELL_FREE_NON_NULL (RetVal);\r
1000 RetVal = TempRetVal;\r
1001 SHELL_FREE_NON_NULL (TempStr);\r
1002\r
1003 //\r
1004 // Set PackageVersionName in return buffer\r
1005 //\r
1006 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_FMP_PACKAGE_VERSION_NAME), NULL);\r
1007 if (TempStr == NULL) {\r
1008 goto ERROR_EXIT;\r
1009 }\r
1010 TempRetVal = CatSPrint (RetVal, TempStr, PackageVersionName);\r
1011 SHELL_FREE_NON_NULL (RetVal);\r
1012 RetVal = TempRetVal;\r
1013 SHELL_FREE_NON_NULL (TempStr);\r
1014\r
1015 for (Index = 0; Index < DescriptorCount; Index++) {\r
1016 //\r
1017 // First check if Attribute is supported\r
1018 // and generate a string for AttributeSetting field\r
1019 //\r
1020 SHELL_FREE_NON_NULL (AttributeSettingStr);\r
1021 AttributeSupported = FALSE;\r
1022 AttributeSetting = 0;\r
1023 if (DescriptorVersion == EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION_V1) {\r
1024 if (ImageInfoV1[Index].AttributesSupported != 0x0) {\r
1025 AttributeSupported = TRUE;\r
1026 AttributeSetting = ImageInfoV1[Index].AttributesSetting;\r
1027 }\r
1028 } else if (DescriptorVersion == EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION_V2) {\r
1029 if (ImageInfoV2[Index].AttributesSupported != 0x0) {\r
1030 AttributeSupported = TRUE;\r
1031 AttributeSetting = ImageInfoV2[Index].AttributesSetting;\r
1032 }\r
1033 } else {\r
1034 if (ImageInfo[Index].AttributesSupported != 0x0) {\r
1035 AttributeSupported = TRUE;\r
1036 AttributeSetting = ImageInfo[Index].AttributesSetting;\r
1037 }\r
1038 }\r
1039\r
1040 if (!AttributeSupported) {\r
1041 AttributeSettingStr = CatSPrint (NULL, L"None");\r
1042 } else {\r
1043 AttributeSettingStr = CatSPrint (NULL, L"(");\r
1044\r
ac14846a 1045 if ((AttributeSetting & IMAGE_ATTRIBUTE_IMAGE_UPDATABLE) != 0x0) {\r
8985d612
TS
1046 TempRetVal = CatSPrint (AttributeSettingStr, L" IMAGE_ATTRIBUTE_IMAGE_UPDATABLE");\r
1047 SHELL_FREE_NON_NULL (AttributeSettingStr);\r
1048 AttributeSettingStr = TempRetVal;\r
1049 }\r
ac14846a 1050 if ((AttributeSetting & IMAGE_ATTRIBUTE_RESET_REQUIRED) != 0x0) {\r
8985d612
TS
1051 TempRetVal = CatSPrint (AttributeSettingStr, L" IMAGE_ATTRIBUTE_RESET_REQUIRED");\r
1052 SHELL_FREE_NON_NULL (AttributeSettingStr);\r
1053 AttributeSettingStr = TempRetVal;\r
1054 }\r
ac14846a 1055 if ((AttributeSetting & IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED) != 0x0) {\r
8985d612
TS
1056 TempRetVal = CatSPrint (AttributeSettingStr, L" IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED");\r
1057 SHELL_FREE_NON_NULL (AttributeSettingStr);\r
1058 AttributeSettingStr = TempRetVal;\r
1059 }\r
ac14846a 1060 if ((AttributeSetting & IMAGE_ATTRIBUTE_IN_USE) != 0x0) {\r
8985d612
TS
1061 TempRetVal = CatSPrint (AttributeSettingStr, L" IMAGE_ATTRIBUTE_IN_USE");\r
1062 SHELL_FREE_NON_NULL (AttributeSettingStr);\r
1063 AttributeSettingStr = TempRetVal;\r
1064 }\r
ac14846a 1065 if ((AttributeSetting & IMAGE_ATTRIBUTE_UEFI_IMAGE) != 0x0) {\r
8985d612
TS
1066 TempRetVal = CatSPrint (AttributeSettingStr, L" IMAGE_ATTRIBUTE_UEFI_IMAGE");\r
1067 SHELL_FREE_NON_NULL (AttributeSettingStr);\r
1068 AttributeSettingStr = TempRetVal;\r
1069 }\r
1070 TempRetVal = CatSPrint (AttributeSettingStr, L" )");\r
1071 SHELL_FREE_NON_NULL (AttributeSettingStr);\r
1072 AttributeSettingStr = TempRetVal;\r
1073 }\r
1074\r
1075 if (DescriptorVersion == EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION_V1) {\r
1076 if (ImageInfoV1[Index].ImageIndex != 0x0) {\r
1077 ImageCount++;\r
1078 }\r
1079\r
1080 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_FMP_IMAGE_DESCRIPTOR_INFO_V1), NULL);\r
1081 if (TempStr == NULL) {\r
1082 goto ERROR_EXIT;\r
1083 }\r
1084 TempRetVal = CatSPrint (\r
1085 RetVal,\r
1086 TempStr,\r
1087 Index,\r
1088 ImageInfoV1[Index].ImageIndex,\r
1089 ImageInfoV1[Index].ImageTypeId,\r
1090 ImageInfoV1[Index].ImageId,\r
1091 ImageInfoV1[Index].ImageIdName,\r
1092 ImageInfoV1[Index].Version,\r
1093 ImageInfoV1[Index].VersionName,\r
1094 ImageInfoV1[Index].Size,\r
1095 ImageInfoV1[Index].AttributesSupported,\r
1096 AttributeSettingStr,\r
1097 ImageInfoV1[Index].Compatibilities\r
1098 );\r
1099 SHELL_FREE_NON_NULL (RetVal);\r
1100 RetVal = TempRetVal;\r
1101 SHELL_FREE_NON_NULL (TempStr);\r
1102 } else if (DescriptorVersion == EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION_V2) {\r
1103 if (ImageInfoV2[Index].ImageIndex != 0x0) {\r
1104 ImageCount++;\r
1105 }\r
1106\r
1107 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_FMP_IMAGE_DESCRIPTOR_INFO_V2), NULL);\r
1108 if (TempStr == NULL) {\r
1109 goto ERROR_EXIT;\r
1110 }\r
1111 TempRetVal = CatSPrint (\r
1112 RetVal,\r
1113 TempStr,\r
1114 Index,\r
1115 ImageInfoV2[Index].ImageIndex,\r
1116 ImageInfoV2[Index].ImageTypeId,\r
1117 ImageInfoV2[Index].ImageId,\r
1118 ImageInfoV2[Index].ImageIdName,\r
1119 ImageInfoV2[Index].Version,\r
1120 ImageInfoV2[Index].VersionName,\r
1121 ImageInfoV2[Index].Size,\r
1122 ImageInfoV2[Index].AttributesSupported,\r
1123 AttributeSettingStr,\r
1124 ImageInfoV2[Index].Compatibilities,\r
1125 ImageInfoV2[Index].LowestSupportedImageVersion\r
1126 );\r
1127 SHELL_FREE_NON_NULL (RetVal);\r
1128 RetVal = TempRetVal;\r
1129 SHELL_FREE_NON_NULL (TempStr);\r
1130 } else {\r
1131 if (ImageInfo[Index].ImageIndex != 0x0) {\r
1132 ImageCount++;\r
1133 }\r
1134\r
1135 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_FMP_IMAGE_DESCRIPTOR_INFO), NULL);\r
1136 if (TempStr == NULL) {\r
1137 goto ERROR_EXIT;\r
1138 }\r
1139 TempRetVal = CatSPrint (\r
1140 RetVal,\r
1141 TempStr,\r
1142 Index,\r
1143 ImageInfo[Index].ImageIndex,\r
1144 ImageInfo[Index].ImageTypeId,\r
1145 ImageInfo[Index].ImageId,\r
1146 ImageInfo[Index].ImageIdName,\r
1147 ImageInfo[Index].Version,\r
1148 ImageInfo[Index].VersionName,\r
1149 ImageInfo[Index].Size,\r
1150 ImageInfo[Index].AttributesSupported,\r
1151 AttributeSettingStr,\r
1152 ImageInfo[Index].Compatibilities,\r
1153 ImageInfo[Index].LowestSupportedImageVersion,\r
1154 ImageInfo[Index].LastAttemptVersion,\r
1155 ImageInfo[Index].LastAttemptStatus,\r
1156 ImageInfo[Index].HardwareInstance\r
1157 );\r
1158 SHELL_FREE_NON_NULL (RetVal);\r
1159 RetVal = TempRetVal;\r
1160 SHELL_FREE_NON_NULL (TempStr);\r
1161 }\r
1162 }\r
1163 }\r
1164\r
1165 if (ImageCount > 0) {\r
1166 for (Index=0; Index<DescriptorCount; Index++) {\r
1167 for (Index1=Index+1; Index1<DescriptorCount; Index1++) {\r
1168 if (DescriptorVersion == EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION_V1) {\r
1169 if (ImageInfoV1[Index].ImageId == ImageInfoV1[Index1].ImageId) {\r
1170 Found = TRUE;\r
1171 //\r
1172 // At least one match found indicating presense of non unique ImageId values so no more comparisons needed\r
1173 //\r
1174 goto ENDLOOP;\r
1175 }\r
1176 } else if (DescriptorVersion == EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION_V2) {\r
1177 if (ImageInfoV2[Index].ImageId == ImageInfoV2[Index1].ImageId) {\r
1178 Found = TRUE;\r
1179 //\r
1180 // At least one match found indicating presense of non unique ImageId values so no more comparisons needed\r
1181 //\r
1182 goto ENDLOOP;\r
1183 }\r
1184 } else {\r
1185 if (ImageInfo[Index].ImageId == ImageInfo[Index1].ImageId) {\r
1186 Found = TRUE;\r
1187 //\r
1188 // At least one match found indicating presense of non unique ImageId values so no more comparisons needed\r
1189 //\r
1190 goto ENDLOOP;\r
1191 }\r
1192 }\r
1193 }\r
1194 }\r
1195 }\r
1196\r
1197ENDLOOP:\r
1198 //\r
1199 // Check if ImageId with duplicate value was found\r
1200 //\r
ac14846a 1201 if (Found) {\r
8985d612
TS
1202 TempStr = HiiGetString (mHandleParsingHiiHandle, STRING_TOKEN(STR_FMP_IMAGEID_NON_UNIQUE), NULL);\r
1203 if (TempStr == NULL) {\r
1204 goto ERROR_EXIT;\r
1205 }\r
1206 TempRetVal = CatSPrint (RetVal, TempStr);\r
1207 SHELL_FREE_NON_NULL (RetVal);\r
1208 RetVal = TempRetVal;\r
1209 SHELL_FREE_NON_NULL (TempStr);\r
1210 }\r
1211\r
1212 SHELL_FREE_NON_NULL (ImageInfo);\r
1213 SHELL_FREE_NON_NULL (PackageVersionName);\r
1214 SHELL_FREE_NON_NULL (AttributeSettingStr);\r
1215\r
1216 return RetVal;\r
1217\r
1218ERROR_EXIT:\r
1219 SHELL_FREE_NON_NULL (RetVal);\r
1220 SHELL_FREE_NON_NULL (ImageInfo);\r
1221 SHELL_FREE_NON_NULL (PackageVersionName);\r
1222 SHELL_FREE_NON_NULL (AttributeSettingStr);\r
1223\r
1224 return NULL;\r
1225}\r
1226\r
a405b86d 1227//\r
1228// Put the information on the NT32 protocol GUIDs here so we are not dependant on the Nt32Pkg\r
1229//\r
1230#define LOCAL_EFI_WIN_NT_THUNK_PROTOCOL_GUID \\r
1231 { \\r
ce68d3bc 1232 0x58c518b1, 0x76f3, 0x11d4, { 0xbc, 0xea, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
a405b86d 1233 }\r
1234\r
1235#define LOCAL_EFI_WIN_NT_BUS_DRIVER_IO_PROTOCOL_GUID \\r
1236 { \\r
ce68d3bc 1237 0x96eb4ad6, 0xa32a, 0x11d4, { 0xbc, 0xfd, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
a405b86d 1238 }\r
1239\r
1240#define LOCAL_EFI_WIN_NT_SERIAL_PORT_GUID \\r
1241 { \\r
ce68d3bc 1242 0xc95a93d, 0xa006, 0x11d4, { 0xbc, 0xfa, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \\r
a405b86d 1243 }\r
1244STATIC CONST EFI_GUID WinNtThunkProtocolGuid = LOCAL_EFI_WIN_NT_THUNK_PROTOCOL_GUID;\r
1245STATIC CONST EFI_GUID WinNtIoProtocolGuid = LOCAL_EFI_WIN_NT_BUS_DRIVER_IO_PROTOCOL_GUID;\r
1246STATIC CONST EFI_GUID WinNtSerialPortGuid = LOCAL_EFI_WIN_NT_SERIAL_PORT_GUID;\r
1247\r
2c23ddaa 1248//\r
1249// Deprecated protocols we dont want to link from IntelFrameworkModulePkg\r
1250//\r
1251#define LOCAL_EFI_ISA_IO_PROTOCOL_GUID \\r
1252 { \\r
1253 0x7ee2bd44, 0x3da0, 0x11d4, { 0x9a, 0x38, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r
1a6f74d9 1254 }\r
2c23ddaa 1255#define LOCAL_EFI_ISA_ACPI_PROTOCOL_GUID \\r
1256 { \\r
1257 0x64a892dc, 0x5561, 0x4536, { 0x92, 0xc7, 0x79, 0x9b, 0xfc, 0x18, 0x33, 0x55 } \\r
1258 }\r
1259STATIC CONST EFI_GUID EfiIsaIoProtocolGuid = LOCAL_EFI_ISA_IO_PROTOCOL_GUID;\r
1260STATIC CONST EFI_GUID EfiIsaAcpiProtocolGuid = LOCAL_EFI_ISA_ACPI_PROTOCOL_GUID;\r
1261\r
1262\r
dee34318 1263STATIC CONST GUID_INFO_BLOCK mGuidStringListNT[] = {\r
a405b86d 1264 {STRING_TOKEN(STR_WINNT_THUNK), (EFI_GUID*)&WinNtThunkProtocolGuid, NULL},\r
1265 {STRING_TOKEN(STR_WINNT_DRIVER_IO), (EFI_GUID*)&WinNtIoProtocolGuid, NULL},\r
1266 {STRING_TOKEN(STR_WINNT_SERIAL_PORT), (EFI_GUID*)&WinNtSerialPortGuid, NULL},\r
1267 {STRING_TOKEN(STR_UNKNOWN_DEVICE), NULL, NULL},\r
1268};\r
1269\r
dee34318 1270STATIC CONST GUID_INFO_BLOCK mGuidStringList[] = {\r
efb76d1a 1271 {STRING_TOKEN(STR_LOADED_IMAGE), &gEfiLoadedImageProtocolGuid, LoadedImageProtocolDumpInformation},\r
a405b86d 1272 {STRING_TOKEN(STR_DEVICE_PATH), &gEfiDevicePathProtocolGuid, DevicePathProtocolDumpInformation},\r
1273 {STRING_TOKEN(STR_IMAGE_PATH), &gEfiLoadedImageDevicePathProtocolGuid, DevicePathProtocolDumpInformation},\r
1274 {STRING_TOKEN(STR_DEVICE_PATH_UTIL), &gEfiDevicePathUtilitiesProtocolGuid, NULL},\r
1275 {STRING_TOKEN(STR_DEVICE_PATH_TXT), &gEfiDevicePathToTextProtocolGuid, NULL},\r
1276 {STRING_TOKEN(STR_DEVICE_PATH_FTXT), &gEfiDevicePathFromTextProtocolGuid, NULL},\r
1277 {STRING_TOKEN(STR_DEVICE_PATH_PC), &gEfiPcAnsiGuid, NULL},\r
1278 {STRING_TOKEN(STR_DEVICE_PATH_VT100), &gEfiVT100Guid, NULL},\r
1279 {STRING_TOKEN(STR_DEVICE_PATH_VT100P), &gEfiVT100PlusGuid, NULL},\r
1280 {STRING_TOKEN(STR_DEVICE_PATH_VTUTF8), &gEfiVTUTF8Guid, NULL},\r
1281 {STRING_TOKEN(STR_DRIVER_BINDING), &gEfiDriverBindingProtocolGuid, NULL},\r
1282 {STRING_TOKEN(STR_PLATFORM_OVERRIDE), &gEfiPlatformDriverOverrideProtocolGuid, NULL},\r
1283 {STRING_TOKEN(STR_BUS_OVERRIDE), &gEfiBusSpecificDriverOverrideProtocolGuid, NULL},\r
1284 {STRING_TOKEN(STR_DRIVER_DIAG), &gEfiDriverDiagnosticsProtocolGuid, NULL},\r
1285 {STRING_TOKEN(STR_DRIVER_DIAG2), &gEfiDriverDiagnostics2ProtocolGuid, NULL},\r
1286 {STRING_TOKEN(STR_DRIVER_CN), &gEfiComponentNameProtocolGuid, NULL},\r
1287 {STRING_TOKEN(STR_DRIVER_CN2), &gEfiComponentName2ProtocolGuid, NULL},\r
1288 {STRING_TOKEN(STR_PLAT_DRV_CFG), &gEfiPlatformToDriverConfigurationProtocolGuid, NULL},\r
1289 {STRING_TOKEN(STR_DRIVER_VERSION), &gEfiDriverSupportedEfiVersionProtocolGuid, DriverEfiVersionProtocolDumpInformation},\r
1290 {STRING_TOKEN(STR_TXT_IN), &gEfiSimpleTextInProtocolGuid, NULL},\r
1291 {STRING_TOKEN(STR_TXT_IN_EX), &gEfiSimpleTextInputExProtocolGuid, NULL},\r
1292 {STRING_TOKEN(STR_TXT_OUT), &gEfiSimpleTextOutProtocolGuid, TxtOutProtocolDumpInformation},\r
1293 {STRING_TOKEN(STR_SIM_POINTER), &gEfiSimplePointerProtocolGuid, NULL},\r
1294 {STRING_TOKEN(STR_ABS_POINTER), &gEfiAbsolutePointerProtocolGuid, NULL},\r
1295 {STRING_TOKEN(STR_SERIAL_IO), &gEfiSerialIoProtocolGuid, NULL},\r
609e0c58 1296 {STRING_TOKEN(STR_GRAPHICS_OUTPUT), &gEfiGraphicsOutputProtocolGuid, GraphicsOutputProtocolDumpInformation},\r
a405b86d 1297 {STRING_TOKEN(STR_EDID_DISCOVERED), &gEfiEdidDiscoveredProtocolGuid, NULL},\r
1298 {STRING_TOKEN(STR_EDID_ACTIVE), &gEfiEdidActiveProtocolGuid, NULL},\r
1299 {STRING_TOKEN(STR_EDID_OVERRIDE), &gEfiEdidOverrideProtocolGuid, NULL},\r
1300 {STRING_TOKEN(STR_CON_IN), &gEfiConsoleInDeviceGuid, NULL},\r
1301 {STRING_TOKEN(STR_CON_OUT), &gEfiConsoleOutDeviceGuid, NULL},\r
1302 {STRING_TOKEN(STR_STD_ERR), &gEfiStandardErrorDeviceGuid, NULL},\r
1303 {STRING_TOKEN(STR_LOAD_FILE), &gEfiLoadFileProtocolGuid, NULL},\r
1304 {STRING_TOKEN(STR_LOAD_FILE2), &gEfiLoadFile2ProtocolGuid, NULL},\r
1305 {STRING_TOKEN(STR_SIMPLE_FILE_SYS), &gEfiSimpleFileSystemProtocolGuid, NULL},\r
a405b86d 1306 {STRING_TOKEN(STR_TAPE_IO), &gEfiTapeIoProtocolGuid, NULL},\r
1307 {STRING_TOKEN(STR_DISK_IO), &gEfiDiskIoProtocolGuid, NULL},\r
1308 {STRING_TOKEN(STR_BLK_IO), &gEfiBlockIoProtocolGuid, NULL},\r
1309 {STRING_TOKEN(STR_UC), &gEfiUnicodeCollationProtocolGuid, NULL},\r
1310 {STRING_TOKEN(STR_UC2), &gEfiUnicodeCollation2ProtocolGuid, NULL},\r
f4f3c6bf 1311 {STRING_TOKEN(STR_PCIRB_IO), &gEfiPciRootBridgeIoProtocolGuid, PciRootBridgeIoDumpInformation},\r
a405b86d 1312 {STRING_TOKEN(STR_PCI_IO), &gEfiPciIoProtocolGuid, NULL},\r
1313 {STRING_TOKEN(STR_SCSI_PT), &gEfiScsiPassThruProtocolGuid, NULL},\r
1314 {STRING_TOKEN(STR_SCSI_IO), &gEfiScsiIoProtocolGuid, NULL},\r
1315 {STRING_TOKEN(STR_SCSI_PT_EXT), &gEfiExtScsiPassThruProtocolGuid, NULL},\r
1316 {STRING_TOKEN(STR_ISCSI), &gEfiIScsiInitiatorNameProtocolGuid, NULL},\r
1317 {STRING_TOKEN(STR_USB_IO), &gEfiUsbIoProtocolGuid, NULL},\r
1318 {STRING_TOKEN(STR_USB_HC), &gEfiUsbHcProtocolGuid, NULL},\r
1319 {STRING_TOKEN(STR_USB_HC2), &gEfiUsb2HcProtocolGuid, NULL},\r
1320 {STRING_TOKEN(STR_DEBUG_SUPPORT), &gEfiDebugSupportProtocolGuid, NULL},\r
1321 {STRING_TOKEN(STR_DEBUG_PORT), &gEfiDebugPortProtocolGuid, NULL},\r
1322 {STRING_TOKEN(STR_DECOMPRESS), &gEfiDecompressProtocolGuid, NULL},\r
1323 {STRING_TOKEN(STR_ACPI_TABLE), &gEfiAcpiTableProtocolGuid, NULL},\r
1324 {STRING_TOKEN(STR_EBC_INTERPRETER), &gEfiEbcProtocolGuid, NULL},\r
1325 {STRING_TOKEN(STR_SNP), &gEfiSimpleNetworkProtocolGuid, NULL},\r
1326 {STRING_TOKEN(STR_NII), &gEfiNetworkInterfaceIdentifierProtocolGuid, NULL},\r
1327 {STRING_TOKEN(STR_NII_31), &gEfiNetworkInterfaceIdentifierProtocolGuid_31, NULL},\r
1328 {STRING_TOKEN(STR_PXE_BC), &gEfiPxeBaseCodeProtocolGuid, NULL},\r
1329 {STRING_TOKEN(STR_PXE_CB), &gEfiPxeBaseCodeCallbackProtocolGuid, NULL},\r
1330 {STRING_TOKEN(STR_BIS), &gEfiBisProtocolGuid, NULL},\r
1331 {STRING_TOKEN(STR_MNP_SB), &gEfiManagedNetworkServiceBindingProtocolGuid, NULL},\r
1332 {STRING_TOKEN(STR_MNP), &gEfiManagedNetworkProtocolGuid, NULL},\r
1333 {STRING_TOKEN(STR_ARP_SB), &gEfiArpServiceBindingProtocolGuid, NULL},\r
1334 {STRING_TOKEN(STR_ARP), &gEfiArpProtocolGuid, NULL},\r
1335 {STRING_TOKEN(STR_DHCPV4_SB), &gEfiDhcp4ServiceBindingProtocolGuid, NULL},\r
1336 {STRING_TOKEN(STR_DHCPV4), &gEfiDhcp4ProtocolGuid, NULL},\r
1337 {STRING_TOKEN(STR_TCPV4_SB), &gEfiTcp4ServiceBindingProtocolGuid, NULL},\r
1338 {STRING_TOKEN(STR_TCPV4), &gEfiTcp4ProtocolGuid, NULL},\r
1339 {STRING_TOKEN(STR_IPV4_SB), &gEfiIp4ServiceBindingProtocolGuid, NULL},\r
1340 {STRING_TOKEN(STR_IPV4), &gEfiIp4ProtocolGuid, NULL},\r
1341 {STRING_TOKEN(STR_IPV4_CFG), &gEfiIp4ConfigProtocolGuid, NULL},\r
00a6ad1b 1342 {STRING_TOKEN(STR_IPV4_CFG2), &gEfiIp4Config2ProtocolGuid, NULL},\r
a405b86d 1343 {STRING_TOKEN(STR_UDPV4_SB), &gEfiUdp4ServiceBindingProtocolGuid, NULL},\r
1344 {STRING_TOKEN(STR_UDPV4), &gEfiUdp4ProtocolGuid, NULL},\r
1345 {STRING_TOKEN(STR_MTFTPV4_SB), &gEfiMtftp4ServiceBindingProtocolGuid, NULL},\r
1346 {STRING_TOKEN(STR_MTFTPV4), &gEfiMtftp4ProtocolGuid, NULL},\r
1347 {STRING_TOKEN(STR_AUTH_INFO), &gEfiAuthenticationInfoProtocolGuid, NULL},\r
1348 {STRING_TOKEN(STR_HASH_SB), &gEfiHashServiceBindingProtocolGuid, NULL},\r
1349 {STRING_TOKEN(STR_HASH), &gEfiHashProtocolGuid, NULL},\r
1350 {STRING_TOKEN(STR_HII_FONT), &gEfiHiiFontProtocolGuid, NULL},\r
1351 {STRING_TOKEN(STR_HII_STRING), &gEfiHiiStringProtocolGuid, NULL},\r
1352 {STRING_TOKEN(STR_HII_IMAGE), &gEfiHiiImageProtocolGuid, NULL},\r
1353 {STRING_TOKEN(STR_HII_DATABASE), &gEfiHiiDatabaseProtocolGuid, NULL},\r
1354 {STRING_TOKEN(STR_HII_CONFIG_ROUT), &gEfiHiiConfigRoutingProtocolGuid, NULL},\r
1355 {STRING_TOKEN(STR_HII_CONFIG_ACC), &gEfiHiiConfigAccessProtocolGuid, NULL},\r
1356 {STRING_TOKEN(STR_HII_FORM_BROWSER2), &gEfiFormBrowser2ProtocolGuid, NULL},\r
dee34318 1357 {STRING_TOKEN(STR_DRIVER_FAM_OVERRIDE), &gEfiDriverFamilyOverrideProtocolGuid, NULL},\r
1358 {STRING_TOKEN(STR_PCD), &gPcdProtocolGuid, NULL},\r
1359 {STRING_TOKEN(STR_TCG), &gEfiTcgProtocolGuid, NULL},\r
1360 {STRING_TOKEN(STR_HII_PACKAGE_LIST), &gEfiHiiPackageListProtocolGuid, NULL},\r
1361\r
1362//\r
1363// the ones under this are deprecated by the current UEFI Spec, but may be found anyways...\r
1364//\r
a405b86d 1365 {STRING_TOKEN(STR_SHELL_INTERFACE), &gEfiShellInterfaceGuid, NULL},\r
1366 {STRING_TOKEN(STR_SHELL_ENV2), &gEfiShellEnvironment2Guid, NULL},\r
1367 {STRING_TOKEN(STR_SHELL_ENV), &gEfiShellEnvironment2Guid, NULL},\r
1368 {STRING_TOKEN(STR_DEVICE_IO), &gEfiDeviceIoProtocolGuid, NULL},\r
1369 {STRING_TOKEN(STR_UGA_DRAW), &gEfiUgaDrawProtocolGuid, NULL},\r
1370 {STRING_TOKEN(STR_UGA_IO), &gEfiUgaIoProtocolGuid, NULL},\r
1371 {STRING_TOKEN(STR_ESP), &gEfiPartTypeSystemPartGuid, NULL},\r
1372 {STRING_TOKEN(STR_GPT_NBR), &gEfiPartTypeLegacyMbrGuid, NULL},\r
1373 {STRING_TOKEN(STR_DRIVER_CONFIG), &gEfiDriverConfigurationProtocolGuid, NULL},\r
1374 {STRING_TOKEN(STR_DRIVER_CONFIG2), &gEfiDriverConfiguration2ProtocolGuid, NULL},\r
2c23ddaa 1375\r
1376//\r
1377// these are using local (non-global) definitions to reduce package dependancy.\r
1378//\r
1379 {STRING_TOKEN(STR_ISA_IO), (EFI_GUID*)&EfiIsaIoProtocolGuid, NULL},\r
1380 {STRING_TOKEN(STR_ISA_ACPI), (EFI_GUID*)&EfiIsaAcpiProtocolGuid, NULL},\r
dee34318 1381\r
1382//\r
1383// the ones under this are GUID identified structs, not protocols\r
1384//\r
1385 {STRING_TOKEN(STR_FILE_INFO), &gEfiFileInfoGuid, NULL},\r
1386 {STRING_TOKEN(STR_FILE_SYS_INFO), &gEfiFileSystemInfoGuid, NULL},\r
1387\r
1388//\r
1389// the ones under this are misc GUIDS.\r
1390//\r
1391 {STRING_TOKEN(STR_EFI_GLOBAL_VARIABLE), &gEfiGlobalVariableGuid, NULL},\r
1392\r
1393//\r
1394// UEFI 2.2\r
1395//\r
1396 {STRING_TOKEN(STR_IP6_SB), &gEfiIp6ServiceBindingProtocolGuid, NULL},\r
1397 {STRING_TOKEN(STR_IP6), &gEfiIp6ProtocolGuid, NULL},\r
1398 {STRING_TOKEN(STR_IP6_CONFIG), &gEfiIp6ConfigProtocolGuid, NULL},\r
1399 {STRING_TOKEN(STR_MTFTP6_SB), &gEfiMtftp6ServiceBindingProtocolGuid, NULL},\r
1400 {STRING_TOKEN(STR_MTFTP6), &gEfiMtftp6ProtocolGuid, NULL},\r
1401 {STRING_TOKEN(STR_DHCP6_SB), &gEfiDhcp6ServiceBindingProtocolGuid, NULL},\r
1402 {STRING_TOKEN(STR_DHCP6), &gEfiDhcp6ProtocolGuid, NULL},\r
1403 {STRING_TOKEN(STR_UDP6_SB), &gEfiUdp6ServiceBindingProtocolGuid, NULL},\r
1404 {STRING_TOKEN(STR_UDP6), &gEfiUdp6ProtocolGuid, NULL},\r
1405 {STRING_TOKEN(STR_TCP6_SB), &gEfiTcp6ServiceBindingProtocolGuid, NULL},\r
1406 {STRING_TOKEN(STR_TCP6), &gEfiTcp6ProtocolGuid, NULL},\r
1407 {STRING_TOKEN(STR_VLAN_CONFIG), &gEfiVlanConfigProtocolGuid, NULL},\r
1408 {STRING_TOKEN(STR_EAP), &gEfiEapProtocolGuid, NULL},\r
1409 {STRING_TOKEN(STR_EAP_MGMT), &gEfiEapManagementProtocolGuid, NULL},\r
1410 {STRING_TOKEN(STR_FTP4_SB), &gEfiFtp4ServiceBindingProtocolGuid, NULL},\r
1411 {STRING_TOKEN(STR_FTP4), &gEfiFtp4ProtocolGuid, NULL},\r
1412 {STRING_TOKEN(STR_IP_SEC_CONFIG), &gEfiIpSecConfigProtocolGuid, NULL},\r
1413 {STRING_TOKEN(STR_DH), &gEfiDriverHealthProtocolGuid, NULL},\r
1414 {STRING_TOKEN(STR_DEF_IMG_LOAD), &gEfiDeferredImageLoadProtocolGuid, NULL},\r
1415 {STRING_TOKEN(STR_USER_CRED), &gEfiUserCredentialProtocolGuid, NULL},\r
1416 {STRING_TOKEN(STR_USER_MNGR), &gEfiUserManagerProtocolGuid, NULL},\r
1417 {STRING_TOKEN(STR_ATA_PASS_THRU), &gEfiAtaPassThruProtocolGuid, NULL},\r
1418\r
1419//\r
1420// UEFI 2.3\r
1421//\r
8985d612 1422 {STRING_TOKEN(STR_FW_MGMT), &gEfiFirmwareManagementProtocolGuid, FirmwareManagementDumpInformation},\r
dee34318 1423 {STRING_TOKEN(STR_IP_SEC), &gEfiIpSecProtocolGuid, NULL},\r
1424 {STRING_TOKEN(STR_IP_SEC2), &gEfiIpSec2ProtocolGuid, NULL},\r
1425\r
1426//\r
1427// UEFI 2.3.1\r
1428//\r
1429 {STRING_TOKEN(STR_KMS), &gEfiKmsProtocolGuid, NULL},\r
1430 {STRING_TOKEN(STR_BLK_IO2), &gEfiBlockIo2ProtocolGuid, NULL},\r
1431 {STRING_TOKEN(STR_SSC), &gEfiStorageSecurityCommandProtocolGuid, NULL},\r
12f1a36c 1432 {STRING_TOKEN(STR_UCRED2), &gEfiUserCredential2ProtocolGuid, NULL},\r
dee34318 1433\r
28cdb62b
CP
1434//\r
1435// UEFI 2.4\r
1436//\r
1437 {STRING_TOKEN(STR_DISK_IO2), &gEfiDiskIo2ProtocolGuid, NULL},\r
59febea1 1438 {STRING_TOKEN(STR_ADAPTER_INFO), &gEfiAdapterInformationProtocolGuid, AdapterInformationDumpInformation},\r
28cdb62b 1439\r
6b640b4a
JC
1440//\r
1441// PI Spec ones\r
1442//\r
1443 {STRING_TOKEN(STR_IDE_CONT_INIT), &gEfiIdeControllerInitProtocolGuid, NULL},\r
4024c116 1444 {STRING_TOKEN(STR_DISK_INFO), &gEfiDiskInfoProtocolGuid, NULL},\r
6b640b4a 1445\r
c2788f1c
JC
1446//\r
1447// PI Spec 1.0\r
1448//\r
1449 {STRING_TOKEN(STR_BDS_ARCH), &gEfiBdsArchProtocolGuid, NULL},\r
1450 {STRING_TOKEN(STR_CPU_ARCH), &gEfiCpuArchProtocolGuid, NULL},\r
1451 {STRING_TOKEN(STR_MET_ARCH), &gEfiMetronomeArchProtocolGuid, NULL},\r
1452 {STRING_TOKEN(STR_MON_ARCH), &gEfiMonotonicCounterArchProtocolGuid, NULL},\r
1453 {STRING_TOKEN(STR_RTC_ARCH), &gEfiRealTimeClockArchProtocolGuid, NULL},\r
1454 {STRING_TOKEN(STR_RESET_ARCH), &gEfiResetArchProtocolGuid, NULL},\r
1455 {STRING_TOKEN(STR_RT_ARCH), &gEfiRuntimeArchProtocolGuid, NULL},\r
1456 {STRING_TOKEN(STR_SEC_ARCH), &gEfiSecurityArchProtocolGuid, NULL},\r
1457 {STRING_TOKEN(STR_TIMER_ARCH), &gEfiTimerArchProtocolGuid, NULL},\r
1458 {STRING_TOKEN(STR_VAR_ARCH), &gEfiVariableWriteArchProtocolGuid, NULL},\r
1459 {STRING_TOKEN(STR_V_ARCH), &gEfiVariableArchProtocolGuid, NULL},\r
1460 {STRING_TOKEN(STR_SECP), &gEfiSecurityPolicyProtocolGuid, NULL},\r
1461 {STRING_TOKEN(STR_WDT_ARCH), &gEfiWatchdogTimerArchProtocolGuid, NULL},\r
1462 {STRING_TOKEN(STR_SCR), &gEfiStatusCodeRuntimeProtocolGuid, NULL},\r
1463 {STRING_TOKEN(STR_SMB_HC), &gEfiSmbusHcProtocolGuid, NULL},\r
1464 {STRING_TOKEN(STR_FV_2), &gEfiFirmwareVolume2ProtocolGuid, NULL},\r
1465 {STRING_TOKEN(STR_FV_BLOCK), &gEfiFirmwareVolumeBlockProtocolGuid, NULL},\r
1466 {STRING_TOKEN(STR_CAP_ARCH), &gEfiCapsuleArchProtocolGuid, NULL},\r
1467 {STRING_TOKEN(STR_MP_SERVICE), &gEfiMpServiceProtocolGuid, NULL},\r
1468 {STRING_TOKEN(STR_HBRAP), &gEfiPciHostBridgeResourceAllocationProtocolGuid, NULL},\r
1469 {STRING_TOKEN(STR_PCIP), &gEfiPciPlatformProtocolGuid, NULL},\r
1470 {STRING_TOKEN(STR_PCIO), &gEfiPciOverrideProtocolGuid, NULL},\r
1471 {STRING_TOKEN(STR_PCIE), &gEfiPciEnumerationCompleteProtocolGuid, NULL},\r
1472 {STRING_TOKEN(STR_IPCID), &gEfiIncompatiblePciDeviceSupportProtocolGuid, NULL},\r
1473 {STRING_TOKEN(STR_PCIHPI), &gEfiPciHotPlugInitProtocolGuid, NULL},\r
1474 {STRING_TOKEN(STR_PCIHPR), &gEfiPciHotPlugRequestProtocolGuid, NULL},\r
1475 {STRING_TOKEN(STR_SMBIOS), &gEfiSmbiosProtocolGuid, NULL},\r
1476 {STRING_TOKEN(STR_S3_SAVE), &gEfiS3SaveStateProtocolGuid, NULL},\r
1477 {STRING_TOKEN(STR_S3_S_SMM), &gEfiS3SmmSaveStateProtocolGuid, NULL},\r
1478 {STRING_TOKEN(STR_RSC), &gEfiRscHandlerProtocolGuid, NULL},\r
1479 {STRING_TOKEN(STR_S_RSC), &gEfiSmmRscHandlerProtocolGuid, NULL},\r
1480 {STRING_TOKEN(STR_ACPI_SDT), &gEfiAcpiSdtProtocolGuid, NULL},\r
1481 {STRING_TOKEN(STR_SIO), &gEfiSioProtocolGuid, NULL},\r
1482 {STRING_TOKEN(STR_S_CPU2), &gEfiSmmCpuIo2ProtocolGuid, NULL},\r
1483 {STRING_TOKEN(STR_S_BASE2), &gEfiSmmBase2ProtocolGuid, NULL},\r
1484 {STRING_TOKEN(STR_S_ACC_2), &gEfiSmmAccess2ProtocolGuid, NULL},\r
1485 {STRING_TOKEN(STR_S_CON_2), &gEfiSmmControl2ProtocolGuid, NULL},\r
1486 {STRING_TOKEN(STR_S_CONFIG), &gEfiSmmConfigurationProtocolGuid, NULL},\r
1487 {STRING_TOKEN(STR_S_RTL), &gEfiSmmReadyToLockProtocolGuid, NULL},\r
1488 {STRING_TOKEN(STR_DS_RTL), &gEfiDxeSmmReadyToLockProtocolGuid, NULL},\r
1489 {STRING_TOKEN(STR_S_COMM), &gEfiSmmCommunicationProtocolGuid, NULL},\r
1490 {STRING_TOKEN(STR_S_STAT), &gEfiSmmStatusCodeProtocolGuid, NULL},\r
1491 {STRING_TOKEN(STR_S_CPU), &gEfiSmmCpuProtocolGuid, NULL},\r
1492 {STRING_TOKEN(STR_S_PCIRBIO), &gEfiPciRootBridgeIoProtocolGuid, NULL},\r
1493 {STRING_TOKEN(STR_S_SWD), &gEfiSmmSwDispatch2ProtocolGuid, NULL},\r
1494 {STRING_TOKEN(STR_S_SXD), &gEfiSmmSxDispatch2ProtocolGuid, NULL},\r
1495 {STRING_TOKEN(STR_S_PTD2), &gEfiSmmPeriodicTimerDispatch2ProtocolGuid, NULL},\r
1496 {STRING_TOKEN(STR_S_UD2), &gEfiSmmUsbDispatch2ProtocolGuid, NULL},\r
1497 {STRING_TOKEN(STR_S_GD2), &gEfiSmmGpiDispatch2ProtocolGuid, NULL},\r
1498 {STRING_TOKEN(STR_S_SBD2), &gEfiSmmStandbyButtonDispatch2ProtocolGuid, NULL},\r
1499 {STRING_TOKEN(STR_S_PBD2), &gEfiSmmPowerButtonDispatch2ProtocolGuid, NULL},\r
1500 {STRING_TOKEN(STR_S_ITD2), &gEfiSmmIoTrapDispatch2ProtocolGuid, NULL},\r
1501 {STRING_TOKEN(STR_PCD), &gEfiPcdProtocolGuid, NULL},\r
1502 {STRING_TOKEN(STR_FVB2), &gEfiFirmwareVolumeBlock2ProtocolGuid, NULL},\r
1503 {STRING_TOKEN(STR_CPUIO2), &gEfiCpuIo2ProtocolGuid, NULL},\r
1504 {STRING_TOKEN(STR_LEGACY_R2), &gEfiLegacyRegion2ProtocolGuid, NULL},\r
1505 {STRING_TOKEN(STR_SAL_MIP), &gEfiSalMcaInitPmiProtocolGuid, NULL},\r
1506 {STRING_TOKEN(STR_ES_BS), &gEfiExtendedSalBootServiceProtocolGuid, NULL},\r
1507 {STRING_TOKEN(STR_ES_BIO), &gEfiExtendedSalBaseIoServicesProtocolGuid, NULL},\r
1508 {STRING_TOKEN(STR_ES_STALL), &gEfiExtendedSalStallServicesProtocolGuid, NULL},\r
1509 {STRING_TOKEN(STR_ES_RTC), &gEfiExtendedSalRtcServicesProtocolGuid, NULL},\r
1510 {STRING_TOKEN(STR_ES_VS), &gEfiExtendedSalVariableServicesProtocolGuid, NULL},\r
1511 {STRING_TOKEN(STR_ES_MTC), &gEfiExtendedSalMtcServicesProtocolGuid, NULL},\r
1512 {STRING_TOKEN(STR_ES_RESET), &gEfiExtendedSalResetServicesProtocolGuid, NULL},\r
1513 {STRING_TOKEN(STR_ES_SC), &gEfiExtendedSalStatusCodeServicesProtocolGuid, NULL},\r
1514 {STRING_TOKEN(STR_ES_FBS), &gEfiExtendedSalFvBlockServicesProtocolGuid, NULL},\r
1515 {STRING_TOKEN(STR_ES_MP), &gEfiExtendedSalMpServicesProtocolGuid, NULL},\r
1516 {STRING_TOKEN(STR_ES_PAL), &gEfiExtendedSalPalServicesProtocolGuid, NULL},\r
1517 {STRING_TOKEN(STR_ES_BASE), &gEfiExtendedSalBaseServicesProtocolGuid, NULL},\r
1518 {STRING_TOKEN(STR_ES_MCA), &gEfiExtendedSalMcaServicesProtocolGuid, NULL},\r
1519 {STRING_TOKEN(STR_ES_PCI), &gEfiExtendedSalPciServicesProtocolGuid, NULL},\r
1520 {STRING_TOKEN(STR_ES_CACHE), &gEfiExtendedSalCacheServicesProtocolGuid, NULL},\r
1521 {STRING_TOKEN(STR_ES_MCA_LOG), &gEfiExtendedSalMcaLogServicesProtocolGuid, NULL},\r
1522 {STRING_TOKEN(STR_S2ARCH), &gEfiSecurity2ArchProtocolGuid, NULL},\r
1523 {STRING_TOKEN(STR_EODXE), &gEfiSmmEndOfDxeProtocolGuid, NULL},\r
1524 {STRING_TOKEN(STR_ISAHC), &gEfiIsaHcProtocolGuid, NULL},\r
1525 {STRING_TOKEN(STR_ISAHC_B), &gEfiIsaHcServiceBindingProtocolGuid, NULL},\r
1526 {STRING_TOKEN(STR_SIO_C), &gEfiSioControlProtocolGuid, NULL},\r
1527 {STRING_TOKEN(STR_GET_PCD), &gEfiGetPcdInfoProtocolGuid, NULL},\r
1528 {STRING_TOKEN(STR_I2C_M), &gEfiI2cMasterProtocolGuid, NULL},\r
1529 {STRING_TOKEN(STR_I2CIO), &gEfiI2cIoProtocolGuid, NULL},\r
1530 {STRING_TOKEN(STR_I2CEN), &gEfiI2cEnumerateProtocolGuid, NULL},\r
1531 {STRING_TOKEN(STR_I2C_H), &gEfiI2cHostProtocolGuid, NULL},\r
1532 {STRING_TOKEN(STR_I2C_BCM), &gEfiI2cBusConfigurationManagementProtocolGuid, NULL},\r
1533 {STRING_TOKEN(STR_TREE), &gEfiTrEEProtocolGuid, NULL},\r
1534 {STRING_TOKEN(STR_TCG2), &gEfiTcg2ProtocolGuid, NULL},\r
1535 {STRING_TOKEN(STR_TIMESTAMP), &gEfiTimestampProtocolGuid, NULL},\r
1536 {STRING_TOKEN(STR_RNG), &gEfiRngProtocolGuid, NULL},\r
1537 {STRING_TOKEN(STR_NVMEPT), &gEfiNvmExpressPassThruProtocolGuid, NULL},\r
1538 {STRING_TOKEN(STR_H2_SB), &gEfiHash2ServiceBindingProtocolGuid, NULL},\r
1539 {STRING_TOKEN(STR_HASH2), &gEfiHash2ProtocolGuid, NULL},\r
1540 {STRING_TOKEN(STR_BIO_C), &gEfiBlockIoCryptoProtocolGuid, NULL},\r
1541 {STRING_TOKEN(STR_SCR), &gEfiSmartCardReaderProtocolGuid, NULL},\r
1542 {STRING_TOKEN(STR_SCE), &gEfiSmartCardEdgeProtocolGuid, NULL},\r
1543 {STRING_TOKEN(STR_USB_FIO), &gEfiUsbFunctionIoProtocolGuid, NULL},\r
1544 {STRING_TOKEN(STR_BC_HC), &gEfiBluetoothHcProtocolGuid, NULL},\r
1545 {STRING_TOKEN(STR_BC_IO_SB), &gEfiBluetoothIoServiceBindingProtocolGuid, NULL},\r
1546 {STRING_TOKEN(STR_BC_IO), &gEfiBluetoothIoProtocolGuid, NULL},\r
1547 {STRING_TOKEN(STR_BC_C), &gEfiBluetoothConfigProtocolGuid, NULL},\r
1548 {STRING_TOKEN(STR_REG_EXP), &gEfiRegularExpressionProtocolGuid, NULL},\r
1549 {STRING_TOKEN(STR_B_MGR_P), &gEfiBootManagerPolicyProtocolGuid, NULL},\r
1550 {STRING_TOKEN(STR_CKH), &gEfiConfigKeywordHandlerProtocolGuid, NULL},\r
1551 {STRING_TOKEN(STR_WIFI), &gEfiWiFiProtocolGuid, NULL},\r
1552 {STRING_TOKEN(STR_EAP_M), &gEfiEapManagement2ProtocolGuid, NULL},\r
1553 {STRING_TOKEN(STR_EAP_C), &gEfiEapConfigurationProtocolGuid, NULL},\r
1554 {STRING_TOKEN(STR_PKCS7), &gEfiPkcs7VerifyProtocolGuid, NULL},\r
1555 {STRING_TOKEN(STR_NET_DNS4_SB), &gEfiDns4ServiceBindingProtocolGuid, NULL},\r
1556 {STRING_TOKEN(STR_NET_DNS4), &gEfiDns4ProtocolGuid, NULL},\r
1557 {STRING_TOKEN(STR_NET_DNS6_SB), &gEfiDns6ServiceBindingProtocolGuid, NULL},\r
1558 {STRING_TOKEN(STR_NET_DNS6), &gEfiDns6ProtocolGuid, NULL},\r
1559 {STRING_TOKEN(STR_NET_HTTP_SB), &gEfiHttpServiceBindingProtocolGuid, NULL},\r
1560 {STRING_TOKEN(STR_NET_HTTP), &gEfiHttpProtocolGuid, NULL},\r
1561 {STRING_TOKEN(STR_NET_HTTP_U), &gEfiHttpUtilitiesProtocolGuid, NULL},\r
1562 {STRING_TOKEN(STR_REST), &gEfiRestProtocolGuid, NULL},\r
1563\r
0a1eb97d
JC
1564//\r
1565// UEFI Shell Spec 2.0\r
1566//\r
1567 {STRING_TOKEN(STR_SHELL_PARAMETERS), &gEfiShellParametersProtocolGuid, NULL},\r
1568 {STRING_TOKEN(STR_SHELL), &gEfiShellProtocolGuid, NULL},\r
1569\r
1570//\r
1571// UEFI Shell Spec 2.1\r
1572//\r
1573 {STRING_TOKEN(STR_SHELL_DYNAMIC), &gEfiShellDynamicCommandProtocolGuid, NULL},\r
1574\r
c2788f1c
JC
1575//\r
1576// Misc\r
1577//\r
1578 {STRING_TOKEN(STR_PCDINFOPROT), &gGetPcdInfoProtocolGuid, NULL},\r
1579\r
dee34318 1580//\r
1581// terminator\r
1582//\r
a405b86d 1583 {STRING_TOKEN(STR_UNKNOWN_DEVICE), NULL, NULL},\r
1584};\r
1585\r
1586/**\r
1587 Function to get the node for a protocol or struct from it's GUID.\r
1588\r
1589 if Guid is NULL, then ASSERT.\r
1590\r
1591 @param[in] Guid The GUID to look for the name of.\r
1592\r
1593 @return The node.\r
1594**/\r
dee34318 1595CONST GUID_INFO_BLOCK *\r
a405b86d 1596EFIAPI\r
1597InternalShellGetNodeFromGuid(\r
1598 IN CONST EFI_GUID* Guid\r
1599 )\r
1600{\r
dee34318 1601 CONST GUID_INFO_BLOCK *ListWalker;\r
6306fd90 1602 UINTN LoopCount;\r
a405b86d 1603\r
1604 ASSERT(Guid != NULL);\r
1605\r
6306fd90
JC
1606 for (LoopCount = 0, ListWalker = GuidList; GuidList != NULL && LoopCount < GuidListCount; LoopCount++, ListWalker++) {\r
1607 if (CompareGuid(ListWalker->GuidId, Guid)) {\r
1608 return (ListWalker);\r
1609 }\r
1610 }\r
1611\r
a405b86d 1612 if (PcdGetBool(PcdShellIncludeNtGuids)) {\r
1613 for (ListWalker = mGuidStringListNT ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {\r
1614 if (CompareGuid(ListWalker->GuidId, Guid)) {\r
1615 return (ListWalker);\r
1616 }\r
1617 }\r
1618 }\r
1619 for (ListWalker = mGuidStringList ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {\r
1620 if (CompareGuid(ListWalker->GuidId, Guid)) {\r
1621 return (ListWalker);\r
1622 }\r
1623 }\r
6306fd90
JC
1624 return (NULL);\r
1625}\r
1626\r
1627/**\r
1628Function to add a new GUID/Name mapping.\r
1629\r
1630@param[in] Guid The Guid\r
f5ba4007
QS
1631@param[in] NameID The STRING id of the HII string to use\r
1632@param[in] DumpFunc The pointer to the dump function\r
6306fd90
JC
1633\r
1634\r
1635@retval EFI_SUCCESS The operation was sucessful\r
1636@retval EFI_OUT_OF_RESOURCES A memory allocation failed\r
1637@retval EFI_INVALID_PARAMETER Guid NameId was invalid\r
1638**/\r
6306fd90
JC
1639EFI_STATUS\r
1640EFIAPI\r
1641InsertNewGuidNameMapping(\r
1642 IN CONST EFI_GUID *Guid,\r
1643 IN CONST EFI_STRING_ID NameID,\r
1644 IN CONST DUMP_PROTOCOL_INFO DumpFunc OPTIONAL\r
1645 )\r
1646{\r
1647 ASSERT(Guid != NULL);\r
1648 ASSERT(NameID != 0);\r
1649\r
1650 GuidList = ReallocatePool(GuidListCount * sizeof(GUID_INFO_BLOCK), GuidListCount+1 * sizeof(GUID_INFO_BLOCK), GuidList);\r
1651 if (GuidList == NULL) {\r
1652 GuidListCount = 0;\r
1653 return (EFI_OUT_OF_RESOURCES);\r
1654 }\r
1655 GuidListCount++;\r
1656\r
1657 GuidList[GuidListCount - 1].GuidId = AllocateCopyPool(sizeof(EFI_GUID), Guid);\r
1658 GuidList[GuidListCount - 1].StringId = NameID;\r
1659 GuidList[GuidListCount - 1].DumpInfo = DumpFunc;\r
1660\r
1661 if (GuidList[GuidListCount - 1].GuidId == NULL) {\r
1662 return (EFI_OUT_OF_RESOURCES);\r
1663 }\r
1664\r
1665 return (EFI_SUCCESS);\r
1666}\r
1667\r
1668/**\r
1669 Function to add a new GUID/Name mapping.\r
1670\r
1671 This cannot overwrite an existing mapping.\r
1672\r
1673 @param[in] Guid The Guid\r
1674 @param[in] TheName The Guid's name\r
1675 @param[in] Lang RFC4646 language code list or NULL\r
1676\r
1677 @retval EFI_SUCCESS The operation was sucessful\r
1678 @retval EFI_ACCESS_DENIED There was a duplicate\r
1679 @retval EFI_OUT_OF_RESOURCES A memory allocation failed\r
1680 @retval EFI_INVALID_PARAMETER Guid or TheName was NULL\r
1681**/\r
1682EFI_STATUS\r
1683EFIAPI\r
1684AddNewGuidNameMapping(\r
1685 IN CONST EFI_GUID *Guid,\r
1686 IN CONST CHAR16 *TheName,\r
1687 IN CONST CHAR8 *Lang OPTIONAL\r
1688 )\r
1689{\r
6306fd90
JC
1690 EFI_STRING_ID NameID;\r
1691\r
e7e0e42b
CP
1692 HandleParsingHiiInit();\r
1693\r
6306fd90
JC
1694 if (Guid == NULL || TheName == NULL){\r
1695 return (EFI_INVALID_PARAMETER);\r
1696 }\r
1697\r
931b2cff 1698 if ((InternalShellGetNodeFromGuid(Guid)) != NULL) {\r
6306fd90
JC
1699 return (EFI_ACCESS_DENIED);\r
1700 }\r
1701\r
1702 NameID = HiiSetString(mHandleParsingHiiHandle, 0, (CHAR16*)TheName, Lang);\r
1703 if (NameID == 0) {\r
1704 return (EFI_OUT_OF_RESOURCES);\r
1705 }\r
1706\r
1707 return (InsertNewGuidNameMapping(Guid, NameID, NULL));\r
a405b86d 1708}\r
1709\r
1710/**\r
1711 Function to get the name of a protocol or struct from it's GUID.\r
1712\r
1713 if Guid is NULL, then ASSERT.\r
1714\r
1715 @param[in] Guid The GUID to look for the name of.\r
1716 @param[in] Lang The language to use.\r
1717\r
1718 @return pointer to string of the name. The caller\r
1719 is responsible to free this memory.\r
1720**/\r
1721CHAR16*\r
1722EFIAPI\r
1723GetStringNameFromGuid(\r
1724 IN CONST EFI_GUID *Guid,\r
1725 IN CONST CHAR8 *Lang OPTIONAL\r
1726 )\r
1727{\r
dee34318 1728 CONST GUID_INFO_BLOCK *Id;\r
a405b86d 1729\r
e7e0e42b
CP
1730 HandleParsingHiiInit();\r
1731\r
a405b86d 1732 Id = InternalShellGetNodeFromGuid(Guid);\r
6306fd90 1733 return (HiiGetString(mHandleParsingHiiHandle, Id==NULL?STRING_TOKEN(STR_UNKNOWN_DEVICE):Id->StringId, Lang));\r
a405b86d 1734}\r
1735\r
1736/**\r
1737 Function to dump protocol information from a handle.\r
1738\r
1739 This function will return a allocated string buffer containing the\r
1740 information. The caller is responsible for freeing the memory.\r
1741\r
1742 If Guid is NULL, ASSERT().\r
1743 If TheHandle is NULL, ASSERT().\r
1744\r
1745 @param[in] TheHandle The handle to dump information from.\r
1746 @param[in] Guid The GUID of the protocol to dump.\r
1747 @param[in] Verbose TRUE for extra info. FALSE otherwise.\r
1748\r
1749 @return The pointer to string.\r
1750 @retval NULL An error was encountered.\r
1751**/\r
1752CHAR16*\r
1753EFIAPI\r
1754GetProtocolInformationDump(\r
1755 IN CONST EFI_HANDLE TheHandle,\r
1756 IN CONST EFI_GUID *Guid,\r
1757 IN CONST BOOLEAN Verbose\r
1758 )\r
1759{\r
dee34318 1760 CONST GUID_INFO_BLOCK *Id;\r
a405b86d 1761\r
1762 ASSERT(TheHandle != NULL);\r
1763 ASSERT(Guid != NULL);\r
1764\r
1765 if (TheHandle == NULL || Guid == NULL) {\r
1766 return (NULL);\r
1767 }\r
1768\r
1769 Id = InternalShellGetNodeFromGuid(Guid);\r
1770 if (Id != NULL && Id->DumpInfo != NULL) {\r
1771 return (Id->DumpInfo(TheHandle, Verbose));\r
1772 }\r
1773 return (NULL);\r
1774}\r
1775\r
1776/**\r
1777 Function to get the Guid for a protocol or struct based on it's string name.\r
1778\r
0a1eb97d
JC
1779 do not modify the returned Guid.\r
1780\r
a405b86d 1781 @param[in] Name The pointer to the string name.\r
1782 @param[in] Lang The pointer to the language code.\r
0a1eb97d 1783 @param[out] Guid The pointer to the Guid.\r
a405b86d 1784\r
1785 @retval EFI_SUCCESS The operation was sucessful.\r
1786**/\r
1787EFI_STATUS\r
1788EFIAPI\r
1789GetGuidFromStringName(\r
1790 IN CONST CHAR16 *Name,\r
1791 IN CONST CHAR8 *Lang OPTIONAL,\r
0a1eb97d 1792 OUT EFI_GUID **Guid\r
a405b86d 1793 )\r
1794{\r
dee34318 1795 CONST GUID_INFO_BLOCK *ListWalker;\r
a405b86d 1796 CHAR16 *String;\r
6306fd90 1797 UINTN LoopCount;\r
a405b86d 1798\r
e7e0e42b
CP
1799 HandleParsingHiiInit();\r
1800\r
a405b86d 1801 ASSERT(Guid != NULL);\r
1802 if (Guid == NULL) {\r
1803 return (EFI_INVALID_PARAMETER);\r
1804 }\r
1805 *Guid = NULL;\r
1806\r
1807 if (PcdGetBool(PcdShellIncludeNtGuids)) {\r
1808 for (ListWalker = mGuidStringListNT ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {\r
1809 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);\r
28cdb62b 1810 if (Name != NULL && String != NULL && StringNoCaseCompare (&Name, &String) == 0) {\r
a405b86d 1811 *Guid = ListWalker->GuidId;\r
1812 }\r
1813 SHELL_FREE_NON_NULL(String);\r
1814 if (*Guid != NULL) {\r
1815 return (EFI_SUCCESS);\r
1816 }\r
1817 }\r
1818 }\r
1819 for (ListWalker = mGuidStringList ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {\r
1820 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);\r
28cdb62b 1821 if (Name != NULL && String != NULL && StringNoCaseCompare (&Name, &String) == 0) {\r
a405b86d 1822 *Guid = ListWalker->GuidId;\r
1823 }\r
1824 SHELL_FREE_NON_NULL(String);\r
1825 if (*Guid != NULL) {\r
1826 return (EFI_SUCCESS);\r
1827 }\r
1828 }\r
6306fd90
JC
1829\r
1830 for (LoopCount = 0, ListWalker = GuidList; GuidList != NULL && LoopCount < GuidListCount; LoopCount++, ListWalker++) {\r
1831 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);\r
1832 if (Name != NULL && String != NULL && StringNoCaseCompare (&Name, &String) == 0) {\r
1833 *Guid = ListWalker->GuidId;\r
1834 }\r
1835 SHELL_FREE_NON_NULL(String);\r
1836 if (*Guid != NULL) {\r
1837 return (EFI_SUCCESS);\r
1838 }\r
1839 }\r
1840\r
a405b86d 1841 return (EFI_NOT_FOUND);\r
1842}\r
1843\r
36384ceb
ED
1844/**\r
1845 Get best support language for this driver.\r
1a6f74d9
CS
1846\r
1847 First base on the user input language to search, second base on the current\r
1848 platform used language to search, third get the first language from the\r
a71003f2 1849 support language list. The caller need to free the buffer of the best language.\r
36384ceb
ED
1850\r
1851 @param[in] SupportedLanguages The support languages for this driver.\r
a71003f2 1852 @param[in] InputLanguage The user input language.\r
36384ceb
ED
1853 @param[in] Iso639Language Whether get language for ISO639.\r
1854\r
1855 @return The best support language for this driver.\r
1856**/\r
1857CHAR8 *\r
a71003f2 1858EFIAPI\r
36384ceb 1859GetBestLanguageForDriver (\r
a71003f2
ED
1860 IN CONST CHAR8 *SupportedLanguages,\r
1861 IN CONST CHAR8 *InputLanguage,\r
36384ceb
ED
1862 IN BOOLEAN Iso639Language\r
1863 )\r
1864{\r
1865 CHAR8 *LanguageVariable;\r
1866 CHAR8 *BestLanguage;\r
1867\r
3cdd434e 1868 GetVariable2 (Iso639Language ? L"Lang" : L"PlatformLang", &gEfiGlobalVariableGuid, (VOID**)&LanguageVariable, NULL);\r
36384ceb
ED
1869\r
1870 BestLanguage = GetBestLanguage(\r
1871 SupportedLanguages,\r
1872 Iso639Language,\r
a71003f2 1873 (InputLanguage != NULL) ? InputLanguage : "",\r
36384ceb 1874 (LanguageVariable != NULL) ? LanguageVariable : "",\r
a71003f2 1875 SupportedLanguages,\r
36384ceb
ED
1876 NULL\r
1877 );\r
1878\r
1879 if (LanguageVariable != NULL) {\r
1880 FreePool (LanguageVariable);\r
1881 }\r
1882\r
1883 return BestLanguage;\r
1884}\r
1885\r
a405b86d 1886/**\r
1887 Function to retrieve the driver name (if possible) from the ComponentName or\r
1888 ComponentName2 protocol\r
1889\r
1890 @param[in] TheHandle The driver handle to get the name of.\r
1891 @param[in] Language The language to use.\r
1892\r
1893 @retval NULL The name could not be found.\r
1894 @return A pointer to the string name. Do not de-allocate the memory.\r
1895**/\r
1896CONST CHAR16*\r
1897EFIAPI\r
1898GetStringNameFromHandle(\r
1899 IN CONST EFI_HANDLE TheHandle,\r
1900 IN CONST CHAR8 *Language\r
1901 )\r
1902{\r
1903 EFI_COMPONENT_NAME2_PROTOCOL *CompNameStruct;\r
1904 EFI_STATUS Status;\r
1905 CHAR16 *RetVal;\r
36384ceb
ED
1906 CHAR8 *BestLang;\r
1907\r
1908 BestLang = NULL;\r
a405b86d 1909\r
1910 Status = gBS->OpenProtocol(\r
1911 TheHandle,\r
1912 &gEfiComponentName2ProtocolGuid,\r
1913 (VOID**)&CompNameStruct,\r
1914 gImageHandle,\r
1915 NULL,\r
1916 EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
1917 if (!EFI_ERROR(Status)) {\r
a71003f2
ED
1918 BestLang = GetBestLanguageForDriver (CompNameStruct->SupportedLanguages, Language, FALSE);\r
1919 Status = CompNameStruct->GetDriverName(CompNameStruct, BestLang, &RetVal);\r
36384ceb
ED
1920 if (BestLang != NULL) {\r
1921 FreePool (BestLang);\r
1922 BestLang = NULL;\r
1923 }\r
a405b86d 1924 if (!EFI_ERROR(Status)) {\r
1925 return (RetVal);\r
1926 }\r
1927 }\r
1928 Status = gBS->OpenProtocol(\r
1929 TheHandle,\r
1930 &gEfiComponentNameProtocolGuid,\r
1931 (VOID**)&CompNameStruct,\r
1932 gImageHandle,\r
1933 NULL,\r
1934 EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
1935 if (!EFI_ERROR(Status)) {\r
a71003f2
ED
1936 BestLang = GetBestLanguageForDriver (CompNameStruct->SupportedLanguages, Language, FALSE);\r
1937 Status = CompNameStruct->GetDriverName(CompNameStruct, BestLang, &RetVal);\r
36384ceb
ED
1938 if (BestLang != NULL) {\r
1939 FreePool (BestLang);\r
1940 }\r
a405b86d 1941 if (!EFI_ERROR(Status)) {\r
1942 return (RetVal);\r
1943 }\r
1944 }\r
1945 return (NULL);\r
1946}\r
1947\r
1948/**\r
1949 Function to initialize the file global mHandleList object for use in\r
1950 vonverting handles to index and index to handle.\r
1951\r
1952 @retval EFI_SUCCESS The operation was successful.\r
1953**/\r
1954EFI_STATUS\r
1955EFIAPI\r
1956InternalShellInitHandleList(\r
1957 VOID\r
1958 )\r
1959{\r
1960 EFI_STATUS Status;\r
1961 EFI_HANDLE *HandleBuffer;\r
1962 UINTN HandleCount;\r
1963 HANDLE_LIST *ListWalker;\r
1964\r
1965 if (mHandleList.NextIndex != 0) {\r
1966 return EFI_SUCCESS;\r
1967 }\r
1968 InitializeListHead(&mHandleList.List.Link);\r
1969 mHandleList.NextIndex = 1;\r
1970 Status = gBS->LocateHandleBuffer (\r
1971 AllHandles,\r
1972 NULL,\r
1973 NULL,\r
1974 &HandleCount,\r
1975 &HandleBuffer\r
1976 );\r
1977 ASSERT_EFI_ERROR(Status);\r
1978 if (EFI_ERROR(Status)) {\r
1979 return (Status);\r
1980 }\r
1981 for (mHandleList.NextIndex = 1 ; mHandleList.NextIndex <= HandleCount ; mHandleList.NextIndex++){\r
78ed876b 1982 ListWalker = AllocateZeroPool(sizeof(HANDLE_LIST));\r
a405b86d 1983 ASSERT(ListWalker != NULL);\r
1984 ListWalker->TheHandle = HandleBuffer[mHandleList.NextIndex-1];\r
1985 ListWalker->TheIndex = mHandleList.NextIndex;\r
1986 InsertTailList(&mHandleList.List.Link,&ListWalker->Link);\r
1987 }\r
1988 FreePool(HandleBuffer);\r
1989 return (EFI_SUCCESS);\r
1990}\r
1991\r
1992/**\r
1993 Function to retrieve the human-friendly index of a given handle. If the handle\r
1994 does not have a index one will be automatically assigned. The index value is valid\r
1995 until the termination of the shell application.\r
1996\r
1997 @param[in] TheHandle The handle to retrieve an index for.\r
1998\r
1999 @retval 0 A memory allocation failed.\r
2000 @return The index of the handle.\r
2001\r
2002**/\r
2003UINTN\r
2004EFIAPI\r
2005ConvertHandleToHandleIndex(\r
2006 IN CONST EFI_HANDLE TheHandle\r
2007 )\r
2008{\r
f330ff35 2009 EFI_STATUS Status;\r
2010 EFI_GUID **ProtocolBuffer;\r
2011 UINTN ProtocolCount;\r
2012 HANDLE_LIST *ListWalker;\r
2013\r
78ed876b 2014 if (TheHandle == NULL) {\r
2015 return 0;\r
2016 }\r
a405b86d 2017\r
2018 InternalShellInitHandleList();\r
2019\r
2020 for (ListWalker = (HANDLE_LIST*)GetFirstNode(&mHandleList.List.Link)\r
2021 ; !IsNull(&mHandleList.List.Link,&ListWalker->Link)\r
2022 ; ListWalker = (HANDLE_LIST*)GetNextNode(&mHandleList.List.Link,&ListWalker->Link)\r
2023 ){\r
2024 if (ListWalker->TheHandle == TheHandle) {\r
f330ff35 2025 //\r
2026 // Verify that TheHandle is still present in the Handle Database\r
2027 //\r
2028 Status = gBS->ProtocolsPerHandle(TheHandle, &ProtocolBuffer, &ProtocolCount);\r
2029 if (EFI_ERROR (Status)) {\r
2030 //\r
2031 // TheHandle is not present in the Handle Database, so delete from the handle list\r
2032 //\r
2033 RemoveEntryList (&ListWalker->Link);\r
2034 return 0;\r
2035 }\r
2036 FreePool (ProtocolBuffer);\r
a405b86d 2037 return (ListWalker->TheIndex);\r
2038 }\r
2039 }\r
f330ff35 2040\r
2041 //\r
2042 // Verify that TheHandle is valid handle\r
2043 //\r
2044 Status = gBS->ProtocolsPerHandle(TheHandle, &ProtocolBuffer, &ProtocolCount);\r
2045 if (EFI_ERROR (Status)) {\r
2046 //\r
2047 // TheHandle is not valid, so do not add to handle list\r
2048 //\r
2049 return 0;\r
2050 }\r
2051 FreePool (ProtocolBuffer);\r
2052\r
78ed876b 2053 ListWalker = AllocateZeroPool(sizeof(HANDLE_LIST));\r
a405b86d 2054 ASSERT(ListWalker != NULL);\r
2055 ListWalker->TheHandle = TheHandle;\r
2056 ListWalker->TheIndex = mHandleList.NextIndex++;\r
2057 InsertTailList(&mHandleList.List.Link,&ListWalker->Link);\r
2058 return (ListWalker->TheIndex);\r
2059}\r
2060\r
2061\r
2062\r
2063/**\r
2064 Function to retrieve the EFI_HANDLE from the human-friendly index.\r
2065\r
2066 @param[in] TheIndex The index to retrieve the EFI_HANDLE for.\r
2067\r
2068 @retval NULL The index was invalid.\r
2069 @return The EFI_HANDLE that index represents.\r
2070\r
2071**/\r
2072EFI_HANDLE\r
2073EFIAPI\r
2074ConvertHandleIndexToHandle(\r
2075 IN CONST UINTN TheIndex\r
2076 )\r
2077{\r
f330ff35 2078 EFI_STATUS Status;\r
2079 EFI_GUID **ProtocolBuffer;\r
2080 UINTN ProtocolCount;\r
a405b86d 2081 HANDLE_LIST *ListWalker;\r
2082\r
2083 InternalShellInitHandleList();\r
2084\r
2085 if (TheIndex >= mHandleList.NextIndex) {\r
f330ff35 2086 return NULL;\r
a405b86d 2087 }\r
2088\r
2089 for (ListWalker = (HANDLE_LIST*)GetFirstNode(&mHandleList.List.Link)\r
2090 ; !IsNull(&mHandleList.List.Link,&ListWalker->Link)\r
2091 ; ListWalker = (HANDLE_LIST*)GetNextNode(&mHandleList.List.Link,&ListWalker->Link)\r
2092 ){\r
f330ff35 2093 if (ListWalker->TheIndex == TheIndex && ListWalker->TheHandle != NULL) {\r
2094 //\r
2095 // Verify that LinkWalker->TheHandle is valid handle\r
2096 //\r
2097 Status = gBS->ProtocolsPerHandle(ListWalker->TheHandle, &ProtocolBuffer, &ProtocolCount);\r
2098 if (EFI_ERROR (Status)) {\r
2099 //\r
2100 // TheHandle is not valid, so do not add to handle list\r
2101 //\r
2102 ListWalker->TheHandle = NULL;\r
2103 }\r
a405b86d 2104 return (ListWalker->TheHandle);\r
2105 }\r
2106 }\r
f330ff35 2107 return NULL;\r
a405b86d 2108}\r
2109\r
2110/**\r
2111 Gets all the related EFI_HANDLEs based on the mask supplied.\r
2112\r
2113 This function scans all EFI_HANDLES in the UEFI environment's handle database\r
2114 and returns the ones with the specified relationship (Mask) to the specified\r
2115 controller handle.\r
2116\r
2117 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.\r
2118 If MatchingHandleCount is NULL, then ASSERT.\r
2119\r
2120 If MatchingHandleBuffer is not NULL upon a successful return the memory must be\r
2121 caller freed.\r
2122\r
2123 @param[in] DriverBindingHandle The handle with Driver Binding protocol on it.\r
2124 @param[in] ControllerHandle The handle with Device Path protocol on it.\r
2125 @param[in] MatchingHandleCount The pointer to UINTN that specifies the number of HANDLES in\r
2126 MatchingHandleBuffer.\r
2127 @param[out] MatchingHandleBuffer On a successful return, a buffer of MatchingHandleCount\r
2128 EFI_HANDLEs with a terminating NULL EFI_HANDLE.\r
2129 @param[out] HandleType An array of type information.\r
2130\r
2131 @retval EFI_SUCCESS The operation was successful, and any related handles\r
2132 are in MatchingHandleBuffer.\r
2133 @retval EFI_NOT_FOUND No matching handles were found.\r
2134 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.\r
2135**/\r
2136EFI_STATUS\r
2137EFIAPI\r
2138ParseHandleDatabaseByRelationshipWithType (\r
2139 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL,\r
2140 IN CONST EFI_HANDLE ControllerHandle OPTIONAL,\r
2141 IN UINTN *HandleCount,\r
2142 OUT EFI_HANDLE **HandleBuffer,\r
2143 OUT UINTN **HandleType\r
2144 )\r
2145{\r
2146 EFI_STATUS Status;\r
2147 UINTN HandleIndex;\r
2148 EFI_GUID **ProtocolGuidArray;\r
2149 UINTN ArrayCount;\r
2150 UINTN ProtocolIndex;\r
2151 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *OpenInfo;\r
2152 UINTN OpenInfoCount;\r
2153 UINTN OpenInfoIndex;\r
2154 UINTN ChildIndex;\r
f330ff35 2155 INTN DriverBindingHandleIndex;\r
a405b86d 2156\r
2157 ASSERT(HandleCount != NULL);\r
2158 ASSERT(HandleBuffer != NULL);\r
2159 ASSERT(HandleType != NULL);\r
2160 ASSERT(DriverBindingHandle != NULL || ControllerHandle != NULL);\r
2161\r
2162 *HandleCount = 0;\r
2163 *HandleBuffer = NULL;\r
2164 *HandleType = NULL;\r
2165\r
2166 //\r
2167 // Retrieve the list of all handles from the handle database\r
2168 //\r
2169 Status = gBS->LocateHandleBuffer (\r
2170 AllHandles,\r
2171 NULL,\r
2172 NULL,\r
2173 HandleCount,\r
2174 HandleBuffer\r
2175 );\r
2176 if (EFI_ERROR (Status)) {\r
2177 return (Status);\r
2178 }\r
2179\r
2180 *HandleType = AllocateZeroPool (*HandleCount * sizeof (UINTN));\r
2181 ASSERT(*HandleType != NULL);\r
2182\r
f330ff35 2183 DriverBindingHandleIndex = -1;\r
2184 for (HandleIndex = 0; HandleIndex < *HandleCount; HandleIndex++) {\r
2185 if (DriverBindingHandle != NULL && (*HandleBuffer)[HandleIndex] == DriverBindingHandle) {\r
2186 DriverBindingHandleIndex = (INTN)HandleIndex;\r
2187 }\r
2188 }\r
2189\r
a405b86d 2190 for (HandleIndex = 0; HandleIndex < *HandleCount; HandleIndex++) {\r
2191 //\r
2192 // Retrieve the list of all the protocols on each handle\r
2193 //\r
2194 Status = gBS->ProtocolsPerHandle (\r
2195 (*HandleBuffer)[HandleIndex],\r
2196 &ProtocolGuidArray,\r
2197 &ArrayCount\r
2198 );\r
f330ff35 2199 if (EFI_ERROR (Status)) {\r
2200 continue;\r
2201 }\r
a405b86d 2202\r
f330ff35 2203 for (ProtocolIndex = 0; ProtocolIndex < ArrayCount; ProtocolIndex++) {\r
a405b86d 2204\r
f330ff35 2205 //\r
2206 // Set the bit describing what this handle has\r
2207 //\r
2208 if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiLoadedImageProtocolGuid) ) {\r
7aae3c35 2209 (*HandleType)[HandleIndex] |= (UINTN)HR_IMAGE_HANDLE;\r
f330ff35 2210 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverBindingProtocolGuid) ) {\r
7aae3c35 2211 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_BINDING_HANDLE;\r
f330ff35 2212 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverConfiguration2ProtocolGuid)) {\r
7aae3c35 2213 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_CONFIGURATION_HANDLE;\r
f330ff35 2214 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverConfigurationProtocolGuid) ) {\r
7aae3c35 2215 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_CONFIGURATION_HANDLE;\r
f330ff35 2216 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverDiagnostics2ProtocolGuid) ) {\r
7aae3c35 2217 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_DIAGNOSTICS_HANDLE;\r
f330ff35 2218 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverDiagnosticsProtocolGuid) ) {\r
7aae3c35 2219 (*HandleType)[HandleIndex] |= (UINTN)HR_DRIVER_DIAGNOSTICS_HANDLE;\r
f330ff35 2220 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiComponentName2ProtocolGuid) ) {\r
7aae3c35 2221 (*HandleType)[HandleIndex] |= (UINTN)HR_COMPONENT_NAME_HANDLE;\r
f330ff35 2222 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiComponentNameProtocolGuid) ) {\r
7aae3c35 2223 (*HandleType)[HandleIndex] |= (UINTN)HR_COMPONENT_NAME_HANDLE;\r
f330ff35 2224 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDevicePathProtocolGuid) ) {\r
7aae3c35 2225 (*HandleType)[HandleIndex] |= (UINTN)HR_DEVICE_HANDLE;\r
f330ff35 2226 } else {\r
2227 DEBUG_CODE_BEGIN();\r
2228 ASSERT((*HandleType)[HandleIndex] == (*HandleType)[HandleIndex]);\r
2229 DEBUG_CODE_END();\r
2230 }\r
2231 //\r
2232 // Retrieve the list of agents that have opened each protocol\r
2233 //\r
2234 Status = gBS->OpenProtocolInformation (\r
a405b86d 2235 (*HandleBuffer)[HandleIndex],\r
2236 ProtocolGuidArray[ProtocolIndex],\r
2237 &OpenInfo,\r
2238 &OpenInfoCount\r
2239 );\r
f330ff35 2240 if (EFI_ERROR (Status)) {\r
2241 continue;\r
2242 }\r
2243\r
2244 if (ControllerHandle == NULL) {\r
2245 //\r
1a6f74d9 2246 // ControllerHandle == NULL and DriverBindingHandle != NULL.\r
f330ff35 2247 // Return information on all the controller handles that the driver specified by DriverBindingHandle is managing\r
2248 //\r
2249 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
2250 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle && (OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
7aae3c35 2251 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);\r
f330ff35 2252 if (DriverBindingHandleIndex != -1) {\r
7aae3c35 2253 (*HandleType)[DriverBindingHandleIndex] |= (UINTN)HR_DEVICE_DRIVER;\r
f330ff35 2254 }\r
2255 }\r
2256 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle && (OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
7aae3c35 2257 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);\r
f330ff35 2258 if (DriverBindingHandleIndex != -1) {\r
7aae3c35 2259 (*HandleType)[DriverBindingHandleIndex] |= (UINTN)(HR_BUS_DRIVER | HR_DEVICE_DRIVER);\r
f330ff35 2260 }\r
2261 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
2262 if (OpenInfo[OpenInfoIndex].ControllerHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 2263 (*HandleType)[ChildIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CHILD_HANDLE);\r
f330ff35 2264 }\r
2265 }\r
2266 }\r
2267 }\r
2268 }\r
2269 if (DriverBindingHandle == NULL && ControllerHandle != NULL) {\r
2270 if (ControllerHandle == (*HandleBuffer)[HandleIndex]) {\r
7aae3c35 2271 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);\r
a405b86d 2272 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
f330ff35 2273 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
2274 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
2275 if (OpenInfo[OpenInfoIndex].AgentHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 2276 (*HandleType)[ChildIndex] |= (UINTN)HR_DEVICE_DRIVER;\r
f330ff35 2277 }\r
a405b86d 2278 }\r
f330ff35 2279 }\r
2280 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
2281 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
2282 if (OpenInfo[OpenInfoIndex].AgentHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 2283 (*HandleType)[ChildIndex] |= (UINTN)(HR_BUS_DRIVER | HR_DEVICE_DRIVER);\r
f330ff35 2284 }\r
2285 if (OpenInfo[OpenInfoIndex].ControllerHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 2286 (*HandleType)[ChildIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CHILD_HANDLE);\r
a405b86d 2287 }\r
2288 }\r
2289 }\r
f330ff35 2290 }\r
2291 } else {\r
2292 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
2293 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
2294 if (OpenInfo[OpenInfoIndex].ControllerHandle == ControllerHandle) {\r
7aae3c35 2295 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_PARENT_HANDLE);\r
f330ff35 2296 }\r
2297 }\r
2298 }\r
2299 }\r
2300 }\r
2301 if (DriverBindingHandle != NULL && ControllerHandle != NULL) {\r
2302 if (ControllerHandle == (*HandleBuffer)[HandleIndex]) {\r
7aae3c35 2303 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);\r
f330ff35 2304 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
2305 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) != 0) {\r
2306 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle) {\r
2307 if (DriverBindingHandleIndex != -1) {\r
7aae3c35 2308 (*HandleType)[DriverBindingHandleIndex] |= (UINTN)HR_DEVICE_DRIVER;\r
a405b86d 2309 }\r
2310 }\r
f330ff35 2311 }\r
2312 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
2313 if (OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle) {\r
a405b86d 2314 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
f330ff35 2315 if (OpenInfo[OpenInfoIndex].ControllerHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 2316 (*HandleType)[ChildIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_CHILD_HANDLE);\r
a405b86d 2317 }\r
2318 }\r
2319 }\r
f330ff35 2320\r
2321 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
2322 if (OpenInfo[OpenInfoIndex].AgentHandle == (*HandleBuffer)[ChildIndex]) {\r
7aae3c35 2323 (*HandleType)[ChildIndex] |= (UINTN)(HR_BUS_DRIVER | HR_DEVICE_DRIVER);\r
f330ff35 2324 }\r
2325 }\r
2326 }\r
2327 }\r
2328 } else {\r
2329 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
2330 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) != 0) {\r
2331 if (OpenInfo[OpenInfoIndex].ControllerHandle == ControllerHandle) {\r
7aae3c35 2332 (*HandleType)[HandleIndex] |= (UINTN)(HR_DEVICE_HANDLE | HR_PARENT_HANDLE);\r
f330ff35 2333 }\r
a405b86d 2334 }\r
2335 }\r
a405b86d 2336 }\r
2337 }\r
f330ff35 2338 FreePool (OpenInfo);\r
a405b86d 2339 }\r
f330ff35 2340 FreePool (ProtocolGuidArray);\r
a405b86d 2341 }\r
f330ff35 2342 return EFI_SUCCESS;\r
a405b86d 2343}\r
2344\r
2345/**\r
2346 Gets all the related EFI_HANDLEs based on the single EFI_HANDLE and the mask\r
2347 supplied.\r
2348\r
2349 This function will scan all EFI_HANDLES in the UEFI environment's handle database\r
2350 and return all the ones with the specified relationship (Mask) to the specified\r
2351 controller handle.\r
2352\r
2353 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.\r
2354 If MatchingHandleCount is NULL, then ASSERT.\r
2355\r
2356 If MatchingHandleBuffer is not NULL upon a sucessful return the memory must be\r
2357 caller freed.\r
2358\r
2359 @param[in] DriverBindingHandle Handle to a object with Driver Binding protocol\r
2360 on it.\r
2361 @param[in] ControllerHandle Handle to a device with Device Path protocol on it.\r
2362 @param[in] Mask Mask of what relationship(s) is desired.\r
2363 @param[in] MatchingHandleCount Poitner to UINTN specifying number of HANDLES in\r
2364 MatchingHandleBuffer.\r
2365 @param[out] MatchingHandleBuffer On a sucessful return a buffer of MatchingHandleCount\r
2366 EFI_HANDLEs and a terminating NULL EFI_HANDLE.\r
2367\r
2368 @retval EFI_SUCCESS The operation was sucessful and any related handles\r
2369 are in MatchingHandleBuffer;\r
2370 @retval EFI_NOT_FOUND No matching handles were found.\r
2371 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.\r
2372**/\r
2373EFI_STATUS\r
2374EFIAPI\r
2375ParseHandleDatabaseByRelationship (\r
2376 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL,\r
2377 IN CONST EFI_HANDLE ControllerHandle OPTIONAL,\r
2378 IN CONST UINTN Mask,\r
2379 IN UINTN *MatchingHandleCount,\r
2380 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL\r
2381 )\r
2382{\r
2383 EFI_STATUS Status;\r
2384 UINTN HandleCount;\r
2385 EFI_HANDLE *HandleBuffer;\r
2386 UINTN *HandleType;\r
2387 UINTN HandleIndex;\r
2388\r
2389 ASSERT(MatchingHandleCount != NULL);\r
2390 ASSERT(DriverBindingHandle != NULL || ControllerHandle != NULL);\r
2391\r
2392 if ((Mask & HR_VALID_MASK) != Mask) {\r
2393 return (EFI_INVALID_PARAMETER);\r
2394 }\r
2395\r
2396 if ((Mask & HR_CHILD_HANDLE) != 0 && DriverBindingHandle == NULL) {\r
2397 return (EFI_INVALID_PARAMETER);\r
2398 }\r
2399\r
2400 *MatchingHandleCount = 0;\r
2401 if (MatchingHandleBuffer != NULL) {\r
2402 *MatchingHandleBuffer = NULL;\r
2403 }\r
2404\r
2405 HandleBuffer = NULL;\r
2406 HandleType = NULL;\r
2407\r
2408 Status = ParseHandleDatabaseByRelationshipWithType (\r
2409 DriverBindingHandle,\r
2410 ControllerHandle,\r
2411 &HandleCount,\r
2412 &HandleBuffer,\r
2413 &HandleType\r
2414 );\r
2415 if (!EFI_ERROR (Status)) {\r
2416 //\r
2417 // Count the number of handles that match the attributes in Mask\r
2418 //\r
2419 for (HandleIndex = 0; HandleIndex < HandleCount; HandleIndex++) {\r
2420 if ((HandleType[HandleIndex] & Mask) == Mask) {\r
2421 (*MatchingHandleCount)++;\r
2422 }\r
2423 }\r
2424 //\r
2425 // If no handles match the attributes in Mask then return EFI_NOT_FOUND\r
2426 //\r
2427 if (*MatchingHandleCount == 0) {\r
2428 Status = EFI_NOT_FOUND;\r
2429 } else {\r
2430\r
2431 if (MatchingHandleBuffer == NULL) {\r
2432 //\r
2433 // Someone just wanted the count...\r
2434 //\r
2435 Status = EFI_SUCCESS;\r
2436 } else {\r
2437 //\r
2438 // Allocate a handle buffer for the number of handles that matched the attributes in Mask\r
2439 //\r
78ed876b 2440 *MatchingHandleBuffer = AllocateZeroPool ((*MatchingHandleCount +1)* sizeof (EFI_HANDLE));\r
a405b86d 2441 ASSERT(*MatchingHandleBuffer != NULL);\r
2442\r
2443 for (HandleIndex = 0,*MatchingHandleCount = 0\r
2444 ; HandleIndex < HandleCount\r
2445 ; HandleIndex++\r
2446 ){\r
2447 //\r
2448 // Fill the allocated buffer with the handles that matched the attributes in Mask\r
2449 //\r
2450 if ((HandleType[HandleIndex] & Mask) == Mask) {\r
2451 (*MatchingHandleBuffer)[(*MatchingHandleCount)++] = HandleBuffer[HandleIndex];\r
2452 }\r
2453 }\r
2454\r
2455 //\r
2456 // Make the last one NULL\r
2457 //\r
2458 (*MatchingHandleBuffer)[*MatchingHandleCount] = NULL;\r
2459\r
2460 Status = EFI_SUCCESS;\r
2461 } // MacthingHandleBuffer == NULL (ELSE)\r
2462 } // *MatchingHandleCount == 0 (ELSE)\r
2463 } // no error on ParseHandleDatabaseByRelationshipWithType\r
2464\r
2465 if (HandleBuffer != NULL) {\r
2466 FreePool (HandleBuffer);\r
2467 }\r
2468\r
2469 if (HandleType != NULL) {\r
2470 FreePool (HandleType);\r
2471 }\r
2472\r
2473 return Status;\r
2474}\r
2475\r
2476/**\r
2477 Gets handles for any child controllers of the passed in controller.\r
2478\r
2479 @param[in] ControllerHandle The handle of the "parent controller"\r
2480 @param[in] MatchingHandleCount Pointer to the number of handles in\r
2481 MatchingHandleBuffer on return.\r
2482 @param[out] MatchingHandleBuffer Buffer containing handles on a successful\r
2483 return.\r
2484\r
2485\r
2486 @retval EFI_SUCCESS The operation was sucessful.\r
2487**/\r
2488EFI_STATUS\r
2489EFIAPI\r
2490ParseHandleDatabaseForChildControllers(\r
2491 IN CONST EFI_HANDLE ControllerHandle,\r
2492 IN UINTN *MatchingHandleCount,\r
2493 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL\r
2494 )\r
2495{\r
2496 EFI_STATUS Status;\r
f330ff35 2497 UINTN HandleIndex;\r
a405b86d 2498 UINTN DriverBindingHandleCount;\r
2499 EFI_HANDLE *DriverBindingHandleBuffer;\r
2500 UINTN DriverBindingHandleIndex;\r
2501 UINTN ChildControllerHandleCount;\r
2502 EFI_HANDLE *ChildControllerHandleBuffer;\r
2503 UINTN ChildControllerHandleIndex;\r
a405b86d 2504 EFI_HANDLE *HandleBufferForReturn;\r
2505\r
ff51746b 2506 if (MatchingHandleCount == NULL) {\r
2507 return (EFI_INVALID_PARAMETER);\r
2508 }\r
64d753f1 2509 *MatchingHandleCount = 0;\r
a405b86d 2510\r
2511 Status = PARSE_HANDLE_DATABASE_UEFI_DRIVERS (\r
2512 ControllerHandle,\r
2513 &DriverBindingHandleCount,\r
2514 &DriverBindingHandleBuffer\r
2515 );\r
2516 if (EFI_ERROR (Status)) {\r
2517 return Status;\r
2518 }\r
2519\r
ff51746b 2520 //\r
2521 // Get a buffer big enough for all the controllers.\r
2522 //\r
f330ff35 2523 HandleBufferForReturn = GetHandleListByProtocol(NULL);\r
a405b86d 2524 if (HandleBufferForReturn == NULL) {\r
2525 FreePool (DriverBindingHandleBuffer);\r
ff51746b 2526 return (EFI_NOT_FOUND);\r
a405b86d 2527 }\r
2528\r
a405b86d 2529 for (DriverBindingHandleIndex = 0; DriverBindingHandleIndex < DriverBindingHandleCount; DriverBindingHandleIndex++) {\r
2530 Status = PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (\r
2531 DriverBindingHandleBuffer[DriverBindingHandleIndex],\r
2532 ControllerHandle,\r
2533 &ChildControllerHandleCount,\r
2534 &ChildControllerHandleBuffer\r
2535 );\r
2536 if (EFI_ERROR (Status)) {\r
2537 continue;\r
2538 }\r
2539\r
2540 for (ChildControllerHandleIndex = 0;\r
2541 ChildControllerHandleIndex < ChildControllerHandleCount;\r
2542 ChildControllerHandleIndex++\r
2543 ) {\r
f330ff35 2544 for (HandleIndex = 0; HandleIndex < *MatchingHandleCount; HandleIndex++) {\r
2545 if (HandleBufferForReturn[HandleIndex] == ChildControllerHandleBuffer[ChildControllerHandleIndex]) {\r
2546 break;\r
2547 }\r
2548 }\r
2549 if (HandleIndex >= *MatchingHandleCount) {\r
2550 HandleBufferForReturn[(*MatchingHandleCount)++] = ChildControllerHandleBuffer[ChildControllerHandleIndex];\r
2551 }\r
a405b86d 2552 }\r
2553\r
2554 FreePool (ChildControllerHandleBuffer);\r
2555 }\r
2556\r
2557 FreePool (DriverBindingHandleBuffer);\r
2558\r
2559 if (MatchingHandleBuffer != NULL) {\r
2560 *MatchingHandleBuffer = HandleBufferForReturn;\r
2561 } else {\r
2562 FreePool(HandleBufferForReturn);\r
2563 }\r
2564\r
2565 return (EFI_SUCCESS);\r
2566}\r
2567\r
2568/**\r
2569 Appends 1 buffer to another buffer. This will re-allocate the destination buffer\r
2570 if necessary to fit all of the data.\r
2571\r
2572 If DestinationBuffer is NULL, then ASSERT().\r
2573\r
4ff7e37b
ED
2574 @param[in, out] DestinationBuffer The pointer to the pointer to the buffer to append onto.\r
2575 @param[in, out] DestinationSize The pointer to the size of DestinationBuffer.\r
2576 @param[in] SourceBuffer The pointer to the buffer to append onto DestinationBuffer.\r
2577 @param[in] SourceSize The number of bytes of SourceBuffer to append.\r
a405b86d 2578\r
2579 @retval NULL A memory allocation failed.\r
2580 @retval NULL A parameter was invalid.\r
2581 @return A pointer to (*DestinationBuffer).\r
2582**/\r
2583VOID*\r
2584EFIAPI\r
2585BuffernCatGrow (\r
2586 IN OUT VOID **DestinationBuffer,\r
2587 IN OUT UINTN *DestinationSize,\r
2588 IN VOID *SourceBuffer,\r
2589 IN UINTN SourceSize\r
2590 )\r
2591{\r
2592 UINTN LocalDestinationSize;\r
2593 UINTN LocalDestinationFinalSize;\r
2594\r
2595 ASSERT(DestinationBuffer != NULL);\r
2596\r
2597 if (SourceSize == 0 || SourceBuffer == NULL) {\r
2598 return (*DestinationBuffer);\r
2599 }\r
2600\r
2601 if (DestinationSize == NULL) {\r
2602 LocalDestinationSize = 0;\r
2603 } else {\r
2604 LocalDestinationSize = *DestinationSize;\r
2605 }\r
2606\r
2607 LocalDestinationFinalSize = LocalDestinationSize + SourceSize;\r
2608\r
2609 if (DestinationSize != NULL) {\r
2610 *DestinationSize = LocalDestinationSize;\r
2611 }\r
2612\r
2613 if (LocalDestinationSize == 0) {\r
2614 // allcoate\r
78ed876b 2615 *DestinationBuffer = AllocateZeroPool(LocalDestinationFinalSize);\r
a405b86d 2616 } else {\r
2617 // reallocate\r
2618 *DestinationBuffer = ReallocatePool(LocalDestinationSize, LocalDestinationFinalSize, *DestinationBuffer);\r
2619 }\r
2620\r
2621 ASSERT(*DestinationBuffer != NULL);\r
2622\r
2623 // copy\r
2624 return (CopyMem(((UINT8*)(*DestinationBuffer)) + LocalDestinationSize, SourceBuffer, SourceSize));\r
2625}\r
2626\r
2627/**\r
2628 Gets handles for any child devices produced by the passed in driver.\r
2629\r
2630 @param[in] DriverHandle The handle of the driver.\r
2631 @param[in] MatchingHandleCount Pointer to the number of handles in\r
2632 MatchingHandleBuffer on return.\r
2633 @param[out] MatchingHandleBuffer Buffer containing handles on a successful\r
2634 return.\r
2635 @retval EFI_SUCCESS The operation was sucessful.\r
2636 @sa ParseHandleDatabaseByRelationship\r
2637**/\r
2638EFI_STATUS\r
2639EFIAPI\r
2640ParseHandleDatabaseForChildDevices(\r
2641 IN CONST EFI_HANDLE DriverHandle,\r
2642 IN UINTN *MatchingHandleCount,\r
2643 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL\r
2644 )\r
2645{\r
2646 EFI_HANDLE *Buffer;\r
2647 EFI_HANDLE *Buffer2;\r
2648 UINTN Count1;\r
2649 UINTN Count2;\r
2650 UINTN HandleIndex;\r
2651 EFI_STATUS Status;\r
2652 UINTN HandleBufferSize;\r
2653\r
2654 ASSERT(MatchingHandleCount != NULL);\r
2655\r
2656 HandleBufferSize = 0;\r
2657 Buffer = NULL;\r
2658 Buffer2 = NULL;\r
2659 *MatchingHandleCount = 0;\r
2660\r
2661 Status = PARSE_HANDLE_DATABASE_DEVICES (\r
2662 DriverHandle,\r
2663 &Count1,\r
2664 &Buffer\r
2665 );\r
2666 if (!EFI_ERROR (Status)) {\r
2667 for (HandleIndex = 0; HandleIndex < Count1; HandleIndex++) {\r
2668 //\r
2669 // now find the children\r
2670 //\r
2671 Status = PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (\r
2672 DriverHandle,\r
2673 Buffer[HandleIndex],\r
2674 &Count2,\r
2675 &Buffer2\r
2676 );\r
2677 if (EFI_ERROR(Status)) {\r
2678 break;\r
2679 }\r
2680 //\r
2681 // save out required and optional data elements\r
2682 //\r
2683 *MatchingHandleCount += Count2;\r
2684 if (MatchingHandleBuffer != NULL) {\r
2685 *MatchingHandleBuffer = BuffernCatGrow((VOID**)MatchingHandleBuffer, &HandleBufferSize, Buffer2, Count2 * sizeof(Buffer2[0]));\r
2686 }\r
2687\r
2688 //\r
2689 // free the memory\r
2690 //\r
2691 if (Buffer2 != NULL) {\r
2692 FreePool(Buffer2);\r
2693 }\r
2694 }\r
2695 }\r
2696\r
2697 if (Buffer != NULL) {\r
2698 FreePool(Buffer);\r
2699 }\r
2700 return (Status);\r
2701}\r
2702\r
2703/**\r
2704 Function to get all handles that support a given protocol or all handles.\r
2705\r
2706 @param[in] ProtocolGuid The guid of the protocol to get handles for. If NULL\r
2707 then the function will return all handles.\r
2708\r
2709 @retval NULL A memory allocation failed.\r
2710 @return A NULL terminated list of handles.\r
2711**/\r
2712EFI_HANDLE*\r
2713EFIAPI\r
40d7a9cf 2714GetHandleListByProtocol (\r
a405b86d 2715 IN CONST EFI_GUID *ProtocolGuid OPTIONAL\r
2716 )\r
2717{\r
2718 EFI_HANDLE *HandleList;\r
2719 UINTN Size;\r
2720 EFI_STATUS Status;\r
2721\r
2722 Size = 0;\r
2723 HandleList = NULL;\r
2724\r
2725 //\r
2726 // We cannot use LocateHandleBuffer since we need that NULL item on the ends of the list!\r
2727 //\r
2728 if (ProtocolGuid == NULL) {\r
2729 Status = gBS->LocateHandle(AllHandles, NULL, NULL, &Size, HandleList);\r
2730 if (Status == EFI_BUFFER_TOO_SMALL) {\r
78ed876b 2731 HandleList = AllocateZeroPool(Size + sizeof(EFI_HANDLE));\r
40d7a9cf 2732 if (HandleList == NULL) {\r
2733 return (NULL);\r
2734 }\r
a405b86d 2735 Status = gBS->LocateHandle(AllHandles, NULL, NULL, &Size, HandleList);\r
2736 HandleList[Size/sizeof(EFI_HANDLE)] = NULL;\r
2737 }\r
2738 } else {\r
2739 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)ProtocolGuid, NULL, &Size, HandleList);\r
2740 if (Status == EFI_BUFFER_TOO_SMALL) {\r
78ed876b 2741 HandleList = AllocateZeroPool(Size + sizeof(EFI_HANDLE));\r
40d7a9cf 2742 if (HandleList == NULL) {\r
2743 return (NULL);\r
2744 }\r
a405b86d 2745 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)ProtocolGuid, NULL, &Size, HandleList);\r
2746 HandleList[Size/sizeof(EFI_HANDLE)] = NULL;\r
2747 }\r
2748 }\r
2749 if (EFI_ERROR(Status)) {\r
2750 if (HandleList != NULL) {\r
2751 FreePool(HandleList);\r
2752 }\r
2753 return (NULL);\r
2754 }\r
2755 return (HandleList);\r
2756}\r
2757\r
2758/**\r
2759 Function to get all handles that support some protocols.\r
2760\r
2761 @param[in] ProtocolGuids A NULL terminated list of protocol GUIDs.\r
2762\r
2763 @retval NULL A memory allocation failed.\r
ff51746b 2764 @retval NULL ProtocolGuids was NULL.\r
2765 @return A NULL terminated list of EFI_HANDLEs.\r
a405b86d 2766**/\r
2767EFI_HANDLE*\r
2768EFIAPI\r
40d7a9cf 2769GetHandleListByProtocolList (\r
a405b86d 2770 IN CONST EFI_GUID **ProtocolGuids\r
2771 )\r
2772{\r
2773 EFI_HANDLE *HandleList;\r
2774 UINTN Size;\r
2775 UINTN TotalSize;\r
40d7a9cf 2776 UINTN TempSize;\r
a405b86d 2777 EFI_STATUS Status;\r
2778 CONST EFI_GUID **GuidWalker;\r
2779 EFI_HANDLE *HandleWalker1;\r
2780 EFI_HANDLE *HandleWalker2;\r
2781\r
2782 Size = 0;\r
2783 HandleList = NULL;\r
2784 TotalSize = sizeof(EFI_HANDLE);\r
2785\r
2786 for (GuidWalker = ProtocolGuids ; GuidWalker != NULL && *GuidWalker != NULL ; GuidWalker++,Size = 0){\r
2787 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)(*GuidWalker), NULL, &Size, NULL);\r
2788 if (Status == EFI_BUFFER_TOO_SMALL) {\r
2789 TotalSize += Size;\r
2790 }\r
2791 }\r
40d7a9cf 2792\r
2793 //\r
2794 // No handles were found... \r
2795 //\r
2796 if (TotalSize == sizeof(EFI_HANDLE)) {\r
2797 return (NULL);\r
2798 }\r
2799\r
2800 HandleList = AllocateZeroPool(TotalSize);\r
a405b86d 2801 if (HandleList == NULL) {\r
2802 return (NULL);\r
2803 }\r
2804\r
2805 Size = 0;\r
2806 for (GuidWalker = ProtocolGuids ; GuidWalker != NULL && *GuidWalker != NULL ; GuidWalker++){\r
40d7a9cf 2807 TempSize = TotalSize - Size;\r
ff51746b 2808 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)(*GuidWalker), NULL, &TempSize, HandleList+(Size/sizeof(EFI_HANDLE)));\r
40d7a9cf 2809\r
2810 //\r
2811 // Allow for missing protocols... Only update the 'used' size upon success.\r
2812 //\r
2813 if (!EFI_ERROR(Status)) {\r
ff51746b 2814 Size += TempSize;\r
40d7a9cf 2815 }\r
a405b86d 2816 }\r
ff51746b 2817 ASSERT(HandleList[(TotalSize/sizeof(EFI_HANDLE))-1] == NULL);\r
a405b86d 2818\r
2819 for (HandleWalker1 = HandleList ; HandleWalker1 != NULL && *HandleWalker1 != NULL ; HandleWalker1++) {\r
2820 for (HandleWalker2 = HandleWalker1 + 1; HandleWalker2 != NULL && *HandleWalker2 != NULL ; HandleWalker2++) {\r
2821 if (*HandleWalker1 == *HandleWalker2) {\r
2822 //\r
2823 // copy memory back 1 handle width.\r
2824 //\r
2825 CopyMem(HandleWalker2, HandleWalker2 + 1, TotalSize - ((HandleWalker2-HandleList+1)*sizeof(EFI_HANDLE)));\r
2826 }\r
2827 }\r
2828 }\r
2829\r
2830 return (HandleList);\r
2831}\r
2832\r
2833\r
2834\r
2835\r
2836\r
2837\r
2838\r
2839\r
2840\r
2841\r