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 option link list, load and start
63 every driver the driver option 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 utile 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
,
274 // Compare with current option variable if the previous option is set in global variable.
276 for (Index
= 0; Index
< TempOptionSize
/ sizeof (UINT16
); Index
++) {
278 // TempOptionPtr must not be NULL if we have non-zero TempOptionSize.
280 ASSERT (TempOptionPtr
!= NULL
);
282 if (*VariableName
== 'B') {
283 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", TempOptionPtr
[Index
]);
285 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Driver%04x", TempOptionPtr
[Index
]);
288 OptionPtr
= BdsLibGetVariableAndSize (
290 &gEfiGlobalVariableGuid
,
293 if (OptionPtr
== NULL
) {
297 TempPtr
+= sizeof (UINT32
) + sizeof (UINT16
);
298 Description
= (CHAR16
*) TempPtr
;
299 TempPtr
+= StrSize ((CHAR16
*) TempPtr
);
300 OptionDevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
303 // Notes: the description may will change base on the GetStringToken
305 if (CompareMem (OptionDevicePath
, DevicePath
, GetDevicePathSize (OptionDevicePath
)) == 0) {
306 if (CompareMem (Description
, String
, StrSize (Description
)) == 0) {
308 // Got the option, so just return
310 FreePool (OptionPtr
);
311 FreePool (TempOptionPtr
);
315 // Option description changed, need update.
317 UpdateDescription
= TRUE
;
318 FreePool (OptionPtr
);
323 FreePool (OptionPtr
);
326 OptionSize
= sizeof (UINT32
) + sizeof (UINT16
) + StrSize (String
);
327 OptionSize
+= GetDevicePathSize (DevicePath
);
328 OptionPtr
= AllocateZeroPool (OptionSize
);
329 ASSERT (OptionPtr
!= NULL
);
332 *(UINT32
*) TempPtr
= LOAD_OPTION_ACTIVE
;
333 TempPtr
+= sizeof (UINT32
);
334 *(UINT16
*) TempPtr
= (UINT16
) GetDevicePathSize (DevicePath
);
335 TempPtr
+= sizeof (UINT16
);
336 CopyMem (TempPtr
, String
, StrSize (String
));
337 TempPtr
+= StrSize (String
);
338 CopyMem (TempPtr
, DevicePath
, GetDevicePathSize (DevicePath
));
340 if (UpdateDescription
) {
342 // The number in option#### to be updated.
343 // In this case, we must have non-NULL TempOptionPtr.
345 ASSERT (TempOptionPtr
!= NULL
);
346 RegisterOptionNumber
= TempOptionPtr
[Index
];
349 // The new option#### number
351 RegisterOptionNumber
= BdsLibGetFreeOptionNumber(VariableName
);
354 if (*VariableName
== 'B') {
355 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", RegisterOptionNumber
);
357 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Driver%04x", RegisterOptionNumber
);
360 Status
= gRT
->SetVariable (
362 &gEfiGlobalVariableGuid
,
363 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
368 // Return if only need to update a changed description or fail to set option.
370 if (EFI_ERROR (Status
) || UpdateDescription
) {
371 FreePool (OptionPtr
);
372 if (TempOptionPtr
!= NULL
) {
373 FreePool (TempOptionPtr
);
378 FreePool (OptionPtr
);
381 // Update the option order variable
385 // If no option order
387 if (TempOptionSize
== 0) {
389 Status
= gRT
->SetVariable (
391 &gEfiGlobalVariableGuid
,
392 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
396 if (TempOptionPtr
!= NULL
) {
397 FreePool (TempOptionPtr
);
403 // TempOptionPtr must not be NULL if TempOptionSize is not zero.
405 ASSERT (TempOptionPtr
!= NULL
);
407 // Append the new option number to the original option order
409 OrderItemNum
= (TempOptionSize
/ sizeof (UINT16
)) + 1 ;
410 OptionOrderPtr
= AllocateZeroPool ( OrderItemNum
* sizeof (UINT16
));
411 ASSERT (OptionOrderPtr
!= NULL
);
412 CopyMem (OptionOrderPtr
, TempOptionPtr
, (OrderItemNum
- 1) * sizeof (UINT16
));
414 OptionOrderPtr
[Index
] = RegisterOptionNumber
;
416 Status
= gRT
->SetVariable (
418 &gEfiGlobalVariableGuid
,
419 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
420 OrderItemNum
* sizeof (UINT16
),
423 FreePool (TempOptionPtr
);
424 FreePool (OptionOrderPtr
);
431 Build the boot#### or driver#### option from the VariableName, the
432 build boot#### or driver#### will also be linked to BdsCommonOptionList.
434 @param BdsCommonOptionList The header of the boot#### or driver#### option
436 @param VariableName EFI Variable name indicate if it is boot#### or
439 @retval BDS_COMMON_OPTION Get the option just been created
440 @retval NULL Failed to get the new option
445 BdsLibVariableToOption (
446 IN OUT LIST_ENTRY
*BdsCommonOptionList
,
447 IN CHAR16
*VariableName
455 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
456 BDS_COMMON_OPTION
*Option
;
458 UINT32 LoadOptionsSize
;
462 // Read the variable. We will never free this data.
464 Variable
= BdsLibGetVariableAndSize (
466 &gEfiGlobalVariableGuid
,
469 if (Variable
== NULL
) {
473 // Notes: careful defined the variable of Boot#### or
474 // Driver####, consider use some macro to abstract the code
477 // Get the option attribute
480 Attribute
= *(UINT32
*) Variable
;
481 TempPtr
+= sizeof (UINT32
);
484 // Get the option's device path size
486 FilePathSize
= *(UINT16
*) TempPtr
;
487 TempPtr
+= sizeof (UINT16
);
490 // Get the option's description string
492 Description
= (CHAR16
*) TempPtr
;
495 // Get the option's description string size
497 TempPtr
+= StrSize ((CHAR16
*) TempPtr
);
500 // Get the option's device path
502 DevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
503 TempPtr
+= FilePathSize
;
505 LoadOptions
= TempPtr
;
506 LoadOptionsSize
= (UINT32
) (VariableSize
- (UINTN
) (TempPtr
- Variable
));
509 // The Console variables may have multiple device paths, so make
510 // an Entry for each one.
512 Option
= AllocateZeroPool (sizeof (BDS_COMMON_OPTION
));
513 if (Option
== NULL
) {
517 Option
->Signature
= BDS_LOAD_OPTION_SIGNATURE
;
518 Option
->DevicePath
= AllocateZeroPool (GetDevicePathSize (DevicePath
));
519 ASSERT(Option
->DevicePath
!= NULL
);
520 CopyMem (Option
->DevicePath
, DevicePath
, GetDevicePathSize (DevicePath
));
522 Option
->Attribute
= Attribute
;
523 Option
->Description
= AllocateZeroPool (StrSize (Description
));
524 ASSERT(Option
->Description
!= NULL
);
525 CopyMem (Option
->Description
, Description
, StrSize (Description
));
527 Option
->LoadOptions
= AllocateZeroPool (LoadOptionsSize
);
528 ASSERT(Option
->LoadOptions
!= NULL
);
529 CopyMem (Option
->LoadOptions
, LoadOptions
, LoadOptionsSize
);
530 Option
->LoadOptionsSize
= LoadOptionsSize
;
533 // Get the value from VariableName Unicode string
534 // since the ISO standard assumes ASCII equivalent abbreviations, we can be safe in converting this
535 // Unicode stream to ASCII without any loss in meaning.
537 if (*VariableName
== 'B') {
538 NumOff
= sizeof (L
"Boot")/sizeof(CHAR16
) -1 ;
539 Option
->BootCurrent
= (UINT16
) ((VariableName
[NumOff
] -'0') * 0x1000);
540 Option
->BootCurrent
= (UINT16
) (Option
->BootCurrent
+ ((VariableName
[NumOff
+1]-'0') * 0x100));
541 Option
->BootCurrent
= (UINT16
) (Option
->BootCurrent
+ ((VariableName
[NumOff
+2]-'0') * 0x10));
542 Option
->BootCurrent
= (UINT16
) (Option
->BootCurrent
+ ((VariableName
[NumOff
+3]-'0')));
545 // Insert active entry to BdsDeviceList
547 if ((Option
->Attribute
& LOAD_OPTION_ACTIVE
) == LOAD_OPTION_ACTIVE
) {
548 InsertTailList (BdsCommonOptionList
, &Option
->Link
);
560 Process BootOrder, or DriverOrder variables, by calling
561 BdsLibVariableToOption () for each UINT16 in the variables.
563 @param BdsCommonOptionList The header of the option list base on variable
565 @param VariableName EFI Variable name indicate the BootOrder or
568 @retval EFI_SUCCESS Success create the boot option or driver option
570 @retval EFI_OUT_OF_RESOURCES Failed to get the boot option or driver option list
575 BdsLibBuildOptionFromVar (
576 IN LIST_ENTRY
*BdsCommonOptionList
,
577 IN CHAR16
*VariableName
581 UINTN OptionOrderSize
;
583 BDS_COMMON_OPTION
*Option
;
584 CHAR16 OptionName
[20];
587 // Zero Buffer in order to get all BOOT#### variables
589 ZeroMem (OptionName
, sizeof (OptionName
));
592 // Read the BootOrder, or DriverOrder variable.
594 OptionOrder
= BdsLibGetVariableAndSize (
596 &gEfiGlobalVariableGuid
,
599 if (OptionOrder
== NULL
) {
600 return EFI_OUT_OF_RESOURCES
;
603 for (Index
= 0; Index
< OptionOrderSize
/ sizeof (UINT16
); Index
++) {
604 if (*VariableName
== 'B') {
605 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", OptionOrder
[Index
]);
607 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Driver%04x", OptionOrder
[Index
]);
610 Option
= BdsLibVariableToOption (BdsCommonOptionList
, OptionName
);
611 ASSERT (Option
!= NULL
);
612 Option
->BootCurrent
= OptionOrder
[Index
];
616 FreePool (OptionOrder
);
622 Get boot mode by looking up configuration table and parsing HOB list
624 @param BootMode Boot mode from PEI handoff HOB.
626 @retval EFI_SUCCESS Successfully get boot mode
632 OUT EFI_BOOT_MODE
*BootMode
635 *BootMode
= GetBootModeHob ();
641 Read the EFI variable (VendorGuid/Name) and return a dynamically allocated
642 buffer, and the size of the buffer. If failure return NULL.
644 @param Name String part of EFI variable name
645 @param VendorGuid GUID part of EFI variable name
646 @param VariableSize Returns the size of the EFI variable that was read
648 @return Dynamically allocated memory that contains a copy of the EFI variable
649 Caller is responsible freeing the buffer.
650 @retval NULL Variable was not read
655 BdsLibGetVariableAndSize (
657 IN EFI_GUID
*VendorGuid
,
658 OUT UINTN
*VariableSize
668 // Pass in a zero size buffer to find the required buffer size.
671 Status
= gRT
->GetVariable (Name
, VendorGuid
, NULL
, &BufferSize
, Buffer
);
672 if (Status
== EFI_BUFFER_TOO_SMALL
) {
674 // Allocate the buffer to return
676 Buffer
= AllocateZeroPool (BufferSize
);
677 if (Buffer
== NULL
) {
681 // Read variable into the allocated buffer.
683 Status
= gRT
->GetVariable (Name
, VendorGuid
, NULL
, &BufferSize
, Buffer
);
684 if (EFI_ERROR (Status
)) {
689 *VariableSize
= BufferSize
;
694 Delete the instance in Multi which matches partly with Single instance
696 @param Multi A pointer to a multi-instance device path data
698 @param Single A pointer to a single-instance device path data
701 @return This function will remove the device path instances in Multi which partly
702 match with the Single, and return the result device path. If there is no
703 remaining device path as a result, this function will return NULL.
706 EFI_DEVICE_PATH_PROTOCOL
*
708 BdsLibDelPartMatchInstance (
709 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
710 IN EFI_DEVICE_PATH_PROTOCOL
*Single
713 EFI_DEVICE_PATH_PROTOCOL
*Instance
;
714 EFI_DEVICE_PATH_PROTOCOL
*NewDevicePath
;
715 EFI_DEVICE_PATH_PROTOCOL
*TempNewDevicePath
;
720 NewDevicePath
= NULL
;
721 TempNewDevicePath
= NULL
;
723 if (Multi
== NULL
|| Single
== NULL
) {
727 Instance
= GetNextDevicePathInstance (&Multi
, &InstanceSize
);
728 SingleDpSize
= GetDevicePathSize (Single
) - END_DEVICE_PATH_LENGTH
;
729 InstanceSize
-= END_DEVICE_PATH_LENGTH
;
731 while (Instance
!= NULL
) {
733 Size
= (SingleDpSize
< InstanceSize
) ? SingleDpSize
: InstanceSize
;
735 if ((CompareMem (Instance
, Single
, Size
) != 0)) {
737 // Append the device path instance which does not match with Single
739 TempNewDevicePath
= NewDevicePath
;
740 NewDevicePath
= AppendDevicePathInstance (NewDevicePath
, Instance
);
741 if (TempNewDevicePath
!= NULL
) {
742 FreePool(TempNewDevicePath
);
746 Instance
= GetNextDevicePathInstance (&Multi
, &InstanceSize
);
747 InstanceSize
-= END_DEVICE_PATH_LENGTH
;
750 return NewDevicePath
;
754 Function compares a device path data structure to that of all the nodes of a
755 second device path instance.
757 @param Multi A pointer to a multi-instance device path data
759 @param Single A pointer to a single-instance device path data
762 @retval TRUE If the Single device path is contained within Multi device path.
763 @retval FALSE The Single device path is not match within Multi device path.
768 BdsLibMatchDevicePaths (
769 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
770 IN EFI_DEVICE_PATH_PROTOCOL
*Single
773 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
774 EFI_DEVICE_PATH_PROTOCOL
*DevicePathInst
;
777 if (Multi
== NULL
|| Single
== NULL
) {
782 DevicePathInst
= GetNextDevicePathInstance (&DevicePath
, &Size
);
785 // Search for the match of 'Single' in 'Multi'
787 while (DevicePathInst
!= NULL
) {
789 // If the single device path is found in multiple device paths,
792 if (CompareMem (Single
, DevicePathInst
, Size
) == 0) {
793 FreePool (DevicePathInst
);
797 FreePool (DevicePathInst
);
798 DevicePathInst
= GetNextDevicePathInstance (&DevicePath
, &Size
);
805 This function prints a series of strings.
807 @param ConOut Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
808 @param ... A variable argument list containing series of
809 strings, the last string must be NULL.
811 @retval EFI_SUCCESS Success print out the string using ConOut.
812 @retval EFI_STATUS Return the status of the ConOut->OutputString ().
817 BdsLibOutputStrings (
818 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*ConOut
,
826 Status
= EFI_SUCCESS
;
827 VA_START (Args
, ConOut
);
829 while (!EFI_ERROR (Status
)) {
831 // If String is NULL, then it's the end of the list
833 String
= VA_ARG (Args
, CHAR16
*);
834 if (String
!= NULL
) {
838 Status
= ConOut
->OutputString (ConOut
, String
);
840 if (EFI_ERROR (Status
)) {
850 // Following are BDS Lib functions which contain all the code about setup browser reset reminder feature.
851 // Setup Browser reset reminder feature is that an reset reminder will be given before user leaves the setup browser if
852 // user change any option setting which needs a reset to be effective, and the reset will be applied according to the user selection.
857 Enable the setup browser reset reminder feature.
858 This routine is used in platform tip. If the platform policy need the feature, use the routine to enable it.
863 EnableResetReminderFeature (
867 mFeaturerSwitch
= TRUE
;
872 Disable the setup browser reset reminder feature.
873 This routine is used in platform tip. If the platform policy do not want the feature, use the routine to disable it.
878 DisableResetReminderFeature (
882 mFeaturerSwitch
= FALSE
;
887 Record the info that a reset is required.
888 A module boolean variable is used to record whether a reset is required.
893 EnableResetRequired (
897 mResetRequired
= TRUE
;
902 Record the info that no reset is required.
903 A module boolean variable is used to record whether a reset is required.
908 DisableResetRequired (
912 mResetRequired
= FALSE
;
917 Check whether platform policy enable the reset reminder feature. The default is enabled.
922 IsResetReminderFeatureEnable (
926 return mFeaturerSwitch
;
931 Check if user changed any option setting which needs a system reset to be effective.
940 return mResetRequired
;
945 Check whether a reset is needed, and finish the reset reminder feature.
946 If a reset is needed, Popup a menu to notice user, and finish the feature
947 according to the user selection.
957 CHAR16
*StringBuffer1
;
958 CHAR16
*StringBuffer2
;
962 //check any reset required change is applied? if yes, reset system
964 if (IsResetReminderFeatureEnable ()) {
965 if (IsResetRequired ()) {
967 StringBuffer1
= AllocateZeroPool (MAX_STRING_LEN
* sizeof (CHAR16
));
968 ASSERT (StringBuffer1
!= NULL
);
969 StringBuffer2
= AllocateZeroPool (MAX_STRING_LEN
* sizeof (CHAR16
));
970 ASSERT (StringBuffer2
!= NULL
);
971 StrCpy (StringBuffer1
, L
"Configuration changed. Reset to apply it Now ? ");
972 StrCpy (StringBuffer2
, L
"Enter (YES) / Esc (NO)");
974 // Popup a menu to notice user
977 IfrLibCreatePopUp (2, &Key
, StringBuffer1
, StringBuffer2
);
978 } while ((Key
.ScanCode
!= SCAN_ESC
) && (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
));
980 FreePool (StringBuffer1
);
981 FreePool (StringBuffer2
);
983 // If the user hits the YES Response key, reset
985 if ((Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
)) {
986 gRT
->ResetSystem (EfiResetCold
, EFI_SUCCESS
, 0, NULL
);
988 gST
->ConOut
->ClearScreen (gST
->ConOut
);
994 Get the headers (dos, image, optional header) from an image
996 @param Device SimpleFileSystem device handle
997 @param FileName File name for the image
998 @param DosHeader Pointer to dos header
999 @param Hdr The buffer in which to return the PE32, PE32+, or TE header.
1001 @retval EFI_SUCCESS Successfully get the machine type.
1002 @retval EFI_NOT_FOUND The file is not found.
1003 @retval EFI_LOAD_ERROR File is not a valid image file.
1008 BdsLibGetImageHeader (
1009 IN EFI_HANDLE Device
,
1010 IN CHAR16
*FileName
,
1011 OUT EFI_IMAGE_DOS_HEADER
*DosHeader
,
1012 OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
1016 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*Volume
;
1017 EFI_FILE_HANDLE Root
;
1018 EFI_FILE_HANDLE ThisFile
;
1021 EFI_FILE_INFO
*Info
;
1026 // Handle the file system interface to the device
1028 Status
= gBS
->HandleProtocol (
1030 &gEfiSimpleFileSystemProtocolGuid
,
1033 if (EFI_ERROR (Status
)) {
1037 Status
= Volume
->OpenVolume (
1041 if (EFI_ERROR (Status
)) {
1046 Status
= Root
->Open (Root
, &ThisFile
, FileName
, EFI_FILE_MODE_READ
, 0);
1047 if (EFI_ERROR (Status
)) {
1054 BufferSize
= SIZE_OF_EFI_FILE_INFO
+ 200;
1057 Status
= gBS
->AllocatePool (EfiBootServicesData
, BufferSize
, (VOID
**) &Info
);
1058 if (EFI_ERROR (Status
)) {
1061 Status
= ThisFile
->GetInfo (
1067 if (!EFI_ERROR (Status
)) {
1070 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
1077 FileSize
= Info
->FileSize
;
1083 BufferSize
= sizeof (EFI_IMAGE_DOS_HEADER
);
1084 Status
= ThisFile
->Read (ThisFile
, &BufferSize
, DosHeader
);
1085 if (EFI_ERROR (Status
) ||
1086 BufferSize
< sizeof (EFI_IMAGE_DOS_HEADER
) ||
1087 FileSize
<= DosHeader
->e_lfanew
||
1088 DosHeader
->e_magic
!= EFI_IMAGE_DOS_SIGNATURE
) {
1089 Status
= EFI_LOAD_ERROR
;
1094 // Move to PE signature
1096 Status
= ThisFile
->SetPosition (ThisFile
, DosHeader
->e_lfanew
);
1097 if (EFI_ERROR (Status
)) {
1098 Status
= EFI_LOAD_ERROR
;
1103 // Read and check PE signature
1105 BufferSize
= sizeof (EFI_IMAGE_OPTIONAL_HEADER_UNION
);
1106 Status
= ThisFile
->Read (ThisFile
, &BufferSize
, Hdr
.Pe32
);
1107 if (EFI_ERROR (Status
) ||
1108 BufferSize
< sizeof (EFI_IMAGE_OPTIONAL_HEADER_UNION
) ||
1109 Hdr
.Pe32
->Signature
!= EFI_IMAGE_NT_SIGNATURE
) {
1110 Status
= EFI_LOAD_ERROR
;
1115 // Check PE32 or PE32+ magic
1117 if (Hdr
.Pe32
->OptionalHeader
.Magic
!= EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
&&
1118 Hdr
.Pe32
->OptionalHeader
.Magic
!= EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
) {
1119 Status
= EFI_LOAD_ERROR
;
1124 if (ThisFile
!= NULL
) {
1125 ThisFile
->Close (ThisFile
);
1135 This routine is a notification function for legayc boot or exit boot
1136 service event. It will adjust the memory information for different
1137 memory type and save them into the variables for next boot.
1140 @param Event The event that triggered this notification function.
1141 @param Context Pointer to the notification functions context.
1146 BdsSetMemoryTypeInformationVariable (
1152 EFI_MEMORY_TYPE_INFORMATION
*PreviousMemoryTypeInformation
;
1153 EFI_MEMORY_TYPE_INFORMATION
*CurrentMemoryTypeInformation
;
1155 BOOLEAN UpdateRequired
;
1161 EFI_HOB_GUID_TYPE
*GuidHob
;
1163 UpdateRequired
= FALSE
;
1166 // Retrieve the current memory usage statistics. If they are not found, then
1167 // no adjustments can be made to the Memory Type Information variable.
1169 Status
= EfiGetSystemConfigurationTable (
1170 &gEfiMemoryTypeInformationGuid
,
1171 (VOID
**) &CurrentMemoryTypeInformation
1173 if (EFI_ERROR (Status
) || CurrentMemoryTypeInformation
== NULL
) {
1178 // Get the Memory Type Information settings from Hob if they exist,
1179 // PEI is responsible for getting them from variable and build a Hob to save them.
1180 // If the previous Memory Type Information is not available, then set defaults
1182 GuidHob
= GetFirstGuidHob (&gEfiMemoryTypeInformationGuid
);
1183 if (GuidHob
== NULL
) {
1185 // If Platform has not built Memory Type Info into the Hob, just return.
1189 PreviousMemoryTypeInformation
= GET_GUID_HOB_DATA (GuidHob
);
1190 VariableSize
= GET_GUID_HOB_DATA_SIZE (GuidHob
);
1193 // Use a heuristic to adjust the Memory Type Information for the next boot
1195 for (Index
= 0; PreviousMemoryTypeInformation
[Index
].Type
!= EfiMaxMemoryType
; Index
++) {
1198 for (Index1
= 0; CurrentMemoryTypeInformation
[Index1
].Type
!= EfiMaxMemoryType
; Index1
++) {
1199 if (PreviousMemoryTypeInformation
[Index
].Type
== CurrentMemoryTypeInformation
[Index1
].Type
) {
1200 Current
= CurrentMemoryTypeInformation
[Index1
].NumberOfPages
;
1205 if (CurrentMemoryTypeInformation
[Index1
].Type
== EfiMaxMemoryType
) {
1209 Previous
= PreviousMemoryTypeInformation
[Index
].NumberOfPages
;
1212 // Write next varible to 125% * current and Inconsistent Memory Reserved across bootings may lead to S4 fail
1214 if (Current
> Previous
) {
1215 Next
= Current
+ (Current
>> 2);
1219 if (Next
> 0 && Next
< 4) {
1223 if (Next
!= Previous
) {
1224 PreviousMemoryTypeInformation
[Index
].NumberOfPages
= Next
;
1225 UpdateRequired
= TRUE
;
1231 // If any changes were made to the Memory Type Information settings, then set the new variable value
1233 if (UpdateRequired
) {
1234 Status
= gRT
->SetVariable (
1235 EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME
,
1236 &gEfiMemoryTypeInformationGuid
,
1237 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
1239 PreviousMemoryTypeInformation
1247 This routine register a function to adjust the different type memory page number
1248 just before booting and save the updated info into the variable for next boot to use.
1253 BdsLibSaveMemoryTypeInformation (
1258 EFI_EVENT ReadyToBootEvent
;
1260 Status
= EfiCreateEventReadyToBootEx (
1262 BdsSetMemoryTypeInformationVariable
,
1266 if (EFI_ERROR (Status
)) {
1267 DEBUG ((DEBUG_ERROR
,"Bds Set Memory Type Informationa Variable Fails\n"));