On Wed, May 26, 2021 at 17:07:11 +0700, Nhi Pham wrote:
> From: Vu Nguyen <vungu...@os.amperecomputing.com>
>
> This change is to produce RNG protocol which is required by several
> modules.
>
> Cc: Thang Nguyen <th...@os.amperecomputing.com>
> Cc: Chuong Tran <chu...@os.amperecomputing.com>
> Cc: Phong Vo <ph...@os.amperecomputing.com>
> Cc: Leif Lindholm <l...@nuviainc.com>
> Cc: Michael D Kinney <michael.d.kin...@intel.com>
> Cc: Ard Biesheuvel <ardb+tianoc...@kernel.org>
> Cc: Nate DeSimone <nathaniel.l.desim...@intel.com>
>
> Signed-off-by: Vu Nguyen <vungu...@os.amperecomputing.com>
> ---
> Silicon/Ampere/AmpereAltraPkg/AmpereAltraPkg.dsc.inc | 5 +
> Platform/Ampere/JadePkg/Jade.fdf | 5 +
> Silicon/Ampere/AmpereAltraPkg/Drivers/RngDxe/RngDxe.inf | 43 +++++
> Silicon/Ampere/AmpereAltraPkg/Drivers/RngDxe/RngDxe.c | 164
> ++++++++++++++++++++
> Silicon/Ampere/AmpereAltraPkg/Drivers/RngDxe/RngDxe.uni | 10 ++
> Silicon/Ampere/AmpereAltraPkg/Drivers/RngDxe/RngDxeExtra.uni | 9 ++
> 6 files changed, 236 insertions(+)
>
> diff --git a/Silicon/Ampere/AmpereAltraPkg/AmpereAltraPkg.dsc.inc
> b/Silicon/Ampere/AmpereAltraPkg/AmpereAltraPkg.dsc.inc
> index 33f5fe7af544..930bbb5d385b 100755
> --- a/Silicon/Ampere/AmpereAltraPkg/AmpereAltraPkg.dsc.inc
> +++ b/Silicon/Ampere/AmpereAltraPkg/AmpereAltraPkg.dsc.inc
> @@ -682,6 +682,11 @@ [Components.common]
> MdeModulePkg/Bus/Pci/PciBusDxe/PciBusDxe.inf
> Silicon/Ampere/AmpereAltraPkg/Bus/Pci/PciHostBridgeDxe/PciHostBridgeDxe.inf
>
> + #
> + # Random Number Generator Support
> + #
> + Silicon/Ampere/AmpereAltraPkg/Drivers/RngDxe/RngDxe.inf
> +
> #
> # Bds
> #
> diff --git a/Platform/Ampere/JadePkg/Jade.fdf
> b/Platform/Ampere/JadePkg/Jade.fdf
> index 6820a197568b..ef24e6f1f8e0 100755
> --- a/Platform/Ampere/JadePkg/Jade.fdf
> +++ b/Platform/Ampere/JadePkg/Jade.fdf
> @@ -304,6 +304,11 @@ [FV.FvMain]
> #
> INF Drivers/ASpeed/ASpeedGopBinPkg/ASpeedAst2500GopDxe.inf
>
> + #
> + # Random Number Generator Support
> + #
> + INF Silicon/Ampere/AmpereAltraPkg/Drivers/RngDxe/RngDxe.inf
> +
> #
> # UEFI application (Shell Embedded Boot Loader)
> #
> diff --git a/Silicon/Ampere/AmpereAltraPkg/Drivers/RngDxe/RngDxe.inf
> b/Silicon/Ampere/AmpereAltraPkg/Drivers/RngDxe/RngDxe.inf
> new file mode 100644
> index 000000000000..d3d2c20436a0
> --- /dev/null
> +++ b/Silicon/Ampere/AmpereAltraPkg/Drivers/RngDxe/RngDxe.inf
> @@ -0,0 +1,43 @@
> +## @file
> +#
> +# Copyright (c) 2021, Ampere Computing LLC. All rights reserved.<BR>
> +#
> +# SPDX-License-Identifier: BSD-2-Clause-Patent
> +#
> +##
> +
> +[Defines]
> + INF_VERSION = 0x0001001B
> + BASE_NAME = RngDxe
> + FILE_GUID = 4FCC006E-C740-4027-BC97-787907C8D286
> + MODULE_TYPE = DXE_DRIVER
> + VERSION_STRING = 1.0
> + ENTRY_POINT = RngDriverEntry
> + MODULE_UNI_FILE = RngDxe.uni
> +
> +[Sources.common]
> + RngDxe.c
> +
> +[Packages]
> + MdePkg/MdePkg.dec
> + Silicon/Ampere/AmpereAltraPkg/AmpereAltraPkg.dec
> +
> +[LibraryClasses]
> + BaseLib
> + DebugLib
> + TrngLib
> + UefiBootServicesTableLib
> + UefiDriverEntryPoint
> + UefiLib
> +
> +[Guids]
> + gEfiRngAlgorithmRaw ## SOMETIMES_PRODUCES ## GUID
> # Unique ID of the algorithm for RNG
> +
> +[Protocols]
> + gEfiRngProtocolGuid ## PRODUCES
> +
> +[UserExtensions.TianoCore."ExtraFiles"]
> + RngDxeExtra.uni
> +
> +[Depex]
> + TRUE
> diff --git a/Silicon/Ampere/AmpereAltraPkg/Drivers/RngDxe/RngDxe.c
> b/Silicon/Ampere/AmpereAltraPkg/Drivers/RngDxe/RngDxe.c
> new file mode 100644
> index 000000000000..bb8140cfeb2f
> --- /dev/null
> +++ b/Silicon/Ampere/AmpereAltraPkg/Drivers/RngDxe/RngDxe.c
> @@ -0,0 +1,164 @@
> +/** @file
> +
> + Copyright (c) 2021, Ampere Computing LLC. All rights reserved.<BR>
> +
> + SPDX-License-Identifier: BSD-2-Clause-Patent
> +
> +**/
> +
> +#include <Uefi.h>
> +
> +#include <Library/BaseLib.h>
> +#include <Library/BaseMemoryLib.h>
> +#include <Library/DebugLib.h>
> +#include <Library/TrngLib.h>
> +#include <Library/UefiBootServicesTableLib.h>
> +#include <Protocol/Rng.h>
> +
> +/**
> + Returns information about the random number generation implementation.
> +
> + @param[in] This A pointer to the EFI_RNG_PROTOCOL
> instance.
> + @param[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.
> + @param[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.
> +
> + @retval EFI_SUCCESS The RNG algorithm list was returned
> successfully.
> + @retval EFI_INVALID_PARAMETER One or more of the parameters are
> incorrect.
> + @retval EFI_BUFFER_TOO_SMALL The buffer RNGAlgorithmList is too
> small to hold the result.
> +
> +**/
> +EFI_STATUS
> +EFIAPI
> +RngGetInfo (
> + IN EFI_RNG_PROTOCOL *This,
> + IN OUT UINTN *RNGAlgorithmListSize,
> + OUT EFI_RNG_ALGORITHM *RNGAlgorithmList
> + )
> +{
> + if (This == NULL || RNGAlgorithmListSize == NULL) {
> + return EFI_INVALID_PARAMETER;
> + }
> +
> + if (*RNGAlgorithmListSize < sizeof (EFI_RNG_ALGORITHM)) {
> + *RNGAlgorithmListSize = sizeof (EFI_RNG_ALGORITHM);
> + return EFI_BUFFER_TOO_SMALL;
> + }
> +
> + if (RNGAlgorithmList == NULL) {
> + return EFI_INVALID_PARAMETER;
> + }
> +
> + *RNGAlgorithmListSize = sizeof (EFI_RNG_ALGORITHM);
> + CopyGuid (RNGAlgorithmList, &gEfiRngAlgorithmRaw);
> +
> + return EFI_SUCCESS;
> +}
> +
> +/**
> + Produces and returns an RNG value using either the default or specified
> RNG algorithm.
> +
> + @param[in] This A pointer to the EFI_RNG_PROTOCOL
> instance.
> + @param[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.
> + @param[in] RNGValueLength The length in bytes of the memory
> buffer pointed to by
> + RNGValue. The driver shall return
> exactly this numbers of bytes.
> + @param[out] RNGValue A caller-allocated memory buffer
> filled by the driver with the
> + resulting RNG value.
> +
> + @retval EFI_SUCCESS The RNG value was returned
> successfully.
> + @retval EFI_UNSUPPORTED The algorithm specified by
> RNGAlgorithm is not supported by
> + this driver.
> + @retval EFI_DEVICE_ERROR An RNG value could not be retrieved
> due to a hardware or
> + firmware error.
> + @retval EFI_INVALID_PARAMETER RNGValue is NULL or RNGValueLength is
> zero.
> +
> +**/
> +EFI_STATUS
> +EFIAPI
> +RngGetRNG (
> + IN EFI_RNG_PROTOCOL *This,
> + IN EFI_RNG_ALGORITHM *RNGAlgorithm, OPTIONAL
> + IN UINTN RNGValueLength,
> + OUT UINT8 *RNGValue
> + )
> +{
> + EFI_STATUS Status;
> +
> + if (This == NULL || RNGValueLength == 0 || RNGValue == NULL) {
> + return EFI_INVALID_PARAMETER;
> + }
> +
> + //
> + // We only support the raw algorithm, so reject requests for anything else
> + //
> + if (RNGAlgorithm != NULL &&
> + !CompareGuid (RNGAlgorithm, &gEfiRngAlgorithmRaw))
> + {
{ on preceding line.
With that:
Reviewed-by: Leif Lindholm <l...@nuviainc.com>
/
Leif
> + return EFI_UNSUPPORTED;
> + }
> +
> + Status = GenerateRandomNumbers (RNGValue, RNGValueLength);
> + if (EFI_ERROR (Status)) {
> + DEBUG ((
> + DEBUG_ERROR,
> + "%a:%d Failed to generate a random number. \n",
> + __FUNCTION__,
> + __LINE__
> + ));
> + return Status;
> + }
> +
> + return EFI_SUCCESS;
> +}
> +
> +/*
> + * The Random Number Generator (RNG) protocol
> + */
> +EFI_RNG_PROTOCOL mRng = {
> + RngGetInfo,
> + RngGetRNG
> +};
> +
> +/**
> + The user Entry Point for the Random Number Generator (RNG) driver.
> +
> + @param[in] ImageHandle The firmware allocated handle for the EFI image.
> + @param[in] SystemTable A pointer to the EFI System Table.
> +
> + @retval EFI_SUCCESS The entry point is executed successfully.
> + @retval EFI_NOT_SUPPORTED Platform does not support RNG.
> + @retval Other Some error occurs when executing this entry
> point.
> +
> +**/
> +EFI_STATUS
> +EFIAPI
> +RngDriverEntry (
> + IN EFI_HANDLE ImageHandle,
> + IN EFI_SYSTEM_TABLE *SystemTable
> + )
> +{
> + EFI_STATUS Status;
> + EFI_HANDLE Handle;
> +
> + //
> + // Install UEFI RNG (Random Number Generator) Protocol
> + //
> + Handle = NULL;
> + Status = gBS->InstallMultipleProtocolInterfaces (
> + &Handle,
> + &gEfiRngProtocolGuid,
> + &mRng,
> + NULL
> + );
> +
> + return Status;
> +}
> diff --git a/Silicon/Ampere/AmpereAltraPkg/Drivers/RngDxe/RngDxe.uni
> b/Silicon/Ampere/AmpereAltraPkg/Drivers/RngDxe/RngDxe.uni
> new file mode 100644
> index 000000000000..cd9dde97a236
> --- /dev/null
> +++ b/Silicon/Ampere/AmpereAltraPkg/Drivers/RngDxe/RngDxe.uni
> @@ -0,0 +1,10 @@
> +//
> +// Copyright (c) 2021, Ampere Computing LLC. All rights reserved.<BR>
> +//
> +// SPDX-License-Identifier: BSD-2-Clause-Patent
> +//
> +
> +
> +#string STR_MODULE_ABSTRACT #language en-US "Produces UEFI
> Random Number Generator protocol"
> +
> +#string STR_MODULE_DESCRIPTION #language en-US "This module will
> produce UEFI Random Number Generator protocol."
> diff --git a/Silicon/Ampere/AmpereAltraPkg/Drivers/RngDxe/RngDxeExtra.uni
> b/Silicon/Ampere/AmpereAltraPkg/Drivers/RngDxe/RngDxeExtra.uni
> new file mode 100644
> index 000000000000..9a3696b25442
> --- /dev/null
> +++ b/Silicon/Ampere/AmpereAltraPkg/Drivers/RngDxe/RngDxeExtra.uni
> @@ -0,0 +1,9 @@
> +//
> +// Copyright (c) 2021, Ampere Computing LLC. All rights reserved.<BR>
> +//
> +// SPDX-License-Identifier: BSD-2-Clause-Patent
> +//
> +
> +#string STR_PROPERTIES_MODULE_NAME
> +#language en-US
> +"Ampere UEFI Random Number Generator DXE"
> --
> 2.17.1
>
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#76196): https://edk2.groups.io/g/devel/message/76196
Mute This Topic: https://groups.io/mt/83097116/21656
Group Owner: devel+ow...@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com]
-=-=-=-=-=-=-=-=-=-=-=-
