Formalize comments for Protocols and PPIs.

[mirror_edk2.git] / MdePkg / Include / Ppi / DxeIpl.h

/** @file\r
  This file declares DXE Initial Program Load PPI.\r
  When the PEI core is done it calls the DXE IPL PPI to load the DXE Foundation.\r
\r
  Copyright (c) 2006 - 2008, 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
  @par Revision Reference:\r
  This PPI is defined in PI.\r
  Version 1.0.\r
\r
**/\r
\r
#ifndef __DXE_IPL_H__\r
#define __DXE_IPL_H__\r
\r
#define EFI_DXE_IPL_PPI_GUID \\r
  { \\r
    0xae8ce5d, 0xe448, 0x4437, {0xa8, 0xd7, 0xeb, 0xf5, 0xf1, 0x94, 0xf7, 0x31 } \\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
  there are no additional PEIMs to invoke.\r
\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 CONST EFI_DXE_IPL_PPI        *This,\r
  IN EFI_PEI_SERVICES             **PeiServices,\r
  IN EFI_PEI_HOB_POINTERS         HobList\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
\r
extern EFI_GUID gEfiDxeIplPpiGuid;\r
\r
#endif\r