]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/Library/DxeSmmDriverEntryPoint.h
Initial import.
[mirror_edk2.git] / MdePkg / Include / Library / DxeSmmDriverEntryPoint.h
CommitLineData
878ddf1f 1/** @file\r
2 Entry point to a DXE SMM Driver\r
3\r
4Copyright (c) 2006, Intel Corporation<BR>\r
5All rights reserved. This program and the accompanying materials\r
6are licensed and made available under the terms and conditions of the BSD License\r
7which accompanies this distribution. The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#ifndef __MODULE_ENTRY_POINT_H__\r
16#define __MODULE_ENTRY_POINT_H__\r
17\r
18//\r
19// Declare the EFI/UEFI Specification Revision to which this driver is implemented \r
20//\r
21extern const UINT32 _gUefiDriverRevision;\r
22\r
23//\r
24// Declare the number of entry points in the image. \r
25//\r
26extern const UINT8 _gDriverEntryPointCount;\r
27\r
28//\r
29// Declare the number of unload handler in the image. \r
30//\r
31extern const UINT8 _gDriverUnloadImageCount;\r
32\r
33/**\r
34 Enrty point to DXE SMM Driver.\r
35\r
36 @param ImageHandle ImageHandle of the loaded driver.\r
37 @param SystemTable Pointer to the EFI System Table.\r
38\r
39 @retval EFI_SUCCESS One or more of the drivers returned a success code.\r
40 @retval !EFI_SUCESS The return status from the last driver entry point in the list.\r
41\r
42**/\r
43EFI_STATUS\r
44EFIAPI\r
45_ModuleEntryPoint (\r
46 IN EFI_HANDLE ImageHandle,\r
47 IN EFI_SYSTEM_TABLE *SystemTable\r
48 );\r
49\r
50/**\r
51 Enrty point wrapper of DXE SMM Driver.\r
52\r
53 @param ImageHandle ImageHandle of the loaded driver.\r
54 @param SystemTable Pointer to the EFI System Table.\r
55\r
56 @retval EFI_SUCCESS One or more of the drivers returned a success code.\r
57 @retval !EFI_SUCESS The return status from the last driver entry point in the list.\r
58\r
59**/\r
60EFI_STATUS\r
61EFIAPI\r
62EfiMain (\r
63 IN EFI_HANDLE ImageHandle,\r
64 IN EFI_SYSTEM_TABLE *SystemTable\r
65 );\r
66\r
67/**\r
68 Computes the cummulative return status for the driver entry point and perform\r
69 a long jump back into DriverEntryPoint().\r
70\r
71 @param Status Status returned by the driver that is exiting.\r
72\r
73**/\r
74VOID\r
75EFIAPI\r
76ExitDriver (\r
77 IN EFI_STATUS Status\r
78 );\r
79\r
80/**\r
81 Call constructs for all libraries. Automatics Generated by tool.\r
82\r
83 @param ImageHandle ImageHandle of the loaded driver.\r
84 @param SystemTable Pointer to the EFI System Table.\r
85\r
86**/\r
87VOID\r
88EFIAPI\r
89ProcessLibraryConstructorList (\r
90 IN EFI_HANDLE ImageHandle,\r
91 IN EFI_SYSTEM_TABLE *SystemTable\r
92 );\r
93\r
94/**\r
95 Call destructors for all libraries. Automatics Generated by tool.\r
96\r
97 @param ImageHandle ImageHandle of the loaded driver.\r
98 @param SystemTable Pointer to the EFI System Table.\r
99\r
100**/\r
101VOID\r
102EFIAPI\r
103ProcessLibraryDestructorList (\r
104 IN EFI_HANDLE ImageHandle,\r
105 IN EFI_SYSTEM_TABLE *SystemTable\r
106 );\r
107\r
108\r
109/**\r
110 Call the list of driver entry points. Automatics Generated by tool.\r
111\r
112 @param ImageHandle ImageHandle of the loaded driver.\r
113 @param SystemTable Pointer to the EFI System Table.\r
114\r
115 @return Status returned by entry points of drivers. \r
116 \r
117**/\r
118EFI_STATUS\r
119EFIAPI\r
120ProcessModuleEntryPointList (\r
121 IN EFI_HANDLE ImageHandle,\r
122 IN EFI_SYSTEM_TABLE *SystemTable\r
123 );\r
124\r
125\r
126/**\r
127 Call the unload handlers for all the modules. Automatics Generated by tool.\r
128\r
129 @param ImageHandle ImageHandle of the loaded driver.\r
130 \r
131 @return Status returned by unload handlers of drivers.\r
132\r
133**/\r
134EFI_STATUS\r
135EFIAPI\r
136ProcessModuleUnloadList (\r
137 IN EFI_HANDLE ImageHandle\r
138 );\r
139\r
140#endif\r