MdeModulePkg: Make retval in UninstallMultipleProtocol follow Spec

[mirror_edk2.git] / CryptoPkg / Include / Library / HashApiLib.h

/** @file\r
  Unified Hash API Defines\r
\r
  This API when called will calculate the Hash using the\r
  hashing algorithm specified by PcdHashApiLibPolicy.\r
\r
  Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __BASEHASHAPILIB_H_\r
#define __BASEHASHAPILIB_H_\r
\r
typedef VOID  *HASH_API_CONTEXT;\r
\r
//\r
// Hash Algorithms\r
//\r
#define HASH_API_ALGO_INVALID    0x00000000\r
#define HASH_API_ALGO_MD4        0x00000001\r
#define HASH_API_ALGO_MD5        0x00000002\r
#define HASH_API_ALGO_SHA1       0x00000003\r
#define HASH_API_ALGO_SHA256     0x00000004\r
#define HASH_API_ALGO_SHA384     0x00000005\r
#define HASH_API_ALGO_SHA512     0x00000006\r
#define HASH_API_ALGO_SM3_256    0x00000007\r
\r
/**\r
  Retrieves the size, in bytes, of the context buffer required for hash operations.\r
\r
  @return  The size, in bytes, of the context buffer required for hash operations.\r
**/\r
UINTN\r
EFIAPI\r
HashApiGetContextSize (\r
  VOID\r
  );\r
\r
/**\r
  Init hash sequence.\r
\r
  @param[out] HashContext   Hash context.\r
\r
  @retval TRUE         Hash start and HashHandle returned.\r
  @retval FALSE        Hash Init unsuccessful.\r
**/\r
BOOLEAN\r
EFIAPI\r
HashApiInit (\r
  OUT HASH_API_CONTEXT  HashContext\r
  );\r
\r
/**\r
  Makes a copy of an existing hash context.\r
\r
  @param[in]  HashContext     Hash context.\r
  @param[out] NewHashContext  New copy of hash context.\r
\r
  @retval TRUE         Hash context copy succeeded.\r
  @retval FALSE        Hash context copy failed.\r
**/\r
BOOLEAN\r
EFIAPI\r
HashApiDuplicate (\r
  IN  HASH_API_CONTEXT  HashContext,\r
  OUT HASH_API_CONTEXT  NewHashContext\r
  );\r
\r
/**\r
  Update hash data.\r
\r
  @param[in] HashContext   Hash context.\r
  @param[in] DataToHash    Data to be hashed.\r
  @param[in] DataToHashLen Data size.\r
\r
  @retval TRUE         Hash updated.\r
  @retval FALSE        Hash updated unsuccessful.\r
**/\r
BOOLEAN\r
EFIAPI\r
HashApiUpdate (\r
  IN HASH_API_CONTEXT  HashContext,\r
  IN VOID              *DataToHash,\r
  IN UINTN             DataToHashLen\r
  );\r
\r
/**\r
  Hash complete.\r
\r
  @param[in]  HashContext  Hash context.\r
  @param[out] Digest       Hash Digest.\r
\r
  @retval TRUE         Hash complete and Digest is returned.\r
  @retval FALSE        Hash complete unsuccessful.\r
**/\r
BOOLEAN\r
EFIAPI\r
HashApiFinal (\r
  IN  HASH_API_CONTEXT  HashContext,\r
  OUT UINT8             *Digest\r
  );\r
\r
/**\r
  Computes hash message digest of a input data buffer.\r
\r
  @param[in]  DataToHash     Data to be hashed.\r
  @param[in]  DataToHashLen  Data size.\r
  @param[out] Digest         Hash Digest.\r
\r
  @retval TRUE   Hash digest computation succeeded.\r
  @retval FALSE  Hash digest computation failed.\r
**/\r
BOOLEAN\r
EFIAPI\r
HashApiHashAll (\r
  IN  CONST VOID  *DataToHash,\r
  IN  UINTN       DataToHashLen,\r
  OUT UINT8       *Digest\r
  );\r
\r
#endif\r