SourceLevelDebugPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / StandaloneMmPkg / Core / FwVol.c

/**@file\r
\r
Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
Copyright (c) 2016 - 2018, ARM Limited. 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
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "StandaloneMmCore.h"\r
#include <Library/FvLib.h>\r
#include <Library/ExtractGuidedSectionLib.h>\r
\r
//\r
// List of file types supported by dispatcher\r
//\r
EFI_FV_FILETYPE mMmFileTypes[] = {\r
  EFI_FV_FILETYPE_MM,\r
  0xE, //EFI_FV_FILETYPE_MM_STANDALONE,\r
       //\r
       // Note: DXE core will process the FV image file, so skip it in MM core\r
       // EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE\r
       //\r
};\r
\r
EFI_STATUS\r
MmAddToDriverList (\r
  IN EFI_HANDLE   FvHandle,\r
  IN VOID         *Pe32Data,\r
  IN UINTN        Pe32DataSize,\r
  IN VOID         *Depex,\r
  IN UINTN        DepexSize,\r
  IN EFI_GUID     *DriverName\r
  );\r
\r
BOOLEAN\r
FvHasBeenProcessed (\r
  IN EFI_HANDLE  FvHandle\r
  );\r
\r
VOID\r
FvIsBeingProcesssed (\r
  IN EFI_HANDLE  FvHandle\r
  );\r
\r
EFI_STATUS\r
MmCoreFfsFindMmDriver (\r
  IN  EFI_FIRMWARE_VOLUME_HEADER  *FwVolHeader\r
  )\r
/*++\r
\r
Routine Description:\r
  Given the pointer to the Firmware Volume Header find the\r
  MM driver and return it's PE32 image.\r
\r
Arguments:\r
  FwVolHeader - Pointer to memory mapped FV\r
\r
Returns:\r
  other       - Failure\r
\r
--*/\r
{\r
  EFI_STATUS                              Status;\r
  EFI_STATUS                              DepexStatus;\r
  EFI_FFS_FILE_HEADER                     *FileHeader;\r
  EFI_FV_FILETYPE                         FileType;\r
  VOID                                    *Pe32Data;\r
  UINTN                                   Pe32DataSize;\r
  VOID                                    *Depex;\r
  UINTN                                   DepexSize;\r
  UINTN                                   Index;\r
  EFI_COMMON_SECTION_HEADER               *Section;\r
  VOID                                    *SectionData;\r
  UINTN                                   SectionDataSize;\r
  UINT32                                  DstBufferSize;\r
  VOID                                    *ScratchBuffer;\r
  UINT32                                  ScratchBufferSize;\r
  VOID                                    *DstBuffer;\r
  UINT16                                  SectionAttribute;\r
  UINT32                                  AuthenticationStatus;\r
  EFI_FIRMWARE_VOLUME_HEADER              *InnerFvHeader;\r
\r
  DEBUG ((DEBUG_INFO, "MmCoreFfsFindMmDriver - 0x%x\n", FwVolHeader));\r
\r
  if (FvHasBeenProcessed (FwVolHeader)) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  FvIsBeingProcesssed (FwVolHeader);\r
\r
  //\r
  // First check for encapsulated compressed firmware volumes\r
  //\r
  FileHeader = NULL;\r
  do {\r
    Status = FfsFindNextFile (EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE,\r
               FwVolHeader, &FileHeader);\r
    if (EFI_ERROR (Status)) {\r
      break;\r
    }\r
    Status = FfsFindSectionData (EFI_SECTION_GUID_DEFINED, FileHeader,\r
               &SectionData, &SectionDataSize);\r
    if (EFI_ERROR (Status)) {\r
      break;\r
    }\r
    Section = (EFI_COMMON_SECTION_HEADER *)(FileHeader + 1);\r
    Status = ExtractGuidedSectionGetInfo (Section, &DstBufferSize,\r
               &ScratchBufferSize, &SectionAttribute);\r
    if (EFI_ERROR (Status)) {\r
      break;\r
    }\r
\r
    //\r
    // Allocate scratch buffer\r
    //\r
    ScratchBuffer = (VOID *)(UINTN)AllocatePages (EFI_SIZE_TO_PAGES (ScratchBufferSize));\r
    if (ScratchBuffer == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
\r
    //\r
    // Allocate destination buffer, extra one page for adjustment\r
    //\r
    DstBuffer = (VOID *)(UINTN)AllocatePages (EFI_SIZE_TO_PAGES (DstBufferSize));\r
    if (DstBuffer == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
\r
    //\r
    // Call decompress function\r
    //\r
    Status = ExtractGuidedSectionDecode (Section, &DstBuffer, ScratchBuffer,\r
                &AuthenticationStatus);\r
    FreePages (ScratchBuffer, EFI_SIZE_TO_PAGES (ScratchBufferSize));\r
    if (EFI_ERROR (Status)) {\r
      goto FreeDstBuffer;\r
    }\r
\r
    DEBUG ((DEBUG_INFO,\r
      "Processing compressed firmware volume (AuthenticationStatus == %x)\n",\r
      AuthenticationStatus));\r
\r
    Status = FindFfsSectionInSections (DstBuffer, DstBufferSize,\r
               EFI_SECTION_FIRMWARE_VOLUME_IMAGE, &Section);\r
    if (EFI_ERROR (Status)) {\r
      goto FreeDstBuffer;\r
    }\r
\r
    InnerFvHeader = (VOID *)(Section + 1);\r
    Status = MmCoreFfsFindMmDriver (InnerFvHeader);\r
    if (EFI_ERROR (Status)) {\r
      goto FreeDstBuffer;\r
    }\r
  } while (TRUE);\r
\r
  for (Index = 0; Index < sizeof (mMmFileTypes) / sizeof (mMmFileTypes[0]); Index++) {\r
    DEBUG ((DEBUG_INFO, "Check MmFileTypes - 0x%x\n", mMmFileTypes[Index]));\r
    FileType = mMmFileTypes[Index];\r
    FileHeader = NULL;\r
    do {\r
      Status = FfsFindNextFile (FileType, FwVolHeader, &FileHeader);\r
      if (!EFI_ERROR (Status)) {\r
        Status = FfsFindSectionData (EFI_SECTION_PE32, FileHeader, &Pe32Data, &Pe32DataSize);\r
        DEBUG ((DEBUG_INFO, "Find PE data - 0x%x\n", Pe32Data));\r
        DepexStatus = FfsFindSectionData (EFI_SECTION_MM_DEPEX, FileHeader, &Depex, &DepexSize);\r
        if (!EFI_ERROR (DepexStatus)) {\r
          MmAddToDriverList (FwVolHeader, Pe32Data, Pe32DataSize, Depex, DepexSize, &FileHeader->Name);\r
        }\r
      }\r
    } while (!EFI_ERROR (Status));\r
  }\r
\r
  return EFI_SUCCESS;\r
\r
FreeDstBuffer:\r
  FreePages (DstBuffer, EFI_SIZE_TO_PAGES (DstBufferSize));\r
\r
  return Status;\r
}\r