2 Misc BDS library function
4 Copyright (c) 2004 - 2012, 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
) {
262 // Validate the variable.
264 if (!ValidateOption(OptionPtr
, OptionSize
)) {
269 TempPtr
+= sizeof (UINT32
) + sizeof (UINT16
);
270 Description
= (CHAR16
*) TempPtr
;
271 TempPtr
+= StrSize ((CHAR16
*) TempPtr
);
272 OptionDevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
275 // Notes: the description may will change base on the GetStringToken
277 if (CompareMem (OptionDevicePath
, DevicePath
, GetDevicePathSize (OptionDevicePath
)) == 0) {
278 if (CompareMem (Description
, String
, StrSize (Description
)) == 0) {
280 // Got the option, so just return
282 FreePool (OptionPtr
);
283 FreePool (TempOptionPtr
);
287 // Option description changed, need update.
289 UpdateDescription
= TRUE
;
290 FreePool (OptionPtr
);
295 FreePool (OptionPtr
);
298 OptionSize
= sizeof (UINT32
) + sizeof (UINT16
) + StrSize (String
);
299 OptionSize
+= GetDevicePathSize (DevicePath
);
300 OptionPtr
= AllocateZeroPool (OptionSize
);
301 ASSERT (OptionPtr
!= NULL
);
304 *(UINT32
*) TempPtr
= LOAD_OPTION_ACTIVE
;
305 TempPtr
+= sizeof (UINT32
);
306 *(UINT16
*) TempPtr
= (UINT16
) GetDevicePathSize (DevicePath
);
307 TempPtr
+= sizeof (UINT16
);
308 CopyMem (TempPtr
, String
, StrSize (String
));
309 TempPtr
+= StrSize (String
);
310 CopyMem (TempPtr
, DevicePath
, GetDevicePathSize (DevicePath
));
312 if (UpdateDescription
) {
314 // The number in option#### to be updated.
315 // In this case, we must have non-NULL TempOptionPtr.
317 ASSERT (TempOptionPtr
!= NULL
);
318 RegisterOptionNumber
= TempOptionPtr
[Index
];
321 // The new option#### number
323 RegisterOptionNumber
= BdsLibGetFreeOptionNumber(VariableName
);
326 if (*VariableName
== 'B') {
327 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", RegisterOptionNumber
);
329 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Driver%04x", RegisterOptionNumber
);
332 Status
= gRT
->SetVariable (
334 &gEfiGlobalVariableGuid
,
335 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
340 // Return if only need to update a changed description or fail to set option.
342 if (EFI_ERROR (Status
) || UpdateDescription
) {
343 FreePool (OptionPtr
);
344 if (TempOptionPtr
!= NULL
) {
345 FreePool (TempOptionPtr
);
350 FreePool (OptionPtr
);
353 // Update the option order variable
357 // If no option order
359 if (TempOptionSize
== 0) {
361 Status
= gRT
->SetVariable (
363 &gEfiGlobalVariableGuid
,
364 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
368 if (TempOptionPtr
!= NULL
) {
369 FreePool (TempOptionPtr
);
375 // TempOptionPtr must not be NULL if TempOptionSize is not zero.
377 ASSERT (TempOptionPtr
!= NULL
);
379 // Append the new option number to the original option order
381 OrderItemNum
= (TempOptionSize
/ sizeof (UINT16
)) + 1 ;
382 OptionOrderPtr
= AllocateZeroPool ( OrderItemNum
* sizeof (UINT16
));
383 ASSERT (OptionOrderPtr
!= NULL
);
384 CopyMem (OptionOrderPtr
, TempOptionPtr
, (OrderItemNum
- 1) * sizeof (UINT16
));
386 OptionOrderPtr
[Index
] = RegisterOptionNumber
;
388 Status
= gRT
->SetVariable (
390 &gEfiGlobalVariableGuid
,
391 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
392 OrderItemNum
* sizeof (UINT16
),
395 FreePool (TempOptionPtr
);
396 FreePool (OptionOrderPtr
);
402 Returns the size of a device path in bytes.
404 This function returns the size, in bytes, of the device path data structure
405 specified by DevicePath including the end of device path node. If DevicePath
406 is NULL, then 0 is returned. If the length of the device path is bigger than
407 MaxSize, also return 0 to indicate this is an invalidate device path.
409 @param DevicePath A pointer to a device path data structure.
410 @param MaxSize Max valid device path size. If big than this size,
413 @retval 0 An invalid device path.
414 @retval Others The size of a device path in bytes.
418 GetDevicePathSizeEx (
419 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
426 if (DevicePath
== NULL
) {
431 // Search for the end of the device path structure
434 while (!IsDevicePathEnd (DevicePath
)) {
435 NodeSize
= DevicePathNodeLength (DevicePath
);
436 if (NodeSize
< END_DEVICE_PATH_LENGTH
) {
440 if (Size
> MaxSize
) {
443 DevicePath
= NextDevicePathNode (DevicePath
);
445 Size
+= DevicePathNodeLength (DevicePath
);
446 if (Size
> MaxSize
) {
454 Returns the length of a Null-terminated Unicode string. If the length is
455 bigger than MaxStringLen, return length 0 to indicate that this is an
458 This function returns the number of Unicode characters in the Null-terminated
459 Unicode string specified by String.
461 If String is NULL, then ASSERT().
462 If String is not aligned on a 16-bit boundary, then ASSERT().
464 @param String A pointer to a Null-terminated Unicode string.
465 @param MaxStringLen Max string len in this string.
467 @retval 0 An invalid string.
468 @retval Others The length of String.
473 IN CONST CHAR16
*String
,
474 IN UINTN MaxStringLen
479 ASSERT (String
!= NULL
&& MaxStringLen
!= 0);
480 ASSERT (((UINTN
) String
& BIT0
) == 0);
482 for (Length
= 0; *String
!= L
'\0' && MaxStringLen
!= Length
; String
++, Length
++);
484 if (*String
!= L
'\0' && MaxStringLen
== Length
) {
488 return (Length
+ 1) * sizeof (*String
);
492 Validate the EFI Boot#### variable (VendorGuid/Name)
494 @param Variable Boot#### variable data.
495 @param VariableSize Returns the size of the EFI variable that was read
497 @retval TRUE The variable data is correct.
498 @retval FALSE The variable data is corrupted.
509 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
510 EFI_DEVICE_PATH_PROTOCOL
*TempPath
;
514 // Skip the option attribute
517 TempPtr
+= sizeof (UINT32
);
520 // Get the option's device path size
522 FilePathSize
= *(UINT16
*) TempPtr
;
523 TempPtr
+= sizeof (UINT16
);
526 // Get the option's description string size
528 TempSize
= StrSizeEx ((CHAR16
*) TempPtr
, VariableSize
);
532 // Get the option's device path
534 DevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
535 TempPtr
+= FilePathSize
;
538 // Validation boot option variable.
540 if ((FilePathSize
== 0) || (TempSize
== 0)) {
544 if (TempSize
+ FilePathSize
+ sizeof (UINT16
) + sizeof (UINT16
) > VariableSize
) {
548 TempPath
= DevicePath
;
549 while (FilePathSize
> 0) {
550 TempSize
= GetDevicePathSizeEx (TempPath
, FilePathSize
);
554 FilePathSize
= (UINT16
) (FilePathSize
- TempSize
);
555 TempPath
+= TempSize
;
562 Convert a single character to number.
563 It assumes the input Char is in the scope of L'0' ~ L'9' and L'A' ~ L'F'
565 @param Char The input char which need to change to a hex number.
573 if ((Char
>= L
'0') && (Char
<= L
'9')) {
574 return (UINTN
) (Char
- L
'0');
577 if ((Char
>= L
'A') && (Char
<= L
'F')) {
578 return (UINTN
) (Char
- L
'A' + 0xA);
586 Build the boot#### or driver#### option from the VariableName, the
587 build boot#### or driver#### will also be linked to BdsCommonOptionList.
589 @param BdsCommonOptionList The header of the boot#### or driver#### option
591 @param VariableName EFI Variable name indicate if it is boot#### or
594 @retval BDS_COMMON_OPTION Get the option just been created
595 @retval NULL Failed to get the new option
600 BdsLibVariableToOption (
601 IN OUT LIST_ENTRY
*BdsCommonOptionList
,
602 IN CHAR16
*VariableName
610 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
611 EFI_DEVICE_PATH_PROTOCOL
*TempPath
;
612 BDS_COMMON_OPTION
*Option
;
614 UINT32 LoadOptionsSize
;
619 // Read the variable. We will never free this data.
621 Variable
= BdsLibGetVariableAndSize (
623 &gEfiGlobalVariableGuid
,
626 if (Variable
== NULL
) {
631 // Validate Boot#### variable data.
633 if (!ValidateOption(Variable
, VariableSize
)) {
638 // Notes: careful defined the variable of Boot#### or
639 // Driver####, consider use some macro to abstract the code
642 // Get the option attribute
645 Attribute
= *(UINT32
*) Variable
;
646 TempPtr
+= sizeof (UINT32
);
649 // Get the option's device path size
651 FilePathSize
= *(UINT16
*) TempPtr
;
652 TempPtr
+= sizeof (UINT16
);
655 // Get the option's description string
657 Description
= (CHAR16
*) TempPtr
;
660 // Get the option's description string size
662 TempSize
= StrSizeEx ((CHAR16
*) TempPtr
, VariableSize
);
669 // Get the option's device path
671 DevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
672 TempPtr
+= FilePathSize
;
675 // Validation device path.
677 TempPath
= DevicePath
;
678 while (FilePathSize
> 0) {
679 TempSize
= GetDevicePathSizeEx (TempPath
, FilePathSize
);
683 FilePathSize
= (UINT16
) (FilePathSize
- TempSize
);
684 TempPath
+= TempSize
;
688 // Get load opion data.
690 LoadOptions
= TempPtr
;
691 if (VariableSize
< (UINTN
)(TempPtr
- Variable
)) {
694 LoadOptionsSize
= (UINT32
) (VariableSize
- (UINTN
) (TempPtr
- Variable
));
697 // The Console variables may have multiple device paths, so make
698 // an Entry for each one.
700 Option
= AllocateZeroPool (sizeof (BDS_COMMON_OPTION
));
701 if (Option
== NULL
) {
705 Option
->Signature
= BDS_LOAD_OPTION_SIGNATURE
;
706 Option
->DevicePath
= AllocateZeroPool (GetDevicePathSize (DevicePath
));
707 ASSERT(Option
->DevicePath
!= NULL
);
708 CopyMem (Option
->DevicePath
, DevicePath
, GetDevicePathSize (DevicePath
));
710 Option
->Attribute
= Attribute
;
711 Option
->Description
= AllocateZeroPool (StrSize (Description
));
712 ASSERT(Option
->Description
!= NULL
);
713 CopyMem (Option
->Description
, Description
, StrSize (Description
));
715 Option
->LoadOptions
= AllocateZeroPool (LoadOptionsSize
);
716 ASSERT(Option
->LoadOptions
!= NULL
);
717 CopyMem (Option
->LoadOptions
, LoadOptions
, LoadOptionsSize
);
718 Option
->LoadOptionsSize
= LoadOptionsSize
;
721 // Get the value from VariableName Unicode string
722 // since the ISO standard assumes ASCII equivalent abbreviations, we can be safe in converting this
723 // Unicode stream to ASCII without any loss in meaning.
725 if (*VariableName
== 'B') {
726 NumOff
= (UINT8
) (sizeof (L
"Boot") / sizeof (CHAR16
) - 1);
727 Option
->BootCurrent
= (UINT16
) (CharToUint (VariableName
[NumOff
+0]) * 0x1000)
728 + (UINT16
) (CharToUint (VariableName
[NumOff
+1]) * 0x100)
729 + (UINT16
) (CharToUint (VariableName
[NumOff
+2]) * 0x10)
730 + (UINT16
) (CharToUint (VariableName
[NumOff
+3]) * 0x1);
733 // Insert active entry to BdsDeviceList
735 if ((Option
->Attribute
& LOAD_OPTION_ACTIVE
) == LOAD_OPTION_ACTIVE
) {
736 InsertTailList (BdsCommonOptionList
, &Option
->Link
);
742 FreePool (Option
->Description
);
743 FreePool (Option
->DevicePath
);
744 FreePool (Option
->LoadOptions
);
750 Process BootOrder, or DriverOrder variables, by calling
751 BdsLibVariableToOption () for each UINT16 in the variables.
753 @param BdsCommonOptionList The header of the option list base on variable
755 @param VariableName EFI Variable name indicate the BootOrder or
758 @retval EFI_SUCCESS Success create the boot option or driver option
760 @retval EFI_OUT_OF_RESOURCES Failed to get the boot option or driver option list
765 BdsLibBuildOptionFromVar (
766 IN LIST_ENTRY
*BdsCommonOptionList
,
767 IN CHAR16
*VariableName
771 UINTN OptionOrderSize
;
773 BDS_COMMON_OPTION
*Option
;
774 CHAR16 OptionName
[20];
777 // Zero Buffer in order to get all BOOT#### variables
779 ZeroMem (OptionName
, sizeof (OptionName
));
782 // Read the BootOrder, or DriverOrder variable.
784 OptionOrder
= BdsLibGetVariableAndSize (
786 &gEfiGlobalVariableGuid
,
789 if (OptionOrder
== NULL
) {
790 return EFI_OUT_OF_RESOURCES
;
793 for (Index
= 0; Index
< OptionOrderSize
/ sizeof (UINT16
); Index
++) {
794 if (*VariableName
== 'B') {
795 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", OptionOrder
[Index
]);
797 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Driver%04x", OptionOrder
[Index
]);
800 Option
= BdsLibVariableToOption (BdsCommonOptionList
, OptionName
);
801 if (Option
!= NULL
) {
802 Option
->BootCurrent
= OptionOrder
[Index
];
806 FreePool (OptionOrder
);
812 Get boot mode by looking up configuration table and parsing HOB list
814 @param BootMode Boot mode from PEI handoff HOB.
816 @retval EFI_SUCCESS Successfully get boot mode
822 OUT EFI_BOOT_MODE
*BootMode
825 *BootMode
= GetBootModeHob ();
831 Read the EFI variable (VendorGuid/Name) and return a dynamically allocated
832 buffer, and the size of the buffer. If failure return NULL.
834 @param Name String part of EFI variable name
835 @param VendorGuid GUID part of EFI variable name
836 @param VariableSize Returns the size of the EFI variable that was read
838 @return Dynamically allocated memory that contains a copy of the EFI variable
839 Caller is responsible freeing the buffer.
840 @retval NULL Variable was not read
845 BdsLibGetVariableAndSize (
847 IN EFI_GUID
*VendorGuid
,
848 OUT UINTN
*VariableSize
858 // Pass in a zero size buffer to find the required buffer size.
861 Status
= gRT
->GetVariable (Name
, VendorGuid
, NULL
, &BufferSize
, Buffer
);
862 if (Status
== EFI_BUFFER_TOO_SMALL
) {
864 // Allocate the buffer to return
866 Buffer
= AllocateZeroPool (BufferSize
);
867 if (Buffer
== NULL
) {
871 // Read variable into the allocated buffer.
873 Status
= gRT
->GetVariable (Name
, VendorGuid
, NULL
, &BufferSize
, Buffer
);
874 if (EFI_ERROR (Status
)) {
879 *VariableSize
= BufferSize
;
884 Delete the instance in Multi which matches partly with Single instance
886 @param Multi A pointer to a multi-instance device path data
888 @param Single A pointer to a single-instance device path data
891 @return This function will remove the device path instances in Multi which partly
892 match with the Single, and return the result device path. If there is no
893 remaining device path as a result, this function will return NULL.
896 EFI_DEVICE_PATH_PROTOCOL
*
898 BdsLibDelPartMatchInstance (
899 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
900 IN EFI_DEVICE_PATH_PROTOCOL
*Single
903 EFI_DEVICE_PATH_PROTOCOL
*Instance
;
904 EFI_DEVICE_PATH_PROTOCOL
*NewDevicePath
;
905 EFI_DEVICE_PATH_PROTOCOL
*TempNewDevicePath
;
910 NewDevicePath
= NULL
;
911 TempNewDevicePath
= NULL
;
913 if (Multi
== NULL
|| Single
== NULL
) {
917 Instance
= GetNextDevicePathInstance (&Multi
, &InstanceSize
);
918 SingleDpSize
= GetDevicePathSize (Single
) - END_DEVICE_PATH_LENGTH
;
919 InstanceSize
-= END_DEVICE_PATH_LENGTH
;
921 while (Instance
!= NULL
) {
923 Size
= (SingleDpSize
< InstanceSize
) ? SingleDpSize
: InstanceSize
;
925 if ((CompareMem (Instance
, Single
, Size
) != 0)) {
927 // Append the device path instance which does not match with Single
929 TempNewDevicePath
= NewDevicePath
;
930 NewDevicePath
= AppendDevicePathInstance (NewDevicePath
, Instance
);
931 if (TempNewDevicePath
!= NULL
) {
932 FreePool(TempNewDevicePath
);
936 Instance
= GetNextDevicePathInstance (&Multi
, &InstanceSize
);
937 InstanceSize
-= END_DEVICE_PATH_LENGTH
;
940 return NewDevicePath
;
944 Function compares a device path data structure to that of all the nodes of a
945 second device path instance.
947 @param Multi A pointer to a multi-instance device path data
949 @param Single A pointer to a single-instance device path data
952 @retval TRUE If the Single device path is contained within Multi device path.
953 @retval FALSE The Single device path is not match within Multi device path.
958 BdsLibMatchDevicePaths (
959 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
960 IN EFI_DEVICE_PATH_PROTOCOL
*Single
963 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
964 EFI_DEVICE_PATH_PROTOCOL
*DevicePathInst
;
967 if (Multi
== NULL
|| Single
== NULL
) {
972 DevicePathInst
= GetNextDevicePathInstance (&DevicePath
, &Size
);
975 // Search for the match of 'Single' in 'Multi'
977 while (DevicePathInst
!= NULL
) {
979 // If the single device path is found in multiple device paths,
982 if (CompareMem (Single
, DevicePathInst
, Size
) == 0) {
983 FreePool (DevicePathInst
);
987 FreePool (DevicePathInst
);
988 DevicePathInst
= GetNextDevicePathInstance (&DevicePath
, &Size
);
995 This function prints a series of strings.
997 @param ConOut Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
998 @param ... A variable argument list containing series of
999 strings, the last string must be NULL.
1001 @retval EFI_SUCCESS Success print out the string using ConOut.
1002 @retval EFI_STATUS Return the status of the ConOut->OutputString ().
1007 BdsLibOutputStrings (
1008 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*ConOut
,
1016 Status
= EFI_SUCCESS
;
1017 VA_START (Args
, ConOut
);
1019 while (!EFI_ERROR (Status
)) {
1021 // If String is NULL, then it's the end of the list
1023 String
= VA_ARG (Args
, CHAR16
*);
1024 if (String
== NULL
) {
1028 Status
= ConOut
->OutputString (ConOut
, String
);
1030 if (EFI_ERROR (Status
)) {
1040 // Following are BDS Lib functions which contain all the code about setup browser reset reminder feature.
1041 // Setup Browser reset reminder feature is that an reset reminder will be given before user leaves the setup browser if
1042 // user change any option setting which needs a reset to be effective, and the reset will be applied according to the user selection.
1047 Enable the setup browser reset reminder feature.
1048 This routine is used in platform tip. If the platform policy need the feature, use the routine to enable it.
1053 EnableResetReminderFeature (
1057 mFeaturerSwitch
= TRUE
;
1062 Disable the setup browser reset reminder feature.
1063 This routine is used in platform tip. If the platform policy do not want the feature, use the routine to disable it.
1068 DisableResetReminderFeature (
1072 mFeaturerSwitch
= FALSE
;
1077 Record the info that a reset is required.
1078 A module boolean variable is used to record whether a reset is required.
1083 EnableResetRequired (
1087 mResetRequired
= TRUE
;
1092 Record the info that no reset is required.
1093 A module boolean variable is used to record whether a reset is required.
1098 DisableResetRequired (
1102 mResetRequired
= FALSE
;
1107 Check whether platform policy enable the reset reminder feature. The default is enabled.
1112 IsResetReminderFeatureEnable (
1116 return mFeaturerSwitch
;
1121 Check if user changed any option setting which needs a system reset to be effective.
1130 return mResetRequired
;
1135 Check whether a reset is needed, and finish the reset reminder feature.
1136 If a reset is needed, Popup a menu to notice user, and finish the feature
1137 according to the user selection.
1142 SetupResetReminder (
1147 CHAR16
*StringBuffer1
;
1148 CHAR16
*StringBuffer2
;
1152 //check any reset required change is applied? if yes, reset system
1154 if (IsResetReminderFeatureEnable ()) {
1155 if (IsResetRequired ()) {
1157 StringBuffer1
= AllocateZeroPool (MAX_STRING_LEN
* sizeof (CHAR16
));
1158 ASSERT (StringBuffer1
!= NULL
);
1159 StringBuffer2
= AllocateZeroPool (MAX_STRING_LEN
* sizeof (CHAR16
));
1160 ASSERT (StringBuffer2
!= NULL
);
1161 StrCpy (StringBuffer1
, L
"Configuration changed. Reset to apply it Now ? ");
1162 StrCpy (StringBuffer2
, L
"Enter (YES) / Esc (NO)");
1164 // Popup a menu to notice user
1167 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, StringBuffer1
, StringBuffer2
, NULL
);
1168 } while ((Key
.ScanCode
!= SCAN_ESC
) && (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
));
1170 FreePool (StringBuffer1
);
1171 FreePool (StringBuffer2
);
1173 // If the user hits the YES Response key, reset
1175 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
1176 gRT
->ResetSystem (EfiResetCold
, EFI_SUCCESS
, 0, NULL
);
1178 gST
->ConOut
->ClearScreen (gST
->ConOut
);
1184 Get the headers (dos, image, optional header) from an image
1186 @param Device SimpleFileSystem device handle
1187 @param FileName File name for the image
1188 @param DosHeader Pointer to dos header
1189 @param Hdr The buffer in which to return the PE32, PE32+, or TE header.
1191 @retval EFI_SUCCESS Successfully get the machine type.
1192 @retval EFI_NOT_FOUND The file is not found.
1193 @retval EFI_LOAD_ERROR File is not a valid image file.
1198 BdsLibGetImageHeader (
1199 IN EFI_HANDLE Device
,
1200 IN CHAR16
*FileName
,
1201 OUT EFI_IMAGE_DOS_HEADER
*DosHeader
,
1202 OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
1206 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*Volume
;
1207 EFI_FILE_HANDLE Root
;
1208 EFI_FILE_HANDLE ThisFile
;
1211 EFI_FILE_INFO
*Info
;
1216 // Handle the file system interface to the device
1218 Status
= gBS
->HandleProtocol (
1220 &gEfiSimpleFileSystemProtocolGuid
,
1223 if (EFI_ERROR (Status
)) {
1227 Status
= Volume
->OpenVolume (
1231 if (EFI_ERROR (Status
)) {
1235 ASSERT (Root
!= NULL
);
1236 Status
= Root
->Open (Root
, &ThisFile
, FileName
, EFI_FILE_MODE_READ
, 0);
1237 if (EFI_ERROR (Status
)) {
1240 ASSERT (ThisFile
!= NULL
);
1245 BufferSize
= SIZE_OF_EFI_FILE_INFO
+ 200;
1248 Status
= gBS
->AllocatePool (EfiBootServicesData
, BufferSize
, (VOID
**) &Info
);
1249 if (EFI_ERROR (Status
)) {
1252 Status
= ThisFile
->GetInfo (
1258 if (!EFI_ERROR (Status
)) {
1261 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
1268 FileSize
= Info
->FileSize
;
1274 BufferSize
= sizeof (EFI_IMAGE_DOS_HEADER
);
1275 Status
= ThisFile
->Read (ThisFile
, &BufferSize
, DosHeader
);
1276 if (EFI_ERROR (Status
) ||
1277 BufferSize
< sizeof (EFI_IMAGE_DOS_HEADER
) ||
1278 FileSize
<= DosHeader
->e_lfanew
||
1279 DosHeader
->e_magic
!= EFI_IMAGE_DOS_SIGNATURE
) {
1280 Status
= EFI_LOAD_ERROR
;
1285 // Move to PE signature
1287 Status
= ThisFile
->SetPosition (ThisFile
, DosHeader
->e_lfanew
);
1288 if (EFI_ERROR (Status
)) {
1289 Status
= EFI_LOAD_ERROR
;
1294 // Read and check PE signature
1296 BufferSize
= sizeof (EFI_IMAGE_OPTIONAL_HEADER_UNION
);
1297 Status
= ThisFile
->Read (ThisFile
, &BufferSize
, Hdr
.Pe32
);
1298 if (EFI_ERROR (Status
) ||
1299 BufferSize
< sizeof (EFI_IMAGE_OPTIONAL_HEADER_UNION
) ||
1300 Hdr
.Pe32
->Signature
!= EFI_IMAGE_NT_SIGNATURE
) {
1301 Status
= EFI_LOAD_ERROR
;
1306 // Check PE32 or PE32+ magic
1308 if (Hdr
.Pe32
->OptionalHeader
.Magic
!= EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
&&
1309 Hdr
.Pe32
->OptionalHeader
.Magic
!= EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
) {
1310 Status
= EFI_LOAD_ERROR
;
1315 if (ThisFile
!= NULL
) {
1316 ThisFile
->Close (ThisFile
);
1325 This routine adjusts the memory information for different memory type and
1326 saves them into the variables for next boot. It conditionally resets the
1327 system when the memory information changes. Platform can reserve memory
1328 large enough (125% of actual requirement) to avoid the reset in the first boot.
1331 BdsSetMemoryTypeInformationVariable (
1336 EFI_MEMORY_TYPE_INFORMATION
*PreviousMemoryTypeInformation
;
1337 EFI_MEMORY_TYPE_INFORMATION
*CurrentMemoryTypeInformation
;
1344 EFI_HOB_GUID_TYPE
*GuidHob
;
1345 BOOLEAN MemoryTypeInformationModified
;
1346 BOOLEAN MemoryTypeInformationVariableExists
;
1347 EFI_BOOT_MODE BootMode
;
1349 MemoryTypeInformationModified
= FALSE
;
1350 MemoryTypeInformationVariableExists
= FALSE
;
1353 BootMode
= GetBootModeHob ();
1355 // In BOOT_IN_RECOVERY_MODE, Variable region is not reliable.
1357 if (BootMode
== BOOT_IN_RECOVERY_MODE
) {
1362 // Only check the the Memory Type Information variable in the boot mode
1363 // other than BOOT_WITH_DEFAULT_SETTINGS because the Memory Type
1364 // Information is not valid in this boot mode.
1366 if (BootMode
!= BOOT_WITH_DEFAULT_SETTINGS
) {
1368 Status
= gRT
->GetVariable (
1369 EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME
,
1370 &gEfiMemoryTypeInformationGuid
,
1375 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1376 MemoryTypeInformationVariableExists
= TRUE
;
1381 // Retrieve the current memory usage statistics. If they are not found, then
1382 // no adjustments can be made to the Memory Type Information variable.
1384 Status
= EfiGetSystemConfigurationTable (
1385 &gEfiMemoryTypeInformationGuid
,
1386 (VOID
**) &CurrentMemoryTypeInformation
1388 if (EFI_ERROR (Status
) || CurrentMemoryTypeInformation
== NULL
) {
1393 // Get the Memory Type Information settings from Hob if they exist,
1394 // PEI is responsible for getting them from variable and build a Hob to save them.
1395 // If the previous Memory Type Information is not available, then set defaults
1397 GuidHob
= GetFirstGuidHob (&gEfiMemoryTypeInformationGuid
);
1398 if (GuidHob
== NULL
) {
1400 // If Platform has not built Memory Type Info into the Hob, just return.
1404 PreviousMemoryTypeInformation
= GET_GUID_HOB_DATA (GuidHob
);
1405 VariableSize
= GET_GUID_HOB_DATA_SIZE (GuidHob
);
1408 // Use a heuristic to adjust the Memory Type Information for the next boot
1410 DEBUG ((EFI_D_INFO
, "Memory Previous Current Next \n"));
1411 DEBUG ((EFI_D_INFO
, " Type Pages Pages Pages \n"));
1412 DEBUG ((EFI_D_INFO
, "====== ======== ======== ========\n"));
1414 for (Index
= 0; PreviousMemoryTypeInformation
[Index
].Type
!= EfiMaxMemoryType
; Index
++) {
1416 for (Index1
= 0; CurrentMemoryTypeInformation
[Index1
].Type
!= EfiMaxMemoryType
; Index1
++) {
1417 if (PreviousMemoryTypeInformation
[Index
].Type
== CurrentMemoryTypeInformation
[Index1
].Type
) {
1421 if (CurrentMemoryTypeInformation
[Index1
].Type
== EfiMaxMemoryType
) {
1426 // Previous is the number of pages pre-allocated
1427 // Current is the number of pages actually needed
1429 Previous
= PreviousMemoryTypeInformation
[Index
].NumberOfPages
;
1430 Current
= CurrentMemoryTypeInformation
[Index1
].NumberOfPages
;
1434 // Write next varible to 125% * current and Inconsistent Memory Reserved across bootings may lead to S4 fail
1436 if (Current
< Previous
) {
1437 if (BootMode
== BOOT_WITH_DEFAULT_SETTINGS
) {
1438 Next
= Current
+ (Current
>> 2);
1439 } else if (!MemoryTypeInformationVariableExists
) {
1440 Next
= MAX (Current
+ (Current
>> 2), Previous
);
1442 } else if (Current
> Previous
) {
1443 Next
= Current
+ (Current
>> 2);
1445 if (Next
> 0 && Next
< 4) {
1449 if (Next
!= Previous
) {
1450 PreviousMemoryTypeInformation
[Index
].NumberOfPages
= Next
;
1451 MemoryTypeInformationModified
= TRUE
;
1454 DEBUG ((EFI_D_INFO
, " %02x %08x %08x %08x\n", PreviousMemoryTypeInformation
[Index
].Type
, Previous
, Current
, Next
));
1458 // If any changes were made to the Memory Type Information settings, then set the new variable value;
1459 // Or create the variable in first boot.
1461 if (MemoryTypeInformationModified
|| !MemoryTypeInformationVariableExists
) {
1462 Status
= gRT
->SetVariable (
1463 EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME
,
1464 &gEfiMemoryTypeInformationGuid
,
1465 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
1467 PreviousMemoryTypeInformation
1471 // If the Memory Type Information settings have been modified, then reset the platform
1472 // so the new Memory Type Information setting will be used to guarantee that an S4
1473 // entry/resume cycle will not fail.
1475 if (MemoryTypeInformationModified
&& PcdGetBool (PcdResetOnMemoryTypeInformationChange
)) {
1476 DEBUG ((EFI_D_INFO
, "Memory Type Information settings change. Warm Reset!!!\n"));
1477 gRT
->ResetSystem (EfiResetWarm
, EFI_SUCCESS
, 0, NULL
);
1483 This routine is kept for backward compatibility.
1487 BdsLibSaveMemoryTypeInformation (
1495 Identify a user and, if authenticated, returns the current user profile handle.
1497 @param[out] User Point to user profile handle.
1499 @retval EFI_SUCCESS User is successfully identified, or user identification
1501 @retval EFI_ACCESS_DENIED User is not successfully identified
1506 BdsLibUserIdentify (
1507 OUT EFI_USER_PROFILE_HANDLE
*User
1511 EFI_USER_MANAGER_PROTOCOL
*Manager
;
1513 Status
= gBS
->LocateProtocol (
1514 &gEfiUserManagerProtocolGuid
,
1518 if (EFI_ERROR (Status
)) {
1522 return Manager
->Identify (Manager
, User
);