3 * Copyright (c) 2011-2015, ARM Limited. All rights reserved.
5 * This program and the accompanying materials
6 * are licensed and made available under the terms and conditions of the BSD License
7 * which accompanies this distribution. The full text of the license may be found at
8 * http://opensource.org/licenses/bsd-license.php
10 * THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "BdsInternal.h"
17 #include <Library/PcdLib.h>
18 #include <Library/PerformanceLib.h>
20 #include <Protocol/Bds.h>
22 #include <Guid/EventGroup.h>
24 #define EFI_SET_TIMER_TO_SECOND 10000000
28 GetConsoleDevicePathFromVariable (
29 IN CHAR16
* ConsoleVarName
,
30 IN CHAR16
* DefaultConsolePaths
,
31 OUT EFI_DEVICE_PATH
** DevicePaths
36 EFI_DEVICE_PATH_PROTOCOL
* DevicePathInstances
;
37 EFI_DEVICE_PATH_PROTOCOL
* DevicePathInstance
;
38 CHAR16
* DevicePathStr
;
39 CHAR16
* NextDevicePathStr
;
40 EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL
*EfiDevicePathFromTextProtocol
;
42 Status
= GetGlobalEnvironmentVariable (ConsoleVarName
, NULL
, NULL
, (VOID
**)&DevicePathInstances
);
43 if (EFI_ERROR(Status
)) {
44 // In case no default console device path has been defined we assume a driver handles the console (eg: SimpleTextInOutSerial)
45 if ((DefaultConsolePaths
== NULL
) || (DefaultConsolePaths
[0] == L
'\0')) {
50 Status
= gBS
->LocateProtocol (&gEfiDevicePathFromTextProtocolGuid
, NULL
, (VOID
**)&EfiDevicePathFromTextProtocol
);
51 ASSERT_EFI_ERROR(Status
);
53 DevicePathInstances
= NULL
;
55 // Extract the Device Path instances from the multi-device path string
56 while ((DefaultConsolePaths
!= NULL
) && (DefaultConsolePaths
[0] != L
'\0')) {
57 NextDevicePathStr
= StrStr (DefaultConsolePaths
, L
";");
58 if (NextDevicePathStr
== NULL
) {
59 DevicePathStr
= DefaultConsolePaths
;
60 DefaultConsolePaths
= NULL
;
62 DevicePathStr
= (CHAR16
*)AllocateCopyPool ((NextDevicePathStr
- DefaultConsolePaths
+ 1) * sizeof(CHAR16
), DefaultConsolePaths
);
63 *(DevicePathStr
+ (NextDevicePathStr
- DefaultConsolePaths
)) = L
'\0';
64 DefaultConsolePaths
= NextDevicePathStr
;
65 if (DefaultConsolePaths
[0] == L
';') {
66 DefaultConsolePaths
++;
70 DevicePathInstance
= EfiDevicePathFromTextProtocol
->ConvertTextToDevicePath (DevicePathStr
);
71 ASSERT(DevicePathInstance
!= NULL
);
72 DevicePathInstances
= AppendDevicePathInstance (DevicePathInstances
, DevicePathInstance
);
74 if (NextDevicePathStr
!= NULL
) {
75 FreePool (DevicePathStr
);
77 FreePool (DevicePathInstance
);
80 // Set the environment variable with this device path multi-instances
81 Size
= GetDevicePathSize (DevicePathInstances
);
85 &gEfiGlobalVariableGuid
,
86 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
91 Status
= EFI_INVALID_PARAMETER
;
95 if (!EFI_ERROR(Status
)) {
96 *DevicePaths
= DevicePathInstances
;
103 InitializeConsolePipe (
104 IN EFI_DEVICE_PATH
*ConsoleDevicePaths
,
105 IN EFI_GUID
*Protocol
,
106 OUT EFI_HANDLE
*Handle
,
114 EFI_DEVICE_PATH_PROTOCOL
* DevicePath
;
116 // Connect all the Device Path Consoles
117 while (ConsoleDevicePaths
!= NULL
) {
118 DevicePath
= GetNextDevicePathInstance (&ConsoleDevicePaths
, &Size
);
120 Status
= BdsConnectDevicePath (DevicePath
, Handle
, NULL
);
122 if (EFI_ERROR(Status
)) {
123 // We convert back to the text representation of the device Path
124 EFI_DEVICE_PATH_TO_TEXT_PROTOCOL
* DevicePathToTextProtocol
;
125 CHAR16
* DevicePathTxt
;
128 Status
= gBS
->LocateProtocol(&gEfiDevicePathToTextProtocolGuid
, NULL
, (VOID
**)&DevicePathToTextProtocol
);
129 if (!EFI_ERROR(Status
)) {
130 DevicePathTxt
= DevicePathToTextProtocol
->ConvertDevicePathToText (DevicePath
, TRUE
, TRUE
);
132 DEBUG((EFI_D_ERROR
,"Fail to start the console with the Device Path '%s'. (Error '%r')\n", DevicePathTxt
, Status
));
134 FreePool (DevicePathTxt
);
139 // If the console splitter driver is not supported by the platform then use the first Device Path
140 // instance for the console interface.
141 if (!EFI_ERROR(Status
) && (*Interface
== NULL
)) {
142 Status
= gBS
->HandleProtocol (*Handle
, Protocol
, Interface
);
146 // No Device Path has been defined for this console interface. We take the first protocol implementation
147 if (*Interface
== NULL
) {
148 Status
= gBS
->LocateHandleBuffer (ByProtocol
, Protocol
, NULL
, &NoHandles
, &Buffer
);
149 if (EFI_ERROR (Status
)) {
150 BdsConnectAllDrivers();
151 Status
= gBS
->LocateHandleBuffer (ByProtocol
, Protocol
, NULL
, &NoHandles
, &Buffer
);
154 if (!EFI_ERROR(Status
)) {
156 Status
= gBS
->HandleProtocol (*Handle
, Protocol
, Interface
);
157 ASSERT_EFI_ERROR(Status
);
161 Status
= EFI_SUCCESS
;
173 EFI_DEVICE_PATH
* ConOutDevicePaths
;
174 EFI_DEVICE_PATH
* ConInDevicePaths
;
175 EFI_DEVICE_PATH
* ConErrDevicePaths
;
177 // By getting the Console Device Paths from the environment variables before initializing the console pipe, we
178 // create the 3 environment variables (ConIn, ConOut, ConErr) that allows to initialize all the console interface
179 // of newly installed console drivers
180 Status
= GetConsoleDevicePathFromVariable (L
"ConOut", (CHAR16
*)PcdGetPtr(PcdDefaultConOutPaths
), &ConOutDevicePaths
);
181 ASSERT_EFI_ERROR (Status
);
182 Status
= GetConsoleDevicePathFromVariable (L
"ConIn", (CHAR16
*)PcdGetPtr(PcdDefaultConInPaths
), &ConInDevicePaths
);
183 ASSERT_EFI_ERROR (Status
);
184 Status
= GetConsoleDevicePathFromVariable (L
"ErrOut", (CHAR16
*)PcdGetPtr(PcdDefaultConOutPaths
), &ConErrDevicePaths
);
185 ASSERT_EFI_ERROR (Status
);
187 // Initialize the Consoles
188 Status
= InitializeConsolePipe (ConOutDevicePaths
, &gEfiSimpleTextOutProtocolGuid
, &gST
->ConsoleOutHandle
, (VOID
**)&gST
->ConOut
);
189 ASSERT_EFI_ERROR (Status
);
190 Status
= InitializeConsolePipe (ConInDevicePaths
, &gEfiSimpleTextInProtocolGuid
, &gST
->ConsoleInHandle
, (VOID
**)&gST
->ConIn
);
191 ASSERT_EFI_ERROR (Status
);
192 Status
= InitializeConsolePipe (ConErrDevicePaths
, &gEfiSimpleTextOutProtocolGuid
, &gST
->StandardErrorHandle
, (VOID
**)&gST
->StdErr
);
193 if (EFI_ERROR(Status
)) {
194 // In case of error, we reuse the console output for the error output
195 gST
->StandardErrorHandle
= gST
->ConsoleOutHandle
;
196 gST
->StdErr
= gST
->ConOut
;
199 // Free Memory allocated for reading the UEFI Variables
200 if (ConOutDevicePaths
) {
201 FreePool (ConOutDevicePaths
);
203 if (ConInDevicePaths
) {
204 FreePool (ConInDevicePaths
);
206 if (ConErrDevicePaths
) {
207 FreePool (ConErrDevicePaths
);
214 DefineDefaultBootEntries (
218 BDS_LOAD_OPTION
* BdsLoadOption
;
221 EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL
* EfiDevicePathFromTextProtocol
;
222 EFI_DEVICE_PATH
* BootDevicePath
;
224 UINTN CmdLineAsciiSize
;
225 CHAR16
* DefaultBootArgument
;
226 CHAR8
* AsciiDefaultBootArgument
;
229 // If Boot Order does not exist then create a default entry
232 Status
= gRT
->GetVariable (L
"BootOrder", &gEfiGlobalVariableGuid
, NULL
, &Size
, NULL
);
233 if (Status
== EFI_NOT_FOUND
) {
234 if ((PcdGetPtr(PcdDefaultBootDevicePath
) == NULL
) || (StrLen ((CHAR16
*)PcdGetPtr(PcdDefaultBootDevicePath
)) == 0)) {
235 return EFI_UNSUPPORTED
;
238 Status
= gBS
->LocateProtocol (&gEfiDevicePathFromTextProtocolGuid
, NULL
, (VOID
**)&EfiDevicePathFromTextProtocol
);
239 if (EFI_ERROR(Status
)) {
240 // You must provide an implementation of DevicePathFromTextProtocol in your firmware (eg: DevicePathDxe)
241 DEBUG((EFI_D_ERROR
,"Error: Bds requires DevicePathFromTextProtocol\n"));
244 BootDevicePath
= EfiDevicePathFromTextProtocol
->ConvertTextToDevicePath ((CHAR16
*)PcdGetPtr(PcdDefaultBootDevicePath
));
247 // We convert back to the text representation of the device Path to see if the initial text is correct
248 EFI_DEVICE_PATH_TO_TEXT_PROTOCOL
* DevicePathToTextProtocol
;
249 CHAR16
* DevicePathTxt
;
251 Status
= gBS
->LocateProtocol(&gEfiDevicePathToTextProtocolGuid
, NULL
, (VOID
**)&DevicePathToTextProtocol
);
252 ASSERT_EFI_ERROR(Status
);
253 DevicePathTxt
= DevicePathToTextProtocol
->ConvertDevicePathToText (BootDevicePath
, TRUE
, TRUE
);
255 if (StrCmp ((CHAR16
*)PcdGetPtr (PcdDefaultBootDevicePath
), DevicePathTxt
) != 0) {
256 DEBUG ((EFI_D_ERROR
, "Device Path given: '%s' Device Path expected: '%s'\n",
257 (CHAR16
*)PcdGetPtr (PcdDefaultBootDevicePath
), DevicePathTxt
));
258 ASSERT_EFI_ERROR (EFI_INVALID_PARAMETER
);
261 FreePool (DevicePathTxt
);
264 // Create the entry is the Default values are correct
265 if (BootDevicePath
!= NULL
) {
266 // We do not support NULL pointer
267 ASSERT (PcdGetPtr (PcdDefaultBootArgument
) != NULL
);
270 // Logic to handle ASCII or Unicode default parameters
272 if (*(CHAR8
*)PcdGetPtr (PcdDefaultBootArgument
) == '\0') {
274 CmdLineAsciiSize
= 0;
275 DefaultBootArgument
= NULL
;
276 AsciiDefaultBootArgument
= NULL
;
277 } else if (IsUnicodeString ((CHAR16
*)PcdGetPtr (PcdDefaultBootArgument
))) {
278 // The command line is a Unicode string
279 DefaultBootArgument
= (CHAR16
*)PcdGetPtr (PcdDefaultBootArgument
);
280 CmdLineSize
= StrSize (DefaultBootArgument
);
282 // Initialize ASCII variables
283 CmdLineAsciiSize
= CmdLineSize
/ 2;
284 AsciiDefaultBootArgument
= AllocatePool (CmdLineAsciiSize
);
285 if (AsciiDefaultBootArgument
== NULL
) {
286 return EFI_OUT_OF_RESOURCES
;
288 UnicodeStrToAsciiStr ((CHAR16
*)PcdGetPtr (PcdDefaultBootArgument
), AsciiDefaultBootArgument
);
290 // The command line is a ASCII string
291 AsciiDefaultBootArgument
= (CHAR8
*)PcdGetPtr (PcdDefaultBootArgument
);
292 CmdLineAsciiSize
= AsciiStrSize (AsciiDefaultBootArgument
);
294 // Initialize ASCII variables
295 CmdLineSize
= CmdLineAsciiSize
* 2;
296 DefaultBootArgument
= AllocatePool (CmdLineSize
);
297 if (DefaultBootArgument
== NULL
) {
298 return EFI_OUT_OF_RESOURCES
;
300 AsciiStrToUnicodeStr (AsciiDefaultBootArgument
, DefaultBootArgument
);
303 BootOptionCreate (LOAD_OPTION_ACTIVE
| LOAD_OPTION_CATEGORY_BOOT
,
304 (CHAR16
*)PcdGetPtr (PcdDefaultBootDescription
),
306 (UINT8
*)DefaultBootArgument
, // OptionalData
307 CmdLineSize
, // OptionalDataSize
310 FreePool (BdsLoadOption
);
312 if (DefaultBootArgument
== (CHAR16
*)PcdGetPtr (PcdDefaultBootArgument
)) {
313 FreePool (AsciiDefaultBootArgument
);
314 } else if (DefaultBootArgument
!= NULL
) {
315 FreePool (DefaultBootArgument
);
318 Status
= EFI_UNSUPPORTED
;
326 StartDefaultBootOnTimeout (
333 EFI_EVENT WaitList
[2];
338 CHAR16 BootVariableName
[9];
342 Size
= sizeof(UINT16
);
343 Timeout
= (UINT16
)PcdGet16 (PcdPlatformBootTimeOut
);
344 Status
= GetGlobalEnvironmentVariable (L
"Timeout", &Timeout
, &Size
, (VOID
**)&TimeoutPtr
);
345 if (!EFI_ERROR (Status
)) {
346 Timeout
= *TimeoutPtr
;
347 FreePool (TimeoutPtr
);
350 if (Timeout
!= 0xFFFF) {
352 // Create the waiting events (keystroke and 1sec timer)
353 gBS
->CreateEvent (EVT_TIMER
, 0, NULL
, NULL
, &WaitList
[0]);
354 gBS
->SetTimer (WaitList
[0], TimerPeriodic
, EFI_SET_TIMER_TO_SECOND
);
355 WaitList
[1] = gST
->ConIn
->WaitForKey
;
359 Print(L
"The default boot selection will start in ");
360 while ((Timeout
> 0) && (WaitIndex
== 0)) {
361 Print(L
"%3d seconds",Timeout
);
362 gBS
->WaitForEvent (2, WaitList
, &WaitIndex
);
363 if (WaitIndex
== 0) {
364 Print(L
"\b\b\b\b\b\b\b\b\b\b\b");
368 // Discard key in the buffer
370 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
371 } while(!EFI_ERROR(Status
));
372 gBS
->CloseEvent (WaitList
[0]);
376 // In case of Timeout we start the default boot selection
378 // Get the Boot Option Order from the environment variable (a default value should have been created)
379 GetGlobalEnvironmentVariable (L
"BootOrder", NULL
, &BootOrderSize
, (VOID
**)&BootOrder
);
381 for (Index
= 0; Index
< BootOrderSize
/ sizeof (UINT16
); Index
++) {
382 UnicodeSPrint (BootVariableName
, 9 * sizeof(CHAR16
), L
"Boot%04X", BootOrder
[Index
]);
383 Status
= BdsStartBootOption (BootVariableName
);
384 if(!EFI_ERROR(Status
)){
385 // Boot option returned successfully, hence don't need to start next boot option
388 // In case of success, we should not return from this call.
390 FreePool (BootOrder
);
397 An empty function to pass error checking of CreateEventEx ().
399 @param Event Event whose notification function is being invoked.
400 @param Context Pointer to the notification function's context,
401 which is implementation-dependent.
406 EmptyCallbackFunction (
415 This function uses policy data from the platform to determine what operating
416 system or system utility should be loaded and invoked. This function call
417 also optionally make the use of user input to determine the operating system
418 or system utility to be loaded and invoked. When the DXE Core has dispatched
419 all the drivers on the dispatch queue, this function is called. This
420 function will attempt to connect the boot devices required to load and invoke
421 the selected operating system or system utility. During this process,
422 additional firmware volumes may be discovered that may contain addition DXE
423 drivers that can be dispatched by the DXE Core. If a boot device cannot be
424 fully connected, this function calls the DXE Service Dispatch() to allow the
425 DXE drivers from any newly discovered firmware volumes to be dispatched.
426 Then the boot device connection can be attempted again. If the same boot
427 device connection operation fails twice in a row, then that boot device has
428 failed, and should be skipped. This function should never return.
430 @param This The EFI_BDS_ARCH_PROTOCOL instance.
438 IN EFI_BDS_ARCH_PROTOCOL
*This
445 CHAR16 BootVariableName
[9];
446 EFI_EVENT EndOfDxeEvent
;
449 // Signal EndOfDxe PI Event
451 Status
= gBS
->CreateEventEx (
454 EmptyCallbackFunction
,
456 &gEfiEndOfDxeEventGroupGuid
,
459 if (!EFI_ERROR (Status
)) {
460 gBS
->SignalEvent (EndOfDxeEvent
);
463 PERF_END (NULL
, "DXE", NULL
, 0);
466 // Declare the Firmware Vendor
468 if (FixedPcdGetPtr(PcdFirmwareVendor
) != NULL
) {
470 gST
->FirmwareVendor
= AllocateRuntimePool (Size
);
471 ASSERT (gST
->FirmwareVendor
!= NULL
);
472 UnicodeSPrint (gST
->FirmwareVendor
, Size
, L
"%a EFI %a %a", PcdGetPtr(PcdFirmwareVendor
), __DATE__
, __TIME__
);
476 // Fixup Table CRC after we updated Firmware Vendor
479 Status
= gBS
->CalculateCrc32 ((VOID
*)gST
, gST
->Hdr
.HeaderSize
, &gST
->Hdr
.CRC32
);
480 ASSERT_EFI_ERROR (Status
);
482 // Now we need to setup the EFI System Table with information about the console devices.
483 InitializeConsole ();
485 // If BootNext environment variable is defined then we just load it !
486 BootNextSize
= sizeof(UINT16
);
487 Status
= GetGlobalEnvironmentVariable (L
"BootNext", NULL
, &BootNextSize
, (VOID
**)&BootNext
);
488 if (!EFI_ERROR(Status
)) {
489 ASSERT(BootNextSize
== sizeof(UINT16
));
491 // Generate the requested Boot Entry variable name
492 UnicodeSPrint (BootVariableName
, 9 * sizeof(CHAR16
), L
"Boot%04X", *BootNext
);
494 // Set BootCurrent variable
495 gRT
->SetVariable (L
"BootCurrent", &gEfiGlobalVariableGuid
,
496 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
497 BootNextSize
, BootNext
);
501 // Start the requested Boot Entry
502 Status
= BdsStartBootOption (BootVariableName
);
503 if (Status
!= EFI_NOT_FOUND
) {
504 // BootNext has not been succeeded launched
505 if (EFI_ERROR(Status
)) {
506 Print(L
"Fail to start BootNext.\n");
509 // Delete the BootNext environment variable
510 gRT
->SetVariable (L
"BootNext", &gEfiGlobalVariableGuid
,
511 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
515 // Clear BootCurrent variable
516 gRT
->SetVariable (L
"BootCurrent", &gEfiGlobalVariableGuid
,
517 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
521 // If Boot Order does not exist then create a default entry
522 DefineDefaultBootEntries ();
525 // Update the CRC32 in the EFI System Table header
528 Status
= gBS
->CalculateCrc32 ((VOID
*)gST
, gST
->Hdr
.HeaderSize
, &gST
->Hdr
.CRC32
);
529 ASSERT_EFI_ERROR (Status
);
531 // Timer before initiating the default boot selection
532 StartDefaultBootOnTimeout ();
534 // Start the Boot Menu
535 Status
= BootMenuMain ();
536 ASSERT_EFI_ERROR (Status
);
540 EFI_BDS_ARCH_PROTOCOL gBdsProtocol
= {
547 IN EFI_HANDLE ImageHandle
,
548 IN EFI_SYSTEM_TABLE
*SystemTable
553 Status
= gBS
->InstallMultipleProtocolInterfaces (
555 &gEfiBdsArchProtocolGuid
, &gBdsProtocol
,
558 ASSERT_EFI_ERROR (Status
);