]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/PlatformDriverOverride/PlatOverMngr/PlatOverMngr.c
projects / mirror_edk2.git / blob
? search:


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