]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkModulePkg/Universal/BdsDxe/BdsEntry.c
Correct a typo: Change the type of the 4th parameter of EFI_DRIVER_HEALTH_PROTOCOL...
[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / BdsDxe / BdsEntry.c
index 55ea3728926cd0a746e0bbcb56acbd4d371c7917..77c88b0d241a5b77b5e609e44a04bb0d49b40968 100644 (file)
@@ -1,12 +1,12 @@
 /** @file\r
-  This module produce main entry for BDS phase - BdsEntry. \r
+  This module produce main entry for BDS phase - BdsEntry.\r
   When this module was dispatched by DxeCore, gEfiBdsArchProtocolGuid will be installed\r
   which contains interface of BdsEntry.\r
   After DxeCore finish DXE phase, gEfiBdsArchProtocolGuid->BdsEntry will be invoked\r
   to enter BDS phase.\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2004 - 2013, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
 http://opensource.org/licenses/bsd-license.php\r
@@ -27,22 +27,27 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 ///\r
 /// Note: Current BDS not directly get the BootMode, DefaultBoot,\r
 /// TimeoutDefault, MemoryTestLevel value from the BDS arch protocol.\r
-/// Please refer to the library useage of BdsLibGetBootMode, BdsLibGetTimeout \r
+/// Please refer to the library useage of BdsLibGetBootMode, BdsLibGetTimeout\r
 /// and PlatformBdsDiagnostics in BdsPlatform.c\r
 ///\r
-EFI_BDS_ARCH_PROTOCOL_INSTANCE  gBdsInstanceTemplate = {\r
-  EFI_BDS_ARCH_PROTOCOL_INSTANCE_SIGNATURE,\r
-  NULL,\r
-  {BdsEntry},\r
-  0xFFFF,\r
-  TRUE,\r
-  0,\r
-  EXTENSIVE\r
+EFI_HANDLE  gBdsHandle = NULL;\r
+\r
+EFI_BDS_ARCH_PROTOCOL  gBds = {\r
+  BdsEntry\r
 };\r
 \r
 UINT16                          *mBootNext = NULL;\r
 \r
-EFI_HANDLE                      mBdsImageHandle;\r
+///\r
+/// The read-only variables defined in UEFI Spec.\r
+///\r
+CHAR16  *mReadOnlyVariables[] = {\r
+  L"PlatformLangCodes",\r
+  L"LangCodes",\r
+  L"BootOptionSupport",\r
+  L"HwErrRecSupport",\r
+  L"OsIndicationsSupported"\r
+  };\r
 \r
 /**\r
 \r
@@ -65,22 +70,37 @@ BdsInitialize (
 {\r
   EFI_STATUS  Status;\r
 \r
-  mBdsImageHandle = ImageHandle;\r
-\r
   //\r
   // Install protocol interface\r
   //\r
-  Status = gBS->InstallProtocolInterface (\r
-                  &gBdsInstanceTemplate.Handle,\r
-                  &gEfiBdsArchProtocolGuid,\r
-                  EFI_NATIVE_INTERFACE,\r
-                  &gBdsInstanceTemplate.Bds\r
+  Status = gBS->InstallMultipleProtocolInterfaces (\r
+                  &gBdsHandle,\r
+                  &gEfiBdsArchProtocolGuid, &gBds,\r
+                  NULL\r
                   );\r
   ASSERT_EFI_ERROR (Status);\r
 \r
   return Status;\r
 }\r
 \r
+\r
+/**\r
+  An empty function to pass error checking of CreateEventEx ().\r
+\r
+  @param  Event                 Event whose notification function is being invoked.\r
+  @param  Context               Pointer to the notification function's context,\r
+                                which is implementation-dependent.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+BdsEmptyCallbackFunction (\r
+  IN EFI_EVENT                Event,\r
+  IN VOID                     *Context\r
+  )\r
+{\r
+}\r
+\r
 /**\r
 \r
   This function attempts to boot for the boot order specified\r
@@ -102,12 +122,14 @@ BdsBootDeviceSelect (
   CHAR16            Buffer[20];\r
   BOOLEAN           BootNextExist;\r
   LIST_ENTRY        *LinkBootNext;\r
+  EFI_EVENT         ConnectConInEvent;\r
 \r
   //\r
   // Got the latest boot option\r
   //\r
   BootNextExist = FALSE;\r
   LinkBootNext  = NULL;\r
+  ConnectConInEvent = NULL;\r
   InitializeListHead (&BootLists);\r
 \r
   //\r
@@ -115,6 +137,23 @@ BdsBootDeviceSelect (
   //\r
   ZeroMem (Buffer, sizeof (Buffer));\r
 \r
+  //\r
+  // Create Event to signal ConIn connection request\r
+  //\r
+  if (PcdGetBool (PcdConInConnectOnDemand)) {\r
+    Status = gBS->CreateEventEx (\r
+                    EVT_NOTIFY_SIGNAL,\r
+                    TPL_CALLBACK,\r
+                    BdsEmptyCallbackFunction,\r
+                    NULL,\r
+                    &gConnectConInEventGuid,\r
+                    &ConnectConInEvent\r
+                    );\r
+    if (EFI_ERROR(Status)) {\r
+      ConnectConInEvent = NULL;\r
+    }\r
+  }\r
+\r
   if (mBootNext != NULL) {\r
     //\r
     // Indicate we have the boot next variable, so this time\r
@@ -138,20 +177,31 @@ BdsBootDeviceSelect (
     //\r
     UnicodeSPrint (Buffer, sizeof (Buffer), L"Boot%04x", *mBootNext);\r
     BootOption = BdsLibVariableToOption (&BootLists, Buffer);\r
-    \r
+\r
     //\r
     // If fail to get boot option from variable, just return and do nothing.\r
     //\r
     if (BootOption == NULL) {\r
       return;\r
     }\r
-    \r
+\r
     BootOption->BootCurrent = *mBootNext;\r
   }\r
   //\r
   // Parse the boot order to get boot option\r
   //\r
   BdsLibBuildOptionFromVar (&BootLists, L"BootOrder");\r
+\r
+  //\r
+  // When we didn't have chance to build boot option variables in the first \r
+  // full configuration boot (e.g.: Reset in the first page or in Device Manager),\r
+  // we have no boot options in the following mini configuration boot.\r
+  // Give the last chance to enumerate the boot options.\r
+  //\r
+  if (IsListEmpty (&BootLists)) {\r
+    BdsLibEnumerateAllBootOption (&BootLists);\r
+  }\r
+\r
   Link = BootLists.ForwardLink;\r
 \r
   //\r
@@ -169,6 +219,13 @@ BdsBootDeviceSelect (
     // Check the boot option list first\r
     //\r
     if (Link == &BootLists) {\r
+      //\r
+      // When LazyConIn enabled, signal connect ConIn event before enter UI\r
+      //\r
+      if (PcdGetBool (PcdConInConnectOnDemand) && ConnectConInEvent != NULL) {\r
+        gBS->SignalEvent (ConnectConInEvent);\r
+      }\r
+\r
       //\r
       // There are two ways to enter here:\r
       // 1. There is no active boot option, give user chance to\r
@@ -196,7 +253,7 @@ BdsBootDeviceSelect (
     //\r
     if (!IS_LOAD_OPTION_TYPE (BootOption->Attribute, LOAD_OPTION_ACTIVE)) {\r
       //\r
-      // skip the header of the link list, becuase it has no boot option\r
+      // skip the header of the link list, because it has no boot option\r
       //\r
       Link = Link->ForwardLink;\r
       continue;\r
@@ -212,12 +269,18 @@ BdsBootDeviceSelect (
       //\r
       BdsLibConnectDevicePath (BootOption->DevicePath);\r
     }\r
+\r
+    //\r
+    // Restore to original mode before launching boot option.\r
+    //\r
+    BdsSetConsoleMode (FALSE);\r
+    \r
     //\r
     // All the driver options should have been processed since\r
     // now boot will be performed.\r
     //\r
     Status = BdsLibBootViaBootOption (BootOption, BootOption->DevicePath, &ExitDataSize, &ExitData);\r
-    if (EFI_ERROR (Status)) {\r
+    if (Status != EFI_SUCCESS) {\r
       //\r
       // Call platform action to indicate the boot fail\r
       //\r
@@ -233,18 +296,26 @@ BdsBootDeviceSelect (
       //\r
       // Call platform action to indicate the boot success\r
       //\r
-      BootOption->StatusString = GetStringById (STRING_TOKEN (STR_BOOT_SUCCEEDED)); \r
+      BootOption->StatusString = GetStringById (STRING_TOKEN (STR_BOOT_SUCCEEDED));\r
       PlatformBdsBootSuccess (BootOption);\r
 \r
       //\r
       // Boot success, then stop process the boot order, and\r
       // present the boot manager menu, front page\r
       //\r
+\r
+      //\r
+      // When LazyConIn enabled, signal connect ConIn Event before enter UI\r
+      //\r
+      if (PcdGetBool (PcdConInConnectOnDemand) && ConnectConInEvent != NULL) {\r
+        gBS->SignalEvent (ConnectConInEvent);\r
+      }\r
+\r
       Timeout = 0xffff;\r
       PlatformBdsEnterFrontPage (Timeout, FALSE);\r
 \r
       //\r
-      // Rescan the boot option list, avoid pertential risk of the boot\r
+      // Rescan the boot option list, avoid potential risk of the boot\r
       // option change in front page\r
       //\r
       if (BootNextExist) {\r
@@ -266,6 +337,167 @@ BdsBootDeviceSelect (
 \r
 }\r
 \r
+/**\r
+\r
+  Validate input console variable data. \r
+\r
+  If found the device path is not a valid device path, remove the variable.\r
+  \r
+  @param VariableName             Input console variable name.\r
+\r
+**/\r
+VOID\r
+BdsFormalizeConsoleVariable (\r
+  IN  CHAR16          *VariableName\r
+  )\r
+{\r
+  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
+  UINTN                     VariableSize;\r
+  EFI_STATUS                Status;\r
+\r
+  DevicePath = BdsLibGetVariableAndSize (\r
+                      VariableName,\r
+                      &gEfiGlobalVariableGuid,\r
+                      &VariableSize\r
+                      );\r
+  if ((DevicePath != NULL) && !IsDevicePathValid (DevicePath, VariableSize)) { \r
+    Status = gRT->SetVariable (\r
+                    VariableName,\r
+                    &gEfiGlobalVariableGuid,\r
+                    EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
+                    0,\r
+                    NULL\r
+                    );\r
+    ASSERT_EFI_ERROR (Status);\r
+  }\r
+}\r
+\r
+/**\r
+\r
+  Formalize Bds global variables. \r
+\r
+ 1. For ConIn/ConOut/ConErr, if found the device path is not a valid device path, remove the variable.\r
+ 2. For OsIndicationsSupported, Create a BS/RT/UINT64 variable to report caps \r
+ 3. Delete OsIndications variable if it is not NV/BS/RT UINT64\r
+ Item 3 is used to solve case when OS corrupts OsIndications. Here simply delete this NV variable.\r
\r
+**/\r
+VOID \r
+BdsFormalizeEfiGlobalVariable (\r
+  VOID\r
+  )\r
+{\r
+  EFI_STATUS Status;\r
+  UINT64     OsIndicationSupport;\r
+  UINT64     OsIndication;\r
+  UINTN      DataSize;\r
+  UINT32     Attributes;\r
+  \r
+  //\r
+  // Validate Console variable.\r
+  //\r
+  BdsFormalizeConsoleVariable (L"ConIn");\r
+  BdsFormalizeConsoleVariable (L"ConOut");\r
+  BdsFormalizeConsoleVariable (L"ErrOut");\r
+\r
+  //\r
+  // OS indicater support variable\r
+  //\r
+  OsIndicationSupport = EFI_OS_INDICATIONS_BOOT_TO_FW_UI;\r
+  Status = gRT->SetVariable (\r
+                  L"OsIndicationsSupported",\r
+                  &gEfiGlobalVariableGuid,\r
+                  EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
+                  sizeof(UINT64),\r
+                  &OsIndicationSupport\r
+                  );\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
+  //\r
+  // If OsIndications is invalid, remove it.\r
+  // Invalid case\r
+  //   1. Data size != UINT64\r
+  //   2. OsIndication value inconsistence\r
+  //   3. OsIndication attribute inconsistence\r
+  //\r
+  OsIndication = 0;\r
+  Attributes = 0;\r
+  DataSize = sizeof(UINT64);\r
+  Status = gRT->GetVariable (\r
+                  L"OsIndications",\r
+                  &gEfiGlobalVariableGuid,\r
+                  &Attributes,\r
+                  &DataSize,\r
+                  &OsIndication\r
+                  );\r
+\r
+  if (!EFI_ERROR(Status)) {\r
+    if (DataSize != sizeof(UINT64) ||\r
+        (OsIndication & ~OsIndicationSupport) != 0 ||\r
+        Attributes != (EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE)){\r
+\r
+      DEBUG ((EFI_D_ERROR, "Unformalized OsIndications variable exists. Delete it\n"));\r
+      Status = gRT->SetVariable (\r
+                      L"OsIndications",\r
+                      &gEfiGlobalVariableGuid,\r
+                      Attributes,\r
+                      0,\r
+                      &OsIndication\r
+                      );\r
+      ASSERT_EFI_ERROR (Status);\r
+    }\r
+  }\r
+\r
+}\r
+\r
+/**\r
+\r
+  Allocate a block of memory that will contain performance data to OS.\r
+\r
+**/\r
+VOID\r
+BdsAllocateMemoryForPerformanceData (\r
+  VOID\r
+  )\r
+{\r
+  EFI_STATUS                    Status;\r
+  EFI_PHYSICAL_ADDRESS          AcpiLowMemoryBase;\r
+  EDKII_VARIABLE_LOCK_PROTOCOL  *VariableLock;\r
+\r
+  AcpiLowMemoryBase = 0x0FFFFFFFFULL;\r
+\r
+  //\r
+  // Allocate a block of memory that will contain performance data to OS.\r
+  //\r
+  Status = gBS->AllocatePages (\r
+                  AllocateMaxAddress,\r
+                  EfiReservedMemoryType,\r
+                  EFI_SIZE_TO_PAGES (PERF_DATA_MAX_LENGTH),\r
+                  &AcpiLowMemoryBase\r
+                  );\r
+  if (!EFI_ERROR (Status)) {\r
+    //\r
+    // Save the pointer to variable for use in S3 resume.\r
+    //\r
+    Status = gRT->SetVariable (\r
+               L"PerfDataMemAddr",\r
+               &gPerformanceProtocolGuid,\r
+               EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
+               sizeof (EFI_PHYSICAL_ADDRESS),\r
+               &AcpiLowMemoryBase\r
+               );\r
+    ASSERT_EFI_ERROR (Status);\r
+    //\r
+    // Mark L"PerfDataMemAddr" variable to read-only if the Variable Lock protocol exists\r
+    //\r
+    Status = gBS->LocateProtocol (&gEdkiiVariableLockProtocolGuid, NULL, (VOID **) &VariableLock);\r
+    if (!EFI_ERROR (Status)) {\r
+      Status = VariableLock->RequestToLock (VariableLock, L"PerfDataMemAddr", &gPerformanceProtocolGuid);\r
+      ASSERT_EFI_ERROR (Status);\r
+    }\r
+  }\r
+}\r
+\r
 /**\r
 \r
   Service routine for BdsInstance->Entry(). Devices are connected, the\r
@@ -280,16 +512,24 @@ BdsEntry (
   IN EFI_BDS_ARCH_PROTOCOL  *This\r
   )\r
 {\r
-  EFI_BDS_ARCH_PROTOCOL_INSTANCE  *PrivateData;\r
   LIST_ENTRY                      DriverOptionList;\r
   LIST_ENTRY                      BootOptionList;\r
   UINTN                           BootNextSize;\r
+  CHAR16                          *FirmwareVendor;\r
+  EFI_STATUS                      Status;\r
+  UINT16                          BootTimeOut;\r
+  UINTN                           Index;\r
+  EDKII_VARIABLE_LOCK_PROTOCOL    *VariableLock;\r
 \r
   //\r
   // Insert the performance probe\r
   //\r
-  PERF_END (0, "DXE", NULL, 0);\r
-  PERF_START (0, "BDS", NULL, 0);\r
+  PERF_END (NULL, "DXE", NULL, 0);\r
+  PERF_START (NULL, "BDS", NULL, 0);\r
+\r
+  PERF_CODE (\r
+    BdsAllocateMemoryForPerformanceData ();\r
+  );\r
 \r
   //\r
   // Initialize the global system boot option and driver option\r
@@ -303,19 +543,65 @@ BdsEntry (
   InitializeHotkeyService ();\r
 \r
   //\r
-  // Get the BDS private data\r
+  // Fill in FirmwareVendor and FirmwareRevision from PCDs\r
   //\r
-  PrivateData = EFI_BDS_ARCH_PROTOCOL_INSTANCE_FROM_THIS (This);\r
+  FirmwareVendor = (CHAR16 *)PcdGetPtr (PcdFirmwareVendor);\r
+  gST->FirmwareVendor = AllocateRuntimeCopyPool (StrSize (FirmwareVendor), FirmwareVendor);\r
+  ASSERT (gST->FirmwareVendor != NULL);\r
+  gST->FirmwareRevision = PcdGet32 (PcdFirmwareRevision);\r
 \r
   //\r
-  // Do the platform init, can be customized by OEM/IBV\r
+  // Fixup Tasble CRC after we updated Firmware Vendor and Revision\r
+  //\r
+  gST->Hdr.CRC32 = 0;\r
+  gBS->CalculateCrc32 ((VOID *)gST, sizeof(EFI_SYSTEM_TABLE), &gST->Hdr.CRC32);\r
+\r
+  //\r
+  // Validate Variable.\r
+  //\r
+  BdsFormalizeEfiGlobalVariable();\r
+\r
+  //\r
+  // Mark the read-only variables if the Variable Lock protocol exists\r
   //\r
-  PERF_START (0, "PlatformBds", "BDS", 0);\r
-  PlatformBdsInit (PrivateData);\r
+  Status = gBS->LocateProtocol (&gEdkiiVariableLockProtocolGuid, NULL, (VOID **) &VariableLock);\r
+  DEBUG ((EFI_D_INFO, "[BdsDxe] Locate Variable Lock protocol - %r\n", Status));\r
+  if (!EFI_ERROR (Status)) {\r
+    for (Index = 0; Index < sizeof (mReadOnlyVariables) / sizeof (mReadOnlyVariables[0]); Index++) {\r
+      Status = VariableLock->RequestToLock (VariableLock, mReadOnlyVariables[Index], &gEfiGlobalVariableGuid);\r
+      ASSERT_EFI_ERROR (Status);\r
+    }\r
+  }\r
+\r
+  //\r
+  // Report Status Code to indicate connecting drivers will happen\r
+  //\r
+  REPORT_STATUS_CODE (\r
+    EFI_PROGRESS_CODE,\r
+    (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_DXE_BS_PC_BEGIN_CONNECTING_DRIVERS)\r
+    );\r
+\r
+  InitializeHwErrRecSupport();\r
 \r
-  if (FeaturePcdGet (PcdSupportHardwareErrorRecord)) {\r
-    InitializeHwErrRecSupport (PcdGet16 (PcdHardwareErrorRecordLevel));\r
+  //\r
+  // Initialize L"Timeout" EFI global variable.\r
+  //\r
+  BootTimeOut = PcdGet16 (PcdPlatformBootTimeOut);\r
+  if (BootTimeOut != 0xFFFF) {\r
+    //\r
+    // If time out value equal 0xFFFF, no need set to 0xFFFF to variable area because UEFI specification\r
+    // define same behavior between no value or 0xFFFF value for L"Timeout".\r
+    //\r
+    Status = gRT->SetVariable (\r
+                    L"Timeout",\r
+                    &gEfiGlobalVariableGuid,\r
+                    EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
+                    sizeof (UINT16),\r
+                    &BootTimeOut\r
+                    );\r
+    ASSERT_EFI_ERROR(Status);\r
   }\r
+\r
   //\r
   // bugbug: platform specific code\r
   // Initialize the platform specific string and language\r
@@ -324,6 +610,12 @@ BdsEntry (
   InitializeLanguage (TRUE);\r
   InitializeFrontPage (TRUE);\r
 \r
+  //\r
+  // Do the platform init, can be customized by OEM/IBV\r
+  //\r
+  PERF_START (NULL, "PlatformBds", "BDS", 0);\r
+  PlatformBdsInit ();\r
+\r
   //\r
   // Set up the device list based on EFI 1.1 variables\r
   // process Driver#### and Load the driver's in the\r
@@ -345,8 +637,8 @@ BdsEntry (
   //\r
   // Setup some platform policy here\r
   //\r
-  PlatformBdsPolicyBehavior (PrivateData, &DriverOptionList, &BootOptionList);\r
-  PERF_END (0, "PlatformBds", "BDS", 0);\r
+  PlatformBdsPolicyBehavior (&DriverOptionList, &BootOptionList, BdsProcessCapsules, BdsMemoryTest);\r
+  PERF_END (NULL, "PlatformBds", "BDS", 0);\r
 \r
   //\r
   // BDS select the boot device to load OS\r