2 Misc BDS library function
4 Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>
5 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
;
26 The function will go through the driver option link list, load and start
27 every driver the driver option device path point to.
29 @param BdsDriverLists The header of the current driver option link list
35 IN LIST_ENTRY
*BdsDriverLists
40 BDS_COMMON_OPTION
*Option
;
41 EFI_HANDLE ImageHandle
;
42 EFI_LOADED_IMAGE_PROTOCOL
*ImageInfo
;
50 // Process the driver option
52 for (Link
= BdsDriverLists
->ForwardLink
; Link
!= BdsDriverLists
; Link
= Link
->ForwardLink
) {
53 Option
= CR (Link
, BDS_COMMON_OPTION
, Link
, BDS_LOAD_OPTION_SIGNATURE
);
56 // If a load option is not marked as LOAD_OPTION_ACTIVE,
57 // the boot manager will not automatically load the option.
59 if (!IS_LOAD_OPTION_TYPE (Option
->Attribute
, LOAD_OPTION_ACTIVE
)) {
64 // If a driver load option is marked as LOAD_OPTION_FORCE_RECONNECT,
65 // then all of the EFI drivers in the system will be disconnected and
66 // reconnected after the last driver load option is processed.
68 if (IS_LOAD_OPTION_TYPE (Option
->Attribute
, LOAD_OPTION_FORCE_RECONNECT
)) {
73 // Make sure the driver path is connected.
75 BdsLibConnectDevicePath (Option
->DevicePath
);
78 // Load and start the image that Driver#### describes
80 Status
= gBS
->LoadImage (
89 if (!EFI_ERROR (Status
)) {
90 gBS
->HandleProtocol (ImageHandle
, &gEfiLoadedImageProtocolGuid
, (VOID
**) &ImageInfo
);
93 // Verify whether this image is a driver, if not,
94 // exit it and continue to parse next load option
96 if (ImageInfo
->ImageCodeType
!= EfiBootServicesCode
&& ImageInfo
->ImageCodeType
!= EfiRuntimeServicesCode
) {
97 gBS
->Exit (ImageHandle
, EFI_INVALID_PARAMETER
, 0, NULL
);
101 if (Option
->LoadOptionsSize
!= 0) {
102 ImageInfo
->LoadOptionsSize
= Option
->LoadOptionsSize
;
103 ImageInfo
->LoadOptions
= Option
->LoadOptions
;
106 // Before calling the image, enable the Watchdog Timer for
107 // the 5 Minute period
109 gBS
->SetWatchdogTimer (5 * 60, 0x0000, 0x00, NULL
);
111 Status
= gBS
->StartImage (ImageHandle
, &ExitDataSize
, &ExitData
);
112 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Driver Return Status = %r\n", Status
));
115 // Clear the Watchdog Timer after the image returns
117 gBS
->SetWatchdogTimer (0x0000, 0x0000, 0x0000, NULL
);
122 // Process the LOAD_OPTION_FORCE_RECONNECT driver option
125 BdsLibDisconnectAllEfi ();
132 Get the Option Number that does not used.
133 Try to locate the specific option variable one by one utile find a free number.
135 @param VariableName Indicate if the boot#### or driver#### option
137 @return The Minimal Free Option Number
141 BdsLibGetFreeOptionNumber (
142 IN CHAR16
*VariableName
147 UINT16
*OptionBuffer
;
151 // Try to find the minimum free number from 0, 1, 2, 3....
155 if (*VariableName
== 'B') {
156 UnicodeSPrint (StrTemp
, sizeof (StrTemp
), L
"Boot%04x", Index
);
158 UnicodeSPrint (StrTemp
, sizeof (StrTemp
), L
"Driver%04x", Index
);
161 // try if the option number is used
163 OptionBuffer
= BdsLibGetVariableAndSize (
165 &gEfiGlobalVariableGuid
,
168 if (OptionBuffer
== NULL
) {
174 return ((UINT16
) Index
);
179 This function will register the new boot#### or driver#### option base on
180 the VariableName. The new registered boot#### or driver#### will be linked
181 to BdsOptionList and also update to the VariableName. After the boot#### or
182 driver#### updated, the BootOrder or DriverOrder will also be updated.
184 @param BdsOptionList The header of the boot#### or driver#### link list
185 @param DevicePath The device path which the boot#### or driver####
187 @param String The description of the boot#### or driver####
188 @param VariableName Indicate if the boot#### or driver#### option
190 @retval EFI_SUCCESS The boot#### or driver#### have been success
192 @retval EFI_STATUS Return the status of gRT->SetVariable ().
197 BdsLibRegisterNewOption (
198 IN LIST_ENTRY
*BdsOptionList
,
199 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
201 IN CHAR16
*VariableName
206 UINT16 RegisterOptionNumber
;
207 UINT16
*TempOptionPtr
;
208 UINTN TempOptionSize
;
209 UINT16
*OptionOrderPtr
;
213 EFI_DEVICE_PATH_PROTOCOL
*OptionDevicePath
;
215 CHAR16 OptionName
[10];
216 BOOLEAN UpdateDescription
;
217 UINT16 BootOrderEntry
;
224 OptionDevicePath
= NULL
;
226 OptionOrderPtr
= NULL
;
227 UpdateDescription
= FALSE
;
228 Status
= EFI_SUCCESS
;
229 ZeroMem (OptionName
, sizeof (OptionName
));
232 TempOptionPtr
= BdsLibGetVariableAndSize (
234 &gEfiGlobalVariableGuid
,
238 // Compare with current option variable if the previous option is set in global variable.
240 for (Index
= 0; Index
< TempOptionSize
/ sizeof (UINT16
); Index
++) {
242 // TempOptionPtr must not be NULL if we have non-zero TempOptionSize.
244 ASSERT (TempOptionPtr
!= NULL
);
246 if (*VariableName
== 'B') {
247 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", TempOptionPtr
[Index
]);
249 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Driver%04x", TempOptionPtr
[Index
]);
252 OptionPtr
= BdsLibGetVariableAndSize (
254 &gEfiGlobalVariableGuid
,
257 if (OptionPtr
== NULL
) {
261 TempPtr
+= sizeof (UINT32
) + sizeof (UINT16
);
262 Description
= (CHAR16
*) TempPtr
;
263 TempPtr
+= StrSize ((CHAR16
*) TempPtr
);
264 OptionDevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
267 // Notes: the description may will change base on the GetStringToken
269 if (CompareMem (OptionDevicePath
, DevicePath
, GetDevicePathSize (OptionDevicePath
)) == 0) {
270 if (CompareMem (Description
, String
, StrSize (Description
)) == 0) {
272 // Got the option, so just return
274 FreePool (OptionPtr
);
275 FreePool (TempOptionPtr
);
279 // Option description changed, need update.
281 UpdateDescription
= TRUE
;
282 FreePool (OptionPtr
);
287 FreePool (OptionPtr
);
290 OptionSize
= sizeof (UINT32
) + sizeof (UINT16
) + StrSize (String
);
291 OptionSize
+= GetDevicePathSize (DevicePath
);
292 OptionPtr
= AllocateZeroPool (OptionSize
);
293 ASSERT (OptionPtr
!= NULL
);
296 *(UINT32
*) TempPtr
= LOAD_OPTION_ACTIVE
;
297 TempPtr
+= sizeof (UINT32
);
298 *(UINT16
*) TempPtr
= (UINT16
) GetDevicePathSize (DevicePath
);
299 TempPtr
+= sizeof (UINT16
);
300 CopyMem (TempPtr
, String
, StrSize (String
));
301 TempPtr
+= StrSize (String
);
302 CopyMem (TempPtr
, DevicePath
, GetDevicePathSize (DevicePath
));
304 if (UpdateDescription
) {
306 // The number in option#### to be updated.
307 // In this case, we must have non-NULL TempOptionPtr.
309 ASSERT (TempOptionPtr
!= NULL
);
310 RegisterOptionNumber
= TempOptionPtr
[Index
];
313 // The new option#### number
315 RegisterOptionNumber
= BdsLibGetFreeOptionNumber(VariableName
);
318 if (*VariableName
== 'B') {
319 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", RegisterOptionNumber
);
321 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Driver%04x", RegisterOptionNumber
);
324 Status
= gRT
->SetVariable (
326 &gEfiGlobalVariableGuid
,
327 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
332 // Return if only need to update a changed description or fail to set option.
334 if (EFI_ERROR (Status
) || UpdateDescription
) {
335 FreePool (OptionPtr
);
336 if (TempOptionPtr
!= NULL
) {
337 FreePool (TempOptionPtr
);
342 FreePool (OptionPtr
);
345 // Update the option order variable
349 // If no option order
351 if (TempOptionSize
== 0) {
353 Status
= gRT
->SetVariable (
355 &gEfiGlobalVariableGuid
,
356 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
360 if (TempOptionPtr
!= NULL
) {
361 FreePool (TempOptionPtr
);
367 // TempOptionPtr must not be NULL if TempOptionSize is not zero.
369 ASSERT (TempOptionPtr
!= NULL
);
371 // Append the new option number to the original option order
373 OrderItemNum
= (TempOptionSize
/ sizeof (UINT16
)) + 1 ;
374 OptionOrderPtr
= AllocateZeroPool ( OrderItemNum
* sizeof (UINT16
));
375 ASSERT (OptionOrderPtr
!= NULL
);
376 CopyMem (OptionOrderPtr
, TempOptionPtr
, (OrderItemNum
- 1) * sizeof (UINT16
));
378 OptionOrderPtr
[Index
] = RegisterOptionNumber
;
380 Status
= gRT
->SetVariable (
382 &gEfiGlobalVariableGuid
,
383 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
384 OrderItemNum
* sizeof (UINT16
),
387 FreePool (TempOptionPtr
);
388 FreePool (OptionOrderPtr
);
394 Returns the size of a device path in bytes.
396 This function returns the size, in bytes, of the device path data structure
397 specified by DevicePath including the end of device path node. If DevicePath
398 is NULL, then 0 is returned. If the length of the device path is bigger than
399 MaxSize, also return 0 to indicate this is an invalidate device path.
401 @param DevicePath A pointer to a device path data structure.
402 @param MaxSize Max valid device path size. If big than this size,
405 @retval 0 An invalid device path.
406 @retval Others The size of a device path in bytes.
410 GetDevicePathSizeEx (
411 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
418 if (DevicePath
== NULL
) {
423 // Search for the end of the device path structure
426 while (!IsDevicePathEnd (DevicePath
)) {
427 NodeSize
= DevicePathNodeLength (DevicePath
);
432 if (Size
> MaxSize
) {
435 DevicePath
= NextDevicePathNode (DevicePath
);
437 Size
+= DevicePathNodeLength (DevicePath
);
438 if (Size
> MaxSize
) {
446 Returns the length of a Null-terminated Unicode string. If the length is
447 bigger than MaxStringLen, return length 0 to indicate that this is an
450 This function returns the number of Unicode characters in the Null-terminated
451 Unicode string specified by String.
453 If String is NULL, then ASSERT().
454 If String is not aligned on a 16-bit boundary, then ASSERT().
456 @param String A pointer to a Null-terminated Unicode string.
457 @param MaxStringLen Max string len in this string.
459 @retval 0 An invalid string.
460 @retval Others The length of String.
465 IN CONST CHAR16
*String
,
466 IN UINTN MaxStringLen
471 ASSERT (String
!= NULL
&& MaxStringLen
!= 0);
472 ASSERT (((UINTN
) String
& BIT0
) == 0);
474 for (Length
= 0; *String
!= L
'\0' && MaxStringLen
!= Length
; String
++, Length
++);
476 if (*String
!= L
'\0' && MaxStringLen
== Length
) {
480 return (Length
+ 1) * sizeof (*String
);
484 Build the boot#### or driver#### option from the VariableName, the
485 build boot#### or driver#### will also be linked to BdsCommonOptionList.
487 @param BdsCommonOptionList The header of the boot#### or driver#### option
489 @param VariableName EFI Variable name indicate if it is boot#### or
492 @retval BDS_COMMON_OPTION Get the option just been created
493 @retval NULL Failed to get the new option
498 BdsLibVariableToOption (
499 IN OUT LIST_ENTRY
*BdsCommonOptionList
,
500 IN CHAR16
*VariableName
508 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
509 EFI_DEVICE_PATH_PROTOCOL
*TempPath
;
510 BDS_COMMON_OPTION
*Option
;
512 UINT32 LoadOptionsSize
;
517 // Read the variable. We will never free this data.
519 Variable
= BdsLibGetVariableAndSize (
521 &gEfiGlobalVariableGuid
,
524 if (Variable
== NULL
) {
528 // Notes: careful defined the variable of Boot#### or
529 // Driver####, consider use some macro to abstract the code
532 // Get the option attribute
535 Attribute
= *(UINT32
*) Variable
;
536 TempPtr
+= sizeof (UINT32
);
539 // Get the option's device path size
541 FilePathSize
= *(UINT16
*) TempPtr
;
542 TempPtr
+= sizeof (UINT16
);
545 // Get the option's description string
547 Description
= (CHAR16
*) TempPtr
;
550 // Get the option's description string size
552 TempSize
= StrSizeEx ((CHAR16
*) TempPtr
, VariableSize
);
559 // Get the option's device path
561 DevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
562 TempPtr
+= FilePathSize
;
565 // Validation device path.
567 TempPath
= DevicePath
;
568 while (FilePathSize
> 0) {
569 TempSize
= GetDevicePathSizeEx (TempPath
, FilePathSize
);
573 FilePathSize
= (UINT16
) (FilePathSize
- TempSize
);
574 TempPath
+= TempSize
;
578 // Get load opion data.
580 LoadOptions
= TempPtr
;
581 if (VariableSize
< (UINTN
)(TempPtr
- Variable
)) {
584 LoadOptionsSize
= (UINT32
) (VariableSize
- (UINTN
) (TempPtr
- Variable
));
587 // The Console variables may have multiple device paths, so make
588 // an Entry for each one.
590 Option
= AllocateZeroPool (sizeof (BDS_COMMON_OPTION
));
591 if (Option
== NULL
) {
595 Option
->Signature
= BDS_LOAD_OPTION_SIGNATURE
;
596 Option
->DevicePath
= AllocateZeroPool (GetDevicePathSize (DevicePath
));
597 ASSERT(Option
->DevicePath
!= NULL
);
598 CopyMem (Option
->DevicePath
, DevicePath
, GetDevicePathSize (DevicePath
));
600 Option
->Attribute
= Attribute
;
601 Option
->Description
= AllocateZeroPool (StrSize (Description
));
602 ASSERT(Option
->Description
!= NULL
);
603 CopyMem (Option
->Description
, Description
, StrSize (Description
));
605 Option
->LoadOptions
= AllocateZeroPool (LoadOptionsSize
);
606 ASSERT(Option
->LoadOptions
!= NULL
);
607 CopyMem (Option
->LoadOptions
, LoadOptions
, LoadOptionsSize
);
608 Option
->LoadOptionsSize
= LoadOptionsSize
;
611 // Get the value from VariableName Unicode string
612 // since the ISO standard assumes ASCII equivalent abbreviations, we can be safe in converting this
613 // Unicode stream to ASCII without any loss in meaning.
615 if (*VariableName
== 'B') {
616 NumOff
= (UINT8
) (sizeof (L
"Boot") / sizeof(CHAR16
) - 1);
617 Option
->BootCurrent
= (UINT16
) ((VariableName
[NumOff
] -'0') * 0x1000);
618 Option
->BootCurrent
= (UINT16
) (Option
->BootCurrent
+ ((VariableName
[NumOff
+1]-'0') * 0x100));
619 Option
->BootCurrent
= (UINT16
) (Option
->BootCurrent
+ ((VariableName
[NumOff
+2]-'0') * 0x10));
620 Option
->BootCurrent
= (UINT16
) (Option
->BootCurrent
+ ((VariableName
[NumOff
+3]-'0')));
623 // Insert active entry to BdsDeviceList
625 if ((Option
->Attribute
& LOAD_OPTION_ACTIVE
) == LOAD_OPTION_ACTIVE
) {
626 InsertTailList (BdsCommonOptionList
, &Option
->Link
);
638 Process BootOrder, or DriverOrder variables, by calling
639 BdsLibVariableToOption () for each UINT16 in the variables.
641 @param BdsCommonOptionList The header of the option list base on variable
643 @param VariableName EFI Variable name indicate the BootOrder or
646 @retval EFI_SUCCESS Success create the boot option or driver option
648 @retval EFI_OUT_OF_RESOURCES Failed to get the boot option or driver option list
653 BdsLibBuildOptionFromVar (
654 IN LIST_ENTRY
*BdsCommonOptionList
,
655 IN CHAR16
*VariableName
659 UINTN OptionOrderSize
;
661 BDS_COMMON_OPTION
*Option
;
662 CHAR16 OptionName
[20];
665 // Zero Buffer in order to get all BOOT#### variables
667 ZeroMem (OptionName
, sizeof (OptionName
));
670 // Read the BootOrder, or DriverOrder variable.
672 OptionOrder
= BdsLibGetVariableAndSize (
674 &gEfiGlobalVariableGuid
,
677 if (OptionOrder
== NULL
) {
678 return EFI_OUT_OF_RESOURCES
;
681 for (Index
= 0; Index
< OptionOrderSize
/ sizeof (UINT16
); Index
++) {
682 if (*VariableName
== 'B') {
683 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", OptionOrder
[Index
]);
685 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Driver%04x", OptionOrder
[Index
]);
688 Option
= BdsLibVariableToOption (BdsCommonOptionList
, OptionName
);
689 if (Option
!= NULL
) {
690 Option
->BootCurrent
= OptionOrder
[Index
];
694 FreePool (OptionOrder
);
700 Get boot mode by looking up configuration table and parsing HOB list
702 @param BootMode Boot mode from PEI handoff HOB.
704 @retval EFI_SUCCESS Successfully get boot mode
710 OUT EFI_BOOT_MODE
*BootMode
713 *BootMode
= GetBootModeHob ();
719 Read the EFI variable (VendorGuid/Name) and return a dynamically allocated
720 buffer, and the size of the buffer. If failure return NULL.
722 @param Name String part of EFI variable name
723 @param VendorGuid GUID part of EFI variable name
724 @param VariableSize Returns the size of the EFI variable that was read
726 @return Dynamically allocated memory that contains a copy of the EFI variable
727 Caller is responsible freeing the buffer.
728 @retval NULL Variable was not read
733 BdsLibGetVariableAndSize (
735 IN EFI_GUID
*VendorGuid
,
736 OUT UINTN
*VariableSize
746 // Pass in a zero size buffer to find the required buffer size.
749 Status
= gRT
->GetVariable (Name
, VendorGuid
, NULL
, &BufferSize
, Buffer
);
750 if (Status
== EFI_BUFFER_TOO_SMALL
) {
752 // Allocate the buffer to return
754 Buffer
= AllocateZeroPool (BufferSize
);
755 if (Buffer
== NULL
) {
759 // Read variable into the allocated buffer.
761 Status
= gRT
->GetVariable (Name
, VendorGuid
, NULL
, &BufferSize
, Buffer
);
762 if (EFI_ERROR (Status
)) {
767 *VariableSize
= BufferSize
;
772 Delete the instance in Multi which matches partly with Single instance
774 @param Multi A pointer to a multi-instance device path data
776 @param Single A pointer to a single-instance device path data
779 @return This function will remove the device path instances in Multi which partly
780 match with the Single, and return the result device path. If there is no
781 remaining device path as a result, this function will return NULL.
784 EFI_DEVICE_PATH_PROTOCOL
*
786 BdsLibDelPartMatchInstance (
787 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
788 IN EFI_DEVICE_PATH_PROTOCOL
*Single
791 EFI_DEVICE_PATH_PROTOCOL
*Instance
;
792 EFI_DEVICE_PATH_PROTOCOL
*NewDevicePath
;
793 EFI_DEVICE_PATH_PROTOCOL
*TempNewDevicePath
;
798 NewDevicePath
= NULL
;
799 TempNewDevicePath
= NULL
;
801 if (Multi
== NULL
|| Single
== NULL
) {
805 Instance
= GetNextDevicePathInstance (&Multi
, &InstanceSize
);
806 SingleDpSize
= GetDevicePathSize (Single
) - END_DEVICE_PATH_LENGTH
;
807 InstanceSize
-= END_DEVICE_PATH_LENGTH
;
809 while (Instance
!= NULL
) {
811 Size
= (SingleDpSize
< InstanceSize
) ? SingleDpSize
: InstanceSize
;
813 if ((CompareMem (Instance
, Single
, Size
) != 0)) {
815 // Append the device path instance which does not match with Single
817 TempNewDevicePath
= NewDevicePath
;
818 NewDevicePath
= AppendDevicePathInstance (NewDevicePath
, Instance
);
819 if (TempNewDevicePath
!= NULL
) {
820 FreePool(TempNewDevicePath
);
824 Instance
= GetNextDevicePathInstance (&Multi
, &InstanceSize
);
825 InstanceSize
-= END_DEVICE_PATH_LENGTH
;
828 return NewDevicePath
;
832 Function compares a device path data structure to that of all the nodes of a
833 second device path instance.
835 @param Multi A pointer to a multi-instance device path data
837 @param Single A pointer to a single-instance device path data
840 @retval TRUE If the Single device path is contained within Multi device path.
841 @retval FALSE The Single device path is not match within Multi device path.
846 BdsLibMatchDevicePaths (
847 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
848 IN EFI_DEVICE_PATH_PROTOCOL
*Single
851 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
852 EFI_DEVICE_PATH_PROTOCOL
*DevicePathInst
;
855 if (Multi
== NULL
|| Single
== NULL
) {
860 DevicePathInst
= GetNextDevicePathInstance (&DevicePath
, &Size
);
863 // Search for the match of 'Single' in 'Multi'
865 while (DevicePathInst
!= NULL
) {
867 // If the single device path is found in multiple device paths,
870 if (CompareMem (Single
, DevicePathInst
, Size
) == 0) {
871 FreePool (DevicePathInst
);
875 FreePool (DevicePathInst
);
876 DevicePathInst
= GetNextDevicePathInstance (&DevicePath
, &Size
);
883 This function prints a series of strings.
885 @param ConOut Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
886 @param ... A variable argument list containing series of
887 strings, the last string must be NULL.
889 @retval EFI_SUCCESS Success print out the string using ConOut.
890 @retval EFI_STATUS Return the status of the ConOut->OutputString ().
895 BdsLibOutputStrings (
896 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*ConOut
,
904 Status
= EFI_SUCCESS
;
905 VA_START (Args
, ConOut
);
907 while (!EFI_ERROR (Status
)) {
909 // If String is NULL, then it's the end of the list
911 String
= VA_ARG (Args
, CHAR16
*);
912 if (String
== NULL
) {
916 Status
= ConOut
->OutputString (ConOut
, String
);
918 if (EFI_ERROR (Status
)) {
928 // Following are BDS Lib functions which contain all the code about setup browser reset reminder feature.
929 // Setup Browser reset reminder feature is that an reset reminder will be given before user leaves the setup browser if
930 // user change any option setting which needs a reset to be effective, and the reset will be applied according to the user selection.
935 Enable the setup browser reset reminder feature.
936 This routine is used in platform tip. If the platform policy need the feature, use the routine to enable it.
941 EnableResetReminderFeature (
945 mFeaturerSwitch
= TRUE
;
950 Disable the setup browser reset reminder feature.
951 This routine is used in platform tip. If the platform policy do not want the feature, use the routine to disable it.
956 DisableResetReminderFeature (
960 mFeaturerSwitch
= FALSE
;
965 Record the info that a reset is required.
966 A module boolean variable is used to record whether a reset is required.
971 EnableResetRequired (
975 mResetRequired
= TRUE
;
980 Record the info that no reset is required.
981 A module boolean variable is used to record whether a reset is required.
986 DisableResetRequired (
990 mResetRequired
= FALSE
;
995 Check whether platform policy enable the reset reminder feature. The default is enabled.
1000 IsResetReminderFeatureEnable (
1004 return mFeaturerSwitch
;
1009 Check if user changed any option setting which needs a system reset to be effective.
1018 return mResetRequired
;
1023 Check whether a reset is needed, and finish the reset reminder feature.
1024 If a reset is needed, Popup a menu to notice user, and finish the feature
1025 according to the user selection.
1030 SetupResetReminder (
1035 CHAR16
*StringBuffer1
;
1036 CHAR16
*StringBuffer2
;
1040 //check any reset required change is applied? if yes, reset system
1042 if (IsResetReminderFeatureEnable ()) {
1043 if (IsResetRequired ()) {
1045 StringBuffer1
= AllocateZeroPool (MAX_STRING_LEN
* sizeof (CHAR16
));
1046 ASSERT (StringBuffer1
!= NULL
);
1047 StringBuffer2
= AllocateZeroPool (MAX_STRING_LEN
* sizeof (CHAR16
));
1048 ASSERT (StringBuffer2
!= NULL
);
1049 StrCpy (StringBuffer1
, L
"Configuration changed. Reset to apply it Now ? ");
1050 StrCpy (StringBuffer2
, L
"Enter (YES) / Esc (NO)");
1052 // Popup a menu to notice user
1055 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, StringBuffer1
, StringBuffer2
, NULL
);
1056 } while ((Key
.ScanCode
!= SCAN_ESC
) && (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
));
1058 FreePool (StringBuffer1
);
1059 FreePool (StringBuffer2
);
1061 // If the user hits the YES Response key, reset
1063 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
1064 gRT
->ResetSystem (EfiResetCold
, EFI_SUCCESS
, 0, NULL
);
1066 gST
->ConOut
->ClearScreen (gST
->ConOut
);
1072 Get the headers (dos, image, optional header) from an image
1074 @param Device SimpleFileSystem device handle
1075 @param FileName File name for the image
1076 @param DosHeader Pointer to dos header
1077 @param Hdr The buffer in which to return the PE32, PE32+, or TE header.
1079 @retval EFI_SUCCESS Successfully get the machine type.
1080 @retval EFI_NOT_FOUND The file is not found.
1081 @retval EFI_LOAD_ERROR File is not a valid image file.
1086 BdsLibGetImageHeader (
1087 IN EFI_HANDLE Device
,
1088 IN CHAR16
*FileName
,
1089 OUT EFI_IMAGE_DOS_HEADER
*DosHeader
,
1090 OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
1094 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*Volume
;
1095 EFI_FILE_HANDLE Root
;
1096 EFI_FILE_HANDLE ThisFile
;
1099 EFI_FILE_INFO
*Info
;
1104 // Handle the file system interface to the device
1106 Status
= gBS
->HandleProtocol (
1108 &gEfiSimpleFileSystemProtocolGuid
,
1111 if (EFI_ERROR (Status
)) {
1115 Status
= Volume
->OpenVolume (
1119 if (EFI_ERROR (Status
)) {
1123 ASSERT (Root
!= NULL
);
1124 Status
= Root
->Open (Root
, &ThisFile
, FileName
, EFI_FILE_MODE_READ
, 0);
1125 if (EFI_ERROR (Status
)) {
1128 ASSERT (ThisFile
!= NULL
);
1133 BufferSize
= SIZE_OF_EFI_FILE_INFO
+ 200;
1136 Status
= gBS
->AllocatePool (EfiBootServicesData
, BufferSize
, (VOID
**) &Info
);
1137 if (EFI_ERROR (Status
)) {
1140 Status
= ThisFile
->GetInfo (
1146 if (!EFI_ERROR (Status
)) {
1149 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
1156 FileSize
= Info
->FileSize
;
1162 BufferSize
= sizeof (EFI_IMAGE_DOS_HEADER
);
1163 Status
= ThisFile
->Read (ThisFile
, &BufferSize
, DosHeader
);
1164 if (EFI_ERROR (Status
) ||
1165 BufferSize
< sizeof (EFI_IMAGE_DOS_HEADER
) ||
1166 FileSize
<= DosHeader
->e_lfanew
||
1167 DosHeader
->e_magic
!= EFI_IMAGE_DOS_SIGNATURE
) {
1168 Status
= EFI_LOAD_ERROR
;
1173 // Move to PE signature
1175 Status
= ThisFile
->SetPosition (ThisFile
, DosHeader
->e_lfanew
);
1176 if (EFI_ERROR (Status
)) {
1177 Status
= EFI_LOAD_ERROR
;
1182 // Read and check PE signature
1184 BufferSize
= sizeof (EFI_IMAGE_OPTIONAL_HEADER_UNION
);
1185 Status
= ThisFile
->Read (ThisFile
, &BufferSize
, Hdr
.Pe32
);
1186 if (EFI_ERROR (Status
) ||
1187 BufferSize
< sizeof (EFI_IMAGE_OPTIONAL_HEADER_UNION
) ||
1188 Hdr
.Pe32
->Signature
!= EFI_IMAGE_NT_SIGNATURE
) {
1189 Status
= EFI_LOAD_ERROR
;
1194 // Check PE32 or PE32+ magic
1196 if (Hdr
.Pe32
->OptionalHeader
.Magic
!= EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
&&
1197 Hdr
.Pe32
->OptionalHeader
.Magic
!= EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
) {
1198 Status
= EFI_LOAD_ERROR
;
1203 if (ThisFile
!= NULL
) {
1204 ThisFile
->Close (ThisFile
);
1213 This routine adjusts the memory information for different memory type and
1214 saves them into the variables for next boot. It conditionally resets the
1215 system when the memory information changes. Platform can reserve memory
1216 large enough (125% of actual requirement) to avoid the reset in the first boot.
1219 BdsSetMemoryTypeInformationVariable (
1224 EFI_MEMORY_TYPE_INFORMATION
*PreviousMemoryTypeInformation
;
1225 EFI_MEMORY_TYPE_INFORMATION
*CurrentMemoryTypeInformation
;
1232 EFI_HOB_GUID_TYPE
*GuidHob
;
1233 BOOLEAN MemoryTypeInformationModified
;
1234 BOOLEAN MemoryTypeInformationVariableExists
;
1235 EFI_BOOT_MODE BootMode
;
1237 MemoryTypeInformationModified
= FALSE
;
1238 MemoryTypeInformationVariableExists
= FALSE
;
1241 BootMode
= GetBootModeHob ();
1243 // In BOOT_IN_RECOVERY_MODE, Variable region is not reliable.
1245 if (BootMode
== BOOT_IN_RECOVERY_MODE
) {
1250 // Only check the the Memory Type Information variable in the boot mode
1251 // other than BOOT_WITH_DEFAULT_SETTINGS because the Memory Type
1252 // Information is not valid in this boot mode.
1254 if (BootMode
!= BOOT_WITH_DEFAULT_SETTINGS
) {
1256 Status
= gRT
->GetVariable (
1257 EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME
,
1258 &gEfiMemoryTypeInformationGuid
,
1263 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1264 MemoryTypeInformationVariableExists
= TRUE
;
1269 // Retrieve the current memory usage statistics. If they are not found, then
1270 // no adjustments can be made to the Memory Type Information variable.
1272 Status
= EfiGetSystemConfigurationTable (
1273 &gEfiMemoryTypeInformationGuid
,
1274 (VOID
**) &CurrentMemoryTypeInformation
1276 if (EFI_ERROR (Status
) || CurrentMemoryTypeInformation
== NULL
) {
1281 // Get the Memory Type Information settings from Hob if they exist,
1282 // PEI is responsible for getting them from variable and build a Hob to save them.
1283 // If the previous Memory Type Information is not available, then set defaults
1285 GuidHob
= GetFirstGuidHob (&gEfiMemoryTypeInformationGuid
);
1286 if (GuidHob
== NULL
) {
1288 // If Platform has not built Memory Type Info into the Hob, just return.
1292 PreviousMemoryTypeInformation
= GET_GUID_HOB_DATA (GuidHob
);
1293 VariableSize
= GET_GUID_HOB_DATA_SIZE (GuidHob
);
1296 // Use a heuristic to adjust the Memory Type Information for the next boot
1298 DEBUG ((EFI_D_INFO
, "Memory Previous Current Next \n"));
1299 DEBUG ((EFI_D_INFO
, " Type Pages Pages Pages \n"));
1300 DEBUG ((EFI_D_INFO
, "====== ======== ======== ========\n"));
1302 for (Index
= 0; PreviousMemoryTypeInformation
[Index
].Type
!= EfiMaxMemoryType
; Index
++) {
1304 for (Index1
= 0; CurrentMemoryTypeInformation
[Index1
].Type
!= EfiMaxMemoryType
; Index1
++) {
1305 if (PreviousMemoryTypeInformation
[Index
].Type
== CurrentMemoryTypeInformation
[Index1
].Type
) {
1309 if (CurrentMemoryTypeInformation
[Index1
].Type
== EfiMaxMemoryType
) {
1314 // Previous is the number of pages pre-allocated
1315 // Current is the number of pages actually needed
1317 Previous
= PreviousMemoryTypeInformation
[Index
].NumberOfPages
;
1318 Current
= CurrentMemoryTypeInformation
[Index1
].NumberOfPages
;
1322 // Write next varible to 125% * current and Inconsistent Memory Reserved across bootings may lead to S4 fail
1324 if (Current
< Previous
) {
1325 if (BootMode
== BOOT_WITH_DEFAULT_SETTINGS
) {
1326 Next
= Current
+ (Current
>> 2);
1327 } else if (!MemoryTypeInformationVariableExists
) {
1328 Next
= MAX (Current
+ (Current
>> 2), Previous
);
1330 } else if (Current
> Previous
) {
1331 Next
= Current
+ (Current
>> 2);
1333 if (Next
> 0 && Next
< 4) {
1337 if (Next
!= Previous
) {
1338 PreviousMemoryTypeInformation
[Index
].NumberOfPages
= Next
;
1339 MemoryTypeInformationModified
= TRUE
;
1342 DEBUG ((EFI_D_INFO
, " %02x %08x %08x %08x\n", PreviousMemoryTypeInformation
[Index
].Type
, Previous
, Current
, Next
));
1346 // If any changes were made to the Memory Type Information settings, then set the new variable value;
1347 // Or create the variable in first boot.
1349 if (MemoryTypeInformationModified
|| !MemoryTypeInformationVariableExists
) {
1350 Status
= gRT
->SetVariable (
1351 EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME
,
1352 &gEfiMemoryTypeInformationGuid
,
1353 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
1355 PreviousMemoryTypeInformation
1359 // If the Memory Type Information settings have been modified, then reset the platform
1360 // so the new Memory Type Information setting will be used to guarantee that an S4
1361 // entry/resume cycle will not fail.
1363 if (MemoryTypeInformationModified
&& PcdGetBool (PcdResetOnMemoryTypeInformationChange
)) {
1364 DEBUG ((EFI_D_INFO
, "Memory Type Information settings change. Warm Reset!!!\n"));
1365 gRT
->ResetSystem (EfiResetWarm
, EFI_SUCCESS
, 0, NULL
);
1371 This routine is kept for backward compatibility.
1375 BdsLibSaveMemoryTypeInformation (
1383 Identify a user and, if authenticated, returns the current user profile handle.
1385 @param[out] User Point to user profile handle.
1387 @retval EFI_SUCCESS User is successfully identified, or user identification
1389 @retval EFI_ACCESS_DENIED User is not successfully identified
1394 BdsLibUserIdentify (
1395 OUT EFI_USER_PROFILE_HANDLE
*User
1399 EFI_USER_MANAGER_PROTOCOL
*Manager
;
1401 Status
= gBS
->LocateProtocol (
1402 &gEfiUserManagerProtocolGuid
,
1406 if (EFI_ERROR (Status
)) {
1410 return Manager
->Identify (Manager
, User
);