Re: [PATCH v1 11/18] StandaloneMmPkg: MM driver entry point library.

[Supreeth Venkatesh <Supreeth.Venkatesh@arm.com>]

My response inline.

-----Original Message-----
From: Achin Gupta
Sent: Monday, April 30, 2018 9:30 AM
To: Supreeth Venkatesh <Supreeth.Venkatesh@arm.com>
Cc: edk2-devel@lists.01.org; michael.d.kinney@intel.com; liming.gao@intel.com; jiewen.yao@intel.com; leif.lindholm@linaro.org; ard.biesheuvel@linaro.org; nd <nd@arm.com>
Subject: Re: [PATCH v1 11/18] StandaloneMmPkg: MM driver entry point library.

Hi Supreeth,

Some of the DXE references will have to be removed and copyright years need to be updated. If that sounds reasonable then..

[Supreeth] Ok.

Acked-by: Achin Gupta <achin.gupta@arm.com>

cheers,
Achin

On Fri, Apr 06, 2018 at 03:42:16PM +0100, Supreeth Venkatesh wrote:
> This patch implements module entry point library for Standalone
> management mode (MM) Drivers.
>
> Contributed-under: TianoCore Contribution Agreement 1.1
> Signed-off-by: Achin Gupta <achin.gupta@arm.com>
> Signed-off-by: Supreeth Venkatesh <supreeth.venkatesh@arm.com>
> ---
>  .../Include/Library/MmDriverStandaloneEntryPoint.h | 148 +++++++++++++++++++++
>  .../StandaloneMmDriverEntryPoint.c                 | 102 ++++++++++++++
>  .../StandaloneMmDriverEntryPoint.inf               |  41 ++++++
>  3 files changed, 291 insertions(+)
>  create mode 100644
> StandaloneMmPkg/Include/Library/MmDriverStandaloneEntryPoint.h
>  create mode 100644
> StandaloneMmPkg/Library/StandaloneMmDriverEntryPoint/StandaloneMmDrive
> rEntryPoint.c  create mode 100644
> StandaloneMmPkg/Library/StandaloneMmDriverEntryPoint/StandaloneMmDrive
> rEntryPoint.inf
>
> diff --git
> a/StandaloneMmPkg/Include/Library/MmDriverStandaloneEntryPoint.h
> b/StandaloneMmPkg/Include/Library/MmDriverStandaloneEntryPoint.h
> new file mode 100644
> index 0000000000..6fb9224e2e
> --- /dev/null
> +++ b/StandaloneMmPkg/Include/Library/MmDriverStandaloneEntryPoint.h
> @@ -0,0 +1,148 @@
> +/** @file
> +  Module entry point library for UEFI drivers, DXE Drivers, DXE
> +Runtime Drivers,
> +  and DXE SMM Drivers.
> +
> +Copyright (c) 2006 - 2008, Intel Corporation. All rights
> +reserved.<BR> Copyright (c) 2016 - 2017, ARM Limited. All rights
> +reserved.<BR>
> +
> +This program and the accompanying materials are licensed and made
> +available under the terms and conditions of the BSD License which
> +accompanies this distribution.  The full text of the license may be
> +found at http://opensource.org/licenses/bsd-license.php
> +
> +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
> +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
> +
> +**/
> +
> +#ifndef __MODULE_ENTRY_POINT_H__
> +#define __MODULE_ENTRY_POINT_H__
> +
> +///
> +///Declare the PI Specification Revision that this driver requires to execute correctly.
> +///
> +extern CONST UINT32                   _gMmRevision;
> +
> +/**
> +  The entry point of PE/COFF Image for a DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.
> +
> +  This function is the entry point for a DXE Driver, DXE Runtime
> + Driver, DXE SMM Driver,  or UEFI Driver.  This function must call
> + ProcessLibraryConstructorList() and  ProcessModuleEntryPointList().
> + If the return status from ProcessModuleEntryPointList()  is an error
> + status, then ProcessLibraryDestructorList() must be called. The
> + return value  from ProcessModuleEntryPointList() is returned. If
> + _gDriverUnloadImageCount is greater  than zero, then an unload handler must be registered for this image and the unload handler  must invoke ProcessModuleUnloadList().
> +  If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision
> + is less than _gUefiDriverRevison,  then return EFI_INCOMPATIBLE_VERSION.
> +
> +
> +  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.
> +  @param  SystemTable  A pointer to the EFI System Table.
> +
> +  @retval  EFI_SUCCESS               The DXE Driver, DXE Runtime Driver, DXE SMM Driver,
> +                                     or UEFI Driver exited normally.
> +  @retval  EFI_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.
> +  @retval  Other                     Return value from ProcessModuleEntryPointList().
> +
> +**/
> +EFI_STATUS
> +EFIAPI
> +_ModuleEntryPoint (
> +  IN EFI_HANDLE             ImageHandle,
> +  IN EFI_MM_SYSTEM_TABLE    *MmSystemTable
> +  );
> +
> +
> +/**
> +  Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().
> +
> +  This function is required to call _ModuleEntryPoint() passing in ImageHandle, and SystemTable.
> +
> +  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.
> +  @param  SystemTable  A pointer to the EFI System Table.
> +
> +  @retval  EFI_SUCCESS               The DXE Driver, DXE Runtime Driver, DXE SMM Driver,
> +                                     or UEFI Driver exited normally.
> +  @retval  EFI_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.
> +  @retval  Other                     Return value from ProcessModuleEntryPointList().
> +**/
> +EFI_STATUS
> +EFIAPI
> +EfiMain (
> +  IN EFI_HANDLE             ImageHandle,
> +  IN EFI_MM_SYSTEM_TABLE    *MmSystemTable
> +  );
> +
> +
> +/**
> +  Autogenerated function that calls the library constructors for all
> +of the module's
> +  dependent libraries.
> +
> +  This function must be called by _ModuleEntryPoint().
> +  This function calls the set of library constructors for the set of
> + library instances  that a module depends on.  This includes library
> + instances that a module depends on  directly and library instances that a module depends on indirectly through other libraries.
> +  This function is autogenerated by build tools and those build tools
> + are responsible  for collecting the set of library instances,
> + determine which ones have constructors,  and calling the library
> + constructors in the proper order based upon each of the library  instances own dependencies.
> +
> +  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.
> +  @param  SystemTable  A pointer to the EFI System Table.
> +
> +**/
> +VOID
> +EFIAPI
> +ProcessLibraryConstructorList (
> +  IN EFI_HANDLE             ImageHandle,
> +  IN EFI_MM_SYSTEM_TABLE    *MmSystemTable
> +  );
> +
> +
> +/**
> +  Autogenerated function that calls the library descructors for all
> +of the module's
> +  dependent libraries.
> +
> +  This function may be called by _ModuleEntryPoint() or ExitDriver().
> +  This function calls the set of library destructors for the set of
> + library instances  that a module depends on. This includes library
> + instances that a module depends on  directly and library instances that a module depends on indirectly through other libraries.
> +  This function is autogenerated by build tools and those build tools
> + are responsible for  collecting the set of library instances,
> + determine which ones have destructors, and calling  the library destructors in the proper order based upon each of the library instances own dependencies.
> +
> +  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.
> +  @param  SystemTable  A pointer to the EFI System Table.
> +
> +**/
> +VOID
> +EFIAPI
> +ProcessLibraryDestructorList (
> +  IN EFI_HANDLE             ImageHandle,
> +  IN EFI_MM_SYSTEM_TABLE    *MmSystemTable
> +  );
> +
> +
> +/**
> +  Autogenerated function that calls a set of module entry points.
> +
> +  This function must be called by _ModuleEntryPoint().
> +  This function calls the set of module entry points.
> +  This function is autogenerated by build tools and those build tools
> + are responsible  for collecting the module entry points and calling them in a specified order.
> +
> +  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.
> +  @param  SystemTable  A pointer to the EFI System Table.
> +
> +  @retval  EFI_SUCCESS   The DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver executed normally.
> +  @retval  !EFI_SUCCESS  The DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver failed to execute normally.
> +**/
> +EFI_STATUS
> +EFIAPI
> +ProcessModuleEntryPointList (
> +  IN EFI_HANDLE             ImageHandle,
> +  IN EFI_MM_SYSTEM_TABLE    *MmSystemTable
> +  );
> +
> +#endif
> diff --git
> a/StandaloneMmPkg/Library/StandaloneMmDriverEntryPoint/StandaloneMmDri
> verEntryPoint.c
> b/StandaloneMmPkg/Library/StandaloneMmDriverEntryPoint/StandaloneMmDri
> verEntryPoint.c
> new file mode 100644
> index 0000000000..84b3d9cd08
> --- /dev/null
> +++ b/StandaloneMmPkg/Library/StandaloneMmDriverEntryPoint/StandaloneM
> +++ mDriverEntryPoint.c
> @@ -0,0 +1,102 @@
> +/** @file
> +  Entry point to a Standalone SMM driver.
> +
> +Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
> +Copyright (c) 2016-2017, ARM Ltd. All rights reserved.<BR>
> +
> +This program and the accompanying materials are licensed and made
> +available under the terms and conditions of the BSD License which
> +accompanies this distribution.  The full text of the license may be
> +found at http://opensource.org/licenses/bsd-license.php
> +
> +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
> +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
> +
> +**/
> +
> +
> +
> +#include <PiMm.h>
> +
> +#include <Library/BaseLib.h>
> +#include <Library/DebugLib.h>
> +
> +VOID
> +EFIAPI
> +ProcessLibraryConstructorList (
> +  IN EFI_HANDLE               ImageHandle,
> +  IN IN EFI_MM_SYSTEM_TABLE   *MmSystemTable
> +  );
> +
> +EFI_STATUS
> +EFIAPI
> +ProcessModuleEntryPointList (
> +  IN EFI_HANDLE               ImageHandle,
> +  IN IN EFI_MM_SYSTEM_TABLE   *MmSystemTable
> +  );
> +
> +VOID
> +EFIAPI
> +ProcessLibraryDestructorList (
> +  IN EFI_HANDLE               ImageHandle,
> +  IN IN EFI_MM_SYSTEM_TABLE   *MmSystemTable
> +  );
> +
> +/**
> +  The entry point of PE/COFF Image for a DXE Driver, DXE Runtime
> +Driver, DXE SMM
> +  Driver, or UEFI Driver.
> +
> +  This function is the entry point for a DXE Driver, DXE Runtime
> + Driver, DXE SMM Driver,  or UEFI Driver.  This function must call
> + ProcessLibraryConstructorList() and  ProcessModuleEntryPointList().
> + If the return status from ProcessModuleEntryPointList()  is an error
> + status, then ProcessLibraryDestructorList() must be called. The
> + return  value from ProcessModuleEntryPointList() is returned. If
> + _gDriverUnloadImageCount  is greater than zero, then an unload handler must be registered for this image  and the unload handler must invoke ProcessModuleUnloadList().
> +  If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision
> + is less than  _gUefiDriverRevison, then return EFI_INCOMPATIBLE_VERSION.
> +
> +
> +  @param  ImageHandle  The image handle of the DXE Driver, DXE Runtime Driver,
> +                       DXE SMM Driver, or UEFI Driver.
> +  @param  SystemTable  A pointer to the EFI System Table.
> +
> +  @retval  EFI_SUCCESS               The DXE Driver, DXE Runtime Driver, DXE SMM
> +                                     Driver, or UEFI Driver exited normally.
> +  @retval  EFI_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than
> +                                    SystemTable->Hdr.Revision.
> +  @retval  Other                     Return value from ProcessModuleEntryPointList().
> +
> +**/
> +EFI_STATUS
> +EFIAPI
> +_ModuleEntryPoint (
> +  IN EFI_HANDLE               ImageHandle,
> +  IN IN EFI_MM_SYSTEM_TABLE   *MmSystemTable
> +  )
> +{
> +  EFI_STATUS                 Status;
> +
> +  //
> +  // Call constructor for all libraries  //
> + ProcessLibraryConstructorList (ImageHandle, MmSystemTable);
> +
> +  //
> +  // Call the driver entry point
> +  //
> +  Status = ProcessModuleEntryPointList (ImageHandle, MmSystemTable);
> +
> +  //
> +  // If all of the drivers returned errors, then invoke all of the
> + library destructors  //  if (EFI_ERROR (Status)) {
> +    ProcessLibraryDestructorList (ImageHandle, MmSystemTable);  }
> +
> +  //
> +  // Return the cumulative return status code from all of the driver
> +entry points
> +  //
> +  return Status;
> +}
> +
> diff --git
> a/StandaloneMmPkg/Library/StandaloneMmDriverEntryPoint/StandaloneMmDri
> verEntryPoint.inf
> b/StandaloneMmPkg/Library/StandaloneMmDriverEntryPoint/StandaloneMmDri
> verEntryPoint.inf
> new file mode 100644
> index 0000000000..564a3f14c8
> --- /dev/null
> +++ b/StandaloneMmPkg/Library/StandaloneMmDriverEntryPoint/StandaloneM
> +++ mDriverEntryPoint.inf
> @@ -0,0 +1,41 @@
> +## @file
> +# Module entry point library for Standalone SMM driver.
> +#
> +# Copyright (c) 2015, Intel Corporation. All rights reserved.<BR> #
> +Copyright (c) 2016-2017, ARM Ltd. All rights reserved.<BR> # #  This
> +program and the accompanying materials #  are licensed and made
> +available under the terms and conditions of the BSD License #  which
> +accompanies this distribution. The full text of the license may be
> +found at #  http://opensource.org/licenses/bsd-license.php.
> +#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS"
> +BASIS, #  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
> +#
> +#
> +##
> +
> +[Defines]
> +  INF_VERSION                    = 0x0001001A
> +  BASE_NAME                      = StandaloneMmDriverEntryPoint
> +  FILE_GUID                      = BBC33478-98F8-4B78-B29D-574D681B7E43
> +  MODULE_TYPE                    = MM_STANDALONE
> +  VERSION_STRING                 = 1.0
> +  PI_SPECIFICATION_VERSION       = 0x00010032
> +  LIBRARY_CLASS                  = StandaloneMmDriverEntryPoint|MM_STANDALONE
> +
> +#
> +# The following information is for reference only and not required by the build tools.
> +#
> +#  VALID_ARCHITECTURES           = IA32 X64 IPF EBC
> +#
> +
> +[Sources]
> +  StandaloneMmDriverEntryPoint.c
> +
> +[Packages]
> +  MdePkg/MdePkg.dec
> +
> +[LibraryClasses]
> +  BaseLib
> +  DebugLib
> +
> --
> 2.16.2
>
IMPORTANT NOTICE: The contents of this email and any attachments are confidential and may also be privileged. If you are not the intended recipient, please notify the sender immediately and do not disclose the contents to any other person, use it for any purpose, or store or copy the information in any medium. Thank you.