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 byte length 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
+=2);
484 if (*String
!= L
'\0' && MaxStringLen
== Length
) {
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
;
512 if (VariableSize
<= sizeof (UINT16
) + sizeof (UINT32
)) {
517 // Skip the option attribute
520 TempPtr
+= sizeof (UINT32
);
523 // Get the option's device path size
525 FilePathSize
= *(UINT16
*) TempPtr
;
526 TempPtr
+= sizeof (UINT16
);
529 // Get the option's description string size
531 TempSize
= StrSizeEx ((CHAR16
*) TempPtr
, VariableSize
- sizeof (UINT16
) - sizeof (UINT32
));
535 // Get the option's device path
537 DevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
538 TempPtr
+= FilePathSize
;
541 // Validation boot option variable.
543 if ((FilePathSize
== 0) || (TempSize
== 0)) {
547 if (TempSize
+ FilePathSize
+ sizeof (UINT16
) + sizeof (UINT32
) > VariableSize
) {
551 return GetDevicePathSizeEx (DevicePath
, FilePathSize
) != 0;
555 Convert a single character to number.
556 It assumes the input Char is in the scope of L'0' ~ L'9' and L'A' ~ L'F'
558 @param Char The input char which need to change to a hex number.
566 if ((Char
>= L
'0') && (Char
<= L
'9')) {
567 return (UINTN
) (Char
- L
'0');
570 if ((Char
>= L
'A') && (Char
<= L
'F')) {
571 return (UINTN
) (Char
- L
'A' + 0xA);
579 Build the boot#### or driver#### option from the VariableName, the
580 build boot#### or driver#### will also be linked to BdsCommonOptionList.
582 @param BdsCommonOptionList The header of the boot#### or driver#### option
584 @param VariableName EFI Variable name indicate if it is boot#### or
587 @retval BDS_COMMON_OPTION Get the option just been created
588 @retval NULL Failed to get the new option
593 BdsLibVariableToOption (
594 IN OUT LIST_ENTRY
*BdsCommonOptionList
,
595 IN CHAR16
*VariableName
603 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
604 BDS_COMMON_OPTION
*Option
;
606 UINT32 LoadOptionsSize
;
611 // Read the variable. We will never free this data.
613 Variable
= BdsLibGetVariableAndSize (
615 &gEfiGlobalVariableGuid
,
618 if (Variable
== NULL
) {
623 // Validate Boot#### variable data.
625 if (!ValidateOption(Variable
, VariableSize
)) {
630 // Notes: careful defined the variable of Boot#### or
631 // Driver####, consider use some macro to abstract the code
634 // Get the option attribute
637 Attribute
= *(UINT32
*) Variable
;
638 TempPtr
+= sizeof (UINT32
);
641 // Get the option's device path size
643 FilePathSize
= *(UINT16
*) TempPtr
;
644 TempPtr
+= sizeof (UINT16
);
647 // Get the option's description string
649 Description
= (CHAR16
*) TempPtr
;
652 // Get the option's description string size
654 TempPtr
+= StrSize((CHAR16
*) TempPtr
);
657 // Get the option's device path
659 DevicePath
= (EFI_DEVICE_PATH_PROTOCOL
*) TempPtr
;
660 TempPtr
+= FilePathSize
;
663 // Get load opion data.
665 LoadOptions
= TempPtr
;
666 LoadOptionsSize
= (UINT32
) (VariableSize
- (UINTN
) (TempPtr
- Variable
));
669 // The Console variables may have multiple device paths, so make
670 // an Entry for each one.
672 Option
= AllocateZeroPool (sizeof (BDS_COMMON_OPTION
));
673 if (Option
== NULL
) {
677 Option
->Signature
= BDS_LOAD_OPTION_SIGNATURE
;
678 Option
->DevicePath
= AllocateZeroPool (GetDevicePathSize (DevicePath
));
679 ASSERT(Option
->DevicePath
!= NULL
);
680 CopyMem (Option
->DevicePath
, DevicePath
, GetDevicePathSize (DevicePath
));
682 Option
->Attribute
= Attribute
;
683 Option
->Description
= AllocateZeroPool (StrSize (Description
));
684 ASSERT(Option
->Description
!= NULL
);
685 CopyMem (Option
->Description
, Description
, StrSize (Description
));
687 Option
->LoadOptions
= AllocateZeroPool (LoadOptionsSize
);
688 ASSERT(Option
->LoadOptions
!= NULL
);
689 CopyMem (Option
->LoadOptions
, LoadOptions
, LoadOptionsSize
);
690 Option
->LoadOptionsSize
= LoadOptionsSize
;
693 // Get the value from VariableName Unicode string
694 // since the ISO standard assumes ASCII equivalent abbreviations, we can be safe in converting this
695 // Unicode stream to ASCII without any loss in meaning.
697 if (*VariableName
== 'B') {
698 NumOff
= (UINT8
) (sizeof (L
"Boot") / sizeof (CHAR16
) - 1);
699 Option
->BootCurrent
= (UINT16
) (CharToUint (VariableName
[NumOff
+0]) * 0x1000)
700 + (UINT16
) (CharToUint (VariableName
[NumOff
+1]) * 0x100)
701 + (UINT16
) (CharToUint (VariableName
[NumOff
+2]) * 0x10)
702 + (UINT16
) (CharToUint (VariableName
[NumOff
+3]) * 0x1);
705 // Insert active entry to BdsDeviceList
707 if ((Option
->Attribute
& LOAD_OPTION_ACTIVE
) == LOAD_OPTION_ACTIVE
) {
708 InsertTailList (BdsCommonOptionList
, &Option
->Link
);
714 FreePool (Option
->Description
);
715 FreePool (Option
->DevicePath
);
716 FreePool (Option
->LoadOptions
);
722 Process BootOrder, or DriverOrder variables, by calling
723 BdsLibVariableToOption () for each UINT16 in the variables.
725 @param BdsCommonOptionList The header of the option list base on variable
727 @param VariableName EFI Variable name indicate the BootOrder or
730 @retval EFI_SUCCESS Success create the boot option or driver option
732 @retval EFI_OUT_OF_RESOURCES Failed to get the boot option or driver option list
737 BdsLibBuildOptionFromVar (
738 IN LIST_ENTRY
*BdsCommonOptionList
,
739 IN CHAR16
*VariableName
743 UINTN OptionOrderSize
;
745 BDS_COMMON_OPTION
*Option
;
746 CHAR16 OptionName
[20];
749 // Zero Buffer in order to get all BOOT#### variables
751 ZeroMem (OptionName
, sizeof (OptionName
));
754 // Read the BootOrder, or DriverOrder variable.
756 OptionOrder
= BdsLibGetVariableAndSize (
758 &gEfiGlobalVariableGuid
,
761 if (OptionOrder
== NULL
) {
762 return EFI_OUT_OF_RESOURCES
;
765 for (Index
= 0; Index
< OptionOrderSize
/ sizeof (UINT16
); Index
++) {
766 if (*VariableName
== 'B') {
767 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Boot%04x", OptionOrder
[Index
]);
769 UnicodeSPrint (OptionName
, sizeof (OptionName
), L
"Driver%04x", OptionOrder
[Index
]);
772 Option
= BdsLibVariableToOption (BdsCommonOptionList
, OptionName
);
773 if (Option
!= NULL
) {
774 Option
->BootCurrent
= OptionOrder
[Index
];
778 FreePool (OptionOrder
);
784 Get boot mode by looking up configuration table and parsing HOB list
786 @param BootMode Boot mode from PEI handoff HOB.
788 @retval EFI_SUCCESS Successfully get boot mode
794 OUT EFI_BOOT_MODE
*BootMode
797 *BootMode
= GetBootModeHob ();
803 Read the EFI variable (VendorGuid/Name) and return a dynamically allocated
804 buffer, and the size of the buffer. If failure return NULL.
806 @param Name String part of EFI variable name
807 @param VendorGuid GUID part of EFI variable name
808 @param VariableSize Returns the size of the EFI variable that was read
810 @return Dynamically allocated memory that contains a copy of the EFI variable
811 Caller is responsible freeing the buffer.
812 @retval NULL Variable was not read
817 BdsLibGetVariableAndSize (
819 IN EFI_GUID
*VendorGuid
,
820 OUT UINTN
*VariableSize
830 // Pass in a zero size buffer to find the required buffer size.
833 Status
= gRT
->GetVariable (Name
, VendorGuid
, NULL
, &BufferSize
, Buffer
);
834 if (Status
== EFI_BUFFER_TOO_SMALL
) {
836 // Allocate the buffer to return
838 Buffer
= AllocateZeroPool (BufferSize
);
839 if (Buffer
== NULL
) {
843 // Read variable into the allocated buffer.
845 Status
= gRT
->GetVariable (Name
, VendorGuid
, NULL
, &BufferSize
, Buffer
);
846 if (EFI_ERROR (Status
)) {
851 *VariableSize
= BufferSize
;
856 Delete the instance in Multi which matches partly with Single instance
858 @param Multi A pointer to a multi-instance device path data
860 @param Single A pointer to a single-instance device path data
863 @return This function will remove the device path instances in Multi which partly
864 match with the Single, and return the result device path. If there is no
865 remaining device path as a result, this function will return NULL.
868 EFI_DEVICE_PATH_PROTOCOL
*
870 BdsLibDelPartMatchInstance (
871 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
872 IN EFI_DEVICE_PATH_PROTOCOL
*Single
875 EFI_DEVICE_PATH_PROTOCOL
*Instance
;
876 EFI_DEVICE_PATH_PROTOCOL
*NewDevicePath
;
877 EFI_DEVICE_PATH_PROTOCOL
*TempNewDevicePath
;
882 NewDevicePath
= NULL
;
883 TempNewDevicePath
= NULL
;
885 if (Multi
== NULL
|| Single
== NULL
) {
889 Instance
= GetNextDevicePathInstance (&Multi
, &InstanceSize
);
890 SingleDpSize
= GetDevicePathSize (Single
) - END_DEVICE_PATH_LENGTH
;
891 InstanceSize
-= END_DEVICE_PATH_LENGTH
;
893 while (Instance
!= NULL
) {
895 Size
= (SingleDpSize
< InstanceSize
) ? SingleDpSize
: InstanceSize
;
897 if ((CompareMem (Instance
, Single
, Size
) != 0)) {
899 // Append the device path instance which does not match with Single
901 TempNewDevicePath
= NewDevicePath
;
902 NewDevicePath
= AppendDevicePathInstance (NewDevicePath
, Instance
);
903 if (TempNewDevicePath
!= NULL
) {
904 FreePool(TempNewDevicePath
);
908 Instance
= GetNextDevicePathInstance (&Multi
, &InstanceSize
);
909 InstanceSize
-= END_DEVICE_PATH_LENGTH
;
912 return NewDevicePath
;
916 Function compares a device path data structure to that of all the nodes of a
917 second device path instance.
919 @param Multi A pointer to a multi-instance device path data
921 @param Single A pointer to a single-instance device path data
924 @retval TRUE If the Single device path is contained within Multi device path.
925 @retval FALSE The Single device path is not match within Multi device path.
930 BdsLibMatchDevicePaths (
931 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
932 IN EFI_DEVICE_PATH_PROTOCOL
*Single
935 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
936 EFI_DEVICE_PATH_PROTOCOL
*DevicePathInst
;
939 if (Multi
== NULL
|| Single
== NULL
) {
944 DevicePathInst
= GetNextDevicePathInstance (&DevicePath
, &Size
);
947 // Search for the match of 'Single' in 'Multi'
949 while (DevicePathInst
!= NULL
) {
951 // If the single device path is found in multiple device paths,
954 if (CompareMem (Single
, DevicePathInst
, Size
) == 0) {
955 FreePool (DevicePathInst
);
959 FreePool (DevicePathInst
);
960 DevicePathInst
= GetNextDevicePathInstance (&DevicePath
, &Size
);
967 This function prints a series of strings.
969 @param ConOut Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
970 @param ... A variable argument list containing series of
971 strings, the last string must be NULL.
973 @retval EFI_SUCCESS Success print out the string using ConOut.
974 @retval EFI_STATUS Return the status of the ConOut->OutputString ().
979 BdsLibOutputStrings (
980 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*ConOut
,
988 Status
= EFI_SUCCESS
;
989 VA_START (Args
, ConOut
);
991 while (!EFI_ERROR (Status
)) {
993 // If String is NULL, then it's the end of the list
995 String
= VA_ARG (Args
, CHAR16
*);
996 if (String
== NULL
) {
1000 Status
= ConOut
->OutputString (ConOut
, String
);
1002 if (EFI_ERROR (Status
)) {
1012 // Following are BDS Lib functions which contain all the code about setup browser reset reminder feature.
1013 // Setup Browser reset reminder feature is that an reset reminder will be given before user leaves the setup browser if
1014 // user change any option setting which needs a reset to be effective, and the reset will be applied according to the user selection.
1019 Enable the setup browser reset reminder feature.
1020 This routine is used in platform tip. If the platform policy need the feature, use the routine to enable it.
1025 EnableResetReminderFeature (
1029 mFeaturerSwitch
= TRUE
;
1034 Disable the setup browser reset reminder feature.
1035 This routine is used in platform tip. If the platform policy do not want the feature, use the routine to disable it.
1040 DisableResetReminderFeature (
1044 mFeaturerSwitch
= FALSE
;
1049 Record the info that a reset is required.
1050 A module boolean variable is used to record whether a reset is required.
1055 EnableResetRequired (
1059 mResetRequired
= TRUE
;
1064 Record the info that no reset is required.
1065 A module boolean variable is used to record whether a reset is required.
1070 DisableResetRequired (
1074 mResetRequired
= FALSE
;
1079 Check whether platform policy enable the reset reminder feature. The default is enabled.
1084 IsResetReminderFeatureEnable (
1088 return mFeaturerSwitch
;
1093 Check if user changed any option setting which needs a system reset to be effective.
1102 return mResetRequired
;
1107 Check whether a reset is needed, and finish the reset reminder feature.
1108 If a reset is needed, Popup a menu to notice user, and finish the feature
1109 according to the user selection.
1114 SetupResetReminder (
1119 CHAR16
*StringBuffer1
;
1120 CHAR16
*StringBuffer2
;
1124 //check any reset required change is applied? if yes, reset system
1126 if (IsResetReminderFeatureEnable ()) {
1127 if (IsResetRequired ()) {
1129 StringBuffer1
= AllocateZeroPool (MAX_STRING_LEN
* sizeof (CHAR16
));
1130 ASSERT (StringBuffer1
!= NULL
);
1131 StringBuffer2
= AllocateZeroPool (MAX_STRING_LEN
* sizeof (CHAR16
));
1132 ASSERT (StringBuffer2
!= NULL
);
1133 StrCpy (StringBuffer1
, L
"Configuration changed. Reset to apply it Now ? ");
1134 StrCpy (StringBuffer2
, L
"Enter (YES) / Esc (NO)");
1136 // Popup a menu to notice user
1139 CreatePopUp (EFI_LIGHTGRAY
| EFI_BACKGROUND_BLUE
, &Key
, StringBuffer1
, StringBuffer2
, NULL
);
1140 } while ((Key
.ScanCode
!= SCAN_ESC
) && (Key
.UnicodeChar
!= CHAR_CARRIAGE_RETURN
));
1142 FreePool (StringBuffer1
);
1143 FreePool (StringBuffer2
);
1145 // If the user hits the YES Response key, reset
1147 if (Key
.UnicodeChar
== CHAR_CARRIAGE_RETURN
) {
1148 gRT
->ResetSystem (EfiResetCold
, EFI_SUCCESS
, 0, NULL
);
1150 gST
->ConOut
->ClearScreen (gST
->ConOut
);
1156 Get the headers (dos, image, optional header) from an image
1158 @param Device SimpleFileSystem device handle
1159 @param FileName File name for the image
1160 @param DosHeader Pointer to dos header
1161 @param Hdr The buffer in which to return the PE32, PE32+, or TE header.
1163 @retval EFI_SUCCESS Successfully get the machine type.
1164 @retval EFI_NOT_FOUND The file is not found.
1165 @retval EFI_LOAD_ERROR File is not a valid image file.
1170 BdsLibGetImageHeader (
1171 IN EFI_HANDLE Device
,
1172 IN CHAR16
*FileName
,
1173 OUT EFI_IMAGE_DOS_HEADER
*DosHeader
,
1174 OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
1178 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*Volume
;
1179 EFI_FILE_HANDLE Root
;
1180 EFI_FILE_HANDLE ThisFile
;
1183 EFI_FILE_INFO
*Info
;
1188 // Handle the file system interface to the device
1190 Status
= gBS
->HandleProtocol (
1192 &gEfiSimpleFileSystemProtocolGuid
,
1195 if (EFI_ERROR (Status
)) {
1199 Status
= Volume
->OpenVolume (
1203 if (EFI_ERROR (Status
)) {
1207 ASSERT (Root
!= NULL
);
1208 Status
= Root
->Open (Root
, &ThisFile
, FileName
, EFI_FILE_MODE_READ
, 0);
1209 if (EFI_ERROR (Status
)) {
1212 ASSERT (ThisFile
!= NULL
);
1217 BufferSize
= SIZE_OF_EFI_FILE_INFO
+ 200;
1220 Status
= gBS
->AllocatePool (EfiBootServicesData
, BufferSize
, (VOID
**) &Info
);
1221 if (EFI_ERROR (Status
)) {
1224 Status
= ThisFile
->GetInfo (
1230 if (!EFI_ERROR (Status
)) {
1233 if (Status
!= EFI_BUFFER_TOO_SMALL
) {
1240 FileSize
= Info
->FileSize
;
1246 BufferSize
= sizeof (EFI_IMAGE_DOS_HEADER
);
1247 Status
= ThisFile
->Read (ThisFile
, &BufferSize
, DosHeader
);
1248 if (EFI_ERROR (Status
) ||
1249 BufferSize
< sizeof (EFI_IMAGE_DOS_HEADER
) ||
1250 FileSize
<= DosHeader
->e_lfanew
||
1251 DosHeader
->e_magic
!= EFI_IMAGE_DOS_SIGNATURE
) {
1252 Status
= EFI_LOAD_ERROR
;
1257 // Move to PE signature
1259 Status
= ThisFile
->SetPosition (ThisFile
, DosHeader
->e_lfanew
);
1260 if (EFI_ERROR (Status
)) {
1261 Status
= EFI_LOAD_ERROR
;
1266 // Read and check PE signature
1268 BufferSize
= sizeof (EFI_IMAGE_OPTIONAL_HEADER_UNION
);
1269 Status
= ThisFile
->Read (ThisFile
, &BufferSize
, Hdr
.Pe32
);
1270 if (EFI_ERROR (Status
) ||
1271 BufferSize
< sizeof (EFI_IMAGE_OPTIONAL_HEADER_UNION
) ||
1272 Hdr
.Pe32
->Signature
!= EFI_IMAGE_NT_SIGNATURE
) {
1273 Status
= EFI_LOAD_ERROR
;
1278 // Check PE32 or PE32+ magic
1280 if (Hdr
.Pe32
->OptionalHeader
.Magic
!= EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC
&&
1281 Hdr
.Pe32
->OptionalHeader
.Magic
!= EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC
) {
1282 Status
= EFI_LOAD_ERROR
;
1287 if (ThisFile
!= NULL
) {
1288 ThisFile
->Close (ThisFile
);
1297 This routine adjusts the memory information for different memory type and
1298 saves them into the variables for next boot. It conditionally resets the
1299 system when the memory information changes. Platform can reserve memory
1300 large enough (125% of actual requirement) to avoid the reset in the first boot.
1303 BdsSetMemoryTypeInformationVariable (
1308 EFI_MEMORY_TYPE_INFORMATION
*PreviousMemoryTypeInformation
;
1309 EFI_MEMORY_TYPE_INFORMATION
*CurrentMemoryTypeInformation
;
1316 EFI_HOB_GUID_TYPE
*GuidHob
;
1317 BOOLEAN MemoryTypeInformationModified
;
1318 BOOLEAN MemoryTypeInformationVariableExists
;
1319 EFI_BOOT_MODE BootMode
;
1321 MemoryTypeInformationModified
= FALSE
;
1322 MemoryTypeInformationVariableExists
= FALSE
;
1325 BootMode
= GetBootModeHob ();
1327 // In BOOT_IN_RECOVERY_MODE, Variable region is not reliable.
1329 if (BootMode
== BOOT_IN_RECOVERY_MODE
) {
1334 // Only check the the Memory Type Information variable in the boot mode
1335 // other than BOOT_WITH_DEFAULT_SETTINGS because the Memory Type
1336 // Information is not valid in this boot mode.
1338 if (BootMode
!= BOOT_WITH_DEFAULT_SETTINGS
) {
1340 Status
= gRT
->GetVariable (
1341 EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME
,
1342 &gEfiMemoryTypeInformationGuid
,
1347 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1348 MemoryTypeInformationVariableExists
= TRUE
;
1353 // Retrieve the current memory usage statistics. If they are not found, then
1354 // no adjustments can be made to the Memory Type Information variable.
1356 Status
= EfiGetSystemConfigurationTable (
1357 &gEfiMemoryTypeInformationGuid
,
1358 (VOID
**) &CurrentMemoryTypeInformation
1360 if (EFI_ERROR (Status
) || CurrentMemoryTypeInformation
== NULL
) {
1365 // Get the Memory Type Information settings from Hob if they exist,
1366 // PEI is responsible for getting them from variable and build a Hob to save them.
1367 // If the previous Memory Type Information is not available, then set defaults
1369 GuidHob
= GetFirstGuidHob (&gEfiMemoryTypeInformationGuid
);
1370 if (GuidHob
== NULL
) {
1372 // If Platform has not built Memory Type Info into the Hob, just return.
1376 PreviousMemoryTypeInformation
= GET_GUID_HOB_DATA (GuidHob
);
1377 VariableSize
= GET_GUID_HOB_DATA_SIZE (GuidHob
);
1380 // Use a heuristic to adjust the Memory Type Information for the next boot
1382 DEBUG ((EFI_D_INFO
, "Memory Previous Current Next \n"));
1383 DEBUG ((EFI_D_INFO
, " Type Pages Pages Pages \n"));
1384 DEBUG ((EFI_D_INFO
, "====== ======== ======== ========\n"));
1386 for (Index
= 0; PreviousMemoryTypeInformation
[Index
].Type
!= EfiMaxMemoryType
; Index
++) {
1388 for (Index1
= 0; CurrentMemoryTypeInformation
[Index1
].Type
!= EfiMaxMemoryType
; Index1
++) {
1389 if (PreviousMemoryTypeInformation
[Index
].Type
== CurrentMemoryTypeInformation
[Index1
].Type
) {
1393 if (CurrentMemoryTypeInformation
[Index1
].Type
== EfiMaxMemoryType
) {
1398 // Previous is the number of pages pre-allocated
1399 // Current is the number of pages actually needed
1401 Previous
= PreviousMemoryTypeInformation
[Index
].NumberOfPages
;
1402 Current
= CurrentMemoryTypeInformation
[Index1
].NumberOfPages
;
1406 // Write next varible to 125% * current and Inconsistent Memory Reserved across bootings may lead to S4 fail
1408 if (Current
< Previous
) {
1409 if (BootMode
== BOOT_WITH_DEFAULT_SETTINGS
) {
1410 Next
= Current
+ (Current
>> 2);
1411 } else if (!MemoryTypeInformationVariableExists
) {
1412 Next
= MAX (Current
+ (Current
>> 2), Previous
);
1414 } else if (Current
> Previous
) {
1415 Next
= Current
+ (Current
>> 2);
1417 if (Next
> 0 && Next
< 4) {
1421 if (Next
!= Previous
) {
1422 PreviousMemoryTypeInformation
[Index
].NumberOfPages
= Next
;
1423 MemoryTypeInformationModified
= TRUE
;
1426 DEBUG ((EFI_D_INFO
, " %02x %08x %08x %08x\n", PreviousMemoryTypeInformation
[Index
].Type
, Previous
, Current
, Next
));
1430 // If any changes were made to the Memory Type Information settings, then set the new variable value;
1431 // Or create the variable in first boot.
1433 if (MemoryTypeInformationModified
|| !MemoryTypeInformationVariableExists
) {
1434 Status
= gRT
->SetVariable (
1435 EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME
,
1436 &gEfiMemoryTypeInformationGuid
,
1437 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
1439 PreviousMemoryTypeInformation
1443 // If the Memory Type Information settings have been modified, then reset the platform
1444 // so the new Memory Type Information setting will be used to guarantee that an S4
1445 // entry/resume cycle will not fail.
1447 if (MemoryTypeInformationModified
&& PcdGetBool (PcdResetOnMemoryTypeInformationChange
)) {
1448 DEBUG ((EFI_D_INFO
, "Memory Type Information settings change. Warm Reset!!!\n"));
1449 gRT
->ResetSystem (EfiResetWarm
, EFI_SUCCESS
, 0, NULL
);
1455 This routine is kept for backward compatibility.
1459 BdsLibSaveMemoryTypeInformation (
1467 Identify a user and, if authenticated, returns the current user profile handle.
1469 @param[out] User Point to user profile handle.
1471 @retval EFI_SUCCESS User is successfully identified, or user identification
1473 @retval EFI_ACCESS_DENIED User is not successfully identified
1478 BdsLibUserIdentify (
1479 OUT EFI_USER_PROFILE_HANDLE
*User
1483 EFI_USER_MANAGER_PROTOCOL
*Manager
;
1485 Status
= gBS
->LocateProtocol (
1486 &gEfiUserManagerProtocolGuid
,
1490 if (EFI_ERROR (Status
)) {
1494 return Manager
->Identify (Manager
, User
);