SecurityPkg: Convert non DOS format files to DOS format

[mirror_edk2.git] / SecurityPkg / RandomNumberGenerator / RngDxe / RdRand.h

/** @file\r
  Header for the RDRAND APIs used by RNG DXE driver.\r
\r
  Support API definitions for RDRAND instruction access, which will leverage\r
  Intel Secure Key technology to provide high-quality random numbers for use\r
  in applications, or entropy for seeding other random number generators.\r
  Refer to http://software.intel.com/en-us/articles/intel-digital-random-number\r
  -generator-drng-software-implementation-guide/ for more information about Intel\r
  Secure Key technology.\r
\r
Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __RD_RAND_H__\r
#define __RD_RAND_H__\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/TimerLib.h>\r
#include <Protocol/Rng.h>\r
\r
//\r
// The maximun number of retries to obtain one available random number. \r
//\r
#define RETRY_LIMIT    10\r
\r
/**\r
  Determines whether or not RDRAND instruction is supported by the host hardware.\r
\r
  @retval EFI_SUCCESS          RDRAND instruction supported.\r
  @retval EFI_UNSUPPORTED      RDRAND instruction not supported.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
IsRdRandSupported (\r
  VOID\r
  );\r
\r
/**\r
  Generates a 16-bit random number through RDRAND instruction.\r
\r
  @param[out]  Rand          Buffer pointer to store the random result.\r
\r
  @retval TRUE               RDRAND call was successful.\r
  @retval FALSE              Failed attempts to call RDRAND.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
RdRand16Step (\r
  OUT UINT16       *Rand\r
  );\r
\r
/**\r
  Generates a 32-bit random number through RDRAND instruction.\r
\r
  @param[out]  Rand          Buffer pointer to store the random result.\r
\r
  @retval TRUE               RDRAND call was successful.\r
  @retval FALSE              Failed attempts to call RDRAND.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
RdRand32Step (\r
  OUT UINT32       *Rand\r
  );\r
\r
/**\r
  Generates a 64-bit random number through RDRAND instruction.\r
\r
  @param[out]  Rand          Buffer pointer to store the random result.\r
\r
  @retval TRUE               RDRAND call was successful.\r
  @retval FALSE              Failed attempts to call RDRAND.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
RdRand64Step  (\r
  OUT UINT64   *Rand\r
  );\r
\r
/**\r
  Calls RDRAND to obtain a 16-bit random number.\r
\r
  @param[out]  Rand          Buffer pointer to store the random result.\r
  @param[in]   NeedRetry     Determine whether or not to loop retry.\r
\r
  @retval EFI_SUCCESS        RDRAND call was successful.\r
  @retval EFI_NOT_READY      Failed attempts to call RDRAND.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RdRand16 (\r
  OUT UINT16       *Rand,\r
  IN BOOLEAN       NeedRetry\r
  );\r
\r
/**\r
  Calls RDRAND to obtain a 32-bit random number.\r
\r
  @param[out]  Rand          Buffer pointer to store the random result.\r
  @param[in]   NeedRetry     Determine whether or not to loop retry.\r
\r
  @retval EFI_SUCCESS        RDRAND call was successful.\r
  @retval EFI_NOT_READY      Failed attempts to call RDRAND.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RdRand32 (\r
  OUT UINT32       *Rand,\r
  IN BOOLEAN       NeedRetry\r
  );\r
\r
/**\r
  Calls RDRAND to obtain a 64-bit random number.\r
\r
  @param[out]  Rand          Buffer pointer to store the random result.\r
  @param[in]   NeedRetry     Determine whether or not to loop retry.\r
\r
  @retval EFI_SUCCESS        RDRAND call was successful.\r
  @retval EFI_NOT_READY      Failed attempts to call RDRAND.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RdRand64 (\r
  OUT UINT64       *Rand,\r
  IN BOOLEAN       NeedRetry\r
  );\r
  \r
/**\r
  Calls RDRAND to request a word-length random number.\r
\r
  @param[out]  Rand          Buffer pointer to store the random number.\r
  @param[in]   NeedRetry     Determine whether or not to loop retry.\r
\r
  @retval EFI_SUCCESS        Random word generation succeeded.\r
  @retval EFI_NOT_READY      Failed to request random word.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RdRandWord (\r
  OUT UINTN        *Rand,\r
  IN BOOLEAN       NeedRetry\r
  );\r
\r
/**\r
  Calls RDRAND to request multiple word-length random numbers.\r
\r
  @param[in]   Length        Size of the buffer, in words, to fill with.\r
  @param[out]  RandBuffer    Pointer to the buffer to store the random result.\r
\r
  @retval EFI_SUCCESS        Random words generation succeeded.\r
  @retval EFI_NOT_READY      Failed to request random words.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RdRandGetWords (\r
  IN UINTN         Length,\r
  OUT UINTN        *RandBuffer\r
  );\r
\r
/**\r
  Calls RDRAND to fill a buffer of arbitrary size with random bytes.\r
\r
  @param[in]   Length        Size of the buffer, in bytes,  to fill with.\r
  @param[out]  RandBuffer    Pointer to the buffer to store the random result.\r
\r
  @retval EFI_SUCCESS        Random bytes generation succeeded.\r
  @retval EFI_NOT_READY      Failed to request random bytes.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RdRandGetBytes (\r
  IN UINTN         Length,\r
  OUT UINT8        *RandBuffer\r
  );\r
\r
/**\r
  Generate high-quality entropy source through RDRAND.\r
\r
  @param[in]   Length        Size of the buffer, in bytes, to fill with.\r
  @param[out]  Entropy       Pointer to the buffer to store the entropy data.\r
\r
  @retval EFI_SUCCESS        Entropy generation succeeded.\r
  @retval EFI_NOT_READY      Failed to request random data.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RdRandGenerateEntropy (\r
  IN UINTN         Length,\r
  OUT UINT8        *Entropy\r
  );\r
\r
#endif  // __RD_RAND_H__