Import Library Class from original MDE package. Also I added the EFI_PEI_CORE_ENTRY_P...
[mirror_edk2.git] / MdePkg / Include / Library / UefiApplicationEntryPoint.h
CommitLineData
fb3df220 1/** @file\r
2 Entry point to a UEFI Application.\r
3\r
4Copyright (c) 2007, 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 __UEFI_APPLICATION_ENTRY_POINT_H__\r
16#define __UEFI_APPLICATION_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 Enrty point to UEFI Application.\r
25\r
26 @param ImageHandle ImageHandle of the loaded driver.\r
27 @param SystemTable Pointer to the EFI System Table.\r
28\r
29 @retval EFI_SUCCESS One or more of the drivers returned a success code.\r
30 @retval !EFI_SUCESS The return status from the last driver entry point in the list.\r
31\r
32**/\r
33EFI_STATUS\r
34EFIAPI\r
35_ModuleEntryPoint (\r
36 IN EFI_HANDLE ImageHandle,\r
37 IN EFI_SYSTEM_TABLE *SystemTable\r
38 );\r
39\r
40\r
41/**\r
42 Enrty point wrapper of UEFI Application.\r
43\r
44 @param ImageHandle ImageHandle of the loaded driver.\r
45 @param SystemTable Pointer to the EFI System Table.\r
46\r
47 @retval EFI_SUCCESS One or more of the drivers returned a success code.\r
48 @retval !EFI_SUCESS The return status from the last driver entry point in the list.\r
49\r
50**/\r
51EFI_STATUS\r
52EFIAPI\r
53EfiMain (\r
54 IN EFI_HANDLE ImageHandle,\r
55 IN EFI_SYSTEM_TABLE *SystemTable\r
56 );\r
57\r
58\r
59/**\r
60 Invoke the destuctors of all libraries and call gBS->Exit\r
61 to return control to firmware core.\r
62\r
63 @param Status Status returned by the application that is exiting.\r
64 \r
65 @retval VOID\r
66\r
67**/\r
68VOID\r
69EFIAPI\r
70Exit (\r
71 IN EFI_STATUS Status\r
72 );\r
73\r
74\r
75/**\r
76 Call constructors for all libraries. Autogen tool inserts the implementation\r
77 of this function into Autogen.c.\r
78\r
79 @param ImageHandle ImageHandle of the loaded driver.\r
80 @param SystemTable Pointer to the EFI System Table.\r
81 \r
82 @retval VOID\r
83\r
84**/\r
85VOID\r
86EFIAPI\r
87ProcessLibraryConstructorList (\r
88 IN EFI_HANDLE ImageHandle,\r
89 IN EFI_SYSTEM_TABLE *SystemTable\r
90 );\r
91\r
92\r
93/**\r
94 Call destructors for all libraries. Autogen tool inserts the implementation\r
95 of this function into Autogen.c.\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 @retval VOID\r
101**/\r
102VOID\r
103EFIAPI\r
104ProcessLibraryDestructorList (\r
105 IN EFI_HANDLE ImageHandle,\r
106 IN EFI_SYSTEM_TABLE *SystemTable\r
107 );\r
108\r
109/**\r
110 Call driver entry point. For UEFI application, user\r
111 can only specify one entry point. Tool will automatically insert\r
112 this to Autogen.c.\r
113\r
114 @param ImageHandle ImageHandle of the loaded driver.\r
115 @param SystemTable Pointer to the EFI System Table.\r
116\r
117 @return Status returned by entry points specified by\r
118 the user. \r
119 \r
120**/\r
121\r
122EFI_STATUS\r
123EFIAPI\r
124ProcessModuleEntryPointList (\r
125 IN EFI_HANDLE ImageHandle,\r
126 IN EFI_SYSTEM_TABLE *SystemTable\r
127 );\r
128\r
129#endif\r