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 #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
;
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
);
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 TimeoutPtr
= &Timeout
;
371 GetGlobalEnvironmentVariable (L
"Timeout", &Timeout
, &Size
, (VOID
**)&TimeoutPtr
);
373 if (Timeout
!= 0xFFFF) {
375 // Create the waiting events (keystroke and 1sec timer)
376 gBS
->CreateEvent (EVT_TIMER
, 0, NULL
, NULL
, &WaitList
[0]);
377 gBS
->SetTimer (WaitList
[0], TimerPeriodic
, EFI_SET_TIMER_TO_SECOND
);
378 WaitList
[1] = gST
->ConIn
->WaitForKey
;
382 Print(L
"The default boot selection will start in ");
383 while ((Timeout
> 0) && (WaitIndex
== 0)) {
384 Print(L
"%3d seconds",Timeout
);
385 gBS
->WaitForEvent (2, WaitList
, &WaitIndex
);
386 if (WaitIndex
== 0) {
387 Print(L
"\b\b\b\b\b\b\b\b\b\b\b");
391 // Discard key in the buffer
393 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
394 } while(!EFI_ERROR(Status
));
395 gBS
->CloseEvent (WaitList
[0]);
399 // In case of Timeout we start the default boot selection
401 // Get the Boot Option Order from the environment variable (a default value should have been created)
402 GetGlobalEnvironmentVariable (L
"BootOrder", NULL
, &BootOrderSize
, (VOID
**)&BootOrder
);
404 for (Index
= 0; Index
< BootOrderSize
/ sizeof (UINT16
); Index
++) {
405 UnicodeSPrint (BootVariableName
, 9 * sizeof(CHAR16
), L
"Boot%04X", BootOrder
[Index
]);
406 Status
= BdsStartBootOption (BootVariableName
);
407 if(!EFI_ERROR(Status
)){
408 // Boot option returned successfully, hence don't need to start next boot option
411 // In case of success, we should not return from this call.
413 FreePool (BootOrder
);
420 This function uses policy data from the platform to determine what operating
421 system or system utility should be loaded and invoked. This function call
422 also optionally make the use of user input to determine the operating system
423 or system utility to be loaded and invoked. When the DXE Core has dispatched
424 all the drivers on the dispatch queue, this function is called. This
425 function will attempt to connect the boot devices required to load and invoke
426 the selected operating system or system utility. During this process,
427 additional firmware volumes may be discovered that may contain addition DXE
428 drivers that can be dispatched by the DXE Core. If a boot device cannot be
429 fully connected, this function calls the DXE Service Dispatch() to allow the
430 DXE drivers from any newly discovered firmware volumes to be dispatched.
431 Then the boot device connection can be attempted again. If the same boot
432 device connection operation fails twice in a row, then that boot device has
433 failed, and should be skipped. This function should never return.
435 @param This The EFI_BDS_ARCH_PROTOCOL instance.
443 IN EFI_BDS_ARCH_PROTOCOL
*This
450 CHAR16 BootVariableName
[9];
452 PERF_END (NULL
, "DXE", NULL
, 0);
455 // Declare the Firmware Vendor
457 if (FixedPcdGetPtr(PcdFirmwareVendor
) != NULL
) {
459 gST
->FirmwareVendor
= AllocateRuntimePool (Size
);
460 ASSERT (gST
->FirmwareVendor
!= NULL
);
461 UnicodeSPrint (gST
->FirmwareVendor
, Size
, L
"%a EFI %a %a", PcdGetPtr(PcdFirmwareVendor
), __DATE__
, __TIME__
);
465 // Fixup Table CRC after we updated Firmware Vendor
468 Status
= gBS
->CalculateCrc32 ((VOID
*)gST
, gST
->Hdr
.HeaderSize
, &gST
->Hdr
.CRC32
);
469 ASSERT_EFI_ERROR (Status
);
471 // If BootNext environment variable is defined then we just load it !
472 BootNextSize
= sizeof(UINT16
);
473 Status
= GetGlobalEnvironmentVariable (L
"BootNext", NULL
, &BootNextSize
, (VOID
**)&BootNext
);
474 if (!EFI_ERROR(Status
)) {
475 ASSERT(BootNextSize
== sizeof(UINT16
));
477 // Generate the requested Boot Entry variable name
478 UnicodeSPrint (BootVariableName
, 9 * sizeof(CHAR16
), L
"Boot%04X", *BootNext
);
480 // Set BootCurrent variable
481 gRT
->SetVariable (L
"BootCurrent", &gEfiGlobalVariableGuid
,
482 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
483 BootNextSize
, BootNext
);
487 // Start the requested Boot Entry
488 Status
= BdsStartBootOption (BootVariableName
);
489 if (Status
!= EFI_NOT_FOUND
) {
490 // BootNext has not been succeeded launched
491 if (EFI_ERROR(Status
)) {
492 Print(L
"Fail to start BootNext.\n");
495 // Delete the BootNext environment variable
496 gRT
->SetVariable (L
"BootNext", &gEfiGlobalVariableGuid
,
497 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
501 // Clear BootCurrent variable
502 gRT
->SetVariable (L
"BootCurrent", &gEfiGlobalVariableGuid
,
503 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
507 // If Boot Order does not exist then create a default entry
508 DefineDefaultBootEntries ();
510 // Now we need to setup the EFI System Table with information about the console devices.
511 InitializeConsole ();
514 // Update the CRC32 in the EFI System Table header
517 Status
= gBS
->CalculateCrc32 ((VOID
*)gST
, gST
->Hdr
.HeaderSize
, &gST
->Hdr
.CRC32
);
518 ASSERT_EFI_ERROR (Status
);
520 // Timer before initiating the default boot selection
521 StartDefaultBootOnTimeout ();
523 // Start the Boot Menu
524 Status
= BootMenuMain ();
525 ASSERT_EFI_ERROR (Status
);
529 EFI_BDS_ARCH_PROTOCOL gBdsProtocol
= {
536 IN EFI_HANDLE ImageHandle
,
537 IN EFI_SYSTEM_TABLE
*SystemTable
542 mImageHandle
= ImageHandle
;
544 Status
= gBS
->InstallMultipleProtocolInterfaces (
546 &gEfiBdsArchProtocolGuid
, &gBdsProtocol
,
549 ASSERT_EFI_ERROR (Status
);