3 * Copyright (c) 2011-2014, 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 OptionalDataSize
;
225 ARM_BDS_LOADER_ARGUMENTS
* BootArguments
;
226 ARM_BDS_LOADER_TYPE BootType
;
227 EFI_DEVICE_PATH
* InitrdPath
;
230 UINTN CmdLineAsciiSize
;
231 CHAR16
* DefaultBootArgument
;
232 CHAR8
* AsciiDefaultBootArgument
;
235 // If Boot Order does not exist then create a default entry
238 Status
= gRT
->GetVariable (L
"BootOrder", &gEfiGlobalVariableGuid
, NULL
, &Size
, NULL
);
239 if (Status
== EFI_NOT_FOUND
) {
240 if ((PcdGetPtr(PcdDefaultBootDevicePath
) == NULL
) || (StrLen ((CHAR16
*)PcdGetPtr(PcdDefaultBootDevicePath
)) == 0)) {
241 return EFI_UNSUPPORTED
;
244 Status
= gBS
->LocateProtocol (&gEfiDevicePathFromTextProtocolGuid
, NULL
, (VOID
**)&EfiDevicePathFromTextProtocol
);
245 if (EFI_ERROR(Status
)) {
246 // You must provide an implementation of DevicePathFromTextProtocol in your firmware (eg: DevicePathDxe)
247 DEBUG((EFI_D_ERROR
,"Error: Bds requires DevicePathFromTextProtocol\n"));
250 BootDevicePath
= EfiDevicePathFromTextProtocol
->ConvertTextToDevicePath ((CHAR16
*)PcdGetPtr(PcdDefaultBootDevicePath
));
253 // We convert back to the text representation of the device Path to see if the initial text is correct
254 EFI_DEVICE_PATH_TO_TEXT_PROTOCOL
* DevicePathToTextProtocol
;
255 CHAR16
* DevicePathTxt
;
257 Status
= gBS
->LocateProtocol(&gEfiDevicePathToTextProtocolGuid
, NULL
, (VOID
**)&DevicePathToTextProtocol
);
258 ASSERT_EFI_ERROR(Status
);
259 DevicePathTxt
= DevicePathToTextProtocol
->ConvertDevicePathToText (BootDevicePath
, TRUE
, TRUE
);
261 ASSERT (StrCmp ((CHAR16
*)PcdGetPtr(PcdDefaultBootDevicePath
), DevicePathTxt
) == 0);
263 FreePool (DevicePathTxt
);
266 // Create the entry is the Default values are correct
267 if (BootDevicePath
!= NULL
) {
268 BootType
= (ARM_BDS_LOADER_TYPE
)PcdGet32 (PcdDefaultBootType
);
270 // We do not support NULL pointer
271 ASSERT (PcdGetPtr (PcdDefaultBootArgument
) != NULL
);
274 // Logic to handle ASCII or Unicode default parameters
276 if (*(CHAR8
*)PcdGetPtr (PcdDefaultBootArgument
) == '\0') {
278 CmdLineAsciiSize
= 0;
279 DefaultBootArgument
= NULL
;
280 AsciiDefaultBootArgument
= NULL
;
281 } else if (IsUnicodeString ((CHAR16
*)PcdGetPtr (PcdDefaultBootArgument
))) {
282 // The command line is a Unicode string
283 DefaultBootArgument
= (CHAR16
*)PcdGetPtr (PcdDefaultBootArgument
);
284 CmdLineSize
= StrSize (DefaultBootArgument
);
286 // Initialize ASCII variables
287 CmdLineAsciiSize
= CmdLineSize
/ 2;
288 AsciiDefaultBootArgument
= AllocatePool (CmdLineAsciiSize
);
289 if (AsciiDefaultBootArgument
== NULL
) {
290 return EFI_OUT_OF_RESOURCES
;
292 UnicodeStrToAsciiStr ((CHAR16
*)PcdGetPtr (PcdDefaultBootArgument
), AsciiDefaultBootArgument
);
294 // The command line is a ASCII string
295 AsciiDefaultBootArgument
= (CHAR8
*)PcdGetPtr (PcdDefaultBootArgument
);
296 CmdLineAsciiSize
= AsciiStrSize (AsciiDefaultBootArgument
);
298 // Initialize ASCII variables
299 CmdLineSize
= CmdLineAsciiSize
* 2;
300 DefaultBootArgument
= AllocatePool (CmdLineSize
);
301 if (DefaultBootArgument
== NULL
) {
302 return EFI_OUT_OF_RESOURCES
;
304 AsciiStrToUnicodeStr (AsciiDefaultBootArgument
, DefaultBootArgument
);
307 if ((BootType
== BDS_LOADER_KERNEL_LINUX_ATAG
) || (BootType
== BDS_LOADER_KERNEL_LINUX_FDT
)) {
308 InitrdPath
= EfiDevicePathFromTextProtocol
->ConvertTextToDevicePath ((CHAR16
*)PcdGetPtr(PcdDefaultBootInitrdPath
));
309 InitrdSize
= GetDevicePathSize (InitrdPath
);
311 OptionalDataSize
= sizeof(ARM_BDS_LOADER_ARGUMENTS
) + CmdLineAsciiSize
+ InitrdSize
;
312 BootArguments
= (ARM_BDS_LOADER_ARGUMENTS
*)AllocatePool (OptionalDataSize
);
313 if (BootArguments
== NULL
) {
314 return EFI_OUT_OF_RESOURCES
;
316 BootArguments
->LinuxArguments
.CmdLineSize
= CmdLineAsciiSize
;
317 BootArguments
->LinuxArguments
.InitrdSize
= InitrdSize
;
319 CopyMem ((VOID
*)(BootArguments
+ 1), AsciiDefaultBootArgument
, CmdLineAsciiSize
);
320 CopyMem ((VOID
*)((UINTN
)(BootArguments
+ 1) + CmdLineAsciiSize
), InitrdPath
, InitrdSize
);
322 OptionalData
= (UINT8
*)BootArguments
;
324 OptionalData
= (UINT8
*)DefaultBootArgument
;
325 OptionalDataSize
= CmdLineSize
;
328 BootOptionCreate (LOAD_OPTION_ACTIVE
| LOAD_OPTION_CATEGORY_BOOT
,
329 (CHAR16
*)PcdGetPtr(PcdDefaultBootDescription
),
336 FreePool (BdsLoadOption
);
338 if (DefaultBootArgument
== (CHAR16
*)PcdGetPtr (PcdDefaultBootArgument
)) {
339 FreePool (AsciiDefaultBootArgument
);
340 } else if (DefaultBootArgument
!= NULL
) {
341 FreePool (DefaultBootArgument
);
344 Status
= EFI_UNSUPPORTED
;
352 StartDefaultBootOnTimeout (
359 EFI_EVENT WaitList
[2];
364 CHAR16 BootVariableName
[9];
368 Size
= sizeof(UINT16
);
369 Timeout
= (UINT16
)PcdGet16 (PcdPlatformBootTimeOut
);
370 Status
= GetGlobalEnvironmentVariable (L
"Timeout", &Timeout
, &Size
, (VOID
**)&TimeoutPtr
);
371 if (!EFI_ERROR (Status
)) {
372 Timeout
= *TimeoutPtr
;
373 FreePool (TimeoutPtr
);
376 if (Timeout
!= 0xFFFF) {
378 // Create the waiting events (keystroke and 1sec timer)
379 gBS
->CreateEvent (EVT_TIMER
, 0, NULL
, NULL
, &WaitList
[0]);
380 gBS
->SetTimer (WaitList
[0], TimerPeriodic
, EFI_SET_TIMER_TO_SECOND
);
381 WaitList
[1] = gST
->ConIn
->WaitForKey
;
385 Print(L
"The default boot selection will start in ");
386 while ((Timeout
> 0) && (WaitIndex
== 0)) {
387 Print(L
"%3d seconds",Timeout
);
388 gBS
->WaitForEvent (2, WaitList
, &WaitIndex
);
389 if (WaitIndex
== 0) {
390 Print(L
"\b\b\b\b\b\b\b\b\b\b\b");
394 // Discard key in the buffer
396 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
397 } while(!EFI_ERROR(Status
));
398 gBS
->CloseEvent (WaitList
[0]);
402 // In case of Timeout we start the default boot selection
404 // Get the Boot Option Order from the environment variable (a default value should have been created)
405 GetGlobalEnvironmentVariable (L
"BootOrder", NULL
, &BootOrderSize
, (VOID
**)&BootOrder
);
407 for (Index
= 0; Index
< BootOrderSize
/ sizeof (UINT16
); Index
++) {
408 UnicodeSPrint (BootVariableName
, 9 * sizeof(CHAR16
), L
"Boot%04X", BootOrder
[Index
]);
409 Status
= BdsStartBootOption (BootVariableName
);
410 if(!EFI_ERROR(Status
)){
411 // Boot option returned successfully, hence don't need to start next boot option
414 // In case of success, we should not return from this call.
416 FreePool (BootOrder
);
423 An empty function to pass error checking of CreateEventEx ().
425 @param Event Event whose notification function is being invoked.
426 @param Context Pointer to the notification function's context,
427 which is implementation-dependent.
433 EmptyCallbackFunction (
442 This function uses policy data from the platform to determine what operating
443 system or system utility should be loaded and invoked. This function call
444 also optionally make the use of user input to determine the operating system
445 or system utility to be loaded and invoked. When the DXE Core has dispatched
446 all the drivers on the dispatch queue, this function is called. This
447 function will attempt to connect the boot devices required to load and invoke
448 the selected operating system or system utility. During this process,
449 additional firmware volumes may be discovered that may contain addition DXE
450 drivers that can be dispatched by the DXE Core. If a boot device cannot be
451 fully connected, this function calls the DXE Service Dispatch() to allow the
452 DXE drivers from any newly discovered firmware volumes to be dispatched.
453 Then the boot device connection can be attempted again. If the same boot
454 device connection operation fails twice in a row, then that boot device has
455 failed, and should be skipped. This function should never return.
457 @param This The EFI_BDS_ARCH_PROTOCOL instance.
465 IN EFI_BDS_ARCH_PROTOCOL
*This
472 CHAR16 BootVariableName
[9];
473 EFI_EVENT EndOfDxeEvent
;
476 // Signal EndOfDxe PI Event
478 Status
= gBS
->CreateEventEx (
481 EmptyCallbackFunction
,
483 &gEfiEndOfDxeEventGroupGuid
,
486 if (!EFI_ERROR (Status
)) {
487 gBS
->SignalEvent (EndOfDxeEvent
);
490 PERF_END (NULL
, "DXE", NULL
, 0);
493 // Declare the Firmware Vendor
495 if (FixedPcdGetPtr(PcdFirmwareVendor
) != NULL
) {
497 gST
->FirmwareVendor
= AllocateRuntimePool (Size
);
498 ASSERT (gST
->FirmwareVendor
!= NULL
);
499 UnicodeSPrint (gST
->FirmwareVendor
, Size
, L
"%a EFI %a %a", PcdGetPtr(PcdFirmwareVendor
), __DATE__
, __TIME__
);
503 // Fixup Table CRC after we updated Firmware Vendor
506 Status
= gBS
->CalculateCrc32 ((VOID
*)gST
, gST
->Hdr
.HeaderSize
, &gST
->Hdr
.CRC32
);
507 ASSERT_EFI_ERROR (Status
);
509 // If BootNext environment variable is defined then we just load it !
510 BootNextSize
= sizeof(UINT16
);
511 Status
= GetGlobalEnvironmentVariable (L
"BootNext", NULL
, &BootNextSize
, (VOID
**)&BootNext
);
512 if (!EFI_ERROR(Status
)) {
513 ASSERT(BootNextSize
== sizeof(UINT16
));
515 // Generate the requested Boot Entry variable name
516 UnicodeSPrint (BootVariableName
, 9 * sizeof(CHAR16
), L
"Boot%04X", *BootNext
);
518 // Set BootCurrent variable
519 gRT
->SetVariable (L
"BootCurrent", &gEfiGlobalVariableGuid
,
520 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
521 BootNextSize
, BootNext
);
525 // Start the requested Boot Entry
526 Status
= BdsStartBootOption (BootVariableName
);
527 if (Status
!= EFI_NOT_FOUND
) {
528 // BootNext has not been succeeded launched
529 if (EFI_ERROR(Status
)) {
530 Print(L
"Fail to start BootNext.\n");
533 // Delete the BootNext environment variable
534 gRT
->SetVariable (L
"BootNext", &gEfiGlobalVariableGuid
,
535 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
539 // Clear BootCurrent variable
540 gRT
->SetVariable (L
"BootCurrent", &gEfiGlobalVariableGuid
,
541 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
545 // If Boot Order does not exist then create a default entry
546 DefineDefaultBootEntries ();
548 // Now we need to setup the EFI System Table with information about the console devices.
549 InitializeConsole ();
552 // Update the CRC32 in the EFI System Table header
555 Status
= gBS
->CalculateCrc32 ((VOID
*)gST
, gST
->Hdr
.HeaderSize
, &gST
->Hdr
.CRC32
);
556 ASSERT_EFI_ERROR (Status
);
558 // Timer before initiating the default boot selection
559 StartDefaultBootOnTimeout ();
561 // Start the Boot Menu
562 Status
= BootMenuMain ();
563 ASSERT_EFI_ERROR (Status
);
567 EFI_BDS_ARCH_PROTOCOL gBdsProtocol
= {
574 IN EFI_HANDLE ImageHandle
,
575 IN EFI_SYSTEM_TABLE
*SystemTable
580 Status
= gBS
->InstallMultipleProtocolInterfaces (
582 &gEfiBdsArchProtocolGuid
, &gBdsProtocol
,
585 ASSERT_EFI_ERROR (Status
);