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