SecurityPkg: Apply uncrustify changes

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

/** @file\r
  Function prototypes for UEFI Random Number Generator protocol support.\r
\r
  Copyright (c) 2021, NUVIA Inc. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef RNGDXE_INTERNALS_H_\r
#define RNGDXE_INTERNALS_H_\r
\r
/**\r
  Returns information about the random number generation implementation.\r
\r
  @param[in]     This                 A pointer to the EFI_RNG_PROTOCOL instance.\r
  @param[in,out] RNGAlgorithmListSize On input, the size in bytes of RNGAlgorithmList.\r
                                      On output with a return code of EFI_SUCCESS, the size\r
                                      in bytes of the data returned in RNGAlgorithmList. On output\r
                                      with a return code of EFI_BUFFER_TOO_SMALL,\r
                                      the size of RNGAlgorithmList required to obtain the list.\r
  @param[out] RNGAlgorithmList        A caller-allocated memory buffer filled by the driver\r
                                      with one EFI_RNG_ALGORITHM element for each supported\r
                                      RNG algorithm. The list must not change across multiple\r
                                      calls to the same driver. The first algorithm in the list\r
                                      is the default algorithm for the driver.\r
\r
  @retval EFI_SUCCESS                 The RNG algorithm list was returned successfully.\r
  @retval EFI_UNSUPPORTED             The services is not supported by this driver.\r
  @retval EFI_DEVICE_ERROR            The list of algorithms could not be retrieved due to a\r
                                      hardware or firmware error.\r
  @retval EFI_INVALID_PARAMETER       One or more of the parameters are incorrect.\r
  @retval EFI_BUFFER_TOO_SMALL        The buffer RNGAlgorithmList is too small to hold the result.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RngGetInfo (\r
  IN EFI_RNG_PROTOCOL    *This,\r
  IN OUT UINTN           *RNGAlgorithmListSize,\r
  OUT EFI_RNG_ALGORITHM  *RNGAlgorithmList\r
  );\r
\r
/**\r
  Produces and returns an RNG value using either the default or specified RNG algorithm.\r
\r
  @param[in]  This                    A pointer to the EFI_RNG_PROTOCOL instance.\r
  @param[in]  RNGAlgorithm            A pointer to the EFI_RNG_ALGORITHM that identifies the RNG\r
                                      algorithm to use. May be NULL in which case the function will\r
                                      use its default RNG algorithm.\r
  @param[in]  RNGValueLength          The length in bytes of the memory buffer pointed to by\r
                                      RNGValue. The driver shall return exactly this numbers of bytes.\r
  @param[out] RNGValue                A caller-allocated memory buffer filled by the driver with the\r
                                      resulting RNG value.\r
\r
  @retval EFI_SUCCESS                 The RNG value was returned successfully.\r
  @retval EFI_UNSUPPORTED             The algorithm specified by RNGAlgorithm is not supported by\r
                                      this driver.\r
  @retval EFI_DEVICE_ERROR            An RNG value could not be retrieved due to a hardware or\r
                                      firmware error.\r
  @retval EFI_NOT_READY               There is not enough random data available to satisfy the length\r
                                      requested by RNGValueLength.\r
  @retval EFI_INVALID_PARAMETER       RNGValue is NULL or RNGValueLength is zero.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RngGetRNG (\r
  IN EFI_RNG_PROTOCOL   *This,\r
  IN EFI_RNG_ALGORITHM  *RNGAlgorithm  OPTIONAL,\r
  IN UINTN              RNGValueLength,\r
  OUT UINT8             *RNGValue\r
  );\r
\r
/**\r
  Returns information about the random number generation implementation.\r
\r
  @param[in,out] RNGAlgorithmListSize On input, the size in bytes of RNGAlgorithmList.\r
                                      On output with a return code of EFI_SUCCESS, the size\r
                                      in bytes of the data returned in RNGAlgorithmList. On output\r
                                      with a return code of EFI_BUFFER_TOO_SMALL,\r
                                      the size of RNGAlgorithmList required to obtain the list.\r
  @param[out] RNGAlgorithmList        A caller-allocated memory buffer filled by the driver\r
                                      with one EFI_RNG_ALGORITHM element for each supported\r
                                      RNG algorithm. The list must not change across multiple\r
                                      calls to the same driver. The first algorithm in the list\r
                                      is the default algorithm for the driver.\r
\r
  @retval EFI_SUCCESS                 The RNG algorithm list was returned successfully.\r
  @retval EFI_BUFFER_TOO_SMALL        The buffer RNGAlgorithmList is too small to hold the result.\r
\r
**/\r
UINTN\r
EFIAPI\r
ArchGetSupportedRngAlgorithms (\r
  IN OUT UINTN              *RNGAlgorithmListSize,\r
  OUT    EFI_RNG_ALGORITHM  *RNGAlgorithmList\r
  );\r
\r
/**\r
  Runs CPU RNG instruction 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
RngGetBytes (\r
  IN UINTN   Length,\r
  OUT UINT8  *RandBuffer\r
  );\r
\r
#endif // RNGDXE_INTERNALS_H_\r