MdePkg: Apply uncrustify changes

[mirror_edk2.git] / MdePkg / Library / BaseRngLib / Rand / RdRand.c

/** @file\r
  Random number generator services that uses RdRand instruction access\r
  to provide high-quality random numbers.\r
\r
Copyright (c) 2021, NUVIA Inc. All rights reserved.<BR>\r
Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <Uefi.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
\r
#include "BaseRngLibInternals.h"\r
\r
//\r
// Bit mask used to determine if RdRand instruction is supported.\r
//\r
#define RDRAND_MASK  BIT30\r
\r
STATIC BOOLEAN  mRdRandSupported;\r
\r
/**\r
  The constructor function checks whether or not RDRAND instruction is supported\r
  by the host hardware.\r
\r
  The constructor function checks whether or not RDRAND instruction is supported.\r
  It will ASSERT() if RDRAND instruction is not supported.\r
  It will always return EFI_SUCCESS.\r
\r
  @retval EFI_SUCCESS   The constructor always returns EFI_SUCCESS.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BaseRngLibConstructor (\r
  VOID\r
  )\r
{\r
  UINT32  RegEcx;\r
\r
  //\r
  // Determine RDRAND support by examining bit 30 of the ECX register returned by\r
  // CPUID. A value of 1 indicates that processor support RDRAND instruction.\r
  //\r
  AsmCpuid (1, 0, 0, &RegEcx, 0);\r
  ASSERT ((RegEcx & RDRAND_MASK) == RDRAND_MASK);\r
\r
  mRdRandSupported = ((RegEcx & RDRAND_MASK) == RDRAND_MASK);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Generates a 16-bit random number.\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
ArchGetRandomNumber16 (\r
  OUT     UINT16  *Rand\r
  )\r
{\r
  return AsmRdRand16 (Rand);\r
}\r
\r
/**\r
  Generates a 32-bit random number.\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
ArchGetRandomNumber32 (\r
  OUT     UINT32  *Rand\r
  )\r
{\r
  return AsmRdRand32 (Rand);\r
}\r
\r
/**\r
  Generates a 64-bit random number.\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
ArchGetRandomNumber64 (\r
  OUT     UINT64  *Rand\r
  )\r
{\r
  return AsmRdRand64 (Rand);\r
}\r
\r
/**\r
  Checks whether RDRAND is supported.\r
\r
  @retval TRUE         RDRAND is supported.\r
  @retval FALSE        RDRAND is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
ArchIsRngSupported (\r
  VOID\r
  )\r
{\r
  /*\r
     Existing software depends on this always returning TRUE, so for\r
     now hard-code it.\r
\r
     return mRdRandSupported;\r
  */\r
  return TRUE;\r
}\r