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