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