MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Universal / EsrtFmpDxe / EsrtFmp.c

/** @file\r
  Publishes ESRT table from Firmware Management Protocol instances\r
\r
  Copyright (c) 2016, Microsoft Corporation\r
  Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>\r
\r
  All rights reserved.\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <Uefi.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/UefiLib.h>\r
#include <Protocol/FirmwareManagement.h>\r
#include <Guid/EventGroup.h>\r
#include <Guid/SystemResourceTable.h>\r
\r
/**\r
 Print ESRT to debug console.\r
\r
 @param[in]  Table   Pointer to the ESRT table.\r
\r
**/\r
VOID\r
EFIAPI\r
PrintTable (\r
  IN EFI_SYSTEM_RESOURCE_TABLE  *Table\r
  );\r
\r
//\r
// Number of ESRT entries to grow by each time we run out of room\r
//\r
#define GROWTH_STEP  10\r
\r
/**\r
  Install EFI System Resource Table into the UEFI Configuration Table\r
\r
  @param[in] Table                  Pointer to the ESRT.\r
\r
  @return  Status code.\r
\r
**/\r
EFI_STATUS\r
InstallEfiSystemResourceTableInUefiConfigurationTable (\r
  IN EFI_SYSTEM_RESOURCE_TABLE      *Table\r
  )\r
{\r
  EFI_STATUS Status;\r
\r
  Status = EFI_SUCCESS;\r
  if (Table->FwResourceCount == 0) {\r
    DEBUG ((DEBUG_ERROR, "EsrtFmpDxe: Can't install ESRT table because it has zero Entries. \n"));\r
    Status = EFI_UNSUPPORTED;\r
  } else {\r
    //\r
    // Install the pointer into config table\r
    //\r
    Status = gBS->InstallConfigurationTable (&gEfiSystemResourceTableGuid, Table);\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((DEBUG_ERROR, "EsrtFmpDxe: Can't install ESRT table.  Status: %r. \n", Status));\r
    } else {\r
      DEBUG ((DEBUG_INFO, "EsrtFmpDxe: Installed ESRT table. \n"));\r
    }\r
  }\r
  return Status;\r
}\r
\r
/**\r
  Return if this FMP is a system FMP or a device FMP, based upon FmpImageInfo.\r
\r
  @param[in] FmpImageInfo A pointer to EFI_FIRMWARE_IMAGE_DESCRIPTOR\r
\r
  @return TRUE  It is a system FMP.\r
  @return FALSE It is a device FMP.\r
**/\r
BOOLEAN\r
IsSystemFmp (\r
  IN EFI_FIRMWARE_IMAGE_DESCRIPTOR  *FmpImageInfo\r
  )\r
{\r
  GUID   *Guid;\r
  UINTN  Count;\r
  UINTN  Index;\r
\r
  Guid  = PcdGetPtr (PcdSystemFmpCapsuleImageTypeIdGuid);\r
  Count = PcdGetSize (PcdSystemFmpCapsuleImageTypeIdGuid) / sizeof(GUID);\r
\r
  for (Index = 0; Index < Count; Index++, Guid++) {\r
    if (CompareGuid (&FmpImageInfo->ImageTypeId, Guid)) {\r
      return TRUE;\r
    }\r
  }\r
\r
  return FALSE;\r
}\r
\r
/**\r
  Function to create a single ESRT Entry and add it to the ESRT\r
  given a FMP descriptor.  If the guid is already in the ESRT it\r
  will be ignored.  The ESRT will grow if it does not have enough room.\r
\r
  @param[in, out] Table             On input, pointer to the pointer to the ESRT.\r
                                    On output, same as input or pointer to the pointer\r
                                    to new enlarged ESRT.\r
  @param[in]      FmpImageInfoBuf   Pointer to the EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r
  @param[in]      FmpVersion        FMP Version.\r
\r
  @return  Status code.\r
\r
**/\r
EFI_STATUS\r
CreateEsrtEntry (\r
  IN OUT EFI_SYSTEM_RESOURCE_TABLE  **Table,\r
  IN EFI_FIRMWARE_IMAGE_DESCRIPTOR  *FmpImageInfoBuf,\r
  IN UINT32                         FmpVersion\r
  )\r
{\r
  UINTN                      Index;\r
  EFI_SYSTEM_RESOURCE_ENTRY  *Entry;\r
  UINTN                      NewSize;\r
  EFI_SYSTEM_RESOURCE_TABLE  *NewTable;\r
\r
  Index = 0;\r
  Entry = NULL;\r
\r
  Entry = (EFI_SYSTEM_RESOURCE_ENTRY *)((*Table) + 1);\r
  //\r
  // Make sure Guid isn't already in the list\r
  //\r
  for (Index = 0; Index < (*Table)->FwResourceCount; Index++) {\r
    if (CompareGuid (&Entry->FwClass, &FmpImageInfoBuf->ImageTypeId)) {\r
      DEBUG ((DEBUG_ERROR, "EsrtFmpDxe: ESRT Entry already exists for FMP Instance with GUID %g\n", &Entry->FwClass));\r
      return EFI_INVALID_PARAMETER;\r
    }\r
    Entry++;\r
  }\r
\r
  //\r
  // Grow table if needed\r
  //\r
  if ((*Table)->FwResourceCount >= (*Table)->FwResourceCountMax) {\r
    NewSize  = (((*Table)->FwResourceCountMax + GROWTH_STEP) * sizeof (EFI_SYSTEM_RESOURCE_ENTRY)) + sizeof (EFI_SYSTEM_RESOURCE_TABLE);\r
    NewTable = AllocateZeroPool (NewSize);\r
    if (NewTable == NULL) {\r
      DEBUG ((DEBUG_ERROR, "EsrtFmpDxe: Failed to allocate memory larger table for ESRT. \n"));\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
    //\r
    // Copy the whole old table into new table buffer\r
    //\r
    CopyMem (\r
      NewTable,\r
      (*Table),\r
      (((*Table)->FwResourceCountMax) * sizeof (EFI_SYSTEM_RESOURCE_ENTRY)) + sizeof (EFI_SYSTEM_RESOURCE_TABLE)\r
      );\r
    //\r
    // Update max\r
    //\r
    NewTable->FwResourceCountMax = NewTable->FwResourceCountMax + GROWTH_STEP;\r
    //\r
    // Free old table\r
    //\r
    FreePool ((*Table));\r
    //\r
    // Reassign pointer to new table.\r
    //\r
    (*Table) = NewTable;\r
  }\r
\r
  //\r
  // ESRT table has enough room for the new entry so add new entry\r
  //\r
  Entry = (EFI_SYSTEM_RESOURCE_ENTRY *)(((UINT8 *)(*Table)) + sizeof (EFI_SYSTEM_RESOURCE_TABLE));\r
  //\r
  // Move to the location of new entry\r
  //\r
  Entry = Entry + (*Table)->FwResourceCount;\r
  //\r
  // Increment resource count\r
  //\r
  (*Table)->FwResourceCount++;\r
\r
  CopyGuid (&Entry->FwClass, &FmpImageInfoBuf->ImageTypeId);\r
\r
  if (IsSystemFmp (FmpImageInfoBuf)) {\r
    DEBUG ((DEBUG_INFO, "EsrtFmpDxe: Found an ESRT entry for a System Device.\n"));\r
    Entry->FwType = (UINT32)(ESRT_FW_TYPE_SYSTEMFIRMWARE);\r
  } else {\r
    Entry->FwType = (UINT32)(ESRT_FW_TYPE_DEVICEFIRMWARE);\r
  }\r
\r
  Entry->FwVersion = FmpImageInfoBuf->Version;\r
  Entry->LowestSupportedFwVersion = 0;\r
  Entry->CapsuleFlags = 0;\r
  Entry->LastAttemptVersion = 0;\r
  Entry->LastAttemptStatus = 0;\r
\r
  //\r
  // VERSION 2 has Lowest Supported\r
  //\r
  if (FmpVersion >= 2) {\r
    Entry->LowestSupportedFwVersion = FmpImageInfoBuf->LowestSupportedImageVersion;\r
  }\r
\r
  //\r
  // VERSION 3 supports last attempt values\r
  //\r
  if (FmpVersion >= 3) {\r
    Entry->LastAttemptVersion = FmpImageInfoBuf->LastAttemptVersion;\r
    Entry->LastAttemptStatus = FmpImageInfoBuf->LastAttemptStatus;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Function to create ESRT based on FMP Instances.\r
  Create ESRT table, get the descriptors from FMP Instance and\r
  create ESRT entries (ESRE).\r
\r
  @return Pointer to the ESRT created.\r
\r
**/\r
EFI_SYSTEM_RESOURCE_TABLE *\r
CreateFmpBasedEsrt (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  EFI_SYSTEM_RESOURCE_TABLE         *Table;\r
  UINTN                             NoProtocols;\r
  VOID                              **Buffer;\r
  UINTN                             Index;\r
  EFI_FIRMWARE_MANAGEMENT_PROTOCOL  *Fmp;\r
  UINTN                             DescriptorSize;\r
  EFI_FIRMWARE_IMAGE_DESCRIPTOR     *FmpImageInfoBuf;\r
  EFI_FIRMWARE_IMAGE_DESCRIPTOR     *FmpImageInfoBufOrg;\r
  UINT8                             FmpImageInfoCount;\r
  UINT32                            FmpImageInfoDescriptorVer;\r
  UINTN                             ImageInfoSize;\r
  UINT32                            PackageVersion;\r
  CHAR16                            *PackageVersionName;\r
\r
  Status             = EFI_SUCCESS;\r
  Table              = NULL;\r
  NoProtocols        = 0;\r
  Buffer             = NULL;\r
  PackageVersionName = NULL;\r
  FmpImageInfoBuf    = NULL;\r
  FmpImageInfoBufOrg = NULL;\r
  Fmp                = NULL;\r
\r
  Status = EfiLocateProtocolBuffer (\r
             &gEfiFirmwareManagementProtocolGuid,\r
             &NoProtocols,\r
             &Buffer\r
             );\r
  if (EFI_ERROR(Status) || (Buffer == NULL)) {\r
    return NULL;\r
  }\r
\r
  //\r
  // Allocate Memory for table\r
  //\r
  Table = AllocateZeroPool (\r
             (GROWTH_STEP * sizeof (EFI_SYSTEM_RESOURCE_ENTRY)) + sizeof (EFI_SYSTEM_RESOURCE_TABLE)\r
             );\r
  if (Table == NULL) {\r
    DEBUG ((DEBUG_ERROR, "EsrtFmpDxe: Failed to allocate memory for ESRT.\n"));\r
    gBS->FreePool (Buffer);\r
    return NULL;\r
  }\r
\r
  Table->FwResourceCount    = 0;\r
  Table->FwResourceCountMax = GROWTH_STEP;\r
  Table->FwResourceVersion  = EFI_SYSTEM_RESOURCE_TABLE_FIRMWARE_RESOURCE_VERSION;\r
\r
  for (Index = 0; Index < NoProtocols; Index++) {\r
    Fmp = (EFI_FIRMWARE_MANAGEMENT_PROTOCOL *) Buffer[Index];\r
\r
    ImageInfoSize = 0;\r
    Status = Fmp->GetImageInfo (\r
                    Fmp,                         // FMP Pointer\r
                    &ImageInfoSize,              // Buffer Size (in this case 0)\r
                    NULL,                        // NULL so we can get size\r
                    &FmpImageInfoDescriptorVer,  // DescriptorVersion\r
                    &FmpImageInfoCount,          // DescriptorCount\r
                    &DescriptorSize,             // DescriptorSize\r
                    &PackageVersion,             // PackageVersion\r
                    &PackageVersionName          // PackageVersionName\r
                    );\r
\r
    if (Status != EFI_BUFFER_TOO_SMALL) {\r
      DEBUG ((DEBUG_ERROR, "EsrtFmpDxe: Unexpected Failure in GetImageInfo.  Status = %r\n", Status));\r
      continue;\r
    }\r
\r
    FmpImageInfoBuf = AllocateZeroPool (ImageInfoSize);\r
    if (FmpImageInfoBuf == NULL) {\r
      DEBUG ((DEBUG_ERROR, "EsrtFmpDxe: Failed to get memory for descriptors.\n"));\r
      continue;\r
    }\r
\r
    FmpImageInfoBufOrg = FmpImageInfoBuf;\r
    PackageVersionName = NULL;\r
    Status = Fmp->GetImageInfo (\r
                    Fmp,\r
                    &ImageInfoSize,              // ImageInfoSize\r
                    FmpImageInfoBuf,             // ImageInfo\r
                    &FmpImageInfoDescriptorVer,  // DescriptorVersion\r
                    &FmpImageInfoCount,          // DescriptorCount\r
                    &DescriptorSize,             // DescriptorSize\r
                    &PackageVersion,             // PackageVersion\r
                    &PackageVersionName          // PackageVersionName\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((DEBUG_ERROR, "EsrtFmpDxe: Failure in GetImageInfo.  Status = %r\n", Status));\r
      FreePool (FmpImageInfoBufOrg);\r
      FmpImageInfoBufOrg = NULL;\r
      continue;\r
    }\r
\r
    //\r
    // Check each descriptor and read from the one specified\r
    //\r
    while (FmpImageInfoCount > 0) {\r
      //\r
      // If the descriptor has the IN USE bit set, create ESRT entry otherwise ignore.\r
      //\r
      if ((FmpImageInfoBuf->AttributesSetting & FmpImageInfoBuf->AttributesSupported & IMAGE_ATTRIBUTE_IN_USE) == IMAGE_ATTRIBUTE_IN_USE) {\r
        //\r
        // Create ESRT entry\r
        //\r
        CreateEsrtEntry (&Table, FmpImageInfoBuf, FmpImageInfoDescriptorVer);\r
      }\r
      FmpImageInfoCount--;\r
      //\r
      // Increment the buffer pointer ahead by the size of the descriptor\r
      //\r
      FmpImageInfoBuf = (EFI_FIRMWARE_IMAGE_DESCRIPTOR *)(((UINT8 *)FmpImageInfoBuf) + DescriptorSize);\r
    }\r
\r
    if (PackageVersionName != NULL) {\r
      FreePool (PackageVersionName);\r
      PackageVersionName = NULL;\r
    }\r
    FreePool (FmpImageInfoBufOrg);\r
    FmpImageInfoBufOrg = NULL;\r
  }\r
\r
  gBS->FreePool (Buffer);\r
  return Table;\r
}\r
\r
/**\r
  Notify function for event group EFI_EVENT_GROUP_READY_TO_BOOT. This is used to\r
  install the Efi System Resource Table.\r
\r
  @param[in]  Event    The Event that is being processed.\r
  @param[in]  Context  The Event Context.\r
\r
**/\r
VOID\r
EFIAPI\r
EsrtReadyToBootEventNotify (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  )\r
{\r
  EFI_STATUS                 Status;\r
  EFI_SYSTEM_RESOURCE_TABLE  *Table;\r
\r
  Table = CreateFmpBasedEsrt ();\r
  if (Table != NULL) {\r
    //\r
    // Print table on debug builds\r
    //\r
    DEBUG_CODE_BEGIN ();\r
    PrintTable (Table);\r
    DEBUG_CODE_END ();\r
\r
    Status = InstallEfiSystemResourceTableInUefiConfigurationTable (Table);\r
    if (EFI_ERROR (Status)) {\r
      FreePool (Table);\r
    }\r
  } else {\r
    DEBUG ((DEBUG_ERROR, "EsrtFmpDxe: Can't install ESRT table because it is NULL. \n"));\r
  }\r
\r
  //\r
  // Close the event to prevent it be signalled again.\r
  //\r
  gBS->CloseEvent (Event);\r
}\r
\r
/**\r
  The module Entry Point of the Efi System Resource Table DXE driver.\r
\r
  @param[in]  ImageHandle  The firmware allocated handle for the EFI image.\r
  @param[in]  SystemTable  A pointer to the EFI System Table.\r
\r
  @retval  EFI_SUCCESS  The entry point is executed successfully.\r
  @retval  Other        Some error occurs when executing this entry point.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EsrtFmpEntryPoint (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS  Status;\r
  EFI_EVENT   EsrtReadyToBootEvent;\r
\r
  //\r
  // Register notify function to install ESRT on ReadyToBoot Event.\r
  //\r
  Status = EfiCreateEventReadyToBootEx (\r
             TPL_CALLBACK,\r
             EsrtReadyToBootEventNotify,\r
             NULL,\r
             &EsrtReadyToBootEvent\r
             );\r
\r
  ASSERT_EFI_ERROR (Status);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "EsrtFmpDxe: Failed to register for ready to boot\n"));\r
  }\r
\r
  return Status;\r
}\r