/** @file\r
This file declares DXE Initial Program Load PPI.\r
- When the PEI core is done it calls the DXE IPL via this PPI.\r
+ When the PEI core is done it calls the DXE IPL PPI to load the DXE Foundation.\r
\r
- Copyright (c) 2006, Intel Corporation \r
- All rights reserved. This program and the accompanying materials \r
- are licensed and made available under the terms and conditions of the BSD License \r
- which accompanies this distribution. The full text of the license may be found at \r
- http://opensource.org/licenses/bsd-license.php \r
-\r
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
-\r
- Module Name: DxeIpl.h\r
+ Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
@par Revision Reference:\r
- This PPI is defined in PEI CIS.\r
- Version 0.91.\r
+ This PPI is introduced in PI Version 1.0.\r
\r
**/\r
\r
typedef struct _EFI_DXE_IPL_PPI EFI_DXE_IPL_PPI;\r
\r
/**\r
- The architectural PPI that the PEI Foundation invokes when \r
+ The architectural PPI that the PEI Foundation invokes when\r
there are no additional PEIMs to invoke.\r
\r
- @param This Pointer to the DXE IPL PPI instance\r
- \r
- @param PeiServices Pointer to the PEI Services Table.\r
- \r
- @param HobList Pointer to the list of Hand-Off Block (HOB) entries.\r
-\r
- @retval EFI_SUCCESS Upon this return code, the PEI Foundation should enter \r
- some exception handling.Under normal circumstances, the DXE IPL PPI should not return.\r
+ This function is invoked by the PEI Foundation.\r
+ The PEI Foundation will invoke this service when there are\r
+ no additional PEIMs to invoke in the system.\r
+ If this PPI does not exist, it is an error condition and\r
+ an ill-formed firmware set. The DXE IPL PPI should never\r
+ return after having been invoked by the PEI Foundation.\r
+ The DXE IPL PPI can do many things internally, including the following:\r
+ - Invoke the DXE entry point from a firmware volume\r
+ - Invoke the recovery processing modules\r
+ - Invoke the S3 resume modules\r
+\r
+ @param This Pointer to the DXE IPL PPI instance\r
+ @param PeiServices Pointer to the PEI Services Table.\r
+ @param HobList Pointer to the list of Hand-Off Block (HOB) entries.\r
+\r
+ @retval EFI_SUCCESS Upon this return code, the PEI Foundation should enter\r
+ some exception handling.Under normal circumstances,\r
+ the DXE IPL PPI should not return.\r
\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_DXE_IPL_ENTRY) (\r
- IN EFI_DXE_IPL_PPI *This,\r
+(EFIAPI *EFI_DXE_IPL_ENTRY)(\r
+ IN CONST EFI_DXE_IPL_PPI *This,\r
IN EFI_PEI_SERVICES **PeiServices,\r
IN EFI_PEI_HOB_POINTERS HobList\r
);\r
\r
-/**\r
- @par Ppi Description:\r
- Final service to be invoked by the PEI Foundation.\r
- The DXE IPL PPI is responsible for locating and loading the DXE Foundation.\r
- The DXE IPL PPI may use PEI services to locate and load the DXE Foundation.\r
-\r
- @param Entry\r
- The entry point to the DXE IPL PPI.\r
-\r
-**/\r
+///\r
+/// Final service to be invoked by the PEI Foundation.\r
+/// The DXE IPL PPI is responsible for locating and loading the DXE Foundation.\r
+/// The DXE IPL PPI may use PEI services to locate and load the DXE Foundation.\r
+///\r
struct _EFI_DXE_IPL_PPI {\r
EFI_DXE_IPL_ENTRY Entry;\r
};\r