2 This module produce main entry for BDS phase - BdsEntry.
3 When this module was dispatched by DxeCore, gEfiBdsArchProtocolGuid will be installed
4 which contains interface of BdsEntry.
5 After DxeCore finish DXE phase, gEfiBdsArchProtocolGuid->BdsEntry will be invoked
8 Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.<BR>
9 This program and the accompanying materials
10 are licensed and made available under the terms and conditions of the BSD License
11 which accompanies this distribution. The full text of the license may be found at
12 http://opensource.org/licenses/bsd-license.php
14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
21 #include "FrontPage.h"
23 #include "HwErrRecSupport.h"
26 /// BDS arch protocol instance initial value.
28 /// Note: Current BDS not directly get the BootMode, DefaultBoot,
29 /// TimeoutDefault, MemoryTestLevel value from the BDS arch protocol.
30 /// Please refer to the library useage of BdsLibGetBootMode, BdsLibGetTimeout
31 /// and PlatformBdsDiagnostics in BdsPlatform.c
33 EFI_HANDLE gBdsHandle
= NULL
;
35 EFI_BDS_ARCH_PROTOCOL gBds
= {
39 UINT16
*mBootNext
= NULL
;
43 Install Boot Device Selection Protocol
45 @param ImageHandle The image handle.
46 @param SystemTable The system table.
48 @retval EFI_SUCEESS BDS has finished initializing.
49 Return the dispatcher and recall BDS.Entry
50 @retval Other Return status from AllocatePool() or gBS->InstallProtocolInterface
56 IN EFI_HANDLE ImageHandle
,
57 IN EFI_SYSTEM_TABLE
*SystemTable
63 // Install protocol interface
65 Status
= gBS
->InstallMultipleProtocolInterfaces (
67 &gEfiBdsArchProtocolGuid
, &gBds
,
70 ASSERT_EFI_ERROR (Status
);
77 This function attempts to boot for the boot order specified
88 BDS_COMMON_OPTION
*BootOption
;
94 BOOLEAN BootNextExist
;
95 LIST_ENTRY
*LinkBootNext
;
98 // Got the latest boot option
100 BootNextExist
= FALSE
;
102 InitializeListHead (&BootLists
);
105 // First check the boot next option
107 ZeroMem (Buffer
, sizeof (Buffer
));
109 if (mBootNext
!= NULL
) {
111 // Indicate we have the boot next variable, so this time
112 // boot will always have this boot option
114 BootNextExist
= TRUE
;
117 // Clear the this variable so it's only exist in this time boot
121 &gEfiGlobalVariableGuid
,
122 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
128 // Add the boot next boot option
130 UnicodeSPrint (Buffer
, sizeof (Buffer
), L
"Boot%04x", *mBootNext
);
131 BootOption
= BdsLibVariableToOption (&BootLists
, Buffer
);
134 // If fail to get boot option from variable, just return and do nothing.
136 if (BootOption
== NULL
) {
140 BootOption
->BootCurrent
= *mBootNext
;
143 // Parse the boot order to get boot option
145 BdsLibBuildOptionFromVar (&BootLists
, L
"BootOrder");
148 // When we didn't have chance to build boot option variables in the first
149 // full configuration boot (e.g.: Reset in the first page or in Device Manager),
150 // we have no boot options in the following mini configuration boot.
151 // Give the last chance to enumerate the boot options.
153 if (IsListEmpty (&BootLists
)) {
154 BdsLibEnumerateAllBootOption (&BootLists
);
157 Link
= BootLists
.ForwardLink
;
160 // Parameter check, make sure the loop will be valid
166 // Here we make the boot in a loop, every boot success will
167 // return to the front page
171 // Check the boot option list first
173 if (Link
== &BootLists
) {
175 // There are two ways to enter here:
176 // 1. There is no active boot option, give user chance to
177 // add new boot option
178 // 2. All the active boot option processed, and there is no
179 // one is success to boot, then we back here to allow user
180 // add new active boot option
183 PlatformBdsEnterFrontPage (Timeout
, FALSE
);
184 InitializeListHead (&BootLists
);
185 BdsLibBuildOptionFromVar (&BootLists
, L
"BootOrder");
186 Link
= BootLists
.ForwardLink
;
190 // Get the boot option from the link list
192 BootOption
= CR (Link
, BDS_COMMON_OPTION
, Link
, BDS_LOAD_OPTION_SIGNATURE
);
195 // According to EFI Specification, if a load option is not marked
196 // as LOAD_OPTION_ACTIVE, the boot manager will not automatically
199 if (!IS_LOAD_OPTION_TYPE (BootOption
->Attribute
, LOAD_OPTION_ACTIVE
)) {
201 // skip the header of the link list, because it has no boot option
203 Link
= Link
->ForwardLink
;
207 // Make sure the boot option device path connected,
208 // but ignore the BBS device path
210 if (DevicePathType (BootOption
->DevicePath
) != BBS_DEVICE_PATH
) {
212 // Notes: the internal shell can not been connected with device path
213 // so we do not check the status here
215 BdsLibConnectDevicePath (BootOption
->DevicePath
);
219 // Restore to original mode before launching boot option.
221 BdsSetConsoleMode (FALSE
);
224 // All the driver options should have been processed since
225 // now boot will be performed.
227 Status
= BdsLibBootViaBootOption (BootOption
, BootOption
->DevicePath
, &ExitDataSize
, &ExitData
);
228 if (Status
!= EFI_SUCCESS
) {
230 // Call platform action to indicate the boot fail
232 BootOption
->StatusString
= GetStringById (STRING_TOKEN (STR_BOOT_FAILED
));
233 PlatformBdsBootFail (BootOption
, Status
, ExitData
, ExitDataSize
);
236 // Check the next boot option
238 Link
= Link
->ForwardLink
;
242 // Call platform action to indicate the boot success
244 BootOption
->StatusString
= GetStringById (STRING_TOKEN (STR_BOOT_SUCCEEDED
));
245 PlatformBdsBootSuccess (BootOption
);
248 // Boot success, then stop process the boot order, and
249 // present the boot manager menu, front page
252 PlatformBdsEnterFrontPage (Timeout
, FALSE
);
255 // Rescan the boot option list, avoid potential risk of the boot
256 // option change in front page
259 LinkBootNext
= BootLists
.ForwardLink
;
262 InitializeListHead (&BootLists
);
263 if (LinkBootNext
!= NULL
) {
265 // Reserve the boot next option
267 InsertTailList (&BootLists
, LinkBootNext
);
270 BdsLibBuildOptionFromVar (&BootLists
, L
"BootOrder");
271 Link
= BootLists
.ForwardLink
;
279 Validate input console variable data.
281 If found the device path is not a valid device path, remove the variable.
283 @param VariableName Input console variable name.
287 BdsFormalizeConsoleVariable (
288 IN CHAR16
*VariableName
291 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
295 DevicePath
= BdsLibGetVariableAndSize (
297 &gEfiGlobalVariableGuid
,
300 if ((DevicePath
!= NULL
) && !IsDevicePathValid (DevicePath
, VariableSize
)) {
301 Status
= gRT
->SetVariable (
303 &gEfiGlobalVariableGuid
,
304 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
308 ASSERT_EFI_ERROR (Status
);
314 Formalize Bds global variables.
316 1. For ConIn/ConOut/ConErr, if found the device path is not a valid device path, remove the variable.
317 2. For OsIndicationsSupported, Create a BS/RT/UINT64 variable to report caps
318 3. Delete OsIndications variable if it is not NV/BS/RT UINT64
319 Item 3 is used to solve case when OS corrupts OsIndications. Here simply delete this NV variable.
323 BdsFormalizeEfiGlobalVariable (
328 UINT64 OsIndicationSupport
;
334 // Validate Console variable.
336 BdsFormalizeConsoleVariable (L
"ConIn");
337 BdsFormalizeConsoleVariable (L
"ConOut");
338 BdsFormalizeConsoleVariable (L
"ErrOut");
341 // OS indicater support variable
343 OsIndicationSupport
= EFI_OS_INDICATIONS_BOOT_TO_FW_UI
;
344 Status
= gRT
->SetVariable (
345 L
"OsIndicationsSupported",
346 &gEfiGlobalVariableGuid
,
347 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
351 ASSERT_EFI_ERROR (Status
);
354 // If OsIndications is invalid, remove it.
356 // 1. Data size != UINT64
357 // 2. OsIndication value inconsistence
358 // 3. OsIndication attribute inconsistence
362 DataSize
= sizeof(UINT64
);
363 Status
= gRT
->GetVariable (
365 &gEfiGlobalVariableGuid
,
371 if (!EFI_ERROR(Status
)) {
372 if (DataSize
!= sizeof(UINT64
) ||
373 (OsIndication
& ~OsIndicationSupport
) != 0 ||
374 Attributes
!= (EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
)){
376 DEBUG ((EFI_D_ERROR
, "Unformalized OsIndications variable exists. Delete it\n"));
377 Status
= gRT
->SetVariable (
379 &gEfiGlobalVariableGuid
,
384 ASSERT_EFI_ERROR (Status
);
392 Service routine for BdsInstance->Entry(). Devices are connected, the
393 consoles are initialized, and the boot options are tried.
395 @param This Protocol Instance structure.
401 IN EFI_BDS_ARCH_PROTOCOL
*This
404 LIST_ENTRY DriverOptionList
;
405 LIST_ENTRY BootOptionList
;
407 CHAR16
*FirmwareVendor
;
410 // Insert the performance probe
412 PERF_END (NULL
, "DXE", NULL
, 0);
413 PERF_START (NULL
, "BDS", NULL
, 0);
416 // Initialize the global system boot option and driver option
418 InitializeListHead (&DriverOptionList
);
419 InitializeListHead (&BootOptionList
);
422 // Initialize hotkey service
424 InitializeHotkeyService ();
427 // Fill in FirmwareVendor and FirmwareRevision from PCDs
429 FirmwareVendor
= (CHAR16
*)PcdGetPtr (PcdFirmwareVendor
);
430 gST
->FirmwareVendor
= AllocateRuntimeCopyPool (StrSize (FirmwareVendor
), FirmwareVendor
);
431 ASSERT (gST
->FirmwareVendor
!= NULL
);
432 gST
->FirmwareRevision
= PcdGet32 (PcdFirmwareRevision
);
435 // Fixup Tasble CRC after we updated Firmware Vendor and Revision
437 gBS
->CalculateCrc32 ((VOID
*)gST
, sizeof(EFI_SYSTEM_TABLE
), &gST
->Hdr
.CRC32
);
440 // Validate Variable.
442 BdsFormalizeEfiGlobalVariable();
445 // Do the platform init, can be customized by OEM/IBV
447 PERF_START (NULL
, "PlatformBds", "BDS", 0);
450 InitializeHwErrRecSupport();
453 // bugbug: platform specific code
454 // Initialize the platform specific string and language
456 InitializeStringSupport ();
457 InitializeLanguage (TRUE
);
458 InitializeFrontPage (TRUE
);
461 // Set up the device list based on EFI 1.1 variables
462 // process Driver#### and Load the driver's in the
463 // driver option list
465 BdsLibBuildOptionFromVar (&DriverOptionList
, L
"DriverOrder");
466 if (!IsListEmpty (&DriverOptionList
)) {
467 BdsLibLoadDrivers (&DriverOptionList
);
470 // Check if we have the boot next option
472 mBootNext
= BdsLibGetVariableAndSize (
474 &gEfiGlobalVariableGuid
,
479 // Setup some platform policy here
481 PlatformBdsPolicyBehavior (&DriverOptionList
, &BootOptionList
, BdsProcessCapsules
, BdsMemoryTest
);
482 PERF_END (NULL
, "PlatformBds", "BDS", 0);
485 // BDS select the boot device to load OS
487 BdsBootDeviceSelect ();
490 // Only assert here since this is the right behavior, we should never
491 // return back to DxeCore.