Skip to content

Fix incorrect documentation for EFI_RNG_GET_RNG #4048

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Josh Triplett (joshtriplett) wants to merge 1 commit into
base: staging
Choose a base branch
from
Open

Fix incorrect documentation for EFI_RNG_GET_RNG #4048

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions windows-driver-docs-pr/bringup/efi-rng-protocol-getrng.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,10 @@ typedef EFI_STATUS (EFIAPI *EFI_RNG_GET_RNG) (
[in] A pointer to the EFI_RNG_ALGORITHM which identifies the RNG algorithm to use. If this parameter is NULL, the default algorithm supported by the driver will be used.

*RNGValueLength*
[in] The length, in bytes, of the buffer returned by *RNGValue*.
[in] The length, in bytes, of the buffer pointed to by *RNGValue*. The driver shall return exactly this many bytes.

*RNGValue*
[in] Pointer to a buffer that will contain the RNG value. The value is allocated by this function using EFI_BOOT_SERVICES->AllocatePool(), and it is the caller's responsibility to free this memory by using EFI_BOOT_SERVICES->FreePool().

## Remarks

The minimum size of *RNGValue* is 32 bytes.
[out] Pointer to a buffer to fill with random bytes.

## Return value

Expand All @@ -45,11 +41,10 @@ Returns one of the following status codes.
| Status code | Description |
|--|--|
| EFI_SUCCESS | The function successfully returned an RNG value. |
| EFI_INVALID_PARAMETER | *RNGAlgorithm* is NULL when several algorithms are possible. |
| EFI_UNSUPPORTED | The algorithm specified by *RNGAlgorithm* is not supported by this driver. |
| EFI_DEVICE_ERROR | An RNG value could not be retrieved because of a hardware or firmware error. |
| EFI_NOT_READY | There is not enough entropy data available. |
| EFI_OUT_OF_RESOURCES | The driver is unable to allocate memory for the RNG value. |
| EFI_INVALID_PARAMETER | *RNGValue* is null or *RNGValueLength* is zero. |

## Requirements

Expand Down