3 * Copyright (c) 2011, 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
= GetEnvironmentVariable (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
"ConErr", (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
;
203 DefineDefaultBootEntries (
207 BDS_LOAD_OPTION
* BdsLoadOption
;
210 EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL
* EfiDevicePathFromTextProtocol
;
211 EFI_DEVICE_PATH
* BootDevicePath
;
212 ARM_BDS_LOADER_ARGUMENTS
* BootArguments
;
213 ARM_BDS_LOADER_TYPE BootType
;
214 EFI_DEVICE_PATH
* InitrdPath
;
219 // If Boot Order does not exist then create a default entry
222 Status
= gRT
->GetVariable (L
"BootOrder", &gEfiGlobalVariableGuid
, NULL
, &Size
, NULL
);
223 if (Status
== EFI_NOT_FOUND
) {
224 if ((PcdGetPtr(PcdDefaultBootDevicePath
) == NULL
) || (StrLen ((CHAR16
*)PcdGetPtr(PcdDefaultBootDevicePath
)) == 0)) {
225 return EFI_UNSUPPORTED
;
228 Status
= gBS
->LocateProtocol (&gEfiDevicePathFromTextProtocolGuid
, NULL
, (VOID
**)&EfiDevicePathFromTextProtocol
);
229 if (EFI_ERROR(Status
)) {
230 // You must provide an implementation of DevicePathFromTextProtocol in your firmware (eg: DevicePathDxe)
231 DEBUG((EFI_D_ERROR
,"Error: Bds requires DevicePathFromTextProtocol\n"));
234 BootDevicePath
= EfiDevicePathFromTextProtocol
->ConvertTextToDevicePath ((CHAR16
*)PcdGetPtr(PcdDefaultBootDevicePath
));
237 // We convert back to the text representation of the device Path to see if the initial text is correct
238 EFI_DEVICE_PATH_TO_TEXT_PROTOCOL
* DevicePathToTextProtocol
;
239 CHAR16
* DevicePathTxt
;
241 Status
= gBS
->LocateProtocol(&gEfiDevicePathToTextProtocolGuid
, NULL
, (VOID
**)&DevicePathToTextProtocol
);
242 ASSERT_EFI_ERROR(Status
);
243 DevicePathTxt
= DevicePathToTextProtocol
->ConvertDevicePathToText (BootDevicePath
, TRUE
, TRUE
);
245 ASSERT (StrCmp ((CHAR16
*)PcdGetPtr(PcdDefaultBootDevicePath
), DevicePathTxt
) == 0);
247 FreePool (DevicePathTxt
);
250 // Create the entry is the Default values are correct
251 if (BootDevicePath
!= NULL
) {
252 BootType
= (ARM_BDS_LOADER_TYPE
)PcdGet32 (PcdDefaultBootType
);
254 if ((BootType
== BDS_LOADER_KERNEL_LINUX_ATAG
) || (BootType
== BDS_LOADER_KERNEL_LINUX_FDT
)) {
255 CmdLineSize
= AsciiStrSize ((CHAR8
*)PcdGetPtr(PcdDefaultBootArgument
));
256 InitrdPath
= EfiDevicePathFromTextProtocol
->ConvertTextToDevicePath ((CHAR16
*)PcdGetPtr(PcdDefaultBootInitrdPath
));
257 InitrdSize
= GetDevicePathSize (InitrdPath
);
259 BootArguments
= (ARM_BDS_LOADER_ARGUMENTS
*)AllocatePool (sizeof(ARM_BDS_LOADER_ARGUMENTS
) + CmdLineSize
+ InitrdSize
);
260 BootArguments
->LinuxArguments
.CmdLineSize
= CmdLineSize
;
261 BootArguments
->LinuxArguments
.InitrdSize
= InitrdSize
;
263 CopyMem ((VOID
*)(BootArguments
+ 1), (CHAR8
*)PcdGetPtr(PcdDefaultBootArgument
), CmdLineSize
);
264 CopyMem ((VOID
*)((UINTN
)(BootArguments
+ 1) + CmdLineSize
), InitrdPath
, InitrdSize
);
266 BootArguments
= NULL
;
269 BootOptionCreate (LOAD_OPTION_ACTIVE
| LOAD_OPTION_CATEGORY_BOOT
,
270 (CHAR16
*)PcdGetPtr(PcdDefaultBootDescription
),
276 FreePool (BdsLoadOption
);
278 Status
= EFI_UNSUPPORTED
;
286 StartDefaultBootOnTimeout (
293 EFI_EVENT WaitList
[2];
298 CHAR16 BootVariableName
[9];
302 Size
= sizeof(UINT16
);
303 Timeout
= (UINT16
)PcdGet16 (PcdPlatformBootTimeOut
);
304 TimeoutPtr
= &Timeout
;
305 GetEnvironmentVariable (L
"Timeout", &Timeout
, &Size
, (VOID
**)&TimeoutPtr
);
307 if (Timeout
!= 0xFFFF) {
309 // Create the waiting events (keystroke and 1sec timer)
310 gBS
->CreateEvent (EVT_TIMER
, 0, NULL
, NULL
, &WaitList
[0]);
311 gBS
->SetTimer (WaitList
[0], TimerPeriodic
, EFI_SET_TIMER_TO_SECOND
);
312 WaitList
[1] = gST
->ConIn
->WaitForKey
;
316 Print(L
"The default boot selection will start in ");
317 while ((Timeout
> 0) && (WaitIndex
== 0)) {
318 Print(L
"%3d seconds",Timeout
);
319 gBS
->WaitForEvent (2, WaitList
, &WaitIndex
);
320 if (WaitIndex
== 0) {
321 Print(L
"\b\b\b\b\b\b\b\b\b\b\b");
325 // Discard key in the buffer
327 Status
= gST
->ConIn
->ReadKeyStroke (gST
->ConIn
, &Key
);
328 } while(!EFI_ERROR(Status
));
329 gBS
->CloseEvent (WaitList
[0]);
333 // In case of Timeout we start the default boot selection
335 // Get the Boot Option Order from the environment variable (a default value should have been created)
336 GetEnvironmentVariable (L
"BootOrder", NULL
, &BootOrderSize
, (VOID
**)&BootOrder
);
338 for (Index
= 0; Index
< BootOrderSize
/ sizeof (UINT16
); Index
++) {
339 UnicodeSPrint (BootVariableName
, 9 * sizeof(CHAR16
), L
"Boot%04X", BootOrder
[Index
]);
340 Status
= BdsStartBootOption (BootVariableName
);
341 if(!EFI_ERROR(Status
)){
342 // Boot option returned successfully, hence don't need to start next boot option
345 // In case of success, we should not return from this call.
353 This function uses policy data from the platform to determine what operating
354 system or system utility should be loaded and invoked. This function call
355 also optionally make the use of user input to determine the operating system
356 or system utility to be loaded and invoked. When the DXE Core has dispatched
357 all the drivers on the dispatch queue, this function is called. This
358 function will attempt to connect the boot devices required to load and invoke
359 the selected operating system or system utility. During this process,
360 additional firmware volumes may be discovered that may contain addition DXE
361 drivers that can be dispatched by the DXE Core. If a boot device cannot be
362 fully connected, this function calls the DXE Service Dispatch() to allow the
363 DXE drivers from any newly discovered firmware volumes to be dispatched.
364 Then the boot device connection can be attempted again. If the same boot
365 device connection operation fails twice in a row, then that boot device has
366 failed, and should be skipped. This function should never return.
368 @param This The EFI_BDS_ARCH_PROTOCOL instance.
376 IN EFI_BDS_ARCH_PROTOCOL
*This
382 PERF_END (NULL
, "DXE", NULL
, 0);
385 // Declare the Firmware Vendor
387 if (FixedPcdGetPtr(PcdFirmwareVendor
) != NULL
) {
389 gST
->FirmwareVendor
= AllocateRuntimePool (Size
);
390 ASSERT (gST
->FirmwareVendor
!= NULL
);
391 UnicodeSPrint (gST
->FirmwareVendor
, Size
, L
"%a EFI %a %a", PcdGetPtr(PcdFirmwareVendor
), __DATE__
, __TIME__
);
394 // If BootNext environment variable is defined then we just load it !
395 Status
= BdsStartBootOption (L
"BootNext");
396 if (Status
!= EFI_NOT_FOUND
) {
397 // BootNext has not been succeeded launched
398 if (EFI_ERROR(Status
)) {
399 Print(L
"Fail to start BootNext.\n");
402 // Delete the BootNext environment variable
403 gRT
->SetVariable (L
"BootNext", &gEfiGlobalVariableGuid
,
404 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
408 // If Boot Order does not exist then create a default entry
409 DefineDefaultBootEntries ();
411 // Now we need to setup the EFI System Table with information about the console devices.
412 InitializeConsole ();
414 // Timer before initiating the default boot selection
415 StartDefaultBootOnTimeout ();
417 // Start the Boot Menu
418 Status
= BootMenuMain ();
419 ASSERT_EFI_ERROR (Status
);
423 EFI_BDS_ARCH_PROTOCOL gBdsProtocol
= {
430 IN EFI_HANDLE ImageHandle
,
431 IN EFI_SYSTEM_TABLE
*SystemTable
436 mImageHandle
= ImageHandle
;
438 Status
= gBS
->InstallMultipleProtocolInterfaces (
440 &gEfiBdsArchProtocolGuid
, &gBdsProtocol
,
443 ASSERT_EFI_ERROR (Status
);