]> git.proxmox.com Git - mirror_edk2.git/blob - IntelFrameworkModulePkg/Library/GenericBdsLib/BdsMisc.c
Add code to check boot option variable before use it
[mirror_edk2.git] / IntelFrameworkModulePkg / Library / GenericBdsLib / BdsMisc.c
1 /** @file
2 Misc BDS library function
3
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
9
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.
12
13 **/
14
15 #include "InternalBdsLib.h"
16
17
18 #define MAX_STRING_LEN 200
19
20 BOOLEAN mFeaturerSwitch = TRUE;
21 BOOLEAN mResetRequired = FALSE;
22
23 extern UINT16 gPlatformBootTimeOutDefault;
24
25 /**
26 The function will go through the driver option link list, load and start
27 every driver the driver option device path point to.
28
29 @param BdsDriverLists The header of the current driver option link list
30
31 **/
32 VOID
33 EFIAPI
34 BdsLibLoadDrivers (
35 IN LIST_ENTRY *BdsDriverLists
36 )
37 {
38 EFI_STATUS Status;
39 LIST_ENTRY *Link;
40 BDS_COMMON_OPTION *Option;
41 EFI_HANDLE ImageHandle;
42 EFI_LOADED_IMAGE_PROTOCOL *ImageInfo;
43 UINTN ExitDataSize;
44 CHAR16 *ExitData;
45 BOOLEAN ReconnectAll;
46
47 ReconnectAll = FALSE;
48
49 //
50 // Process the driver option
51 //
52 for (Link = BdsDriverLists->ForwardLink; Link != BdsDriverLists; Link = Link->ForwardLink) {
53 Option = CR (Link, BDS_COMMON_OPTION, Link, BDS_LOAD_OPTION_SIGNATURE);
54
55 //
56 // If a load option is not marked as LOAD_OPTION_ACTIVE,
57 // the boot manager will not automatically load the option.
58 //
59 if (!IS_LOAD_OPTION_TYPE (Option->Attribute, LOAD_OPTION_ACTIVE)) {
60 continue;
61 }
62
63 //
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.
67 //
68 if (IS_LOAD_OPTION_TYPE (Option->Attribute, LOAD_OPTION_FORCE_RECONNECT)) {
69 ReconnectAll = TRUE;
70 }
71
72 //
73 // Make sure the driver path is connected.
74 //
75 BdsLibConnectDevicePath (Option->DevicePath);
76
77 //
78 // Load and start the image that Driver#### describes
79 //
80 Status = gBS->LoadImage (
81 FALSE,
82 gImageHandle,
83 Option->DevicePath,
84 NULL,
85 0,
86 &ImageHandle
87 );
88
89 if (!EFI_ERROR (Status)) {
90 gBS->HandleProtocol (ImageHandle, &gEfiLoadedImageProtocolGuid, (VOID **) &ImageInfo);
91
92 //
93 // Verify whether this image is a driver, if not,
94 // exit it and continue to parse next load option
95 //
96 if (ImageInfo->ImageCodeType != EfiBootServicesCode && ImageInfo->ImageCodeType != EfiRuntimeServicesCode) {
97 gBS->Exit (ImageHandle, EFI_INVALID_PARAMETER, 0, NULL);
98 continue;
99 }
100
101 if (Option->LoadOptionsSize != 0) {
102 ImageInfo->LoadOptionsSize = Option->LoadOptionsSize;
103 ImageInfo->LoadOptions = Option->LoadOptions;
104 }
105 //
106 // Before calling the image, enable the Watchdog Timer for
107 // the 5 Minute period
108 //
109 gBS->SetWatchdogTimer (5 * 60, 0x0000, 0x00, NULL);
110
111 Status = gBS->StartImage (ImageHandle, &ExitDataSize, &ExitData);
112 DEBUG ((DEBUG_INFO | DEBUG_LOAD, "Driver Return Status = %r\n", Status));
113
114 //
115 // Clear the Watchdog Timer after the image returns
116 //
117 gBS->SetWatchdogTimer (0x0000, 0x0000, 0x0000, NULL);
118 }
119 }
120
121 //
122 // Process the LOAD_OPTION_FORCE_RECONNECT driver option
123 //
124 if (ReconnectAll) {
125 BdsLibDisconnectAllEfi ();
126 BdsLibConnectAll ();
127 }
128
129 }
130
131 /**
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.
134
135 @param VariableName Indicate if the boot#### or driver#### option
136
137 @return The Minimal Free Option Number
138
139 **/
140 UINT16
141 BdsLibGetFreeOptionNumber (
142 IN CHAR16 *VariableName
143 )
144 {
145 UINTN Index;
146 CHAR16 StrTemp[10];
147 UINT16 *OptionBuffer;
148 UINTN OptionSize;
149
150 //
151 // Try to find the minimum free number from 0, 1, 2, 3....
152 //
153 Index = 0;
154 do {
155 if (*VariableName == 'B') {
156 UnicodeSPrint (StrTemp, sizeof (StrTemp), L"Boot%04x", Index);
157 } else {
158 UnicodeSPrint (StrTemp, sizeof (StrTemp), L"Driver%04x", Index);
159 }
160 //
161 // try if the option number is used
162 //
163 OptionBuffer = BdsLibGetVariableAndSize (
164 StrTemp,
165 &gEfiGlobalVariableGuid,
166 &OptionSize
167 );
168 if (OptionBuffer == NULL) {
169 break;
170 }
171 Index++;
172 } while (TRUE);
173
174 return ((UINT16) Index);
175 }
176
177
178 /**
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.
183
184 @param BdsOptionList The header of the boot#### or driver#### link list
185 @param DevicePath The device path which the boot#### or driver####
186 option present
187 @param String The description of the boot#### or driver####
188 @param VariableName Indicate if the boot#### or driver#### option
189
190 @retval EFI_SUCCESS The boot#### or driver#### have been success
191 registered
192 @retval EFI_STATUS Return the status of gRT->SetVariable ().
193
194 **/
195 EFI_STATUS
196 EFIAPI
197 BdsLibRegisterNewOption (
198 IN LIST_ENTRY *BdsOptionList,
199 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,
200 IN CHAR16 *String,
201 IN CHAR16 *VariableName
202 )
203 {
204 EFI_STATUS Status;
205 UINTN Index;
206 UINT16 RegisterOptionNumber;
207 UINT16 *TempOptionPtr;
208 UINTN TempOptionSize;
209 UINT16 *OptionOrderPtr;
210 VOID *OptionPtr;
211 UINTN OptionSize;
212 UINT8 *TempPtr;
213 EFI_DEVICE_PATH_PROTOCOL *OptionDevicePath;
214 CHAR16 *Description;
215 CHAR16 OptionName[10];
216 BOOLEAN UpdateDescription;
217 UINT16 BootOrderEntry;
218 UINTN OrderItemNum;
219
220
221 OptionPtr = NULL;
222 OptionSize = 0;
223 TempPtr = NULL;
224 OptionDevicePath = NULL;
225 Description = NULL;
226 OptionOrderPtr = NULL;
227 UpdateDescription = FALSE;
228 Status = EFI_SUCCESS;
229 ZeroMem (OptionName, sizeof (OptionName));
230
231 TempOptionSize = 0;
232 TempOptionPtr = BdsLibGetVariableAndSize (
233 VariableName,
234 &gEfiGlobalVariableGuid,
235 &TempOptionSize
236 );
237 //
238 // Compare with current option variable if the previous option is set in global variable.
239 //
240 for (Index = 0; Index < TempOptionSize / sizeof (UINT16); Index++) {
241 //
242 // TempOptionPtr must not be NULL if we have non-zero TempOptionSize.
243 //
244 ASSERT (TempOptionPtr != NULL);
245
246 if (*VariableName == 'B') {
247 UnicodeSPrint (OptionName, sizeof (OptionName), L"Boot%04x", TempOptionPtr[Index]);
248 } else {
249 UnicodeSPrint (OptionName, sizeof (OptionName), L"Driver%04x", TempOptionPtr[Index]);
250 }
251
252 OptionPtr = BdsLibGetVariableAndSize (
253 OptionName,
254 &gEfiGlobalVariableGuid,
255 &OptionSize
256 );
257 if (OptionPtr == NULL) {
258 continue;
259 }
260
261 //
262 // Validate the variable.
263 //
264 if (!ValidateOption(OptionPtr, OptionSize)) {
265 continue;
266 }
267
268 TempPtr = OptionPtr;
269 TempPtr += sizeof (UINT32) + sizeof (UINT16);
270 Description = (CHAR16 *) TempPtr;
271 TempPtr += StrSize ((CHAR16 *) TempPtr);
272 OptionDevicePath = (EFI_DEVICE_PATH_PROTOCOL *) TempPtr;
273
274 //
275 // Notes: the description may will change base on the GetStringToken
276 //
277 if (CompareMem (OptionDevicePath, DevicePath, GetDevicePathSize (OptionDevicePath)) == 0) {
278 if (CompareMem (Description, String, StrSize (Description)) == 0) {
279 //
280 // Got the option, so just return
281 //
282 FreePool (OptionPtr);
283 FreePool (TempOptionPtr);
284 return EFI_SUCCESS;
285 } else {
286 //
287 // Option description changed, need update.
288 //
289 UpdateDescription = TRUE;
290 FreePool (OptionPtr);
291 break;
292 }
293 }
294
295 FreePool (OptionPtr);
296 }
297
298 OptionSize = sizeof (UINT32) + sizeof (UINT16) + StrSize (String);
299 OptionSize += GetDevicePathSize (DevicePath);
300 OptionPtr = AllocateZeroPool (OptionSize);
301 ASSERT (OptionPtr != NULL);
302
303 TempPtr = OptionPtr;
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));
311
312 if (UpdateDescription) {
313 //
314 // The number in option#### to be updated.
315 // In this case, we must have non-NULL TempOptionPtr.
316 //
317 ASSERT (TempOptionPtr != NULL);
318 RegisterOptionNumber = TempOptionPtr[Index];
319 } else {
320 //
321 // The new option#### number
322 //
323 RegisterOptionNumber = BdsLibGetFreeOptionNumber(VariableName);
324 }
325
326 if (*VariableName == 'B') {
327 UnicodeSPrint (OptionName, sizeof (OptionName), L"Boot%04x", RegisterOptionNumber);
328 } else {
329 UnicodeSPrint (OptionName, sizeof (OptionName), L"Driver%04x", RegisterOptionNumber);
330 }
331
332 Status = gRT->SetVariable (
333 OptionName,
334 &gEfiGlobalVariableGuid,
335 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,
336 OptionSize,
337 OptionPtr
338 );
339 //
340 // Return if only need to update a changed description or fail to set option.
341 //
342 if (EFI_ERROR (Status) || UpdateDescription) {
343 FreePool (OptionPtr);
344 if (TempOptionPtr != NULL) {
345 FreePool (TempOptionPtr);
346 }
347 return Status;
348 }
349
350 FreePool (OptionPtr);
351
352 //
353 // Update the option order variable
354 //
355
356 //
357 // If no option order
358 //
359 if (TempOptionSize == 0) {
360 BootOrderEntry = 0;
361 Status = gRT->SetVariable (
362 VariableName,
363 &gEfiGlobalVariableGuid,
364 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,
365 sizeof (UINT16),
366 &BootOrderEntry
367 );
368 if (TempOptionPtr != NULL) {
369 FreePool (TempOptionPtr);
370 }
371 return Status;
372 }
373
374 //
375 // TempOptionPtr must not be NULL if TempOptionSize is not zero.
376 //
377 ASSERT (TempOptionPtr != NULL);
378 //
379 // Append the new option number to the original option order
380 //
381 OrderItemNum = (TempOptionSize / sizeof (UINT16)) + 1 ;
382 OptionOrderPtr = AllocateZeroPool ( OrderItemNum * sizeof (UINT16));
383 ASSERT (OptionOrderPtr!= NULL);
384 CopyMem (OptionOrderPtr, TempOptionPtr, (OrderItemNum - 1) * sizeof (UINT16));
385
386 OptionOrderPtr[Index] = RegisterOptionNumber;
387
388 Status = gRT->SetVariable (
389 VariableName,
390 &gEfiGlobalVariableGuid,
391 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,
392 OrderItemNum * sizeof (UINT16),
393 OptionOrderPtr
394 );
395 FreePool (TempOptionPtr);
396 FreePool (OptionOrderPtr);
397
398 return Status;
399 }
400
401 /**
402 Returns the size of a device path in bytes.
403
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.
408
409 @param DevicePath A pointer to a device path data structure.
410 @param MaxSize Max valid device path size. If big than this size,
411 return error.
412
413 @retval 0 An invalid device path.
414 @retval Others The size of a device path in bytes.
415
416 **/
417 UINTN
418 GetDevicePathSizeEx (
419 IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,
420 IN UINTN MaxSize
421 )
422 {
423 UINTN Size;
424 UINTN NodeSize;
425
426 if (DevicePath == NULL) {
427 return 0;
428 }
429
430 //
431 // Search for the end of the device path structure
432 //
433 Size = 0;
434 while (!IsDevicePathEnd (DevicePath)) {
435 NodeSize = DevicePathNodeLength (DevicePath);
436 if (NodeSize < END_DEVICE_PATH_LENGTH) {
437 return 0;
438 }
439 Size += NodeSize;
440 if (Size > MaxSize) {
441 return 0;
442 }
443 DevicePath = NextDevicePathNode (DevicePath);
444 }
445 Size += DevicePathNodeLength (DevicePath);
446 if (Size > MaxSize) {
447 return 0;
448 }
449
450 return Size;
451 }
452
453 /**
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
456 invalidate string.
457
458 This function returns the number of Unicode characters in the Null-terminated
459 Unicode string specified by String.
460
461 If String is NULL, then ASSERT().
462 If String is not aligned on a 16-bit boundary, then ASSERT().
463
464 @param String A pointer to a Null-terminated Unicode string.
465 @param MaxStringLen Max string len in this string.
466
467 @retval 0 An invalid string.
468 @retval Others The length of String.
469
470 **/
471 UINTN
472 StrSizeEx (
473 IN CONST CHAR16 *String,
474 IN UINTN MaxStringLen
475 )
476 {
477 UINTN Length;
478
479 ASSERT (String != NULL && MaxStringLen != 0);
480 ASSERT (((UINTN) String & BIT0) == 0);
481
482 for (Length = 0; *String != L'\0' && MaxStringLen != Length; String++, Length++);
483
484 if (*String != L'\0' && MaxStringLen == Length) {
485 return 0;
486 }
487
488 return (Length + 1) * sizeof (*String);
489 }
490
491 /**
492 Validate the EFI Boot#### variable (VendorGuid/Name)
493
494 @param Variable Boot#### variable data.
495 @param VariableSize Returns the size of the EFI variable that was read
496
497 @retval TRUE The variable data is correct.
498 @retval FALSE The variable data is corrupted.
499
500 **/
501 BOOLEAN
502 ValidateOption (
503 UINT8 *Variable,
504 UINTN VariableSize
505 )
506 {
507 UINT16 FilePathSize;
508 UINT8 *TempPtr;
509 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
510 EFI_DEVICE_PATH_PROTOCOL *TempPath;
511 UINTN TempSize;
512
513 //
514 // Skip the option attribute
515 //
516 TempPtr = Variable;
517 TempPtr += sizeof (UINT32);
518
519 //
520 // Get the option's device path size
521 //
522 FilePathSize = *(UINT16 *) TempPtr;
523 TempPtr += sizeof (UINT16);
524
525 //
526 // Get the option's description string size
527 //
528 TempSize = StrSizeEx ((CHAR16 *) TempPtr, VariableSize);
529 TempPtr += TempSize;
530
531 //
532 // Get the option's device path
533 //
534 DevicePath = (EFI_DEVICE_PATH_PROTOCOL *) TempPtr;
535 TempPtr += FilePathSize;
536
537 //
538 // Validation boot option variable.
539 //
540 if ((FilePathSize == 0) || (TempSize == 0)) {
541 return FALSE;
542 }
543
544 if (TempSize + FilePathSize + sizeof (UINT16) + sizeof (UINT16) > VariableSize) {
545 return FALSE;
546 }
547
548 TempPath = DevicePath;
549 while (FilePathSize > 0) {
550 TempSize = GetDevicePathSizeEx (TempPath, FilePathSize);
551 if (TempSize == 0) {
552 return FALSE;
553 }
554 FilePathSize = (UINT16) (FilePathSize - TempSize);
555 TempPath += TempSize;
556 }
557
558 return TRUE;
559 }
560
561 /**
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'
564
565 @param Char The input char which need to change to a hex number.
566
567 **/
568 UINTN
569 CharToUint (
570 IN CHAR16 Char
571 )
572 {
573 if ((Char >= L'0') && (Char <= L'9')) {
574 return (UINTN) (Char - L'0');
575 }
576
577 if ((Char >= L'A') && (Char <= L'F')) {
578 return (UINTN) (Char - L'A' + 0xA);
579 }
580
581 ASSERT (FALSE);
582 return 0;
583 }
584
585 /**
586 Build the boot#### or driver#### option from the VariableName, the
587 build boot#### or driver#### will also be linked to BdsCommonOptionList.
588
589 @param BdsCommonOptionList The header of the boot#### or driver#### option
590 link list
591 @param VariableName EFI Variable name indicate if it is boot#### or
592 driver####
593
594 @retval BDS_COMMON_OPTION Get the option just been created
595 @retval NULL Failed to get the new option
596
597 **/
598 BDS_COMMON_OPTION *
599 EFIAPI
600 BdsLibVariableToOption (
601 IN OUT LIST_ENTRY *BdsCommonOptionList,
602 IN CHAR16 *VariableName
603 )
604 {
605 UINT32 Attribute;
606 UINT16 FilePathSize;
607 UINT8 *Variable;
608 UINT8 *TempPtr;
609 UINTN VariableSize;
610 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
611 EFI_DEVICE_PATH_PROTOCOL *TempPath;
612 BDS_COMMON_OPTION *Option;
613 VOID *LoadOptions;
614 UINT32 LoadOptionsSize;
615 CHAR16 *Description;
616 UINT8 NumOff;
617 UINTN TempSize;
618 //
619 // Read the variable. We will never free this data.
620 //
621 Variable = BdsLibGetVariableAndSize (
622 VariableName,
623 &gEfiGlobalVariableGuid,
624 &VariableSize
625 );
626 if (Variable == NULL) {
627 return NULL;
628 }
629
630 //
631 // Validate Boot#### variable data.
632 //
633 if (!ValidateOption(Variable, VariableSize)) {
634 return NULL;
635 }
636
637 //
638 // Notes: careful defined the variable of Boot#### or
639 // Driver####, consider use some macro to abstract the code
640 //
641 //
642 // Get the option attribute
643 //
644 TempPtr = Variable;
645 Attribute = *(UINT32 *) Variable;
646 TempPtr += sizeof (UINT32);
647
648 //
649 // Get the option's device path size
650 //
651 FilePathSize = *(UINT16 *) TempPtr;
652 TempPtr += sizeof (UINT16);
653
654 //
655 // Get the option's description string
656 //
657 Description = (CHAR16 *) TempPtr;
658
659 //
660 // Get the option's description string size
661 //
662 TempSize = StrSizeEx ((CHAR16 *) TempPtr, VariableSize);
663 if (TempSize == 0) {
664 return NULL;
665 }
666 TempPtr += TempSize;
667
668 //
669 // Get the option's device path
670 //
671 DevicePath = (EFI_DEVICE_PATH_PROTOCOL *) TempPtr;
672 TempPtr += FilePathSize;
673
674 //
675 // Validation device path.
676 //
677 TempPath = DevicePath;
678 while (FilePathSize > 0) {
679 TempSize = GetDevicePathSizeEx (TempPath, FilePathSize);
680 if (TempSize == 0) {
681 return NULL;
682 }
683 FilePathSize = (UINT16) (FilePathSize - TempSize);
684 TempPath += TempSize;
685 }
686
687 //
688 // Get load opion data.
689 //
690 LoadOptions = TempPtr;
691 if (VariableSize < (UINTN)(TempPtr - Variable)) {
692 return NULL;
693 }
694 LoadOptionsSize = (UINT32) (VariableSize - (UINTN) (TempPtr - Variable));
695
696 //
697 // The Console variables may have multiple device paths, so make
698 // an Entry for each one.
699 //
700 Option = AllocateZeroPool (sizeof (BDS_COMMON_OPTION));
701 if (Option == NULL) {
702 return NULL;
703 }
704
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));
709
710 Option->Attribute = Attribute;
711 Option->Description = AllocateZeroPool (StrSize (Description));
712 ASSERT(Option->Description != NULL);
713 CopyMem (Option->Description, Description, StrSize (Description));
714
715 Option->LoadOptions = AllocateZeroPool (LoadOptionsSize);
716 ASSERT(Option->LoadOptions != NULL);
717 CopyMem (Option->LoadOptions, LoadOptions, LoadOptionsSize);
718 Option->LoadOptionsSize = LoadOptionsSize;
719
720 //
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.
724 //
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);
731 }
732 //
733 // Insert active entry to BdsDeviceList
734 //
735 if ((Option->Attribute & LOAD_OPTION_ACTIVE) == LOAD_OPTION_ACTIVE) {
736 InsertTailList (BdsCommonOptionList, &Option->Link);
737 FreePool (Variable);
738 return Option;
739 }
740
741 FreePool (Variable);
742 FreePool (Option);
743 return NULL;
744
745 }
746
747 /**
748 Process BootOrder, or DriverOrder variables, by calling
749 BdsLibVariableToOption () for each UINT16 in the variables.
750
751 @param BdsCommonOptionList The header of the option list base on variable
752 VariableName
753 @param VariableName EFI Variable name indicate the BootOrder or
754 DriverOrder
755
756 @retval EFI_SUCCESS Success create the boot option or driver option
757 list
758 @retval EFI_OUT_OF_RESOURCES Failed to get the boot option or driver option list
759
760 **/
761 EFI_STATUS
762 EFIAPI
763 BdsLibBuildOptionFromVar (
764 IN LIST_ENTRY *BdsCommonOptionList,
765 IN CHAR16 *VariableName
766 )
767 {
768 UINT16 *OptionOrder;
769 UINTN OptionOrderSize;
770 UINTN Index;
771 BDS_COMMON_OPTION *Option;
772 CHAR16 OptionName[20];
773
774 //
775 // Zero Buffer in order to get all BOOT#### variables
776 //
777 ZeroMem (OptionName, sizeof (OptionName));
778
779 //
780 // Read the BootOrder, or DriverOrder variable.
781 //
782 OptionOrder = BdsLibGetVariableAndSize (
783 VariableName,
784 &gEfiGlobalVariableGuid,
785 &OptionOrderSize
786 );
787 if (OptionOrder == NULL) {
788 return EFI_OUT_OF_RESOURCES;
789 }
790
791 for (Index = 0; Index < OptionOrderSize / sizeof (UINT16); Index++) {
792 if (*VariableName == 'B') {
793 UnicodeSPrint (OptionName, sizeof (OptionName), L"Boot%04x", OptionOrder[Index]);
794 } else {
795 UnicodeSPrint (OptionName, sizeof (OptionName), L"Driver%04x", OptionOrder[Index]);
796 }
797
798 Option = BdsLibVariableToOption (BdsCommonOptionList, OptionName);
799 if (Option != NULL) {
800 Option->BootCurrent = OptionOrder[Index];
801 }
802 }
803
804 FreePool (OptionOrder);
805
806 return EFI_SUCCESS;
807 }
808
809 /**
810 Get boot mode by looking up configuration table and parsing HOB list
811
812 @param BootMode Boot mode from PEI handoff HOB.
813
814 @retval EFI_SUCCESS Successfully get boot mode
815
816 **/
817 EFI_STATUS
818 EFIAPI
819 BdsLibGetBootMode (
820 OUT EFI_BOOT_MODE *BootMode
821 )
822 {
823 *BootMode = GetBootModeHob ();
824
825 return EFI_SUCCESS;
826 }
827
828 /**
829 Read the EFI variable (VendorGuid/Name) and return a dynamically allocated
830 buffer, and the size of the buffer. If failure return NULL.
831
832 @param Name String part of EFI variable name
833 @param VendorGuid GUID part of EFI variable name
834 @param VariableSize Returns the size of the EFI variable that was read
835
836 @return Dynamically allocated memory that contains a copy of the EFI variable
837 Caller is responsible freeing the buffer.
838 @retval NULL Variable was not read
839
840 **/
841 VOID *
842 EFIAPI
843 BdsLibGetVariableAndSize (
844 IN CHAR16 *Name,
845 IN EFI_GUID *VendorGuid,
846 OUT UINTN *VariableSize
847 )
848 {
849 EFI_STATUS Status;
850 UINTN BufferSize;
851 VOID *Buffer;
852
853 Buffer = NULL;
854
855 //
856 // Pass in a zero size buffer to find the required buffer size.
857 //
858 BufferSize = 0;
859 Status = gRT->GetVariable (Name, VendorGuid, NULL, &BufferSize, Buffer);
860 if (Status == EFI_BUFFER_TOO_SMALL) {
861 //
862 // Allocate the buffer to return
863 //
864 Buffer = AllocateZeroPool (BufferSize);
865 if (Buffer == NULL) {
866 return NULL;
867 }
868 //
869 // Read variable into the allocated buffer.
870 //
871 Status = gRT->GetVariable (Name, VendorGuid, NULL, &BufferSize, Buffer);
872 if (EFI_ERROR (Status)) {
873 BufferSize = 0;
874 }
875 }
876
877 *VariableSize = BufferSize;
878 return Buffer;
879 }
880
881 /**
882 Delete the instance in Multi which matches partly with Single instance
883
884 @param Multi A pointer to a multi-instance device path data
885 structure.
886 @param Single A pointer to a single-instance device path data
887 structure.
888
889 @return This function will remove the device path instances in Multi which partly
890 match with the Single, and return the result device path. If there is no
891 remaining device path as a result, this function will return NULL.
892
893 **/
894 EFI_DEVICE_PATH_PROTOCOL *
895 EFIAPI
896 BdsLibDelPartMatchInstance (
897 IN EFI_DEVICE_PATH_PROTOCOL *Multi,
898 IN EFI_DEVICE_PATH_PROTOCOL *Single
899 )
900 {
901 EFI_DEVICE_PATH_PROTOCOL *Instance;
902 EFI_DEVICE_PATH_PROTOCOL *NewDevicePath;
903 EFI_DEVICE_PATH_PROTOCOL *TempNewDevicePath;
904 UINTN InstanceSize;
905 UINTN SingleDpSize;
906 UINTN Size;
907
908 NewDevicePath = NULL;
909 TempNewDevicePath = NULL;
910
911 if (Multi == NULL || Single == NULL) {
912 return Multi;
913 }
914
915 Instance = GetNextDevicePathInstance (&Multi, &InstanceSize);
916 SingleDpSize = GetDevicePathSize (Single) - END_DEVICE_PATH_LENGTH;
917 InstanceSize -= END_DEVICE_PATH_LENGTH;
918
919 while (Instance != NULL) {
920
921 Size = (SingleDpSize < InstanceSize) ? SingleDpSize : InstanceSize;
922
923 if ((CompareMem (Instance, Single, Size) != 0)) {
924 //
925 // Append the device path instance which does not match with Single
926 //
927 TempNewDevicePath = NewDevicePath;
928 NewDevicePath = AppendDevicePathInstance (NewDevicePath, Instance);
929 if (TempNewDevicePath != NULL) {
930 FreePool(TempNewDevicePath);
931 }
932 }
933 FreePool(Instance);
934 Instance = GetNextDevicePathInstance (&Multi, &InstanceSize);
935 InstanceSize -= END_DEVICE_PATH_LENGTH;
936 }
937
938 return NewDevicePath;
939 }
940
941 /**
942 Function compares a device path data structure to that of all the nodes of a
943 second device path instance.
944
945 @param Multi A pointer to a multi-instance device path data
946 structure.
947 @param Single A pointer to a single-instance device path data
948 structure.
949
950 @retval TRUE If the Single device path is contained within Multi device path.
951 @retval FALSE The Single device path is not match within Multi device path.
952
953 **/
954 BOOLEAN
955 EFIAPI
956 BdsLibMatchDevicePaths (
957 IN EFI_DEVICE_PATH_PROTOCOL *Multi,
958 IN EFI_DEVICE_PATH_PROTOCOL *Single
959 )
960 {
961 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
962 EFI_DEVICE_PATH_PROTOCOL *DevicePathInst;
963 UINTN Size;
964
965 if (Multi == NULL || Single == NULL) {
966 return FALSE;
967 }
968
969 DevicePath = Multi;
970 DevicePathInst = GetNextDevicePathInstance (&DevicePath, &Size);
971
972 //
973 // Search for the match of 'Single' in 'Multi'
974 //
975 while (DevicePathInst != NULL) {
976 //
977 // If the single device path is found in multiple device paths,
978 // return success
979 //
980 if (CompareMem (Single, DevicePathInst, Size) == 0) {
981 FreePool (DevicePathInst);
982 return TRUE;
983 }
984
985 FreePool (DevicePathInst);
986 DevicePathInst = GetNextDevicePathInstance (&DevicePath, &Size);
987 }
988
989 return FALSE;
990 }
991
992 /**
993 This function prints a series of strings.
994
995 @param ConOut Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
996 @param ... A variable argument list containing series of
997 strings, the last string must be NULL.
998
999 @retval EFI_SUCCESS Success print out the string using ConOut.
1000 @retval EFI_STATUS Return the status of the ConOut->OutputString ().
1001
1002 **/
1003 EFI_STATUS
1004 EFIAPI
1005 BdsLibOutputStrings (
1006 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *ConOut,
1007 ...
1008 )
1009 {
1010 VA_LIST Args;
1011 EFI_STATUS Status;
1012 CHAR16 *String;
1013
1014 Status = EFI_SUCCESS;
1015 VA_START (Args, ConOut);
1016
1017 while (!EFI_ERROR (Status)) {
1018 //
1019 // If String is NULL, then it's the end of the list
1020 //
1021 String = VA_ARG (Args, CHAR16 *);
1022 if (String == NULL) {
1023 break;
1024 }
1025
1026 Status = ConOut->OutputString (ConOut, String);
1027
1028 if (EFI_ERROR (Status)) {
1029 break;
1030 }
1031 }
1032
1033 VA_END(Args);
1034 return Status;
1035 }
1036
1037 //
1038 // Following are BDS Lib functions which contain all the code about setup browser reset reminder feature.
1039 // Setup Browser reset reminder feature is that an reset reminder will be given before user leaves the setup browser if
1040 // user change any option setting which needs a reset to be effective, and the reset will be applied according to the user selection.
1041 //
1042
1043
1044 /**
1045 Enable the setup browser reset reminder feature.
1046 This routine is used in platform tip. If the platform policy need the feature, use the routine to enable it.
1047
1048 **/
1049 VOID
1050 EFIAPI
1051 EnableResetReminderFeature (
1052 VOID
1053 )
1054 {
1055 mFeaturerSwitch = TRUE;
1056 }
1057
1058
1059 /**
1060 Disable the setup browser reset reminder feature.
1061 This routine is used in platform tip. If the platform policy do not want the feature, use the routine to disable it.
1062
1063 **/
1064 VOID
1065 EFIAPI
1066 DisableResetReminderFeature (
1067 VOID
1068 )
1069 {
1070 mFeaturerSwitch = FALSE;
1071 }
1072
1073
1074 /**
1075 Record the info that a reset is required.
1076 A module boolean variable is used to record whether a reset is required.
1077
1078 **/
1079 VOID
1080 EFIAPI
1081 EnableResetRequired (
1082 VOID
1083 )
1084 {
1085 mResetRequired = TRUE;
1086 }
1087
1088
1089 /**
1090 Record the info that no reset is required.
1091 A module boolean variable is used to record whether a reset is required.
1092
1093 **/
1094 VOID
1095 EFIAPI
1096 DisableResetRequired (
1097 VOID
1098 )
1099 {
1100 mResetRequired = FALSE;
1101 }
1102
1103
1104 /**
1105 Check whether platform policy enable the reset reminder feature. The default is enabled.
1106
1107 **/
1108 BOOLEAN
1109 EFIAPI
1110 IsResetReminderFeatureEnable (
1111 VOID
1112 )
1113 {
1114 return mFeaturerSwitch;
1115 }
1116
1117
1118 /**
1119 Check if user changed any option setting which needs a system reset to be effective.
1120
1121 **/
1122 BOOLEAN
1123 EFIAPI
1124 IsResetRequired (
1125 VOID
1126 )
1127 {
1128 return mResetRequired;
1129 }
1130
1131
1132 /**
1133 Check whether a reset is needed, and finish the reset reminder feature.
1134 If a reset is needed, Popup a menu to notice user, and finish the feature
1135 according to the user selection.
1136
1137 **/
1138 VOID
1139 EFIAPI
1140 SetupResetReminder (
1141 VOID
1142 )
1143 {
1144 EFI_INPUT_KEY Key;
1145 CHAR16 *StringBuffer1;
1146 CHAR16 *StringBuffer2;
1147
1148
1149 //
1150 //check any reset required change is applied? if yes, reset system
1151 //
1152 if (IsResetReminderFeatureEnable ()) {
1153 if (IsResetRequired ()) {
1154
1155 StringBuffer1 = AllocateZeroPool (MAX_STRING_LEN * sizeof (CHAR16));
1156 ASSERT (StringBuffer1 != NULL);
1157 StringBuffer2 = AllocateZeroPool (MAX_STRING_LEN * sizeof (CHAR16));
1158 ASSERT (StringBuffer2 != NULL);
1159 StrCpy (StringBuffer1, L"Configuration changed. Reset to apply it Now ? ");
1160 StrCpy (StringBuffer2, L"Enter (YES) / Esc (NO)");
1161 //
1162 // Popup a menu to notice user
1163 //
1164 do {
1165 CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, StringBuffer1, StringBuffer2, NULL);
1166 } while ((Key.ScanCode != SCAN_ESC) && (Key.UnicodeChar != CHAR_CARRIAGE_RETURN));
1167
1168 FreePool (StringBuffer1);
1169 FreePool (StringBuffer2);
1170 //
1171 // If the user hits the YES Response key, reset
1172 //
1173 if (Key.UnicodeChar == CHAR_CARRIAGE_RETURN) {
1174 gRT->ResetSystem (EfiResetCold, EFI_SUCCESS, 0, NULL);
1175 }
1176 gST->ConOut->ClearScreen (gST->ConOut);
1177 }
1178 }
1179 }
1180
1181 /**
1182 Get the headers (dos, image, optional header) from an image
1183
1184 @param Device SimpleFileSystem device handle
1185 @param FileName File name for the image
1186 @param DosHeader Pointer to dos header
1187 @param Hdr The buffer in which to return the PE32, PE32+, or TE header.
1188
1189 @retval EFI_SUCCESS Successfully get the machine type.
1190 @retval EFI_NOT_FOUND The file is not found.
1191 @retval EFI_LOAD_ERROR File is not a valid image file.
1192
1193 **/
1194 EFI_STATUS
1195 EFIAPI
1196 BdsLibGetImageHeader (
1197 IN EFI_HANDLE Device,
1198 IN CHAR16 *FileName,
1199 OUT EFI_IMAGE_DOS_HEADER *DosHeader,
1200 OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
1201 )
1202 {
1203 EFI_STATUS Status;
1204 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *Volume;
1205 EFI_FILE_HANDLE Root;
1206 EFI_FILE_HANDLE ThisFile;
1207 UINTN BufferSize;
1208 UINT64 FileSize;
1209 EFI_FILE_INFO *Info;
1210
1211 Root = NULL;
1212 ThisFile = NULL;
1213 //
1214 // Handle the file system interface to the device
1215 //
1216 Status = gBS->HandleProtocol (
1217 Device,
1218 &gEfiSimpleFileSystemProtocolGuid,
1219 (VOID *) &Volume
1220 );
1221 if (EFI_ERROR (Status)) {
1222 goto Done;
1223 }
1224
1225 Status = Volume->OpenVolume (
1226 Volume,
1227 &Root
1228 );
1229 if (EFI_ERROR (Status)) {
1230 Root = NULL;
1231 goto Done;
1232 }
1233 ASSERT (Root != NULL);
1234 Status = Root->Open (Root, &ThisFile, FileName, EFI_FILE_MODE_READ, 0);
1235 if (EFI_ERROR (Status)) {
1236 goto Done;
1237 }
1238 ASSERT (ThisFile != NULL);
1239
1240 //
1241 // Get file size
1242 //
1243 BufferSize = SIZE_OF_EFI_FILE_INFO + 200;
1244 do {
1245 Info = NULL;
1246 Status = gBS->AllocatePool (EfiBootServicesData, BufferSize, (VOID **) &Info);
1247 if (EFI_ERROR (Status)) {
1248 goto Done;
1249 }
1250 Status = ThisFile->GetInfo (
1251 ThisFile,
1252 &gEfiFileInfoGuid,
1253 &BufferSize,
1254 Info
1255 );
1256 if (!EFI_ERROR (Status)) {
1257 break;
1258 }
1259 if (Status != EFI_BUFFER_TOO_SMALL) {
1260 FreePool (Info);
1261 goto Done;
1262 }
1263 FreePool (Info);
1264 } while (TRUE);
1265
1266 FileSize = Info->FileSize;
1267 FreePool (Info);
1268
1269 //
1270 // Read dos header
1271 //
1272 BufferSize = sizeof (EFI_IMAGE_DOS_HEADER);
1273 Status = ThisFile->Read (ThisFile, &BufferSize, DosHeader);
1274 if (EFI_ERROR (Status) ||
1275 BufferSize < sizeof (EFI_IMAGE_DOS_HEADER) ||
1276 FileSize <= DosHeader->e_lfanew ||
1277 DosHeader->e_magic != EFI_IMAGE_DOS_SIGNATURE) {
1278 Status = EFI_LOAD_ERROR;
1279 goto Done;
1280 }
1281
1282 //
1283 // Move to PE signature
1284 //
1285 Status = ThisFile->SetPosition (ThisFile, DosHeader->e_lfanew);
1286 if (EFI_ERROR (Status)) {
1287 Status = EFI_LOAD_ERROR;
1288 goto Done;
1289 }
1290
1291 //
1292 // Read and check PE signature
1293 //
1294 BufferSize = sizeof (EFI_IMAGE_OPTIONAL_HEADER_UNION);
1295 Status = ThisFile->Read (ThisFile, &BufferSize, Hdr.Pe32);
1296 if (EFI_ERROR (Status) ||
1297 BufferSize < sizeof (EFI_IMAGE_OPTIONAL_HEADER_UNION) ||
1298 Hdr.Pe32->Signature != EFI_IMAGE_NT_SIGNATURE) {
1299 Status = EFI_LOAD_ERROR;
1300 goto Done;
1301 }
1302
1303 //
1304 // Check PE32 or PE32+ magic
1305 //
1306 if (Hdr.Pe32->OptionalHeader.Magic != EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC &&
1307 Hdr.Pe32->OptionalHeader.Magic != EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC) {
1308 Status = EFI_LOAD_ERROR;
1309 goto Done;
1310 }
1311
1312 Done:
1313 if (ThisFile != NULL) {
1314 ThisFile->Close (ThisFile);
1315 }
1316 if (Root != NULL) {
1317 Root->Close (Root);
1318 }
1319 return Status;
1320 }
1321
1322 /**
1323 This routine adjusts the memory information for different memory type and
1324 saves them into the variables for next boot. It conditionally resets the
1325 system when the memory information changes. Platform can reserve memory
1326 large enough (125% of actual requirement) to avoid the reset in the first boot.
1327 **/
1328 VOID
1329 BdsSetMemoryTypeInformationVariable (
1330 VOID
1331 )
1332 {
1333 EFI_STATUS Status;
1334 EFI_MEMORY_TYPE_INFORMATION *PreviousMemoryTypeInformation;
1335 EFI_MEMORY_TYPE_INFORMATION *CurrentMemoryTypeInformation;
1336 UINTN VariableSize;
1337 UINTN Index;
1338 UINTN Index1;
1339 UINT32 Previous;
1340 UINT32 Current;
1341 UINT32 Next;
1342 EFI_HOB_GUID_TYPE *GuidHob;
1343 BOOLEAN MemoryTypeInformationModified;
1344 BOOLEAN MemoryTypeInformationVariableExists;
1345 EFI_BOOT_MODE BootMode;
1346
1347 MemoryTypeInformationModified = FALSE;
1348 MemoryTypeInformationVariableExists = FALSE;
1349
1350
1351 BootMode = GetBootModeHob ();
1352 //
1353 // In BOOT_IN_RECOVERY_MODE, Variable region is not reliable.
1354 //
1355 if (BootMode == BOOT_IN_RECOVERY_MODE) {
1356 return;
1357 }
1358
1359 //
1360 // Only check the the Memory Type Information variable in the boot mode
1361 // other than BOOT_WITH_DEFAULT_SETTINGS because the Memory Type
1362 // Information is not valid in this boot mode.
1363 //
1364 if (BootMode != BOOT_WITH_DEFAULT_SETTINGS) {
1365 VariableSize = 0;
1366 Status = gRT->GetVariable (
1367 EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME,
1368 &gEfiMemoryTypeInformationGuid,
1369 NULL,
1370 &VariableSize,
1371 NULL
1372 );
1373 if (Status == EFI_BUFFER_TOO_SMALL) {
1374 MemoryTypeInformationVariableExists = TRUE;
1375 }
1376 }
1377
1378 //
1379 // Retrieve the current memory usage statistics. If they are not found, then
1380 // no adjustments can be made to the Memory Type Information variable.
1381 //
1382 Status = EfiGetSystemConfigurationTable (
1383 &gEfiMemoryTypeInformationGuid,
1384 (VOID **) &CurrentMemoryTypeInformation
1385 );
1386 if (EFI_ERROR (Status) || CurrentMemoryTypeInformation == NULL) {
1387 return;
1388 }
1389
1390 //
1391 // Get the Memory Type Information settings from Hob if they exist,
1392 // PEI is responsible for getting them from variable and build a Hob to save them.
1393 // If the previous Memory Type Information is not available, then set defaults
1394 //
1395 GuidHob = GetFirstGuidHob (&gEfiMemoryTypeInformationGuid);
1396 if (GuidHob == NULL) {
1397 //
1398 // If Platform has not built Memory Type Info into the Hob, just return.
1399 //
1400 return;
1401 }
1402 PreviousMemoryTypeInformation = GET_GUID_HOB_DATA (GuidHob);
1403 VariableSize = GET_GUID_HOB_DATA_SIZE (GuidHob);
1404
1405 //
1406 // Use a heuristic to adjust the Memory Type Information for the next boot
1407 //
1408 DEBUG ((EFI_D_INFO, "Memory Previous Current Next \n"));
1409 DEBUG ((EFI_D_INFO, " Type Pages Pages Pages \n"));
1410 DEBUG ((EFI_D_INFO, "====== ======== ======== ========\n"));
1411
1412 for (Index = 0; PreviousMemoryTypeInformation[Index].Type != EfiMaxMemoryType; Index++) {
1413
1414 for (Index1 = 0; CurrentMemoryTypeInformation[Index1].Type != EfiMaxMemoryType; Index1++) {
1415 if (PreviousMemoryTypeInformation[Index].Type == CurrentMemoryTypeInformation[Index1].Type) {
1416 break;
1417 }
1418 }
1419 if (CurrentMemoryTypeInformation[Index1].Type == EfiMaxMemoryType) {
1420 continue;
1421 }
1422
1423 //
1424 // Previous is the number of pages pre-allocated
1425 // Current is the number of pages actually needed
1426 //
1427 Previous = PreviousMemoryTypeInformation[Index].NumberOfPages;
1428 Current = CurrentMemoryTypeInformation[Index1].NumberOfPages;
1429 Next = Previous;
1430
1431 //
1432 // Write next varible to 125% * current and Inconsistent Memory Reserved across bootings may lead to S4 fail
1433 //
1434 if (Current < Previous) {
1435 if (BootMode == BOOT_WITH_DEFAULT_SETTINGS) {
1436 Next = Current + (Current >> 2);
1437 } else if (!MemoryTypeInformationVariableExists) {
1438 Next = MAX (Current + (Current >> 2), Previous);
1439 }
1440 } else if (Current > Previous) {
1441 Next = Current + (Current >> 2);
1442 }
1443 if (Next > 0 && Next < 4) {
1444 Next = 4;
1445 }
1446
1447 if (Next != Previous) {
1448 PreviousMemoryTypeInformation[Index].NumberOfPages = Next;
1449 MemoryTypeInformationModified = TRUE;
1450 }
1451
1452 DEBUG ((EFI_D_INFO, " %02x %08x %08x %08x\n", PreviousMemoryTypeInformation[Index].Type, Previous, Current, Next));
1453 }
1454
1455 //
1456 // If any changes were made to the Memory Type Information settings, then set the new variable value;
1457 // Or create the variable in first boot.
1458 //
1459 if (MemoryTypeInformationModified || !MemoryTypeInformationVariableExists) {
1460 Status = gRT->SetVariable (
1461 EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME,
1462 &gEfiMemoryTypeInformationGuid,
1463 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,
1464 VariableSize,
1465 PreviousMemoryTypeInformation
1466 );
1467
1468 //
1469 // If the Memory Type Information settings have been modified, then reset the platform
1470 // so the new Memory Type Information setting will be used to guarantee that an S4
1471 // entry/resume cycle will not fail.
1472 //
1473 if (MemoryTypeInformationModified && PcdGetBool (PcdResetOnMemoryTypeInformationChange)) {
1474 DEBUG ((EFI_D_INFO, "Memory Type Information settings change. Warm Reset!!!\n"));
1475 gRT->ResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);
1476 }
1477 }
1478 }
1479
1480 /**
1481 This routine is kept for backward compatibility.
1482 **/
1483 VOID
1484 EFIAPI
1485 BdsLibSaveMemoryTypeInformation (
1486 VOID
1487 )
1488 {
1489 }
1490
1491
1492 /**
1493 Identify a user and, if authenticated, returns the current user profile handle.
1494
1495 @param[out] User Point to user profile handle.
1496
1497 @retval EFI_SUCCESS User is successfully identified, or user identification
1498 is not supported.
1499 @retval EFI_ACCESS_DENIED User is not successfully identified
1500
1501 **/
1502 EFI_STATUS
1503 EFIAPI
1504 BdsLibUserIdentify (
1505 OUT EFI_USER_PROFILE_HANDLE *User
1506 )
1507 {
1508 EFI_STATUS Status;
1509 EFI_USER_MANAGER_PROTOCOL *Manager;
1510
1511 Status = gBS->LocateProtocol (
1512 &gEfiUserManagerProtocolGuid,
1513 NULL,
1514 (VOID **) &Manager
1515 );
1516 if (EFI_ERROR (Status)) {
1517 return EFI_SUCCESS;
1518 }
1519
1520 return Manager->Identify (Manager, User);
1521 }
1522