MdePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdePkg / Library / PeimEntryPoint / PeimEntryPoint.c

/** @file\r
  Entry point to a PEIM.\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
\r
#include <PiPei.h>\r
\r
\r
#include <Library/PeimEntryPoint.h>\r
#include <Library/DebugLib.h>\r
\r
/**\r
  The entry point of PE/COFF Image for a PEIM.\r
\r
  This function is the entry point for a PEIM.  This function must call ProcessLibraryConstructorList()\r
  and ProcessModuleEntryPointList().  The return value from ProcessModuleEntryPointList() is returned.\r
  If _gPeimRevision is not zero and PeiServices->Hdr.Revision is less than _gPeimRevison, then ASSERT().\r
\r
  @param  FileHandle  Handle of the file being invoked.\r
  @param  PeiServices Describes the list of possible PEI Services.\r
\r
  @retval  EFI_SUCCESS   The PEIM executed normally.\r
  @retval  !EFI_SUCCESS  The PEIM failed to execute normally.\r
**/\r
EFI_STATUS\r
EFIAPI\r
_ModuleEntryPoint (\r
  IN EFI_PEI_FILE_HANDLE       FileHandle,\r
  IN CONST EFI_PEI_SERVICES    **PeiServices\r
  )\r
{\r
  if (_gPeimRevision != 0) {\r
    //\r
    // Make sure that the PEI spec revision of the platform is >= PEI spec revision of the driver\r
    //\r
    ASSERT ((*PeiServices)->Hdr.Revision >= _gPeimRevision);\r
  }\r
\r
  //\r
  // Call constructor for all libraries\r
  //\r
  ProcessLibraryConstructorList (FileHandle, PeiServices);\r
\r
  //\r
  // Call the driver entry point\r
  //\r
  return ProcessModuleEntryPointList (FileHandle, PeiServices);\r
}\r
\r
\r
/**\r
  Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().\r
\r
  This function is required to call _ModuleEntryPoint() passing in FileHandle and PeiServices.\r
\r
  @param  FileHandle  Handle of the file being invoked.\r
  @param  PeiServices Describes the list of possible PEI Services.\r
\r
  @retval EFI_SUCCESS  The PEIM executed normally.\r
  @retval !EFI_SUCCESS The PEIM failed to execute normally.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiMain (\r
  IN EFI_PEI_FILE_HANDLE       FileHandle,\r
  IN CONST EFI_PEI_SERVICES    **PeiServices\r
  )\r
{\r
  return _ModuleEntryPoint (FileHandle, PeiServices);\r
}\r