MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Library / UefiBootManagerLib / BmMisc.c

/** @file\r
  Misc library functions.\r
\r
Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
(C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "InternalBm.h"\r
\r
/**\r
  Delete the instance in Multi which matches partly with Single instance\r
\r
  @param  Multi                 A pointer to a multi-instance device path data\r
                                structure.\r
  @param  Single                A pointer to a single-instance device path data\r
                                structure.\r
\r
  @return This function will remove the device path instances in Multi which partly\r
          match with the Single, and return the result device path. If there is no\r
          remaining device path as a result, this function will return NULL.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
BmDelPartMatchInstance (\r
  IN     EFI_DEVICE_PATH_PROTOCOL  *Multi,\r
  IN     EFI_DEVICE_PATH_PROTOCOL  *Single\r
  )\r
{\r
  EFI_DEVICE_PATH_PROTOCOL  *Instance;\r
  EFI_DEVICE_PATH_PROTOCOL  *NewDevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL  *TempNewDevicePath;\r
  UINTN                     InstanceSize;\r
  UINTN                     SingleDpSize;\r
\r
  NewDevicePath     = NULL;\r
  TempNewDevicePath = NULL;\r
\r
  if (Multi == NULL || Single == NULL) {\r
    return Multi;\r
  }\r
\r
  Instance        = GetNextDevicePathInstance (&Multi, &InstanceSize);\r
  SingleDpSize    = GetDevicePathSize (Single) - END_DEVICE_PATH_LENGTH;\r
  InstanceSize   -= END_DEVICE_PATH_LENGTH;\r
\r
  while (Instance != NULL) {\r
\r
    if (CompareMem (Instance, Single, MIN (SingleDpSize, InstanceSize)) != 0) {\r
      //\r
      // Append the device path instance which does not match with Single\r
      //\r
      TempNewDevicePath = NewDevicePath;\r
      NewDevicePath = AppendDevicePathInstance (NewDevicePath, Instance);\r
      if (TempNewDevicePath != NULL) {\r
        FreePool(TempNewDevicePath);\r
      }\r
    }\r
    FreePool(Instance);\r
    Instance      = GetNextDevicePathInstance (&Multi, &InstanceSize);\r
    InstanceSize -= END_DEVICE_PATH_LENGTH;\r
  }\r
\r
  return NewDevicePath;\r
}\r
\r
/**\r
  Function compares a device path data structure to that of all the nodes of a\r
  second device path instance.\r
\r
  @param  Multi                 A pointer to a multi-instance device path data\r
                                structure.\r
  @param  Single                A pointer to a single-instance device path data\r
                                structure.\r
\r
  @retval TRUE                  If the Single device path is contained within Multi device path.\r
  @retval FALSE                 The Single device path is not match within Multi device path.\r
\r
**/\r
BOOLEAN\r
BmMatchDevicePaths (\r
  IN  EFI_DEVICE_PATH_PROTOCOL  *Multi,\r
  IN  EFI_DEVICE_PATH_PROTOCOL  *Single\r
  )\r
{\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePathInst;\r
  UINTN                     Size;\r
\r
  if (Multi == NULL || Single  == NULL) {\r
    return FALSE;\r
  }\r
\r
  DevicePath     = Multi;\r
  DevicePathInst = GetNextDevicePathInstance (&DevicePath, &Size);\r
\r
  //\r
  // Search for the match of 'Single' in 'Multi'\r
  //\r
  while (DevicePathInst != NULL) {\r
    //\r
    // If the single device path is found in multiple device paths,\r
    // return success\r
    //\r
    if (CompareMem (Single, DevicePathInst, Size) == 0) {\r
      FreePool (DevicePathInst);\r
      return TRUE;\r
    }\r
\r
    FreePool (DevicePathInst);\r
    DevicePathInst = GetNextDevicePathInstance (&DevicePath, &Size);\r
  }\r
\r
  return FALSE;\r
}\r
\r
/**\r
  This routine adjust the memory information for different memory type and\r
  save them into the variables for next boot. It resets the system when\r
  memory information is updated and the current boot option belongs to\r
  boot category instead of application category. It doesn't count the\r
  reserved memory occupied by RAM Disk.\r
\r
  @param Boot               TRUE if current boot option belongs to boot\r
                            category instead of application category.\r
**/\r
VOID\r
BmSetMemoryTypeInformationVariable (\r
  IN BOOLEAN                    Boot\r
  )\r
{\r
  EFI_STATUS                   Status;\r
  EFI_MEMORY_TYPE_INFORMATION  *PreviousMemoryTypeInformation;\r
  EFI_MEMORY_TYPE_INFORMATION  *CurrentMemoryTypeInformation;\r
  UINTN                        VariableSize;\r
  UINTN                        Index;\r
  UINTN                        Index1;\r
  UINT32                       Previous;\r
  UINT32                       Current;\r
  UINT32                       Next;\r
  EFI_HOB_GUID_TYPE            *GuidHob;\r
  BOOLEAN                      MemoryTypeInformationModified;\r
  BOOLEAN                      MemoryTypeInformationVariableExists;\r
  EFI_BOOT_MODE                BootMode;\r
\r
  MemoryTypeInformationModified       = FALSE;\r
  MemoryTypeInformationVariableExists = FALSE;\r
\r
\r
  BootMode = GetBootModeHob ();\r
  //\r
  // In BOOT_IN_RECOVERY_MODE, Variable region is not reliable.\r
  //\r
  if (BootMode == BOOT_IN_RECOVERY_MODE) {\r
    return;\r
  }\r
\r
  //\r
  // Only check the the Memory Type Information variable in the boot mode\r
  // other than BOOT_WITH_DEFAULT_SETTINGS because the Memory Type\r
  // Information is not valid in this boot mode.\r
  //\r
  if (BootMode != BOOT_WITH_DEFAULT_SETTINGS) {\r
    VariableSize = 0;\r
    Status = gRT->GetVariable (\r
                    EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME,\r
                    &gEfiMemoryTypeInformationGuid,\r
                    NULL,\r
                    &VariableSize,\r
                    NULL\r
                    );\r
    if (Status == EFI_BUFFER_TOO_SMALL) {\r
      MemoryTypeInformationVariableExists = TRUE;\r
    }\r
  }\r
\r
  //\r
  // Retrieve the current memory usage statistics.  If they are not found, then\r
  // no adjustments can be made to the Memory Type Information variable.\r
  //\r
  Status = EfiGetSystemConfigurationTable (\r
             &gEfiMemoryTypeInformationGuid,\r
             (VOID **) &CurrentMemoryTypeInformation\r
             );\r
  if (EFI_ERROR (Status) || CurrentMemoryTypeInformation == NULL) {\r
    return;\r
  }\r
\r
  //\r
  // Get the Memory Type Information settings from Hob if they exist,\r
  // PEI is responsible for getting them from variable and build a Hob to save them.\r
  // If the previous Memory Type Information is not available, then set defaults\r
  //\r
  GuidHob = GetFirstGuidHob (&gEfiMemoryTypeInformationGuid);\r
  if (GuidHob == NULL) {\r
    //\r
    // If Platform has not built Memory Type Info into the Hob, just return.\r
    //\r
    return;\r
  }\r
  VariableSize                  = GET_GUID_HOB_DATA_SIZE (GuidHob);\r
  PreviousMemoryTypeInformation = AllocateCopyPool (VariableSize, GET_GUID_HOB_DATA (GuidHob));\r
  if (PreviousMemoryTypeInformation == NULL) {\r
    return;\r
  }\r
\r
  //\r
  // Use a heuristic to adjust the Memory Type Information for the next boot\r
  //\r
  DEBUG ((EFI_D_INFO, "Memory  Previous  Current    Next   \n"));\r
  DEBUG ((EFI_D_INFO, " Type    Pages     Pages     Pages  \n"));\r
  DEBUG ((EFI_D_INFO, "======  ========  ========  ========\n"));\r
\r
  for (Index = 0; PreviousMemoryTypeInformation[Index].Type != EfiMaxMemoryType; Index++) {\r
\r
    for (Index1 = 0; CurrentMemoryTypeInformation[Index1].Type != EfiMaxMemoryType; Index1++) {\r
      if (PreviousMemoryTypeInformation[Index].Type == CurrentMemoryTypeInformation[Index1].Type) {\r
        break;\r
      }\r
    }\r
    if (CurrentMemoryTypeInformation[Index1].Type == EfiMaxMemoryType) {\r
      continue;\r
    }\r
\r
    //\r
    // Previous is the number of pages pre-allocated\r
    // Current is the number of pages actually needed\r
    //\r
    Previous = PreviousMemoryTypeInformation[Index].NumberOfPages;\r
    Current  = CurrentMemoryTypeInformation[Index1].NumberOfPages;\r
    Next     = Previous;\r
\r
    //\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 + (Current >> 1)) < Previous) {\r
      if (BootMode == BOOT_WITH_DEFAULT_SETTINGS) {\r
        Next = Current + (Current >> 2);\r
      }\r
    } else if (Current > Previous) {\r
      Next = Current + (Current >> 2);\r
    }\r
    if (Next > 0 && Next < 4) {\r
      Next = 4;\r
    }\r
\r
    if (Next != Previous) {\r
      PreviousMemoryTypeInformation[Index].NumberOfPages = Next;\r
      MemoryTypeInformationModified = TRUE;\r
    }\r
\r
    DEBUG ((EFI_D_INFO, "  %02x    %08x  %08x  %08x\n", PreviousMemoryTypeInformation[Index].Type, Previous, Current, Next));\r
  }\r
\r
  //\r
  // If any changes were made to the Memory Type Information settings, then set the new variable value;\r
  // Or create the variable in first boot.\r
  //\r
  if (MemoryTypeInformationModified || !MemoryTypeInformationVariableExists) {\r
    Status = BmSetVariableAndReportStatusCodeOnError (\r
               EFI_MEMORY_TYPE_INFORMATION_VARIABLE_NAME,\r
               &gEfiMemoryTypeInformationGuid,\r
               EFI_VARIABLE_NON_VOLATILE  | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
               VariableSize,\r
               PreviousMemoryTypeInformation\r
               );\r
\r
    if (!EFI_ERROR (Status)) {\r
      //\r
      // If the Memory Type Information settings have been modified and the boot option belongs to boot category,\r
      // then reset the platform 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) {\r
        DEBUG ((EFI_D_INFO, "Memory Type Information settings change.\n"));\r
        if (Boot && PcdGetBool (PcdResetOnMemoryTypeInformationChange)) {\r
          DEBUG ((EFI_D_INFO, "...Warm Reset!!!\n"));\r
          gRT->ResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);\r
        }\r
      }\r
    } else {\r
      DEBUG ((EFI_D_ERROR, "Memory Type Information settings cannot be saved. OS S4 may fail!\n"));\r
    }\r
  }\r
  FreePool (PreviousMemoryTypeInformation);\r
}\r
\r
/**\r
  Set the variable and report the error through status code upon failure.\r
\r
  @param  VariableName           A Null-terminated string that is the name of the vendor's variable.\r
                                 Each VariableName is unique for each VendorGuid. VariableName must\r
                                 contain 1 or more characters. If VariableName is an empty string,\r
                                 then EFI_INVALID_PARAMETER is returned.\r
  @param  VendorGuid             A unique identifier for the vendor.\r
  @param  Attributes             Attributes bitmask to set for the variable.\r
  @param  DataSize               The size in bytes of the Data buffer. Unless the EFI_VARIABLE_APPEND_WRITE,\r
                                 or EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute is set, a size of zero\r
                                 causes the variable to be deleted. When the EFI_VARIABLE_APPEND_WRITE attribute is\r
                                 set, then a SetVariable() call with a DataSize of zero will not cause any change to\r
                                 the variable value (the timestamp associated with the variable may be updated however\r
                                 even if no new data value is provided,see the description of the\r
                                 EFI_VARIABLE_AUTHENTICATION_2 descriptor below. In this case the DataSize will not\r
                                 be zero since the EFI_VARIABLE_AUTHENTICATION_2 descriptor will be populated).\r
  @param  Data                   The contents for the variable.\r
\r
  @retval EFI_SUCCESS            The firmware has successfully stored the variable and its data as\r
                                 defined by the Attributes.\r
  @retval EFI_INVALID_PARAMETER  An invalid combination of attribute bits, name, and GUID was supplied, or the\r
                                 DataSize exceeds the maximum allowed.\r
  @retval EFI_INVALID_PARAMETER  VariableName is an empty string.\r
  @retval EFI_OUT_OF_RESOURCES   Not enough storage is available to hold the variable and its data.\r
  @retval EFI_DEVICE_ERROR       The variable could not be retrieved due to a hardware error.\r
  @retval EFI_WRITE_PROTECTED    The variable in question is read-only.\r
  @retval EFI_WRITE_PROTECTED    The variable in question cannot be deleted.\r
  @retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACESS\r
                                 being set, but the AuthInfo does NOT pass the validation check carried out by the firmware.\r
\r
  @retval EFI_NOT_FOUND          The variable trying to be updated or deleted was not found.\r
**/\r
EFI_STATUS\r
BmSetVariableAndReportStatusCodeOnError (\r
  IN CHAR16     *VariableName,\r
  IN EFI_GUID   *VendorGuid,\r
  IN UINT32     Attributes,\r
  IN UINTN      DataSize,\r
  IN VOID       *Data\r
  )\r
{\r
  EFI_STATUS                 Status;\r
  EDKII_SET_VARIABLE_STATUS  *SetVariableStatus;\r
  UINTN                      NameSize;\r
\r
  Status = gRT->SetVariable (\r
                  VariableName,\r
                  VendorGuid,\r
                  Attributes,\r
                  DataSize,\r
                  Data\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    NameSize = StrSize (VariableName);\r
    SetVariableStatus = AllocatePool (sizeof (EDKII_SET_VARIABLE_STATUS) + NameSize + DataSize);\r
    if (SetVariableStatus != NULL) {\r
      CopyGuid (&SetVariableStatus->Guid, VendorGuid);\r
      SetVariableStatus->NameSize   = NameSize;\r
      SetVariableStatus->DataSize   = DataSize;\r
      SetVariableStatus->SetStatus  = Status;\r
      SetVariableStatus->Attributes = Attributes;\r
      CopyMem (SetVariableStatus + 1,                          VariableName, NameSize);\r
      CopyMem (((UINT8 *) (SetVariableStatus + 1)) + NameSize, Data,         DataSize);\r
\r
      REPORT_STATUS_CODE_EX (\r
        EFI_ERROR_CODE,\r
        PcdGet32 (PcdErrorCodeSetVariable),\r
        0,\r
        NULL,\r
        &gEdkiiStatusCodeDataTypeVariableGuid,\r
        SetVariableStatus,\r
        sizeof (EDKII_SET_VARIABLE_STATUS) + NameSize + DataSize\r
        );\r
\r
      FreePool (SetVariableStatus);\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Print the device path info.\r
\r
  @param DevicePath           The device path need to print.\r
**/\r
VOID\r
BmPrintDp (\r
  EFI_DEVICE_PATH_PROTOCOL            *DevicePath\r
  )\r
{\r
  CHAR16                              *Str;\r
\r
  Str = ConvertDevicePathToText (DevicePath, FALSE, FALSE);\r
  DEBUG ((EFI_D_INFO, "%s", Str));\r
  if (Str != NULL) {\r
    FreePool (Str);\r
  }\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 convert to int.\r
\r
  @return  The converted 8-bit number or (UINTN) -1 if conversion failed.\r
**/\r
UINTN\r
BmCharToUint (\r
  IN CHAR16                           Char\r
  )\r
{\r
  if ((Char >= L'0') && (Char <= L'9')) {\r
    return (Char - L'0');\r
  }\r
\r
  if ((Char >= L'A') && (Char <= L'F')) {\r
    return (Char - L'A' + 0xA);\r
  }\r
\r
  return (UINTN) -1;\r
}\r
\r
/**\r
  Dispatch the deferred images that are returned from all DeferredImageLoad instances.\r
\r
  @retval EFI_SUCCESS       At least one deferred image is loaded successfully and started.\r
  @retval EFI_NOT_FOUND     There is no deferred image.\r
  @retval EFI_ACCESS_DENIED There are deferred images but all of them are failed to load.\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiBootManagerDispatchDeferredImages (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                         Status;\r
  EFI_DEFERRED_IMAGE_LOAD_PROTOCOL   *DeferredImage;\r
  UINTN                              HandleCount;\r
  EFI_HANDLE                         *Handles;\r
  UINTN                              Index;\r
  UINTN                              ImageIndex;\r
  EFI_DEVICE_PATH_PROTOCOL           *ImageDevicePath;\r
  VOID                               *Image;\r
  UINTN                              ImageSize;\r
  BOOLEAN                            BootOption;\r
  EFI_HANDLE                         ImageHandle;\r
  UINTN                              ExitDataSize;\r
  CHAR16                             *ExitData;\r
  UINTN                              ImageCount;\r
  UINTN                              LoadCount;\r
\r
  //\r
  // Find all the deferred image load protocols.\r
  //\r
  HandleCount = 0;\r
  Handles = NULL;\r
  Status = gBS->LocateHandleBuffer (\r
    ByProtocol,\r
    &gEfiDeferredImageLoadProtocolGuid,\r
    NULL,\r
    &HandleCount,\r
    &Handles\r
  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  ImageCount = 0;\r
  LoadCount  = 0;\r
  for (Index = 0; Index < HandleCount; Index++) {\r
    Status = gBS->HandleProtocol (Handles[Index], &gEfiDeferredImageLoadProtocolGuid, (VOID **) &DeferredImage);\r
    if (EFI_ERROR (Status)) {\r
      continue;\r
    }\r
\r
    for (ImageIndex = 0; ;ImageIndex++) {\r
      //\r
      // Load all the deferred images in this protocol instance.\r
      //\r
      Status = DeferredImage->GetImageInfo (\r
                                DeferredImage,\r
                                ImageIndex,\r
                                &ImageDevicePath,\r
                                (VOID **) &Image,\r
                                &ImageSize,\r
                                &BootOption\r
                                );\r
      if (EFI_ERROR (Status)) {\r
        break;\r
      }\r
      ImageCount++;\r
      //\r
      // Load and start the image.\r
      //\r
      Status = gBS->LoadImage (\r
        BootOption,\r
        gImageHandle,\r
        ImageDevicePath,\r
        NULL,\r
        0,\r
        &ImageHandle\r
      );\r
      if (!EFI_ERROR (Status)) {\r
        LoadCount++;\r
        //\r
        // Before calling the image, enable the Watchdog Timer for\r
        // a 5 Minute period\r
        //\r
        gBS->SetWatchdogTimer (5 * 60, 0x0000, 0x00, NULL);\r
        Status = gBS->StartImage (ImageHandle, &ExitDataSize, &ExitData);\r
        if (ExitData != NULL) {\r
          FreePool (ExitData);\r
        }\r
\r
        //\r
        // Clear the Watchdog Timer after the image returns.\r
        //\r
        gBS->SetWatchdogTimer (0x0000, 0x0000, 0x0000, NULL);\r
      }\r
    }\r
  }\r
  if (Handles != NULL) {\r
    FreePool (Handles);\r
  }\r
\r
  if (ImageCount == 0) {\r
    return EFI_NOT_FOUND;\r
  } else {\r
    if (LoadCount == 0) {\r
      return EFI_ACCESS_DENIED;\r
    } else {\r
      return EFI_SUCCESS;\r
    }\r
  }\r
}\r