]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | Module entry point library for PEIM.\r | |
3 | \r | |
4 | Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r | |
5 | 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 | |
18 | ///\r | |
19 | /// Declare the EFI/UEFI Specification Revision to which this driver is implemented \r | |
20 | ///\r | |
21 | extern CONST UINT32 _gPeimRevision;\r | |
22 | \r | |
23 | \r | |
24 | /**\r | |
25 | The entry point of PE/COFF Image for a PEIM.\r | |
26 | \r | |
27 | This function is the entry point for a PEIM. This function must call ProcessLibraryConstructorList() \r | |
28 | and ProcessModuleEntryPointList(). The return value from ProcessModuleEntryPointList() is returned.\r | |
29 | If _gPeimRevision is not zero and PeiServices->Hdr.Revision is less than _gPeimRevison, then ASSERT().\r | |
30 | \r | |
31 | @param FileHandle Handle of the file being invoked. \r | |
32 | @param PeiServices Describes the list of possible PEI Services.\r | |
33 | \r | |
34 | @retval EFI_SUCCESS The PEIM executed normally.\r | |
35 | @retval !EFI_SUCCESS The PEIM failed to execute normally.\r | |
36 | **/\r | |
37 | EFI_STATUS\r | |
38 | EFIAPI\r | |
39 | _ModuleEntryPoint (\r | |
40 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
41 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
42 | );\r | |
43 | \r | |
44 | \r | |
45 | /**\r | |
46 | Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().\r | |
47 | \r | |
48 | This function is required to call _ModuleEntryPoint() passing in FileHandle and PeiServices.\r | |
49 | \r | |
50 | @param FileHandle Handle of the file being invoked. \r | |
51 | @param PeiServices Describes the list of possible PEI Services.\r | |
52 | \r | |
53 | @retval EFI_SUCCESS The PEIM executed normally.\r | |
54 | @retval !EFI_SUCCESS The PEIM failed to execute normally.\r | |
55 | \r | |
56 | **/\r | |
57 | EFI_STATUS\r | |
58 | EFIAPI\r | |
59 | EfiMain (\r | |
60 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
61 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
62 | );\r | |
63 | \r | |
64 | /**\r | |
65 | Autogenerated function that calls the library constructors for all of the module's\r | |
66 | dependent libraries.\r | |
67 | \r | |
68 | This function must be called by _ModuleEntryPoint().\r | |
69 | This function calls the set of library constructors for the set of library instances that a\r | |
70 | module depends on. This includes library instances that a module depends on directly and library\r | |
71 | instances that a module depends on indirectly through other libraries. \r | |
72 | This function is autogenerated by build tools and those build tools are responsible for collecting\r | |
73 | the set of library instances, determine which ones have constructors, and calling the library\r | |
74 | constructors in the proper order based upon each of the library instances own dependencies.\r | |
75 | \r | |
76 | @param FileHandle Handle of the file being invoked.\r | |
77 | @param PeiServices Describes the list of possible PEI Services.\r | |
78 | \r | |
79 | **/\r | |
80 | VOID\r | |
81 | EFIAPI\r | |
82 | ProcessLibraryConstructorList (\r | |
83 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
84 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
85 | );\r | |
86 | \r | |
87 | /**\r | |
88 | Autogenerated function that calls a set of module entry points.\r | |
89 | \r | |
90 | This function must be called by _ModuleEntryPoint().\r | |
91 | This function calls the set of module entry points. \r | |
92 | This function is autogenerated by build tools and those build tools are responsible\r | |
93 | for collecting the module entry points and calling them in a specified order.\r | |
94 | \r | |
95 | @param FileHandle Handle of the file being invoked. \r | |
96 | @param PeiServices Describes the list of possible PEI Services.\r | |
97 | \r | |
98 | @retval EFI_SUCCESS The PEIM executed normally.\r | |
99 | @retval !EFI_SUCCESS The PEIM failed to execute normally.\r | |
100 | \r | |
101 | **/\r | |
102 | EFI_STATUS\r | |
103 | EFIAPI\r | |
104 | ProcessModuleEntryPointList (\r | |
105 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
106 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
107 | );\r | |
108 | \r | |
109 | #endif\r |