UefiCpuPkg/MpInitLib: Add out attribute for parameter.

[mirror_edk2.git] / SecurityPkg / FvReportPei / FvReportPei.h

/** @file\r
  Definitions for OBB FVs verification.\r
\r
Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __FV_REPORT_PEI_H__\r
#define __FV_REPORT_PEI_H__\r
\r
#include <PiPei.h>\r
\r
#include <IndustryStandard/Tpm20.h>\r
\r
#include <Ppi/FirmwareVolumeInfoStoredHashFv.h>\r
\r
#include <Library/PeiServicesLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/BaseCryptLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
\r
#define HASH_INFO_PTR(PreHashedFvPpi)  \\r
  (HASH_INFO *)((UINT8 *)(PreHashedFvPpi) + sizeof (EDKII_PEI_FIRMWARE_VOLUME_INFO_PREHASHED_FV_PPI))\r
\r
#define HASH_VALUE_PTR(HashInfo)   \\r
  (VOID *)((UINT8 *)(HashInfo) + sizeof (HASH_INFO))\r
\r
/**\r
  Computes the message digest of a input data buffer.\r
\r
  This function performs message digest of a given data buffer, and places\r
  the digest value into the specified memory.\r
\r
  If this interface is not supported, then return FALSE.\r
\r
  @param[in]   Data        Pointer to the buffer containing the data to be hashed.\r
  @param[in]   DataSize    Size of Data buffer in bytes.\r
  @param[out]  HashValue   Pointer to a buffer that receives digest value.\r
\r
  @retval TRUE   The digest computation succeeded.\r
  @retval FALSE  The digest computation failed.\r
\r
**/\r
typedef\r
BOOLEAN\r
(EFIAPI *HASH_ALL_METHOD) (\r
  IN   CONST VOID  *Data,\r
  IN   UINTN       DataSize,\r
  OUT  UINT8       *HashValue\r
  );\r
\r
/**\r
  Initializes user-supplied memory as hash context for subsequent use.\r
\r
  @param[out]  HashContext  Pointer to hash context being initialized.\r
\r
  @retval TRUE   Hash context initialization succeeded.\r
  @retval FALSE  Hash context initialization failed.\r
  @retval FALSE  This interface is not supported.\r
\r
**/\r
typedef\r
BOOLEAN\r
(EFIAPI *HASH_INIT_METHOD) (\r
  OUT  VOID  *HashContext\r
  );\r
\r
/**\r
  Digests the input data and updates hash context.\r
\r
  @param[in, out]  HashContext  Pointer to the hash context.\r
  @param[in]       Data         Pointer to the buffer containing the data to be hashed.\r
  @param[in]       DataSize     Size of Data buffer in bytes.\r
\r
  @retval TRUE   Hash data digest succeeded.\r
  @retval FALSE  Hash data digest failed.\r
  @retval FALSE  This interface is not supported.\r
\r
**/\r
typedef\r
BOOLEAN\r
(EFIAPI *HASH_UPDATE_METHOD) (\r
  IN OUT  VOID        *HashContext,\r
  IN      CONST VOID  *Data,\r
  IN      UINTN       DataSize\r
  );\r
\r
/**\r
  Completes computation of the hash digest value.\r
\r
  @param[in, out]  HashContext  Pointer to the hash context.\r
  @param[out]      HashValue    Pointer to a buffer that receives the hash digest\r
                                value.\r
\r
  @retval TRUE   Hash digest computation succeeded.\r
  @retval FALSE  Hash digest computation failed.\r
  @retval FALSE  This interface is not supported.\r
\r
**/\r
typedef\r
BOOLEAN\r
(EFIAPI *HASH_FINAL_METHOD) (\r
  IN OUT  VOID   *HashContext,\r
  OUT     UINT8  *HashValue\r
  );\r
\r
typedef struct {\r
  UINT16              HashAlgId;\r
  UINTN               HashSize;\r
  HASH_INIT_METHOD    HashInit;\r
  HASH_UPDATE_METHOD  HashUpdate;\r
  HASH_FINAL_METHOD   HashFinal;\r
  HASH_ALL_METHOD     HashAll;\r
} HASH_ALG_INFO;\r
\r
#endif //__FV_REPORT_PEI_H__\r
\r