RngLib.h File Reference

Go to the source code of this file.

Functions
BOOLEAN EFIAPI	GetRandomNumber16 (OUT UINT16 *Rand)
BOOLEAN EFIAPI	GetRandomNumber32 (OUT UINT32 *Rand)
BOOLEAN EFIAPI	GetRandomNumber64 (OUT UINT64 *Rand)
BOOLEAN EFIAPI	GetRandomNumber128 (OUT UINT64 *Rand)

Detailed Description

Provides random number generator services.

Copyright (c) 2015, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Function Documentation

GetRandomNumber128()

BOOLEAN EFIAPI GetRandomNumber128

(

OUT UINT64 *

Rand

)

Generates a 128-bit random number.

if Rand is NULL, then ASSERT().

Parameters

[out]

Rand

Buffer pointer to store the 128-bit random value.

Return values

TRUE	Random number generated successfully.
FALSE	Failed to generate the random number.

GetRandomNumber16()

BOOLEAN EFIAPI GetRandomNumber16

(

OUT UINT16 *

Rand

)

Generates a 16-bit random number.

if Rand is NULL, then ASSERT().

Parameters

[out]

Rand

Buffer pointer to store the 16-bit random value.

Return values

TRUE	Random number generated successfully.
FALSE	Failed to generate the random number.

GetRandomNumber32()

BOOLEAN EFIAPI GetRandomNumber32

(

OUT UINT32 *

Rand

)

Generates a 32-bit random number.

if Rand is NULL, then ASSERT().

Parameters

[out]

Rand

Buffer pointer to store the 32-bit random value.

Return values

TRUE	Random number generated successfully.
FALSE	Failed to generate the random number.

GetRandomNumber64()

BOOLEAN EFIAPI GetRandomNumber64

(

OUT UINT64 *

Rand

)

Generates a 64-bit random number.

if Rand is NULL, then ASSERT().

Parameters

[out]

Rand

Buffer pointer to store the 64-bit random value.

Return values

TRUE	Random number generated successfully.
FALSE	Failed to generate the random number.