]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - MdeModulePkg/Universal/BdsDxe/BdsEntry.c
MdeModulePkg: Deprecate EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS
[mirror_edk2.git] / MdeModulePkg / Universal / BdsDxe / BdsEntry.c
... / ...
CommitLineData
1/** @file\r
2 This module produce main entry for BDS phase - BdsEntry.\r
3 When this module was dispatched by DxeCore, gEfiBdsArchProtocolGuid will be installed\r
4 which contains interface of BdsEntry.\r
5 After DxeCore finish DXE phase, gEfiBdsArchProtocolGuid->BdsEntry will be invoked\r
6 to enter BDS phase.\r
7\r
8Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.<BR>\r
9(C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
10(C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r
11This program and the accompanying materials\r
12are licensed and made available under the terms and conditions of the BSD License\r
13which accompanies this distribution. The full text of the license may be found at\r
14http://opensource.org/licenses/bsd-license.php\r
15\r
16THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
17WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
18\r
19**/\r
20\r
21#include "Bds.h"\r
22#include "Language.h"\r
23#include "HwErrRecSupport.h"\r
24\r
25#define SET_BOOT_OPTION_SUPPORT_KEY_COUNT(a, c) { \\r
26 (a) = ((a) & ~EFI_BOOT_OPTION_SUPPORT_COUNT) | (((c) << LowBitSet32 (EFI_BOOT_OPTION_SUPPORT_COUNT)) & EFI_BOOT_OPTION_SUPPORT_COUNT); \\r
27 }\r
28\r
29///\r
30/// BDS arch protocol instance initial value.\r
31///\r
32EFI_BDS_ARCH_PROTOCOL gBds = {\r
33 BdsEntry\r
34};\r
35\r
36//\r
37// gConnectConInEvent - Event which is signaled when ConIn connection is required\r
38//\r
39EFI_EVENT gConnectConInEvent = NULL;\r
40\r
41///\r
42/// The read-only variables defined in UEFI Spec.\r
43///\r
44CHAR16 *mReadOnlyVariables[] = {\r
45 EFI_PLATFORM_LANG_CODES_VARIABLE_NAME,\r
46 EFI_LANG_CODES_VARIABLE_NAME,\r
47 EFI_BOOT_OPTION_SUPPORT_VARIABLE_NAME,\r
48 EFI_HW_ERR_REC_SUPPORT_VARIABLE_NAME,\r
49 EFI_OS_INDICATIONS_SUPPORT_VARIABLE_NAME\r
50 };\r
51\r
52CHAR16 *mBdsLoadOptionName[] = {\r
53 L"Driver",\r
54 L"SysPrep",\r
55 L"Boot",\r
56 L"PlatformRecovery"\r
57};\r
58\r
59/**\r
60 Event to Connect ConIn.\r
61\r
62 @param Event Event whose notification function is being invoked.\r
63 @param Context Pointer to the notification function's context,\r
64 which is implementation-dependent.\r
65\r
66**/\r
67VOID\r
68EFIAPI\r
69BdsDxeOnConnectConInCallBack (\r
70 IN EFI_EVENT Event,\r
71 IN VOID *Context\r
72 )\r
73{\r
74 EFI_STATUS Status;\r
75\r
76 //\r
77 // When Osloader call ReadKeyStroke to signal this event\r
78 // no driver dependency is assumed existing. So use a non-dispatch version\r
79 //\r
80 Status = EfiBootManagerConnectConsoleVariable (ConIn);\r
81 if (EFI_ERROR (Status)) {\r
82 //\r
83 // Should not enter this case, if enter, the keyboard will not work.\r
84 // May need platfrom policy to connect keyboard.\r
85 //\r
86 DEBUG ((EFI_D_WARN, "[Bds] Connect ConIn failed - %r!!!\n", Status));\r
87 }\r
88}\r
89/**\r
90 Notify function for event group EFI_EVENT_GROUP_READY_TO_BOOT. This is used to\r
91 check whether there is remaining deferred load images.\r
92\r
93 @param[in] Event The Event that is being processed.\r
94 @param[in] Context The Event Context.\r
95\r
96**/\r
97VOID\r
98EFIAPI\r
99CheckDeferredLoadImageOnReadyToBoot (\r
100 IN EFI_EVENT Event,\r
101 IN VOID *Context\r
102 )\r
103{\r
104 EFI_STATUS Status;\r
105 EFI_DEFERRED_IMAGE_LOAD_PROTOCOL *DeferredImage;\r
106 UINTN HandleCount;\r
107 EFI_HANDLE *Handles;\r
108 UINTN Index;\r
109 UINTN ImageIndex;\r
110 EFI_DEVICE_PATH_PROTOCOL *ImageDevicePath;\r
111 VOID *Image;\r
112 UINTN ImageSize;\r
113 BOOLEAN BootOption;\r
114 CHAR16 *DevicePathStr;\r
115\r
116 //\r
117 // Find all the deferred image load protocols.\r
118 //\r
119 HandleCount = 0;\r
120 Handles = NULL;\r
121 Status = gBS->LocateHandleBuffer (\r
122 ByProtocol,\r
123 &gEfiDeferredImageLoadProtocolGuid,\r
124 NULL,\r
125 &HandleCount,\r
126 &Handles\r
127 );\r
128 if (EFI_ERROR (Status)) {\r
129 return;\r
130 }\r
131\r
132 for (Index = 0; Index < HandleCount; Index++) {\r
133 Status = gBS->HandleProtocol (Handles[Index], &gEfiDeferredImageLoadProtocolGuid, (VOID **) &DeferredImage);\r
134 if (EFI_ERROR (Status)) {\r
135 continue;\r
136 }\r
137\r
138 for (ImageIndex = 0; ; ImageIndex++) {\r
139 //\r
140 // Load all the deferred images in this protocol instance.\r
141 //\r
142 Status = DeferredImage->GetImageInfo (\r
143 DeferredImage,\r
144 ImageIndex,\r
145 &ImageDevicePath,\r
146 (VOID **) &Image,\r
147 &ImageSize,\r
148 &BootOption\r
149 );\r
150 if (EFI_ERROR (Status)) {\r
151 break;\r
152 }\r
153 DevicePathStr = ConvertDevicePathToText (ImageDevicePath, FALSE, FALSE);\r
154 DEBUG ((DEBUG_LOAD, "[Bds] Image was deferred but not loaded: %s.\n", DevicePathStr));\r
155 if (DevicePathStr != NULL) {\r
156 FreePool (DevicePathStr);\r
157 }\r
158 }\r
159 }\r
160 if (Handles != NULL) {\r
161 FreePool (Handles);\r
162 }\r
163}\r
164\r
165/**\r
166\r
167 Install Boot Device Selection Protocol\r
168\r
169 @param ImageHandle The image handle.\r
170 @param SystemTable The system table.\r
171\r
172 @retval EFI_SUCEESS BDS has finished initializing.\r
173 Return the dispatcher and recall BDS.Entry\r
174 @retval Other Return status from AllocatePool() or gBS->InstallProtocolInterface\r
175\r
176**/\r
177EFI_STATUS\r
178EFIAPI\r
179BdsInitialize (\r
180 IN EFI_HANDLE ImageHandle,\r
181 IN EFI_SYSTEM_TABLE *SystemTable\r
182 )\r
183{\r
184 EFI_STATUS Status;\r
185 EFI_HANDLE Handle;\r
186 //\r
187 // Install protocol interface\r
188 //\r
189 Handle = NULL;\r
190 Status = gBS->InstallMultipleProtocolInterfaces (\r
191 &Handle,\r
192 &gEfiBdsArchProtocolGuid, &gBds,\r
193 NULL\r
194 );\r
195 ASSERT_EFI_ERROR (Status);\r
196\r
197 DEBUG_CODE (\r
198 EFI_EVENT Event;\r
199 //\r
200 // Register notify function to check deferred images on ReadyToBoot Event.\r
201 //\r
202 Status = gBS->CreateEventEx (\r
203 EVT_NOTIFY_SIGNAL,\r
204 TPL_CALLBACK,\r
205 CheckDeferredLoadImageOnReadyToBoot,\r
206 NULL,\r
207 &gEfiEventReadyToBootGuid,\r
208 &Event\r
209 );\r
210 ASSERT_EFI_ERROR (Status);\r
211 );\r
212 return Status;\r
213}\r
214\r
215/**\r
216 Function waits for a given event to fire, or for an optional timeout to expire.\r
217\r
218 @param Event The event to wait for\r
219 @param Timeout An optional timeout value in 100 ns units.\r
220\r
221 @retval EFI_SUCCESS Event fired before Timeout expired.\r
222 @retval EFI_TIME_OUT Timout expired before Event fired..\r
223\r
224**/\r
225EFI_STATUS\r
226BdsWaitForSingleEvent (\r
227 IN EFI_EVENT Event,\r
228 IN UINT64 Timeout OPTIONAL\r
229 )\r
230{\r
231 UINTN Index;\r
232 EFI_STATUS Status;\r
233 EFI_EVENT TimerEvent;\r
234 EFI_EVENT WaitList[2];\r
235\r
236 if (Timeout != 0) {\r
237 //\r
238 // Create a timer event\r
239 //\r
240 Status = gBS->CreateEvent (EVT_TIMER, 0, NULL, NULL, &TimerEvent);\r
241 if (!EFI_ERROR (Status)) {\r
242 //\r
243 // Set the timer event\r
244 //\r
245 gBS->SetTimer (\r
246 TimerEvent,\r
247 TimerRelative,\r
248 Timeout\r
249 );\r
250\r
251 //\r
252 // Wait for the original event or the timer\r
253 //\r
254 WaitList[0] = Event;\r
255 WaitList[1] = TimerEvent;\r
256 Status = gBS->WaitForEvent (2, WaitList, &Index);\r
257 ASSERT_EFI_ERROR (Status);\r
258 gBS->CloseEvent (TimerEvent);\r
259\r
260 //\r
261 // If the timer expired, change the return to timed out\r
262 //\r
263 if (Index == 1) {\r
264 Status = EFI_TIMEOUT;\r
265 }\r
266 }\r
267 } else {\r
268 //\r
269 // No timeout... just wait on the event\r
270 //\r
271 Status = gBS->WaitForEvent (1, &Event, &Index);\r
272 ASSERT (!EFI_ERROR (Status));\r
273 ASSERT (Index == 0);\r
274 }\r
275\r
276 return Status;\r
277}\r
278\r
279/**\r
280 The function reads user inputs.\r
281\r
282**/\r
283VOID\r
284BdsReadKeys (\r
285 VOID\r
286 )\r
287{\r
288 EFI_STATUS Status;\r
289 EFI_INPUT_KEY Key;\r
290\r
291 if (PcdGetBool (PcdConInConnectOnDemand)) {\r
292 return;\r
293 }\r
294\r
295 while (gST->ConIn != NULL) {\r
296 \r
297 Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
298 \r
299 if (EFI_ERROR (Status)) {\r
300 //\r
301 // No more keys.\r
302 //\r
303 break;\r
304 }\r
305 }\r
306}\r
307\r
308/**\r
309 The function waits for the boot manager timeout expires or hotkey is pressed.\r
310\r
311 It calls PlatformBootManagerWaitCallback each second.\r
312\r
313 @param HotkeyTriggered Input hotkey event.\r
314**/\r
315VOID\r
316BdsWait (\r
317 IN EFI_EVENT HotkeyTriggered\r
318 )\r
319{\r
320 EFI_STATUS Status;\r
321 UINT16 TimeoutRemain;\r
322\r
323 DEBUG ((EFI_D_INFO, "[Bds]BdsWait ...Zzzzzzzzzzzz...\n"));\r
324\r
325 TimeoutRemain = PcdGet16 (PcdPlatformBootTimeOut);\r
326 while (TimeoutRemain != 0) {\r
327 DEBUG ((EFI_D_INFO, "[Bds]BdsWait(%d)..Zzzz...\n", (UINTN) TimeoutRemain));\r
328 PlatformBootManagerWaitCallback (TimeoutRemain);\r
329\r
330 BdsReadKeys (); // BUGBUG: Only reading can signal HotkeyTriggered\r
331 // Can be removed after all keyboard drivers invoke callback in timer callback.\r
332\r
333 if (HotkeyTriggered != NULL) {\r
334 Status = BdsWaitForSingleEvent (HotkeyTriggered, EFI_TIMER_PERIOD_SECONDS (1));\r
335 if (!EFI_ERROR (Status)) {\r
336 break;\r
337 }\r
338 } else {\r
339 gBS->Stall (1000000);\r
340 }\r
341\r
342 //\r
343 // 0xffff means waiting forever\r
344 // BDS with no hotkey provided and 0xffff as timeout will "hang" in the loop\r
345 //\r
346 if (TimeoutRemain != 0xffff) {\r
347 TimeoutRemain--;\r
348 }\r
349 }\r
350 DEBUG ((EFI_D_INFO, "[Bds]Exit the waiting!\n"));\r
351}\r
352\r
353/**\r
354 Attempt to boot each boot option in the BootOptions array.\r
355\r
356 @param BootOptions Input boot option array.\r
357 @param BootOptionCount Input boot option count.\r
358 @param BootManagerMenu Input boot manager menu.\r
359\r
360 @retval TRUE Successfully boot one of the boot options.\r
361 @retval FALSE Failed boot any of the boot options.\r
362**/\r
363BOOLEAN\r
364BootBootOptions (\r
365 IN EFI_BOOT_MANAGER_LOAD_OPTION *BootOptions,\r
366 IN UINTN BootOptionCount,\r
367 IN EFI_BOOT_MANAGER_LOAD_OPTION *BootManagerMenu OPTIONAL\r
368 )\r
369{\r
370 UINTN Index;\r
371\r
372 //\r
373 // Report Status Code to indicate BDS starts attempting booting from the UEFI BootOrder list.\r
374 //\r
375 REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_DXE_BS_PC_ATTEMPT_BOOT_ORDER_EVENT));\r
376\r
377 //\r
378 // Attempt boot each boot option\r
379 //\r
380 for (Index = 0; Index < BootOptionCount; Index++) {\r
381 //\r
382 // According to EFI Specification, if a load option is not marked\r
383 // as LOAD_OPTION_ACTIVE, the boot manager will not automatically\r
384 // load the option.\r
385 //\r
386 if ((BootOptions[Index].Attributes & LOAD_OPTION_ACTIVE) == 0) {\r
387 continue;\r
388 }\r
389\r
390 //\r
391 // Boot#### load options with LOAD_OPTION_CATEGORY_APP are executables which are not\r
392 // part of the normal boot processing. Boot options with reserved category values will be\r
393 // ignored by the boot manager.\r
394 //\r
395 if ((BootOptions[Index].Attributes & LOAD_OPTION_CATEGORY) != LOAD_OPTION_CATEGORY_BOOT) {\r
396 continue;\r
397 }\r
398\r
399 //\r
400 // All the driver options should have been processed since\r
401 // now boot will be performed.\r
402 //\r
403 EfiBootManagerBoot (&BootOptions[Index]);\r
404\r
405 //\r
406 // If the boot via Boot#### returns with a status of EFI_SUCCESS, platform firmware\r
407 // supports boot manager menu, and if firmware is configured to boot in an\r
408 // interactive mode, the boot manager will stop processing the BootOrder variable and\r
409 // present a boot manager menu to the user.\r
410 //\r
411 if ((BootManagerMenu != NULL) && (BootOptions[Index].Status == EFI_SUCCESS)) {\r
412 EfiBootManagerBoot (BootManagerMenu);\r
413 break;\r
414 }\r
415 }\r
416\r
417 return (BOOLEAN) (Index < BootOptionCount);\r
418}\r
419\r
420/**\r
421 The function will load and start every Driver####, SysPrep#### or PlatformRecovery####.\r
422\r
423 @param LoadOptions Load option array.\r
424 @param LoadOptionCount Load option count.\r
425**/\r
426VOID\r
427ProcessLoadOptions (\r
428 IN EFI_BOOT_MANAGER_LOAD_OPTION *LoadOptions,\r
429 IN UINTN LoadOptionCount\r
430 )\r
431{\r
432 EFI_STATUS Status;\r
433 UINTN Index;\r
434 BOOLEAN ReconnectAll;\r
435 EFI_BOOT_MANAGER_LOAD_OPTION_TYPE LoadOptionType;\r
436\r
437 ReconnectAll = FALSE;\r
438 LoadOptionType = LoadOptionTypeMax;\r
439\r
440 //\r
441 // Process the driver option\r
442 //\r
443 for (Index = 0; Index < LoadOptionCount; Index++) {\r
444 //\r
445 // All the load options in the array should be of the same type.\r
446 //\r
447 if (Index == 0) {\r
448 LoadOptionType = LoadOptions[Index].OptionType;\r
449 }\r
450 ASSERT (LoadOptionType == LoadOptions[Index].OptionType);\r
451 ASSERT (LoadOptionType != LoadOptionTypeBoot);\r
452\r
453 Status = EfiBootManagerProcessLoadOption (&LoadOptions[Index]);\r
454\r
455 //\r
456 // Status indicates whether the load option is loaded and executed\r
457 // LoadOptions[Index].Status is what the load option returns\r
458 //\r
459 if (!EFI_ERROR (Status)) {\r
460 //\r
461 // Stop processing if any PlatformRecovery#### returns success.\r
462 //\r
463 if ((LoadOptions[Index].Status == EFI_SUCCESS) &&\r
464 (LoadOptionType == LoadOptionTypePlatformRecovery)) {\r
465 break;\r
466 }\r
467\r
468 //\r
469 // Only set ReconnectAll flag when the load option executes successfully.\r
470 //\r
471 if (!EFI_ERROR (LoadOptions[Index].Status) &&\r
472 (LoadOptions[Index].Attributes & LOAD_OPTION_FORCE_RECONNECT) != 0) {\r
473 ReconnectAll = TRUE;\r
474 }\r
475 }\r
476 }\r
477\r
478 //\r
479 // If a driver load option is marked as LOAD_OPTION_FORCE_RECONNECT,\r
480 // then all of the EFI drivers in the system will be disconnected and\r
481 // reconnected after the last driver load option is processed.\r
482 //\r
483 if (ReconnectAll && LoadOptionType == LoadOptionTypeDriver) {\r
484 EfiBootManagerDisconnectAll ();\r
485 EfiBootManagerConnectAll ();\r
486 }\r
487}\r
488\r
489/**\r
490\r
491 Validate input console variable data. \r
492\r
493 If found the device path is not a valid device path, remove the variable.\r
494 \r
495 @param VariableName Input console variable name.\r
496\r
497**/\r
498VOID\r
499BdsFormalizeConsoleVariable (\r
500 IN CHAR16 *VariableName\r
501 )\r
502{\r
503 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
504 UINTN VariableSize;\r
505 EFI_STATUS Status;\r
506\r
507 GetEfiGlobalVariable2 (VariableName, (VOID **) &DevicePath, &VariableSize);\r
508 if ((DevicePath != NULL) && !IsDevicePathValid (DevicePath, VariableSize)) { \r
509 Status = gRT->SetVariable (\r
510 VariableName,\r
511 &gEfiGlobalVariableGuid,\r
512 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
513 0,\r
514 NULL\r
515 );\r
516 //\r
517 // Deleting variable with current variable implementation shouldn't fail.\r
518 //\r
519 ASSERT_EFI_ERROR (Status);\r
520 }\r
521\r
522 if (DevicePath != NULL) {\r
523 FreePool (DevicePath);\r
524 }\r
525}\r
526\r
527/**\r
528 Formalize OsIndication related variables. \r
529 \r
530 For OsIndicationsSupported, Create a BS/RT/UINT64 variable to report caps \r
531 Delete OsIndications variable if it is not NV/BS/RT UINT64.\r
532 \r
533 Item 3 is used to solve case when OS corrupts OsIndications. Here simply delete this NV variable.\r
534\r
535 Create a boot option for BootManagerMenu if it hasn't been created yet\r
536\r
537**/\r
538VOID \r
539BdsFormalizeOSIndicationVariable (\r
540 VOID\r
541 )\r
542{\r
543 EFI_STATUS Status;\r
544 UINT64 OsIndicationSupport;\r
545 UINT64 OsIndication;\r
546 UINTN DataSize;\r
547 UINT32 Attributes;\r
548 EFI_BOOT_MANAGER_LOAD_OPTION BootManagerMenu;\r
549\r
550 //\r
551 // OS indicater support variable\r
552 //\r
553 Status = EfiBootManagerGetBootManagerMenu (&BootManagerMenu);\r
554 if (Status != EFI_NOT_FOUND) {\r
555 OsIndicationSupport = EFI_OS_INDICATIONS_BOOT_TO_FW_UI | EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY;\r
556 EfiBootManagerFreeLoadOption (&BootManagerMenu);\r
557 } else {\r
558 OsIndicationSupport = EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY;\r
559 }\r
560\r
561 Status = gRT->SetVariable (\r
562 EFI_OS_INDICATIONS_SUPPORT_VARIABLE_NAME,\r
563 &gEfiGlobalVariableGuid,\r
564 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
565 sizeof(UINT64),\r
566 &OsIndicationSupport\r
567 );\r
568 //\r
569 // Platform needs to make sure setting volatile variable before calling 3rd party code shouldn't fail.\r
570 //\r
571 ASSERT_EFI_ERROR (Status);\r
572\r
573 //\r
574 // If OsIndications is invalid, remove it.\r
575 // Invalid case\r
576 // 1. Data size != UINT64\r
577 // 2. OsIndication value inconsistence\r
578 // 3. OsIndication attribute inconsistence\r
579 //\r
580 OsIndication = 0;\r
581 Attributes = 0;\r
582 DataSize = sizeof(UINT64);\r
583 Status = gRT->GetVariable (\r
584 EFI_OS_INDICATIONS_VARIABLE_NAME,\r
585 &gEfiGlobalVariableGuid,\r
586 &Attributes,\r
587 &DataSize,\r
588 &OsIndication\r
589 );\r
590 if (Status == EFI_NOT_FOUND) {\r
591 return;\r
592 }\r
593\r
594 if ((DataSize != sizeof (OsIndication)) ||\r
595 ((OsIndication & ~OsIndicationSupport) != 0) ||\r
596 (Attributes != (EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE))\r
597 ){\r
598\r
599 DEBUG ((EFI_D_ERROR, "[Bds] Unformalized OsIndications variable exists. Delete it\n"));\r
600 Status = gRT->SetVariable (\r
601 EFI_OS_INDICATIONS_VARIABLE_NAME,\r
602 &gEfiGlobalVariableGuid,\r
603 0,\r
604 0,\r
605 NULL\r
606 );\r
607 //\r
608 // Deleting variable with current variable implementation shouldn't fail.\r
609 //\r
610 ASSERT_EFI_ERROR(Status);\r
611 }\r
612}\r
613\r
614/**\r
615\r
616 Validate variables. \r
617\r
618**/\r
619VOID \r
620BdsFormalizeEfiGlobalVariable (\r
621 VOID\r
622 )\r
623{\r
624 //\r
625 // Validate Console variable.\r
626 //\r
627 BdsFormalizeConsoleVariable (EFI_CON_IN_VARIABLE_NAME);\r
628 BdsFormalizeConsoleVariable (EFI_CON_OUT_VARIABLE_NAME);\r
629 BdsFormalizeConsoleVariable (EFI_ERR_OUT_VARIABLE_NAME);\r
630\r
631 //\r
632 // Validate OSIndication related variable.\r
633 //\r
634 BdsFormalizeOSIndicationVariable ();\r
635}\r
636\r
637/**\r
638\r
639 Allocate a block of memory that will contain performance data to OS.\r
640\r
641**/\r
642VOID\r
643BdsAllocateMemoryForPerformanceData (\r
644 VOID\r
645 )\r
646{\r
647 EFI_STATUS Status;\r
648 EFI_PHYSICAL_ADDRESS AcpiLowMemoryBase;\r
649 EDKII_VARIABLE_LOCK_PROTOCOL *VariableLock;\r
650\r
651 AcpiLowMemoryBase = 0x0FFFFFFFFULL;\r
652\r
653 //\r
654 // Allocate a block of memory that will contain performance data to OS.\r
655 //\r
656 Status = gBS->AllocatePages (\r
657 AllocateMaxAddress,\r
658 EfiReservedMemoryType,\r
659 EFI_SIZE_TO_PAGES (PERF_DATA_MAX_LENGTH),\r
660 &AcpiLowMemoryBase\r
661 );\r
662 if (!EFI_ERROR (Status)) {\r
663 //\r
664 // Save the pointer to variable for use in S3 resume.\r
665 //\r
666 Status = BdsDxeSetVariableAndReportStatusCodeOnError (\r
667 L"PerfDataMemAddr",\r
668 &gPerformanceProtocolGuid,\r
669 EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
670 sizeof (EFI_PHYSICAL_ADDRESS),\r
671 &AcpiLowMemoryBase\r
672 );\r
673 if (EFI_ERROR (Status)) {\r
674 DEBUG ((EFI_D_ERROR, "[Bds] PerfDataMemAddr (%08x) cannot be saved to NV storage.\n", AcpiLowMemoryBase));\r
675 }\r
676 //\r
677 // Mark L"PerfDataMemAddr" variable to read-only if the Variable Lock protocol exists\r
678 // Still lock it even the variable cannot be saved to prevent it's set by 3rd party code.\r
679 //\r
680 Status = gBS->LocateProtocol (&gEdkiiVariableLockProtocolGuid, NULL, (VOID **) &VariableLock);\r
681 if (!EFI_ERROR (Status)) {\r
682 Status = VariableLock->RequestToLock (VariableLock, L"PerfDataMemAddr", &gPerformanceProtocolGuid);\r
683 ASSERT_EFI_ERROR (Status);\r
684 }\r
685 }\r
686}\r
687\r
688/**\r
689\r
690 Service routine for BdsInstance->Entry(). Devices are connected, the\r
691 consoles are initialized, and the boot options are tried.\r
692\r
693 @param This Protocol Instance structure.\r
694\r
695**/\r
696VOID\r
697EFIAPI\r
698BdsEntry (\r
699 IN EFI_BDS_ARCH_PROTOCOL *This\r
700 )\r
701{\r
702 EFI_BOOT_MANAGER_LOAD_OPTION *LoadOptions;\r
703 UINTN LoadOptionCount;\r
704 CHAR16 *FirmwareVendor;\r
705 EFI_EVENT HotkeyTriggered;\r
706 UINT64 OsIndication;\r
707 UINTN DataSize;\r
708 EFI_STATUS Status;\r
709 UINT32 BootOptionSupport;\r
710 UINT16 BootTimeOut;\r
711 EDKII_VARIABLE_LOCK_PROTOCOL *VariableLock;\r
712 UINTN Index;\r
713 EFI_BOOT_MANAGER_LOAD_OPTION LoadOption;\r
714 UINT16 *BootNext;\r
715 CHAR16 BootNextVariableName[sizeof ("Boot####")];\r
716 EFI_BOOT_MANAGER_LOAD_OPTION BootManagerMenu;\r
717 BOOLEAN BootFwUi;\r
718 BOOLEAN PlatformRecovery;\r
719 BOOLEAN BootSuccess;\r
720 EFI_DEVICE_PATH_PROTOCOL *FilePath;\r
721 EFI_STATUS BootManagerMenuStatus;\r
722\r
723 HotkeyTriggered = NULL;\r
724 Status = EFI_SUCCESS;\r
725 BootSuccess = FALSE;\r
726\r
727 //\r
728 // Insert the performance probe\r
729 //\r
730 PERF_END (NULL, "DXE", NULL, 0);\r
731 PERF_START (NULL, "BDS", NULL, 0);\r
732 DEBUG ((EFI_D_INFO, "[Bds] Entry...\n"));\r
733\r
734 PERF_CODE (\r
735 BdsAllocateMemoryForPerformanceData ();\r
736 );\r
737\r
738 //\r
739 // Fill in FirmwareVendor and FirmwareRevision from PCDs\r
740 //\r
741 FirmwareVendor = (CHAR16 *) PcdGetPtr (PcdFirmwareVendor);\r
742 gST->FirmwareVendor = AllocateRuntimeCopyPool (StrSize (FirmwareVendor), FirmwareVendor);\r
743 ASSERT (gST->FirmwareVendor != NULL);\r
744 gST->FirmwareRevision = PcdGet32 (PcdFirmwareRevision);\r
745\r
746 //\r
747 // Fixup Tasble CRC after we updated Firmware Vendor and Revision\r
748 //\r
749 gST->Hdr.CRC32 = 0;\r
750 gBS->CalculateCrc32 ((VOID *) gST, sizeof (EFI_SYSTEM_TABLE), &gST->Hdr.CRC32);\r
751\r
752 //\r
753 // Validate Variable.\r
754 //\r
755 BdsFormalizeEfiGlobalVariable ();\r
756\r
757 //\r
758 // Mark the read-only variables if the Variable Lock protocol exists\r
759 //\r
760 Status = gBS->LocateProtocol (&gEdkiiVariableLockProtocolGuid, NULL, (VOID **) &VariableLock);\r
761 DEBUG ((EFI_D_INFO, "[BdsDxe] Locate Variable Lock protocol - %r\n", Status));\r
762 if (!EFI_ERROR (Status)) {\r
763 for (Index = 0; Index < ARRAY_SIZE (mReadOnlyVariables); Index++) {\r
764 Status = VariableLock->RequestToLock (VariableLock, mReadOnlyVariables[Index], &gEfiGlobalVariableGuid);\r
765 ASSERT_EFI_ERROR (Status);\r
766 }\r
767 }\r
768\r
769 InitializeHwErrRecSupport ();\r
770\r
771 //\r
772 // Initialize L"Timeout" EFI global variable.\r
773 //\r
774 BootTimeOut = PcdGet16 (PcdPlatformBootTimeOut);\r
775 if (BootTimeOut != 0xFFFF) {\r
776 //\r
777 // If time out value equal 0xFFFF, no need set to 0xFFFF to variable area because UEFI specification\r
778 // define same behavior between no value or 0xFFFF value for L"Timeout".\r
779 //\r
780 BdsDxeSetVariableAndReportStatusCodeOnError (\r
781 EFI_TIME_OUT_VARIABLE_NAME,\r
782 &gEfiGlobalVariableGuid,\r
783 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
784 sizeof (UINT16),\r
785 &BootTimeOut\r
786 );\r
787 }\r
788\r
789 //\r
790 // Initialize L"BootOptionSupport" EFI global variable.\r
791 // Lazy-ConIn implictly disables BDS hotkey.\r
792 //\r
793 BootOptionSupport = EFI_BOOT_OPTION_SUPPORT_APP | EFI_BOOT_OPTION_SUPPORT_SYSPREP;\r
794 if (!PcdGetBool (PcdConInConnectOnDemand)) {\r
795 BootOptionSupport |= EFI_BOOT_OPTION_SUPPORT_KEY;\r
796 SET_BOOT_OPTION_SUPPORT_KEY_COUNT (BootOptionSupport, 3);\r
797 }\r
798 Status = gRT->SetVariable (\r
799 EFI_BOOT_OPTION_SUPPORT_VARIABLE_NAME,\r
800 &gEfiGlobalVariableGuid,\r
801 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
802 sizeof (BootOptionSupport),\r
803 &BootOptionSupport\r
804 );\r
805 //\r
806 // Platform needs to make sure setting volatile variable before calling 3rd party code shouldn't fail.\r
807 //\r
808 ASSERT_EFI_ERROR (Status);\r
809\r
810 //\r
811 // Cache the "BootNext" NV variable before calling any PlatformBootManagerLib APIs\r
812 // This could avoid the "BootNext" set by PlatformBootManagerLib be consumed in this boot.\r
813 //\r
814 GetEfiGlobalVariable2 (EFI_BOOT_NEXT_VARIABLE_NAME, (VOID **) &BootNext, &DataSize);\r
815 if (DataSize != sizeof (UINT16)) {\r
816 if (BootNext != NULL) {\r
817 FreePool (BootNext);\r
818 }\r
819 BootNext = NULL;\r
820 }\r
821\r
822 //\r
823 // Initialize the platform language variables\r
824 //\r
825 InitializeLanguage (TRUE);\r
826\r
827 //\r
828 // System firmware must include a PlatformRecovery#### variable specifying\r
829 // a short-form File Path Media Device Path containing the platform default\r
830 // file path for removable media\r
831 //\r
832 FilePath = FileDevicePath (NULL, EFI_REMOVABLE_MEDIA_FILE_NAME);\r
833 Status = EfiBootManagerInitializeLoadOption (\r
834 &LoadOption,\r
835 LoadOptionNumberUnassigned,\r
836 LoadOptionTypePlatformRecovery,\r
837 LOAD_OPTION_ACTIVE,\r
838 L"Default PlatformRecovery",\r
839 FilePath,\r
840 NULL,\r
841 0\r
842 );\r
843 ASSERT_EFI_ERROR (Status);\r
844 LoadOptions = EfiBootManagerGetLoadOptions (&LoadOptionCount, LoadOptionTypePlatformRecovery);\r
845 if (EfiBootManagerFindLoadOption (&LoadOption, LoadOptions, LoadOptionCount) == -1) {\r
846 for (Index = 0; Index < LoadOptionCount; Index++) {\r
847 //\r
848 // The PlatformRecovery#### options are sorted by OptionNumber.\r
849 // Find the the smallest unused number as the new OptionNumber.\r
850 //\r
851 if (LoadOptions[Index].OptionNumber != Index) {\r
852 break;\r
853 }\r
854 }\r
855 LoadOption.OptionNumber = Index;\r
856 Status = EfiBootManagerLoadOptionToVariable (&LoadOption);\r
857 ASSERT_EFI_ERROR (Status);\r
858 }\r
859 EfiBootManagerFreeLoadOption (&LoadOption);\r
860 FreePool (FilePath);\r
861 EfiBootManagerFreeLoadOptions (LoadOptions, LoadOptionCount);\r
862\r
863 //\r
864 // Report Status Code to indicate connecting drivers will happen\r
865 //\r
866 REPORT_STATUS_CODE (\r
867 EFI_PROGRESS_CODE,\r
868 (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_DXE_BS_PC_BEGIN_CONNECTING_DRIVERS)\r
869 );\r
870\r
871 //\r
872 // Initialize ConnectConIn event before calling platform code.\r
873 //\r
874 if (PcdGetBool (PcdConInConnectOnDemand)) {\r
875 Status = gBS->CreateEventEx (\r
876 EVT_NOTIFY_SIGNAL,\r
877 TPL_CALLBACK,\r
878 BdsDxeOnConnectConInCallBack,\r
879 NULL,\r
880 &gConnectConInEventGuid,\r
881 &gConnectConInEvent\r
882 );\r
883 if (EFI_ERROR (Status)) {\r
884 gConnectConInEvent = NULL;\r
885 }\r
886 }\r
887\r
888 //\r
889 // Do the platform init, can be customized by OEM/IBV\r
890 // Possible things that can be done in PlatformBootManagerBeforeConsole:\r
891 // > Update console variable: 1. include hot-plug devices; 2. Clear ConIn and add SOL for AMT\r
892 // > Register new Driver#### or Boot####\r
893 // > Register new Key####: e.g.: F12 \r
894 // > Signal ReadyToLock event\r
895 // > Authentication action: 1. connect Auth devices; 2. Identify auto logon user.\r
896 //\r
897 PERF_START (NULL, "PlatformBootManagerBeforeConsole", "BDS", 0);\r
898 PlatformBootManagerBeforeConsole ();\r
899 PERF_END (NULL, "PlatformBootManagerBeforeConsole", "BDS", 0);\r
900\r
901 //\r
902 // Initialize hotkey service\r
903 //\r
904 EfiBootManagerStartHotkeyService (&HotkeyTriggered);\r
905\r
906 //\r
907 // Execute Driver Options\r
908 //\r
909 LoadOptions = EfiBootManagerGetLoadOptions (&LoadOptionCount, LoadOptionTypeDriver);\r
910 ProcessLoadOptions (LoadOptions, LoadOptionCount);\r
911 EfiBootManagerFreeLoadOptions (LoadOptions, LoadOptionCount);\r
912\r
913 //\r
914 // Connect consoles\r
915 //\r
916 PERF_START (NULL, "EfiBootManagerConnectAllDefaultConsoles", "BDS", 0);\r
917 if (PcdGetBool (PcdConInConnectOnDemand)) {\r
918 EfiBootManagerConnectConsoleVariable (ConOut);\r
919 EfiBootManagerConnectConsoleVariable (ErrOut);\r
920 //\r
921 // Do not connect ConIn devices when lazy ConIn feature is ON.\r
922 //\r
923 } else {\r
924 EfiBootManagerConnectAllDefaultConsoles ();\r
925 }\r
926 PERF_END (NULL, "EfiBootManagerConnectAllDefaultConsoles", "BDS", 0);\r
927\r
928 //\r
929 // Do the platform specific action after the console is ready\r
930 // Possible things that can be done in PlatformBootManagerAfterConsole:\r
931 // > Console post action:\r
932 // > Dynamically switch output mode from 100x31 to 80x25 for certain senarino\r
933 // > Signal console ready platform customized event\r
934 // > Run diagnostics like memory testing\r
935 // > Connect certain devices\r
936 // > Dispatch aditional option roms\r
937 // > Special boot: e.g.: USB boot, enter UI\r
938 // \r
939 PERF_START (NULL, "PlatformBootManagerAfterConsole", "BDS", 0);\r
940 PlatformBootManagerAfterConsole ();\r
941 PERF_END (NULL, "PlatformBootManagerAfterConsole", "BDS", 0);\r
942 //\r
943 // Boot to Boot Manager Menu when EFI_OS_INDICATIONS_BOOT_TO_FW_UI is set. Skip HotkeyBoot\r
944 //\r
945 DataSize = sizeof (UINT64);\r
946 Status = gRT->GetVariable (\r
947 EFI_OS_INDICATIONS_VARIABLE_NAME,\r
948 &gEfiGlobalVariableGuid,\r
949 NULL,\r
950 &DataSize,\r
951 &OsIndication\r
952 );\r
953 if (EFI_ERROR (Status)) {\r
954 OsIndication = 0;\r
955 }\r
956\r
957 DEBUG_CODE (\r
958 EFI_BOOT_MANAGER_LOAD_OPTION_TYPE LoadOptionType;\r
959 DEBUG ((EFI_D_INFO, "[Bds]OsIndication: %016x\n", OsIndication));\r
960 DEBUG ((EFI_D_INFO, "[Bds]=============Begin Load Options Dumping ...=============\n"));\r
961 for (LoadOptionType = 0; LoadOptionType < LoadOptionTypeMax; LoadOptionType++) {\r
962 DEBUG ((\r
963 EFI_D_INFO, " %s Options:\n",\r
964 mBdsLoadOptionName[LoadOptionType]\r
965 ));\r
966 LoadOptions = EfiBootManagerGetLoadOptions (&LoadOptionCount, LoadOptionType);\r
967 for (Index = 0; Index < LoadOptionCount; Index++) {\r
968 DEBUG ((\r
969 EFI_D_INFO, " %s%04x: %s \t\t 0x%04x\n",\r
970 mBdsLoadOptionName[LoadOptionType],\r
971 LoadOptions[Index].OptionNumber,\r
972 LoadOptions[Index].Description,\r
973 LoadOptions[Index].Attributes\r
974 ));\r
975 }\r
976 EfiBootManagerFreeLoadOptions (LoadOptions, LoadOptionCount);\r
977 }\r
978 DEBUG ((EFI_D_INFO, "[Bds]=============End Load Options Dumping=============\n"));\r
979 );\r
980\r
981 //\r
982 // BootManagerMenu doesn't contain the correct information when return status is EFI_NOT_FOUND.\r
983 //\r
984 BootManagerMenuStatus = EfiBootManagerGetBootManagerMenu (&BootManagerMenu);\r
985\r
986 BootFwUi = (BOOLEAN) ((OsIndication & EFI_OS_INDICATIONS_BOOT_TO_FW_UI) != 0);\r
987 PlatformRecovery = (BOOLEAN) ((OsIndication & EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY) != 0);\r
988 //\r
989 // Clear EFI_OS_INDICATIONS_BOOT_TO_FW_UI to acknowledge OS\r
990 // \r
991 if (BootFwUi || PlatformRecovery) {\r
992 OsIndication &= ~((UINT64) (EFI_OS_INDICATIONS_BOOT_TO_FW_UI | EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY));\r
993 Status = gRT->SetVariable (\r
994 EFI_OS_INDICATIONS_VARIABLE_NAME,\r
995 &gEfiGlobalVariableGuid,\r
996 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
997 sizeof(UINT64),\r
998 &OsIndication\r
999 );\r
1000 //\r
1001 // Changing the content without increasing its size with current variable implementation shouldn't fail.\r
1002 //\r
1003 ASSERT_EFI_ERROR (Status);\r
1004 }\r
1005\r
1006 //\r
1007 // Launch Boot Manager Menu directly when EFI_OS_INDICATIONS_BOOT_TO_FW_UI is set. Skip HotkeyBoot\r
1008 //\r
1009 if (BootFwUi && (BootManagerMenuStatus != EFI_NOT_FOUND)) {\r
1010 //\r
1011 // Follow generic rule, Call BdsDxeOnConnectConInCallBack to connect ConIn before enter UI\r
1012 //\r
1013 if (PcdGetBool (PcdConInConnectOnDemand)) {\r
1014 BdsDxeOnConnectConInCallBack (NULL, NULL);\r
1015 }\r
1016\r
1017 //\r
1018 // Directly enter the setup page.\r
1019 //\r
1020 EfiBootManagerBoot (&BootManagerMenu);\r
1021 }\r
1022\r
1023 if (!PlatformRecovery) {\r
1024 //\r
1025 // Execute SysPrep####\r
1026 //\r
1027 LoadOptions = EfiBootManagerGetLoadOptions (&LoadOptionCount, LoadOptionTypeSysPrep);\r
1028 ProcessLoadOptions (LoadOptions, LoadOptionCount);\r
1029 EfiBootManagerFreeLoadOptions (LoadOptions, LoadOptionCount);\r
1030\r
1031 //\r
1032 // Execute Key####\r
1033 //\r
1034 PERF_START (NULL, "BdsWait", "BDS", 0);\r
1035 BdsWait (HotkeyTriggered);\r
1036 PERF_END (NULL, "BdsWait", "BDS", 0);\r
1037\r
1038 //\r
1039 // BdsReadKeys() can be removed after all keyboard drivers invoke callback in timer callback.\r
1040 //\r
1041 BdsReadKeys ();\r
1042\r
1043 EfiBootManagerHotkeyBoot ();\r
1044\r
1045 if (BootNext != NULL) {\r
1046 //\r
1047 // Delete "BootNext" NV variable before transferring control to it to prevent loops.\r
1048 //\r
1049 Status = gRT->SetVariable (\r
1050 EFI_BOOT_NEXT_VARIABLE_NAME,\r
1051 &gEfiGlobalVariableGuid,\r
1052 0,\r
1053 0,\r
1054 NULL\r
1055 );\r
1056 //\r
1057 // Deleting NV variable shouldn't fail unless it doesn't exist.\r
1058 //\r
1059 ASSERT (Status == EFI_SUCCESS || Status == EFI_NOT_FOUND);\r
1060\r
1061 //\r
1062 // Boot to "BootNext"\r
1063 //\r
1064 UnicodeSPrint (BootNextVariableName, sizeof (BootNextVariableName), L"Boot%04x", *BootNext);\r
1065 Status = EfiBootManagerVariableToLoadOption (BootNextVariableName, &LoadOption);\r
1066 if (!EFI_ERROR (Status)) {\r
1067 EfiBootManagerBoot (&LoadOption);\r
1068 EfiBootManagerFreeLoadOption (&LoadOption);\r
1069 if ((LoadOption.Status == EFI_SUCCESS) && \r
1070 (BootManagerMenuStatus != EFI_NOT_FOUND) &&\r
1071 (LoadOption.OptionNumber != BootManagerMenu.OptionNumber)) {\r
1072 //\r
1073 // Boot to Boot Manager Menu upon EFI_SUCCESS\r
1074 // Exception: Do not boot again when the BootNext points to Boot Manager Menu.\r
1075 //\r
1076 EfiBootManagerBoot (&BootManagerMenu);\r
1077 }\r
1078 }\r
1079 }\r
1080\r
1081 do {\r
1082 //\r
1083 // Retry to boot if any of the boot succeeds\r
1084 //\r
1085 LoadOptions = EfiBootManagerGetLoadOptions (&LoadOptionCount, LoadOptionTypeBoot);\r
1086 BootSuccess = BootBootOptions (LoadOptions, LoadOptionCount, (BootManagerMenuStatus != EFI_NOT_FOUND) ? &BootManagerMenu : NULL);\r
1087 EfiBootManagerFreeLoadOptions (LoadOptions, LoadOptionCount);\r
1088 } while (BootSuccess);\r
1089 }\r
1090\r
1091 if (BootManagerMenuStatus != EFI_NOT_FOUND) {\r
1092 EfiBootManagerFreeLoadOption (&BootManagerMenu);\r
1093 }\r
1094\r
1095 if (!BootSuccess) {\r
1096 LoadOptions = EfiBootManagerGetLoadOptions (&LoadOptionCount, LoadOptionTypePlatformRecovery);\r
1097 ProcessLoadOptions (LoadOptions, LoadOptionCount);\r
1098 EfiBootManagerFreeLoadOptions (LoadOptions, LoadOptionCount);\r
1099 }\r
1100\r
1101 DEBUG ((EFI_D_ERROR, "[Bds] Unable to boot!\n"));\r
1102 CpuDeadLoop ();\r
1103}\r
1104\r
1105/**\r
1106 Set the variable and report the error through status code upon failure.\r
1107\r
1108 @param VariableName A Null-terminated string that is the name of the vendor's variable.\r
1109 Each VariableName is unique for each VendorGuid. VariableName must\r
1110 contain 1 or more characters. If VariableName is an empty string,\r
1111 then EFI_INVALID_PARAMETER is returned.\r
1112 @param VendorGuid A unique identifier for the vendor.\r
1113 @param Attributes Attributes bitmask to set for the variable.\r
1114 @param DataSize The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE, \r
1115 or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero\r
1116 causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is \r
1117 set, then a SetVariable() call with a DataSize of zero will not cause any change to \r
1118 the variable value (the timestamp associated with the variable may be updated however \r
1119 even if no new data value is provided,see the description of the \r
1120 EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not \r
1121 be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated). \r
1122 @param Data The contents for the variable.\r
1123\r
1124 @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as\r
1125 defined by the Attributes.\r
1126 @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, and GUID was supplied, or the\r
1127 DataSize exceeds the maximum allowed.\r
1128 @retval EFI_INVALID_PARAMETER VariableName is an empty string.\r
1129 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r
1130 @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r
1131 @retval EFI_WRITE_PROTECTED The variable in question is read-only.\r
1132 @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.\r
1133 @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS\r
1134 being set, but the AuthInfo does NOT pass the validation check carried out by the firmware.\r
1135\r
1136 @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.\r
1137**/\r
1138EFI_STATUS\r
1139BdsDxeSetVariableAndReportStatusCodeOnError (\r
1140 IN CHAR16 *VariableName,\r
1141 IN EFI_GUID *VendorGuid,\r
1142 IN UINT32 Attributes,\r
1143 IN UINTN DataSize,\r
1144 IN VOID *Data\r
1145 )\r
1146{\r
1147 EFI_STATUS Status;\r
1148 EDKII_SET_VARIABLE_STATUS *SetVariableStatus;\r
1149 UINTN NameSize;\r
1150\r
1151 Status = gRT->SetVariable (\r
1152 VariableName,\r
1153 VendorGuid,\r
1154 Attributes,\r
1155 DataSize,\r
1156 Data\r
1157 );\r
1158 if (EFI_ERROR (Status)) {\r
1159 NameSize = StrSize (VariableName);\r
1160 SetVariableStatus = AllocatePool (sizeof (EDKII_SET_VARIABLE_STATUS) + NameSize + DataSize);\r
1161 if (SetVariableStatus != NULL) {\r
1162 CopyGuid (&SetVariableStatus->Guid, VendorGuid);\r
1163 SetVariableStatus->NameSize = NameSize;\r
1164 SetVariableStatus->DataSize = DataSize;\r
1165 SetVariableStatus->SetStatus = Status;\r
1166 SetVariableStatus->Attributes = Attributes;\r
1167 CopyMem (SetVariableStatus + 1, VariableName, NameSize);\r
1168 CopyMem (((UINT8 *) (SetVariableStatus + 1)) + NameSize, Data, DataSize);\r
1169\r
1170 REPORT_STATUS_CODE_EX (\r
1171 EFI_ERROR_CODE,\r
1172 PcdGet32 (PcdErrorCodeSetVariable),\r
1173 0,\r
1174 NULL,\r
1175 &gEdkiiStatusCodeDataTypeVariableGuid,\r
1176 SetVariableStatus,\r
1177 sizeof (EDKII_SET_VARIABLE_STATUS) + NameSize + DataSize\r
1178 );\r
1179\r
1180 FreePool (SetVariableStatus);\r
1181 }\r
1182 }\r
1183\r
1184 return Status;\r
1185}\r