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