]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Application/PlatOverMngr/PlatOverMngr.c
Remove unreferenced library class.
[mirror_edk2.git] / MdeModulePkg / Application / PlatOverMngr / PlatOverMngr.c
CommitLineData
a6f164a7 1/** @file\r
2\r
9bc88ad8 3 A UI application to offer a UI interface in device manager to let user configure\r
a6f164a7 4 platform override protocol to override the default algorithm for matching\r
5 drivers to controllers.\r
6\r
7 The main flow:\r
68dbca6c
LG
8 1. The UI application dynamicly locate all controller device path.\r
9 2. The UI application dynamicly locate all drivers which support binding protocol.\r
10 3. The UI application export and dynamicly update two menu to let user select the\r
a6f164a7 11 mapping between drivers to controllers.\r
68dbca6c 12 4. The UI application save all the mapping info in NV variables which will be consumed\r
a6f164a7 13 by platform override protocol driver to publish the platform override protocol.\r
14\r
e5618791
LG
15Copyright (c) 2007 - 2008, Intel Corporation\r
16All rights reserved. This program and the accompanying materials\r
17are licensed and made available under the terms and conditions of the BSD License\r
18which accompanies this distribution. The full text of the license may be found at\r
19http://opensource.org/licenses/bsd-license.php\r
20\r
21THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
22WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
23\r
a6f164a7 24**/\r
25\r
68dbca6c
LG
26#include <PiDxe.h>\r
27\r
28#include <Protocol/HiiConfigAccess.h>\r
29#include <Protocol/HiiConfigRouting.h>\r
30#include <Protocol/HiiDatabase.h>\r
31#include <Protocol/FormBrowser2.h>\r
32#include <Protocol/LoadedImage.h>\r
33#include <Protocol/FirmwareVolume2.h>\r
34#include <Protocol/PciIo.h>\r
35#include <Protocol/BusSpecificDriverOverride.h>\r
36#include <Protocol/ComponentName2.h>\r
37#include <Protocol/ComponentName.h>\r
38#include <Protocol/DriverBinding.h>\r
87fbccbe 39#include <Protocol/DevicePathToText.h>\r
b9982883 40#include <Guid/GlobalVariable.h>\r
68dbca6c
LG
41\r
42#include <Library/BaseLib.h>\r
43#include <Library/DebugLib.h>\r
44#include <Library/UefiLib.h>\r
45#include <Library/UefiApplicationEntryPoint.h>\r
46#include <Library/UefiBootServicesTableLib.h>\r
e4b99ad9 47#include <Library/PlatformDriverOverrideLib.h>\r
68dbca6c
LG
48#include <Library/HiiLib.h>\r
49#include <Library/IfrSupportLib.h>\r
50#include <Library/ExtendedHiiLib.h>\r
51#include <Library/ExtendedIfrSupportLib.h>\r
52#include <Library/BaseMemoryLib.h>\r
53#include <Library/MemoryAllocationLib.h>\r
54#include <Library/UefiRuntimeServicesTableLib.h>\r
55#include <Library/DevicePathLib.h>\r
a6f164a7 56#include "PlatOverMngr.h"\r
57\r
68dbca6c
LG
58#define EFI_CALLBACK_INFO_SIGNATURE SIGNATURE_32 ('C', 'l', 'b', 'k')\r
59#define EFI_CALLBACK_INFO_FROM_THIS(a) CR (a, EFI_CALLBACK_INFO, ConfigAccess, EFI_CALLBACK_INFO_SIGNATURE)\r
60\r
61typedef struct {\r
62 UINTN Signature;\r
63 EFI_HANDLE DriverHandle;\r
64 EFI_HII_HANDLE RegisteredHandle;\r
65 PLAT_OVER_MNGR_DATA FakeNvData;\r
66 EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;\r
67 EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccess;\r
68} EFI_CALLBACK_INFO;\r
69\r
70//\r
71// uni string and Vfr Binary data.\r
72//\r
73extern UINT8 VfrBin[];\r
74extern UINT8 PlatOverMngrStrings[];\r
75\r
76//\r
77// module global data\r
78//\r
79EFI_GUID mPlatformOverridesManagerGuid = PLAT_OVER_MNGR_GUID;\r
80LIST_ENTRY mMappingDataBase = INITIALIZE_LIST_HEAD_VARIABLE (mMappingDataBase);\r
81\r
82EFI_HANDLE *mDevicePathHandleBuffer;\r
83EFI_HANDLE *mDriverImageHandleBuffer;\r
84\r
db0bd81c 85INTN mSelectedCtrIndex;\r
68dbca6c 86EFI_STRING_ID mControllerToken[MAX_CHOICE_NUM];\r
fe1e36e5 87UINTN mDriverImageHandleCount;\r
88EFI_STRING_ID mDriverImageToken[MAX_CHOICE_NUM];\r
89EFI_STRING_ID mDriverImageFilePathToken[MAX_CHOICE_NUM];\r
90EFI_LOADED_IMAGE_PROTOCOL *mDriverImageProtocol[MAX_CHOICE_NUM];\r
91EFI_DEVICE_PATH_PROTOCOL *mControllerDevicePathProtocol[MAX_CHOICE_NUM];\r
92UINTN mSelectedDriverImageNum;\r
93UINTN mLastSavedDriverImageNum;\r
94CHAR8 mLanguage[RFC_3066_ENTRY_SIZE];\r
95UINT16 mCurrentPage;\r
a6f164a7 96\r
87fbccbe 97/**\r
98 Converting a given device to an unicode string. \r
99 \r
100 This function will dependent on gEfiDevicePathToTextProtocolGuid, if protocol\r
101 does not installed, then return unknown device path L"?" directly.\r
102 \r
103 @param DevPath Given device path instance\r
104 \r
105 @return Converted string from given device path.\r
106 @retval L"?" Can not locate gEfiDevicePathToTextProtocolGuid protocol for converting.\r
107**/\r
108CHAR16 *\r
109DevicePathToStr (\r
110 IN EFI_DEVICE_PATH_PROTOCOL *DevPath\r
111 );\r
112\r
a6f164a7 113/**\r
68dbca6c
LG
114 Do string convertion for the ComponentName supported language. It do\r
115 the convertion just for english language code from RFC 3066 to ISO 639-2.\r
116 Then it will check whether the converted language is in the supported language list.\r
117 If not supported, NULL is returned.\r
118 If Language is not english, NULL is returned.\r
a6f164a7 119\r
68dbca6c
LG
120 @param SupportedLanguages Pointer to ComponentName supported language string list. ISO 639-2 language\r
121 @param Language The language string. RFC 3066 language\r
a6f164a7 122\r
68dbca6c
LG
123 @return English language string (ISO 639-2)\r
124 @return NULL if the conertion is not successful.\r
a6f164a7 125\r
126**/\r
127CHAR8 *\r
68dbca6c
LG
128ConvertComponentNameSupportLanguage (\r
129 IN CHAR8 *SupportedLanguages,\r
a6f164a7 130 IN CHAR8 *Language\r
131 )\r
132{\r
e5618791
LG
133 CHAR8 *LangCode;\r
134 LangCode = NULL;\r
a6f164a7 135\r
136 //\r
e5618791 137 // Check the input language is English\r
a6f164a7 138 //\r
68dbca6c
LG
139 if (AsciiStrnCmp (Language, "en-", 3) != 0) {\r
140 return NULL;\r
a6f164a7 141 }\r
68dbca6c 142 \r
a6f164a7 143 //\r
e5618791 144 // Check SupportedLanguages format\r
a6f164a7 145 //\r
e5618791
LG
146 if (AsciiStrStr (SupportedLanguages, "en-") != NULL) {\r
147 //\r
148 // Create RFC 3066 language\r
149 //\r
150 LangCode = AllocateZeroPool(AsciiStrSize (Language));\r
151 AsciiStrCpy (LangCode, Language);\r
152 } else if (AsciiStrStr (SupportedLanguages, "en") != NULL) {\r
153 //\r
154 // Create ISO 639-2 Language\r
155 //\r
156 LangCode = AllocateZeroPool(4);\r
157 AsciiStrCpy (LangCode, "eng"); \r
a6f164a7 158 }\r
e5618791 159 \r
a6f164a7 160 return LangCode;\r
161}\r
162\r
163/**\r
68dbca6c
LG
164 Get the driver name by ComponentName or ComponentName2 protocol \r
165 according to the driver binding handle\r
a6f164a7 166\r
167 @param DriverBindingHandle The Handle of DriverBinding.\r
168\r
169 @retval !NULL Pointer into the image name if the image name is found,\r
170 @retval NULL Pointer to NULL if the image name is not found.\r
171\r
172**/\r
173CHAR16 *\r
174GetComponentName (\r
175 IN EFI_HANDLE DriverBindingHandle\r
176 )\r
177{\r
178 EFI_STATUS Status;\r
179 EFI_COMPONENT_NAME_PROTOCOL *ComponentName;\r
180 EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2;\r
181 CHAR8 *SupportedLanguage;\r
182 CHAR16 *DriverName;\r
183\r
184 ComponentName = NULL;\r
185 ComponentName2 = NULL;\r
186 Status = gBS->OpenProtocol (\r
187 DriverBindingHandle,\r
188 &gEfiComponentName2ProtocolGuid,\r
189 (VOID **) &ComponentName2,\r
190 NULL,\r
191 NULL,\r
192 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
193 );\r
194 if (EFI_ERROR(Status)) {\r
195 Status = gBS->OpenProtocol (\r
196 DriverBindingHandle,\r
197 &gEfiComponentNameProtocolGuid,\r
198 (VOID **) &ComponentName,\r
199 NULL,\r
200 NULL,\r
201 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
202 );\r
203 }\r
204\r
205 Status = EFI_SUCCESS;\r
206 DriverName = NULL;\r
207 if (ComponentName != NULL) {\r
208 if (ComponentName->GetDriverName != NULL) {\r
68dbca6c 209 SupportedLanguage = ConvertComponentNameSupportLanguage (ComponentName->SupportedLanguages, mLanguage);\r
e5618791
LG
210 if (SupportedLanguage != NULL) {\r
211 Status = ComponentName->GetDriverName (\r
212 ComponentName,\r
213 SupportedLanguage,\r
214 &DriverName\r
215 );\r
216 FreePool (SupportedLanguage);\r
217 }\r
a6f164a7 218 }\r
219 } else if (ComponentName2 != NULL) {\r
220 if (ComponentName2->GetDriverName != NULL) {\r
a6f164a7 221 Status = ComponentName2->GetDriverName (\r
222 ComponentName2,\r
68dbca6c 223 mLanguage,\r
a6f164a7 224 &DriverName\r
225 );\r
a6f164a7 226 }\r
227 }\r
68dbca6c 228\r
a6f164a7 229 if (EFI_ERROR (Status)) {\r
230 return NULL;\r
231 }\r
232\r
233 return DriverName;\r
234}\r
235\r
236/**\r
68dbca6c
LG
237 Get the image name from EFI UI section.\r
238 Get FV protocol by its loaded image protoocl to abastract EFI UI section.\r
a6f164a7 239\r
68dbca6c 240 @param Image Pointer to the loaded image protocol\r
a6f164a7 241\r
68dbca6c
LG
242 @retval !NULL Pointer to the image name if the image name is found,\r
243 @retval NULL NULL if the image name is not found.\r
a6f164a7 244\r
245**/\r
246CHAR16 *\r
247GetImageName (\r
cebc8d48 248 IN EFI_LOADED_IMAGE_PROTOCOL *Image\r
a6f164a7 249 )\r
250{\r
251 EFI_STATUS Status;\r
a6f164a7 252 EFI_DEVICE_PATH_PROTOCOL *DevPathNode;\r
1232b214 253 EFI_DEVICE_PATH_PROTOCOL *AlignedDevPathNode;\r
a6f164a7 254 MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *FvFilePath;\r
255 VOID *Buffer;\r
256 UINTN BufferSize;\r
257 UINT32 AuthenticationStatus;\r
258 EFI_GUID *NameGuid;\r
cebc8d48 259 EFI_FIRMWARE_VOLUME2_PROTOCOL *Fv2;\r
a6f164a7 260\r
cebc8d48 261 Fv2 = NULL;\r
a6f164a7 262 Buffer = NULL;\r
263 BufferSize = 0;\r
264\r
265 if (Image->FilePath == NULL) {\r
266 return NULL;\r
267 }\r
1232b214 268 DevPathNode = Image->FilePath;\r
a6f164a7 269\r
a6f164a7 270 while (!IsDevicePathEnd (DevPathNode)) {\r
1232b214 271 //\r
272 // Make sure device path node is aligned when accessing it's FV Name Guid field.\r
273 //\r
274 AlignedDevPathNode = AllocateCopyPool (DevicePathNodeLength(DevPathNode), DevPathNode);\r
275 \r
a6f164a7 276 //\r
277 // Find the Fv File path\r
278 //\r
1232b214 279 NameGuid = EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *)AlignedDevPathNode);\r
a6f164a7 280 if (NameGuid != NULL) {\r
1232b214 281 FvFilePath = (MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *) AlignedDevPathNode;\r
a6f164a7 282 Status = gBS->HandleProtocol (\r
283 Image->DeviceHandle,\r
284 &gEfiFirmwareVolume2ProtocolGuid,\r
cebc8d48 285 (VOID **) &Fv2\r
a6f164a7 286 );\r
68dbca6c
LG
287 //\r
288 // Locate Image EFI UI section to get the image name.\r
289 //\r
a6f164a7 290 if (!EFI_ERROR (Status)) {\r
cebc8d48
LG
291 Status = Fv2->ReadSection (\r
292 Fv2,\r
a6f164a7 293 &FvFilePath->FvFileName,\r
294 EFI_SECTION_USER_INTERFACE,\r
295 0,\r
296 &Buffer,\r
297 &BufferSize,\r
298 &AuthenticationStatus\r
299 );\r
300 if (!EFI_ERROR (Status)) {\r
1232b214 301 FreePool (AlignedDevPathNode);\r
a6f164a7 302 break;\r
303 }\r
304 Buffer = NULL;\r
305 }\r
306 }\r
1232b214 307 \r
308 FreePool (AlignedDevPathNode);\r
309 \r
a6f164a7 310 //\r
311 // Next device path node\r
312 //\r
313 DevPathNode = NextDevicePathNode (DevPathNode);\r
314 }\r
315\r
a6f164a7 316 return Buffer;\r
317}\r
318\r
319/**\r
320 Prepare the first page to let user select the device controller which need to\r
68dbca6c
LG
321 add mapping drivers if user select 'Refresh' in first page.\r
322 During first page, user will see all currnet controller device path in system,\r
323 select any device path will go to second page to select its overrides drivers.\r
a6f164a7 324\r
325 @param Private Pointer to EFI_CALLBACK_INFO.\r
326 @param KeyValue The callback key value of device controller item in first page.\r
327 @param FakeNvData Pointer to PLAT_OVER_MNGR_DATA.\r
328\r
329 @retval EFI_SUCCESS Always returned.\r
330\r
331**/\r
332EFI_STATUS\r
333UpdateDeviceSelectPage (\r
334 IN EFI_CALLBACK_INFO *Private,\r
335 IN UINT16 KeyValue,\r
336 IN PLAT_OVER_MNGR_DATA *FakeNvData\r
337 )\r
338{\r
339 EFI_HII_UPDATE_DATA UpdateData;\r
340 EFI_STATUS Status;\r
341 UINTN LangSize;\r
342 UINTN Index;\r
343 UINTN DevicePathHandleCount;\r
344 CHAR16 *NewString;\r
345 EFI_STRING_ID NewStringToken;\r
346 CHAR16 *ControllerName;\r
347 EFI_DEVICE_PATH_PROTOCOL *ControllerDevicePath;\r
348 EFI_PCI_IO_PROTOCOL *PciIo;\r
349 EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL *BusSpecificDriverOverride;\r
350 UINTN Len;\r
68dbca6c 351 \r
a6f164a7 352 //\r
68dbca6c
LG
353 // set current page form ID.\r
354 //\r
355 mCurrentPage = FORM_ID_DEVICE; \r
356 \r
357 //\r
358 // Get Platform supported Language (RFC_3066 format)\r
a6f164a7 359 //\r
a6f164a7 360 LangSize = RFC_3066_ENTRY_SIZE;\r
361 Status = gRT->GetVariable (\r
362 L"PlatformLang",\r
363 &gEfiGlobalVariableGuid,\r
364 NULL,\r
365 &LangSize,\r
366 mLanguage\r
367 );\r
368 ASSERT_EFI_ERROR (Status);\r
369\r
370 //\r
371 // Initial the mapping database in memory\r
372 //\r
373 FreeMappingDatabase (&mMappingDataBase);\r
374 Status = InitOverridesMapping (&mMappingDataBase);\r
375\r
376 //\r
377 // Clear all the content in the first page\r
378 //\r
379 UpdateData.BufferSize = UPDATE_DATA_SIZE;\r
380 UpdateData.Offset = 0;\r
381 UpdateData.Data = AllocateZeroPool (UPDATE_DATA_SIZE);\r
382 ASSERT (UpdateData.Data != NULL);\r
383 //\r
384 // Clear first page form\r
385 //\r
386 IfrLibUpdateForm (\r
387 Private->RegisteredHandle,\r
388 &mPlatformOverridesManagerGuid,\r
389 FORM_ID_DEVICE,\r
390 FORM_ID_DEVICE,\r
391 FALSE,\r
392 &UpdateData\r
393 );\r
394\r
395 //\r
396 // When user enter the page at first time, the 'first refresh' string is given to notify user to refresh all the drivers,\r
68dbca6c 397 // then the 'first refresh' string will be replaced by the 'refresh' string, and the two strings content are same after the replacement\r
a6f164a7 398 //\r
399 NewStringToken = STRING_TOKEN (STR_FIRST_REFRESH);\r
400 HiiLibGetStringFromHandle (Private->RegisteredHandle, STRING_TOKEN (STR_REFRESH), &NewString);\r
401 ASSERT (NewString != NULL);\r
402 Status = HiiLibSetString (Private->RegisteredHandle, NewStringToken, NewString);\r
403 ASSERT_EFI_ERROR (Status);\r
68dbca6c 404 FreePool (NewString);\r
a6f164a7 405\r
406 NewStringToken = STRING_TOKEN (STR_FIRST_REFRESH_HELP);\r
407 HiiLibGetStringFromHandle (Private->RegisteredHandle, STRING_TOKEN (STR_REFRESH_HELP), &NewString);\r
408 ASSERT (NewString != NULL);\r
409 Status = HiiLibSetString (Private->RegisteredHandle, NewStringToken, NewString);\r
410 ASSERT_EFI_ERROR (Status);\r
68dbca6c
LG
411 FreePool (NewString);\r
412\r
a6f164a7 413 //\r
414 // created needed controller device item in first page\r
415 //\r
416 DevicePathHandleCount = 0;\r
417 Status = gBS->LocateHandleBuffer (\r
418 ByProtocol,\r
419 &gEfiDevicePathProtocolGuid,\r
420 NULL,\r
421 &DevicePathHandleCount,\r
422 &mDevicePathHandleBuffer\r
423 );\r
424 if (EFI_ERROR (Status) || (DevicePathHandleCount == 0)) {\r
425 return EFI_SUCCESS;\r
426 }\r
427\r
428 for (Index = 0; Index < DevicePathHandleCount; Index++) {\r
429 if (FakeNvData->PciDeviceFilter == 0x01) {\r
430 //\r
431 // Only care PCI device which contain efi driver in its option rom.\r
432 //\r
433\r
434 //\r
435 // Check whether it is a pci device\r
436 //\r
437 ControllerDevicePath = NULL;\r
438 Status = gBS->OpenProtocol (\r
439 mDevicePathHandleBuffer[Index],\r
440 &gEfiPciIoProtocolGuid,\r
441 (VOID **) &PciIo,\r
442 NULL,\r
443 NULL,\r
444 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
445 );\r
446 if (EFI_ERROR (Status)) {\r
447 continue;\r
448 }\r
449 //\r
450 // Check whether it contain efi driver in its option rom\r
451 //\r
452 Status = gBS->HandleProtocol(\r
453 mDevicePathHandleBuffer[Index],\r
454 &gEfiBusSpecificDriverOverrideProtocolGuid,\r
455 (VOID **) &BusSpecificDriverOverride\r
456 );\r
457 if (EFI_ERROR (Status) || BusSpecificDriverOverride == NULL) {\r
458 continue;\r
459 }\r
460 }\r
461\r
462 ControllerDevicePath = NULL;\r
463 Status = gBS->OpenProtocol (\r
464 mDevicePathHandleBuffer[Index],\r
465 &gEfiDevicePathProtocolGuid,\r
466 (VOID **) &ControllerDevicePath,\r
467 NULL,\r
468 NULL,\r
469 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
470 );\r
471 ASSERT_EFI_ERROR (Status);\r
472 //\r
473 // Save the device path protocol interface\r
474 //\r
475 mControllerDevicePathProtocol[Index] = ControllerDevicePath;\r
476\r
477 //\r
478 // Get the driver name\r
479 //\r
480 ControllerName = DevicePathToStr (ControllerDevicePath);\r
481\r
482 //\r
483 // Export the driver name string and create item in set options page\r
484 //\r
485 Len = StrSize (ControllerName);\r
486 NewString = AllocateZeroPool (Len + StrSize (L"--"));\r
77980854 487 ASSERT (NewString != NULL);\r
a6f164a7 488 if (EFI_ERROR (CheckMapping (ControllerDevicePath,NULL, &mMappingDataBase, NULL, NULL))) {\r
489 StrCat (NewString, L"--");\r
490 } else {\r
491 StrCat (NewString, L"**");\r
492 }\r
493 StrCat (NewString, ControllerName);\r
494\r
495 NewStringToken = mControllerToken[Index];\r
496 if (NewStringToken == 0) {\r
497 Status = HiiLibNewString (Private->RegisteredHandle, &NewStringToken, NewString);\r
498 } else {\r
499 Status = HiiLibSetString (Private->RegisteredHandle, NewStringToken, NewString);\r
500 }\r
501 ASSERT_EFI_ERROR (Status);\r
68dbca6c 502 FreePool (NewString);\r
a6f164a7 503 //\r
504 // Save the device path string toke for next access use\r
505 //\r
506 mControllerToken[Index] = NewStringToken;\r
507\r
508 CreateGotoOpCode (\r
509 FORM_ID_DRIVER,\r
510 NewStringToken,\r
511 STRING_TOKEN (STR_GOTO_HELP_DRIVER),\r
512 EFI_IFR_FLAG_CALLBACK,\r
513 (UINT16) (Index + KEY_VALUE_DEVICE_OFFSET),\r
514 &UpdateData\r
515 );\r
516 }\r
517\r
518 //\r
519 // Update first page form\r
520 //\r
521 IfrLibUpdateForm (\r
522 Private->RegisteredHandle,\r
523 &mPlatformOverridesManagerGuid,\r
524 FORM_ID_DEVICE,\r
525 FORM_ID_DEVICE,\r
526 FALSE,\r
527 &UpdateData\r
528 );\r
529\r
68dbca6c 530 FreePool (UpdateData.Data);\r
a6f164a7 531 return EFI_SUCCESS;\r
532}\r
533\r
68dbca6c
LG
534/**\r
535 Get the first Driver Binding handle which has the specific image handle.\r
536\r
537 @param ImageHandle The Image handle\r
538\r
539 @return Handle to Driver binding\r
540 @retval NULL The paramter is not valid or the driver binding handle is not found.\r
541\r
542**/\r
543EFI_HANDLE\r
544GetDriverBindingHandleFromImageHandle (\r
545 IN EFI_HANDLE ImageHandle\r
546 )\r
547{\r
548 EFI_STATUS Status;\r
549 UINTN Index;\r
550 UINTN DriverBindingHandleCount;\r
551 EFI_HANDLE *DriverBindingHandleBuffer;\r
552 EFI_DRIVER_BINDING_PROTOCOL *DriverBindingInterface;\r
553 EFI_HANDLE DriverBindingHandle;\r
554\r
555 DriverBindingHandle = NULL;\r
556\r
557 if (ImageHandle == NULL) {\r
558 return NULL;\r
559 }\r
560 //\r
561 // Get all drivers which support driver binding protocol\r
562 //\r
563 DriverBindingHandleCount = 0;\r
564 Status = gBS->LocateHandleBuffer (\r
565 ByProtocol,\r
566 &gEfiDriverBindingProtocolGuid,\r
567 NULL,\r
568 &DriverBindingHandleCount,\r
569 &DriverBindingHandleBuffer\r
570 );\r
571 if (EFI_ERROR (Status) || (DriverBindingHandleCount == 0)) {\r
572 return NULL;\r
573 }\r
e5618791
LG
574 \r
575 //\r
576 // Get the first Driver Binding handle which has the specific image handle.\r
577 //\r
68dbca6c
LG
578 for (Index = 0; Index < DriverBindingHandleCount; Index++) {\r
579 DriverBindingInterface = NULL;\r
580 Status = gBS->OpenProtocol (\r
581 DriverBindingHandleBuffer[Index],\r
582 &gEfiDriverBindingProtocolGuid,\r
583 (VOID **) &DriverBindingInterface,\r
584 NULL,\r
585 NULL,\r
586 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
587 );\r
588 if (EFI_ERROR (Status)) {\r
589 continue;\r
590 }\r
591\r
592 if (DriverBindingInterface->ImageHandle == ImageHandle) {\r
593 DriverBindingHandle = DriverBindingHandleBuffer[Index];\r
594 break;\r
595 }\r
596 }\r
597\r
68dbca6c
LG
598 FreePool (DriverBindingHandleBuffer);\r
599 return DriverBindingHandle;\r
600}\r
601\r
a6f164a7 602/**\r
603 Prepare to let user select the drivers which need mapping with the device controller\r
604 selected in first page.\r
605\r
606 @param Private Pointer to EFI_CALLBACK_INFO.\r
607 @param KeyValue The callback key value of device controller item in first page.\r
9872985b 608 KeyValue is larger than or equal to KEY_VALUE_DEVICE_OFFSET.\r
a6f164a7 609 @param FakeNvData Pointer to PLAT_OVER_MNGR_DATA.\r
610\r
611 @retval EFI_SUCCESS Always returned.\r
612\r
613**/\r
614EFI_STATUS\r
615UpdateBindingDriverSelectPage (\r
616 IN EFI_CALLBACK_INFO *Private,\r
617 IN UINT16 KeyValue,\r
618 IN PLAT_OVER_MNGR_DATA *FakeNvData\r
619 )\r
620{\r
621 EFI_HII_UPDATE_DATA UpdateData;\r
622 EFI_STATUS Status;\r
623 UINTN Index;\r
a6f164a7 624 CHAR16 *NewString;\r
625 EFI_STRING_ID NewStringToken;\r
626 EFI_STRING_ID NewStringHelpToken;\r
627 UINTN DriverImageHandleCount;\r
a6f164a7 628 EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;\r
629 CHAR16 *DriverName;\r
630 BOOLEAN FreeDriverName;\r
a6f164a7 631 EFI_DEVICE_PATH_PROTOCOL *LoadedImageDevicePath;\r
632 EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL *BusSpecificDriverOverride;\r
633 EFI_HANDLE DriverBindingHandle;\r
68dbca6c 634\r
a6f164a7 635 //\r
636 // If user select a controller item in the first page the following code will be run.\r
637 // During second page, user will see all currnet driver bind protocol driver, the driver name and its device path will be shown\r
638 //\r
639 //First acquire the list of Loaded Image Protocols, and then when want the name of the driver, look up all the Driver Binding Protocols\r
640 // and find the first one whose ImageHandle field matches the image handle of the Loaded Image Protocol.\r
641 // then use the Component Name Protocol on the same handle as the first matching Driver Binding Protocol to look up the name of the driver.\r
642 //\r
643\r
644 mCurrentPage = FORM_ID_DRIVER;\r
645 //\r
646 // Switch the item callback key value to its NO. in mDevicePathHandleBuffer\r
647 //\r
68dbca6c 648 mSelectedCtrIndex = KeyValue - KEY_VALUE_DEVICE_OFFSET;\r
db0bd81c 649 ASSERT (mSelectedCtrIndex > 0 && mSelectedCtrIndex < MAX_CHOICE_NUM);\r
650\r
a6f164a7 651 mLastSavedDriverImageNum = 0;\r
652 //\r
653 // Clear all the content in dynamic page\r
654 //\r
655 UpdateData.BufferSize = UPDATE_DATA_SIZE;\r
656 UpdateData.Offset = 0;\r
657 UpdateData.Data = AllocateZeroPool (UPDATE_DATA_SIZE);\r
658 ASSERT (UpdateData.Data != NULL);\r
659 //\r
660 // Clear second page form\r
661 //\r
662 IfrLibUpdateForm (\r
663 Private->RegisteredHandle,\r
664 &mPlatformOverridesManagerGuid,\r
665 FORM_ID_DRIVER,\r
666 FORM_ID_DRIVER,\r
667 FALSE,\r
668 &UpdateData\r
669 );\r
670\r
671 //\r
672 // Show all driver which support loaded image protocol in second page\r
673 //\r
674 DriverImageHandleCount = 0;\r
675 Status = gBS->LocateHandleBuffer (\r
676 ByProtocol,\r
677 &gEfiLoadedImageProtocolGuid,\r
678 NULL,\r
679 &DriverImageHandleCount,\r
680 &mDriverImageHandleBuffer\r
681 );\r
682 if (EFI_ERROR (Status) || (DriverImageHandleCount == 0)) {\r
683 return EFI_NOT_FOUND;\r
684 }\r
685\r
686 mDriverImageHandleCount = DriverImageHandleCount;\r
687 for (Index = 0; Index < DriverImageHandleCount; Index++) {\r
688 //\r
689 // Step1: Get the driver image total file path for help string and the driver name.\r
690 //\r
691\r
692 //\r
693 // Find driver's Loaded Image protocol\r
694 //\r
695 LoadedImage =NULL;\r
696\r
697 Status = gBS->OpenProtocol (\r
698 mDriverImageHandleBuffer[Index],\r
699 &gEfiLoadedImageProtocolGuid,\r
700 (VOID **) &LoadedImage,\r
701 NULL,\r
702 NULL,\r
703 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
704 );\r
705 if (EFI_ERROR (Status)) {\r
706 FakeNvData->DriSelection[Index] = 0x00;\r
707 continue;\r
708 }\r
709 mDriverImageProtocol[Index] = LoadedImage;\r
710 //\r
711 // Find its related driver binding protocol\r
712 //\r
68dbca6c
LG
713 DriverBindingHandle = GetDriverBindingHandleFromImageHandle (mDriverImageHandleBuffer[Index]);\r
714 if (DriverBindingHandle == NULL) {\r
a6f164a7 715 FakeNvData->DriSelection[Index] = 0x00;\r
716 continue;\r
717 }\r
718\r
719 //\r
720 // Get the EFI Loaded Image Device Path Protocol\r
721 //\r
722 LoadedImageDevicePath = NULL;\r
723 Status = gBS->HandleProtocol (\r
724 mDriverImageHandleBuffer[Index],\r
725 &gEfiLoadedImageDevicePathProtocolGuid,\r
726 (VOID **) &LoadedImageDevicePath\r
727 );\r
728 if (LoadedImageDevicePath == NULL) {\r
729 FakeNvData->DriSelection[Index] = 0x00;\r
730 continue;\r
731 }\r
732\r
733 if (FakeNvData->PciDeviceFilter == 0x01) {\r
734 //\r
735 // only care the driver which is in a Pci device option rom,\r
736 // and the driver's LoadedImage->DeviceHandle must point to a pci device which has efi option rom\r
737 //\r
738 if (!EFI_ERROR (Status)) {\r
739 Status = gBS->HandleProtocol(\r
740 LoadedImage->DeviceHandle,\r
741 &gEfiBusSpecificDriverOverrideProtocolGuid,\r
742 (VOID **) &BusSpecificDriverOverride\r
743 );\r
744 if (EFI_ERROR (Status) || BusSpecificDriverOverride == NULL) {\r
745 FakeNvData->DriSelection[Index] = 0x00;\r
746 continue;\r
747 }\r
748 } else {\r
749 FakeNvData->DriSelection[Index] = 0x00;\r
750 continue;\r
751 }\r
752 }\r
753\r
754 //\r
755 // For driver name, try to get its component name, if fail, get its image name,\r
756 // if also fail, give a default name.\r
757 //\r
758 FreeDriverName = FALSE;\r
759 DriverName = GetComponentName (DriverBindingHandle);\r
760 if (DriverName == NULL) {\r
761 //\r
762 // get its image name\r
763 //\r
764 DriverName = GetImageName (LoadedImage);\r
765 }\r
766 if (DriverName == NULL) {\r
767 //\r
768 // give a default name\r
769 //\r
770 HiiLibGetStringFromHandle (Private->RegisteredHandle, STRING_TOKEN (STR_DRIVER_DEFAULT_NAME), &DriverName);\r
771 ASSERT (DriverName != NULL);\r
772 FreeDriverName = TRUE; // the DriverName string need to free pool\r
773 }\r
774\r
775\r
776 //\r
777 // Step2 Export the driver name string and create check box item in second page\r
778 //\r
779\r
780 //\r
781 // First create the driver image name\r
782 //\r
783 NewString = AllocateZeroPool (StrSize (DriverName));\r
77980854 784 ASSERT (NewString != NULL); \r
a6f164a7 785 if (EFI_ERROR (CheckMapping (mControllerDevicePathProtocol[mSelectedCtrIndex], LoadedImageDevicePath, &mMappingDataBase, NULL, NULL))) {\r
786 FakeNvData->DriSelection[Index] = 0x00;\r
787 } else {\r
788 FakeNvData->DriSelection[Index] = 0x01;\r
789 mLastSavedDriverImageNum++;\r
790 }\r
791 StrCat (NewString, DriverName);\r
792 NewStringToken = mDriverImageToken[Index];\r
793 if (NewStringToken == 0) {\r
794 Status = HiiLibNewString (Private->RegisteredHandle, &NewStringToken, NewString);\r
795 } else {\r
796 Status = HiiLibSetString (Private->RegisteredHandle, NewStringToken, NewString);\r
797 }\r
798 mDriverImageToken[Index] = NewStringToken;\r
799 ASSERT_EFI_ERROR (Status);\r
68dbca6c 800 FreePool (NewString);\r
a6f164a7 801 if (FreeDriverName) {\r
68dbca6c 802 FreePool (DriverName);\r
a6f164a7 803 }\r
804\r
805 //\r
806 // Second create the driver image device path as item help string\r
807 //\r
808 DriverName = DevicePathToStr (LoadedImageDevicePath);\r
809\r
810 NewString = AllocateZeroPool (StrSize (DriverName));\r
80882266 811 ASSERT (NewString != NULL); \r
a6f164a7 812 StrCat (NewString, DriverName);\r
813 NewStringHelpToken = mDriverImageFilePathToken[Index];\r
814 if (NewStringHelpToken == 0) {\r
815 Status = HiiLibNewString (Private->RegisteredHandle, &NewStringHelpToken, NewString);\r
816 } else {\r
817 Status = HiiLibSetString (Private->RegisteredHandle, NewStringHelpToken, NewString);\r
818 }\r
819 mDriverImageFilePathToken[Index] = NewStringHelpToken;\r
820 ASSERT_EFI_ERROR (Status);\r
68dbca6c
LG
821 FreePool (NewString);\r
822 FreePool (DriverName);\r
a6f164a7 823\r
824 CreateCheckBoxOpCode (\r
825 (UINT16) (DRIVER_SELECTION_QUESTION_ID + Index),\r
826 VARSTORE_ID_PLAT_OVER_MNGR,\r
827 (UINT16) (DRIVER_SELECTION_VAR_OFFSET + Index),\r
828 NewStringToken,\r
829 NewStringHelpToken,\r
830 0,\r
831 0,\r
832 &UpdateData\r
833 );\r
834 }\r
835\r
836 //\r
837 // Update second page form\r
838 //\r
839 IfrLibUpdateForm (\r
840 Private->RegisteredHandle,\r
841 &mPlatformOverridesManagerGuid,\r
842 FORM_ID_DRIVER,\r
843 FORM_ID_DRIVER,\r
844 FALSE,\r
845 &UpdateData\r
846 );\r
847\r
68dbca6c 848 FreePool (UpdateData.Data);\r
a6f164a7 849 return EFI_SUCCESS;\r
850}\r
851\r
852/**\r
853 Prepare to let user select the priority order of the drivers which are\r
854 selected in second page.\r
855\r
856 @param Private Pointer to EFI_CALLBACK_INFO.\r
857 @param KeyValue The callback key value of device controller item in first page.\r
858 @param FakeNvData Pointer to PLAT_OVER_MNGR_DATA.\r
859\r
860 @retval EFI_SUCCESS Always returned.\r
861\r
862**/\r
863EFI_STATUS\r
864UpdatePrioritySelectPage (\r
865 IN EFI_CALLBACK_INFO *Private,\r
866 IN UINT16 KeyValue,\r
867 IN PLAT_OVER_MNGR_DATA *FakeNvData\r
868 )\r
869{\r
870 EFI_HII_UPDATE_DATA UpdateData;\r
871 UINTN Index;\r
a6f164a7 872 EFI_DEVICE_PATH_PROTOCOL *LoadedImageDevicePath;\r
a6f164a7 873 IFR_OPTION *IfrOptionList;\r
874 UINTN SelectedDriverImageNum;\r
875 UINT32 DriverImageNO;\r
876 UINTN MinNO;\r
877 UINTN Index1;\r
878 UINTN TempNO[100];\r
879\r
880 //\r
881 // Following code will be run if user select 'order ... priority' item in second page\r
882 // Prepare third page. In third page, user will order the drivers priority which are selected in second page\r
883 //\r
884 mCurrentPage = FORM_ID_ORDER;\r
885\r
886 UpdateData.BufferSize = UPDATE_DATA_SIZE;\r
887 UpdateData.Offset = 0;\r
888 UpdateData.Data = AllocateZeroPool (UPDATE_DATA_SIZE);\r
889 ASSERT (UpdateData.Data != NULL);\r
890 //\r
891 // Clear third page form\r
892 //\r
893 IfrLibUpdateForm (\r
894 Private->RegisteredHandle,\r
895 &mPlatformOverridesManagerGuid,\r
896 FORM_ID_ORDER,\r
897 FORM_ID_ORDER,\r
898 FALSE,\r
899 &UpdateData\r
900 );\r
901\r
902 //\r
903 // Check how many drivers have been selected\r
904 //\r
905 SelectedDriverImageNum = 0;\r
906 for (Index = 0; Index < mDriverImageHandleCount; Index++) {\r
907 if (FakeNvData->DriSelection[Index] != 0) {\r
908 SelectedDriverImageNum ++;\r
909 }\r
910 }\r
911\r
912 mSelectedDriverImageNum = SelectedDriverImageNum;\r
913 if (SelectedDriverImageNum == 0) {\r
914 return EFI_SUCCESS;\r
915 }\r
68dbca6c
LG
916 \r
917 IfrOptionList = AllocateZeroPool (sizeof (IFR_OPTION) * mSelectedDriverImageNum);\r
77980854 918 ASSERT (IfrOptionList != NULL);\r
a6f164a7 919 //\r
920 // Create order list for those selected drivers\r
921 //\r
922 SelectedDriverImageNum = 0;\r
923 for (Index = 0; Index < mDriverImageHandleCount; Index++) {\r
924 if (FakeNvData->DriSelection[Index] != 0) {\r
925 IfrOptionList[SelectedDriverImageNum].StringToken = mDriverImageToken[Index];\r
926 //\r
927 // Use the NO. in driver binding buffer as value, will use it later\r
928 //\r
929 IfrOptionList[SelectedDriverImageNum].Value.u8 = (UINT8) (Index + 1);\r
930 IfrOptionList[SelectedDriverImageNum].Flags = 0;\r
931\r
932 //\r
933 // Get the EFI Loaded Image Device Path Protocol\r
934 //\r
935 LoadedImageDevicePath = NULL;\r
936 gBS->HandleProtocol (\r
937 mDriverImageHandleBuffer[Index],\r
938 &gEfiLoadedImageDevicePathProtocolGuid,\r
939 (VOID **) &LoadedImageDevicePath\r
940 );\r
941 ASSERT (LoadedImageDevicePath != NULL);\r
942\r
943 //\r
944 // Check the driver DriverImage's order number in mapping database\r
945 //\r
946 DriverImageNO = 0;\r
947 CheckMapping (\r
948 mControllerDevicePathProtocol[mSelectedCtrIndex],\r
949 LoadedImageDevicePath,\r
950 &mMappingDataBase,\r
951 NULL,\r
952 &DriverImageNO\r
953 );\r
954 if (DriverImageNO == 0) {\r
955 DriverImageNO = (UINT32) mLastSavedDriverImageNum + 1;\r
956 mLastSavedDriverImageNum++;\r
957 }\r
958 TempNO[SelectedDriverImageNum] = DriverImageNO;\r
959 SelectedDriverImageNum ++;\r
960 }\r
961 }\r
962\r
963 ASSERT (SelectedDriverImageNum == mSelectedDriverImageNum);\r
964 //\r
965 // NvRamMap Must be clear firstly\r
966 //\r
68dbca6c 967 ZeroMem (FakeNvData->DriOrder, sizeof (FakeNvData->DriOrder));\r
a6f164a7 968\r
969 //\r
970 // Order the selected drivers according to the info already in mapping database\r
971 // the less order number in mapping database the less order number in NvRamMap\r
972 //\r
973 for (Index=0; Index < SelectedDriverImageNum; Index++) {\r
974 //\r
975 // Find the minimal order number in TempNO array, its index in TempNO is same as IfrOptionList array\r
976 //\r
977 MinNO = 0;\r
978 for (Index1=0; Index1 < SelectedDriverImageNum; Index1++) {\r
979 if (TempNO[Index1] < TempNO[MinNO]) {\r
980 MinNO = Index1;\r
981 }\r
982 }\r
983 //\r
984 // the IfrOptionList[MinNO].Value = the driver NO. in driver binding buffer\r
985 //\r
986 FakeNvData->DriOrder[Index] =IfrOptionList[MinNO].Value.u8;\r
68dbca6c 987 TempNO[MinNO] = MAX_CHOICE_NUM + 1;\r
a6f164a7 988 }\r
989\r
990 CreateOrderedListOpCode (\r
991 (UINT16) DRIVER_ORDER_QUESTION_ID,\r
992 VARSTORE_ID_PLAT_OVER_MNGR,\r
993 (UINT16) DRIVER_ORDER_VAR_OFFSET,\r
994 mControllerToken[mSelectedCtrIndex],\r
995 mControllerToken[mSelectedCtrIndex],\r
996 EFI_IFR_FLAG_RESET_REQUIRED,\r
997 0,\r
998 EFI_IFR_NUMERIC_SIZE_1,\r
40b96d40 999 (UINT8) MAX_CHOICE_NUM,\r
a6f164a7 1000 IfrOptionList,\r
1001 SelectedDriverImageNum,\r
1002 &UpdateData\r
1003 );\r
1004\r
1005 //\r
1006 // Update third page form\r
1007 //\r
1008 IfrLibUpdateForm (\r
1009 Private->RegisteredHandle,\r
1010 &mPlatformOverridesManagerGuid,\r
1011 FORM_ID_ORDER,\r
1012 FORM_ID_ORDER,\r
1013 FALSE,\r
1014 &UpdateData\r
1015 );\r
1016\r
68dbca6c
LG
1017 FreePool (IfrOptionList);\r
1018 FreePool (UpdateData.Data);\r
a6f164a7 1019 return EFI_SUCCESS;\r
1020}\r
1021\r
1022/**\r
1023 Save the save the mapping database to NV variable.\r
1024\r
1025 @param Private Pointer to EFI_CALLBACK_INFO.\r
1026 @param KeyValue The callback key value of device controller item in first page.\r
1027 @param FakeNvData Pointer to PLAT_OVER_MNGR_DATA.\r
1028\r
1029 @retval EFI_SUCCESS Always returned.\r
1030\r
1031**/\r
1032EFI_STATUS\r
1033CommintChanges (\r
1034 IN EFI_CALLBACK_INFO *Private,\r
1035 IN UINT16 KeyValue,\r
1036 IN PLAT_OVER_MNGR_DATA *FakeNvData\r
1037 )\r
1038{\r
1039 EFI_STATUS Status;\r
1040 UINTN Index;\r
1041 UINTN SelectedDriverImageNum;\r
1042 EFI_DEVICE_PATH_PROTOCOL *LoadedImageDevicePath;\r
1043 //\r
1044 // Following code will be run if user select 'commint changes' in third page\r
1045 // user enter 'Commit Changes' to save the mapping database\r
1046 //\r
1047 DeleteDriverImage (mControllerDevicePathProtocol[mSelectedCtrIndex], NULL, &mMappingDataBase);\r
1048 for (SelectedDriverImageNum = 0; SelectedDriverImageNum < mSelectedDriverImageNum; SelectedDriverImageNum++) {\r
1049 //\r
1050 // DriOrder[SelectedDriverImageNum] = the driver NO. in driver binding buffer\r
1051 //\r
1052 Index = FakeNvData->DriOrder[SelectedDriverImageNum] - 1;\r
1053\r
1054 //\r
1055 // Get the EFI Loaded Image Device Path Protocol\r
1056 //\r
1057 LoadedImageDevicePath = NULL;\r
1058 Status = gBS->HandleProtocol (\r
1059 mDriverImageHandleBuffer[Index],\r
1060 &gEfiLoadedImageDevicePathProtocolGuid,\r
1061 (VOID **) &LoadedImageDevicePath\r
1062 );\r
1063 ASSERT (LoadedImageDevicePath != NULL);\r
1064\r
1065 InsertDriverImage (\r
1066 mControllerDevicePathProtocol[mSelectedCtrIndex],\r
1067 LoadedImageDevicePath,\r
1068 &mMappingDataBase,\r
1069 (UINT32)SelectedDriverImageNum + 1\r
1070 );\r
1071 }\r
1072 Status = SaveOverridesMapping (&mMappingDataBase);\r
1073\r
1074 return Status;\r
1075}\r
1076\r
1077/**\r
1078 This function allows a caller to extract the current configuration for one\r
1079 or more named elements from the target driver.\r
1080\r
1081 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
1082 @param Request A null-terminated Unicode string in <ConfigRequest> format.\r
1083 @param Progress On return, points to a character in the Request string.\r
1084 Points to the string's null terminator if request was successful.\r
1085 Points to the most recent '&' before the first failing name/value\r
1086 pair (or the beginning of the string if the failure is in the\r
1087 first name/value pair) if the request was not successful.\r
1088 @param Results A null-terminated Unicode string in <ConfigAltResp> format which\r
1089 has all values filled in for the names in the Request string.\r
1090 String to be allocated by the called function.\r
1091\r
1092 @retval EFI_SUCCESS The Results is filled with the requested values.\r
1093 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.\r
1094 @retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name.\r
1095 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.\r
1096\r
1097**/\r
1098EFI_STATUS\r
1099EFIAPI\r
1100PlatOverMngrExtractConfig (\r
68dbca6c 1101 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
a6f164a7 1102 IN CONST EFI_STRING Request,\r
1103 OUT EFI_STRING *Progress,\r
1104 OUT EFI_STRING *Results\r
1105 )\r
1106{\r
1107 EFI_STATUS Status;\r
1108 EFI_CALLBACK_INFO *Private;\r
1109 EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;\r
1110\r
8d00a0f1 1111 if (Request == NULL) {\r
1112 return EFI_NOT_FOUND;\r
1113 }\r
1114\r
a6f164a7 1115 Private = EFI_CALLBACK_INFO_FROM_THIS (This);\r
1116 HiiConfigRouting = Private->HiiConfigRouting;\r
1117\r
1118 //\r
1119 // Convert buffer data to <ConfigResp> by helper function BlockToConfig()\r
1120 //\r
1121 Status = HiiConfigRouting->BlockToConfig (\r
1122 HiiConfigRouting,\r
1123 Request,\r
1124 (UINT8 *) &Private->FakeNvData,\r
1125 sizeof (PLAT_OVER_MNGR_DATA),\r
1126 Results,\r
1127 Progress\r
1128 );\r
1129 return Status;\r
1130}\r
1131\r
1132/**\r
1133 This function processes the results of changes in configuration.\r
1134\r
cebc8d48
LG
1135 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
1136 @param Configuration A null-terminated Unicode string in <ConfigRequest> format.\r
1137 @param Progress A pointer to a string filled in with the offset of the most\r
1138 recent '&' before the first failing name/value pair (or the\r
1139 beginning of the string if the failure is in the first\r
1140 name/value pair) or the terminating NULL if all was successful.\r
a6f164a7 1141\r
1142 @retval EFI_SUCCESS The Results is processed successfully.\r
1143 @retval EFI_INVALID_PARAMETER Configuration is NULL.\r
1144 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.\r
1145\r
1146**/\r
1147EFI_STATUS\r
1148EFIAPI\r
1149PlatOverMngrRouteConfig (\r
1150 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
1151 IN CONST EFI_STRING Configuration,\r
1152 OUT EFI_STRING *Progress\r
1153 )\r
1154{\r
1155 EFI_CALLBACK_INFO *Private;\r
1156 EFI_STATUS Status;\r
1157 UINT16 KeyValue;\r
1158 UINTN BufferSize;\r
1159 PLAT_OVER_MNGR_DATA *FakeNvData;\r
1160\r
1161 Private = EFI_CALLBACK_INFO_FROM_THIS (This);\r
1162\r
1163 FakeNvData = &Private->FakeNvData;\r
1164 BufferSize = sizeof (PLAT_OVER_MNGR_DATA);\r
1165 Status = GetBrowserData (NULL, NULL, &BufferSize, (UINT8 *) FakeNvData);\r
1166 if (EFI_ERROR (Status)) {\r
1167 return Status;\r
1168 }\r
1169\r
1170 if (mCurrentPage == FORM_ID_DRIVER) {\r
1171 KeyValue = KEY_VALUE_DRIVER_GOTO_ORDER;\r
1172 UpdatePrioritySelectPage (Private, KeyValue, FakeNvData);\r
1173 KeyValue = KEY_VALUE_ORDER_SAVE_AND_EXIT;\r
1174 CommintChanges (Private, KeyValue, FakeNvData);\r
1175 //\r
1176 // Since UpdatePrioritySelectPage will change mCurrentPage,\r
1177 // should ensure the mCurrentPage still indicate the second page here\r
1178 //\r
1179 mCurrentPage = FORM_ID_DRIVER;\r
1180 }\r
1181\r
1182 if (mCurrentPage == FORM_ID_ORDER) {\r
1183 KeyValue = KEY_VALUE_ORDER_SAVE_AND_EXIT;\r
1184 CommintChanges (Private, KeyValue, FakeNvData);\r
1185 }\r
1186 return EFI_SUCCESS;\r
1187}\r
1188\r
1189/**\r
1190 This is the function that is called to provide results data to the driver. This data\r
1191 consists of a unique key which is used to identify what data is either being passed back\r
1192 or being asked for.\r
1193\r
1194 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
1195 @param Action A null-terminated Unicode string in <ConfigRequest> format.\r
1196 @param KeyValue A unique Goto OpCode callback value which record user's selection.\r
1197 0x100 <= KeyValue <0x500 : user select a controller item in the first page;\r
1198 KeyValue == 0x1234 : user select 'Refresh' in first page, or user select 'Go to Previous Menu' in second page\r
1199 KeyValue == 0x1235 : user select 'Pci device filter' in first page\r
1200 KeyValue == 0x1500 : user select 'order ... priority' item in second page\r
1201 KeyValue == 0x1800 : user select 'commint changes' in third page\r
1202 KeyValue == 0x2000 : user select 'Go to Previous Menu' in third page\r
1203 @param Type The type of value for the question.\r
1204 @param Value A pointer to the data being sent to the original exporting driver.\r
1205 @param ActionRequest On return, points to the action requested by the callback function.\r
1206\r
1207 @retval EFI_SUCCESS Always returned.\r
1208\r
1209**/\r
1210EFI_STATUS\r
1211EFIAPI\r
1212PlatOverMngrCallback (\r
1213 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
1214 IN EFI_BROWSER_ACTION Action,\r
1215 IN EFI_QUESTION_ID KeyValue,\r
1216 IN UINT8 Type,\r
1217 IN EFI_IFR_TYPE_VALUE *Value,\r
1218 OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r
1219 )\r
1220{\r
1221 EFI_CALLBACK_INFO *Private;\r
1222 EFI_STATUS Status;\r
1223 EFI_STRING_ID NewStringToken;\r
1224 UINTN BufferSize;\r
1225 PLAT_OVER_MNGR_DATA *FakeNvData;\r
1226 EFI_INPUT_KEY Key;\r
1227\r
1228 Private = EFI_CALLBACK_INFO_FROM_THIS (This);\r
1229\r
1230 FakeNvData = &Private->FakeNvData;\r
1231 BufferSize = sizeof (PLAT_OVER_MNGR_DATA);\r
1232 Status = GetBrowserData (NULL, NULL, &BufferSize, (UINT8 *) FakeNvData);\r
1233 if (EFI_ERROR (Status)) {\r
1234 return Status;\r
1235 }\r
1236\r
1237 if (KeyValue == KEY_VALUE_DEVICE_REFRESH ||\r
1238 KeyValue == KEY_VALUE_DEVICE_FILTER ||\r
1239 KeyValue == KEY_VALUE_DRIVER_GOTO_PREVIOUS\r
1240 ) {\r
1241 UpdateDeviceSelectPage (Private, KeyValue, FakeNvData);\r
1242 //\r
1243 // Update page title string\r
1244 //\r
1245 NewStringToken = STRING_TOKEN (STR_TITLE);\r
1246 Status = HiiLibSetString (Private->RegisteredHandle, NewStringToken, L"First, Select the controller by device path");\r
1247 ASSERT_EFI_ERROR (Status);\r
1248 }\r
1249\r
80882266 1250 if (((KeyValue >= KEY_VALUE_DEVICE_OFFSET) && (KeyValue < KEY_VALUE_DEVICE_MAX)) || (KeyValue == KEY_VALUE_ORDER_GOTO_PREVIOUS)) {\r
a6f164a7 1251 if (KeyValue == KEY_VALUE_ORDER_GOTO_PREVIOUS) {\r
68dbca6c 1252 KeyValue = (EFI_QUESTION_ID) (mSelectedCtrIndex + KEY_VALUE_DEVICE_OFFSET);\r
a6f164a7 1253 }\r
1254 UpdateBindingDriverSelectPage (Private, KeyValue, FakeNvData);\r
1255 //\r
1256 // Update page title string\r
1257 //\r
1258 NewStringToken = STRING_TOKEN (STR_TITLE);\r
1259 Status = HiiLibSetString (Private->RegisteredHandle, NewStringToken, L"Second, Select drivers for the previous selected controller");\r
1260 ASSERT_EFI_ERROR (Status);\r
1261 }\r
1262\r
1263 if (KeyValue == KEY_VALUE_DRIVER_GOTO_ORDER) {\r
1264 UpdatePrioritySelectPage (Private, KeyValue, FakeNvData);\r
1265 //\r
1266 // Update page title string\r
1267 //\r
1268 NewStringToken = STRING_TOKEN (STR_TITLE);\r
1269 Status = HiiLibSetString (Private->RegisteredHandle, NewStringToken, L"Finally, Set the priority order for the drivers and save them");\r
1270 ASSERT_EFI_ERROR (Status);\r
1271 }\r
1272\r
1273 if (KeyValue == KEY_VALUE_ORDER_SAVE_AND_EXIT) {\r
1274 Status = CommintChanges (Private, KeyValue, FakeNvData);\r
1275 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT;\r
1276 if (EFI_ERROR (Status)) {\r
1277 IfrLibCreatePopUp (1, &Key, L"Single Override Info too large, Saving Error!");\r
1278 return EFI_DEVICE_ERROR;\r
1279 }\r
1280 }\r
1281\r
1282 if (KeyValue == KEY_VALUE_DEVICE_CLEAR) {\r
1283 //\r
1284 // Deletes all environment variable(s) that contain the override mappings info\r
1285 //\r
1286 FreeMappingDatabase (&mMappingDataBase);\r
1287 Status = SaveOverridesMapping (&mMappingDataBase);\r
1288 UpdateDeviceSelectPage (Private, KeyValue, FakeNvData);\r
1289 }\r
1290 //\r
1291 // Pass changed uncommitted data back to Form Browser\r
1292 //\r
1293 BufferSize = sizeof (PLAT_OVER_MNGR_DATA);\r
1294 Status = SetBrowserData (NULL, NULL, BufferSize, (UINT8 *) FakeNvData, NULL);\r
1295\r
1296 return EFI_SUCCESS;\r
1297}\r
1298\r
a6f164a7 1299/**\r
68dbca6c
LG
1300 The driver Entry Point. The funciton will export a disk device class formset and\r
1301 its callback function to hii database.\r
a6f164a7 1302\r
68dbca6c
LG
1303 @param ImageHandle The firmware allocated handle for the EFI image.\r
1304 @param SystemTable A pointer to the EFI System Table.\r
a6f164a7 1305\r
68dbca6c
LG
1306 @retval EFI_SUCCESS The entry point is executed successfully.\r
1307 @retval other Some error occurs when executing this entry point.\r
a6f164a7 1308\r
1309**/\r
68dbca6c
LG
1310EFI_STATUS\r
1311EFIAPI\r
1312PlatOverMngrInit (\r
1313 IN EFI_HANDLE ImageHandle,\r
1314 IN EFI_SYSTEM_TABLE *SystemTable\r
a6f164a7 1315 )\r
1316{\r
68dbca6c
LG
1317 EFI_STATUS Status;\r
1318 EFI_HII_DATABASE_PROTOCOL *HiiDatabase;\r
1319 EFI_HII_PACKAGE_LIST_HEADER *PackageList;\r
1320 EFI_CALLBACK_INFO *CallbackInfo;\r
1321 EFI_HANDLE DriverHandle;\r
1322 EFI_FORM_BROWSER2_PROTOCOL *FormBrowser2;\r
e5618791 1323 \r
68dbca6c
LG
1324 //\r
1325 // There should only be one HII protocol\r
1326 //\r
1327 Status = gBS->LocateProtocol (\r
1328 &gEfiHiiDatabaseProtocolGuid,\r
1329 NULL,\r
1330 (VOID **) &HiiDatabase\r
1331 );\r
1332 if (EFI_ERROR (Status)) {\r
1333 return Status;\r
a6f164a7 1334 }\r
1335\r
68dbca6c
LG
1336 //\r
1337 // There should only be one Form Configuration protocol\r
1338 //\r
a6f164a7 1339 Status = gBS->LocateProtocol (\r
68dbca6c
LG
1340 &gEfiFormBrowser2ProtocolGuid,\r
1341 NULL,\r
1342 (VOID **) &FormBrowser2\r
1343 );\r
1344 if (EFI_ERROR (Status)) {\r
1345 return Status;\r
1346 }\r
1347\r
1348 CallbackInfo = AllocateZeroPool (sizeof (EFI_CALLBACK_INFO));\r
1349 if (CallbackInfo == NULL) {\r
1350 return EFI_BAD_BUFFER_SIZE;\r
1351 }\r
1352\r
1353 CallbackInfo->Signature = EFI_CALLBACK_INFO_SIGNATURE;\r
1354 CallbackInfo->ConfigAccess.ExtractConfig = PlatOverMngrExtractConfig;\r
1355 CallbackInfo->ConfigAccess.RouteConfig = PlatOverMngrRouteConfig;\r
1356 CallbackInfo->ConfigAccess.Callback = PlatOverMngrCallback;\r
1357\r
1358 //\r
1359 // Create driver handle used by HII database\r
1360 //\r
1361 Status = HiiLibCreateHiiDriverHandle (&DriverHandle);\r
1362 if (EFI_ERROR (Status)) {\r
e5618791 1363 goto Finish;\r
68dbca6c
LG
1364 }\r
1365 CallbackInfo->DriverHandle = DriverHandle;\r
1366\r
1367 //\r
1368 // Install Config Access protocol to driver handle\r
1369 //\r
1370 Status = gBS->InstallProtocolInterface (\r
1371 &DriverHandle,\r
1372 &gEfiHiiConfigAccessProtocolGuid,\r
1373 EFI_NATIVE_INTERFACE,\r
1374 &CallbackInfo->ConfigAccess\r
1375 );\r
1376 if (EFI_ERROR (Status)) {\r
e5618791 1377 goto Finish;\r
68dbca6c
LG
1378 }\r
1379\r
1380 //\r
1381 // Publish our HII data\r
1382 //\r
1383 PackageList = HiiLibPreparePackageList (\r
1384 2,\r
1385 &mPlatformOverridesManagerGuid,\r
1386 VfrBin,\r
1387 PlatOverMngrStrings\r
1388 );\r
1389 ASSERT (PackageList != NULL);\r
1390\r
1391 Status = HiiDatabase->NewPackageList (\r
1392 HiiDatabase,\r
1393 PackageList,\r
1394 DriverHandle,\r
1395 &CallbackInfo->RegisteredHandle\r
1396 );\r
1397 FreePool (PackageList);\r
1398\r
e5618791
LG
1399 if (EFI_ERROR (Status)) {\r
1400 goto Finish;\r
1401 }\r
1402\r
68dbca6c
LG
1403 //\r
1404 // Locate ConfigRouting protocol\r
1405 //\r
1406 Status = gBS->LocateProtocol (\r
1407 &gEfiHiiConfigRoutingProtocolGuid,\r
a6f164a7 1408 NULL,\r
68dbca6c 1409 (VOID **) &CallbackInfo->HiiConfigRouting\r
a6f164a7 1410 );\r
68dbca6c 1411 if (EFI_ERROR (Status)) {\r
e5618791 1412 goto Finish;\r
68dbca6c
LG
1413 }\r
1414\r
1415 //\r
1416 // Clear all the globle variable\r
1417 //\r
1418 mDriverImageHandleCount = 0;\r
1419 mCurrentPage = 0;\r
1420 ZeroMem (mDriverImageToken, MAX_CHOICE_NUM * sizeof (EFI_STRING_ID));\r
1421 ZeroMem (mDriverImageFilePathToken, MAX_CHOICE_NUM * sizeof (EFI_STRING_ID));\r
1422 ZeroMem (mControllerToken, MAX_CHOICE_NUM * sizeof (EFI_STRING_ID));\r
1423 ZeroMem (mDriverImageProtocol, MAX_CHOICE_NUM * sizeof (EFI_LOADED_IMAGE_PROTOCOL *));\r
1424\r
1425 //\r
1426 // Show the page\r
1427 //\r
1428 Status = FormBrowser2->SendForm (\r
1429 FormBrowser2,\r
1430 &CallbackInfo->RegisteredHandle,\r
1431 1,\r
1432 NULL,\r
1433 0,\r
1434 NULL,\r
1435 NULL\r
1436 );\r
e5618791
LG
1437 if (EFI_ERROR (Status)) {\r
1438 goto Finish;\r
1439 }\r
68dbca6c
LG
1440\r
1441 Status = HiiDatabase->RemovePackageList (HiiDatabase, CallbackInfo->RegisteredHandle);\r
1442 if (EFI_ERROR (Status)) {\r
e5618791 1443 goto Finish;\r
a6f164a7 1444 }\r
e5618791 1445 \r
68dbca6c 1446 return EFI_SUCCESS;\r
e5618791
LG
1447\r
1448Finish:\r
1449 if (CallbackInfo->DriverHandle != NULL) {\r
1450 HiiLibDestroyHiiDriverHandle (CallbackInfo->DriverHandle);\r
1451 }\r
1452 if (CallbackInfo != NULL) {\r
1453 FreePool (CallbackInfo);\r
1454 }\r
1455\r
1456 return Status;\r
a6f164a7 1457}\r
87fbccbe 1458\r
1459/**\r
1460 Converting a given device to an unicode string. \r
1461 \r
1462 This function will dependent on gEfiDevicePathToTextProtocolGuid, if protocol\r
1463 does not installed, then return unknown device path L"?" directly.\r
1464 \r
1465 @param DevPath Given device path instance\r
1466 \r
1467 @return Converted string from given device path.\r
1468 @retval L"?" Can not locate gEfiDevicePathToTextProtocolGuid protocol for converting.\r
1469**/\r
1470CHAR16 *\r
1471DevicePathToStr (\r
1472 IN EFI_DEVICE_PATH_PROTOCOL *DevPath\r
1473 )\r
1474{\r
1475 EFI_STATUS Status;\r
1476 EFI_DEVICE_PATH_TO_TEXT_PROTOCOL *DevPathToText;\r
1477 CHAR16 *ToText;\r
1478 \r
1479 if (DevPath == NULL) {\r
1480 return L"";\r
1481 }\r
1482 \r
1483 Status = gBS->LocateProtocol (\r
1484 &gEfiDevicePathToTextProtocolGuid,\r
1485 NULL,\r
1486 (VOID **) &DevPathToText\r
1487 );\r
1488 if (!EFI_ERROR (Status)) {\r
1489 ToText = DevPathToText->ConvertDevicePathToText (\r
1490 DevPath,\r
1491 FALSE,\r
1492 TRUE\r
1493 );\r
1494 ASSERT (ToText != NULL);\r
1495 return ToText;\r
1496 }\r
1497\r
1498 return L"?";\r
1499}\r