#include <Protocol/Rng.h>

Functions
EFI_STATUS EFIAPI	GetAvailableAlgorithms (VOID)

VOID EFIAPI	FreeAvailableAlgorithms (VOID)

EFI_STATUS EFIAPI	RngGetInfo (IN EFI_RNG_PROTOCOL This, IN OUT UINTN RNGAlgorithmListSize, OUT EFI_RNG_ALGORITHM *RNGAlgorithmList)

EFI_STATUS EFIAPI	RngGetRNG (IN EFI_RNG_PROTOCOL This, IN EFI_RNG_ALGORITHM RNGAlgorithm OPTIONAL, IN UINTN RNGValueLength, OUT UINT8 *RNGValue)

EFI_STATUS EFIAPI	RngGetBytes (IN UINTN Length, OUT UINT8 *RandBuffer)

EFI_STATUS EFIAPI	GenerateEntropy (IN UINTN Length, OUT UINT8 *Entropy)

Variables
UINTN	mAvailableAlgoArrayCount

EFI_RNG_ALGORITHM *	mAvailableAlgoArray

Detailed Description

Function prototypes for UEFI Random Number Generator protocol support.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file RngDxeInternals.h.

Function Documentation

◆ FreeAvailableAlgorithms()

VOID EFIAPI FreeAvailableAlgorithms ( VOID )

Free mAvailableAlgoArray.

Definition at line 39 of file ArmRngDxe.c.

◆ GenerateEntropy()

EFI_STATUS EFIAPI GenerateEntropy	(	IN UINTN	Length,
		OUT UINT8 *	Entropy
	)

Generate high-quality entropy source using a TRNG or through RDRAND.

Parameters

[in]	Length	Size of the buffer, in bytes, to fill with.
[out]	Entropy	Pointer to the buffer to store the entropy data.

Return values

EFI_SUCCESS	Entropy generation succeeded.
EFI_NOT_READY	Failed to request random data.

Generate high-quality entropy source using a TRNG or through RDRAND.

Parameters

[in]	Length	Size of the buffer, in bytes, to fill with.
[out]	Entropy	Pointer to the buffer to store the entropy data.

Return values

RETURN_SUCCESS	The function completed successfully.
RETURN_INVALID_PARAMETER	Invalid parameter.
RETURN_UNSUPPORTED	Function not implemented.
RETURN_BAD_BUFFER_SIZE	Buffer size is too small.
RETURN_NOT_READY	No Entropy available.

Generate high-quality entropy source through RDRAND.

Parameters

[in]	Length	Size of the buffer, in bytes, to fill with.
[out]	Entropy	Pointer to the buffer to store the entropy data.

Return values

EFI_SUCCESS	Entropy generation succeeded.
EFI_NOT_READY	Failed to request random data.

Definition at line 35 of file ArmTrng.c.

◆ GetAvailableAlgorithms()

EFI_STATUS EFIAPI GetAvailableAlgorithms ( VOID )

Allocate and initialize mAvailableAlgoArray with the available Rng algorithms. Also update mAvailableAlgoArrayCount.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_OUT_OF_RESOURCES	Could not allocate memory.

Definition at line 29 of file AArch64Algo.c.

◆ RngGetBytes()

EFI_STATUS EFIAPI RngGetBytes	(	IN UINTN	Length,
		OUT UINT8 *	RandBuffer
	)

Runs CPU RNG instruction to fill a buffer of arbitrary size with random bytes.

Parameters

[in]	Length	Size of the buffer, in bytes, to fill with.
[out]	RandBuffer	Pointer to the buffer to store the random result.

Return values

EFI_SUCCESS	Random bytes generation succeeded.
EFI_NOT_READY	Failed to request random bytes.

Definition at line 132 of file RngDxe.c.

◆ RngGetInfo()

EFI_STATUS EFIAPI RngGetInfo	(	IN EFI_RNG_PROTOCOL *	This,
		IN OUT UINTN *	RNGAlgorithmListSize,
		OUT EFI_RNG_ALGORITHM *	RNGAlgorithmList
	)

Returns information about the random number generation implementation.

Parameters

[in]	This	A pointer to the EFI_RNG_PROTOCOL instance.
[in,out]	RNGAlgorithmListSize	On input, the size in bytes of RNGAlgorithmList. On output with a return code of EFI_SUCCESS, the size in bytes of the data returned in RNGAlgorithmList. On output with a return code of EFI_BUFFER_TOO_SMALL, the size of RNGAlgorithmList required to obtain the list.
[out]	RNGAlgorithmList	A caller-allocated memory buffer filled by the driver with one EFI_RNG_ALGORITHM element for each supported RNG algorithm. The list must not change across multiple calls to the same driver. The first algorithm in the list is the default algorithm for the driver.

Return values

EFI_SUCCESS	The RNG algorithm list was returned successfully.
EFI_UNSUPPORTED	The services is not supported by this driver.
EFI_DEVICE_ERROR	The list of algorithms could not be retrieved due to a hardware or firmware error.
EFI_INVALID_PARAMETER	One or more of the parameters are incorrect.
EFI_BUFFER_TOO_SMALL	The buffer RNGAlgorithmList is too small to hold the result.

Returns information about the random number generation implementation.

Parameters

[in]	This	A pointer to the EFI_RNG_PROTOCOL instance.
[in,out]	RNGAlgorithmListSize	On input, the size in bytes of RNGAlgorithmList. On output with a return code of EFI_SUCCESS, the size in bytes of the data returned in RNGAlgorithmList. On output with a return code of EFI_BUFFER_TOO_SMALL, the size of RNGAlgorithmList required to obtain the list.
[out]	RNGAlgorithmList	A caller-allocated memory buffer filled by the driver with one EFI_RNG_ALGORITHM element for each supported RNG algorithm. The list must not change across multiple calls to the same driver. The first algorithm in the list is the default algorithm for the driver.

Return values

EFI_SUCCESS	The RNG algorithm list was returned successfully.
EFI_UNSUPPORTED	No supported algorithms found.
EFI_DEVICE_ERROR	The list of algorithms could not be retrieved due to a hardware or firmware error.
EFI_INVALID_PARAMETER	One or more of the parameters are incorrect.
EFI_BUFFER_TOO_SMALL	The buffer RNGAlgorithmList is too small to hold the result.

Definition at line 141 of file ArmRngDxe.c.

◆ RngGetRNG()

EFI_STATUS EFIAPI RngGetRNG	(	IN EFI_RNG_PROTOCOL *	This,
		IN EFI_RNG_ALGORITHM *RNGAlgorithm	OPTIONAL,
		IN UINTN	RNGValueLength,
		OUT UINT8 *	RNGValue
	)

Produces and returns an RNG value using either the default or specified RNG algorithm.

Parameters

[in]	This	A pointer to the EFI_RNG_PROTOCOL instance.
[in]	RNGAlgorithm	A pointer to the EFI_RNG_ALGORITHM that identifies the RNG algorithm to use. May be NULL in which case the function will use its default RNG algorithm.
[in]	RNGValueLength	The length in bytes of the memory buffer pointed to by RNGValue. The driver shall return exactly this numbers of bytes.
[out]	RNGValue	A caller-allocated memory buffer filled by the driver with the resulting RNG value.

Return values

EFI_SUCCESS	The RNG value was returned successfully.
EFI_UNSUPPORTED	The algorithm specified by RNGAlgorithm is not supported by this driver.
EFI_DEVICE_ERROR	An RNG value could not be retrieved due to a hardware or firmware error.
EFI_NOT_READY	There is not enough random data available to satisfy the length requested by RNGValueLength.
EFI_INVALID_PARAMETER	RNGValue is NULL or RNGValueLength is zero.

Definition at line 72 of file ArmRngDxe.c.

Variable Documentation

◆ mAvailableAlgoArray

EFI_RNG_ALGORITHM* mAvailableAlgoArray

extern

Definition at line 35 of file RngDxe.c.

◆ mAvailableAlgoArrayCount

UINTN mAvailableAlgoArrayCount

extern

Definition at line 34 of file RngDxe.c.

Functions

Variables

Detailed Description

Function Documentation

◆ FreeAvailableAlgorithms()

◆ GenerateEntropy()

◆ GetAvailableAlgorithms()

◆ RngGetBytes()

◆ RngGetInfo()

◆ RngGetRNG()

Variable Documentation

◆ mAvailableAlgoArray

◆ mAvailableAlgoArrayCount