]>
Commit | Line | Data |
---|---|---|
5879b875 | 1 | /** @file\r |
2 | This file declares DXE Initial Program Load PPI.\r | |
d7132512 | 3 | When the PEI core is done it calls the DXE IPL PPI to load the DXE Foundation.\r |
5879b875 | 4 | \r |
9df063a0 HT |
5 | Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r |
6 | This program and the accompanying materials \r | |
5879b875 | 7 | are licensed and made available under the terms and conditions of the BSD License \r |
8 | which accompanies this distribution. The full text of the license may be found at \r | |
9 | http://opensource.org/licenses/bsd-license.php \r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
13 | \r | |
5879b875 | 14 | @par Revision Reference:\r |
0047820e | 15 | This PPI is introduced in PI Version 1.0.\r |
5879b875 | 16 | \r |
17 | **/\r | |
18 | \r | |
19 | #ifndef __DXE_IPL_H__\r | |
20 | #define __DXE_IPL_H__\r | |
21 | \r | |
22 | #define EFI_DXE_IPL_PPI_GUID \\r | |
23 | { \\r | |
24 | 0xae8ce5d, 0xe448, 0x4437, {0xa8, 0xd7, 0xeb, 0xf5, 0xf1, 0x94, 0xf7, 0x31 } \\r | |
25 | }\r | |
26 | \r | |
27 | typedef struct _EFI_DXE_IPL_PPI EFI_DXE_IPL_PPI;\r | |
28 | \r | |
29 | /**\r | |
30 | The architectural PPI that the PEI Foundation invokes when \r | |
31 | there are no additional PEIMs to invoke.\r | |
32 | \r | |
dafa11b1 | 33 | This function is invoked by the PEI Foundation.\r |
34 | The PEI Foundation will invoke this service when there are\r | |
35 | no additional PEIMs to invoke in the system.\r | |
36 | If this PPI does not exist, it is an error condition and\r | |
37 | an ill-formed firmware set. The DXE IPL PPI should never\r | |
38 | return after having been invoked by the PEI Foundation.\r | |
39 | The DXE IPL PPI can do many things internally, including the following:\r | |
40 | - Invoke the DXE entry point from a firmware volume\r | |
41 | - Invoke the recovery processing modules\r | |
42 | - Invoke the S3 resume modules\r | |
43 | \r | |
5879b875 | 44 | @param This Pointer to the DXE IPL PPI instance\r |
45 | @param PeiServices Pointer to the PEI Services Table.\r | |
46 | @param HobList Pointer to the list of Hand-Off Block (HOB) entries.\r | |
47 | \r | |
d7132512 LG |
48 | @retval EFI_SUCCESS Upon this return code, the PEI Foundation should enter\r |
49 | some exception handling.Under normal circumstances, \r | |
50 | the DXE IPL PPI should not return.\r | |
5879b875 | 51 | \r |
52 | **/\r | |
53 | typedef\r | |
54 | EFI_STATUS\r | |
8b13229b | 55 | (EFIAPI *EFI_DXE_IPL_ENTRY)(\r |
dafa11b1 | 56 | IN CONST EFI_DXE_IPL_PPI *This,\r |
5879b875 | 57 | IN EFI_PEI_SERVICES **PeiServices,\r |
58 | IN EFI_PEI_HOB_POINTERS HobList\r | |
59 | );\r | |
60 | \r | |
dafa11b1 | 61 | ///\r |
62 | /// Final service to be invoked by the PEI Foundation.\r | |
63 | /// The DXE IPL PPI is responsible for locating and loading the DXE Foundation.\r | |
64 | /// The DXE IPL PPI may use PEI services to locate and load the DXE Foundation.\r | |
65 | ///\r | |
5879b875 | 66 | struct _EFI_DXE_IPL_PPI {\r |
67 | EFI_DXE_IPL_ENTRY Entry;\r | |
68 | };\r | |
69 | \r | |
70 | extern EFI_GUID gEfiDxeIplPpiGuid;\r | |
71 | \r | |
72 | #endif\r |