]> git.proxmox.com Git - mirror_edk2.git/blobdiff - OldMdePkg/Include/Library/DxeSmmDriverEntryPoint.h
Moved the MdePkg to OldMdePkg so that new code in MdePkg does not break existing...
[mirror_edk2.git] / OldMdePkg / Include / Library / DxeSmmDriverEntryPoint.h
diff --git a/OldMdePkg/Include/Library/DxeSmmDriverEntryPoint.h b/OldMdePkg/Include/Library/DxeSmmDriverEntryPoint.h
new file mode 100644 (file)
index 0000000..12d35d5
--- /dev/null
@@ -0,0 +1,140 @@
+/** @file\r
+  Entry point to a DXE SMM Driver\r
+\r
+Copyright (c) 2006, Intel Corporation<BR>\r
+All rights reserved. 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
+#ifndef __MODULE_ENTRY_POINT_H__\r
+#define __MODULE_ENTRY_POINT_H__\r
+\r
+//\r
+// Declare the EFI/UEFI Specification Revision to which this driver is implemented \r
+//\r
+extern const UINT32                   _gUefiDriverRevision;\r
+\r
+//\r
+// Declare the number of entry points in the image. \r
+//\r
+extern const UINT8                    _gDriverEntryPointCount;\r
+\r
+//\r
+// Declare the number of unload handler in the image. \r
+//\r
+extern const UINT8                    _gDriverUnloadImageCount;\r
+\r
+/**\r
+  Enrty point to DXE SMM Driver.\r
+\r
+  @param  ImageHandle ImageHandle of the loaded driver.\r
+  @param  SystemTable Pointer to the EFI System Table.\r
+\r
+  @retval  EFI_SUCCESS One or more of the drivers returned a success code.\r
+  @retval  !EFI_SUCESS The return status from the last driver entry point in the list.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+_ModuleEntryPoint (\r
+  IN EFI_HANDLE        ImageHandle,\r
+  IN EFI_SYSTEM_TABLE  *SystemTable\r
+  );\r
+\r
+/**\r
+  Enrty point wrapper of DXE SMM Driver.\r
+\r
+  @param  ImageHandle ImageHandle of the loaded driver.\r
+  @param  SystemTable Pointer to the EFI System Table.\r
+\r
+  @retval  EFI_SUCCESS One or more of the drivers returned a success code.\r
+  @retval  !EFI_SUCESS The return status from the last driver entry point in the list.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+EfiMain (\r
+  IN EFI_HANDLE        ImageHandle,\r
+  IN EFI_SYSTEM_TABLE  *SystemTable\r
+  );\r
+\r
+/**\r
+  Computes the cummulative return status for the driver entry point and perform\r
+  a long jump back into DriverEntryPoint().\r
+\r
+  @param  Status Status returned by the driver that is exiting.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+ExitDriver (\r
+  IN EFI_STATUS  Status\r
+  );\r
+\r
+/**\r
+  Call constructs for all libraries. Automatics Generated by tool.\r
+\r
+  @param  ImageHandle ImageHandle of the loaded driver.\r
+  @param  SystemTable Pointer to the EFI System Table.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+ProcessLibraryConstructorList (\r
+  IN EFI_HANDLE        ImageHandle,\r
+  IN EFI_SYSTEM_TABLE  *SystemTable\r
+  );\r
+\r
+/**\r
+  Call destructors for all libraries. Automatics Generated by tool.\r
+\r
+  @param  ImageHandle ImageHandle of the loaded driver.\r
+  @param  SystemTable Pointer to the EFI System Table.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+ProcessLibraryDestructorList (\r
+  IN EFI_HANDLE        ImageHandle,\r
+  IN EFI_SYSTEM_TABLE  *SystemTable\r
+  );\r
+\r
+\r
+/**\r
+  Call the list of driver entry points. Automatics Generated by tool.\r
+\r
+  @param  ImageHandle ImageHandle of the loaded driver.\r
+  @param  SystemTable Pointer to the EFI System Table.\r
+\r
+  @return Status returned by entry points of drivers.  \r
\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ProcessModuleEntryPointList (\r
+  IN EFI_HANDLE        ImageHandle,\r
+  IN EFI_SYSTEM_TABLE  *SystemTable\r
+  );\r
+\r
+\r
+/**\r
+  Call the unload handlers for all the modules. Automatics Generated by tool.\r
+\r
+  @param  ImageHandle ImageHandle of the loaded driver.\r
\r
+  @return Status returned by unload handlers of drivers.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ProcessModuleUnloadList (\r
+  IN EFI_HANDLE  ImageHandle\r
+  );\r
+\r
+#endif\r