MdePkg: Apply uncrustify changes

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

/** @file\r
  This file declares Sec Hob Data PPI.\r
\r
  This PPI provides a way for the SEC code to pass zero or more HOBs in a HOB list.\r
\r
Copyright (c) 2017 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Revision Reference:\r
  This PPI is introduced in PI Version 1.5.\r
\r
**/\r
\r
#ifndef __SEC_HOB_DATA_PPI_H__\r
#define __SEC_HOB_DATA_PPI_H__\r
\r
#include <Pi/PiHob.h>\r
\r
#define EFI_SEC_HOB_DATA_PPI_GUID \\r
  { \\r
    0x3ebdaf20, 0x6667, 0x40d8, {0xb4, 0xee, 0xf5, 0x99, 0x9a, 0xc1, 0xb7, 0x1f } \\r
  }\r
\r
typedef struct _EFI_SEC_HOB_DATA_PPI EFI_SEC_HOB_DATA_PPI;\r
\r
/**\r
  Return a pointer to a buffer containing zero or more HOBs that\r
  will be installed into the PEI HOB List.\r
\r
  This function returns a pointer to a pointer to zero or more HOBs,\r
  terminated with a HOB of type EFI_HOB_TYPE_END_OF_HOB_LIST.\r
  Note: The HobList must not contain a EFI_HOB_HANDOFF_INFO_TABLE HOB (PHIT) HOB.\r
\r
  @param[in]  This          Pointer to this PPI structure.\r
  @param[out] HobList       A pointer to a returned pointer to zero or more HOBs.\r
                            If no HOBs are to be returned, then the returned pointer\r
                            is a pointer to a HOB of type EFI_HOB_TYPE_END_OF_HOB_LIST.\r
\r
  @retval EFI_SUCCESS       This function completed successfully.\r
  @retval EFI_NOT_FOUND     No HOBS are available.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_SEC_HOB_DATA_GET)(\r
  IN CONST EFI_SEC_HOB_DATA_PPI *This,\r
  OUT EFI_HOB_GENERIC_HEADER    **HobList\r
  );\r
\r
///\r
/// This PPI provides a way for the SEC code to pass zero or more HOBs in a HOB list.\r
///\r
struct _EFI_SEC_HOB_DATA_PPI {\r
  EFI_SEC_HOB_DATA_GET    GetHobs;\r
};\r
\r
extern EFI_GUID  gEfiSecHobDataPpiGuid;\r
\r
#endif\r