]> git.proxmox.com Git - mirror_edk2.git/blob - IntelFrameworkModulePkg/Library/GenericBdsLib/BdsMisc.c
Refine logic about validate boot option.
[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 byte length 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+=2);
483
484 if (*String != L'\0' && MaxStringLen == Length) {
485 return 0;
486 }
487
488 return Length + 2;
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 UINTN TempSize;
511
512 if (VariableSize <= sizeof (UINT16) + sizeof (UINT32)) {
513 return FALSE;
514 }
515
516 //
517 // Skip the option attribute
518 //
519 TempPtr = Variable;
520 TempPtr += sizeof (UINT32);
521
522 //
523 // Get the option's device path size
524 //
525 FilePathSize = *(UINT16 *) TempPtr;
526 TempPtr += sizeof (UINT16);
527
528 //
529 // Get the option's description string size
530 //
531 TempSize = StrSizeEx ((CHAR16 *) TempPtr, VariableSize - sizeof (UINT16) - sizeof (UINT32));
532 TempPtr += TempSize;
533
534 //
535 // Get the option's device path
536 //
537 DevicePath = (EFI_DEVICE_PATH_PROTOCOL *) TempPtr;
538 TempPtr += FilePathSize;
539
540 //
541 // Validation boot option variable.
542 //
543 if ((FilePathSize == 0) || (TempSize == 0)) {
544 return FALSE;
545 }
546
547 if (TempSize + FilePathSize + sizeof (UINT16) + sizeof (UINT32) > VariableSize) {
548 return FALSE;
549 }
550
551 return GetDevicePathSizeEx (DevicePath, FilePathSize) != 0;
552 }
553
554 /**
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'
557
558 @param Char The input char which need to change to a hex number.
559
560 **/
561 UINTN
562 CharToUint (
563 IN CHAR16 Char
564 )
565 {
566 if ((Char >= L'0') && (Char <= L'9')) {
567 return (UINTN) (Char - L'0');
568 }
569
570 if ((Char >= L'A') && (Char <= L'F')) {
571 return (UINTN) (Char - L'A' + 0xA);
572 }
573
574 ASSERT (FALSE);
575 return 0;
576 }
577
578 /**
579 Build the boot#### or driver#### option from the VariableName, the
580 build boot#### or driver#### will also be linked to BdsCommonOptionList.
581
582 @param BdsCommonOptionList The header of the boot#### or driver#### option
583 link list
584 @param VariableName EFI Variable name indicate if it is boot#### or
585 driver####
586
587 @retval BDS_COMMON_OPTION Get the option just been created
588 @retval NULL Failed to get the new option
589
590 **/
591 BDS_COMMON_OPTION *
592 EFIAPI
593 BdsLibVariableToOption (
594 IN OUT LIST_ENTRY *BdsCommonOptionList,
595 IN CHAR16 *VariableName
596 )
597 {
598 UINT32 Attribute;
599 UINT16 FilePathSize;
600 UINT8 *Variable;
601 UINT8 *TempPtr;
602 UINTN VariableSize;
603 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
604 BDS_COMMON_OPTION *Option;
605 VOID *LoadOptions;
606 UINT32 LoadOptionsSize;
607 CHAR16 *Description;
608 UINT8 NumOff;
609
610 //
611 // Read the variable. We will never free this data.
612 //
613 Variable = BdsLibGetVariableAndSize (
614 VariableName,
615 &gEfiGlobalVariableGuid,
616 &VariableSize
617 );
618 if (Variable == NULL) {
619 return NULL;
620 }
621
622 //
623 // Validate Boot#### variable data.
624 //
625 if (!ValidateOption(Variable, VariableSize)) {
626 return NULL;
627 }
628
629 //
630 // Notes: careful defined the variable of Boot#### or
631 // Driver####, consider use some macro to abstract the code
632 //
633 //
634 // Get the option attribute
635 //
636 TempPtr = Variable;
637 Attribute = *(UINT32 *) Variable;
638 TempPtr += sizeof (UINT32);
639
640 //
641 // Get the option's device path size
642 //
643 FilePathSize = *(UINT16 *) TempPtr;
644 TempPtr += sizeof (UINT16);
645
646 //
647 // Get the option's description string
648 //
649 Description = (CHAR16 *) TempPtr;
650
651 //
652 // Get the option's description string size
653 //
654 TempPtr += StrSize((CHAR16 *) TempPtr);
655
656 //
657 // Get the option's device path
658 //
659 DevicePath = (EFI_DEVICE_PATH_PROTOCOL *) TempPtr;
660 TempPtr += FilePathSize;
661
662 //
663 // Get load opion data.
664 //
665 LoadOptions = TempPtr;
666 LoadOptionsSize = (UINT32) (VariableSize - (UINTN) (TempPtr - Variable));
667
668 //
669 // The Console variables may have multiple device paths, so make
670 // an Entry for each one.
671 //
672 Option = AllocateZeroPool (sizeof (BDS_COMMON_OPTION));
673 if (Option == NULL) {
674 return NULL;
675 }
676
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));
681
682 Option->Attribute = Attribute;
683 Option->Description = AllocateZeroPool (StrSize (Description));
684 ASSERT(Option->Description != NULL);
685 CopyMem (Option->Description, Description, StrSize (Description));
686
687 Option->LoadOptions = AllocateZeroPool (LoadOptionsSize);
688 ASSERT(Option->LoadOptions != NULL);
689 CopyMem (Option->LoadOptions, LoadOptions, LoadOptionsSize);
690 Option->LoadOptionsSize = LoadOptionsSize;
691
692 //
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.
696 //
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);
703 }
704 //
705 // Insert active entry to BdsDeviceList
706 //
707 if ((Option->Attribute & LOAD_OPTION_ACTIVE) == LOAD_OPTION_ACTIVE) {
708 InsertTailList (BdsCommonOptionList, &Option->Link);
709 FreePool (Variable);
710 return Option;
711 }
712
713 FreePool (Variable);
714 FreePool (Option->Description);
715 FreePool (Option->DevicePath);
716 FreePool (Option->LoadOptions);
717 FreePool (Option);
718 return NULL;
719 }
720
721 /**
722 Process BootOrder, or DriverOrder variables, by calling
723 BdsLibVariableToOption () for each UINT16 in the variables.
724
725 @param BdsCommonOptionList The header of the option list base on variable
726 VariableName
727 @param VariableName EFI Variable name indicate the BootOrder or
728 DriverOrder
729
730 @retval EFI_SUCCESS Success create the boot option or driver option
731 list
732 @retval EFI_OUT_OF_RESOURCES Failed to get the boot option or driver option list
733
734 **/
735 EFI_STATUS
736 EFIAPI
737 BdsLibBuildOptionFromVar (
738 IN LIST_ENTRY *BdsCommonOptionList,
739 IN CHAR16 *VariableName
740 )
741 {
742 UINT16 *OptionOrder;
743 UINTN OptionOrderSize;
744 UINTN Index;
745 BDS_COMMON_OPTION *Option;
746 CHAR16 OptionName[20];
747
748 //
749 // Zero Buffer in order to get all BOOT#### variables
750 //
751 ZeroMem (OptionName, sizeof (OptionName));
752
753 //
754 // Read the BootOrder, or DriverOrder variable.
755 //
756 OptionOrder = BdsLibGetVariableAndSize (
757 VariableName,
758 &gEfiGlobalVariableGuid,
759 &OptionOrderSize
760 );
761 if (OptionOrder == NULL) {
762 return EFI_OUT_OF_RESOURCES;
763 }
764
765 for (Index = 0; Index < OptionOrderSize / sizeof (UINT16); Index++) {
766 if (*VariableName == 'B') {
767 UnicodeSPrint (OptionName, sizeof (OptionName), L"Boot%04x", OptionOrder[Index]);
768 } else {
769 UnicodeSPrint (OptionName, sizeof (OptionName), L"Driver%04x", OptionOrder[Index]);
770 }
771
772 Option = BdsLibVariableToOption (BdsCommonOptionList, OptionName);
773 if (Option != NULL) {
774 Option->BootCurrent = OptionOrder[Index];
775 }
776 }
777
778 FreePool (OptionOrder);
779
780 return EFI_SUCCESS;
781 }
782
783 /**
784 Get boot mode by looking up configuration table and parsing HOB list
785
786 @param BootMode Boot mode from PEI handoff HOB.
787
788 @retval EFI_SUCCESS Successfully get boot mode
789
790 **/
791 EFI_STATUS
792 EFIAPI
793 BdsLibGetBootMode (
794 OUT EFI_BOOT_MODE *BootMode
795 )
796 {
797 *BootMode = GetBootModeHob ();
798
799 return EFI_SUCCESS;
800 }
801
802 /**
803 Read the EFI variable (VendorGuid/Name) and return a dynamically allocated
804 buffer, and the size of the buffer. If failure return NULL.
805
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
809
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
813
814 **/
815 VOID *
816 EFIAPI
817 BdsLibGetVariableAndSize (
818 IN CHAR16 *Name,
819 IN EFI_GUID *VendorGuid,
820 OUT UINTN *VariableSize
821 )
822 {
823 EFI_STATUS Status;
824 UINTN BufferSize;
825 VOID *Buffer;
826
827 Buffer = NULL;
828
829 //
830 // Pass in a zero size buffer to find the required buffer size.
831 //
832 BufferSize = 0;
833 Status = gRT->GetVariable (Name, VendorGuid, NULL, &BufferSize, Buffer);
834 if (Status == EFI_BUFFER_TOO_SMALL) {
835 //
836 // Allocate the buffer to return
837 //
838 Buffer = AllocateZeroPool (BufferSize);
839 if (Buffer == NULL) {
840 return NULL;
841 }
842 //
843 // Read variable into the allocated buffer.
844 //
845 Status = gRT->GetVariable (Name, VendorGuid, NULL, &BufferSize, Buffer);
846 if (EFI_ERROR (Status)) {
847 BufferSize = 0;
848 }
849 }
850
851 *VariableSize = BufferSize;
852 return Buffer;
853 }
854
855 /**
856 Delete the instance in Multi which matches partly with Single instance
857
858 @param Multi A pointer to a multi-instance device path data
859 structure.
860 @param Single A pointer to a single-instance device path data
861 structure.
862
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.
866
867 **/
868 EFI_DEVICE_PATH_PROTOCOL *
869 EFIAPI
870 BdsLibDelPartMatchInstance (
871 IN EFI_DEVICE_PATH_PROTOCOL *Multi,
872 IN EFI_DEVICE_PATH_PROTOCOL *Single
873 )
874 {
875 EFI_DEVICE_PATH_PROTOCOL *Instance;
876 EFI_DEVICE_PATH_PROTOCOL *NewDevicePath;
877 EFI_DEVICE_PATH_PROTOCOL *TempNewDevicePath;
878 UINTN InstanceSize;
879 UINTN SingleDpSize;
880 UINTN Size;
881
882 NewDevicePath = NULL;
883 TempNewDevicePath = NULL;
884
885 if (Multi == NULL || Single == NULL) {
886 return Multi;
887 }
888
889 Instance = GetNextDevicePathInstance (&Multi, &InstanceSize);
890 SingleDpSize = GetDevicePathSize (Single) - END_DEVICE_PATH_LENGTH;
891 InstanceSize -= END_DEVICE_PATH_LENGTH;
892
893 while (Instance != NULL) {
894
895 Size = (SingleDpSize < InstanceSize) ? SingleDpSize : InstanceSize;
896
897 if ((CompareMem (Instance, Single, Size) != 0)) {
898 //
899 // Append the device path instance which does not match with Single
900 //
901 TempNewDevicePath = NewDevicePath;
902 NewDevicePath = AppendDevicePathInstance (NewDevicePath, Instance);
903 if (TempNewDevicePath != NULL) {
904 FreePool(TempNewDevicePath);
905 }
906 }
907 FreePool(Instance);
908 Instance = GetNextDevicePathInstance (&Multi, &InstanceSize);
909 InstanceSize -= END_DEVICE_PATH_LENGTH;
910 }
911
912 return NewDevicePath;
913 }
914
915 /**
916 Function compares a device path data structure to that of all the nodes of a
917 second device path instance.
918
919 @param Multi A pointer to a multi-instance device path data
920 structure.
921 @param Single A pointer to a single-instance device path data
922 structure.
923
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.
926
927 **/
928 BOOLEAN
929 EFIAPI
930 BdsLibMatchDevicePaths (
931 IN EFI_DEVICE_PATH_PROTOCOL *Multi,
932 IN EFI_DEVICE_PATH_PROTOCOL *Single
933 )
934 {
935 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
936 EFI_DEVICE_PATH_PROTOCOL *DevicePathInst;
937 UINTN Size;
938
939 if (Multi == NULL || Single == NULL) {
940 return FALSE;
941 }
942
943 DevicePath = Multi;
944 DevicePathInst = GetNextDevicePathInstance (&DevicePath, &Size);
945
946 //
947 // Search for the match of 'Single' in 'Multi'
948 //
949 while (DevicePathInst != NULL) {
950 //
951 // If the single device path is found in multiple device paths,
952 // return success
953 //
954 if (CompareMem (Single, DevicePathInst, Size) == 0) {
955 FreePool (DevicePathInst);
956 return TRUE;
957 }
958
959 FreePool (DevicePathInst);
960 DevicePathInst = GetNextDevicePathInstance (&DevicePath, &Size);
961 }
962
963 return FALSE;
964 }
965
966 /**
967 This function prints a series of strings.
968
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.
972
973 @retval EFI_SUCCESS Success print out the string using ConOut.
974 @retval EFI_STATUS Return the status of the ConOut->OutputString ().
975
976 **/
977 EFI_STATUS
978 EFIAPI
979 BdsLibOutputStrings (
980 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *ConOut,
981 ...
982 )
983 {
984 VA_LIST Args;
985 EFI_STATUS Status;
986 CHAR16 *String;
987
988 Status = EFI_SUCCESS;
989 VA_START (Args, ConOut);
990
991 while (!EFI_ERROR (Status)) {
992 //
993 // If String is NULL, then it's the end of the list
994 //
995 String = VA_ARG (Args, CHAR16 *);
996 if (String == NULL) {
997 break;
998 }
999
1000 Status = ConOut->OutputString (ConOut, String);
1001
1002 if (EFI_ERROR (Status)) {
1003 break;
1004 }
1005 }
1006
1007 VA_END(Args);
1008 return Status;
1009 }
1010
1011 //
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.
1015 //
1016
1017
1018 /**
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.
1021
1022 **/
1023 VOID
1024 EFIAPI
1025 EnableResetReminderFeature (
1026 VOID
1027 )
1028 {
1029 mFeaturerSwitch = TRUE;
1030 }
1031
1032
1033 /**
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.
1036
1037 **/
1038 VOID
1039 EFIAPI
1040 DisableResetReminderFeature (
1041 VOID
1042 )
1043 {
1044 mFeaturerSwitch = FALSE;
1045 }
1046
1047
1048 /**
1049 Record the info that a reset is required.
1050 A module boolean variable is used to record whether a reset is required.
1051
1052 **/
1053 VOID
1054 EFIAPI
1055 EnableResetRequired (
1056 VOID
1057 )
1058 {
1059 mResetRequired = TRUE;
1060 }
1061
1062
1063 /**
1064 Record the info that no reset is required.
1065 A module boolean variable is used to record whether a reset is required.
1066
1067 **/
1068 VOID
1069 EFIAPI
1070 DisableResetRequired (
1071 VOID
1072 )
1073 {
1074 mResetRequired = FALSE;
1075 }
1076
1077
1078 /**
1079 Check whether platform policy enable the reset reminder feature. The default is enabled.
1080
1081 **/
1082 BOOLEAN
1083 EFIAPI
1084 IsResetReminderFeatureEnable (
1085 VOID
1086 )
1087 {
1088 return mFeaturerSwitch;
1089 }
1090
1091
1092 /**
1093 Check if user changed any option setting which needs a system reset to be effective.
1094
1095 **/
1096 BOOLEAN
1097 EFIAPI
1098 IsResetRequired (
1099 VOID
1100 )
1101 {
1102 return mResetRequired;
1103 }
1104
1105
1106 /**
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.
1110
1111 **/
1112 VOID
1113 EFIAPI
1114 SetupResetReminder (
1115 VOID
1116 )
1117 {
1118 EFI_INPUT_KEY Key;
1119 CHAR16 *StringBuffer1;
1120 CHAR16 *StringBuffer2;
1121
1122
1123 //
1124 //check any reset required change is applied? if yes, reset system
1125 //
1126 if (IsResetReminderFeatureEnable ()) {
1127 if (IsResetRequired ()) {
1128
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)");
1135 //
1136 // Popup a menu to notice user
1137 //
1138 do {
1139 CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, StringBuffer1, StringBuffer2, NULL);
1140 } while ((Key.ScanCode != SCAN_ESC) && (Key.UnicodeChar != CHAR_CARRIAGE_RETURN));
1141
1142 FreePool (StringBuffer1);
1143 FreePool (StringBuffer2);
1144 //
1145 // If the user hits the YES Response key, reset
1146 //
1147 if (Key.UnicodeChar == CHAR_CARRIAGE_RETURN) {
1148 gRT->ResetSystem (EfiResetCold, EFI_SUCCESS, 0, NULL);
1149 }
1150 gST->ConOut->ClearScreen (gST->ConOut);
1151 }
1152 }
1153 }
1154
1155 /**
1156 Get the headers (dos, image, optional header) from an image
1157
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.
1162
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.
1166
1167 **/
1168 EFI_STATUS
1169 EFIAPI
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
1175 )
1176 {
1177 EFI_STATUS Status;
1178 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *Volume;
1179 EFI_FILE_HANDLE Root;
1180 EFI_FILE_HANDLE ThisFile;
1181 UINTN BufferSize;
1182 UINT64 FileSize;
1183 EFI_FILE_INFO *Info;
1184
1185 Root = NULL;
1186 ThisFile = NULL;
1187 //
1188 // Handle the file system interface to the device
1189 //
1190 Status = gBS->HandleProtocol (
1191 Device,
1192 &gEfiSimpleFileSystemProtocolGuid,
1193 (VOID *) &Volume
1194 );
1195 if (EFI_ERROR (Status)) {
1196 goto Done;
1197 }
1198
1199 Status = Volume->OpenVolume (
1200 Volume,
1201 &Root
1202 );
1203 if (EFI_ERROR (Status)) {
1204 Root = NULL;
1205 goto Done;
1206 }
1207 ASSERT (Root != NULL);
1208 Status = Root->Open (Root, &ThisFile, FileName, EFI_FILE_MODE_READ, 0);
1209 if (EFI_ERROR (Status)) {
1210 goto Done;
1211 }
1212 ASSERT (ThisFile != NULL);
1213
1214 //
1215 // Get file size
1216 //
1217 BufferSize = SIZE_OF_EFI_FILE_INFO + 200;
1218 do {
1219 Info = NULL;
1220 Status = gBS->AllocatePool (EfiBootServicesData, BufferSize, (VOID **) &Info);
1221 if (EFI_ERROR (Status)) {
1222 goto Done;
1223 }
1224 Status = ThisFile->GetInfo (
1225 ThisFile,
1226 &gEfiFileInfoGuid,
1227 &BufferSize,
1228 Info
1229 );
1230 if (!EFI_ERROR (Status)) {
1231 break;
1232 }
1233 if (Status != EFI_BUFFER_TOO_SMALL) {
1234 FreePool (Info);
1235 goto Done;
1236 }
1237 FreePool (Info);
1238 } while (TRUE);
1239
1240 FileSize = Info->FileSize;
1241 FreePool (Info);
1242
1243 //
1244 // Read dos header
1245 //
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;
1253 goto Done;
1254 }
1255
1256 //
1257 // Move to PE signature
1258 //
1259 Status = ThisFile->SetPosition (ThisFile, DosHeader->e_lfanew);
1260 if (EFI_ERROR (Status)) {
1261 Status = EFI_LOAD_ERROR;
1262 goto Done;
1263 }
1264
1265 //
1266 // Read and check PE signature
1267 //
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;
1274 goto Done;
1275 }
1276
1277 //
1278 // Check PE32 or PE32+ magic
1279 //
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;
1283 goto Done;
1284 }
1285
1286 Done:
1287 if (ThisFile != NULL) {
1288 ThisFile->Close (ThisFile);
1289 }
1290 if (Root != NULL) {
1291 Root->Close (Root);
1292 }
1293 return Status;
1294 }
1295
1296 /**
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.
1301 **/
1302 VOID
1303 BdsSetMemoryTypeInformationVariable (
1304 VOID
1305 )
1306 {
1307 EFI_STATUS Status;
1308 EFI_MEMORY_TYPE_INFORMATION *PreviousMemoryTypeInformation;
1309 EFI_MEMORY_TYPE_INFORMATION *CurrentMemoryTypeInformation;
1310 UINTN VariableSize;
1311 UINTN Index;
1312 UINTN Index1;
1313 UINT32 Previous;
1314 UINT32 Current;
1315 UINT32 Next;
1316 EFI_HOB_GUID_TYPE *GuidHob;
1317 BOOLEAN MemoryTypeInformationModified;
1318 BOOLEAN MemoryTypeInformationVariableExists;
1319 EFI_BOOT_MODE BootMode;
1320
1321 MemoryTypeInformationModified = FALSE;
1322 MemoryTypeInformationVariableExists = FALSE;
1323
1324
1325 BootMode = GetBootModeHob ();
1326 //
1327 // In BOOT_IN_RECOVERY_MODE, Variable region is not reliable.
1328 //
1329 if (BootMode == BOOT_IN_RECOVERY_MODE) {
1330 return;
1331 }
1332
1333 //
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.
1337 //
1338 if (BootMode != BOOT_WITH_DEFAULT_SETTINGS) {
1339 VariableSize = 0;
1340 Status = gRT->GetVariable (
1341 EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME,
1342 &gEfiMemoryTypeInformationGuid,
1343 NULL,
1344 &VariableSize,
1345 NULL
1346 );
1347 if (Status == EFI_BUFFER_TOO_SMALL) {
1348 MemoryTypeInformationVariableExists = TRUE;
1349 }
1350 }
1351
1352 //
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.
1355 //
1356 Status = EfiGetSystemConfigurationTable (
1357 &gEfiMemoryTypeInformationGuid,
1358 (VOID **) &CurrentMemoryTypeInformation
1359 );
1360 if (EFI_ERROR (Status) || CurrentMemoryTypeInformation == NULL) {
1361 return;
1362 }
1363
1364 //
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
1368 //
1369 GuidHob = GetFirstGuidHob (&gEfiMemoryTypeInformationGuid);
1370 if (GuidHob == NULL) {
1371 //
1372 // If Platform has not built Memory Type Info into the Hob, just return.
1373 //
1374 return;
1375 }
1376 PreviousMemoryTypeInformation = GET_GUID_HOB_DATA (GuidHob);
1377 VariableSize = GET_GUID_HOB_DATA_SIZE (GuidHob);
1378
1379 //
1380 // Use a heuristic to adjust the Memory Type Information for the next boot
1381 //
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"));
1385
1386 for (Index = 0; PreviousMemoryTypeInformation[Index].Type != EfiMaxMemoryType; Index++) {
1387
1388 for (Index1 = 0; CurrentMemoryTypeInformation[Index1].Type != EfiMaxMemoryType; Index1++) {
1389 if (PreviousMemoryTypeInformation[Index].Type == CurrentMemoryTypeInformation[Index1].Type) {
1390 break;
1391 }
1392 }
1393 if (CurrentMemoryTypeInformation[Index1].Type == EfiMaxMemoryType) {
1394 continue;
1395 }
1396
1397 //
1398 // Previous is the number of pages pre-allocated
1399 // Current is the number of pages actually needed
1400 //
1401 Previous = PreviousMemoryTypeInformation[Index].NumberOfPages;
1402 Current = CurrentMemoryTypeInformation[Index1].NumberOfPages;
1403 Next = Previous;
1404
1405 //
1406 // Write next varible to 125% * current and Inconsistent Memory Reserved across bootings may lead to S4 fail
1407 //
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);
1413 }
1414 } else if (Current > Previous) {
1415 Next = Current + (Current >> 2);
1416 }
1417 if (Next > 0 && Next < 4) {
1418 Next = 4;
1419 }
1420
1421 if (Next != Previous) {
1422 PreviousMemoryTypeInformation[Index].NumberOfPages = Next;
1423 MemoryTypeInformationModified = TRUE;
1424 }
1425
1426 DEBUG ((EFI_D_INFO, " %02x %08x %08x %08x\n", PreviousMemoryTypeInformation[Index].Type, Previous, Current, Next));
1427 }
1428
1429 //
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.
1432 //
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,
1438 VariableSize,
1439 PreviousMemoryTypeInformation
1440 );
1441
1442 //
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.
1446 //
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);
1450 }
1451 }
1452 }
1453
1454 /**
1455 This routine is kept for backward compatibility.
1456 **/
1457 VOID
1458 EFIAPI
1459 BdsLibSaveMemoryTypeInformation (
1460 VOID
1461 )
1462 {
1463 }
1464
1465
1466 /**
1467 Identify a user and, if authenticated, returns the current user profile handle.
1468
1469 @param[out] User Point to user profile handle.
1470
1471 @retval EFI_SUCCESS User is successfully identified, or user identification
1472 is not supported.
1473 @retval EFI_ACCESS_DENIED User is not successfully identified
1474
1475 **/
1476 EFI_STATUS
1477 EFIAPI
1478 BdsLibUserIdentify (
1479 OUT EFI_USER_PROFILE_HANDLE *User
1480 )
1481 {
1482 EFI_STATUS Status;
1483 EFI_USER_MANAGER_PROTOCOL *Manager;
1484
1485 Status = gBS->LocateProtocol (
1486 &gEfiUserManagerProtocolGuid,
1487 NULL,
1488 (VOID **) &Manager
1489 );
1490 if (EFI_ERROR (Status)) {
1491 return EFI_SUCCESS;
1492 }
1493
1494 return Manager->Identify (Manager, User);
1495 }
1496