]>
Commit | Line | Data |
---|---|---|
f4cd24da RN |
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 | |
f5cbc197 | 8 | Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>\r |
e58f1ae5 SW |
9 | (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r |
10 | (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r | |
f4cd24da RN |
11 | This program and the accompanying materials\r |
12 | are licensed and made available under the terms and conditions of the BSD License\r | |
13 | which accompanies this distribution. The full text of the license may be found at\r | |
14 | http://opensource.org/licenses/bsd-license.php\r | |
15 | \r | |
16 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
17 | WITHOUT 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 | |
32 | EFI_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 | |
39 | EFI_EVENT gConnectConInEvent = NULL;\r | |
40 | \r | |
41 | ///\r | |
42 | /// The read-only variables defined in UEFI Spec.\r | |
43 | ///\r | |
44 | CHAR16 *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 | |
1634214d RN |
52 | CHAR16 *mBdsLoadOptionName[] = {\r |
53 | L"Driver",\r | |
54 | L"SysPrep",\r | |
68456d8a RN |
55 | L"Boot",\r |
56 | L"PlatformRecovery"\r | |
1634214d RN |
57 | };\r |
58 | \r | |
f4cd24da RN |
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 | |
67 | VOID\r | |
68 | EFIAPI\r | |
69 | BdsDxeOnConnectConInCallBack (\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 | |
1634214d | 86 | DEBUG ((EFI_D_WARN, "[Bds] Connect ConIn failed - %r!!!\n", Status));\r |
f4cd24da RN |
87 | }\r |
88 | }\r | |
048bcba1 RN |
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 | |
97 | VOID\r | |
98 | EFIAPI\r | |
99 | CheckDeferredLoadImageOnReadyToBoot (\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 | |
f4cd24da RN |
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 | |
177 | EFI_STATUS\r | |
178 | EFIAPI\r | |
179 | BdsInitialize (\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 | |
048bcba1 RN |
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 | |
f4cd24da RN |
212 | return Status;\r |
213 | }\r | |
214 | \r | |
f4cd24da RN |
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 | |
225 | EFI_STATUS\r | |
226 | BdsWaitForSingleEvent (\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 | |
283 | VOID\r | |
284 | BdsReadKeys (\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 | |
315 | VOID\r | |
316 | BdsWait (\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 | |
68456d8a | 358 | @param BootManagerMenu Input boot manager menu.\r |
f4cd24da RN |
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 | |
363 | BOOLEAN\r | |
68456d8a | 364 | BootBootOptions (\r |
f4cd24da | 365 | IN EFI_BOOT_MANAGER_LOAD_OPTION *BootOptions,\r |
68456d8a | 366 | IN UINTN BootOptionCount,\r |
e58f1ae5 | 367 | IN EFI_BOOT_MANAGER_LOAD_OPTION *BootManagerMenu OPTIONAL\r |
f4cd24da RN |
368 | )\r |
369 | {\r | |
370 | UINTN Index;\r | |
371 | \r | |
372 | //\r | |
373 | // Attempt boot each boot option\r | |
374 | //\r | |
375 | for (Index = 0; Index < BootOptionCount; Index++) {\r | |
376 | //\r | |
377 | // According to EFI Specification, if a load option is not marked\r | |
378 | // as LOAD_OPTION_ACTIVE, the boot manager will not automatically\r | |
379 | // load the option.\r | |
380 | //\r | |
381 | if ((BootOptions[Index].Attributes & LOAD_OPTION_ACTIVE) == 0) {\r | |
382 | continue;\r | |
383 | }\r | |
384 | \r | |
385 | //\r | |
386 | // Boot#### load options with LOAD_OPTION_CATEGORY_APP are executables which are not\r | |
387 | // part of the normal boot processing. Boot options with reserved category values will be\r | |
388 | // ignored by the boot manager.\r | |
389 | //\r | |
390 | if ((BootOptions[Index].Attributes & LOAD_OPTION_CATEGORY) != LOAD_OPTION_CATEGORY_BOOT) {\r | |
391 | continue;\r | |
392 | }\r | |
393 | \r | |
394 | //\r | |
395 | // All the driver options should have been processed since\r | |
396 | // now boot will be performed.\r | |
397 | //\r | |
398 | EfiBootManagerBoot (&BootOptions[Index]);\r | |
399 | \r | |
400 | //\r | |
311b5a6f ED |
401 | // If the boot via Boot#### returns with a status of EFI_SUCCESS, platform firmware\r |
402 | // supports boot manager menu, and if firmware is configured to boot in an\r | |
403 | // interactive mode, the boot manager will stop processing the BootOrder variable and\r | |
404 | // present a boot manager menu to the user.\r | |
f4cd24da | 405 | //\r |
e58f1ae5 | 406 | if ((BootManagerMenu != NULL) && (BootOptions[Index].Status == EFI_SUCCESS)) {\r |
68456d8a | 407 | EfiBootManagerBoot (BootManagerMenu);\r |
f4cd24da RN |
408 | break;\r |
409 | }\r | |
410 | }\r | |
411 | \r | |
412 | return (BOOLEAN) (Index < BootOptionCount);\r | |
413 | }\r | |
414 | \r | |
415 | /**\r | |
68456d8a | 416 | The function will load and start every Driver####, SysPrep#### or PlatformRecovery####.\r |
f4cd24da | 417 | \r |
1634214d RN |
418 | @param LoadOptions Load option array.\r |
419 | @param LoadOptionCount Load option count.\r | |
f4cd24da RN |
420 | **/\r |
421 | VOID\r | |
1634214d RN |
422 | ProcessLoadOptions (\r |
423 | IN EFI_BOOT_MANAGER_LOAD_OPTION *LoadOptions,\r | |
424 | IN UINTN LoadOptionCount\r | |
f4cd24da RN |
425 | )\r |
426 | {\r | |
1634214d RN |
427 | EFI_STATUS Status;\r |
428 | UINTN Index;\r | |
429 | BOOLEAN ReconnectAll;\r | |
430 | EFI_BOOT_MANAGER_LOAD_OPTION_TYPE LoadOptionType;\r | |
f4cd24da | 431 | \r |
68456d8a | 432 | ReconnectAll = FALSE;\r |
1634214d | 433 | LoadOptionType = LoadOptionTypeMax;\r |
f4cd24da RN |
434 | \r |
435 | //\r | |
436 | // Process the driver option\r | |
437 | //\r | |
1634214d | 438 | for (Index = 0; Index < LoadOptionCount; Index++) {\r |
f4cd24da | 439 | //\r |
1634214d | 440 | // All the load options in the array should be of the same type.\r |
f4cd24da | 441 | //\r |
68456d8a | 442 | if (Index == 0) {\r |
1634214d | 443 | LoadOptionType = LoadOptions[Index].OptionType;\r |
f4cd24da | 444 | }\r |
1634214d | 445 | ASSERT (LoadOptionType == LoadOptions[Index].OptionType);\r |
de67c35c | 446 | ASSERT (LoadOptionType != LoadOptionTypeBoot);\r |
f4cd24da | 447 | \r |
1634214d | 448 | Status = EfiBootManagerProcessLoadOption (&LoadOptions[Index]);\r |
f4cd24da | 449 | \r |
de67c35c RN |
450 | //\r |
451 | // Status indicates whether the load option is loaded and executed\r | |
452 | // LoadOptions[Index].Status is what the load option returns\r | |
453 | //\r | |
68456d8a | 454 | if (!EFI_ERROR (Status)) {\r |
de67c35c RN |
455 | //\r |
456 | // Stop processing if any PlatformRecovery#### returns success.\r | |
457 | //\r | |
458 | if ((LoadOptions[Index].Status == EFI_SUCCESS) &&\r | |
459 | (LoadOptionType == LoadOptionTypePlatformRecovery)) {\r | |
68456d8a RN |
460 | break;\r |
461 | }\r | |
de67c35c RN |
462 | \r |
463 | //\r | |
464 | // Only set ReconnectAll flag when the load option executes successfully.\r | |
465 | //\r | |
466 | if (!EFI_ERROR (LoadOptions[Index].Status) &&\r | |
467 | (LoadOptions[Index].Attributes & LOAD_OPTION_FORCE_RECONNECT) != 0) {\r | |
68456d8a RN |
468 | ReconnectAll = TRUE;\r |
469 | }\r | |
f4cd24da RN |
470 | }\r |
471 | }\r | |
1634214d | 472 | \r |
f4cd24da | 473 | //\r |
1634214d RN |
474 | // If a driver load option is marked as LOAD_OPTION_FORCE_RECONNECT,\r |
475 | // then all of the EFI drivers in the system will be disconnected and\r | |
476 | // reconnected after the last driver load option is processed.\r | |
f4cd24da | 477 | //\r |
1634214d | 478 | if (ReconnectAll && LoadOptionType == LoadOptionTypeDriver) {\r |
f4cd24da RN |
479 | EfiBootManagerDisconnectAll ();\r |
480 | EfiBootManagerConnectAll ();\r | |
481 | }\r | |
f4cd24da RN |
482 | }\r |
483 | \r | |
484 | /**\r | |
485 | \r | |
486 | Validate input console variable data. \r | |
487 | \r | |
488 | If found the device path is not a valid device path, remove the variable.\r | |
489 | \r | |
490 | @param VariableName Input console variable name.\r | |
491 | \r | |
492 | **/\r | |
493 | VOID\r | |
494 | BdsFormalizeConsoleVariable (\r | |
495 | IN CHAR16 *VariableName\r | |
496 | )\r | |
497 | {\r | |
498 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
499 | UINTN VariableSize;\r | |
500 | EFI_STATUS Status;\r | |
501 | \r | |
502 | GetEfiGlobalVariable2 (VariableName, (VOID **) &DevicePath, &VariableSize);\r | |
503 | if ((DevicePath != NULL) && !IsDevicePathValid (DevicePath, VariableSize)) { \r | |
504 | Status = gRT->SetVariable (\r | |
505 | VariableName,\r | |
506 | &gEfiGlobalVariableGuid,\r | |
507 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r | |
508 | 0,\r | |
509 | NULL\r | |
510 | );\r | |
511 | //\r | |
512 | // Deleting variable with current variable implementation shouldn't fail.\r | |
513 | //\r | |
514 | ASSERT_EFI_ERROR (Status);\r | |
515 | }\r | |
516 | \r | |
517 | if (DevicePath != NULL) {\r | |
518 | FreePool (DevicePath);\r | |
519 | }\r | |
520 | }\r | |
521 | \r | |
522 | /**\r | |
523 | Formalize OsIndication related variables. \r | |
524 | \r | |
525 | For OsIndicationsSupported, Create a BS/RT/UINT64 variable to report caps \r | |
526 | Delete OsIndications variable if it is not NV/BS/RT UINT64.\r | |
527 | \r | |
528 | Item 3 is used to solve case when OS corrupts OsIndications. Here simply delete this NV variable.\r | |
529 | \r | |
e58f1ae5 SW |
530 | Create a boot option for BootManagerMenu if it hasn't been created yet\r |
531 | \r | |
f4cd24da RN |
532 | **/\r |
533 | VOID \r | |
534 | BdsFormalizeOSIndicationVariable (\r | |
535 | VOID\r | |
536 | )\r | |
537 | {\r | |
e58f1ae5 SW |
538 | EFI_STATUS Status;\r |
539 | UINT64 OsIndicationSupport;\r | |
540 | UINT64 OsIndication;\r | |
541 | UINTN DataSize;\r | |
542 | UINT32 Attributes;\r | |
543 | EFI_BOOT_MANAGER_LOAD_OPTION BootManagerMenu;\r | |
f4cd24da RN |
544 | \r |
545 | //\r | |
546 | // OS indicater support variable\r | |
547 | //\r | |
e58f1ae5 SW |
548 | Status = EfiBootManagerGetBootManagerMenu (&BootManagerMenu);\r |
549 | if (Status != EFI_NOT_FOUND) {\r | |
550 | OsIndicationSupport = EFI_OS_INDICATIONS_BOOT_TO_FW_UI | EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY;\r | |
551 | EfiBootManagerFreeLoadOption (&BootManagerMenu);\r | |
552 | } else {\r | |
553 | OsIndicationSupport = EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY;\r | |
554 | }\r | |
555 | \r | |
f4cd24da | 556 | Status = gRT->SetVariable (\r |
cc4812f6 | 557 | EFI_OS_INDICATIONS_SUPPORT_VARIABLE_NAME,\r |
f4cd24da RN |
558 | &gEfiGlobalVariableGuid,\r |
559 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r | |
560 | sizeof(UINT64),\r | |
561 | &OsIndicationSupport\r | |
562 | );\r | |
563 | //\r | |
564 | // Platform needs to make sure setting volatile variable before calling 3rd party code shouldn't fail.\r | |
565 | //\r | |
566 | ASSERT_EFI_ERROR (Status);\r | |
567 | \r | |
568 | //\r | |
569 | // If OsIndications is invalid, remove it.\r | |
570 | // Invalid case\r | |
571 | // 1. Data size != UINT64\r | |
572 | // 2. OsIndication value inconsistence\r | |
573 | // 3. OsIndication attribute inconsistence\r | |
574 | //\r | |
575 | OsIndication = 0;\r | |
576 | Attributes = 0;\r | |
577 | DataSize = sizeof(UINT64);\r | |
578 | Status = gRT->GetVariable (\r | |
cc4812f6 | 579 | EFI_OS_INDICATIONS_VARIABLE_NAME,\r |
f4cd24da RN |
580 | &gEfiGlobalVariableGuid,\r |
581 | &Attributes,\r | |
582 | &DataSize,\r | |
583 | &OsIndication\r | |
584 | );\r | |
585 | if (Status == EFI_NOT_FOUND) {\r | |
586 | return;\r | |
587 | }\r | |
588 | \r | |
589 | if ((DataSize != sizeof (OsIndication)) ||\r | |
590 | ((OsIndication & ~OsIndicationSupport) != 0) ||\r | |
591 | (Attributes != (EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE))\r | |
592 | ){\r | |
593 | \r | |
594 | DEBUG ((EFI_D_ERROR, "[Bds] Unformalized OsIndications variable exists. Delete it\n"));\r | |
595 | Status = gRT->SetVariable (\r | |
cc4812f6 | 596 | EFI_OS_INDICATIONS_VARIABLE_NAME,\r |
f4cd24da RN |
597 | &gEfiGlobalVariableGuid,\r |
598 | 0,\r | |
599 | 0,\r | |
600 | NULL\r | |
601 | );\r | |
602 | //\r | |
603 | // Deleting variable with current variable implementation shouldn't fail.\r | |
604 | //\r | |
605 | ASSERT_EFI_ERROR(Status);\r | |
606 | }\r | |
607 | }\r | |
608 | \r | |
609 | /**\r | |
610 | \r | |
611 | Validate variables. \r | |
612 | \r | |
613 | **/\r | |
614 | VOID \r | |
615 | BdsFormalizeEfiGlobalVariable (\r | |
616 | VOID\r | |
617 | )\r | |
618 | {\r | |
619 | //\r | |
620 | // Validate Console variable.\r | |
621 | //\r | |
cc4812f6 RN |
622 | BdsFormalizeConsoleVariable (EFI_CON_IN_VARIABLE_NAME);\r |
623 | BdsFormalizeConsoleVariable (EFI_CON_OUT_VARIABLE_NAME);\r | |
624 | BdsFormalizeConsoleVariable (EFI_ERR_OUT_VARIABLE_NAME);\r | |
f4cd24da RN |
625 | \r |
626 | //\r | |
627 | // Validate OSIndication related variable.\r | |
628 | //\r | |
629 | BdsFormalizeOSIndicationVariable ();\r | |
630 | }\r | |
631 | \r | |
632 | /**\r | |
633 | \r | |
634 | Allocate a block of memory that will contain performance data to OS.\r | |
635 | \r | |
636 | **/\r | |
637 | VOID\r | |
638 | BdsAllocateMemoryForPerformanceData (\r | |
639 | VOID\r | |
640 | )\r | |
641 | {\r | |
642 | EFI_STATUS Status;\r | |
643 | EFI_PHYSICAL_ADDRESS AcpiLowMemoryBase;\r | |
644 | EDKII_VARIABLE_LOCK_PROTOCOL *VariableLock;\r | |
645 | \r | |
646 | AcpiLowMemoryBase = 0x0FFFFFFFFULL;\r | |
647 | \r | |
648 | //\r | |
649 | // Allocate a block of memory that will contain performance data to OS.\r | |
650 | //\r | |
651 | Status = gBS->AllocatePages (\r | |
652 | AllocateMaxAddress,\r | |
653 | EfiReservedMemoryType,\r | |
654 | EFI_SIZE_TO_PAGES (PERF_DATA_MAX_LENGTH),\r | |
655 | &AcpiLowMemoryBase\r | |
656 | );\r | |
657 | if (!EFI_ERROR (Status)) {\r | |
658 | //\r | |
659 | // Save the pointer to variable for use in S3 resume.\r | |
660 | //\r | |
661 | Status = BdsDxeSetVariableAndReportStatusCodeOnError (\r | |
662 | L"PerfDataMemAddr",\r | |
663 | &gPerformanceProtocolGuid,\r | |
664 | EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r | |
665 | sizeof (EFI_PHYSICAL_ADDRESS),\r | |
666 | &AcpiLowMemoryBase\r | |
667 | );\r | |
668 | if (EFI_ERROR (Status)) {\r | |
669 | DEBUG ((EFI_D_ERROR, "[Bds] PerfDataMemAddr (%08x) cannot be saved to NV storage.\n", AcpiLowMemoryBase));\r | |
670 | }\r | |
671 | //\r | |
672 | // Mark L"PerfDataMemAddr" variable to read-only if the Variable Lock protocol exists\r | |
673 | // Still lock it even the variable cannot be saved to prevent it's set by 3rd party code.\r | |
674 | //\r | |
675 | Status = gBS->LocateProtocol (&gEdkiiVariableLockProtocolGuid, NULL, (VOID **) &VariableLock);\r | |
676 | if (!EFI_ERROR (Status)) {\r | |
677 | Status = VariableLock->RequestToLock (VariableLock, L"PerfDataMemAddr", &gPerformanceProtocolGuid);\r | |
678 | ASSERT_EFI_ERROR (Status);\r | |
679 | }\r | |
680 | }\r | |
681 | }\r | |
682 | \r | |
683 | /**\r | |
684 | \r | |
685 | Service routine for BdsInstance->Entry(). Devices are connected, the\r | |
686 | consoles are initialized, and the boot options are tried.\r | |
687 | \r | |
688 | @param This Protocol Instance structure.\r | |
689 | \r | |
690 | **/\r | |
691 | VOID\r | |
692 | EFIAPI\r | |
693 | BdsEntry (\r | |
694 | IN EFI_BDS_ARCH_PROTOCOL *This\r | |
695 | )\r | |
696 | {\r | |
1634214d RN |
697 | EFI_BOOT_MANAGER_LOAD_OPTION *LoadOptions;\r |
698 | UINTN LoadOptionCount;\r | |
f4cd24da RN |
699 | CHAR16 *FirmwareVendor;\r |
700 | EFI_EVENT HotkeyTriggered;\r | |
701 | UINT64 OsIndication;\r | |
702 | UINTN DataSize;\r | |
703 | EFI_STATUS Status;\r | |
704 | UINT32 BootOptionSupport;\r | |
705 | UINT16 BootTimeOut;\r | |
706 | EDKII_VARIABLE_LOCK_PROTOCOL *VariableLock;\r | |
707 | UINTN Index;\r | |
d175f4e6 | 708 | EFI_BOOT_MANAGER_LOAD_OPTION LoadOption;\r |
f4cd24da RN |
709 | UINT16 *BootNext;\r |
710 | CHAR16 BootNextVariableName[sizeof ("Boot####")];\r | |
1634214d RN |
711 | EFI_BOOT_MANAGER_LOAD_OPTION BootManagerMenu;\r |
712 | BOOLEAN BootFwUi;\r | |
68456d8a RN |
713 | BOOLEAN PlatformRecovery;\r |
714 | BOOLEAN BootSuccess;\r | |
d175f4e6 | 715 | EFI_DEVICE_PATH_PROTOCOL *FilePath;\r |
e58f1ae5 | 716 | EFI_STATUS BootManagerMenuStatus;\r |
f4cd24da RN |
717 | \r |
718 | HotkeyTriggered = NULL;\r | |
719 | Status = EFI_SUCCESS;\r | |
68456d8a | 720 | BootSuccess = FALSE;\r |
f4cd24da RN |
721 | \r |
722 | //\r | |
723 | // Insert the performance probe\r | |
724 | //\r | |
725 | PERF_END (NULL, "DXE", NULL, 0);\r | |
726 | PERF_START (NULL, "BDS", NULL, 0);\r | |
727 | DEBUG ((EFI_D_INFO, "[Bds] Entry...\n"));\r | |
728 | \r | |
729 | PERF_CODE (\r | |
730 | BdsAllocateMemoryForPerformanceData ();\r | |
731 | );\r | |
732 | \r | |
733 | //\r | |
734 | // Fill in FirmwareVendor and FirmwareRevision from PCDs\r | |
735 | //\r | |
736 | FirmwareVendor = (CHAR16 *) PcdGetPtr (PcdFirmwareVendor);\r | |
737 | gST->FirmwareVendor = AllocateRuntimeCopyPool (StrSize (FirmwareVendor), FirmwareVendor);\r | |
738 | ASSERT (gST->FirmwareVendor != NULL);\r | |
739 | gST->FirmwareRevision = PcdGet32 (PcdFirmwareRevision);\r | |
740 | \r | |
741 | //\r | |
742 | // Fixup Tasble CRC after we updated Firmware Vendor and Revision\r | |
743 | //\r | |
744 | gST->Hdr.CRC32 = 0;\r | |
745 | gBS->CalculateCrc32 ((VOID *) gST, sizeof (EFI_SYSTEM_TABLE), &gST->Hdr.CRC32);\r | |
746 | \r | |
747 | //\r | |
748 | // Validate Variable.\r | |
749 | //\r | |
750 | BdsFormalizeEfiGlobalVariable ();\r | |
751 | \r | |
752 | //\r | |
753 | // Mark the read-only variables if the Variable Lock protocol exists\r | |
754 | //\r | |
755 | Status = gBS->LocateProtocol (&gEdkiiVariableLockProtocolGuid, NULL, (VOID **) &VariableLock);\r | |
756 | DEBUG ((EFI_D_INFO, "[BdsDxe] Locate Variable Lock protocol - %r\n", Status));\r | |
757 | if (!EFI_ERROR (Status)) {\r | |
1a5afd71 | 758 | for (Index = 0; Index < ARRAY_SIZE (mReadOnlyVariables); Index++) {\r |
f4cd24da RN |
759 | Status = VariableLock->RequestToLock (VariableLock, mReadOnlyVariables[Index], &gEfiGlobalVariableGuid);\r |
760 | ASSERT_EFI_ERROR (Status);\r | |
761 | }\r | |
762 | }\r | |
763 | \r | |
764 | InitializeHwErrRecSupport ();\r | |
765 | \r | |
766 | //\r | |
767 | // Initialize L"Timeout" EFI global variable.\r | |
768 | //\r | |
769 | BootTimeOut = PcdGet16 (PcdPlatformBootTimeOut);\r | |
770 | if (BootTimeOut != 0xFFFF) {\r | |
771 | //\r | |
772 | // If time out value equal 0xFFFF, no need set to 0xFFFF to variable area because UEFI specification\r | |
773 | // define same behavior between no value or 0xFFFF value for L"Timeout".\r | |
774 | //\r | |
775 | BdsDxeSetVariableAndReportStatusCodeOnError (\r | |
776 | EFI_TIME_OUT_VARIABLE_NAME,\r | |
777 | &gEfiGlobalVariableGuid,\r | |
778 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r | |
779 | sizeof (UINT16),\r | |
780 | &BootTimeOut\r | |
781 | );\r | |
782 | }\r | |
783 | \r | |
784 | //\r | |
785 | // Initialize L"BootOptionSupport" EFI global variable.\r | |
786 | // Lazy-ConIn implictly disables BDS hotkey.\r | |
787 | //\r | |
1634214d | 788 | BootOptionSupport = EFI_BOOT_OPTION_SUPPORT_APP | EFI_BOOT_OPTION_SUPPORT_SYSPREP;\r |
f4cd24da RN |
789 | if (!PcdGetBool (PcdConInConnectOnDemand)) {\r |
790 | BootOptionSupport |= EFI_BOOT_OPTION_SUPPORT_KEY;\r | |
791 | SET_BOOT_OPTION_SUPPORT_KEY_COUNT (BootOptionSupport, 3);\r | |
792 | }\r | |
793 | Status = gRT->SetVariable (\r | |
794 | EFI_BOOT_OPTION_SUPPORT_VARIABLE_NAME,\r | |
795 | &gEfiGlobalVariableGuid,\r | |
796 | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r | |
797 | sizeof (BootOptionSupport),\r | |
798 | &BootOptionSupport\r | |
799 | );\r | |
800 | //\r | |
801 | // Platform needs to make sure setting volatile variable before calling 3rd party code shouldn't fail.\r | |
802 | //\r | |
803 | ASSERT_EFI_ERROR (Status);\r | |
804 | \r | |
805 | //\r | |
806 | // Cache and remove the "BootNext" NV variable.\r | |
807 | //\r | |
808 | GetEfiGlobalVariable2 (EFI_BOOT_NEXT_VARIABLE_NAME, (VOID **) &BootNext, &DataSize);\r | |
809 | if (DataSize != sizeof (UINT16)) {\r | |
810 | if (BootNext != NULL) {\r | |
811 | FreePool (BootNext);\r | |
812 | }\r | |
813 | BootNext = NULL;\r | |
814 | }\r | |
815 | Status = gRT->SetVariable (\r | |
816 | EFI_BOOT_NEXT_VARIABLE_NAME,\r | |
817 | &gEfiGlobalVariableGuid,\r | |
818 | 0,\r | |
819 | 0,\r | |
820 | NULL\r | |
821 | );\r | |
822 | //\r | |
823 | // Deleting NV variable shouldn't fail unless it doesn't exist.\r | |
824 | //\r | |
825 | ASSERT (Status == EFI_SUCCESS || Status == EFI_NOT_FOUND);\r | |
826 | \r | |
827 | //\r | |
828 | // Initialize the platform language variables\r | |
829 | //\r | |
830 | InitializeLanguage (TRUE);\r | |
831 | \r | |
d175f4e6 RN |
832 | //\r |
833 | // System firmware must include a PlatformRecovery#### variable specifying\r | |
834 | // a short-form File Path Media Device Path containing the platform default\r | |
835 | // file path for removable media\r | |
836 | //\r | |
837 | FilePath = FileDevicePath (NULL, EFI_REMOVABLE_MEDIA_FILE_NAME);\r | |
838 | Status = EfiBootManagerInitializeLoadOption (\r | |
839 | &LoadOption,\r | |
0dc3fb06 | 840 | LoadOptionNumberUnassigned,\r |
d175f4e6 RN |
841 | LoadOptionTypePlatformRecovery,\r |
842 | LOAD_OPTION_ACTIVE,\r | |
843 | L"Default PlatformRecovery",\r | |
844 | FilePath,\r | |
845 | NULL,\r | |
846 | 0\r | |
847 | );\r | |
848 | ASSERT_EFI_ERROR (Status);\r | |
0dc3fb06 RN |
849 | LoadOptions = EfiBootManagerGetLoadOptions (&LoadOptionCount, LoadOptionTypePlatformRecovery);\r |
850 | if (EfiBootManagerFindLoadOption (&LoadOption, LoadOptions, LoadOptionCount) == -1) {\r | |
851 | for (Index = 0; Index < LoadOptionCount; Index++) {\r | |
852 | //\r | |
853 | // The PlatformRecovery#### options are sorted by OptionNumber.\r | |
854 | // Find the the smallest unused number as the new OptionNumber.\r | |
855 | //\r | |
856 | if (LoadOptions[Index].OptionNumber != Index) {\r | |
857 | break;\r | |
858 | }\r | |
859 | }\r | |
860 | LoadOption.OptionNumber = Index;\r | |
861 | Status = EfiBootManagerLoadOptionToVariable (&LoadOption);\r | |
862 | ASSERT_EFI_ERROR (Status);\r | |
863 | }\r | |
d175f4e6 RN |
864 | EfiBootManagerFreeLoadOption (&LoadOption);\r |
865 | FreePool (FilePath);\r | |
0dc3fb06 | 866 | EfiBootManagerFreeLoadOptions (LoadOptions, LoadOptionCount);\r |
d175f4e6 | 867 | \r |
f4cd24da RN |
868 | //\r |
869 | // Report Status Code to indicate connecting drivers will happen\r | |
870 | //\r | |
871 | REPORT_STATUS_CODE (\r | |
872 | EFI_PROGRESS_CODE,\r | |
873 | (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_DXE_BS_PC_BEGIN_CONNECTING_DRIVERS)\r | |
874 | );\r | |
875 | \r | |
876 | //\r | |
877 | // Do the platform init, can be customized by OEM/IBV\r | |
878 | // Possible things that can be done in PlatformBootManagerBeforeConsole:\r | |
879 | // > Update console variable: 1. include hot-plug devices; 2. Clear ConIn and add SOL for AMT\r | |
880 | // > Register new Driver#### or Boot####\r | |
881 | // > Register new Key####: e.g.: F12 \r | |
882 | // > Signal ReadyToLock event\r | |
883 | // > Authentication action: 1. connect Auth devices; 2. Identify auto logon user.\r | |
884 | //\r | |
885 | PERF_START (NULL, "PlatformBootManagerBeforeConsole", "BDS", 0);\r | |
886 | PlatformBootManagerBeforeConsole ();\r | |
887 | PERF_END (NULL, "PlatformBootManagerBeforeConsole", "BDS", 0);\r | |
888 | \r | |
889 | //\r | |
890 | // Initialize hotkey service\r | |
891 | //\r | |
892 | EfiBootManagerStartHotkeyService (&HotkeyTriggered);\r | |
893 | \r | |
894 | //\r | |
1634214d | 895 | // Execute Driver Options\r |
f4cd24da | 896 | //\r |
1634214d RN |
897 | LoadOptions = EfiBootManagerGetLoadOptions (&LoadOptionCount, LoadOptionTypeDriver);\r |
898 | ProcessLoadOptions (LoadOptions, LoadOptionCount);\r | |
899 | EfiBootManagerFreeLoadOptions (LoadOptions, LoadOptionCount);\r | |
f4cd24da RN |
900 | \r |
901 | //\r | |
902 | // Connect consoles\r | |
903 | //\r | |
904 | PERF_START (NULL, "EfiBootManagerConnectAllDefaultConsoles", "BDS", 0);\r | |
905 | if (PcdGetBool (PcdConInConnectOnDemand)) {\r | |
906 | EfiBootManagerConnectConsoleVariable (ConOut);\r | |
907 | EfiBootManagerConnectConsoleVariable (ErrOut);\r | |
908 | \r | |
909 | //\r | |
910 | // Initialize ConnectConIn event\r | |
911 | //\r | |
912 | Status = gBS->CreateEventEx (\r | |
913 | EVT_NOTIFY_SIGNAL,\r | |
914 | TPL_CALLBACK,\r | |
915 | BdsDxeOnConnectConInCallBack,\r | |
916 | NULL,\r | |
917 | &gConnectConInEventGuid,\r | |
918 | &gConnectConInEvent\r | |
919 | );\r | |
920 | if (EFI_ERROR (Status)) {\r | |
921 | gConnectConInEvent = NULL;\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 | |
68456d8a RN |
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 | |
f4cd24da RN |
956 | \r |
957 | DEBUG_CODE (\r | |
1634214d | 958 | EFI_BOOT_MANAGER_LOAD_OPTION_TYPE LoadOptionType;\r |
68456d8a | 959 | DEBUG ((EFI_D_INFO, "[Bds]OsIndication: %016x\n", OsIndication));\r |
1634214d RN |
960 | DEBUG ((EFI_D_INFO, "[Bds]=============Begin Load Options Dumping ...=============\n"));\r |
961 | for (LoadOptionType = 0; LoadOptionType < LoadOptionTypeMax; LoadOptionType++) {\r | |
f4cd24da | 962 | DEBUG ((\r |
1634214d RN |
963 | EFI_D_INFO, " %s Options:\n",\r |
964 | mBdsLoadOptionName[LoadOptionType]\r | |
f4cd24da | 965 | ));\r |
1634214d RN |
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 | |
f4cd24da | 977 | }\r |
1634214d RN |
978 | DEBUG ((EFI_D_INFO, "[Bds]=============End Load Options Dumping=============\n"));\r |
979 | );\r | |
f4cd24da RN |
980 | \r |
981 | //\r | |
e58f1ae5 | 982 | // BootManagerMenu doesn't contain the correct information when return status is EFI_NOT_FOUND.\r |
f4cd24da | 983 | //\r |
e58f1ae5 | 984 | BootManagerMenuStatus = EfiBootManagerGetBootManagerMenu (&BootManagerMenu);\r |
1634214d | 985 | \r |
68456d8a RN |
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 | |
1634214d RN |
988 | //\r |
989 | // Clear EFI_OS_INDICATIONS_BOOT_TO_FW_UI to acknowledge OS\r | |
990 | // \r | |
68456d8a RN |
991 | if (BootFwUi || PlatformRecovery) {\r |
992 | OsIndication &= ~((UINT64) (EFI_OS_INDICATIONS_BOOT_TO_FW_UI | EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY));\r | |
f4cd24da | 993 | Status = gRT->SetVariable (\r |
cc4812f6 | 994 | EFI_OS_INDICATIONS_VARIABLE_NAME,\r |
f4cd24da RN |
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 | |
1634214d | 1004 | }\r |
f4cd24da | 1005 | \r |
1634214d RN |
1006 | //\r |
1007 | // Launch Boot Manager Menu directly when EFI_OS_INDICATIONS_BOOT_TO_FW_UI is set. Skip HotkeyBoot\r | |
1008 | //\r | |
e58f1ae5 | 1009 | if (BootFwUi && (BootManagerMenuStatus != EFI_NOT_FOUND)) {\r |
f4cd24da RN |
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 | |
1634214d | 1018 | // Directly enter the setup page.\r |
f4cd24da | 1019 | //\r |
1634214d | 1020 | EfiBootManagerBoot (&BootManagerMenu);\r |
f4cd24da RN |
1021 | }\r |
1022 | \r | |
68456d8a RN |
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 | |
1634214d | 1030 | \r |
68456d8a RN |
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 | |
1634214d | 1037 | \r |
68456d8a RN |
1038 | //\r |
1039 | // BdsReadKeys() can be removed after all keyboard drivers invoke callback in timer callback.\r | |
1040 | //\r | |
1041 | BdsReadKeys ();\r | |
1634214d | 1042 | \r |
68456d8a | 1043 | EfiBootManagerHotkeyBoot ();\r |
1634214d | 1044 | \r |
68456d8a RN |
1045 | //\r |
1046 | // Boot to "BootNext"\r | |
1047 | //\r | |
1048 | if (BootNext != NULL) {\r | |
1049 | UnicodeSPrint (BootNextVariableName, sizeof (BootNextVariableName), L"Boot%04x", *BootNext);\r | |
1050 | Status = EfiBootManagerVariableToLoadOption (BootNextVariableName, &LoadOption);\r | |
1051 | if (!EFI_ERROR (Status)) {\r | |
d175f4e6 RN |
1052 | EfiBootManagerBoot (&LoadOption);\r |
1053 | EfiBootManagerFreeLoadOption (&LoadOption);\r | |
e58f1ae5 SW |
1054 | if ((LoadOption.Status == EFI_SUCCESS) && \r |
1055 | (BootManagerMenuStatus != EFI_NOT_FOUND) &&\r | |
1056 | (LoadOption.OptionNumber != BootManagerMenu.OptionNumber)) {\r | |
68456d8a RN |
1057 | //\r |
1058 | // Boot to Boot Manager Menu upon EFI_SUCCESS\r | |
f5cbc197 | 1059 | // Exception: Do not boot again when the BootNext points to Boot Manager Menu.\r |
68456d8a RN |
1060 | //\r |
1061 | EfiBootManagerBoot (&BootManagerMenu);\r | |
1062 | }\r | |
f4cd24da RN |
1063 | }\r |
1064 | }\r | |
68456d8a RN |
1065 | \r |
1066 | do {\r | |
1067 | //\r | |
1068 | // Retry to boot if any of the boot succeeds\r | |
1069 | //\r | |
1070 | LoadOptions = EfiBootManagerGetLoadOptions (&LoadOptionCount, LoadOptionTypeBoot);\r | |
e58f1ae5 | 1071 | BootSuccess = BootBootOptions (LoadOptions, LoadOptionCount, (BootManagerMenuStatus != EFI_NOT_FOUND) ? &BootManagerMenu : NULL);\r |
68456d8a RN |
1072 | EfiBootManagerFreeLoadOptions (LoadOptions, LoadOptionCount);\r |
1073 | } while (BootSuccess);\r | |
f4cd24da RN |
1074 | }\r |
1075 | \r | |
e58f1ae5 SW |
1076 | if (BootManagerMenuStatus != EFI_NOT_FOUND) {\r |
1077 | EfiBootManagerFreeLoadOption (&BootManagerMenu);\r | |
1078 | }\r | |
68456d8a RN |
1079 | \r |
1080 | if (!BootSuccess) {\r | |
1081 | LoadOptions = EfiBootManagerGetLoadOptions (&LoadOptionCount, LoadOptionTypePlatformRecovery);\r | |
1082 | ProcessLoadOptions (LoadOptions, LoadOptionCount);\r | |
1083 | EfiBootManagerFreeLoadOptions (LoadOptions, LoadOptionCount);\r | |
f4cd24da | 1084 | }\r |
68456d8a RN |
1085 | \r |
1086 | DEBUG ((EFI_D_ERROR, "[Bds] Unable to boot!\n"));\r | |
1087 | CpuDeadLoop ();\r | |
f4cd24da RN |
1088 | }\r |
1089 | \r | |
1090 | /**\r | |
1091 | Set the variable and report the error through status code upon failure.\r | |
1092 | \r | |
1093 | @param VariableName A Null-terminated string that is the name of the vendor's variable.\r | |
1094 | Each VariableName is unique for each VendorGuid. VariableName must\r | |
1095 | contain 1 or more characters. If VariableName is an empty string,\r | |
1096 | then EFI_INVALID_PARAMETER is returned.\r | |
1097 | @param VendorGuid A unique identifier for the vendor.\r | |
1098 | @param Attributes Attributes bitmask to set for the variable.\r | |
1099 | @param DataSize The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE, \r | |
1100 | EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS, or \r | |
1101 | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero \r | |
1102 | causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is \r | |
1103 | set, then a SetVariable() call with a DataSize of zero will not cause any change to \r | |
1104 | the variable value (the timestamp associated with the variable may be updated however \r | |
1105 | even if no new data value is provided,see the description of the \r | |
1106 | EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not \r | |
1107 | be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated). \r | |
1108 | @param Data The contents for the variable.\r | |
1109 | \r | |
1110 | @retval EFI_SUCCESS The firmware has successfully stored the variable and its data as\r | |
1111 | defined by the Attributes.\r | |
1112 | @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, and GUID was supplied, or the\r | |
1113 | DataSize exceeds the maximum allowed.\r | |
1114 | @retval EFI_INVALID_PARAMETER VariableName is an empty string.\r | |
1115 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r | |
1116 | @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r | |
1117 | @retval EFI_WRITE_PROTECTED The variable in question is read-only.\r | |
1118 | @retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.\r | |
1119 | @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS \r | |
1120 | or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS being set, but the AuthInfo \r | |
1121 | does NOT pass the validation check carried out by the firmware.\r | |
1122 | \r | |
1123 | @retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.\r | |
1124 | **/\r | |
1125 | EFI_STATUS\r | |
1126 | BdsDxeSetVariableAndReportStatusCodeOnError (\r | |
1127 | IN CHAR16 *VariableName,\r | |
1128 | IN EFI_GUID *VendorGuid,\r | |
1129 | IN UINT32 Attributes,\r | |
1130 | IN UINTN DataSize,\r | |
1131 | IN VOID *Data\r | |
1132 | )\r | |
1133 | {\r | |
1134 | EFI_STATUS Status;\r | |
1135 | EDKII_SET_VARIABLE_STATUS *SetVariableStatus;\r | |
1136 | UINTN NameSize;\r | |
1137 | \r | |
1138 | Status = gRT->SetVariable (\r | |
1139 | VariableName,\r | |
1140 | VendorGuid,\r | |
1141 | Attributes,\r | |
1142 | DataSize,\r | |
1143 | Data\r | |
1144 | );\r | |
1145 | if (EFI_ERROR (Status)) {\r | |
1146 | NameSize = StrSize (VariableName);\r | |
1147 | SetVariableStatus = AllocatePool (sizeof (EDKII_SET_VARIABLE_STATUS) + NameSize + DataSize);\r | |
1148 | if (SetVariableStatus != NULL) {\r | |
1149 | CopyGuid (&SetVariableStatus->Guid, VendorGuid);\r | |
1150 | SetVariableStatus->NameSize = NameSize;\r | |
1151 | SetVariableStatus->DataSize = DataSize;\r | |
1152 | SetVariableStatus->SetStatus = Status;\r | |
1153 | SetVariableStatus->Attributes = Attributes;\r | |
1154 | CopyMem (SetVariableStatus + 1, VariableName, NameSize);\r | |
1155 | CopyMem (((UINT8 *) (SetVariableStatus + 1)) + NameSize, Data, DataSize);\r | |
1156 | \r | |
1157 | REPORT_STATUS_CODE_EX (\r | |
1158 | EFI_ERROR_CODE,\r | |
1159 | PcdGet32 (PcdErrorCodeSetVariable),\r | |
1160 | 0,\r | |
1161 | NULL,\r | |
1162 | &gEdkiiStatusCodeDataTypeVariableGuid,\r | |
1163 | SetVariableStatus,\r | |
1164 | sizeof (EDKII_SET_VARIABLE_STATUS) + NameSize + DataSize\r | |
1165 | );\r | |
1166 | \r | |
1167 | FreePool (SetVariableStatus);\r | |
1168 | }\r | |
1169 | }\r | |
1170 | \r | |
1171 | return Status;\r | |
1172 | }\r |