Parameter checking in BdsLibMatchDevicePaths() is wrong. This bug was found because...
[mirror_edk2.git] / MdeModulePkg / Library / GenericBdsLib / BdsMisc.c
1 /** @file
2 Misc BDS library function
3
4 Copyright (c) 2004 - 2008, Intel Corporation. <BR>
5 All rights reserved. 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 /**
27 Return the default value for system Timeout variable.
28
29 @return Timeout value.
30
31 **/
32 UINT16
33 EFIAPI
34 BdsLibGetTimeout (
35 VOID
36 )
37 {
38 UINT16 Timeout;
39 UINTN Size;
40 EFI_STATUS Status;
41
42 //
43 // Return Timeout variable or 0xffff if no valid
44 // Timeout variable exists.
45 //
46 Size = sizeof (UINT16);
47 Status = gRT->GetVariable (L"Timeout", &gEfiGlobalVariableGuid, NULL, &Size, &Timeout);
48 if (EFI_ERROR (Status)) {
49 //
50 // According to UEFI 2.0 spec, it should treat the Timeout value as 0xffff
51 // (default value PcdPlatformBootTimeOutDefault) when L"Timeout" variable is not present.
52 // To make the current EFI Automatic-Test activity possible, platform can choose other value
53 // for automatic boot when the variable is not present.
54 //
55 Timeout = PcdGet16 (PcdPlatformBootTimeOutDefault);
56 }
57
58 return Timeout;
59 }
60
61 /**
62 The function will go through the driver optoin link list, load and start
63 every driver the driver optoin device path point to.
64
65 @param BdsDriverLists The header of the current driver option link list
66
67 **/
68 VOID
69 EFIAPI
70 BdsLibLoadDrivers (
71 IN LIST_ENTRY *BdsDriverLists
72 )
73 {
74 EFI_STATUS Status;
75 LIST_ENTRY *Link;
76 BDS_COMMON_OPTION *Option;
77 EFI_HANDLE ImageHandle;
78 EFI_LOADED_IMAGE_PROTOCOL *ImageInfo;
79 UINTN ExitDataSize;
80 CHAR16 *ExitData;
81 BOOLEAN ReconnectAll;
82
83 ReconnectAll = FALSE;
84
85 //
86 // Process the driver option
87 //
88 for (Link = BdsDriverLists->ForwardLink; Link != BdsDriverLists; Link = Link->ForwardLink) {
89 Option = CR (Link, BDS_COMMON_OPTION, Link, BDS_LOAD_OPTION_SIGNATURE);
90
91 //
92 // If a load option is not marked as LOAD_OPTION_ACTIVE,
93 // the boot manager will not automatically load the option.
94 //
95 if (!IS_LOAD_OPTION_TYPE (Option->Attribute, LOAD_OPTION_ACTIVE)) {
96 continue;
97 }
98
99 //
100 // If a driver load option is marked as LOAD_OPTION_FORCE_RECONNECT,
101 // then all of the EFI drivers in the system will be disconnected and
102 // reconnected after the last driver load option is processed.
103 //
104 if (IS_LOAD_OPTION_TYPE (Option->Attribute, LOAD_OPTION_FORCE_RECONNECT)) {
105 ReconnectAll = TRUE;
106 }
107
108 //
109 // Make sure the driver path is connected.
110 //
111 BdsLibConnectDevicePath (Option->DevicePath);
112
113 //
114 // Load and start the image that Driver#### describes
115 //
116 Status = gBS->LoadImage (
117 FALSE,
118 mBdsImageHandle,
119 Option->DevicePath,
120 NULL,
121 0,
122 &ImageHandle
123 );
124
125 if (!EFI_ERROR (Status)) {
126 gBS->HandleProtocol (ImageHandle, &gEfiLoadedImageProtocolGuid, (VOID **) &ImageInfo);
127
128 //
129 // Verify whether this image is a driver, if not,
130 // exit it and continue to parse next load option
131 //
132 if (ImageInfo->ImageCodeType != EfiBootServicesCode && ImageInfo->ImageCodeType != EfiRuntimeServicesCode) {
133 gBS->Exit (ImageHandle, EFI_INVALID_PARAMETER, 0, NULL);
134 continue;
135 }
136
137 if (Option->LoadOptionsSize != 0) {
138 ImageInfo->LoadOptionsSize = Option->LoadOptionsSize;
139 ImageInfo->LoadOptions = Option->LoadOptions;
140 }
141 //
142 // Before calling the image, enable the Watchdog Timer for
143 // the 5 Minute period
144 //
145 gBS->SetWatchdogTimer (5 * 60, 0x0000, 0x00, NULL);
146
147 Status = gBS->StartImage (ImageHandle, &ExitDataSize, &ExitData);
148 DEBUG ((DEBUG_INFO | DEBUG_LOAD, "Driver Return Status = %r\n", Status));
149
150 //
151 // Clear the Watchdog Timer after the image returns
152 //
153 gBS->SetWatchdogTimer (0x0000, 0x0000, 0x0000, NULL);
154 }
155 }
156
157 //
158 // Process the LOAD_OPTION_FORCE_RECONNECT driver option
159 //
160 if (ReconnectAll) {
161 BdsLibDisconnectAllEfi ();
162 BdsLibConnectAll ();
163 }
164
165 }
166
167 /**
168 Get the Option Number that does not used.
169 Try to locate the specific option variable one by one untile find a free number.
170
171 @param VariableName Indicate if the boot#### or driver#### option
172
173 @return The Minimal Free Option Number
174
175 **/
176 UINT16
177 BdsLibGetFreeOptionNumber (
178 IN CHAR16 *VariableName
179 )
180 {
181 UINTN Index;
182 CHAR16 StrTemp[10];
183 UINT16 *OptionBuffer;
184 UINTN OptionSize;
185
186 //
187 // Try to find the minimum free number from 0, 1, 2, 3....
188 //
189 Index = 0;
190 do {
191 if (*VariableName == 'B') {
192 UnicodeSPrint (StrTemp, sizeof (StrTemp), L"Boot%04x", Index);
193 } else {
194 UnicodeSPrint (StrTemp, sizeof (StrTemp), L"Driver%04x", Index);
195 }
196 //
197 // try if the option number is used
198 //
199 OptionBuffer = BdsLibGetVariableAndSize (
200 StrTemp,
201 &gEfiGlobalVariableGuid,
202 &OptionSize
203 );
204 if (OptionBuffer == NULL) {
205 break;
206 }
207 Index ++;
208 } while (TRUE);
209
210 return ((UINT16) Index);
211 }
212
213
214 /**
215 This function will register the new boot#### or driver#### option base on
216 the VariableName. The new registered boot#### or driver#### will be linked
217 to BdsOptionList and also update to the VariableName. After the boot#### or
218 driver#### updated, the BootOrder or DriverOrder will also be updated.
219
220 @param BdsOptionList The header of the boot#### or driver#### link list
221 @param DevicePath The device path which the boot#### or driver####
222 option present
223 @param String The description of the boot#### or driver####
224 @param VariableName Indicate if the boot#### or driver#### option
225
226 @retval EFI_SUCCESS The boot#### or driver#### have been success
227 registered
228 @retval EFI_STATUS Return the status of gRT->SetVariable ().
229
230 **/
231 EFI_STATUS
232 EFIAPI
233 BdsLibRegisterNewOption (
234 IN LIST_ENTRY *BdsOptionList,
235 IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,
236 IN CHAR16 *String,
237 IN CHAR16 *VariableName
238 )
239 {
240 EFI_STATUS Status;
241 UINTN Index;
242 UINT16 RegisterOptionNumber;
243 UINT16 *TempOptionPtr;
244 UINTN TempOptionSize;
245 UINT16 *OptionOrderPtr;
246 VOID *OptionPtr;
247 UINTN OptionSize;
248 UINT8 *TempPtr;
249 EFI_DEVICE_PATH_PROTOCOL *OptionDevicePath;
250 CHAR16 *Description;
251 CHAR16 OptionName[10];
252 BOOLEAN UpdateDescription;
253 UINT16 BootOrderEntry;
254 UINTN OrderItemNum;
255
256
257 OptionPtr = NULL;
258 OptionSize = 0;
259 TempPtr = NULL;
260 OptionDevicePath = NULL;
261 Description = NULL;
262 OptionOrderPtr = NULL;
263 UpdateDescription = FALSE;
264 Status = EFI_SUCCESS;
265 ZeroMem (OptionName, sizeof (OptionName));
266
267 TempOptionSize = 0;
268 TempOptionPtr = BdsLibGetVariableAndSize (
269 VariableName,
270 &gEfiGlobalVariableGuid,
271 &TempOptionSize
272 );
273
274 //
275 // Compare with current option variable
276 //
277 for (Index = 0; Index < TempOptionSize / sizeof (UINT16); Index++) {
278
279 if (*VariableName == 'B') {
280 UnicodeSPrint (OptionName, sizeof (OptionName), L"Boot%04x", TempOptionPtr[Index]);
281 } else {
282 UnicodeSPrint (OptionName, sizeof (OptionName), L"Driver%04x", TempOptionPtr[Index]);
283 }
284
285 OptionPtr = BdsLibGetVariableAndSize (
286 OptionName,
287 &gEfiGlobalVariableGuid,
288 &OptionSize
289 );
290 if (OptionPtr == NULL) {
291 continue;
292 }
293 TempPtr = OptionPtr;
294 TempPtr += sizeof (UINT32) + sizeof (UINT16);
295 Description = (CHAR16 *) TempPtr;
296 TempPtr += StrSize ((CHAR16 *) TempPtr);
297 OptionDevicePath = (EFI_DEVICE_PATH_PROTOCOL *) TempPtr;
298
299 //
300 // Notes: the description may will change base on the GetStringToken
301 //
302 if (CompareMem (OptionDevicePath, DevicePath, GetDevicePathSize (OptionDevicePath)) == 0) {
303 if (CompareMem (Description, String, StrSize (Description)) == 0) {
304 //
305 // Got the option, so just return
306 //
307 FreePool (OptionPtr);
308 FreePool (TempOptionPtr);
309 return EFI_SUCCESS;
310 } else {
311 //
312 // Option description changed, need update.
313 //
314 UpdateDescription = TRUE;
315 FreePool (OptionPtr);
316 break;
317 }
318 }
319
320 FreePool (OptionPtr);
321 }
322
323 OptionSize = sizeof (UINT32) + sizeof (UINT16) + StrSize (String);
324 OptionSize += GetDevicePathSize (DevicePath);
325 OptionPtr = AllocateZeroPool (OptionSize);
326 ASSERT (OptionPtr != NULL);
327
328 TempPtr = OptionPtr;
329 *(UINT32 *) TempPtr = LOAD_OPTION_ACTIVE;
330 TempPtr += sizeof (UINT32);
331 *(UINT16 *) TempPtr = (UINT16) GetDevicePathSize (DevicePath);
332 TempPtr += sizeof (UINT16);
333 CopyMem (TempPtr, String, StrSize (String));
334 TempPtr += StrSize (String);
335 CopyMem (TempPtr, DevicePath, GetDevicePathSize (DevicePath));
336
337 if (UpdateDescription) {
338 //
339 // The number in option#### to be updated
340 //
341 RegisterOptionNumber = TempOptionPtr[Index];
342 } else {
343 //
344 // The new option#### number
345 //
346 RegisterOptionNumber = BdsLibGetFreeOptionNumber(VariableName);
347 }
348
349 if (*VariableName == 'B') {
350 UnicodeSPrint (OptionName, sizeof (OptionName), L"Boot%04x", RegisterOptionNumber);
351 } else {
352 UnicodeSPrint (OptionName, sizeof (OptionName), L"Driver%04x", RegisterOptionNumber);
353 }
354
355 Status = gRT->SetVariable (
356 OptionName,
357 &gEfiGlobalVariableGuid,
358 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,
359 OptionSize,
360 OptionPtr
361 );
362 //
363 // Return if only need to update a changed description or fail to set option.
364 //
365 if (EFI_ERROR (Status) || UpdateDescription) {
366 FreePool (OptionPtr);
367 if (TempOptionPtr != NULL) {
368 FreePool (TempOptionPtr);
369 }
370 return Status;
371 }
372
373 FreePool (OptionPtr);
374
375 //
376 // Update the option order variable
377 //
378
379 //
380 // If no option order
381 //
382 if (TempOptionSize == 0) {
383 BootOrderEntry = 0;
384 Status = gRT->SetVariable (
385 VariableName,
386 &gEfiGlobalVariableGuid,
387 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,
388 sizeof (UINT16),
389 &BootOrderEntry
390 );
391 if (TempOptionPtr != NULL) {
392 FreePool (TempOptionPtr);
393 }
394 return Status;
395 }
396
397 //
398 // Append the new option number to the original option order
399 //
400 OrderItemNum = (TempOptionSize / sizeof (UINT16)) + 1 ;
401 OptionOrderPtr = AllocateZeroPool ( OrderItemNum * sizeof (UINT16));
402 ASSERT (OptionOrderPtr!= NULL);
403
404 CopyMem (OptionOrderPtr, TempOptionPtr, (OrderItemNum - 1) * sizeof (UINT16));
405
406 OptionOrderPtr[Index] = RegisterOptionNumber;
407
408 Status = gRT->SetVariable (
409 VariableName,
410 &gEfiGlobalVariableGuid,
411 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,
412 OrderItemNum * sizeof (UINT16),
413 OptionOrderPtr
414 );
415 FreePool (TempOptionPtr);
416 FreePool (OptionOrderPtr);
417
418 return Status;
419 }
420
421
422 /**
423 Build the boot#### or driver#### option from the VariableName, the
424 build boot#### or driver#### will also be linked to BdsCommonOptionList.
425
426 @param BdsCommonOptionList The header of the boot#### or driver#### option
427 link list
428 @param VariableName EFI Variable name indicate if it is boot#### or
429 driver####
430
431 @retval BDS_COMMON_OPTION Get the option just been created
432 @retval NULL Failed to get the new option
433
434 **/
435 BDS_COMMON_OPTION *
436 EFIAPI
437 BdsLibVariableToOption (
438 IN OUT LIST_ENTRY *BdsCommonOptionList,
439 IN CHAR16 *VariableName
440 )
441 {
442 UINT32 Attribute;
443 UINT16 FilePathSize;
444 UINT8 *Variable;
445 UINT8 *TempPtr;
446 UINTN VariableSize;
447 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
448 BDS_COMMON_OPTION *Option;
449 VOID *LoadOptions;
450 UINT32 LoadOptionsSize;
451 CHAR16 *Description;
452 UINT8 NumOff;
453 //
454 // Read the variable. We will never free this data.
455 //
456 Variable = BdsLibGetVariableAndSize (
457 VariableName,
458 &gEfiGlobalVariableGuid,
459 &VariableSize
460 );
461 if (Variable == NULL) {
462 return NULL;
463 }
464 //
465 // Notes: careful defined the variable of Boot#### or
466 // Driver####, consider use some macro to abstract the code
467 //
468 //
469 // Get the option attribute
470 //
471 TempPtr = Variable;
472 Attribute = *(UINT32 *) Variable;
473 TempPtr += sizeof (UINT32);
474
475 //
476 // Get the option's device path size
477 //
478 FilePathSize = *(UINT16 *) TempPtr;
479 TempPtr += sizeof (UINT16);
480
481 //
482 // Get the option's description string
483 //
484 Description = (CHAR16 *) TempPtr;
485
486 //
487 // Get the option's description string size
488 //
489 TempPtr += StrSize ((CHAR16 *) TempPtr);
490
491 //
492 // Get the option's device path
493 //
494 DevicePath = (EFI_DEVICE_PATH_PROTOCOL *) TempPtr;
495 TempPtr += FilePathSize;
496
497 LoadOptions = TempPtr;
498 LoadOptionsSize = (UINT32) (VariableSize - (UINTN) (TempPtr - Variable));
499
500 //
501 // The Console variables may have multiple device paths, so make
502 // an Entry for each one.
503 //
504 Option = AllocateZeroPool (sizeof (BDS_COMMON_OPTION));
505 if (Option == NULL) {
506 return NULL;
507 }
508
509 Option->Signature = BDS_LOAD_OPTION_SIGNATURE;
510 Option->DevicePath = AllocateZeroPool (GetDevicePathSize (DevicePath));
511 CopyMem (Option->DevicePath, DevicePath, GetDevicePathSize (DevicePath));
512 Option->Attribute = Attribute;
513 Option->Description = AllocateZeroPool (StrSize (Description));
514 CopyMem (Option->Description, Description, StrSize (Description));
515 Option->LoadOptions = AllocateZeroPool (LoadOptionsSize);
516 CopyMem (Option->LoadOptions, LoadOptions, LoadOptionsSize);
517 Option->LoadOptionsSize = LoadOptionsSize;
518
519 //
520 // Get the value from VariableName Unicode string
521 // since the ISO standard assumes ASCII equivalent abbreviations, we can be safe in converting this
522 // Unicode stream to ASCII without any loss in meaning.
523 //
524 if (*VariableName == 'B') {
525 NumOff = sizeof (L"Boot")/sizeof(CHAR16) -1 ;
526 Option->BootCurrent = (UINT16) ((VariableName[NumOff] -'0') * 0x1000);
527 Option->BootCurrent = (UINT16) (Option->BootCurrent + ((VariableName[NumOff+1]-'0') * 0x100));
528 Option->BootCurrent = (UINT16) (Option->BootCurrent + ((VariableName[NumOff+2]-'0') * 0x10));
529 Option->BootCurrent = (UINT16) (Option->BootCurrent + ((VariableName[NumOff+3]-'0')));
530 }
531 //
532 // Insert active entry to BdsDeviceList
533 //
534 if ((Option->Attribute & LOAD_OPTION_ACTIVE) == LOAD_OPTION_ACTIVE) {
535 InsertTailList (BdsCommonOptionList, &Option->Link);
536 FreePool (Variable);
537 return Option;
538 }
539
540 FreePool (Variable);
541 FreePool (Option);
542 return NULL;
543
544 }
545
546 /**
547 Process BootOrder, or DriverOrder variables, by calling
548 BdsLibVariableToOption () for each UINT16 in the variables.
549
550 @param BdsCommonOptionList The header of the option list base on variable
551 VariableName
552 @param VariableName EFI Variable name indicate the BootOrder or
553 DriverOrder
554
555 @retval EFI_SUCCESS Success create the boot option or driver option
556 list
557 @retval EFI_OUT_OF_RESOURCES Failed to get the boot option or driver option list
558
559 **/
560 EFI_STATUS
561 EFIAPI
562 BdsLibBuildOptionFromVar (
563 IN LIST_ENTRY *BdsCommonOptionList,
564 IN CHAR16 *VariableName
565 )
566 {
567 UINT16 *OptionOrder;
568 UINTN OptionOrderSize;
569 UINTN Index;
570 BDS_COMMON_OPTION *Option;
571 CHAR16 OptionName[20];
572
573 //
574 // Zero Buffer in order to get all BOOT#### variables
575 //
576 ZeroMem (OptionName, sizeof (OptionName));
577
578 //
579 // Read the BootOrder, or DriverOrder variable.
580 //
581 OptionOrder = BdsLibGetVariableAndSize (
582 VariableName,
583 &gEfiGlobalVariableGuid,
584 &OptionOrderSize
585 );
586 if (OptionOrder == NULL) {
587 return EFI_OUT_OF_RESOURCES;
588 }
589
590 for (Index = 0; Index < OptionOrderSize / sizeof (UINT16); Index++) {
591 if (*VariableName == 'B') {
592 UnicodeSPrint (OptionName, sizeof (OptionName), L"Boot%04x", OptionOrder[Index]);
593 } else {
594 UnicodeSPrint (OptionName, sizeof (OptionName), L"Driver%04x", OptionOrder[Index]);
595 }
596
597 Option = BdsLibVariableToOption (BdsCommonOptionList, OptionName);
598 Option->BootCurrent = OptionOrder[Index];
599
600 }
601
602 FreePool (OptionOrder);
603
604 return EFI_SUCCESS;
605 }
606
607 /**
608 Get boot mode by looking up configuration table and parsing HOB list
609
610 @param BootMode Boot mode from PEI handoff HOB.
611
612 @retval EFI_SUCCESS Successfully get boot mode
613
614 **/
615 EFI_STATUS
616 EFIAPI
617 BdsLibGetBootMode (
618 OUT EFI_BOOT_MODE *BootMode
619 )
620 {
621 *BootMode = GetBootModeHob ();
622
623 return EFI_SUCCESS;
624 }
625
626 /**
627 Read the EFI variable (VendorGuid/Name) and return a dynamically allocated
628 buffer, and the size of the buffer. If failure return NULL.
629
630 @param Name String part of EFI variable name
631 @param VendorGuid GUID part of EFI variable name
632 @param VariableSize Returns the size of the EFI variable that was read
633
634 @return Dynamically allocated memory that contains a copy of the EFI variable.
635 @return Caller is responsible freeing the buffer.
636 @retval NULL Variable was not read
637
638 **/
639 VOID *
640 EFIAPI
641 BdsLibGetVariableAndSize (
642 IN CHAR16 *Name,
643 IN EFI_GUID *VendorGuid,
644 OUT UINTN *VariableSize
645 )
646 {
647 EFI_STATUS Status;
648 UINTN BufferSize;
649 VOID *Buffer;
650
651 Buffer = NULL;
652
653 //
654 // Pass in a zero size buffer to find the required buffer size.
655 //
656 BufferSize = 0;
657 Status = gRT->GetVariable (Name, VendorGuid, NULL, &BufferSize, Buffer);
658 if (Status == EFI_BUFFER_TOO_SMALL) {
659 //
660 // Allocate the buffer to return
661 //
662 Buffer = AllocateZeroPool (BufferSize);
663 if (Buffer == NULL) {
664 return NULL;
665 }
666 //
667 // Read variable into the allocated buffer.
668 //
669 Status = gRT->GetVariable (Name, VendorGuid, NULL, &BufferSize, Buffer);
670 if (EFI_ERROR (Status)) {
671 BufferSize = 0;
672 }
673 }
674
675 *VariableSize = BufferSize;
676 return Buffer;
677 }
678
679 /**
680 Delete the instance in Multi which matches partly with Single instance
681
682 @param Multi A pointer to a multi-instance device path data
683 structure.
684 @param Single A pointer to a single-instance device path data
685 structure.
686
687 @return This function will remove the device path instances in Multi which partly
688 match with the Single, and return the result device path. If there is no
689 remaining device path as a result, this function will return NULL.
690
691 **/
692 EFI_DEVICE_PATH_PROTOCOL *
693 EFIAPI
694 BdsLibDelPartMatchInstance (
695 IN EFI_DEVICE_PATH_PROTOCOL *Multi,
696 IN EFI_DEVICE_PATH_PROTOCOL *Single
697 )
698 {
699 EFI_DEVICE_PATH_PROTOCOL *Instance;
700 EFI_DEVICE_PATH_PROTOCOL *NewDevicePath;
701 EFI_DEVICE_PATH_PROTOCOL *TempNewDevicePath;
702 UINTN InstanceSize;
703 UINTN SingleDpSize;
704 UINTN Size;
705
706 NewDevicePath = NULL;
707 TempNewDevicePath = NULL;
708
709 if (Multi == NULL || Single == NULL) {
710 return Multi;
711 }
712
713 Instance = GetNextDevicePathInstance (&Multi, &InstanceSize);
714 SingleDpSize = GetDevicePathSize (Single) - END_DEVICE_PATH_LENGTH;
715 InstanceSize -= END_DEVICE_PATH_LENGTH;
716
717 while (Instance != NULL) {
718
719 Size = (SingleDpSize < InstanceSize) ? SingleDpSize : InstanceSize;
720
721 if ((CompareMem (Instance, Single, Size) != 0)) {
722 //
723 // Append the device path instance which does not match with Single
724 //
725 TempNewDevicePath = NewDevicePath;
726 NewDevicePath = AppendDevicePathInstance (NewDevicePath, Instance);
727 if (TempNewDevicePath != NULL) {
728 FreePool(TempNewDevicePath);
729 }
730 }
731 FreePool(Instance);
732 Instance = GetNextDevicePathInstance (&Multi, &InstanceSize);
733 InstanceSize -= END_DEVICE_PATH_LENGTH;
734 }
735
736 return NewDevicePath;
737 }
738
739 /**
740 Function compares a device path data structure to that of all the nodes of a
741 second device path instance.
742
743 @param Multi A pointer to a multi-instance device path data
744 structure.
745 @param Single A pointer to a single-instance device path data
746 structure.
747
748 @retval TRUE If the Single is contained within Multi
749 @retval FALSE The Single is not match within Multi
750
751 **/
752 BOOLEAN
753 EFIAPI
754 BdsLibMatchDevicePaths (
755 IN EFI_DEVICE_PATH_PROTOCOL *Multi,
756 IN EFI_DEVICE_PATH_PROTOCOL *Single
757 )
758 {
759 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
760 EFI_DEVICE_PATH_PROTOCOL *DevicePathInst;
761 UINTN Size;
762
763 if (Multi == NULL || Single == NULL) {
764 return FALSE;
765 }
766
767 DevicePath = Multi;
768 DevicePathInst = GetNextDevicePathInstance (&DevicePath, &Size);
769
770 //
771 // Search for the match of 'Single' in 'Multi'
772 //
773 while (DevicePathInst != NULL) {
774 //
775 // If the single device path is found in multiple device paths,
776 // return success
777 //
778 if (CompareMem (Single, DevicePathInst, Size) == 0) {
779 FreePool (DevicePathInst);
780 return TRUE;
781 }
782
783 FreePool (DevicePathInst);
784 DevicePathInst = GetNextDevicePathInstance (&DevicePath, &Size);
785 }
786
787 return FALSE;
788 }
789
790 /**
791 This function prints a series of strings.
792
793 @param ConOut Pointer to EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
794 @param ... A variable argument list containing series of
795 strings, the last string must be NULL.
796
797 @retval EFI_SUCCESS Success print out the string using ConOut.
798 @retval EFI_STATUS Return the status of the ConOut->OutputString ().
799
800 **/
801 EFI_STATUS
802 EFIAPI
803 BdsLibOutputStrings (
804 IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *ConOut,
805 ...
806 )
807 {
808 VA_LIST Args;
809 EFI_STATUS Status;
810 CHAR16 *String;
811
812 Status = EFI_SUCCESS;
813 VA_START (Args, ConOut);
814
815 while (!EFI_ERROR (Status)) {
816 //
817 // If String is NULL, then it's the end of the list
818 //
819 String = VA_ARG (Args, CHAR16 *);
820 if (String != NULL) {
821 break;
822 }
823
824 Status = ConOut->OutputString (ConOut, String);
825
826 if (EFI_ERROR (Status)) {
827 break;
828 }
829 }
830
831 return Status;
832 }
833
834 //
835 // Following are BDS Lib functions which contain all the code about setup browser reset reminder feature.
836 // Setup Browser reset reminder feature is that an reset reminder will be given before user leaves the setup browser if
837 // user change any option setting which needs a reset to be effective, and the reset will be applied according to the user selection.
838 //
839
840
841 /**
842 Enable the setup browser reset reminder feature.
843 This routine is used in platform tip. If the platform policy need the feature, use the routine to enable it.
844
845 **/
846 VOID
847 EFIAPI
848 EnableResetReminderFeature (
849 VOID
850 )
851 {
852 mFeaturerSwitch = TRUE;
853 }
854
855
856 /**
857 Disable the setup browser reset reminder feature.
858 This routine is used in platform tip. If the platform policy do not want the feature, use the routine to disable it.
859
860 **/
861 VOID
862 EFIAPI
863 DisableResetReminderFeature (
864 VOID
865 )
866 {
867 mFeaturerSwitch = FALSE;
868 }
869
870
871 /**
872 Record the info that a reset is required.
873 A module boolean variable is used to record whether a reset is required.
874
875 **/
876 VOID
877 EFIAPI
878 EnableResetRequired (
879 VOID
880 )
881 {
882 mResetRequired = TRUE;
883 }
884
885
886 /**
887 Record the info that no reset is required.
888 A module boolean variable is used to record whether a reset is required.
889
890 **/
891 VOID
892 EFIAPI
893 DisableResetRequired (
894 VOID
895 )
896 {
897 mResetRequired = FALSE;
898 }
899
900
901 /**
902 Check whether platform policy enable the reset reminder feature. The default is enabled.
903
904 **/
905 BOOLEAN
906 EFIAPI
907 IsResetReminderFeatureEnable (
908 VOID
909 )
910 {
911 return mFeaturerSwitch;
912 }
913
914
915 /**
916 Check if user changed any option setting which needs a system reset to be effective.
917
918 **/
919 BOOLEAN
920 EFIAPI
921 IsResetRequired (
922 VOID
923 )
924 {
925 return mResetRequired;
926 }
927
928
929 /**
930 Check whether a reset is needed, and finish the reset reminder feature.
931 If a reset is needed, Popup a menu to notice user, and finish the feature
932 according to the user selection.
933
934 **/
935 VOID
936 EFIAPI
937 SetupResetReminder (
938 VOID
939 )
940 {
941 EFI_INPUT_KEY Key;
942 CHAR16 *StringBuffer1;
943 CHAR16 *StringBuffer2;
944
945
946 //
947 //check any reset required change is applied? if yes, reset system
948 //
949 if (IsResetReminderFeatureEnable ()) {
950 if (IsResetRequired ()) {
951
952 StringBuffer1 = AllocateZeroPool (MAX_STRING_LEN * sizeof (CHAR16));
953 ASSERT (StringBuffer1 != NULL);
954 StringBuffer2 = AllocateZeroPool (MAX_STRING_LEN * sizeof (CHAR16));
955 ASSERT (StringBuffer2 != NULL);
956 StrCpy (StringBuffer1, L"Configuration changed. Reset to apply it Now ? ");
957 StrCpy (StringBuffer2, L"Enter (YES) / Esc (NO)");
958 //
959 // Popup a menu to notice user
960 //
961 do {
962 IfrLibCreatePopUp (2, &Key, StringBuffer1, StringBuffer2);
963 } while ((Key.ScanCode != SCAN_ESC) && (Key.UnicodeChar != CHAR_CARRIAGE_RETURN));
964
965 FreePool (StringBuffer1);
966 FreePool (StringBuffer2);
967 //
968 // If the user hits the YES Response key, reset
969 //
970 if ((Key.UnicodeChar == CHAR_CARRIAGE_RETURN)) {
971 gRT->ResetSystem (EfiResetCold, EFI_SUCCESS, 0, NULL);
972 }
973 gST->ConOut->ClearScreen (gST->ConOut);
974 }
975 }
976 }
977
978 /**
979 Get the headers (dos, image, optional header) from an image.
980
981 @param Device SimpleFileSystem device handle
982 @param FileName File name for the image
983 @param DosHeader Pointer to dos header
984 @param Hdr Pointer to optional header
985
986 @retval EFI_SUCCESS Successfully get the machine type.
987 @retval EFI_NOT_FOUND The file is not found.
988 @retval EFI_LOAD_ERROR File is not a valid image file.
989
990 **/
991 EFI_STATUS
992 EFIAPI
993 BdsLibGetImageHeader (
994 IN EFI_HANDLE Device,
995 IN CHAR16 *FileName,
996 OUT EFI_IMAGE_DOS_HEADER *DosHeader,
997 OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr
998 )
999 {
1000 EFI_STATUS Status;
1001 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *Volume;
1002 EFI_FILE_HANDLE Root;
1003 EFI_FILE_HANDLE ThisFile;
1004 UINTN BufferSize;
1005 UINT64 FileSize;
1006 EFI_FILE_INFO *Info;
1007
1008 Root = NULL;
1009 ThisFile = NULL;
1010 //
1011 // Handle the file system interface to the device
1012 //
1013 Status = gBS->HandleProtocol (
1014 Device,
1015 &gEfiSimpleFileSystemProtocolGuid,
1016 (VOID *) &Volume
1017 );
1018 if (EFI_ERROR (Status)) {
1019 goto Done;
1020 }
1021
1022 Status = Volume->OpenVolume (
1023 Volume,
1024 &Root
1025 );
1026 if (EFI_ERROR (Status)) {
1027 Root = NULL;
1028 goto Done;
1029 }
1030
1031 Status = Root->Open (Root, &ThisFile, FileName, EFI_FILE_MODE_READ, 0);
1032 if (EFI_ERROR (Status)) {
1033 goto Done;
1034 }
1035
1036 //
1037 // Get file size
1038 //
1039 BufferSize = SIZE_OF_EFI_FILE_INFO + 200;
1040 do {
1041 Info = NULL;
1042 Status = gBS->AllocatePool (EfiBootServicesData, BufferSize, (VOID **) &Info);
1043 if (EFI_ERROR (Status)) {
1044 goto Done;
1045 }
1046 Status = ThisFile->GetInfo (
1047 ThisFile,
1048 &gEfiFileInfoGuid,
1049 &BufferSize,
1050 Info
1051 );
1052 if (!EFI_ERROR (Status)) {
1053 break;
1054 }
1055 if (Status != EFI_BUFFER_TOO_SMALL) {
1056 FreePool (Info);
1057 goto Done;
1058 }
1059 FreePool (Info);
1060 } while (TRUE);
1061
1062 FileSize = Info->FileSize;
1063 FreePool (Info);
1064
1065 //
1066 // Read dos header
1067 //
1068 BufferSize = sizeof (EFI_IMAGE_DOS_HEADER);
1069 Status = ThisFile->Read (ThisFile, &BufferSize, DosHeader);
1070 if (EFI_ERROR (Status) ||
1071 BufferSize < sizeof (EFI_IMAGE_DOS_HEADER) ||
1072 FileSize <= DosHeader->e_lfanew ||
1073 DosHeader->e_magic != EFI_IMAGE_DOS_SIGNATURE) {
1074 Status = EFI_LOAD_ERROR;
1075 goto Done;
1076 }
1077
1078 //
1079 // Move to PE signature
1080 //
1081 Status = ThisFile->SetPosition (ThisFile, DosHeader->e_lfanew);
1082 if (EFI_ERROR (Status)) {
1083 Status = EFI_LOAD_ERROR;
1084 goto Done;
1085 }
1086
1087 //
1088 // Read and check PE signature
1089 //
1090 BufferSize = sizeof (EFI_IMAGE_OPTIONAL_HEADER_UNION);
1091 Status = ThisFile->Read (ThisFile, &BufferSize, Hdr.Pe32);
1092 if (EFI_ERROR (Status) ||
1093 BufferSize < sizeof (EFI_IMAGE_OPTIONAL_HEADER_UNION) ||
1094 Hdr.Pe32->Signature != EFI_IMAGE_NT_SIGNATURE) {
1095 Status = EFI_LOAD_ERROR;
1096 goto Done;
1097 }
1098
1099 //
1100 // Check PE32 or PE32+ magic
1101 //
1102 if (Hdr.Pe32->OptionalHeader.Magic != EFI_IMAGE_NT_OPTIONAL_HDR32_MAGIC &&
1103 Hdr.Pe32->OptionalHeader.Magic != EFI_IMAGE_NT_OPTIONAL_HDR64_MAGIC) {
1104 Status = EFI_LOAD_ERROR;
1105 goto Done;
1106 }
1107
1108 Done:
1109 if (ThisFile != NULL) {
1110 ThisFile->Close (ThisFile);
1111 }
1112 if (Root != NULL) {
1113 Root->Close (Root);
1114 }
1115 return Status;
1116 }
1117
1118 /**
1119
1120 This routine is a notification function for legayc boot or exit boot
1121 service event. It will adjust the memory information for different
1122 memory type and save them into the variables for next boot.
1123
1124
1125 @param Event The event that triggered this notification function.
1126 @param Context Pointer to the notification functions context.
1127
1128 **/
1129 VOID
1130 EFIAPI
1131 BdsSetMemoryTypeInformationVariable (
1132 EFI_EVENT Event,
1133 VOID *Context
1134 )
1135 {
1136 EFI_STATUS Status;
1137 EFI_MEMORY_TYPE_INFORMATION *PreviousMemoryTypeInformation;
1138 EFI_MEMORY_TYPE_INFORMATION *CurrentMemoryTypeInformation;
1139 UINTN VariableSize;
1140 BOOLEAN UpdateRequired;
1141 UINTN Index;
1142 UINTN Index1;
1143 UINT32 Previous;
1144 UINT32 Current;
1145 UINT32 Next;
1146 EFI_HOB_GUID_TYPE *GuidHob;
1147
1148 UpdateRequired = FALSE;
1149
1150 //
1151 // Retrieve the current memory usage statistics. If they are not found, then
1152 // no adjustments can be made to the Memory Type Information variable.
1153 //
1154 Status = EfiGetSystemConfigurationTable (
1155 &gEfiMemoryTypeInformationGuid,
1156 (VOID **) &CurrentMemoryTypeInformation
1157 );
1158 if (EFI_ERROR (Status)) {
1159 return;
1160 }
1161
1162 //
1163 // Get the Memory Type Information settings from Hob if they exist,
1164 // PEI is responsible for getting them from variable and build a Hob to save them.
1165 // If the previous Memory Type Information is not available, then set defaults
1166 //
1167 GuidHob = GetFirstGuidHob (&gEfiMemoryTypeInformationGuid);
1168 if (GuidHob == NULL) {
1169 //
1170 // If Platform has not built Memory Type Info into the Hob, just return.
1171 //
1172 return;
1173 }
1174 PreviousMemoryTypeInformation = GET_GUID_HOB_DATA (GuidHob);
1175 VariableSize = GET_GUID_HOB_DATA_SIZE (GuidHob);
1176
1177 //
1178 // Use a heuristic to adjust the Memory Type Information for the next boot
1179 //
1180 for (Index = 0; PreviousMemoryTypeInformation[Index].Type != EfiMaxMemoryType; Index++) {
1181
1182 Current = 0;
1183 for (Index1 = 0; CurrentMemoryTypeInformation[Index1].Type != EfiMaxMemoryType; Index1++) {
1184 if (PreviousMemoryTypeInformation[Index].Type == CurrentMemoryTypeInformation[Index1].Type) {
1185 Current = CurrentMemoryTypeInformation[Index1].NumberOfPages;
1186 break;
1187 }
1188 }
1189
1190 if (CurrentMemoryTypeInformation[Index1].Type == EfiMaxMemoryType) {
1191 continue;
1192 }
1193
1194 Previous = PreviousMemoryTypeInformation[Index].NumberOfPages;
1195
1196 //
1197 // Write next varible to 125% * current and Inconsistent Memory Reserved across bootings may lead to S4 fail
1198 //
1199 if (Current > Previous) {
1200 Next = Current + (Current >> 2);
1201 } else {
1202 Next = Previous;
1203 }
1204 if (Next > 0 && Next < 4) {
1205 Next = 4;
1206 }
1207
1208 if (Next != Previous) {
1209 PreviousMemoryTypeInformation[Index].NumberOfPages = Next;
1210 UpdateRequired = TRUE;
1211 }
1212
1213 }
1214
1215 //
1216 // If any changes were made to the Memory Type Information settings, then set the new variable value
1217 //
1218 if (UpdateRequired) {
1219 Status = gRT->SetVariable (
1220 EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME,
1221 &gEfiMemoryTypeInformationGuid,
1222 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,
1223 VariableSize,
1224 PreviousMemoryTypeInformation
1225 );
1226 }
1227
1228 return;
1229 }
1230
1231 /**
1232 This routine register a function to adjust the different type memory page number just before booting
1233 and save the updated info into the variable for next boot to use.
1234
1235 **/
1236 VOID
1237 EFIAPI
1238 BdsLibSaveMemoryTypeInformation (
1239 VOID
1240 )
1241 {
1242 EFI_STATUS Status;
1243 EFI_EVENT ReadyToBootEvent;
1244
1245 Status = EfiCreateEventReadyToBootEx (
1246 TPL_CALLBACK,
1247 BdsSetMemoryTypeInformationVariable,
1248 NULL,
1249 &ReadyToBootEvent
1250 );
1251 if (EFI_ERROR (Status)) {
1252 DEBUG ((DEBUG_ERROR,"Bds Set Memory Type Informationa Variable Fails\n"));
1253 }
1254
1255 }
1256
1257