3 * Copyright (c) 2011-2013, 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 #define EFI_SET_TIMER_TO_SECOND 10000000
24 EFI_HANDLE mImageHandle
;
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
;
223 ARM_BDS_LOADER_ARGUMENTS
* BootArguments
;
224 ARM_BDS_LOADER_TYPE BootType
;
225 EFI_DEVICE_PATH
* InitrdPath
;
230 // If Boot Order does not exist then create a default entry
233 Status
= gRT
->GetVariable (L
"BootOrder", &gEfiGlobalVariableGuid
, NULL
, &Size
, NULL
);
234 if (Status
== EFI_NOT_FOUND
) {
235 if ((PcdGetPtr(PcdDefaultBootDevicePath
) == NULL
) || (StrLen ((CHAR16
*)PcdGetPtr(PcdDefaultBootDevicePath
)) == 0)) {
236 return EFI_UNSUPPORTED
;
239 Status
= gBS
->LocateProtocol (&gEfiDevicePathFromTextProtocolGuid
, NULL
, (VOID
**)&EfiDevicePathFromTextProtocol
);
240 if (EFI_ERROR(Status
)) {
241 // You must provide an implementation of DevicePathFromTextProtocol in your firmware (eg: DevicePathDxe)
242 DEBUG((EFI_D_ERROR
,"Error: Bds requires DevicePathFromTextProtocol\n"));
245 BootDevicePath
= EfiDevicePathFromTextProtocol
->ConvertTextToDevicePath ((CHAR16
*)PcdGetPtr(PcdDefaultBootDevicePath
));
248 // We convert back to the text representation of the device Path to see if the initial text is correct
249 EFI_DEVICE_PATH_TO_TEXT_PROTOCOL
* DevicePathToTextProtocol
;
250 CHAR16
* DevicePathTxt
;
252 Status
= gBS
->LocateProtocol(&gEfiDevicePathToTextProtocolGuid
, NULL
, (VOID
**)&DevicePathToTextProtocol
);
253 ASSERT_EFI_ERROR(Status
);
254 DevicePathTxt
= DevicePathToTextProtocol
->ConvertDevicePathToText (BootDevicePath
, TRUE
, TRUE
);
256 ASSERT (StrCmp ((CHAR16
*)PcdGetPtr(PcdDefaultBootDevicePath
), DevicePathTxt
) == 0);
258 FreePool (DevicePathTxt
);
261 // Create the entry is the Default values are correct
262 if (BootDevicePath
!= NULL
) {
263 BootType
= (ARM_BDS_LOADER_TYPE
)PcdGet32 (PcdDefaultBootType
);
265 if ((BootType
== BDS_LOADER_KERNEL_LINUX_ATAG
) || (BootType
== BDS_LOADER_KERNEL_LINUX_FDT
)) {
266 CmdLineSize
= AsciiStrSize ((CHAR8
*)PcdGetPtr(PcdDefaultBootArgument
));
267 InitrdPath
= EfiDevicePathFromTextProtocol
->ConvertTextToDevicePath ((CHAR16
*)PcdGetPtr(PcdDefaultBootInitrdPath
));
268 InitrdSize
= GetDevicePathSize (InitrdPath
);
270 BootArguments
= (ARM_BDS_LOADER_ARGUMENTS
*)AllocatePool (sizeof(ARM_BDS_LOADER_ARGUMENTS
) + CmdLineSize
+ InitrdSize
);
271 BootArguments
->LinuxArguments
.CmdLineSize
= CmdLineSize
;
272 BootArguments
->LinuxArguments
.InitrdSize
= InitrdSize
;
274 CopyMem ((VOID
*)(BootArguments
+ 1), (CHAR8
*)PcdGetPtr(PcdDefaultBootArgument
), CmdLineSize
);
275 CopyMem ((VOID
*)((UINTN
)(BootArguments
+ 1) + CmdLineSize
), InitrdPath
, InitrdSize
);
277 BootArguments
= NULL
;
280 BootOptionCreate (LOAD_OPTION_ACTIVE
| LOAD_OPTION_CATEGORY_BOOT
,
281 (CHAR16
*)PcdGetPtr(PcdDefaultBootDescription
),
287 FreePool (BdsLoadOption
);
289 Status
= EFI_UNSUPPORTED
;
297 StartDefaultBootOnTimeout (
304 EFI_EVENT WaitList
[2];
309 CHAR16 BootVariableName
[9];
313 Size
= sizeof(UINT16
);
314 Timeout
= (UINT16
)PcdGet16 (PcdPlatformBootTimeOut
);
315 TimeoutPtr
= &Timeout
;
316 GetGlobalEnvironmentVariable (L
"Timeout", &Timeout
, &Size
, (VOID
**)&TimeoutPtr
);
318 if (Timeout
!= 0xFFFF) {
320 // Create the waiting events (keystroke and 1sec timer)
321 gBS
->CreateEvent (EVT_TIMER
, 0, NULL
, NULL
, &WaitList
[0]);
322 gBS
->SetTimer (WaitList
[0], TimerPeriodic
, EFI_SET_TIMER_TO_SECOND
);
323 WaitList
[1] = gST
->ConIn
->WaitForKey
;
327 Print(L
"The default boot selection will start in ");
328 while ((Timeout
> 0) && (WaitIndex
== 0)) {
329 Print(L
"%3d seconds",Timeout
);
330 gBS
->WaitForEvent (2, WaitList
, &WaitIndex
);
331 if (WaitIndex
== 0) {
332 Print(L
"\b\b\b\b\b\b\b\b\b\b\b");
336 // Discard key in the buffer
338 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
339 } while(!EFI_ERROR(Status
));
340 gBS
->CloseEvent (WaitList
[0]);
344 // In case of Timeout we start the default boot selection
346 // Get the Boot Option Order from the environment variable (a default value should have been created)
347 GetGlobalEnvironmentVariable (L
"BootOrder", NULL
, &BootOrderSize
, (VOID
**)&BootOrder
);
349 for (Index
= 0; Index
< BootOrderSize
/ sizeof (UINT16
); Index
++) {
350 UnicodeSPrint (BootVariableName
, 9 * sizeof(CHAR16
), L
"Boot%04X", BootOrder
[Index
]);
351 Status
= BdsStartBootOption (BootVariableName
);
352 if(!EFI_ERROR(Status
)){
353 // Boot option returned successfully, hence don't need to start next boot option
356 // In case of success, we should not return from this call.
358 FreePool (BootOrder
);
365 This function uses policy data from the platform to determine what operating
366 system or system utility should be loaded and invoked. This function call
367 also optionally make the use of user input to determine the operating system
368 or system utility to be loaded and invoked. When the DXE Core has dispatched
369 all the drivers on the dispatch queue, this function is called. This
370 function will attempt to connect the boot devices required to load and invoke
371 the selected operating system or system utility. During this process,
372 additional firmware volumes may be discovered that may contain addition DXE
373 drivers that can be dispatched by the DXE Core. If a boot device cannot be
374 fully connected, this function calls the DXE Service Dispatch() to allow the
375 DXE drivers from any newly discovered firmware volumes to be dispatched.
376 Then the boot device connection can be attempted again. If the same boot
377 device connection operation fails twice in a row, then that boot device has
378 failed, and should be skipped. This function should never return.
380 @param This The EFI_BDS_ARCH_PROTOCOL instance.
388 IN EFI_BDS_ARCH_PROTOCOL
*This
395 CHAR16 BootVariableName
[9];
397 PERF_END (NULL
, "DXE", NULL
, 0);
400 // Declare the Firmware Vendor
402 if (FixedPcdGetPtr(PcdFirmwareVendor
) != NULL
) {
404 gST
->FirmwareVendor
= AllocateRuntimePool (Size
);
405 ASSERT (gST
->FirmwareVendor
!= NULL
);
406 UnicodeSPrint (gST
->FirmwareVendor
, Size
, L
"%a EFI %a %a", PcdGetPtr(PcdFirmwareVendor
), __DATE__
, __TIME__
);
409 // If BootNext environment variable is defined then we just load it !
410 BootNextSize
= sizeof(UINT16
);
411 Status
= GetGlobalEnvironmentVariable (L
"BootNext", NULL
, &BootNextSize
, (VOID
**)&BootNext
);
412 if (!EFI_ERROR(Status
)) {
413 ASSERT(BootNextSize
== sizeof(UINT16
));
415 // Generate the requested Boot Entry variable name
416 UnicodeSPrint (BootVariableName
, 9 * sizeof(CHAR16
), L
"Boot%04X", *BootNext
);
418 // Set BootCurrent variable
419 gRT
->SetVariable (L
"BootCurrent", &gEfiGlobalVariableGuid
,
420 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
421 BootNextSize
, BootNext
);
425 // Start the requested Boot Entry
426 Status
= BdsStartBootOption (BootVariableName
);
427 if (Status
!= EFI_NOT_FOUND
) {
428 // BootNext has not been succeeded launched
429 if (EFI_ERROR(Status
)) {
430 Print(L
"Fail to start BootNext.\n");
433 // Delete the BootNext environment variable
434 gRT
->SetVariable (L
"BootNext", &gEfiGlobalVariableGuid
,
435 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
439 // Clear BootCurrent variable
440 gRT
->SetVariable (L
"BootCurrent", &gEfiGlobalVariableGuid
,
441 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
445 // If Boot Order does not exist then create a default entry
446 DefineDefaultBootEntries ();
448 // Now we need to setup the EFI System Table with information about the console devices.
449 InitializeConsole ();
451 // Timer before initiating the default boot selection
452 StartDefaultBootOnTimeout ();
454 // Start the Boot Menu
455 Status
= BootMenuMain ();
456 ASSERT_EFI_ERROR (Status
);
460 EFI_BDS_ARCH_PROTOCOL gBdsProtocol
= {
467 IN EFI_HANDLE ImageHandle
,
468 IN EFI_SYSTEM_TABLE
*SystemTable
473 mImageHandle
= ImageHandle
;
475 Status
= gBS
->InstallMultipleProtocolInterfaces (
477 &gEfiBdsArchProtocolGuid
, &gBdsProtocol
,
480 ASSERT_EFI_ERROR (Status
);