MdePkg: introduce standalone MM entry point library implementation
[mirror_edk2.git] / MdePkg / Library / StandaloneMmDriverEntryPoint / StandaloneMmDriverEntryPoint.c
1 /** @file\r
2   Entry point to a Standalone MM driver.\r
3 \r
4 Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
5 Copyright (c) 2016 - 2018, ARM Ltd. All rights reserved.<BR>\r
6 Copyright (c) 2018, Linaro, Limited. All rights reserved.<BR>\r
7 \r
8 This program and the accompanying materials\r
9 are licensed and made available under the terms and conditions of the BSD License\r
10 which accompanies this distribution.  The full text of the license may be found at\r
11 http://opensource.org/licenses/bsd-license.php\r
12 \r
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
15 \r
16 **/\r
17 \r
18 #include <PiMm.h>\r
19 \r
20 #include <Library/BaseLib.h>\r
21 #include <Library/DebugLib.h>\r
22 #include <Library/MmServicesTableLib.h>\r
23 #include <Library/StandaloneMmDriverEntryPoint.h>\r
24 \r
25 /**\r
26   The entry point of PE/COFF Image for a Standalone MM Driver.\r
27 \r
28   This function is the entry point for a Standalone MM Driver.\r
29   This function must call ProcessLibraryConstructorList() and\r
30   ProcessModuleEntryPointList().\r
31   If the return status from ProcessModuleEntryPointList()\r
32   is an error status, then ProcessLibraryDestructorList() must be called.\r
33   The return value from ProcessModuleEntryPointList() is returned.\r
34   If _gMmRevision is not zero and SystemTable->Hdr.Revision is\r
35   less than _gMmRevision, then return EFI_INCOMPATIBLE_VERSION.\r
36 \r
37   @param  ImageHandle  The image handle of the Standalone MM Driver.\r
38   @param  SystemTable  A pointer to the EFI System Table.\r
39 \r
40   @retval  EFI_SUCCESS               The Standalone MM Driver exited normally.\r
41   @retval  EFI_INCOMPATIBLE_VERSION  _gMmRevision is greater than\r
42                                      MmSystemTable->Hdr.Revision.\r
43   @retval  Other                     Return value from\r
44                                      ProcessModuleEntryPointList().\r
45 \r
46 **/\r
47 EFI_STATUS\r
48 EFIAPI\r
49 _ModuleEntryPoint (\r
50   IN EFI_HANDLE               ImageHandle,\r
51   IN IN EFI_MM_SYSTEM_TABLE   *MmSystemTable\r
52   )\r
53 {\r
54   EFI_STATUS                 Status;\r
55 \r
56   if (_gMmRevision != 0) {\r
57     //\r
58     // Make sure that the MM spec revision of the platform\r
59     // is >= MM spec revision of the driver\r
60     //\r
61     if (MmSystemTable->Hdr.Revision < _gMmRevision) {\r
62       return EFI_INCOMPATIBLE_VERSION;\r
63     }\r
64   }\r
65 \r
66   //\r
67   // Call constructor for all libraries\r
68   //\r
69   ProcessLibraryConstructorList (ImageHandle, MmSystemTable);\r
70 \r
71   //\r
72   // Call the driver entry point\r
73   //\r
74   Status = ProcessModuleEntryPointList (ImageHandle, MmSystemTable);\r
75 \r
76   //\r
77   // If all of the drivers returned errors, then invoke all of the library destructors\r
78   //\r
79   if (EFI_ERROR (Status)) {\r
80     ProcessLibraryDestructorList (ImageHandle, MmSystemTable);\r
81   }\r
82 \r
83   //\r
84   // Return the cumulative return status code from all of the driver entry points\r
85   //\r
86   return Status;\r
87 }\r