SecurityPkg/RngDxe: Remove ArchGetSupportedRngAlgorithms()

RngGetInfo() is one of the 2 functions of the EFI_RNG_PROTOCOL.
RngGetInfo() is currently a mere wrapper around
ArchGetSupportedRngAlgorithms() which is implemented differently
depending on the architecture used.

RngGetInfo() does nothing more than calling
ArchGetSupportedRngAlgorithms(). So remove it, and let RngGetInfo()
be implemented differently according to the architecture.

This follows the implementation of the other function of the
EFI_RNG_PROTOCOL, RngGetRNG().

Signed-off-by: Pierre Gondois <pierre.gondois@arm.com>
Acked-by: Jiewen Yao <jiewen.yao@intel.com>

4 files changed, 33 insertions, 82 deletions

diff --git a/SecurityPkg/RandomNumberGenerator/RngDxe/AArch64/RngDxe.c b/SecurityPkg/RandomNumberGenerator/RngDxe/AArch64/RngDxe.c
index 3daf847d46..6d989f7ea3 100644
--- a/SecurityPkg/RandomNumberGenerator/RngDxe/AArch64/RngDxe.c
+++ b/SecurityPkg/RandomNumberGenerator/RngDxe/AArch64/RngDxe.c
@@ -14,6 +14,7 @@
   Copyright (c) 2021, NUVIA Inc. All rights reserved.<BR>

   Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>

   (C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR>

+  Copyright (c) 2021 - 2022, Arm Limited. All rights reserved.<BR>

 

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

 

@@ -85,6 +86,7 @@ RngGetRNG (
 /**

   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

@@ -97,14 +99,19 @@ RngGetRNG (
                                       is the default algorithm for the driver.

 

   @retval EFI_SUCCESS                 The RNG algorithm list was returned successfully.

+  @retval EFI_UNSUPPORTED             The services is not supported by this driver.

+  @retval EFI_DEVICE_ERROR            The list of algorithms could not be retrieved due to a

+                                      hardware or firmware error.

+  @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.

 

 **/

-UINTN

+EFI_STATUS

 EFIAPI

-ArchGetSupportedRngAlgorithms (

-  IN OUT UINTN              *RNGAlgorithmListSize,

-  OUT    EFI_RNG_ALGORITHM  *RNGAlgorithmList

+RngGetInfo (

+  IN EFI_RNG_PROTOCOL    *This,

+  IN OUT UINTN           *RNGAlgorithmListSize,

+  OUT EFI_RNG_ALGORITHM  *RNGAlgorithmList

   )

 {

   UINTN              RequiredSize;

@@ -112,6 +119,10 @@ ArchGetSupportedRngAlgorithms (
 

   RequiredSize = sizeof (EFI_RNG_ALGORITHM);

 

+  if ((This == NULL) || (RNGAlgorithmListSize == NULL)) {

+    return EFI_INVALID_PARAMETER;

+  }

+

   if (*RNGAlgorithmListSize < RequiredSize) {

     *RNGAlgorithmListSize = RequiredSize;

     return EFI_BUFFER_TOO_SMALL;

diff --git a/SecurityPkg/RandomNumberGenerator/RngDxe/Rand/RngDxe.c b/SecurityPkg/RandomNumberGenerator/RngDxe/Rand/RngDxe.c
index df7db12b77..b2d2236380 100644
--- a/SecurityPkg/RandomNumberGenerator/RngDxe/Rand/RngDxe.c
+++ b/SecurityPkg/RandomNumberGenerator/RngDxe/Rand/RngDxe.c
@@ -104,6 +104,7 @@ RngGetRNG (
 /**

   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

@@ -116,18 +117,27 @@ RngGetRNG (
                                       is the default algorithm for the driver.

 

   @retval EFI_SUCCESS                 The RNG algorithm list was returned successfully.

+  @retval EFI_UNSUPPORTED             No supported algorithms found.

+  @retval EFI_DEVICE_ERROR            The list of algorithms could not be retrieved due to a

+                                      hardware or firmware error.

+  @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.

 

 **/

-UINTN

+EFI_STATUS

 EFIAPI

-ArchGetSupportedRngAlgorithms (

-  IN OUT UINTN              *RNGAlgorithmListSize,

-  OUT    EFI_RNG_ALGORITHM  *RNGAlgorithmList

+RngGetInfo (

+  IN EFI_RNG_PROTOCOL    *This,

+  IN OUT UINTN           *RNGAlgorithmListSize,

+  OUT EFI_RNG_ALGORITHM  *RNGAlgorithmList

   )

 {

   UINTN  RequiredSize;

 

+  if ((This == NULL) || (RNGAlgorithmListSize == NULL)) {

+    return EFI_INVALID_PARAMETER;

+  }

+

   RequiredSize = 2 * sizeof (EFI_RNG_ALGORITHM);

 

   if (*RNGAlgorithmListSize < RequiredSize) {

@@ -135,6 +145,10 @@ ArchGetSupportedRngAlgorithms (
     return EFI_BUFFER_TOO_SMALL;

   }

 

+  if (RNGAlgorithmList == NULL) {

+    return EFI_INVALID_PARAMETER;

+  }

+

   CopyMem (&RNGAlgorithmList[0], &gEfiRngAlgorithmSp80090Ctr256Guid, sizeof (EFI_RNG_ALGORITHM));

 

   // x86 platforms also support EFI_RNG_ALGORITHM_RAW via RDSEED

diff --git a/SecurityPkg/RandomNumberGenerator/RngDxe/RngDxe.c b/SecurityPkg/RandomNumberGenerator/RngDxe/RngDxe.c
index 6f52eeff4a..6608ca8804 100644
--- a/SecurityPkg/RandomNumberGenerator/RngDxe/RngDxe.c
+++ b/SecurityPkg/RandomNumberGenerator/RngDxe/RngDxe.c
@@ -28,55 +28,6 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
 

 #include "RngDxeInternals.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_UNSUPPORTED             The services is not supported by this driver.

-  @retval EFI_DEVICE_ERROR            The list of algorithms could not be retrieved due to a

-                                      hardware or firmware error.

-  @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

-  )

-{

-  EFI_STATUS  Status;

-

-  if ((This == NULL) || (RNGAlgorithmListSize == NULL)) {

-    return EFI_INVALID_PARAMETER;

-  }

-

-  //

-  // Return algorithm list supported by driver.

-  //

-  if (RNGAlgorithmList != NULL) {

-    Status = ArchGetSupportedRngAlgorithms (RNGAlgorithmListSize, RNGAlgorithmList);

-  } else {

-    Status = EFI_INVALID_PARAMETER;

-  }

-

-  return Status;

-}

-

 //

 // The Random Number Generator (RNG) protocol

 //

diff --git a/SecurityPkg/RandomNumberGenerator/RngDxe/RngDxeInternals.h b/SecurityPkg/RandomNumberGenerator/RngDxe/RngDxeInternals.h
index 48d2d27c16..7ecab14048 100644
--- a/SecurityPkg/RandomNumberGenerator/RngDxe/RngDxeInternals.h
+++ b/SecurityPkg/RandomNumberGenerator/RngDxe/RngDxeInternals.h
@@ -75,31 +75,6 @@ RngGetRNG (
   );

 

 /**

-  Returns information about the random number generation implementation.

-

-  @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_BUFFER_TOO_SMALL        The buffer RNGAlgorithmList is too small to hold the result.

-

-**/

-UINTN

-EFIAPI

-ArchGetSupportedRngAlgorithms (

-  IN OUT UINTN              *RNGAlgorithmListSize,

-  OUT    EFI_RNG_ALGORITHM  *RNGAlgorithmList

-  );

-

-/**

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

 

   @param[in]   Length        Size of the buffer, in bytes,  to fill with.