UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / MdePkg / Include / Library / RngLib.h

/** @file\r
  Provides random number generator services.\r
\r
Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __RNG_LIB_H__\r
#define __RNG_LIB_H__\r
\r
/**\r
  Generates a 16-bit random number.\r
\r
  if Rand is NULL, then ASSERT().\r
\r
  @param[out] Rand     Buffer pointer to store the 16-bit random value.\r
\r
  @retval TRUE         Random number generated successfully.\r
  @retval FALSE        Failed to generate the random number.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
GetRandomNumber16 (\r
  OUT     UINT16  *Rand\r
  );\r
\r
/**\r
  Generates a 32-bit random number.\r
\r
  if Rand is NULL, then ASSERT().\r
\r
  @param[out] Rand     Buffer pointer to store the 32-bit random value.\r
\r
  @retval TRUE         Random number generated successfully.\r
  @retval FALSE        Failed to generate the random number.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
GetRandomNumber32 (\r
  OUT     UINT32  *Rand\r
  );\r
\r
/**\r
  Generates a 64-bit random number.\r
\r
  if Rand is NULL, then ASSERT().\r
\r
  @param[out] Rand     Buffer pointer to store the 64-bit random value.\r
\r
  @retval TRUE         Random number generated successfully.\r
  @retval FALSE        Failed to generate the random number.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
GetRandomNumber64 (\r
  OUT     UINT64  *Rand\r
  );\r
\r
/**\r
  Generates a 128-bit random number.\r
\r
  if Rand is NULL, then ASSERT().\r
\r
  @param[out] Rand     Buffer pointer to store the 128-bit random value.\r
\r
  @retval TRUE         Random number generated successfully.\r
  @retval FALSE        Failed to generate the random number.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
GetRandomNumber128 (\r
  OUT     UINT64  *Rand\r
  );\r
\r
#endif // __RNG_LIB_H__\r