]> git.proxmox.com Git - mirror_edk2.git/blame - ShellPkg/Library/UefiHandleParsingLib/UefiHandleParsingLib.c
StdLib: Fix several problems where characters were not being correctly converted...
[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
dee34318 4 Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>\r
a405b86d 5 This program and the accompanying materials\r
6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#include "UefiHandleParsingLib.h"\r
f4f3c6bf 16#include "IndustryStandard/Acpi10.h"\r
a405b86d 17\r
a405b86d 18EFI_HANDLE mHandleParsingHiiHandle;\r
19HANDLE_INDEX_LIST mHandleList = {{{NULL,NULL},0,0},0};\r
20\r
21/**\r
22 Constructor for the library.\r
23\r
24 @param[in] ImageHandle Ignored.\r
25 @param[in] SystemTable Ignored.\r
26\r
27 @retval EFI_SUCCESS The operation was successful.\r
28**/\r
29EFI_STATUS\r
30EFIAPI\r
31HandleParsingLibConstructor (\r
32 IN EFI_HANDLE ImageHandle,\r
33 IN EFI_SYSTEM_TABLE *SystemTable\r
34 )\r
35{\r
bca163ff 36 mHandleParsingHiiHandle = HiiAddPackages (&gHandleParsingHiiGuid, gImageHandle, UefiHandleParsingLibStrings, NULL);\r
a405b86d 37 if (mHandleParsingHiiHandle == NULL) {\r
38 return (EFI_DEVICE_ERROR);\r
39 }\r
40\r
41 return (EFI_SUCCESS);\r
42}\r
43\r
44/**\r
45 Destructor for the library. free any resources.\r
46\r
47 @param[in] ImageHandle Ignored.\r
48 @param[in] SystemTable Ignored.\r
49\r
50 @retval EFI_SUCCESS The operation was successful.\r
51**/\r
52EFI_STATUS\r
53EFIAPI\r
54HandleParsingLibDestructor (\r
55 IN EFI_HANDLE ImageHandle,\r
56 IN EFI_SYSTEM_TABLE *SystemTable\r
57 )\r
58{\r
59 if (mHandleParsingHiiHandle != NULL) {\r
60 HiiRemovePackages(mHandleParsingHiiHandle);\r
61 }\r
62 return (EFI_SUCCESS);\r
63}\r
64\r
65/*\r
66CHAR16*\r
67EFIAPI\r
68LoadedImageProtocolDumpInformation(\r
69 IN CONST EFI_HANDLE TheHandle,\r
70 IN CONST BOOLEAN Verbose\r
71 )\r
72{\r
73 EFI_LOADED_IMAGE_PROTOCOL *Image;\r
74 EFI_STATUS Status;\r
75 EFI_DEVICE_PATH_PROTOCOL *DevPath;\r
76 EFI_DEVICE_PATH_PROTOCOL *DevPathNode;\r
77 VOID *Buffer;\r
78 UINTN BufferSize;\r
79 UINT32 AuthenticationStatus;\r
80 EFI_GUID *NameGuid;\r
81 EFI_FIRMWARE_VOLUME_PROTOCOL *FV;\r
82 EFI_FIRMWARE_VOLUME2_PROTOCOL *FV2;\r
83\r
84 FV = NULL;\r
85 FV2 = NULL;\r
86 Buffer = NULL;\r
87 BufferSize = 0;\r
88\r
89 Status = HandleProtocol (\r
90 TheHandle,\r
91 &gEfiLoadedImageProtocolGuid,\r
92 &Image);\r
93 ASSERT_EFI_ERROR(Status);\r
94\r
95 DevPath = UnpackDevicePath (Image->FilePath);\r
96\r
97 if (DevPath == NULL) {\r
98 return NULL;\r
99 }\r
100\r
101 DevPathNode = DevPath;\r
102\r
103 while (!IsDevicePathEnd (DevPathNode)) {\r
104 //\r
105 // Find the Fv File path\r
106 //\r
107 NameGuid = GetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *)DevPathNode);\r
108 if (NameGuid != NULL) {\r
109 Status = BS->HandleProtocol (\r
110 Image->DeviceHandle,\r
111 &gEfiFirmwareVolumeProtocolGuid,\r
112 &FV\r
113 );\r
114 if (!EFI_ERROR (Status)) {\r
115 Status = FV->ReadSection (\r
116 FV,\r
117 NameGuid,\r
118 EFI_SECTION_USER_INTERFACE,\r
119 0,\r
120 &Buffer,\r
121 &BufferSize,\r
122 &AuthenticationStatus\r
123 );\r
124 if (!EFI_ERROR (Status)) {\r
125 break;\r
126 }\r
127\r
128 Buffer = NULL;\r
129 } else {\r
130 Status = BS->HandleProtocol (\r
131 Image->DeviceHandle,\r
132 &gEfiFirmwareVolume2ProtocolGuid,\r
133 &FV2\r
134 );\r
135 if (!EFI_ERROR (Status)) {\r
136 Status = FV2->ReadSection (\r
137 FV2,\r
138 NameGuid,\r
139 EFI_SECTION_USER_INTERFACE,\r
140 0,\r
141 &Buffer,\r
142 &BufferSize,\r
143 &AuthenticationStatus\r
144 );\r
145 if (!EFI_ERROR (Status)) {\r
146 break;\r
147 }\r
148\r
149 Buffer = NULL;\r
150 }\r
151 }\r
152 }\r
153 //\r
154 // Next device path node\r
155 //\r
156 DevPathNode = NextDevicePathNode (DevPathNode);\r
157 }\r
158\r
159 FreePool (DevPath);\r
160 return Buffer;\r
161}\r
162*/\r
163\r
f4f3c6bf 164/**\r
165 Function to dump information about PciRootBridgeIo.\r
166\r
167 This will allocate the return buffer from boot services pool.\r
168\r
169 @param[in] TheHandle The handle that has PciRootBridgeIo installed.\r
170 @param[in] Verbose TRUE for additional information, FALSE otherwise.\r
171\r
172 @retval A poitner to a string containing the information.\r
173**/\r
174CHAR16*\r
175EFIAPI\r
176PciRootBridgeIoDumpInformation(\r
177 IN CONST EFI_HANDLE TheHandle,\r
178 IN CONST BOOLEAN Verbose\r
179 )\r
180{\r
181 EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *PciRootBridgeIo;\r
182 EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR *Configuration;\r
183 UINT64 Supports;\r
184 UINT64 Attributes;\r
185 CHAR16 *Temp;\r
186 CHAR16 *Temp2;\r
187 CHAR16 *RetVal;\r
188 EFI_STATUS Status;\r
189\r
190 RetVal = NULL;\r
191\r
192 if (!Verbose) {\r
193 return (CatSPrint(NULL, L"PciRootBridgeIo"));\r
194 }\r
195\r
196 Status = gBS->HandleProtocol(\r
197 TheHandle,\r
198 &gEfiPciRootBridgeIoProtocolGuid,\r
199 (VOID**)&PciRootBridgeIo);\r
200\r
201 if (EFI_ERROR(Status)) {\r
202 return NULL;\r
203 }\r
204\r
205 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_PH), NULL);\r
8d300003 206 ASSERT (Temp != NULL);\r
f4f3c6bf 207 Temp2 = CatSPrint(L"\r\n", Temp, PciRootBridgeIo->ParentHandle);\r
208 FreePool(Temp);\r
209 RetVal = Temp2;\r
210 Temp2 = NULL;\r
211 \r
212 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_SEG), NULL);\r
8d300003 213 ASSERT (Temp != NULL);\r
f4f3c6bf 214 Temp2 = CatSPrint(RetVal, Temp, PciRootBridgeIo->SegmentNumber);\r
215 FreePool(Temp);\r
216 FreePool(RetVal);\r
217 RetVal = Temp2;\r
218 Temp2 = NULL;\r
219\r
220 Supports = 0;\r
221 Attributes = 0;\r
222 Status = PciRootBridgeIo->GetAttributes (PciRootBridgeIo, &Supports, &Attributes);\r
223 if (!EFI_ERROR(Status)) {\r
224 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_ATT), NULL);\r
8d300003 225 ASSERT (Temp != NULL); \r
f4f3c6bf 226 Temp2 = CatSPrint(RetVal, Temp, Attributes);\r
227 FreePool(Temp);\r
228 FreePool(RetVal);\r
229 RetVal = Temp2;\r
230 Temp2 = NULL;\r
231 \r
232 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_SUPPORTS), NULL);\r
8d300003 233 ASSERT (Temp != NULL);\r
f4f3c6bf 234 Temp2 = CatSPrint(RetVal, Temp, Supports);\r
235 FreePool(Temp);\r
236 FreePool(RetVal);\r
237 RetVal = Temp2;\r
238 Temp2 = NULL;\r
239 }\r
240\r
241 Configuration = NULL;\r
242 Status = PciRootBridgeIo->Configuration (PciRootBridgeIo, (VOID **) &Configuration);\r
243 if (!EFI_ERROR(Status) && Configuration != NULL) {\r
244 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_TITLE), NULL);\r
8d300003 245 ASSERT (Temp != NULL);\r
f4f3c6bf 246 Temp2 = CatSPrint(RetVal, Temp, Supports);\r
247 FreePool(Temp);\r
248 FreePool(RetVal);\r
249 RetVal = Temp2;\r
250 Temp2 = NULL;\r
251 while (Configuration->Desc == ACPI_ADDRESS_SPACE_DESCRIPTOR) {\r
252 Temp = NULL;\r
253 switch (Configuration->ResType) {\r
254 case ACPI_ADDRESS_SPACE_TYPE_MEM:\r
255 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_MEM), NULL);\r
256 break;\r
257 case ACPI_ADDRESS_SPACE_TYPE_IO:\r
258 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_IO), NULL);\r
259 break;\r
260 case ACPI_ADDRESS_SPACE_TYPE_BUS:\r
261 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_PCIRB_DUMP_BUS), NULL);\r
262 break;\r
263 }\r
264 if (Temp != NULL) {\r
265 Temp2 = CatSPrint(RetVal, L"%s", Temp);\r
266 FreePool(Temp);\r
267 FreePool(RetVal);\r
268 RetVal = Temp2;\r
269 Temp2 = NULL;\r
270 }\r
271\r
272 Temp2 = CatSPrint(RetVal, \r
273 L"%H%02x %016lx %016lx %02x%N\r\n",\r
274 Configuration->SpecificFlag,\r
275 Configuration->AddrRangeMin,\r
276 Configuration->AddrRangeMax,\r
277 Configuration->AddrSpaceGranularity\r
278 );\r
279 FreePool(RetVal);\r
280 RetVal = Temp2;\r
281 Temp2 = NULL;\r
282 Configuration++;\r
283 }\r
284 }\r
285 return (RetVal);\r
286}\r
287\r
a405b86d 288/**\r
289 Function to dump information about SimpleTextOut.\r
290\r
291 This will allocate the return buffer from boot services pool.\r
292\r
293 @param[in] TheHandle The handle that has SimpleTextOut installed.\r
294 @param[in] Verbose TRUE for additional information, FALSE otherwise.\r
295\r
296 @retval A poitner to a string containing the information.\r
297**/\r
298CHAR16*\r
299EFIAPI\r
300TxtOutProtocolDumpInformation(\r
301 IN CONST EFI_HANDLE TheHandle,\r
302 IN CONST BOOLEAN Verbose\r
303 )\r
304{\r
305 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *Dev;\r
306 INTN Index;\r
307 UINTN Col;\r
308 UINTN Row;\r
309 EFI_STATUS Status;\r
310 CHAR16 *RetVal;\r
311 UINTN Size;\r
312 CHAR16 *Temp;\r
313 UINTN NewSize;\r
314\r
315 if (!Verbose) {\r
316 return (NULL);\r
317 }\r
318\r
319 RetVal = NULL;\r
320 Size = 0;\r
321\r
322 Status = gBS->HandleProtocol(\r
323 TheHandle,\r
324 &gEfiSimpleTextOutProtocolGuid,\r
325 (VOID**)&Dev);\r
326\r
327 ASSERT_EFI_ERROR(Status);\r
328 ASSERT (Dev != NULL && Dev->Mode != NULL);\r
329\r
330 Size = (Dev->Mode->MaxMode + 1) * 80;\r
331 RetVal = AllocateZeroPool(Size);\r
332\r
333 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_TXT_OUT_DUMP_HEADER), NULL);\r
ecae5117 334 if (Temp != NULL) {\r
335 UnicodeSPrint(RetVal, Size, Temp, Dev, Dev->Mode->Attribute);\r
336 FreePool(Temp);\r
337 }\r
a405b86d 338\r
339 //\r
340 // Dump TextOut Info\r
341 //\r
342 Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_TXT_OUT_DUMP_LINE), NULL);\r
343 for (Index = 0; Index < Dev->Mode->MaxMode; Index++) {\r
344 Status = Dev->QueryMode (Dev, Index, &Col, &Row);\r
345 NewSize = Size - StrSize(RetVal);\r
346 UnicodeSPrint(\r
347 RetVal + StrLen(RetVal),\r
348 NewSize,\r
ecae5117 349 Temp == NULL?L"":Temp,\r
a405b86d 350 Index == Dev->Mode->Mode ? L'*' : L' ',\r
351 Index,\r
352 !EFI_ERROR(Status)?Col:-1,\r
353 !EFI_ERROR(Status)?Row:-1\r
354 );\r
355 }\r
356 FreePool(Temp);\r
357 return (RetVal);\r
358}\r
359\r
360STATIC CONST UINTN VersionStringSize = 60;\r
361\r
362/**\r
363 Function to dump information about EfiDriverSupportedEfiVersion protocol.\r
364\r
365 This will allocate the return buffer from boot services pool.\r
366\r
367 @param[in] TheHandle The handle that has the protocol installed.\r
368 @param[in] Verbose TRUE for additional information, FALSE otherwise.\r
369\r
370 @retval A poitner to a string containing the information.\r
371**/\r
372CHAR16*\r
373EFIAPI\r
374DriverEfiVersionProtocolDumpInformation(\r
375 IN CONST EFI_HANDLE TheHandle,\r
376 IN CONST BOOLEAN Verbose\r
377 )\r
378{\r
379 EFI_DRIVER_SUPPORTED_EFI_VERSION_PROTOCOL *DriverEfiVersion;\r
380 EFI_STATUS Status;\r
381 CHAR16 *RetVal;\r
382\r
383 Status = gBS->HandleProtocol(\r
384 TheHandle,\r
385 &gEfiDriverSupportedEfiVersionProtocolGuid,\r
386 (VOID**)&DriverEfiVersion);\r
387\r
388 ASSERT_EFI_ERROR(Status);\r
389\r
78ed876b 390 RetVal = AllocateZeroPool(VersionStringSize);\r
a405b86d 391 ASSERT(RetVal != NULL);\r
392 UnicodeSPrint(RetVal, VersionStringSize, L"0x%08x", DriverEfiVersion->FirmwareVersion);\r
393 return (RetVal);\r
394}\r
395\r
396/**\r
397 Function to dump information about DevicePath protocol.\r
398\r
399 This will allocate the return buffer from boot services pool.\r
400\r
401 @param[in] TheHandle The handle that has the protocol installed.\r
402 @param[in] Verbose TRUE for additional information, FALSE otherwise.\r
403\r
404 @retval A poitner to a string containing the information.\r
405**/\r
406CHAR16*\r
407EFIAPI\r
408DevicePathProtocolDumpInformation(\r
409 IN CONST EFI_HANDLE TheHandle,\r
410 IN CONST BOOLEAN Verbose\r
411 )\r
412{\r
413 EFI_DEVICE_PATH_PROTOCOL *DevPath;\r
414 CHAR16 *Temp;\r
415 CHAR16 *Temp2;\r
416 EFI_STATUS Status;\r
417 EFI_DEVICE_PATH_TO_TEXT_PROTOCOL *DevPathToText;\r
418 Temp = NULL;\r
419\r
420 Status = gBS->LocateProtocol(&gEfiDevicePathToTextProtocolGuid, NULL, (VOID**)&DevPathToText);\r
421 if (!EFI_ERROR(Status)) {\r
422 Status = gBS->OpenProtocol(TheHandle, &gEfiDevicePathProtocolGuid, (VOID**)&DevPath, gImageHandle, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
423 if (!EFI_ERROR(Status)) {\r
424 //\r
425 // I cannot decide whether to allow shortcuts here (the second BOOLEAN on the next line)\r
426 //\r
427 Temp = DevPathToText->ConvertDevicePathToText(DevPath, TRUE, TRUE);\r
428 gBS->CloseProtocol(TheHandle, &gEfiDevicePathProtocolGuid, gImageHandle, NULL);\r
429 }\r
430 }\r
78ed876b 431 if (!Verbose && Temp != NULL && StrLen(Temp) > 30) {\r
a405b86d 432 Temp2 = NULL;\r
433 Temp2 = StrnCatGrow(&Temp2, NULL, Temp+(StrLen(Temp) - 30), 30);\r
434 FreePool(Temp);\r
435 Temp = Temp2;\r
436 }\r
437 return (Temp);\r
438}\r
439\r
440//\r
441// Put the information on the NT32 protocol GUIDs here so we are not dependant on the Nt32Pkg\r
442//\r
443#define LOCAL_EFI_WIN_NT_THUNK_PROTOCOL_GUID \\r
444 { \\r
445 0x58c518b1, 0x76f3, 0x11d4, 0xbc, 0xea, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 \\r
446 }\r
447\r
448#define LOCAL_EFI_WIN_NT_BUS_DRIVER_IO_PROTOCOL_GUID \\r
449 { \\r
450 0x96eb4ad6, 0xa32a, 0x11d4, 0xbc, 0xfd, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 \\r
451 }\r
452\r
453#define LOCAL_EFI_WIN_NT_SERIAL_PORT_GUID \\r
454 { \\r
455 0xc95a93d, 0xa006, 0x11d4, 0xbc, 0xfa, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 \\r
456 }\r
457STATIC CONST EFI_GUID WinNtThunkProtocolGuid = LOCAL_EFI_WIN_NT_THUNK_PROTOCOL_GUID;\r
458STATIC CONST EFI_GUID WinNtIoProtocolGuid = LOCAL_EFI_WIN_NT_BUS_DRIVER_IO_PROTOCOL_GUID;\r
459STATIC CONST EFI_GUID WinNtSerialPortGuid = LOCAL_EFI_WIN_NT_SERIAL_PORT_GUID;\r
460\r
dee34318 461STATIC CONST GUID_INFO_BLOCK mGuidStringListNT[] = {\r
a405b86d 462 {STRING_TOKEN(STR_WINNT_THUNK), (EFI_GUID*)&WinNtThunkProtocolGuid, NULL},\r
463 {STRING_TOKEN(STR_WINNT_DRIVER_IO), (EFI_GUID*)&WinNtIoProtocolGuid, NULL},\r
464 {STRING_TOKEN(STR_WINNT_SERIAL_PORT), (EFI_GUID*)&WinNtSerialPortGuid, NULL},\r
465 {STRING_TOKEN(STR_UNKNOWN_DEVICE), NULL, NULL},\r
466};\r
467\r
dee34318 468STATIC CONST GUID_INFO_BLOCK mGuidStringList[] = {\r
a405b86d 469 {STRING_TOKEN(STR_LOADED_IMAGE), &gEfiLoadedImageProtocolGuid, NULL},\r
470 {STRING_TOKEN(STR_DEVICE_PATH), &gEfiDevicePathProtocolGuid, DevicePathProtocolDumpInformation},\r
471 {STRING_TOKEN(STR_IMAGE_PATH), &gEfiLoadedImageDevicePathProtocolGuid, DevicePathProtocolDumpInformation},\r
472 {STRING_TOKEN(STR_DEVICE_PATH_UTIL), &gEfiDevicePathUtilitiesProtocolGuid, NULL},\r
473 {STRING_TOKEN(STR_DEVICE_PATH_TXT), &gEfiDevicePathToTextProtocolGuid, NULL},\r
474 {STRING_TOKEN(STR_DEVICE_PATH_FTXT), &gEfiDevicePathFromTextProtocolGuid, NULL},\r
475 {STRING_TOKEN(STR_DEVICE_PATH_PC), &gEfiPcAnsiGuid, NULL},\r
476 {STRING_TOKEN(STR_DEVICE_PATH_VT100), &gEfiVT100Guid, NULL},\r
477 {STRING_TOKEN(STR_DEVICE_PATH_VT100P), &gEfiVT100PlusGuid, NULL},\r
478 {STRING_TOKEN(STR_DEVICE_PATH_VTUTF8), &gEfiVTUTF8Guid, NULL},\r
479 {STRING_TOKEN(STR_DRIVER_BINDING), &gEfiDriverBindingProtocolGuid, NULL},\r
480 {STRING_TOKEN(STR_PLATFORM_OVERRIDE), &gEfiPlatformDriverOverrideProtocolGuid, NULL},\r
481 {STRING_TOKEN(STR_BUS_OVERRIDE), &gEfiBusSpecificDriverOverrideProtocolGuid, NULL},\r
482 {STRING_TOKEN(STR_DRIVER_DIAG), &gEfiDriverDiagnosticsProtocolGuid, NULL},\r
483 {STRING_TOKEN(STR_DRIVER_DIAG2), &gEfiDriverDiagnostics2ProtocolGuid, NULL},\r
484 {STRING_TOKEN(STR_DRIVER_CN), &gEfiComponentNameProtocolGuid, NULL},\r
485 {STRING_TOKEN(STR_DRIVER_CN2), &gEfiComponentName2ProtocolGuid, NULL},\r
486 {STRING_TOKEN(STR_PLAT_DRV_CFG), &gEfiPlatformToDriverConfigurationProtocolGuid, NULL},\r
487 {STRING_TOKEN(STR_DRIVER_VERSION), &gEfiDriverSupportedEfiVersionProtocolGuid, DriverEfiVersionProtocolDumpInformation},\r
488 {STRING_TOKEN(STR_TXT_IN), &gEfiSimpleTextInProtocolGuid, NULL},\r
489 {STRING_TOKEN(STR_TXT_IN_EX), &gEfiSimpleTextInputExProtocolGuid, NULL},\r
490 {STRING_TOKEN(STR_TXT_OUT), &gEfiSimpleTextOutProtocolGuid, TxtOutProtocolDumpInformation},\r
491 {STRING_TOKEN(STR_SIM_POINTER), &gEfiSimplePointerProtocolGuid, NULL},\r
492 {STRING_TOKEN(STR_ABS_POINTER), &gEfiAbsolutePointerProtocolGuid, NULL},\r
493 {STRING_TOKEN(STR_SERIAL_IO), &gEfiSerialIoProtocolGuid, NULL},\r
494 {STRING_TOKEN(STR_GRAPHICS_OUTPUT), &gEfiGraphicsOutputProtocolGuid, NULL},\r
495 {STRING_TOKEN(STR_EDID_DISCOVERED), &gEfiEdidDiscoveredProtocolGuid, NULL},\r
496 {STRING_TOKEN(STR_EDID_ACTIVE), &gEfiEdidActiveProtocolGuid, NULL},\r
497 {STRING_TOKEN(STR_EDID_OVERRIDE), &gEfiEdidOverrideProtocolGuid, NULL},\r
498 {STRING_TOKEN(STR_CON_IN), &gEfiConsoleInDeviceGuid, NULL},\r
499 {STRING_TOKEN(STR_CON_OUT), &gEfiConsoleOutDeviceGuid, NULL},\r
500 {STRING_TOKEN(STR_STD_ERR), &gEfiStandardErrorDeviceGuid, NULL},\r
501 {STRING_TOKEN(STR_LOAD_FILE), &gEfiLoadFileProtocolGuid, NULL},\r
502 {STRING_TOKEN(STR_LOAD_FILE2), &gEfiLoadFile2ProtocolGuid, NULL},\r
503 {STRING_TOKEN(STR_SIMPLE_FILE_SYS), &gEfiSimpleFileSystemProtocolGuid, NULL},\r
a405b86d 504 {STRING_TOKEN(STR_TAPE_IO), &gEfiTapeIoProtocolGuid, NULL},\r
505 {STRING_TOKEN(STR_DISK_IO), &gEfiDiskIoProtocolGuid, NULL},\r
506 {STRING_TOKEN(STR_BLK_IO), &gEfiBlockIoProtocolGuid, NULL},\r
507 {STRING_TOKEN(STR_UC), &gEfiUnicodeCollationProtocolGuid, NULL},\r
508 {STRING_TOKEN(STR_UC2), &gEfiUnicodeCollation2ProtocolGuid, NULL},\r
f4f3c6bf 509 {STRING_TOKEN(STR_PCIRB_IO), &gEfiPciRootBridgeIoProtocolGuid, PciRootBridgeIoDumpInformation},\r
a405b86d 510 {STRING_TOKEN(STR_PCI_IO), &gEfiPciIoProtocolGuid, NULL},\r
511 {STRING_TOKEN(STR_SCSI_PT), &gEfiScsiPassThruProtocolGuid, NULL},\r
512 {STRING_TOKEN(STR_SCSI_IO), &gEfiScsiIoProtocolGuid, NULL},\r
513 {STRING_TOKEN(STR_SCSI_PT_EXT), &gEfiExtScsiPassThruProtocolGuid, NULL},\r
514 {STRING_TOKEN(STR_ISCSI), &gEfiIScsiInitiatorNameProtocolGuid, NULL},\r
515 {STRING_TOKEN(STR_USB_IO), &gEfiUsbIoProtocolGuid, NULL},\r
516 {STRING_TOKEN(STR_USB_HC), &gEfiUsbHcProtocolGuid, NULL},\r
517 {STRING_TOKEN(STR_USB_HC2), &gEfiUsb2HcProtocolGuid, NULL},\r
518 {STRING_TOKEN(STR_DEBUG_SUPPORT), &gEfiDebugSupportProtocolGuid, NULL},\r
519 {STRING_TOKEN(STR_DEBUG_PORT), &gEfiDebugPortProtocolGuid, NULL},\r
520 {STRING_TOKEN(STR_DECOMPRESS), &gEfiDecompressProtocolGuid, NULL},\r
521 {STRING_TOKEN(STR_ACPI_TABLE), &gEfiAcpiTableProtocolGuid, NULL},\r
522 {STRING_TOKEN(STR_EBC_INTERPRETER), &gEfiEbcProtocolGuid, NULL},\r
523 {STRING_TOKEN(STR_SNP), &gEfiSimpleNetworkProtocolGuid, NULL},\r
524 {STRING_TOKEN(STR_NII), &gEfiNetworkInterfaceIdentifierProtocolGuid, NULL},\r
525 {STRING_TOKEN(STR_NII_31), &gEfiNetworkInterfaceIdentifierProtocolGuid_31, NULL},\r
526 {STRING_TOKEN(STR_PXE_BC), &gEfiPxeBaseCodeProtocolGuid, NULL},\r
527 {STRING_TOKEN(STR_PXE_CB), &gEfiPxeBaseCodeCallbackProtocolGuid, NULL},\r
528 {STRING_TOKEN(STR_BIS), &gEfiBisProtocolGuid, NULL},\r
529 {STRING_TOKEN(STR_MNP_SB), &gEfiManagedNetworkServiceBindingProtocolGuid, NULL},\r
530 {STRING_TOKEN(STR_MNP), &gEfiManagedNetworkProtocolGuid, NULL},\r
531 {STRING_TOKEN(STR_ARP_SB), &gEfiArpServiceBindingProtocolGuid, NULL},\r
532 {STRING_TOKEN(STR_ARP), &gEfiArpProtocolGuid, NULL},\r
533 {STRING_TOKEN(STR_DHCPV4_SB), &gEfiDhcp4ServiceBindingProtocolGuid, NULL},\r
534 {STRING_TOKEN(STR_DHCPV4), &gEfiDhcp4ProtocolGuid, NULL},\r
535 {STRING_TOKEN(STR_TCPV4_SB), &gEfiTcp4ServiceBindingProtocolGuid, NULL},\r
536 {STRING_TOKEN(STR_TCPV4), &gEfiTcp4ProtocolGuid, NULL},\r
537 {STRING_TOKEN(STR_IPV4_SB), &gEfiIp4ServiceBindingProtocolGuid, NULL},\r
538 {STRING_TOKEN(STR_IPV4), &gEfiIp4ProtocolGuid, NULL},\r
539 {STRING_TOKEN(STR_IPV4_CFG), &gEfiIp4ConfigProtocolGuid, NULL},\r
540 {STRING_TOKEN(STR_SHELL_PARAMETERS), &gEfiShellParametersProtocolGuid, NULL},\r
541 {STRING_TOKEN(STR_SHELL), &gEfiShellProtocolGuid, NULL},\r
a405b86d 542 {STRING_TOKEN(STR_UDPV4_SB), &gEfiUdp4ServiceBindingProtocolGuid, NULL},\r
543 {STRING_TOKEN(STR_UDPV4), &gEfiUdp4ProtocolGuid, NULL},\r
544 {STRING_TOKEN(STR_MTFTPV4_SB), &gEfiMtftp4ServiceBindingProtocolGuid, NULL},\r
545 {STRING_TOKEN(STR_MTFTPV4), &gEfiMtftp4ProtocolGuid, NULL},\r
546 {STRING_TOKEN(STR_AUTH_INFO), &gEfiAuthenticationInfoProtocolGuid, NULL},\r
547 {STRING_TOKEN(STR_HASH_SB), &gEfiHashServiceBindingProtocolGuid, NULL},\r
548 {STRING_TOKEN(STR_HASH), &gEfiHashProtocolGuid, NULL},\r
549 {STRING_TOKEN(STR_HII_FONT), &gEfiHiiFontProtocolGuid, NULL},\r
550 {STRING_TOKEN(STR_HII_STRING), &gEfiHiiStringProtocolGuid, NULL},\r
551 {STRING_TOKEN(STR_HII_IMAGE), &gEfiHiiImageProtocolGuid, NULL},\r
552 {STRING_TOKEN(STR_HII_DATABASE), &gEfiHiiDatabaseProtocolGuid, NULL},\r
553 {STRING_TOKEN(STR_HII_CONFIG_ROUT), &gEfiHiiConfigRoutingProtocolGuid, NULL},\r
554 {STRING_TOKEN(STR_HII_CONFIG_ACC), &gEfiHiiConfigAccessProtocolGuid, NULL},\r
555 {STRING_TOKEN(STR_HII_FORM_BROWSER2), &gEfiFormBrowser2ProtocolGuid, NULL},\r
dee34318 556 {STRING_TOKEN(STR_DRIVER_FAM_OVERRIDE), &gEfiDriverFamilyOverrideProtocolGuid, NULL},\r
557 {STRING_TOKEN(STR_PCD), &gPcdProtocolGuid, NULL},\r
558 {STRING_TOKEN(STR_TCG), &gEfiTcgProtocolGuid, NULL},\r
559 {STRING_TOKEN(STR_HII_PACKAGE_LIST), &gEfiHiiPackageListProtocolGuid, NULL},\r
560\r
561//\r
562// the ones under this are deprecated by the current UEFI Spec, but may be found anyways...\r
563//\r
a405b86d 564 {STRING_TOKEN(STR_SHELL_INTERFACE), &gEfiShellInterfaceGuid, NULL},\r
565 {STRING_TOKEN(STR_SHELL_ENV2), &gEfiShellEnvironment2Guid, NULL},\r
566 {STRING_TOKEN(STR_SHELL_ENV), &gEfiShellEnvironment2Guid, NULL},\r
567 {STRING_TOKEN(STR_DEVICE_IO), &gEfiDeviceIoProtocolGuid, NULL},\r
568 {STRING_TOKEN(STR_UGA_DRAW), &gEfiUgaDrawProtocolGuid, NULL},\r
569 {STRING_TOKEN(STR_UGA_IO), &gEfiUgaIoProtocolGuid, NULL},\r
570 {STRING_TOKEN(STR_ESP), &gEfiPartTypeSystemPartGuid, NULL},\r
571 {STRING_TOKEN(STR_GPT_NBR), &gEfiPartTypeLegacyMbrGuid, NULL},\r
572 {STRING_TOKEN(STR_DRIVER_CONFIG), &gEfiDriverConfigurationProtocolGuid, NULL},\r
573 {STRING_TOKEN(STR_DRIVER_CONFIG2), &gEfiDriverConfiguration2ProtocolGuid, NULL},\r
dee34318 574\r
575//\r
576// the ones under this are GUID identified structs, not protocols\r
577//\r
578 {STRING_TOKEN(STR_FILE_INFO), &gEfiFileInfoGuid, NULL},\r
579 {STRING_TOKEN(STR_FILE_SYS_INFO), &gEfiFileSystemInfoGuid, NULL},\r
580\r
581//\r
582// the ones under this are misc GUIDS.\r
583//\r
584 {STRING_TOKEN(STR_EFI_GLOBAL_VARIABLE), &gEfiGlobalVariableGuid, NULL},\r
585\r
586//\r
587// UEFI 2.2\r
588//\r
589 {STRING_TOKEN(STR_IP6_SB), &gEfiIp6ServiceBindingProtocolGuid, NULL},\r
590 {STRING_TOKEN(STR_IP6), &gEfiIp6ProtocolGuid, NULL},\r
591 {STRING_TOKEN(STR_IP6_CONFIG), &gEfiIp6ConfigProtocolGuid, NULL},\r
592 {STRING_TOKEN(STR_MTFTP6_SB), &gEfiMtftp6ServiceBindingProtocolGuid, NULL},\r
593 {STRING_TOKEN(STR_MTFTP6), &gEfiMtftp6ProtocolGuid, NULL},\r
594 {STRING_TOKEN(STR_DHCP6_SB), &gEfiDhcp6ServiceBindingProtocolGuid, NULL},\r
595 {STRING_TOKEN(STR_DHCP6), &gEfiDhcp6ProtocolGuid, NULL},\r
596 {STRING_TOKEN(STR_UDP6_SB), &gEfiUdp6ServiceBindingProtocolGuid, NULL},\r
597 {STRING_TOKEN(STR_UDP6), &gEfiUdp6ProtocolGuid, NULL},\r
598 {STRING_TOKEN(STR_TCP6_SB), &gEfiTcp6ServiceBindingProtocolGuid, NULL},\r
599 {STRING_TOKEN(STR_TCP6), &gEfiTcp6ProtocolGuid, NULL},\r
600 {STRING_TOKEN(STR_VLAN_CONFIG), &gEfiVlanConfigProtocolGuid, NULL},\r
601 {STRING_TOKEN(STR_EAP), &gEfiEapProtocolGuid, NULL},\r
602 {STRING_TOKEN(STR_EAP_MGMT), &gEfiEapManagementProtocolGuid, NULL},\r
603 {STRING_TOKEN(STR_FTP4_SB), &gEfiFtp4ServiceBindingProtocolGuid, NULL},\r
604 {STRING_TOKEN(STR_FTP4), &gEfiFtp4ProtocolGuid, NULL},\r
605 {STRING_TOKEN(STR_IP_SEC_CONFIG), &gEfiIpSecConfigProtocolGuid, NULL},\r
606 {STRING_TOKEN(STR_DH), &gEfiDriverHealthProtocolGuid, NULL},\r
607 {STRING_TOKEN(STR_DEF_IMG_LOAD), &gEfiDeferredImageLoadProtocolGuid, NULL},\r
608 {STRING_TOKEN(STR_USER_CRED), &gEfiUserCredentialProtocolGuid, NULL},\r
609 {STRING_TOKEN(STR_USER_MNGR), &gEfiUserManagerProtocolGuid, NULL},\r
610 {STRING_TOKEN(STR_ATA_PASS_THRU), &gEfiAtaPassThruProtocolGuid, NULL},\r
611\r
612//\r
613// UEFI 2.3\r
614//\r
615 {STRING_TOKEN(STR_FW_MGMT), &gEfiFirmwareManagementProtocolGuid, NULL},\r
616 {STRING_TOKEN(STR_IP_SEC), &gEfiIpSecProtocolGuid, NULL},\r
617 {STRING_TOKEN(STR_IP_SEC2), &gEfiIpSec2ProtocolGuid, NULL},\r
618\r
619//\r
620// UEFI 2.3.1\r
621//\r
622 {STRING_TOKEN(STR_KMS), &gEfiKmsProtocolGuid, NULL},\r
623 {STRING_TOKEN(STR_BLK_IO2), &gEfiBlockIo2ProtocolGuid, NULL},\r
624 {STRING_TOKEN(STR_SSC), &gEfiStorageSecurityCommandProtocolGuid, NULL},\r
625 {STRING_TOKEN(STR_UC2), &gEfiUserCredential2ProtocolGuid, NULL},\r
626\r
627//\r
628// terminator\r
629//\r
a405b86d 630 {STRING_TOKEN(STR_UNKNOWN_DEVICE), NULL, NULL},\r
631};\r
632\r
633/**\r
634 Function to get the node for a protocol or struct from it's GUID.\r
635\r
636 if Guid is NULL, then ASSERT.\r
637\r
638 @param[in] Guid The GUID to look for the name of.\r
639\r
640 @return The node.\r
641**/\r
dee34318 642CONST GUID_INFO_BLOCK *\r
a405b86d 643EFIAPI\r
644InternalShellGetNodeFromGuid(\r
645 IN CONST EFI_GUID* Guid\r
646 )\r
647{\r
dee34318 648 CONST GUID_INFO_BLOCK *ListWalker;\r
a405b86d 649\r
650 ASSERT(Guid != NULL);\r
651\r
652 if (PcdGetBool(PcdShellIncludeNtGuids)) {\r
653 for (ListWalker = mGuidStringListNT ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {\r
654 if (CompareGuid(ListWalker->GuidId, Guid)) {\r
655 return (ListWalker);\r
656 }\r
657 }\r
658 }\r
659 for (ListWalker = mGuidStringList ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {\r
660 if (CompareGuid(ListWalker->GuidId, Guid)) {\r
661 return (ListWalker);\r
662 }\r
663 }\r
664 return (ListWalker);\r
665}\r
666\r
667/**\r
668 Function to get the name of a protocol or struct from it's GUID.\r
669\r
670 if Guid is NULL, then ASSERT.\r
671\r
672 @param[in] Guid The GUID to look for the name of.\r
673 @param[in] Lang The language to use.\r
674\r
675 @return pointer to string of the name. The caller\r
676 is responsible to free this memory.\r
677**/\r
678CHAR16*\r
679EFIAPI\r
680GetStringNameFromGuid(\r
681 IN CONST EFI_GUID *Guid,\r
682 IN CONST CHAR8 *Lang OPTIONAL\r
683 )\r
684{\r
dee34318 685 CONST GUID_INFO_BLOCK *Id;\r
a405b86d 686\r
687 Id = InternalShellGetNodeFromGuid(Guid);\r
688 return (HiiGetString(mHandleParsingHiiHandle, Id->StringId, Lang));\r
689}\r
690\r
691/**\r
692 Function to dump protocol information from a handle.\r
693\r
694 This function will return a allocated string buffer containing the\r
695 information. The caller is responsible for freeing the memory.\r
696\r
697 If Guid is NULL, ASSERT().\r
698 If TheHandle is NULL, ASSERT().\r
699\r
700 @param[in] TheHandle The handle to dump information from.\r
701 @param[in] Guid The GUID of the protocol to dump.\r
702 @param[in] Verbose TRUE for extra info. FALSE otherwise.\r
703\r
704 @return The pointer to string.\r
705 @retval NULL An error was encountered.\r
706**/\r
707CHAR16*\r
708EFIAPI\r
709GetProtocolInformationDump(\r
710 IN CONST EFI_HANDLE TheHandle,\r
711 IN CONST EFI_GUID *Guid,\r
712 IN CONST BOOLEAN Verbose\r
713 )\r
714{\r
dee34318 715 CONST GUID_INFO_BLOCK *Id;\r
a405b86d 716\r
717 ASSERT(TheHandle != NULL);\r
718 ASSERT(Guid != NULL);\r
719\r
720 if (TheHandle == NULL || Guid == NULL) {\r
721 return (NULL);\r
722 }\r
723\r
724 Id = InternalShellGetNodeFromGuid(Guid);\r
725 if (Id != NULL && Id->DumpInfo != NULL) {\r
726 return (Id->DumpInfo(TheHandle, Verbose));\r
727 }\r
728 return (NULL);\r
729}\r
730\r
731/**\r
732 Function to get the Guid for a protocol or struct based on it's string name.\r
733\r
734 @param[in] Name The pointer to the string name.\r
735 @param[in] Lang The pointer to the language code.\r
736 @param[in] Guid The pointer to the Guid.\r
737\r
738 @retval EFI_SUCCESS The operation was sucessful.\r
739**/\r
740EFI_STATUS\r
741EFIAPI\r
742GetGuidFromStringName(\r
743 IN CONST CHAR16 *Name,\r
744 IN CONST CHAR8 *Lang OPTIONAL,\r
745 IN EFI_GUID **Guid\r
746 )\r
747{\r
dee34318 748 CONST GUID_INFO_BLOCK *ListWalker;\r
a405b86d 749 CHAR16 *String;\r
750\r
751 ASSERT(Guid != NULL);\r
752 if (Guid == NULL) {\r
753 return (EFI_INVALID_PARAMETER);\r
754 }\r
755 *Guid = NULL;\r
756\r
757 if (PcdGetBool(PcdShellIncludeNtGuids)) {\r
758 for (ListWalker = mGuidStringListNT ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {\r
759 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);\r
760 if (Name != NULL && String != NULL && StrCmp(Name, String)==0) {\r
761 *Guid = ListWalker->GuidId;\r
762 }\r
763 SHELL_FREE_NON_NULL(String);\r
764 if (*Guid != NULL) {\r
765 return (EFI_SUCCESS);\r
766 }\r
767 }\r
768 }\r
769 for (ListWalker = mGuidStringList ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {\r
770 String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);\r
771 if (Name != NULL && String != NULL && StrCmp(Name, String)==0) {\r
772 *Guid = ListWalker->GuidId;\r
773 }\r
774 SHELL_FREE_NON_NULL(String);\r
775 if (*Guid != NULL) {\r
776 return (EFI_SUCCESS);\r
777 }\r
778 }\r
779 return (EFI_NOT_FOUND);\r
780}\r
781\r
36384ceb
ED
782/**\r
783 Get best support language for this driver.\r
784 \r
785 First base on the current platform used language to search,Second base on the \r
786 default language to search. The caller need to free the buffer of the best \r
787 language.\r
788\r
789 @param[in] SupportedLanguages The support languages for this driver.\r
790 @param[in] Iso639Language Whether get language for ISO639.\r
791\r
792 @return The best support language for this driver.\r
793**/\r
794CHAR8 *\r
795GetBestLanguageForDriver (\r
796 IN CONST CHAR8 *SupportedLanguages, \r
797 IN BOOLEAN Iso639Language\r
798 )\r
799{\r
800 CHAR8 *LanguageVariable;\r
801 CHAR8 *BestLanguage;\r
802\r
803 LanguageVariable = GetVariable (Iso639Language ? L"Lang" : L"PlatformLang", &gEfiGlobalVariableGuid);\r
804\r
805 BestLanguage = GetBestLanguage(\r
806 SupportedLanguages,\r
807 Iso639Language,\r
808 (LanguageVariable != NULL) ? LanguageVariable : "",\r
809 Iso639Language ? "en" : "en-US",\r
810 NULL\r
811 );\r
812\r
813 if (LanguageVariable != NULL) {\r
814 FreePool (LanguageVariable);\r
815 }\r
816\r
817 return BestLanguage;\r
818}\r
819\r
a405b86d 820/**\r
821 Function to retrieve the driver name (if possible) from the ComponentName or\r
822 ComponentName2 protocol\r
823\r
824 @param[in] TheHandle The driver handle to get the name of.\r
825 @param[in] Language The language to use.\r
826\r
827 @retval NULL The name could not be found.\r
828 @return A pointer to the string name. Do not de-allocate the memory.\r
829**/\r
830CONST CHAR16*\r
831EFIAPI\r
832GetStringNameFromHandle(\r
833 IN CONST EFI_HANDLE TheHandle,\r
834 IN CONST CHAR8 *Language\r
835 )\r
836{\r
837 EFI_COMPONENT_NAME2_PROTOCOL *CompNameStruct;\r
838 EFI_STATUS Status;\r
839 CHAR16 *RetVal;\r
36384ceb
ED
840 CHAR8 *BestLang;\r
841\r
842 BestLang = NULL;\r
a405b86d 843\r
844 Status = gBS->OpenProtocol(\r
845 TheHandle,\r
846 &gEfiComponentName2ProtocolGuid,\r
847 (VOID**)&CompNameStruct,\r
848 gImageHandle,\r
849 NULL,\r
850 EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
851 if (!EFI_ERROR(Status)) {\r
36384ceb
ED
852 if (Language == NULL) {\r
853 BestLang = GetBestLanguageForDriver (CompNameStruct->SupportedLanguages, FALSE);\r
854 Language = BestLang;\r
855 }\r
a405b86d 856 Status = CompNameStruct->GetDriverName(CompNameStruct, (CHAR8*)Language, &RetVal);\r
36384ceb
ED
857\r
858 if (BestLang != NULL) {\r
859 FreePool (BestLang);\r
860 BestLang = NULL;\r
861 }\r
a405b86d 862 if (!EFI_ERROR(Status)) {\r
863 return (RetVal);\r
864 }\r
865 }\r
866 Status = gBS->OpenProtocol(\r
867 TheHandle,\r
868 &gEfiComponentNameProtocolGuid,\r
869 (VOID**)&CompNameStruct,\r
870 gImageHandle,\r
871 NULL,\r
872 EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
873 if (!EFI_ERROR(Status)) {\r
36384ceb
ED
874 if (Language == NULL) {\r
875 BestLang = GetBestLanguageForDriver (CompNameStruct->SupportedLanguages, FALSE);\r
876 Language = BestLang;\r
877 }\r
a405b86d 878 Status = CompNameStruct->GetDriverName(CompNameStruct, (CHAR8*)Language, &RetVal);\r
36384ceb
ED
879 \r
880 if (BestLang != NULL) {\r
881 FreePool (BestLang);\r
882 }\r
a405b86d 883 if (!EFI_ERROR(Status)) {\r
884 return (RetVal);\r
885 }\r
886 }\r
887 return (NULL);\r
888}\r
889\r
890/**\r
891 Function to initialize the file global mHandleList object for use in\r
892 vonverting handles to index and index to handle.\r
893\r
894 @retval EFI_SUCCESS The operation was successful.\r
895**/\r
896EFI_STATUS\r
897EFIAPI\r
898InternalShellInitHandleList(\r
899 VOID\r
900 )\r
901{\r
902 EFI_STATUS Status;\r
903 EFI_HANDLE *HandleBuffer;\r
904 UINTN HandleCount;\r
905 HANDLE_LIST *ListWalker;\r
906\r
907 if (mHandleList.NextIndex != 0) {\r
908 return EFI_SUCCESS;\r
909 }\r
910 InitializeListHead(&mHandleList.List.Link);\r
911 mHandleList.NextIndex = 1;\r
912 Status = gBS->LocateHandleBuffer (\r
913 AllHandles,\r
914 NULL,\r
915 NULL,\r
916 &HandleCount,\r
917 &HandleBuffer\r
918 );\r
919 ASSERT_EFI_ERROR(Status);\r
920 if (EFI_ERROR(Status)) {\r
921 return (Status);\r
922 }\r
923 for (mHandleList.NextIndex = 1 ; mHandleList.NextIndex <= HandleCount ; mHandleList.NextIndex++){\r
78ed876b 924 ListWalker = AllocateZeroPool(sizeof(HANDLE_LIST));\r
a405b86d 925 ASSERT(ListWalker != NULL);\r
926 ListWalker->TheHandle = HandleBuffer[mHandleList.NextIndex-1];\r
927 ListWalker->TheIndex = mHandleList.NextIndex;\r
928 InsertTailList(&mHandleList.List.Link,&ListWalker->Link);\r
929 }\r
930 FreePool(HandleBuffer);\r
931 return (EFI_SUCCESS);\r
932}\r
933\r
934/**\r
935 Function to retrieve the human-friendly index of a given handle. If the handle\r
936 does not have a index one will be automatically assigned. The index value is valid\r
937 until the termination of the shell application.\r
938\r
939 @param[in] TheHandle The handle to retrieve an index for.\r
940\r
941 @retval 0 A memory allocation failed.\r
942 @return The index of the handle.\r
943\r
944**/\r
945UINTN\r
946EFIAPI\r
947ConvertHandleToHandleIndex(\r
948 IN CONST EFI_HANDLE TheHandle\r
949 )\r
950{\r
951 HANDLE_LIST *ListWalker;\r
78ed876b 952 if (TheHandle == NULL) {\r
953 return 0;\r
954 }\r
a405b86d 955\r
956 InternalShellInitHandleList();\r
957\r
958 for (ListWalker = (HANDLE_LIST*)GetFirstNode(&mHandleList.List.Link)\r
959 ; !IsNull(&mHandleList.List.Link,&ListWalker->Link)\r
960 ; ListWalker = (HANDLE_LIST*)GetNextNode(&mHandleList.List.Link,&ListWalker->Link)\r
961 ){\r
962 if (ListWalker->TheHandle == TheHandle) {\r
963 return (ListWalker->TheIndex);\r
964 }\r
965 }\r
78ed876b 966 ListWalker = AllocateZeroPool(sizeof(HANDLE_LIST));\r
a405b86d 967 ASSERT(ListWalker != NULL);\r
968 ListWalker->TheHandle = TheHandle;\r
969 ListWalker->TheIndex = mHandleList.NextIndex++;\r
970 InsertTailList(&mHandleList.List.Link,&ListWalker->Link);\r
971 return (ListWalker->TheIndex);\r
972}\r
973\r
974\r
975\r
976/**\r
977 Function to retrieve the EFI_HANDLE from the human-friendly index.\r
978\r
979 @param[in] TheIndex The index to retrieve the EFI_HANDLE for.\r
980\r
981 @retval NULL The index was invalid.\r
982 @return The EFI_HANDLE that index represents.\r
983\r
984**/\r
985EFI_HANDLE\r
986EFIAPI\r
987ConvertHandleIndexToHandle(\r
988 IN CONST UINTN TheIndex\r
989 )\r
990{\r
991 HANDLE_LIST *ListWalker;\r
992\r
993 InternalShellInitHandleList();\r
994\r
995 if (TheIndex >= mHandleList.NextIndex) {\r
996 return (NULL);\r
997 }\r
998\r
999 for (ListWalker = (HANDLE_LIST*)GetFirstNode(&mHandleList.List.Link)\r
1000 ; !IsNull(&mHandleList.List.Link,&ListWalker->Link)\r
1001 ; ListWalker = (HANDLE_LIST*)GetNextNode(&mHandleList.List.Link,&ListWalker->Link)\r
1002 ){\r
1003 if (ListWalker->TheIndex == TheIndex) {\r
1004 return (ListWalker->TheHandle);\r
1005 }\r
1006 }\r
1007 return (NULL);\r
1008}\r
1009\r
1010/**\r
1011 Gets all the related EFI_HANDLEs based on the mask supplied.\r
1012\r
1013 This function scans all EFI_HANDLES in the UEFI environment's handle database\r
1014 and returns the ones with the specified relationship (Mask) to the specified\r
1015 controller handle.\r
1016\r
1017 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.\r
1018 If MatchingHandleCount is NULL, then ASSERT.\r
1019\r
1020 If MatchingHandleBuffer is not NULL upon a successful return the memory must be\r
1021 caller freed.\r
1022\r
1023 @param[in] DriverBindingHandle The handle with Driver Binding protocol on it.\r
1024 @param[in] ControllerHandle The handle with Device Path protocol on it.\r
1025 @param[in] MatchingHandleCount The pointer to UINTN that specifies the number of HANDLES in\r
1026 MatchingHandleBuffer.\r
1027 @param[out] MatchingHandleBuffer On a successful return, a buffer of MatchingHandleCount\r
1028 EFI_HANDLEs with a terminating NULL EFI_HANDLE.\r
1029 @param[out] HandleType An array of type information.\r
1030\r
1031 @retval EFI_SUCCESS The operation was successful, and any related handles\r
1032 are in MatchingHandleBuffer.\r
1033 @retval EFI_NOT_FOUND No matching handles were found.\r
1034 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.\r
1035**/\r
1036EFI_STATUS\r
1037EFIAPI\r
1038ParseHandleDatabaseByRelationshipWithType (\r
1039 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL,\r
1040 IN CONST EFI_HANDLE ControllerHandle OPTIONAL,\r
1041 IN UINTN *HandleCount,\r
1042 OUT EFI_HANDLE **HandleBuffer,\r
1043 OUT UINTN **HandleType\r
1044 )\r
1045{\r
1046 EFI_STATUS Status;\r
1047 UINTN HandleIndex;\r
1048 EFI_GUID **ProtocolGuidArray;\r
1049 UINTN ArrayCount;\r
1050 UINTN ProtocolIndex;\r
1051 EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *OpenInfo;\r
1052 UINTN OpenInfoCount;\r
1053 UINTN OpenInfoIndex;\r
1054 UINTN ChildIndex;\r
1055\r
1056 ASSERT(HandleCount != NULL);\r
1057 ASSERT(HandleBuffer != NULL);\r
1058 ASSERT(HandleType != NULL);\r
1059 ASSERT(DriverBindingHandle != NULL || ControllerHandle != NULL);\r
1060\r
1061 *HandleCount = 0;\r
1062 *HandleBuffer = NULL;\r
1063 *HandleType = NULL;\r
1064\r
1065 //\r
1066 // Retrieve the list of all handles from the handle database\r
1067 //\r
1068 Status = gBS->LocateHandleBuffer (\r
1069 AllHandles,\r
1070 NULL,\r
1071 NULL,\r
1072 HandleCount,\r
1073 HandleBuffer\r
1074 );\r
1075 if (EFI_ERROR (Status)) {\r
1076 return (Status);\r
1077 }\r
1078\r
1079 *HandleType = AllocateZeroPool (*HandleCount * sizeof (UINTN));\r
1080 ASSERT(*HandleType != NULL);\r
1081\r
1082 for (HandleIndex = 0; HandleIndex < *HandleCount; HandleIndex++) {\r
1083 //\r
1084 // Retrieve the list of all the protocols on each handle\r
1085 //\r
1086 Status = gBS->ProtocolsPerHandle (\r
1087 (*HandleBuffer)[HandleIndex],\r
1088 &ProtocolGuidArray,\r
1089 &ArrayCount\r
1090 );\r
1091 if (!EFI_ERROR (Status)) {\r
1092\r
1093 for (ProtocolIndex = 0; ProtocolIndex < ArrayCount; ProtocolIndex++) {\r
1094\r
1095 //\r
1096 // Set the bit describing what this handle has\r
1097 //\r
1098 if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiLoadedImageProtocolGuid) ) {\r
1099 (*HandleType)[HandleIndex] |= HR_IMAGE_HANDLE;\r
1100 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverBindingProtocolGuid) ) {\r
1101 (*HandleType)[HandleIndex] |= HR_DRIVER_BINDING_HANDLE;\r
1102 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverConfiguration2ProtocolGuid)) {\r
1103 (*HandleType)[HandleIndex] |= HR_DRIVER_CONFIGURATION_HANDLE;\r
1104 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverConfigurationProtocolGuid) ) {\r
1105 (*HandleType)[HandleIndex] |= HR_DRIVER_CONFIGURATION_HANDLE;\r
1106 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverDiagnostics2ProtocolGuid) ) {\r
1107 (*HandleType)[HandleIndex] |= HR_DRIVER_DIAGNOSTICS_HANDLE;\r
1108 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDriverDiagnosticsProtocolGuid) ) {\r
1109 (*HandleType)[HandleIndex] |= HR_DRIVER_DIAGNOSTICS_HANDLE;\r
1110 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiComponentName2ProtocolGuid) ) {\r
1111 (*HandleType)[HandleIndex] |= HR_COMPONENT_NAME_HANDLE;\r
1112 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiComponentNameProtocolGuid) ) {\r
1113 (*HandleType)[HandleIndex] |= HR_COMPONENT_NAME_HANDLE;\r
1114 } else if (CompareGuid (ProtocolGuidArray[ProtocolIndex], &gEfiDevicePathProtocolGuid) ) {\r
1115 (*HandleType)[HandleIndex] |= HR_DEVICE_HANDLE;\r
1116 } else {\r
1117 DEBUG_CODE_BEGIN();\r
1118 ASSERT((*HandleType)[HandleIndex] == (*HandleType)[HandleIndex]);\r
1119 DEBUG_CODE_END();\r
1120 }\r
1121 //\r
1122 // Retrieve the list of agents that have opened each protocol\r
1123 //\r
1124 Status = gBS->OpenProtocolInformation (\r
1125 (*HandleBuffer)[HandleIndex],\r
1126 ProtocolGuidArray[ProtocolIndex],\r
1127 &OpenInfo,\r
1128 &OpenInfoCount\r
1129 );\r
1130 if (!EFI_ERROR (Status)) {\r
1131 for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
1132 if (DriverBindingHandle != NULL && OpenInfo[OpenInfoIndex].AgentHandle == DriverBindingHandle) {\r
1133 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) == EFI_OPEN_PROTOCOL_BY_DRIVER) {\r
1134 (*HandleType)[HandleIndex] |= (HR_DEVICE_HANDLE | HR_CONTROLLER_HANDLE);\r
1135 }\r
1136 if (ControllerHandle != NULL && (*HandleBuffer)[HandleIndex] == ControllerHandle) {\r
1137 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) == EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {\r
1138 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
1139 if ((*HandleBuffer)[ChildIndex] == OpenInfo[OpenInfoIndex].ControllerHandle) {\r
1140 (*HandleType)[ChildIndex] |= (HR_DEVICE_HANDLE | HR_CHILD_HANDLE);\r
1141 }\r
1142 }\r
1143 }\r
1144 }\r
1145 }\r
1146 if (DriverBindingHandle == NULL && OpenInfo[OpenInfoIndex].ControllerHandle == ControllerHandle) {\r
1147 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_DRIVER) == EFI_OPEN_PROTOCOL_BY_DRIVER) {\r
1148 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
1149 if ((*HandleBuffer)[ChildIndex] == OpenInfo[OpenInfoIndex].AgentHandle) {\r
1150 (*HandleType)[ChildIndex] |= HR_DEVICE_DRIVER;\r
1151 }\r
1152 }\r
1153 }\r
1154 if ((OpenInfo[OpenInfoIndex].Attributes & EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) == EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER) {\r
1155 (*HandleType)[HandleIndex] |= HR_PARENT_HANDLE;\r
1156 for (ChildIndex = 0; ChildIndex < *HandleCount; ChildIndex++) {\r
1157 if ((*HandleBuffer)[ChildIndex] == OpenInfo[OpenInfoIndex].AgentHandle) {\r
1158 (*HandleType)[ChildIndex] |= HR_BUS_DRIVER;\r
1159 }\r
1160 }\r
1161 }\r
1162 }\r
1163 }\r
1164\r
1165 FreePool (OpenInfo);\r
1166 }\r
1167 }\r
1168\r
1169 FreePool (ProtocolGuidArray);\r
1170 }\r
1171 }\r
1172\r
1173 if (EFI_ERROR(Status)) {\r
1174 if (*HandleType != NULL) {\r
1175 FreePool (*HandleType);\r
1176 }\r
1177 if (*HandleBuffer != NULL) {\r
1178 FreePool (*HandleBuffer);\r
1179 }\r
1180\r
1181 *HandleCount = 0;\r
1182 *HandleBuffer = NULL;\r
1183 *HandleType = NULL;\r
1184 }\r
1185\r
1186 return Status;\r
1187}\r
1188\r
1189/**\r
1190 Gets all the related EFI_HANDLEs based on the single EFI_HANDLE and the mask\r
1191 supplied.\r
1192\r
1193 This function will scan all EFI_HANDLES in the UEFI environment's handle database\r
1194 and return all the ones with the specified relationship (Mask) to the specified\r
1195 controller handle.\r
1196\r
1197 If both DriverBindingHandle and ControllerHandle are NULL, then ASSERT.\r
1198 If MatchingHandleCount is NULL, then ASSERT.\r
1199\r
1200 If MatchingHandleBuffer is not NULL upon a sucessful return the memory must be\r
1201 caller freed.\r
1202\r
1203 @param[in] DriverBindingHandle Handle to a object with Driver Binding protocol\r
1204 on it.\r
1205 @param[in] ControllerHandle Handle to a device with Device Path protocol on it.\r
1206 @param[in] Mask Mask of what relationship(s) is desired.\r
1207 @param[in] MatchingHandleCount Poitner to UINTN specifying number of HANDLES in\r
1208 MatchingHandleBuffer.\r
1209 @param[out] MatchingHandleBuffer On a sucessful return a buffer of MatchingHandleCount\r
1210 EFI_HANDLEs and a terminating NULL EFI_HANDLE.\r
1211\r
1212 @retval EFI_SUCCESS The operation was sucessful and any related handles\r
1213 are in MatchingHandleBuffer;\r
1214 @retval EFI_NOT_FOUND No matching handles were found.\r
1215 @retval EFI_INVALID_PARAMETER A parameter was invalid or out of range.\r
1216**/\r
1217EFI_STATUS\r
1218EFIAPI\r
1219ParseHandleDatabaseByRelationship (\r
1220 IN CONST EFI_HANDLE DriverBindingHandle OPTIONAL,\r
1221 IN CONST EFI_HANDLE ControllerHandle OPTIONAL,\r
1222 IN CONST UINTN Mask,\r
1223 IN UINTN *MatchingHandleCount,\r
1224 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL\r
1225 )\r
1226{\r
1227 EFI_STATUS Status;\r
1228 UINTN HandleCount;\r
1229 EFI_HANDLE *HandleBuffer;\r
1230 UINTN *HandleType;\r
1231 UINTN HandleIndex;\r
1232\r
1233 ASSERT(MatchingHandleCount != NULL);\r
1234 ASSERT(DriverBindingHandle != NULL || ControllerHandle != NULL);\r
1235\r
1236 if ((Mask & HR_VALID_MASK) != Mask) {\r
1237 return (EFI_INVALID_PARAMETER);\r
1238 }\r
1239\r
1240 if ((Mask & HR_CHILD_HANDLE) != 0 && DriverBindingHandle == NULL) {\r
1241 return (EFI_INVALID_PARAMETER);\r
1242 }\r
1243\r
1244 *MatchingHandleCount = 0;\r
1245 if (MatchingHandleBuffer != NULL) {\r
1246 *MatchingHandleBuffer = NULL;\r
1247 }\r
1248\r
1249 HandleBuffer = NULL;\r
1250 HandleType = NULL;\r
1251\r
1252 Status = ParseHandleDatabaseByRelationshipWithType (\r
1253 DriverBindingHandle,\r
1254 ControllerHandle,\r
1255 &HandleCount,\r
1256 &HandleBuffer,\r
1257 &HandleType\r
1258 );\r
1259 if (!EFI_ERROR (Status)) {\r
1260 //\r
1261 // Count the number of handles that match the attributes in Mask\r
1262 //\r
1263 for (HandleIndex = 0; HandleIndex < HandleCount; HandleIndex++) {\r
1264 if ((HandleType[HandleIndex] & Mask) == Mask) {\r
1265 (*MatchingHandleCount)++;\r
1266 }\r
1267 }\r
1268 //\r
1269 // If no handles match the attributes in Mask then return EFI_NOT_FOUND\r
1270 //\r
1271 if (*MatchingHandleCount == 0) {\r
1272 Status = EFI_NOT_FOUND;\r
1273 } else {\r
1274\r
1275 if (MatchingHandleBuffer == NULL) {\r
1276 //\r
1277 // Someone just wanted the count...\r
1278 //\r
1279 Status = EFI_SUCCESS;\r
1280 } else {\r
1281 //\r
1282 // Allocate a handle buffer for the number of handles that matched the attributes in Mask\r
1283 //\r
78ed876b 1284 *MatchingHandleBuffer = AllocateZeroPool ((*MatchingHandleCount +1)* sizeof (EFI_HANDLE));\r
a405b86d 1285 ASSERT(*MatchingHandleBuffer != NULL);\r
1286\r
1287 for (HandleIndex = 0,*MatchingHandleCount = 0\r
1288 ; HandleIndex < HandleCount\r
1289 ; HandleIndex++\r
1290 ){\r
1291 //\r
1292 // Fill the allocated buffer with the handles that matched the attributes in Mask\r
1293 //\r
1294 if ((HandleType[HandleIndex] & Mask) == Mask) {\r
1295 (*MatchingHandleBuffer)[(*MatchingHandleCount)++] = HandleBuffer[HandleIndex];\r
1296 }\r
1297 }\r
1298\r
1299 //\r
1300 // Make the last one NULL\r
1301 //\r
1302 (*MatchingHandleBuffer)[*MatchingHandleCount] = NULL;\r
1303\r
1304 Status = EFI_SUCCESS;\r
1305 } // MacthingHandleBuffer == NULL (ELSE)\r
1306 } // *MatchingHandleCount == 0 (ELSE)\r
1307 } // no error on ParseHandleDatabaseByRelationshipWithType\r
1308\r
1309 if (HandleBuffer != NULL) {\r
1310 FreePool (HandleBuffer);\r
1311 }\r
1312\r
1313 if (HandleType != NULL) {\r
1314 FreePool (HandleType);\r
1315 }\r
1316\r
1317 return Status;\r
1318}\r
1319\r
1320/**\r
1321 Gets handles for any child controllers of the passed in controller.\r
1322\r
1323 @param[in] ControllerHandle The handle of the "parent controller"\r
1324 @param[in] MatchingHandleCount Pointer to the number of handles in\r
1325 MatchingHandleBuffer on return.\r
1326 @param[out] MatchingHandleBuffer Buffer containing handles on a successful\r
1327 return.\r
1328\r
1329\r
1330 @retval EFI_SUCCESS The operation was sucessful.\r
1331**/\r
1332EFI_STATUS\r
1333EFIAPI\r
1334ParseHandleDatabaseForChildControllers(\r
1335 IN CONST EFI_HANDLE ControllerHandle,\r
1336 IN UINTN *MatchingHandleCount,\r
1337 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL\r
1338 )\r
1339{\r
1340 EFI_STATUS Status;\r
78ed876b 1341// UINTN HandleIndex;\r
a405b86d 1342 UINTN DriverBindingHandleCount;\r
1343 EFI_HANDLE *DriverBindingHandleBuffer;\r
1344 UINTN DriverBindingHandleIndex;\r
1345 UINTN ChildControllerHandleCount;\r
1346 EFI_HANDLE *ChildControllerHandleBuffer;\r
1347 UINTN ChildControllerHandleIndex;\r
78ed876b 1348// BOOLEAN Found;\r
a405b86d 1349 EFI_HANDLE *HandleBufferForReturn;\r
1350\r
ff51746b 1351 if (MatchingHandleCount == NULL) {\r
1352 return (EFI_INVALID_PARAMETER);\r
1353 }\r
64d753f1 1354 *MatchingHandleCount = 0;\r
a405b86d 1355\r
1356 Status = PARSE_HANDLE_DATABASE_UEFI_DRIVERS (\r
1357 ControllerHandle,\r
1358 &DriverBindingHandleCount,\r
1359 &DriverBindingHandleBuffer\r
1360 );\r
1361 if (EFI_ERROR (Status)) {\r
1362 return Status;\r
1363 }\r
1364\r
ff51746b 1365 //\r
1366 // Get a buffer big enough for all the controllers.\r
1367 //\r
1368 HandleBufferForReturn = GetHandleListByProtocol(&gEfiDevicePathProtocolGuid);\r
a405b86d 1369 if (HandleBufferForReturn == NULL) {\r
1370 FreePool (DriverBindingHandleBuffer);\r
ff51746b 1371 return (EFI_NOT_FOUND);\r
a405b86d 1372 }\r
1373\r
a405b86d 1374 for (DriverBindingHandleIndex = 0; DriverBindingHandleIndex < DriverBindingHandleCount; DriverBindingHandleIndex++) {\r
1375 Status = PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (\r
1376 DriverBindingHandleBuffer[DriverBindingHandleIndex],\r
1377 ControllerHandle,\r
1378 &ChildControllerHandleCount,\r
1379 &ChildControllerHandleBuffer\r
1380 );\r
1381 if (EFI_ERROR (Status)) {\r
1382 continue;\r
1383 }\r
1384\r
1385 for (ChildControllerHandleIndex = 0;\r
1386 ChildControllerHandleIndex < ChildControllerHandleCount;\r
1387 ChildControllerHandleIndex++\r
1388 ) {\r
78ed876b 1389// Found = FALSE;\r
1390 HandleBufferForReturn[(*MatchingHandleCount)++] = ChildControllerHandleBuffer[ChildControllerHandleIndex];\r
1391// for (HandleIndex = 0; HandleBufferForReturn[HandleIndex] != NULL; HandleIndex++) {\r
1392// if (HandleBufferForReturn[HandleIndex] == ChildControllerHandleBuffer[ChildControllerHandleIndex]) {\r
1393// Found = TRUE;\r
1394// break;\r
1395// }\r
1396// }\r
1397\r
1398// if (Found) {\r
1399// HandleBufferForReturn[(*MatchingHandleCount)++] = ChildControllerHandleBuffer[ChildControllerHandleIndex];\r
1400// }\r
a405b86d 1401 }\r
1402\r
1403 FreePool (ChildControllerHandleBuffer);\r
1404 }\r
1405\r
1406 FreePool (DriverBindingHandleBuffer);\r
1407\r
1408 if (MatchingHandleBuffer != NULL) {\r
1409 *MatchingHandleBuffer = HandleBufferForReturn;\r
1410 } else {\r
1411 FreePool(HandleBufferForReturn);\r
1412 }\r
1413\r
1414 return (EFI_SUCCESS);\r
1415}\r
1416\r
1417/**\r
1418 Appends 1 buffer to another buffer. This will re-allocate the destination buffer\r
1419 if necessary to fit all of the data.\r
1420\r
1421 If DestinationBuffer is NULL, then ASSERT().\r
1422\r
4ff7e37b
ED
1423 @param[in, out] DestinationBuffer The pointer to the pointer to the buffer to append onto.\r
1424 @param[in, out] DestinationSize The pointer to the size of DestinationBuffer.\r
1425 @param[in] SourceBuffer The pointer to the buffer to append onto DestinationBuffer.\r
1426 @param[in] SourceSize The number of bytes of SourceBuffer to append.\r
a405b86d 1427\r
1428 @retval NULL A memory allocation failed.\r
1429 @retval NULL A parameter was invalid.\r
1430 @return A pointer to (*DestinationBuffer).\r
1431**/\r
1432VOID*\r
1433EFIAPI\r
1434BuffernCatGrow (\r
1435 IN OUT VOID **DestinationBuffer,\r
1436 IN OUT UINTN *DestinationSize,\r
1437 IN VOID *SourceBuffer,\r
1438 IN UINTN SourceSize\r
1439 )\r
1440{\r
1441 UINTN LocalDestinationSize;\r
1442 UINTN LocalDestinationFinalSize;\r
1443\r
1444 ASSERT(DestinationBuffer != NULL);\r
1445\r
1446 if (SourceSize == 0 || SourceBuffer == NULL) {\r
1447 return (*DestinationBuffer);\r
1448 }\r
1449\r
1450 if (DestinationSize == NULL) {\r
1451 LocalDestinationSize = 0;\r
1452 } else {\r
1453 LocalDestinationSize = *DestinationSize;\r
1454 }\r
1455\r
1456 LocalDestinationFinalSize = LocalDestinationSize + SourceSize;\r
1457\r
1458 if (DestinationSize != NULL) {\r
1459 *DestinationSize = LocalDestinationSize;\r
1460 }\r
1461\r
1462 if (LocalDestinationSize == 0) {\r
1463 // allcoate\r
78ed876b 1464 *DestinationBuffer = AllocateZeroPool(LocalDestinationFinalSize);\r
a405b86d 1465 } else {\r
1466 // reallocate\r
1467 *DestinationBuffer = ReallocatePool(LocalDestinationSize, LocalDestinationFinalSize, *DestinationBuffer);\r
1468 }\r
1469\r
1470 ASSERT(*DestinationBuffer != NULL);\r
1471\r
1472 // copy\r
1473 return (CopyMem(((UINT8*)(*DestinationBuffer)) + LocalDestinationSize, SourceBuffer, SourceSize));\r
1474}\r
1475\r
1476/**\r
1477 Gets handles for any child devices produced by the passed in driver.\r
1478\r
1479 @param[in] DriverHandle The handle of the driver.\r
1480 @param[in] MatchingHandleCount Pointer to the number of handles in\r
1481 MatchingHandleBuffer on return.\r
1482 @param[out] MatchingHandleBuffer Buffer containing handles on a successful\r
1483 return.\r
1484 @retval EFI_SUCCESS The operation was sucessful.\r
1485 @sa ParseHandleDatabaseByRelationship\r
1486**/\r
1487EFI_STATUS\r
1488EFIAPI\r
1489ParseHandleDatabaseForChildDevices(\r
1490 IN CONST EFI_HANDLE DriverHandle,\r
1491 IN UINTN *MatchingHandleCount,\r
1492 OUT EFI_HANDLE **MatchingHandleBuffer OPTIONAL\r
1493 )\r
1494{\r
1495 EFI_HANDLE *Buffer;\r
1496 EFI_HANDLE *Buffer2;\r
1497 UINTN Count1;\r
1498 UINTN Count2;\r
1499 UINTN HandleIndex;\r
1500 EFI_STATUS Status;\r
1501 UINTN HandleBufferSize;\r
1502\r
1503 ASSERT(MatchingHandleCount != NULL);\r
1504\r
1505 HandleBufferSize = 0;\r
1506 Buffer = NULL;\r
1507 Buffer2 = NULL;\r
1508 *MatchingHandleCount = 0;\r
1509\r
1510 Status = PARSE_HANDLE_DATABASE_DEVICES (\r
1511 DriverHandle,\r
1512 &Count1,\r
1513 &Buffer\r
1514 );\r
1515 if (!EFI_ERROR (Status)) {\r
1516 for (HandleIndex = 0; HandleIndex < Count1; HandleIndex++) {\r
1517 //\r
1518 // now find the children\r
1519 //\r
1520 Status = PARSE_HANDLE_DATABASE_MANAGED_CHILDREN (\r
1521 DriverHandle,\r
1522 Buffer[HandleIndex],\r
1523 &Count2,\r
1524 &Buffer2\r
1525 );\r
1526 if (EFI_ERROR(Status)) {\r
1527 break;\r
1528 }\r
1529 //\r
1530 // save out required and optional data elements\r
1531 //\r
1532 *MatchingHandleCount += Count2;\r
1533 if (MatchingHandleBuffer != NULL) {\r
1534 *MatchingHandleBuffer = BuffernCatGrow((VOID**)MatchingHandleBuffer, &HandleBufferSize, Buffer2, Count2 * sizeof(Buffer2[0]));\r
1535 }\r
1536\r
1537 //\r
1538 // free the memory\r
1539 //\r
1540 if (Buffer2 != NULL) {\r
1541 FreePool(Buffer2);\r
1542 }\r
1543 }\r
1544 }\r
1545\r
1546 if (Buffer != NULL) {\r
1547 FreePool(Buffer);\r
1548 }\r
1549 return (Status);\r
1550}\r
1551\r
1552/**\r
1553 Function to get all handles that support a given protocol or all handles.\r
1554\r
1555 @param[in] ProtocolGuid The guid of the protocol to get handles for. If NULL\r
1556 then the function will return all handles.\r
1557\r
1558 @retval NULL A memory allocation failed.\r
1559 @return A NULL terminated list of handles.\r
1560**/\r
1561EFI_HANDLE*\r
1562EFIAPI\r
40d7a9cf 1563GetHandleListByProtocol (\r
a405b86d 1564 IN CONST EFI_GUID *ProtocolGuid OPTIONAL\r
1565 )\r
1566{\r
1567 EFI_HANDLE *HandleList;\r
1568 UINTN Size;\r
1569 EFI_STATUS Status;\r
1570\r
1571 Size = 0;\r
1572 HandleList = NULL;\r
1573\r
1574 //\r
1575 // We cannot use LocateHandleBuffer since we need that NULL item on the ends of the list!\r
1576 //\r
1577 if (ProtocolGuid == NULL) {\r
1578 Status = gBS->LocateHandle(AllHandles, NULL, NULL, &Size, HandleList);\r
1579 if (Status == EFI_BUFFER_TOO_SMALL) {\r
78ed876b 1580 HandleList = AllocateZeroPool(Size + sizeof(EFI_HANDLE));\r
40d7a9cf 1581 if (HandleList == NULL) {\r
1582 return (NULL);\r
1583 }\r
a405b86d 1584 Status = gBS->LocateHandle(AllHandles, NULL, NULL, &Size, HandleList);\r
1585 HandleList[Size/sizeof(EFI_HANDLE)] = NULL;\r
1586 }\r
1587 } else {\r
1588 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)ProtocolGuid, NULL, &Size, HandleList);\r
1589 if (Status == EFI_BUFFER_TOO_SMALL) {\r
78ed876b 1590 HandleList = AllocateZeroPool(Size + sizeof(EFI_HANDLE));\r
40d7a9cf 1591 if (HandleList == NULL) {\r
1592 return (NULL);\r
1593 }\r
a405b86d 1594 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)ProtocolGuid, NULL, &Size, HandleList);\r
1595 HandleList[Size/sizeof(EFI_HANDLE)] = NULL;\r
1596 }\r
1597 }\r
1598 if (EFI_ERROR(Status)) {\r
1599 if (HandleList != NULL) {\r
1600 FreePool(HandleList);\r
1601 }\r
1602 return (NULL);\r
1603 }\r
1604 return (HandleList);\r
1605}\r
1606\r
1607/**\r
1608 Function to get all handles that support some protocols.\r
1609\r
1610 @param[in] ProtocolGuids A NULL terminated list of protocol GUIDs.\r
1611\r
1612 @retval NULL A memory allocation failed.\r
ff51746b 1613 @retval NULL ProtocolGuids was NULL.\r
1614 @return A NULL terminated list of EFI_HANDLEs.\r
a405b86d 1615**/\r
1616EFI_HANDLE*\r
1617EFIAPI\r
40d7a9cf 1618GetHandleListByProtocolList (\r
a405b86d 1619 IN CONST EFI_GUID **ProtocolGuids\r
1620 )\r
1621{\r
1622 EFI_HANDLE *HandleList;\r
1623 UINTN Size;\r
1624 UINTN TotalSize;\r
40d7a9cf 1625 UINTN TempSize;\r
a405b86d 1626 EFI_STATUS Status;\r
1627 CONST EFI_GUID **GuidWalker;\r
1628 EFI_HANDLE *HandleWalker1;\r
1629 EFI_HANDLE *HandleWalker2;\r
1630\r
1631 Size = 0;\r
1632 HandleList = NULL;\r
1633 TotalSize = sizeof(EFI_HANDLE);\r
1634\r
1635 for (GuidWalker = ProtocolGuids ; GuidWalker != NULL && *GuidWalker != NULL ; GuidWalker++,Size = 0){\r
1636 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)(*GuidWalker), NULL, &Size, NULL);\r
1637 if (Status == EFI_BUFFER_TOO_SMALL) {\r
1638 TotalSize += Size;\r
1639 }\r
1640 }\r
40d7a9cf 1641\r
1642 //\r
1643 // No handles were found... \r
1644 //\r
1645 if (TotalSize == sizeof(EFI_HANDLE)) {\r
1646 return (NULL);\r
1647 }\r
1648\r
1649 HandleList = AllocateZeroPool(TotalSize);\r
a405b86d 1650 if (HandleList == NULL) {\r
1651 return (NULL);\r
1652 }\r
1653\r
1654 Size = 0;\r
1655 for (GuidWalker = ProtocolGuids ; GuidWalker != NULL && *GuidWalker != NULL ; GuidWalker++){\r
40d7a9cf 1656 TempSize = TotalSize - Size;\r
ff51746b 1657 Status = gBS->LocateHandle(ByProtocol, (EFI_GUID*)(*GuidWalker), NULL, &TempSize, HandleList+(Size/sizeof(EFI_HANDLE)));\r
40d7a9cf 1658\r
1659 //\r
1660 // Allow for missing protocols... Only update the 'used' size upon success.\r
1661 //\r
1662 if (!EFI_ERROR(Status)) {\r
ff51746b 1663 Size += TempSize;\r
40d7a9cf 1664 }\r
a405b86d 1665 }\r
ff51746b 1666 ASSERT(HandleList[(TotalSize/sizeof(EFI_HANDLE))-1] == NULL);\r
a405b86d 1667\r
1668 for (HandleWalker1 = HandleList ; HandleWalker1 != NULL && *HandleWalker1 != NULL ; HandleWalker1++) {\r
1669 for (HandleWalker2 = HandleWalker1 + 1; HandleWalker2 != NULL && *HandleWalker2 != NULL ; HandleWalker2++) {\r
1670 if (*HandleWalker1 == *HandleWalker2) {\r
1671 //\r
1672 // copy memory back 1 handle width.\r
1673 //\r
1674 CopyMem(HandleWalker2, HandleWalker2 + 1, TotalSize - ((HandleWalker2-HandleList+1)*sizeof(EFI_HANDLE)));\r
1675 }\r
1676 }\r
1677 }\r
1678\r
1679 return (HandleList);\r
1680}\r
1681\r
1682\r
1683\r
1684\r
1685\r
1686\r
1687\r
1688\r
1689\r
1690\r