]>
Commit | Line | Data |
---|---|---|
fb3df220 | 1 | /** @file\r |
2 | Entry point to a DXE Boot Services Driver\r | |
3 | \r | |
4 | Copyright (c) 2006, Intel Corporation<BR>\r | |
5 | All rights reserved. This program and the accompanying materials\r | |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT 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 | |
fc30687f | 18 | ///\r |
19 | /// Declare the EFI/UEFI Specification Revision to which this driver is implemented \r | |
20 | ///\r | |
0308e20d | 21 | extern CONST UINT32 _gUefiDriverRevision;\r |
fb3df220 | 22 | \r |
fc30687f | 23 | ///\r |
24 | /// Declare the number of unload handler in the image. \r | |
25 | ///\r | |
0308e20d | 26 | extern CONST UINT8 _gDriverUnloadImageCount;\r |
fb3df220 | 27 | \r |
fb3df220 | 28 | \r |
29 | /**\r | |
822ce226 | 30 | Enrty point to DXE Driver.\r |
fb3df220 | 31 | \r |
32 | @param ImageHandle ImageHandle of the loaded driver.\r | |
33 | @param SystemTable Pointer to the EFI System Table.\r | |
34 | \r | |
35 | @retval EFI_SUCCESS One or more of the drivers returned a success code.\r | |
36 | @retval !EFI_SUCESS The return status from the last driver entry point in the list.\r | |
37 | \r | |
38 | **/\r | |
39 | EFI_STATUS\r | |
40 | EFIAPI\r | |
41 | _ModuleEntryPoint (\r | |
42 | IN EFI_HANDLE ImageHandle,\r | |
43 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
44 | );\r | |
45 | \r | |
46 | \r | |
47 | /**\r | |
48 | Enrty point wrapper of DXE Driver.\r | |
49 | \r | |
50 | @param ImageHandle ImageHandle of the loaded driver.\r | |
51 | @param SystemTable Pointer to the EFI System Table.\r | |
52 | \r | |
53 | @retval EFI_SUCCESS One or more of the drivers returned a success code.\r | |
54 | @retval !EFI_SUCESS The return status from the last driver entry point in the list.\r | |
55 | \r | |
56 | **/\r | |
57 | EFI_STATUS\r | |
58 | EFIAPI\r | |
59 | EfiMain (\r | |
60 | IN EFI_HANDLE ImageHandle,\r | |
61 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
62 | );\r | |
63 | \r | |
64 | \r | |
65 | /**\r | |
66 | Computes the cummulative return status for the driver entry point and perform\r | |
67 | a long jump back into DriverEntryPoint().\r | |
68 | \r | |
69 | @param Status Status returned by the driver that is exiting.\r | |
70 | \r | |
71 | **/\r | |
72 | VOID\r | |
73 | EFIAPI\r | |
74 | ExitDriver (\r | |
75 | IN EFI_STATUS Status\r | |
76 | );\r | |
77 | \r | |
78 | \r | |
79 | /**\r | |
80 | Call constructs for all libraries. Automatics Generated by tool.\r | |
81 | \r | |
82 | @param ImageHandle ImageHandle of the loaded driver.\r | |
83 | @param SystemTable Pointer to the EFI System Table.\r | |
84 | \r | |
85 | **/\r | |
86 | VOID\r | |
87 | EFIAPI\r | |
88 | ProcessLibraryConstructorList (\r | |
89 | IN EFI_HANDLE ImageHandle,\r | |
90 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
91 | );\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 | |
101 | VOID\r | |
102 | EFIAPI\r | |
103 | ProcessLibraryDestructorList (\r | |
104 | IN EFI_HANDLE ImageHandle,\r | |
105 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
106 | );\r | |
107 | \r | |
108 | /**\r | |
109 | Call the list of driver entry points. Automatics Generated by tool.\r | |
110 | \r | |
111 | @param ImageHandle ImageHandle of the loaded driver.\r | |
112 | @param SystemTable Pointer to the EFI System Table.\r | |
113 | \r | |
114 | @return Status returned by entry points of drivers. \r | |
115 | \r | |
116 | **/\r | |
117 | \r | |
42eedea9 | 118 | /**\r |
119 | Call the list of driver entry points. Automatics Generated by tool.\r | |
120 | \r | |
121 | @param ImageHandle ImageHandle of the loaded driver.\r | |
122 | @param SystemTable Pointer to the EFI System Table.\r | |
123 | \r | |
124 | @return Status returned by entry points of drivers. \r | |
125 | \r | |
126 | **/\r | |
fb3df220 | 127 | EFI_STATUS\r |
128 | EFIAPI\r | |
129 | ProcessModuleEntryPointList (\r | |
130 | IN EFI_HANDLE ImageHandle,\r | |
131 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
132 | );\r | |
133 | \r | |
134 | \r | |
135 | /**\r | |
136 | Call the unload handlers for all the modules. Automatics Generated by tool.\r | |
137 | \r | |
138 | @param ImageHandle ImageHandle of the loaded driver.\r | |
139 | \r | |
140 | @return Status returned by unload handlers of drivers.\r | |
141 | \r | |
142 | **/\r | |
143 | EFI_STATUS\r | |
144 | EFIAPI\r | |
145 | ProcessModuleUnloadList (\r | |
146 | IN EFI_HANDLE ImageHandle\r | |
147 | );\r | |
148 | \r | |
149 | #endif\r |