]>
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 | |
fb3df220 | 21 | extern const UINT32 _gUefiDriverRevision;\r |
22 | \r | |
fc30687f | 23 | ///\r |
24 | /// Declare the number of entry points in the image. \r | |
25 | ///\r | |
fb3df220 | 26 | extern const UINT8 _gDriverEntryPointCount;\r |
27 | \r | |
fc30687f | 28 | ///\r |
29 | /// Declare the number of unload handler in the image. \r | |
30 | ///\r | |
fb3df220 | 31 | extern const UINT8 _gDriverUnloadImageCount;\r |
32 | \r | |
fc30687f | 33 | ///\r |
34 | /// Declare the arrary of Boot Sevice Exit Event callbacks . \r | |
35 | ///\r | |
fb3df220 | 36 | extern const EFI_EVENT_NOTIFY _gDriverExitBootServicesEvent[];\r |
37 | \r | |
fc30687f | 38 | ///\r |
39 | /// Declare the arrary of Virtual Address Change Event callbacks . \r | |
40 | ///\r | |
fb3df220 | 41 | extern const EFI_EVENT_NOTIFY _gDriverSetVirtualAddressMapEvent[];\r |
42 | \r | |
43 | /**\r | |
44 | Enrty point to DXE SMM Driver.\r | |
45 | \r | |
46 | @param ImageHandle ImageHandle of the loaded driver.\r | |
47 | @param SystemTable Pointer to the EFI System Table.\r | |
48 | \r | |
49 | @retval EFI_SUCCESS One or more of the drivers returned a success code.\r | |
50 | @retval !EFI_SUCESS The return status from the last driver entry point in the list.\r | |
51 | \r | |
52 | **/\r | |
53 | EFI_STATUS\r | |
54 | EFIAPI\r | |
55 | _ModuleEntryPoint (\r | |
56 | IN EFI_HANDLE ImageHandle,\r | |
57 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
58 | );\r | |
59 | \r | |
60 | \r | |
61 | /**\r | |
62 | Enrty point wrapper of DXE Driver.\r | |
63 | \r | |
64 | @param ImageHandle ImageHandle of the loaded driver.\r | |
65 | @param SystemTable Pointer to the EFI System Table.\r | |
66 | \r | |
67 | @retval EFI_SUCCESS One or more of the drivers returned a success code.\r | |
68 | @retval !EFI_SUCESS The return status from the last driver entry point in the list.\r | |
69 | \r | |
70 | **/\r | |
71 | EFI_STATUS\r | |
72 | EFIAPI\r | |
73 | EfiMain (\r | |
74 | IN EFI_HANDLE ImageHandle,\r | |
75 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
76 | );\r | |
77 | \r | |
78 | \r | |
79 | /**\r | |
80 | Computes the cummulative return status for the driver entry point and perform\r | |
81 | a long jump back into DriverEntryPoint().\r | |
82 | \r | |
83 | @param Status Status returned by the driver that is exiting.\r | |
84 | \r | |
85 | **/\r | |
86 | VOID\r | |
87 | EFIAPI\r | |
88 | ExitDriver (\r | |
89 | IN EFI_STATUS Status\r | |
90 | );\r | |
91 | \r | |
92 | \r | |
93 | /**\r | |
94 | Call constructs for all libraries. Automatics Generated by tool.\r | |
95 | \r | |
96 | @param ImageHandle ImageHandle of the loaded driver.\r | |
97 | @param SystemTable Pointer to the EFI System Table.\r | |
98 | \r | |
99 | **/\r | |
100 | VOID\r | |
101 | EFIAPI\r | |
102 | ProcessLibraryConstructorList (\r | |
103 | IN EFI_HANDLE ImageHandle,\r | |
104 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
105 | );\r | |
106 | \r | |
107 | \r | |
108 | /**\r | |
109 | Call destructors for all libraries. 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 | **/\r | |
115 | VOID\r | |
116 | EFIAPI\r | |
117 | ProcessLibraryDestructorList (\r | |
118 | IN EFI_HANDLE ImageHandle,\r | |
119 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
120 | );\r | |
121 | \r | |
122 | /**\r | |
123 | Call the list of driver entry points. Automatics Generated by tool.\r | |
124 | \r | |
125 | @param ImageHandle ImageHandle of the loaded driver.\r | |
126 | @param SystemTable Pointer to the EFI System Table.\r | |
127 | \r | |
128 | @return Status returned by entry points of drivers. \r | |
129 | \r | |
130 | **/\r | |
131 | \r | |
42eedea9 | 132 | /**\r |
133 | Call the list of driver entry points. Automatics Generated by tool.\r | |
134 | \r | |
135 | @param ImageHandle ImageHandle of the loaded driver.\r | |
136 | @param SystemTable Pointer to the EFI System Table.\r | |
137 | \r | |
138 | @return Status returned by entry points of drivers. \r | |
139 | \r | |
140 | **/\r | |
fb3df220 | 141 | EFI_STATUS\r |
142 | EFIAPI\r | |
143 | ProcessModuleEntryPointList (\r | |
144 | IN EFI_HANDLE ImageHandle,\r | |
145 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
146 | );\r | |
147 | \r | |
148 | \r | |
149 | /**\r | |
150 | Call the unload handlers for all the modules. Automatics Generated by tool.\r | |
151 | \r | |
152 | @param ImageHandle ImageHandle of the loaded driver.\r | |
153 | \r | |
154 | @return Status returned by unload handlers of drivers.\r | |
155 | \r | |
156 | **/\r | |
157 | EFI_STATUS\r | |
158 | EFIAPI\r | |
159 | ProcessModuleUnloadList (\r | |
160 | IN EFI_HANDLE ImageHandle\r | |
161 | );\r | |
162 | \r | |
163 | #endif\r |