]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkModulePkg/Library/GenericBdsLib/BdsMisc.c
Do not reset system when the MemoryTypeInformation variable cannot be written.
[mirror_edk2.git] / IntelFrameworkModulePkg / Library / GenericBdsLib / BdsMisc.c
index 904e968db95f6f48951d343e5dd31a2ca833b513..cafbe71e25993f28fc5976713f2768168e13f2db 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Misc BDS library function\r
 \r
-Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2004 - 2014, 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
@@ -257,6 +257,14 @@ BdsLibRegisterNewOption (
     if (OptionPtr == NULL) {\r
       continue;\r
     }\r
+\r
+    //\r
+    // Validate the variable.\r
+    //\r
+    if (!ValidateOption(OptionPtr, OptionSize)) {\r
+      continue;\r
+    }\r
+\r
     TempPtr         =   OptionPtr;\r
     TempPtr         +=  sizeof (UINT32) + sizeof (UINT16);\r
     Description     =   (CHAR16 *) TempPtr;\r
@@ -425,7 +433,7 @@ GetDevicePathSizeEx (
   Size = 0;\r
   while (!IsDevicePathEnd (DevicePath)) {\r
     NodeSize = DevicePathNodeLength (DevicePath);\r
-    if (NodeSize == 0) {\r
+    if (NodeSize < END_DEVICE_PATH_LENGTH) {\r
       return 0;\r
     }\r
     Size += NodeSize;\r
@@ -447,7 +455,7 @@ GetDevicePathSizeEx (
   bigger than MaxStringLen, return length 0 to indicate that this is an \r
   invalidate string.\r
 \r
-  This function returns the number of Unicode characters in the Null-terminated\r
+  This function returns the byte length of Unicode characters in the Null-terminated\r
   Unicode string specified by String. \r
 \r
   If String is NULL, then ASSERT().\r
@@ -471,13 +479,100 @@ StrSizeEx (
   ASSERT (String != NULL && MaxStringLen != 0);\r
   ASSERT (((UINTN) String & BIT0) == 0);\r
 \r
-  for (Length = 0; *String != L'\0' && MaxStringLen != Length; String++, Length++);\r
+  for (Length = 0; *String != L'\0' && MaxStringLen != Length; String++, Length+=2);\r
 \r
   if (*String != L'\0' && MaxStringLen == Length) {\r
     return 0;\r
   }\r
 \r
-  return (Length + 1) * sizeof (*String);\r
+  return Length + 2;\r
+}\r
+\r
+/**\r
+  Validate the EFI Boot#### variable (VendorGuid/Name)\r
+\r
+  @param  Variable              Boot#### variable data.\r
+  @param  VariableSize          Returns the size of the EFI variable that was read\r
+\r
+  @retval TRUE                  The variable data is correct.\r
+  @retval FALSE                 The variable data is corrupted.\r
+\r
+**/\r
+BOOLEAN \r
+ValidateOption (\r
+  UINT8                     *Variable,\r
+  UINTN                     VariableSize\r
+  )\r
+{\r
+  UINT16                    FilePathSize;\r
+  UINT8                     *TempPtr;\r
+  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
+  UINTN                     TempSize;\r
+\r
+  if (VariableSize <= sizeof (UINT16) + sizeof (UINT32)) {\r
+    return FALSE;\r
+  }\r
+\r
+  //\r
+  // Skip the option attribute\r
+  //\r
+  TempPtr    = Variable;\r
+  TempPtr   += sizeof (UINT32);\r
+\r
+  //\r
+  // Get the option's device path size\r
+  //\r
+  FilePathSize  = *(UINT16 *) TempPtr;\r
+  TempPtr      += sizeof (UINT16);\r
+\r
+  //\r
+  // Get the option's description string size\r
+  //\r
+  TempSize = StrSizeEx ((CHAR16 *) TempPtr, VariableSize - sizeof (UINT16) - sizeof (UINT32));\r
+  TempPtr += TempSize;\r
+\r
+  //\r
+  // Get the option's device path\r
+  //\r
+  DevicePath =  (EFI_DEVICE_PATH_PROTOCOL *) TempPtr;\r
+  TempPtr   += FilePathSize;\r
+\r
+  //\r
+  // Validation boot option variable.\r
+  //\r
+  if ((FilePathSize == 0) || (TempSize == 0)) {\r
+    return FALSE;\r
+  }\r
+\r
+  if (TempSize + FilePathSize + sizeof (UINT16) + sizeof (UINT32) > VariableSize) {\r
+    return FALSE;\r
+  }\r
+\r
+  return (BOOLEAN) (GetDevicePathSizeEx (DevicePath, FilePathSize) != 0);\r
+}\r
+\r
+/**\r
+  Convert a single character to number.\r
+  It assumes the input Char is in the scope of L'0' ~ L'9' and L'A' ~ L'F'\r
+  \r
+  @param Char    The input char which need to change to a hex number.\r
+  \r
+**/\r
+UINTN\r
+CharToUint (\r
+  IN CHAR16                           Char\r
+  )\r
+{\r
+  if ((Char >= L'0') && (Char <= L'9')) {\r
+    return (UINTN) (Char - L'0');\r
+  }\r
+\r
+  if ((Char >= L'A') && (Char <= L'F')) {\r
+    return (UINTN) (Char - L'A' + 0xA);\r
+  }\r
+\r
+  ASSERT (FALSE);\r
+  return 0;\r
 }\r
 \r
 /**\r
@@ -506,13 +601,12 @@ BdsLibVariableToOption (
   UINT8                     *TempPtr;\r
   UINTN                     VariableSize;\r
   EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
-  EFI_DEVICE_PATH_PROTOCOL  *TempPath;\r
   BDS_COMMON_OPTION         *Option;\r
   VOID                      *LoadOptions;\r
   UINT32                    LoadOptionsSize;\r
   CHAR16                    *Description;\r
   UINT8                     NumOff;\r
-  UINTN                     TempSize;\r
+\r
   //\r
   // Read the variable. We will never free this data.\r
   //\r
@@ -524,6 +618,14 @@ BdsLibVariableToOption (
   if (Variable == NULL) {\r
     return NULL;\r
   }\r
+\r
+  //\r
+  // Validate Boot#### variable data.\r
+  //\r
+  if (!ValidateOption(Variable, VariableSize)) {\r
+    return NULL;\r
+  }\r
+\r
   //\r
   // Notes: careful defined the variable of Boot#### or\r
   // Driver####, consider use some macro to abstract the code\r
@@ -549,11 +651,7 @@ BdsLibVariableToOption (
   //\r
   // Get the option's description string size\r
   //\r
-  TempSize = StrSizeEx ((CHAR16 *) TempPtr, VariableSize);\r
-  if (TempSize == 0) {\r
-    return NULL;\r
-  }\r
-  TempPtr += TempSize;\r
+  TempPtr += StrSize((CHAR16 *) TempPtr);\r
 \r
   //\r
   // Get the option's device path\r
@@ -561,26 +659,10 @@ BdsLibVariableToOption (
   DevicePath =  (EFI_DEVICE_PATH_PROTOCOL *) TempPtr;\r
   TempPtr    += FilePathSize;\r
 \r
-  //\r
-  // Validation device path.\r
-  //\r
-  TempPath       = DevicePath;\r
-  while (FilePathSize > 0) {\r
-    TempSize = GetDevicePathSizeEx (TempPath, FilePathSize);\r
-    if (TempSize == 0) {\r
-      return NULL;\r
-    }\r
-    FilePathSize = (UINT16) (FilePathSize - TempSize);\r
-    TempPath    += TempSize;\r
-  }\r
-\r
   //\r
   // Get load opion data.\r
   //\r
   LoadOptions     = TempPtr;\r
-  if (VariableSize < (UINTN)(TempPtr - Variable)) {\r
-    return NULL;\r
-  }\r
   LoadOptionsSize = (UINT32) (VariableSize - (UINTN) (TempPtr - Variable));\r
 \r
   //\r
@@ -613,25 +695,15 @@ BdsLibVariableToOption (
   // Unicode stream to ASCII without any loss in meaning.\r
   //\r
   if (*VariableName == 'B') {\r
-    NumOff = (UINT8) (sizeof (L"Boot") / sizeof(CHAR16) - 1);\r
-    Option->BootCurrent = (UINT16) ((VariableName[NumOff]  -'0') * 0x1000);\r
-    Option->BootCurrent = (UINT16) (Option->BootCurrent + ((VariableName[NumOff+1]-'0') * 0x100));\r
-    Option->BootCurrent = (UINT16) (Option->BootCurrent +  ((VariableName[NumOff+2]-'0') * 0x10));\r
-    Option->BootCurrent = (UINT16) (Option->BootCurrent + ((VariableName[NumOff+3]-'0')));\r
-  }\r
-  //\r
-  // Insert active entry to BdsDeviceList\r
-  //\r
-  if ((Option->Attribute & LOAD_OPTION_ACTIVE) == LOAD_OPTION_ACTIVE) {\r
-    InsertTailList (BdsCommonOptionList, &Option->Link);\r
-    FreePool (Variable);\r
-    return Option;\r
+    NumOff = (UINT8) (sizeof (L"Boot") / sizeof (CHAR16) - 1);\r
+    Option->BootCurrent = (UINT16) (CharToUint (VariableName[NumOff+0]) * 0x1000) \r
+               + (UINT16) (CharToUint (VariableName[NumOff+1]) * 0x100)\r
+               + (UINT16) (CharToUint (VariableName[NumOff+2]) * 0x10)\r
+               + (UINT16) (CharToUint (VariableName[NumOff+3]) * 0x1);\r
   }\r
-\r
+  InsertTailList (BdsCommonOptionList, &Option->Link);\r
   FreePool (Variable);\r
-  FreePool (Option);\r
-  return NULL;\r
-\r
+  return Option;\r
 }\r
 \r
 /**\r
@@ -753,6 +825,7 @@ BdsLibGetVariableAndSize (
     //\r
     Buffer = AllocateZeroPool (BufferSize);\r
     if (Buffer == NULL) {\r
+      *VariableSize = 0;\r
       return NULL;\r
     }\r
     //\r
@@ -760,10 +833,15 @@ BdsLibGetVariableAndSize (
     //\r
     Status = gRT->GetVariable (Name, VendorGuid, NULL, &BufferSize, Buffer);\r
     if (EFI_ERROR (Status)) {\r
+      FreePool (Buffer);\r
       BufferSize = 0;\r
+      Buffer     = NULL;\r
     }\r
   }\r
 \r
+  ASSERT (((Buffer == NULL) && (BufferSize == 0)) ||\r
+          ((Buffer != NULL) && (BufferSize != 0))\r
+          );\r
   *VariableSize = BufferSize;\r
   return Buffer;\r
 }\r
@@ -1046,24 +1124,19 @@ SetupResetReminder (
       ASSERT (StringBuffer1 != NULL);\r
       StringBuffer2 = AllocateZeroPool (MAX_STRING_LEN * sizeof (CHAR16));\r
       ASSERT (StringBuffer2 != NULL);\r
-      StrCpy (StringBuffer1, L"Configuration changed. Reset to apply it Now ? ");\r
-      StrCpy (StringBuffer2, L"Enter (YES)  /   Esc (NO)");\r
+      StrCpy (StringBuffer1, L"Configuration changed. Reset to apply it Now.");\r
+      StrCpy (StringBuffer2, L"Press ENTER to reset");\r
       //\r
       // Popup a menu to notice user\r
       //\r
       do {\r
         CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, StringBuffer1, StringBuffer2, NULL);\r
-      } while ((Key.ScanCode != SCAN_ESC) && (Key.UnicodeChar != CHAR_CARRIAGE_RETURN));\r
+      } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);\r
 \r
       FreePool (StringBuffer1);\r
       FreePool (StringBuffer2);\r
-      //\r
-      // If the user hits the YES Response key, reset\r
-      //\r
-      if (Key.UnicodeChar == CHAR_CARRIAGE_RETURN) {\r
-        gRT->ResetSystem (EfiResetCold, EFI_SUCCESS, 0, NULL);\r
-      }\r
-      gST->ConOut->ClearScreen (gST->ConOut);\r
+\r
+      gRT->ResetSystem (EfiResetCold, EFI_SUCCESS, 0, NULL);\r
     }\r
   }\r
 }\r
@@ -1210,10 +1283,8 @@ BdsLibGetImageHeader (
 }\r
 \r
 /**\r
-  This routine adjusts the memory information for different memory type and \r
-  saves them into the variables for next boot. It conditionally resets the\r
-  system when the memory information changes. Platform can reserve memory \r
-  large enough (125% of actual requirement) to avoid the reset in the first boot.\r
+  This routine adjust the memory information for different memory type and \r
+  save them into the variables for next boot.\r
 **/\r
 VOID\r
 BdsSetMemoryTypeInformationVariable (\r
@@ -1319,13 +1390,14 @@ BdsSetMemoryTypeInformationVariable (
     Next     = Previous;\r
 \r
     //\r
-    // Write next varible to 125% * current and Inconsistent Memory Reserved across bootings may lead to S4 fail\r
+    // Inconsistent Memory Reserved across bootings may lead to S4 fail\r
+    // Write next varible to 125% * current when the pre-allocated memory is:\r
+    //  1. More than 150% of needed memory and boot mode is BOOT_WITH_DEFAULT_SETTING\r
+    //  2. Less than the needed memory\r
     //\r
-    if (Current < Previous) {\r
+    if ((Current + (Current >> 1)) < Previous) {\r
       if (BootMode == BOOT_WITH_DEFAULT_SETTINGS) {\r
         Next = Current + (Current >> 2);\r
-      } else if (!MemoryTypeInformationVariableExists) {\r
-        Next = MAX (Current + (Current >> 2), Previous);\r
       }\r
     } else if (Current > Previous) {\r
       Next = Current + (Current >> 2);\r
@@ -1350,19 +1422,23 @@ BdsSetMemoryTypeInformationVariable (
     Status = gRT->SetVariable (\r
                     EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME,\r
                     &gEfiMemoryTypeInformationGuid,\r
-                    EFI_VARIABLE_NON_VOLATILE  | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
+                    EFI_VARIABLE_NON_VOLATILE  | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
                     VariableSize,\r
                     PreviousMemoryTypeInformation\r
                     );\r
 \r
-    //\r
-    // If the Memory Type Information settings have been modified, then reset the platform\r
-    // so the new Memory Type Information setting will be used to guarantee that an S4\r
-    // entry/resume cycle will not fail.\r
-    //\r
-    if (MemoryTypeInformationModified && PcdGetBool (PcdResetOnMemoryTypeInformationChange)) {\r
-      DEBUG ((EFI_D_INFO, "Memory Type Information settings change. Warm Reset!!!\n"));\r
-      gRT->ResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);\r
+    if (!EFI_ERROR (Status)) {\r
+      //\r
+      // If the Memory Type Information settings have been modified, then reset the platform\r
+      // so the new Memory Type Information setting will be used to guarantee that an S4\r
+      // entry/resume cycle will not fail.\r
+      //\r
+      if (MemoryTypeInformationModified && PcdGetBool (PcdResetOnMemoryTypeInformationChange)) {\r
+        DEBUG ((EFI_D_INFO, "Memory Type Information settings change. Warm Reset!!!\n"));\r
+        gRT->ResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);\r
+      }\r
+    } else {\r
+      DEBUG ((EFI_D_ERROR, "Memory Type Information settings cannot be saved. OS S4 may fail!\n"));\r
     }\r
   }\r
 }\r