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 FreePool (TempOptionPtr
);
312 // Option description changed, need update.
314 UpdateDescription
= TRUE
;
315 FreePool (OptionPtr
);
320 FreePool (OptionPtr
);
323 OptionSize
= sizeof (UINT32
) + sizeof (UINT16
) + StrSize (String
);
324 OptionSize
+= GetDevicePathSize (DevicePath
);
325 OptionPtr
= AllocateZeroPool (OptionSize
);
326 ASSERT (OptionPtr
!= NULL
);
329 *(UINT32
*) TempPtr
= LOAD_OPTION_ACTIVE
;
330 TempPtr
+= sizeof (UINT32
);
331 *(UINT16
*) TempPtr
= (UINT16
) GetDevicePathSize (DevicePath
);
332 TempPtr
+= sizeof (UINT16
);
333 CopyMem (TempPtr
, String
, StrSize (String
));
334 TempPtr
+= StrSize (String
);
335 CopyMem (TempPtr
, DevicePath
, GetDevicePathSize (DevicePath
));
337 if (UpdateDescription
) {
339 // The number in option#### to be updated
341 RegisterOptionNumber
= TempOptionPtr
[Index
];
344 // The new option#### number
346 RegisterOptionNumber
= BdsLibGetFreeOptionNumber(VariableName
);
349 if (*VariableName
== 'B') {
350 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", RegisterOptionNumber
);
352 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Driver%04x", RegisterOptionNumber
);
355 Status
= gRT
->SetVariable (
357 &gEfiGlobalVariableGuid
,
358 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
363 // Return if only need to update a changed description or fail to set option.
365 if (EFI_ERROR (Status
) || UpdateDescription
) {
366 FreePool (OptionPtr
);
367 FreePool (TempOptionPtr
);
371 FreePool (OptionPtr
);
374 // Update the option order variable
378 // If no option order
380 if (TempOptionSize
== 0) {
382 Status
= gRT
->SetVariable (
384 &gEfiGlobalVariableGuid
,
385 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
389 FreePool (TempOptionPtr
);
394 // Append the new option number to the original option order
396 OrderItemNum
= (TempOptionSize
/ sizeof (UINT16
)) + 1 ;
397 OptionOrderPtr
= AllocateZeroPool ( OrderItemNum
* sizeof (UINT16
));
398 ASSERT (OptionOrderPtr
!= NULL
);
400 CopyMem (OptionOrderPtr
, TempOptionPtr
, (OrderItemNum
- 1) * sizeof (UINT16
));
402 OptionOrderPtr
[Index
] = RegisterOptionNumber
;
404 Status
= gRT
->SetVariable (
406 &gEfiGlobalVariableGuid
,
407 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
408 OrderItemNum
* sizeof (UINT16
),
411 FreePool (TempOptionPtr
);
412 FreePool (OptionOrderPtr
);
419 Build the boot#### or driver#### option from the VariableName, the
420 build boot#### or driver#### will also be linked to BdsCommonOptionList.
422 @param BdsCommonOptionList The header of the boot#### or driver#### option
424 @param VariableName EFI Variable name indicate if it is boot#### or
427 @retval BDS_COMMON_OPTION Get the option just been created
428 @retval NULL Failed to get the new option
433 BdsLibVariableToOption (
434 IN OUT LIST_ENTRY
*BdsCommonOptionList
,
435 IN CHAR16
*VariableName
443 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
444 BDS_COMMON_OPTION
*Option
;
446 UINT32 LoadOptionsSize
;
450 // Read the variable. We will never free this data.
452 Variable
= BdsLibGetVariableAndSize (
454 &gEfiGlobalVariableGuid
,
457 if (Variable
== NULL
) {
461 // Notes: careful defined the variable of Boot#### or
462 // Driver####, consider use some macro to abstract the code
465 // Get the option attribute
468 Attribute
= *(UINT32
*) Variable
;
469 TempPtr
+= sizeof (UINT32
);
472 // Get the option's device path size
474 FilePathSize
= *(UINT16
*) TempPtr
;
475 TempPtr
+= sizeof (UINT16
);
478 // Get the option's description string
480 Description
= (CHAR16
*) TempPtr
;
483 // Get the option's description string size
485 TempPtr
+= StrSize ((CHAR16
*) TempPtr
);
488 // Get the option's device path
490 DevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
491 TempPtr
+= FilePathSize
;
493 LoadOptions
= TempPtr
;
494 LoadOptionsSize
= (UINT32
) (VariableSize
- (UINTN
) (TempPtr
- Variable
));
497 // The Console variables may have multiple device paths, so make
498 // an Entry for each one.
500 Option
= AllocateZeroPool (sizeof (BDS_COMMON_OPTION
));
501 if (Option
== NULL
) {
505 Option
->Signature
= BDS_LOAD_OPTION_SIGNATURE
;
506 Option
->DevicePath
= AllocateZeroPool (GetDevicePathSize (DevicePath
));
507 CopyMem (Option
->DevicePath
, DevicePath
, GetDevicePathSize (DevicePath
));
508 Option
->Attribute
= Attribute
;
509 Option
->Description
= AllocateZeroPool (StrSize (Description
));
510 CopyMem (Option
->Description
, Description
, StrSize (Description
));
511 Option
->LoadOptions
= AllocateZeroPool (LoadOptionsSize
);
512 CopyMem (Option
->LoadOptions
, LoadOptions
, LoadOptionsSize
);
513 Option
->LoadOptionsSize
= LoadOptionsSize
;
516 // Get the value from VariableName Unicode string
517 // since the ISO standard assumes ASCII equivalent abbreviations, we can be safe in converting this
518 // Unicode stream to ASCII without any loss in meaning.
520 if (*VariableName
== 'B') {
521 NumOff
= sizeof (L
"Boot")/sizeof(CHAR16
) -1 ;
522 Option
->BootCurrent
= (UINT16
) ((VariableName
[NumOff
] -'0') * 0x1000);
523 Option
->BootCurrent
= (UINT16
) (Option
->BootCurrent
+ ((VariableName
[NumOff
+1]-'0') * 0x100));
524 Option
->BootCurrent
= (UINT16
) (Option
->BootCurrent
+ ((VariableName
[NumOff
+2]-'0') * 0x10));
525 Option
->BootCurrent
= (UINT16
) (Option
->BootCurrent
+ ((VariableName
[NumOff
+3]-'0')));
528 // Insert active entry to BdsDeviceList
530 if ((Option
->Attribute
& LOAD_OPTION_ACTIVE
) == LOAD_OPTION_ACTIVE
) {
531 InsertTailList (BdsCommonOptionList
, &Option
->Link
);
543 Process BootOrder, or DriverOrder variables, by calling
544 BdsLibVariableToOption () for each UINT16 in the variables.
546 @param BdsCommonOptionList The header of the option list base on variable
548 @param VariableName EFI Variable name indicate the BootOrder or
551 @retval EFI_SUCCESS Success create the boot option or driver option
553 @retval EFI_OUT_OF_RESOURCES Failed to get the boot option or driver option list
558 BdsLibBuildOptionFromVar (
559 IN LIST_ENTRY
*BdsCommonOptionList
,
560 IN CHAR16
*VariableName
564 UINTN OptionOrderSize
;
566 BDS_COMMON_OPTION
*Option
;
567 CHAR16 OptionName
[20];
570 // Zero Buffer in order to get all BOOT#### variables
572 ZeroMem (OptionName
, sizeof (OptionName
));
575 // Read the BootOrder, or DriverOrder variable.
577 OptionOrder
= BdsLibGetVariableAndSize (
579 &gEfiGlobalVariableGuid
,
582 if (OptionOrder
== NULL
) {
583 return EFI_OUT_OF_RESOURCES
;
586 for (Index
= 0; Index
< OptionOrderSize
/ sizeof (UINT16
); Index
++) {
587 if (*VariableName
== 'B') {
588 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", OptionOrder
[Index
]);
590 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Driver%04x", OptionOrder
[Index
]);
593 Option
= BdsLibVariableToOption (BdsCommonOptionList
, OptionName
);
594 Option
->BootCurrent
= OptionOrder
[Index
];
598 FreePool (OptionOrder
);
604 Get boot mode by looking up configuration table and parsing HOB list
606 @param BootMode Boot mode from PEI handoff HOB.
608 @retval EFI_SUCCESS Successfully get boot mode
614 OUT EFI_BOOT_MODE
*BootMode
617 *BootMode
= GetBootModeHob ();
623 Read the EFI variable (VendorGuid/Name) and return a dynamically allocated
624 buffer, and the size of the buffer. If failure return NULL.
626 @param Name String part of EFI variable name
627 @param VendorGuid GUID part of EFI variable name
628 @param VariableSize Returns the size of the EFI variable that was read
630 @return Dynamically allocated memory that contains a copy of the EFI variable.
631 @return Caller is responsible freeing the buffer.
632 @retval NULL Variable was not read
637 BdsLibGetVariableAndSize (
639 IN EFI_GUID
*VendorGuid
,
640 OUT UINTN
*VariableSize
650 // Pass in a zero size buffer to find the required buffer size.
653 Status
= gRT
->GetVariable (Name
, VendorGuid
, NULL
, &BufferSize
, Buffer
);
654 if (Status
== EFI_BUFFER_TOO_SMALL
) {
656 // Allocate the buffer to return
658 Buffer
= AllocateZeroPool (BufferSize
);
659 if (Buffer
== NULL
) {
663 // Read variable into the allocated buffer.
665 Status
= gRT
->GetVariable (Name
, VendorGuid
, NULL
, &BufferSize
, Buffer
);
666 if (EFI_ERROR (Status
)) {
671 *VariableSize
= BufferSize
;
676 Delete the instance in Multi which matches partly with Single instance
678 @param Multi A pointer to a multi-instance device path data
680 @param Single A pointer to a single-instance device path data
683 @return This function will remove the device path instances in Multi which partly
684 match with the Single, and return the result device path. If there is no
685 remaining device path as a result, this function will return NULL.
688 EFI_DEVICE_PATH_PROTOCOL
*
690 BdsLibDelPartMatchInstance (
691 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
692 IN EFI_DEVICE_PATH_PROTOCOL
*Single
695 EFI_DEVICE_PATH_PROTOCOL
*Instance
;
696 EFI_DEVICE_PATH_PROTOCOL
*NewDevicePath
;
697 EFI_DEVICE_PATH_PROTOCOL
*TempNewDevicePath
;
702 NewDevicePath
= NULL
;
703 TempNewDevicePath
= NULL
;
705 if (Multi
== NULL
|| Single
== NULL
) {
709 Instance
= GetNextDevicePathInstance (&Multi
, &InstanceSize
);
710 SingleDpSize
= GetDevicePathSize (Single
) - END_DEVICE_PATH_LENGTH
;
711 InstanceSize
-= END_DEVICE_PATH_LENGTH
;
713 while (Instance
!= NULL
) {
715 Size
= (SingleDpSize
< InstanceSize
) ? SingleDpSize
: InstanceSize
;
717 if ((CompareMem (Instance
, Single
, Size
) != 0)) {
719 // Append the device path instance which does not match with Single
721 TempNewDevicePath
= NewDevicePath
;
722 NewDevicePath
= AppendDevicePathInstance (NewDevicePath
, Instance
);
723 if (TempNewDevicePath
!= NULL
) {
724 FreePool(TempNewDevicePath
);
728 Instance
= GetNextDevicePathInstance (&Multi
, &InstanceSize
);
729 InstanceSize
-= END_DEVICE_PATH_LENGTH
;
732 return NewDevicePath
;
736 Function compares a device path data structure to that of all the nodes of a
737 second device path instance.
739 @param Multi A pointer to a multi-instance device path data
741 @param Single A pointer to a single-instance device path data
744 @retval TRUE If the Single is contained within Multi
745 @retval FALSE The Single is not match within Multi
750 BdsLibMatchDevicePaths (
751 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
752 IN EFI_DEVICE_PATH_PROTOCOL
*Single
755 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
756 EFI_DEVICE_PATH_PROTOCOL
*DevicePathInst
;
759 if (Multi
!= NULL
|| Single
!= NULL
) {
764 DevicePathInst
= GetNextDevicePathInstance (&DevicePath
, &Size
);
767 // Search for the match of 'Single' in 'Multi'
769 while (DevicePathInst
!= NULL
) {
771 // If the single device path is found in multiple device paths,
774 if (CompareMem (Single
, DevicePathInst
, Size
) == 0) {
775 FreePool (DevicePathInst
);
779 FreePool (DevicePathInst
);
780 DevicePathInst
= GetNextDevicePathInstance (&DevicePath
, &Size
);
787 This function prints a series of strings.
789 @param ConOut Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
790 @param ... A variable argument list containing series of
791 strings, the last string must be NULL.
793 @retval EFI_SUCCESS Success print out the string using ConOut.
794 @retval EFI_STATUS Return the status of the ConOut->OutputString ().
799 BdsLibOutputStrings (
800 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*ConOut
,
808 Status
= EFI_SUCCESS
;
809 VA_START (Args
, ConOut
);
811 while (!EFI_ERROR (Status
)) {
813 // If String is NULL, then it's the end of the list
815 String
= VA_ARG (Args
, CHAR16
*);
816 if (String
!= NULL
) {
820 Status
= ConOut
->OutputString (ConOut
, String
);
822 if (EFI_ERROR (Status
)) {
831 // Following are BDS Lib functions which contain all the code about setup browser reset reminder feature.
832 // Setup Browser reset reminder feature is that an reset reminder will be given before user leaves the setup browser if
833 // user change any option setting which needs a reset to be effective, and the reset will be applied according to the user selection.
838 Enable the setup browser reset reminder feature.
839 This routine is used in platform tip. If the platform policy need the feature, use the routine to enable it.
844 EnableResetReminderFeature (
848 mFeaturerSwitch
= TRUE
;
853 Disable the setup browser reset reminder feature.
854 This routine is used in platform tip. If the platform policy do not want the feature, use the routine to disable it.
859 DisableResetReminderFeature (
863 mFeaturerSwitch
= FALSE
;
868 Record the info that a reset is required.
869 A module boolean variable is used to record whether a reset is required.
874 EnableResetRequired (
878 mResetRequired
= TRUE
;
883 Record the info that no reset is required.
884 A module boolean variable is used to record whether a reset is required.
889 DisableResetRequired (
893 mResetRequired
= FALSE
;
898 Check whether platform policy enable the reset reminder feature. The default is enabled.
903 IsResetReminderFeatureEnable (
907 return mFeaturerSwitch
;
912 Check if user changed any option setting which needs a system reset to be effective.
921 return mResetRequired
;
926 Check whether a reset is needed, and finish the reset reminder feature.
927 If a reset is needed, Popup a menu to notice user, and finish the feature
928 according to the user selection.
938 CHAR16
*StringBuffer1
;
939 CHAR16
*StringBuffer2
;
943 //check any reset required change is applied? if yes, reset system
945 if (IsResetReminderFeatureEnable ()) {
946 if (IsResetRequired ()) {
948 StringBuffer1
= AllocateZeroPool (MAX_STRING_LEN
* sizeof (CHAR16
));
949 ASSERT (StringBuffer1
!= NULL
);
950 StringBuffer2
= AllocateZeroPool (MAX_STRING_LEN
* sizeof (CHAR16
));
951 ASSERT (StringBuffer2
!= NULL
);
952 StrCpy (StringBuffer1
, L
"Configuration changed. Reset to apply it Now ? ");
953 StrCpy (StringBuffer2
, L
"Enter (YES) / Esc (NO)");
955 // Popup a menu to notice user
958 IfrLibCreatePopUp (2, &Key
, StringBuffer1
, StringBuffer2
);
959 } while ((Key
.ScanCode
!= SCAN_ESC
) && (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
));
961 FreePool (StringBuffer1
);
962 FreePool (StringBuffer2
);
964 // If the user hits the YES Response key, reset
966 if ((Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
)) {
967 gRT
->ResetSystem (EfiResetCold
, EFI_SUCCESS
, 0, NULL
);
969 gST
->ConOut
->ClearScreen (gST
->ConOut
);
975 Get the headers (dos, image, optional header) from an image.
977 @param Device SimpleFileSystem device handle
978 @param FileName File name for the image
979 @param DosHeader Pointer to dos header
980 @param Hdr Pointer to optional header
982 @retval EFI_SUCCESS Successfully get the machine type.
983 @retval EFI_NOT_FOUND The file is not found.
984 @retval EFI_LOAD_ERROR File is not a valid image file.
989 BdsLibGetImageHeader (
990 IN EFI_HANDLE Device
,
992 OUT EFI_IMAGE_DOS_HEADER
*DosHeader
,
993 OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
997 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*Volume
;
998 EFI_FILE_HANDLE Root
;
999 EFI_FILE_HANDLE ThisFile
;
1002 EFI_FILE_INFO
*Info
;
1007 // Handle the file system interface to the device
1009 Status
= gBS
->HandleProtocol (
1011 &gEfiSimpleFileSystemProtocolGuid
,
1014 if (EFI_ERROR (Status
)) {
1018 Status
= Volume
->OpenVolume (
1022 if (EFI_ERROR (Status
)) {
1027 Status
= Root
->Open (Root
, &ThisFile
, FileName
, EFI_FILE_MODE_READ
, 0);
1028 if (EFI_ERROR (Status
)) {
1035 BufferSize
= SIZE_OF_EFI_FILE_INFO
+ 200;
1038 Status
= gBS
->AllocatePool (EfiBootServicesData
, BufferSize
, (VOID
**) &Info
);
1039 if (EFI_ERROR (Status
)) {
1042 Status
= ThisFile
->GetInfo (
1048 if (!EFI_ERROR (Status
)) {
1051 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
1058 FileSize
= Info
->FileSize
;
1064 BufferSize
= sizeof (EFI_IMAGE_DOS_HEADER
);
1065 Status
= ThisFile
->Read (ThisFile
, &BufferSize
, DosHeader
);
1066 if (EFI_ERROR (Status
) ||
1067 BufferSize
< sizeof (EFI_IMAGE_DOS_HEADER
) ||
1068 FileSize
<= DosHeader
->e_lfanew
||
1069 DosHeader
->e_magic
!= EFI_IMAGE_DOS_SIGNATURE
) {
1070 Status
= EFI_LOAD_ERROR
;
1075 // Move to PE signature
1077 Status
= ThisFile
->SetPosition (ThisFile
, DosHeader
->e_lfanew
);
1078 if (EFI_ERROR (Status
)) {
1079 Status
= EFI_LOAD_ERROR
;
1084 // Read and check PE signature
1086 BufferSize
= sizeof (EFI_IMAGE_OPTIONAL_HEADER_UNION
);
1087 Status
= ThisFile
->Read (ThisFile
, &BufferSize
, Hdr
.Pe32
);
1088 if (EFI_ERROR (Status
) ||
1089 BufferSize
< sizeof (EFI_IMAGE_OPTIONAL_HEADER_UNION
) ||
1090 Hdr
.Pe32
->Signature
!= EFI_IMAGE_NT_SIGNATURE
) {
1091 Status
= EFI_LOAD_ERROR
;
1096 // Check PE32 or PE32+ magic
1098 if (Hdr
.Pe32
->OptionalHeader
.Magic
!= EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
&&
1099 Hdr
.Pe32
->OptionalHeader
.Magic
!= EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
) {
1100 Status
= EFI_LOAD_ERROR
;
1105 if (ThisFile
!= NULL
) {
1106 ThisFile
->Close (ThisFile
);
1116 This routine is a notification function for legayc boot or exit boot
1117 service event. It will adjust the memory information for different
1118 memory type and save them into the variables for next boot.
1121 @param Event The event that triggered this notification function.
1122 @param Context Pointer to the notification functions context.
1127 BdsSetMemoryTypeInformationVariable (
1133 EFI_MEMORY_TYPE_INFORMATION
*PreviousMemoryTypeInformation
;
1134 EFI_MEMORY_TYPE_INFORMATION
*CurrentMemoryTypeInformation
;
1136 BOOLEAN UpdateRequired
;
1142 EFI_HOB_GUID_TYPE
*GuidHob
;
1144 UpdateRequired
= FALSE
;
1147 // Retrieve the current memory usage statistics. If they are not found, then
1148 // no adjustments can be made to the Memory Type Information variable.
1150 Status
= EfiGetSystemConfigurationTable (
1151 &gEfiMemoryTypeInformationGuid
,
1152 (VOID
**) &CurrentMemoryTypeInformation
1154 if (EFI_ERROR (Status
)) {
1159 // Get the Memory Type Information settings from Hob if they exist,
1160 // PEI is responsible for getting them from variable and build a Hob to save them.
1161 // If the previous Memory Type Information is not available, then set defaults
1163 GuidHob
= GetFirstGuidHob (&gEfiMemoryTypeInformationGuid
);
1164 if (GuidHob
== NULL
) {
1166 // If Platform has not built Memory Type Info into the Hob, just return.
1170 PreviousMemoryTypeInformation
= GET_GUID_HOB_DATA (GuidHob
);
1171 VariableSize
= GET_GUID_HOB_DATA_SIZE (GuidHob
);
1174 // Use a heuristic to adjust the Memory Type Information for the next boot
1176 for (Index
= 0; PreviousMemoryTypeInformation
[Index
].Type
!= EfiMaxMemoryType
; Index
++) {
1179 for (Index1
= 0; CurrentMemoryTypeInformation
[Index1
].Type
!= EfiMaxMemoryType
; Index1
++) {
1180 if (PreviousMemoryTypeInformation
[Index
].Type
== CurrentMemoryTypeInformation
[Index1
].Type
) {
1181 Current
= CurrentMemoryTypeInformation
[Index1
].NumberOfPages
;
1186 if (CurrentMemoryTypeInformation
[Index1
].Type
== EfiMaxMemoryType
) {
1190 Previous
= PreviousMemoryTypeInformation
[Index
].NumberOfPages
;
1193 // Write next varible to 125% * current and Inconsistent Memory Reserved across bootings may lead to S4 fail
1195 if (Current
> Previous
) {
1196 Next
= Current
+ (Current
>> 2);
1200 if (Next
> 0 && Next
< 4) {
1204 if (Next
!= Previous
) {
1205 PreviousMemoryTypeInformation
[Index
].NumberOfPages
= Next
;
1206 UpdateRequired
= TRUE
;
1212 // If any changes were made to the Memory Type Information settings, then set the new variable value
1214 if (UpdateRequired
) {
1215 Status
= gRT
->SetVariable (
1216 EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME
,
1217 &gEfiMemoryTypeInformationGuid
,
1218 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
1220 PreviousMemoryTypeInformation
1228 This routine register a function to adjust the different type memory page number just before booting
1229 and save the updated info into the variable for next boot to use.
1234 BdsLibSaveMemoryTypeInformation (
1239 EFI_EVENT ReadyToBootEvent
;
1241 Status
= EfiCreateEventReadyToBootEx (
1243 BdsSetMemoryTypeInformationVariable
,
1247 if (EFI_ERROR (Status
)) {
1248 DEBUG ((DEBUG_ERROR
,"Bds Set Memory Type Informationa Variable Fails\n"));