2 Misc BDS library function
4 Copyright (c) 2004 - 2008, Intel Corporation. <BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "InternalBdsLib.h"
18 #define MAX_STRING_LEN 200
20 BOOLEAN mFeaturerSwitch
= TRUE
;
21 BOOLEAN mResetRequired
= FALSE
;
23 extern UINT16 gPlatformBootTimeOutDefault
;
27 Return the default value for system Timeout variable.
29 @return Timeout value.
43 // Return Timeout variable or 0xffff if no valid
44 // Timeout variable exists.
46 Size
= sizeof (UINT16
);
47 Status
= gRT
->GetVariable (L
"Timeout", &gEfiGlobalVariableGuid
, NULL
, &Size
, &Timeout
);
48 if (EFI_ERROR (Status
)) {
50 // According to UEFI 2.0 spec, it should treat the Timeout value as 0xffff
51 // (default value PcdPlatformBootTimeOutDefault) when L"Timeout" variable is not present.
52 // To make the current EFI Automatic-Test activity possible, platform can choose other value
53 // for automatic boot when the variable is not present.
55 Timeout
= PcdGet16 (PcdPlatformBootTimeOutDefault
);
62 The function will go through the driver optoin link list, load and start
63 every driver the driver optoin device path point to.
65 @param BdsDriverLists The header of the current driver option link list
71 IN LIST_ENTRY
*BdsDriverLists
76 BDS_COMMON_OPTION
*Option
;
77 EFI_HANDLE ImageHandle
;
78 EFI_LOADED_IMAGE_PROTOCOL
*ImageInfo
;
86 // Process the driver option
88 for (Link
= BdsDriverLists
->ForwardLink
; Link
!= BdsDriverLists
; Link
= Link
->ForwardLink
) {
89 Option
= CR (Link
, BDS_COMMON_OPTION
, Link
, BDS_LOAD_OPTION_SIGNATURE
);
92 // If a load option is not marked as LOAD_OPTION_ACTIVE,
93 // the boot manager will not automatically load the option.
95 if (!IS_LOAD_OPTION_TYPE (Option
->Attribute
, LOAD_OPTION_ACTIVE
)) {
100 // If a driver load option is marked as LOAD_OPTION_FORCE_RECONNECT,
101 // then all of the EFI drivers in the system will be disconnected and
102 // reconnected after the last driver load option is processed.
104 if (IS_LOAD_OPTION_TYPE (Option
->Attribute
, LOAD_OPTION_FORCE_RECONNECT
)) {
109 // Make sure the driver path is connected.
111 BdsLibConnectDevicePath (Option
->DevicePath
);
114 // Load and start the image that Driver#### describes
116 Status
= gBS
->LoadImage (
125 if (!EFI_ERROR (Status
)) {
126 gBS
->HandleProtocol (ImageHandle
, &gEfiLoadedImageProtocolGuid
, (VOID
**) &ImageInfo
);
129 // Verify whether this image is a driver, if not,
130 // exit it and continue to parse next load option
132 if (ImageInfo
->ImageCodeType
!= EfiBootServicesCode
&& ImageInfo
->ImageCodeType
!= EfiRuntimeServicesCode
) {
133 gBS
->Exit (ImageHandle
, EFI_INVALID_PARAMETER
, 0, NULL
);
137 if (Option
->LoadOptionsSize
!= 0) {
138 ImageInfo
->LoadOptionsSize
= Option
->LoadOptionsSize
;
139 ImageInfo
->LoadOptions
= Option
->LoadOptions
;
142 // Before calling the image, enable the Watchdog Timer for
143 // the 5 Minute period
145 gBS
->SetWatchdogTimer (5 * 60, 0x0000, 0x00, NULL
);
147 Status
= gBS
->StartImage (ImageHandle
, &ExitDataSize
, &ExitData
);
148 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Driver Return Status = %r\n", Status
));
151 // Clear the Watchdog Timer after the image returns
153 gBS
->SetWatchdogTimer (0x0000, 0x0000, 0x0000, NULL
);
158 // Process the LOAD_OPTION_FORCE_RECONNECT driver option
161 BdsLibDisconnectAllEfi ();
168 Get the Option Number that does not used.
169 Try to locate the specific option variable one by one untile find a free number.
171 @param VariableName Indicate if the boot#### or driver#### option
173 @return The Minimal Free Option Number
177 BdsLibGetFreeOptionNumber (
178 IN CHAR16
*VariableName
183 UINT16
*OptionBuffer
;
187 // Try to find the minimum free number from 0, 1, 2, 3....
191 if (*VariableName
== 'B') {
192 UnicodeSPrint (StrTemp
, sizeof (StrTemp
), L
"Boot%04x", Index
);
194 UnicodeSPrint (StrTemp
, sizeof (StrTemp
), L
"Driver%04x", Index
);
197 // try if the option number is used
199 OptionBuffer
= BdsLibGetVariableAndSize (
201 &gEfiGlobalVariableGuid
,
204 if (OptionBuffer
== NULL
) {
210 return ((UINT16
) Index
);
215 This function will register the new boot#### or driver#### option base on
216 the VariableName. The new registered boot#### or driver#### will be linked
217 to BdsOptionList and also update to the VariableName. After the boot#### or
218 driver#### updated, the BootOrder or DriverOrder will also be updated.
220 @param BdsOptionList The header of the boot#### or driver#### link list
221 @param DevicePath The device path which the boot#### or driver####
223 @param String The description of the boot#### or driver####
224 @param VariableName Indicate if the boot#### or driver#### option
226 @retval EFI_SUCCESS The boot#### or driver#### have been success
228 @retval EFI_STATUS Return the status of gRT->SetVariable ().
233 BdsLibRegisterNewOption (
234 IN LIST_ENTRY
*BdsOptionList
,
235 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
237 IN CHAR16
*VariableName
242 UINT16 RegisterOptionNumber
;
243 UINT16
*TempOptionPtr
;
244 UINTN TempOptionSize
;
245 UINT16
*OptionOrderPtr
;
249 EFI_DEVICE_PATH_PROTOCOL
*OptionDevicePath
;
251 CHAR16 OptionName
[10];
252 BOOLEAN UpdateDescription
;
253 UINT16 BootOrderEntry
;
260 OptionDevicePath
= NULL
;
262 OptionOrderPtr
= NULL
;
263 UpdateDescription
= FALSE
;
264 Status
= EFI_SUCCESS
;
265 ZeroMem (OptionName
, sizeof (OptionName
));
268 TempOptionPtr
= BdsLibGetVariableAndSize (
270 &gEfiGlobalVariableGuid
,
275 // Compare with current option variable
277 for (Index
= 0; Index
< TempOptionSize
/ sizeof (UINT16
); Index
++) {
279 if (*VariableName
== 'B') {
280 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", TempOptionPtr
[Index
]);
282 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Driver%04x", TempOptionPtr
[Index
]);
285 OptionPtr
= BdsLibGetVariableAndSize (
287 &gEfiGlobalVariableGuid
,
290 if (OptionPtr
== NULL
) {
294 TempPtr
+= sizeof (UINT32
) + sizeof (UINT16
);
295 Description
= (CHAR16
*) TempPtr
;
296 TempPtr
+= StrSize ((CHAR16
*) TempPtr
);
297 OptionDevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
300 // Notes: the description may will change base on the GetStringToken
302 if (CompareMem (OptionDevicePath
, DevicePath
, GetDevicePathSize (OptionDevicePath
)) == 0) {
303 if (CompareMem (Description
, String
, StrSize (Description
)) == 0) {
305 // Got the option, so just return
307 FreePool (OptionPtr
);
308 if (TempOptionPtr
!= NULL
) {
309 FreePool (TempOptionPtr
);
314 // Option description changed, need update.
316 UpdateDescription
= TRUE
;
317 FreePool (OptionPtr
);
322 FreePool (OptionPtr
);
325 OptionSize
= sizeof (UINT32
) + sizeof (UINT16
) + StrSize (String
);
326 OptionSize
+= GetDevicePathSize (DevicePath
);
327 OptionPtr
= AllocateZeroPool (OptionSize
);
328 ASSERT (OptionPtr
!= NULL
);
331 *(UINT32
*) TempPtr
= LOAD_OPTION_ACTIVE
;
332 TempPtr
+= sizeof (UINT32
);
333 *(UINT16
*) TempPtr
= (UINT16
) GetDevicePathSize (DevicePath
);
334 TempPtr
+= sizeof (UINT16
);
335 CopyMem (TempPtr
, String
, StrSize (String
));
336 TempPtr
+= StrSize (String
);
337 CopyMem (TempPtr
, DevicePath
, GetDevicePathSize (DevicePath
));
339 if (UpdateDescription
) {
341 // The number in option#### to be updated
343 RegisterOptionNumber
= TempOptionPtr
[Index
];
346 // The new option#### number
348 RegisterOptionNumber
= BdsLibGetFreeOptionNumber(VariableName
);
351 if (*VariableName
== 'B') {
352 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", RegisterOptionNumber
);
354 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Driver%04x", RegisterOptionNumber
);
357 Status
= gRT
->SetVariable (
359 &gEfiGlobalVariableGuid
,
360 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
365 // Return if only need to update a changed description or fail to set option.
367 if (EFI_ERROR (Status
) || UpdateDescription
) {
368 FreePool (OptionPtr
);
369 if (TempOptionPtr
!= NULL
) {
370 FreePool (TempOptionPtr
);
375 FreePool (OptionPtr
);
378 // Update the option order variable
382 // If no option order
384 if (TempOptionSize
== 0) {
386 Status
= gRT
->SetVariable (
388 &gEfiGlobalVariableGuid
,
389 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
393 if (TempOptionPtr
!= NULL
) {
394 FreePool (TempOptionPtr
);
400 // Append the new option number to the original option order
402 OrderItemNum
= (TempOptionSize
/ sizeof (UINT16
)) + 1 ;
403 OptionOrderPtr
= AllocateZeroPool ( OrderItemNum
* sizeof (UINT16
));
404 ASSERT (OptionOrderPtr
!= NULL
);
406 CopyMem (OptionOrderPtr
, TempOptionPtr
, (OrderItemNum
- 1) * sizeof (UINT16
));
408 OptionOrderPtr
[Index
] = RegisterOptionNumber
;
410 Status
= gRT
->SetVariable (
412 &gEfiGlobalVariableGuid
,
413 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
414 OrderItemNum
* sizeof (UINT16
),
417 FreePool (TempOptionPtr
);
418 FreePool (OptionOrderPtr
);
425 Build the boot#### or driver#### option from the VariableName, the
426 build boot#### or driver#### will also be linked to BdsCommonOptionList.
428 @param BdsCommonOptionList The header of the boot#### or driver#### option
430 @param VariableName EFI Variable name indicate if it is boot#### or
433 @retval BDS_COMMON_OPTION Get the option just been created
434 @retval NULL Failed to get the new option
439 BdsLibVariableToOption (
440 IN OUT LIST_ENTRY
*BdsCommonOptionList
,
441 IN CHAR16
*VariableName
449 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
450 BDS_COMMON_OPTION
*Option
;
452 UINT32 LoadOptionsSize
;
456 // Read the variable. We will never free this data.
458 Variable
= BdsLibGetVariableAndSize (
460 &gEfiGlobalVariableGuid
,
463 if (Variable
== NULL
) {
467 // Notes: careful defined the variable of Boot#### or
468 // Driver####, consider use some macro to abstract the code
471 // Get the option attribute
474 Attribute
= *(UINT32
*) Variable
;
475 TempPtr
+= sizeof (UINT32
);
478 // Get the option's device path size
480 FilePathSize
= *(UINT16
*) TempPtr
;
481 TempPtr
+= sizeof (UINT16
);
484 // Get the option's description string
486 Description
= (CHAR16
*) TempPtr
;
489 // Get the option's description string size
491 TempPtr
+= StrSize ((CHAR16
*) TempPtr
);
494 // Get the option's device path
496 DevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
497 TempPtr
+= FilePathSize
;
499 LoadOptions
= TempPtr
;
500 LoadOptionsSize
= (UINT32
) (VariableSize
- (UINTN
) (TempPtr
- Variable
));
503 // The Console variables may have multiple device paths, so make
504 // an Entry for each one.
506 Option
= AllocateZeroPool (sizeof (BDS_COMMON_OPTION
));
507 if (Option
== NULL
) {
511 Option
->Signature
= BDS_LOAD_OPTION_SIGNATURE
;
512 Option
->DevicePath
= AllocateZeroPool (GetDevicePathSize (DevicePath
));
513 CopyMem (Option
->DevicePath
, DevicePath
, GetDevicePathSize (DevicePath
));
514 Option
->Attribute
= Attribute
;
515 Option
->Description
= AllocateZeroPool (StrSize (Description
));
516 CopyMem (Option
->Description
, Description
, StrSize (Description
));
517 Option
->LoadOptions
= AllocateZeroPool (LoadOptionsSize
);
518 CopyMem (Option
->LoadOptions
, LoadOptions
, LoadOptionsSize
);
519 Option
->LoadOptionsSize
= LoadOptionsSize
;
522 // Get the value from VariableName Unicode string
523 // since the ISO standard assumes ASCII equivalent abbreviations, we can be safe in converting this
524 // Unicode stream to ASCII without any loss in meaning.
526 if (*VariableName
== 'B') {
527 NumOff
= sizeof (L
"Boot")/sizeof(CHAR16
) -1 ;
528 Option
->BootCurrent
= (UINT16
) ((VariableName
[NumOff
] -'0') * 0x1000);
529 Option
->BootCurrent
= (UINT16
) (Option
->BootCurrent
+ ((VariableName
[NumOff
+1]-'0') * 0x100));
530 Option
->BootCurrent
= (UINT16
) (Option
->BootCurrent
+ ((VariableName
[NumOff
+2]-'0') * 0x10));
531 Option
->BootCurrent
= (UINT16
) (Option
->BootCurrent
+ ((VariableName
[NumOff
+3]-'0')));
534 // Insert active entry to BdsDeviceList
536 if ((Option
->Attribute
& LOAD_OPTION_ACTIVE
) == LOAD_OPTION_ACTIVE
) {
537 InsertTailList (BdsCommonOptionList
, &Option
->Link
);
549 Process BootOrder, or DriverOrder variables, by calling
550 BdsLibVariableToOption () for each UINT16 in the variables.
552 @param BdsCommonOptionList The header of the option list base on variable
554 @param VariableName EFI Variable name indicate the BootOrder or
557 @retval EFI_SUCCESS Success create the boot option or driver option
559 @retval EFI_OUT_OF_RESOURCES Failed to get the boot option or driver option list
564 BdsLibBuildOptionFromVar (
565 IN LIST_ENTRY
*BdsCommonOptionList
,
566 IN CHAR16
*VariableName
570 UINTN OptionOrderSize
;
572 BDS_COMMON_OPTION
*Option
;
573 CHAR16 OptionName
[20];
576 // Zero Buffer in order to get all BOOT#### variables
578 ZeroMem (OptionName
, sizeof (OptionName
));
581 // Read the BootOrder, or DriverOrder variable.
583 OptionOrder
= BdsLibGetVariableAndSize (
585 &gEfiGlobalVariableGuid
,
588 if (OptionOrder
== NULL
) {
589 return EFI_OUT_OF_RESOURCES
;
592 for (Index
= 0; Index
< OptionOrderSize
/ sizeof (UINT16
); Index
++) {
593 if (*VariableName
== 'B') {
594 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", OptionOrder
[Index
]);
596 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Driver%04x", OptionOrder
[Index
]);
599 Option
= BdsLibVariableToOption (BdsCommonOptionList
, OptionName
);
600 Option
->BootCurrent
= OptionOrder
[Index
];
604 FreePool (OptionOrder
);
610 Get boot mode by looking up configuration table and parsing HOB list
612 @param BootMode Boot mode from PEI handoff HOB.
614 @retval EFI_SUCCESS Successfully get boot mode
620 OUT EFI_BOOT_MODE
*BootMode
623 *BootMode
= GetBootModeHob ();
629 Read the EFI variable (VendorGuid/Name) and return a dynamically allocated
630 buffer, and the size of the buffer. If failure return NULL.
632 @param Name String part of EFI variable name
633 @param VendorGuid GUID part of EFI variable name
634 @param VariableSize Returns the size of the EFI variable that was read
636 @return Dynamically allocated memory that contains a copy of the EFI variable.
637 @return Caller is responsible freeing the buffer.
638 @retval NULL Variable was not read
643 BdsLibGetVariableAndSize (
645 IN EFI_GUID
*VendorGuid
,
646 OUT UINTN
*VariableSize
656 // Pass in a zero size buffer to find the required buffer size.
659 Status
= gRT
->GetVariable (Name
, VendorGuid
, NULL
, &BufferSize
, Buffer
);
660 if (Status
== EFI_BUFFER_TOO_SMALL
) {
662 // Allocate the buffer to return
664 Buffer
= AllocateZeroPool (BufferSize
);
665 if (Buffer
== NULL
) {
669 // Read variable into the allocated buffer.
671 Status
= gRT
->GetVariable (Name
, VendorGuid
, NULL
, &BufferSize
, Buffer
);
672 if (EFI_ERROR (Status
)) {
677 *VariableSize
= BufferSize
;
682 Delete the instance in Multi which matches partly with Single instance
684 @param Multi A pointer to a multi-instance device path data
686 @param Single A pointer to a single-instance device path data
689 @return This function will remove the device path instances in Multi which partly
690 match with the Single, and return the result device path. If there is no
691 remaining device path as a result, this function will return NULL.
694 EFI_DEVICE_PATH_PROTOCOL
*
696 BdsLibDelPartMatchInstance (
697 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
698 IN EFI_DEVICE_PATH_PROTOCOL
*Single
701 EFI_DEVICE_PATH_PROTOCOL
*Instance
;
702 EFI_DEVICE_PATH_PROTOCOL
*NewDevicePath
;
703 EFI_DEVICE_PATH_PROTOCOL
*TempNewDevicePath
;
708 NewDevicePath
= NULL
;
709 TempNewDevicePath
= NULL
;
711 if (Multi
== NULL
|| Single
== NULL
) {
715 Instance
= GetNextDevicePathInstance (&Multi
, &InstanceSize
);
716 SingleDpSize
= GetDevicePathSize (Single
) - END_DEVICE_PATH_LENGTH
;
717 InstanceSize
-= END_DEVICE_PATH_LENGTH
;
719 while (Instance
!= NULL
) {
721 Size
= (SingleDpSize
< InstanceSize
) ? SingleDpSize
: InstanceSize
;
723 if ((CompareMem (Instance
, Single
, Size
) != 0)) {
725 // Append the device path instance which does not match with Single
727 TempNewDevicePath
= NewDevicePath
;
728 NewDevicePath
= AppendDevicePathInstance (NewDevicePath
, Instance
);
729 if (TempNewDevicePath
!= NULL
) {
730 FreePool(TempNewDevicePath
);
734 Instance
= GetNextDevicePathInstance (&Multi
, &InstanceSize
);
735 InstanceSize
-= END_DEVICE_PATH_LENGTH
;
738 return NewDevicePath
;
742 Function compares a device path data structure to that of all the nodes of a
743 second device path instance.
745 @param Multi A pointer to a multi-instance device path data
747 @param Single A pointer to a single-instance device path data
750 @retval TRUE If the Single is contained within Multi
751 @retval FALSE The Single is not match within Multi
756 BdsLibMatchDevicePaths (
757 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
758 IN EFI_DEVICE_PATH_PROTOCOL
*Single
761 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
762 EFI_DEVICE_PATH_PROTOCOL
*DevicePathInst
;
765 if (Multi
!= NULL
|| Single
!= NULL
) {
770 DevicePathInst
= GetNextDevicePathInstance (&DevicePath
, &Size
);
773 // Search for the match of 'Single' in 'Multi'
775 while (DevicePathInst
!= NULL
) {
777 // If the single device path is found in multiple device paths,
780 if (CompareMem (Single
, DevicePathInst
, Size
) == 0) {
781 FreePool (DevicePathInst
);
785 FreePool (DevicePathInst
);
786 DevicePathInst
= GetNextDevicePathInstance (&DevicePath
, &Size
);
793 This function prints a series of strings.
795 @param ConOut Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
796 @param ... A variable argument list containing series of
797 strings, the last string must be NULL.
799 @retval EFI_SUCCESS Success print out the string using ConOut.
800 @retval EFI_STATUS Return the status of the ConOut->OutputString ().
805 BdsLibOutputStrings (
806 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*ConOut
,
814 Status
= EFI_SUCCESS
;
815 VA_START (Args
, ConOut
);
817 while (!EFI_ERROR (Status
)) {
819 // If String is NULL, then it's the end of the list
821 String
= VA_ARG (Args
, CHAR16
*);
822 if (String
!= NULL
) {
826 Status
= ConOut
->OutputString (ConOut
, String
);
828 if (EFI_ERROR (Status
)) {
837 // Following are BDS Lib functions which contain all the code about setup browser reset reminder feature.
838 // Setup Browser reset reminder feature is that an reset reminder will be given before user leaves the setup browser if
839 // user change any option setting which needs a reset to be effective, and the reset will be applied according to the user selection.
844 Enable the setup browser reset reminder feature.
845 This routine is used in platform tip. If the platform policy need the feature, use the routine to enable it.
850 EnableResetReminderFeature (
854 mFeaturerSwitch
= TRUE
;
859 Disable the setup browser reset reminder feature.
860 This routine is used in platform tip. If the platform policy do not want the feature, use the routine to disable it.
865 DisableResetReminderFeature (
869 mFeaturerSwitch
= FALSE
;
874 Record the info that a reset is required.
875 A module boolean variable is used to record whether a reset is required.
880 EnableResetRequired (
884 mResetRequired
= TRUE
;
889 Record the info that no reset is required.
890 A module boolean variable is used to record whether a reset is required.
895 DisableResetRequired (
899 mResetRequired
= FALSE
;
904 Check whether platform policy enable the reset reminder feature. The default is enabled.
909 IsResetReminderFeatureEnable (
913 return mFeaturerSwitch
;
918 Check if user changed any option setting which needs a system reset to be effective.
927 return mResetRequired
;
932 Check whether a reset is needed, and finish the reset reminder feature.
933 If a reset is needed, Popup a menu to notice user, and finish the feature
934 according to the user selection.
944 CHAR16
*StringBuffer1
;
945 CHAR16
*StringBuffer2
;
949 //check any reset required change is applied? if yes, reset system
951 if (IsResetReminderFeatureEnable ()) {
952 if (IsResetRequired ()) {
954 StringBuffer1
= AllocateZeroPool (MAX_STRING_LEN
* sizeof (CHAR16
));
955 ASSERT (StringBuffer1
!= NULL
);
956 StringBuffer2
= AllocateZeroPool (MAX_STRING_LEN
* sizeof (CHAR16
));
957 ASSERT (StringBuffer2
!= NULL
);
958 StrCpy (StringBuffer1
, L
"Configuration changed. Reset to apply it Now ? ");
959 StrCpy (StringBuffer2
, L
"Enter (YES) / Esc (NO)");
961 // Popup a menu to notice user
964 IfrLibCreatePopUp (2, &Key
, StringBuffer1
, StringBuffer2
);
965 } while ((Key
.ScanCode
!= SCAN_ESC
) && (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
));
967 FreePool (StringBuffer1
);
968 FreePool (StringBuffer2
);
970 // If the user hits the YES Response key, reset
972 if ((Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
)) {
973 gRT
->ResetSystem (EfiResetCold
, EFI_SUCCESS
, 0, NULL
);
975 gST
->ConOut
->ClearScreen (gST
->ConOut
);
981 Get the headers (dos, image, optional header) from an image.
983 @param Device SimpleFileSystem device handle
984 @param FileName File name for the image
985 @param DosHeader Pointer to dos header
986 @param Hdr Pointer to optional header
988 @retval EFI_SUCCESS Successfully get the machine type.
989 @retval EFI_NOT_FOUND The file is not found.
990 @retval EFI_LOAD_ERROR File is not a valid image file.
995 BdsLibGetImageHeader (
996 IN EFI_HANDLE Device
,
998 OUT EFI_IMAGE_DOS_HEADER
*DosHeader
,
999 OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
1003 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*Volume
;
1004 EFI_FILE_HANDLE Root
;
1005 EFI_FILE_HANDLE ThisFile
;
1008 EFI_FILE_INFO
*Info
;
1013 // Handle the file system interface to the device
1015 Status
= gBS
->HandleProtocol (
1017 &gEfiSimpleFileSystemProtocolGuid
,
1020 if (EFI_ERROR (Status
)) {
1024 Status
= Volume
->OpenVolume (
1028 if (EFI_ERROR (Status
)) {
1033 Status
= Root
->Open (Root
, &ThisFile
, FileName
, EFI_FILE_MODE_READ
, 0);
1034 if (EFI_ERROR (Status
)) {
1041 BufferSize
= SIZE_OF_EFI_FILE_INFO
+ 200;
1044 Status
= gBS
->AllocatePool (EfiBootServicesData
, BufferSize
, (VOID
**) &Info
);
1045 if (EFI_ERROR (Status
)) {
1048 Status
= ThisFile
->GetInfo (
1054 if (!EFI_ERROR (Status
)) {
1057 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
1064 FileSize
= Info
->FileSize
;
1070 BufferSize
= sizeof (EFI_IMAGE_DOS_HEADER
);
1071 Status
= ThisFile
->Read (ThisFile
, &BufferSize
, DosHeader
);
1072 if (EFI_ERROR (Status
) ||
1073 BufferSize
< sizeof (EFI_IMAGE_DOS_HEADER
) ||
1074 FileSize
<= DosHeader
->e_lfanew
||
1075 DosHeader
->e_magic
!= EFI_IMAGE_DOS_SIGNATURE
) {
1076 Status
= EFI_LOAD_ERROR
;
1081 // Move to PE signature
1083 Status
= ThisFile
->SetPosition (ThisFile
, DosHeader
->e_lfanew
);
1084 if (EFI_ERROR (Status
)) {
1085 Status
= EFI_LOAD_ERROR
;
1090 // Read and check PE signature
1092 BufferSize
= sizeof (EFI_IMAGE_OPTIONAL_HEADER_UNION
);
1093 Status
= ThisFile
->Read (ThisFile
, &BufferSize
, Hdr
.Pe32
);
1094 if (EFI_ERROR (Status
) ||
1095 BufferSize
< sizeof (EFI_IMAGE_OPTIONAL_HEADER_UNION
) ||
1096 Hdr
.Pe32
->Signature
!= EFI_IMAGE_NT_SIGNATURE
) {
1097 Status
= EFI_LOAD_ERROR
;
1102 // Check PE32 or PE32+ magic
1104 if (Hdr
.Pe32
->OptionalHeader
.Magic
!= EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
&&
1105 Hdr
.Pe32
->OptionalHeader
.Magic
!= EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
) {
1106 Status
= EFI_LOAD_ERROR
;
1111 if (ThisFile
!= NULL
) {
1112 ThisFile
->Close (ThisFile
);
1122 This routine is a notification function for legayc boot or exit boot
1123 service event. It will adjust the memory information for different
1124 memory type and save them into the variables for next boot.
1127 @param Event The event that triggered this notification function.
1128 @param Context Pointer to the notification functions context.
1133 BdsSetMemoryTypeInformationVariable (
1139 EFI_MEMORY_TYPE_INFORMATION
*PreviousMemoryTypeInformation
;
1140 EFI_MEMORY_TYPE_INFORMATION
*CurrentMemoryTypeInformation
;
1142 BOOLEAN UpdateRequired
;
1148 EFI_HOB_GUID_TYPE
*GuidHob
;
1150 UpdateRequired
= FALSE
;
1153 // Retrieve the current memory usage statistics. If they are not found, then
1154 // no adjustments can be made to the Memory Type Information variable.
1156 Status
= EfiGetSystemConfigurationTable (
1157 &gEfiMemoryTypeInformationGuid
,
1158 (VOID
**) &CurrentMemoryTypeInformation
1160 if (EFI_ERROR (Status
)) {
1165 // Get the Memory Type Information settings from Hob if they exist,
1166 // PEI is responsible for getting them from variable and build a Hob to save them.
1167 // If the previous Memory Type Information is not available, then set defaults
1169 GuidHob
= GetFirstGuidHob (&gEfiMemoryTypeInformationGuid
);
1170 if (GuidHob
== NULL
) {
1172 // If Platform has not built Memory Type Info into the Hob, just return.
1176 PreviousMemoryTypeInformation
= GET_GUID_HOB_DATA (GuidHob
);
1177 VariableSize
= GET_GUID_HOB_DATA_SIZE (GuidHob
);
1180 // Use a heuristic to adjust the Memory Type Information for the next boot
1182 for (Index
= 0; PreviousMemoryTypeInformation
[Index
].Type
!= EfiMaxMemoryType
; Index
++) {
1185 for (Index1
= 0; CurrentMemoryTypeInformation
[Index1
].Type
!= EfiMaxMemoryType
; Index1
++) {
1186 if (PreviousMemoryTypeInformation
[Index
].Type
== CurrentMemoryTypeInformation
[Index1
].Type
) {
1187 Current
= CurrentMemoryTypeInformation
[Index1
].NumberOfPages
;
1192 if (CurrentMemoryTypeInformation
[Index1
].Type
== EfiMaxMemoryType
) {
1196 Previous
= PreviousMemoryTypeInformation
[Index
].NumberOfPages
;
1199 // Write next varible to 125% * current and Inconsistent Memory Reserved across bootings may lead to S4 fail
1201 if (Current
> Previous
) {
1202 Next
= Current
+ (Current
>> 2);
1206 if (Next
> 0 && Next
< 4) {
1210 if (Next
!= Previous
) {
1211 PreviousMemoryTypeInformation
[Index
].NumberOfPages
= Next
;
1212 UpdateRequired
= TRUE
;
1218 // If any changes were made to the Memory Type Information settings, then set the new variable value
1220 if (UpdateRequired
) {
1221 Status
= gRT
->SetVariable (
1222 EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME
,
1223 &gEfiMemoryTypeInformationGuid
,
1224 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
1226 PreviousMemoryTypeInformation
1234 This routine register a function to adjust the different type memory page number just before booting
1235 and save the updated info into the variable for next boot to use.
1240 BdsLibSaveMemoryTypeInformation (
1245 EFI_EVENT ReadyToBootEvent
;
1247 Status
= EfiCreateEventReadyToBootEx (
1249 BdsSetMemoryTypeInformationVariable
,
1253 if (EFI_ERROR (Status
)) {
1254 DEBUG ((DEBUG_ERROR
,"Bds Set Memory Type Informationa Variable Fails\n"));