MdeModulePkg: Align RuntimeDxe function headers with UEFI return values

RuntimeDxe is used to back the runtime services time functions,
so align the description of the function return values with the
defined values for these services as described in UEFI Spec 2.10.

REF: UEFI spec 2.10 section 8 Services ? Runtime Services

Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Signed-off-by: Suqiang Ren <suqiangx.ren@intel.com>
Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>

1 files changed, 31 insertions, 9 deletions

diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
index 3c360481f4..d394d237a5 100644
--- a/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
+++ b/MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
@@ -2385,10 +2385,19 @@ Done:
   @param Data                       The buffer to return the contents of the variable. May be NULL

                                     with a zero DataSize in order to determine the size buffer needed.

 

-  @return EFI_INVALID_PARAMETER     Invalid parameter.

-  @return EFI_SUCCESS               Find the specified variable.

-  @return EFI_NOT_FOUND             Not found.

-  @return EFI_BUFFER_TO_SMALL       DataSize is too small for the result.

+  @retval EFI_SUCCESS               The function completed successfully.

+  @retval EFI_NOT_FOUND             The variable was not found.

+  @retval EFI_BUFFER_TOO_SMALL      The DataSize is too small for the result.

+  @retval EFI_INVALID_PARAMETER     VariableName is NULL.

+  @retval EFI_INVALID_PARAMETER     VendorGuid is NULL.

+  @retval EFI_INVALID_PARAMETER     DataSize is NULL.

+  @retval EFI_INVALID_PARAMETER     The DataSize is not too small and Data is NULL.

+  @retval EFI_DEVICE_ERROR          The variable could not be retrieved due to a hardware error.

+  @retval EFI_SECURITY_VIOLATION    The variable could not be retrieved due to an authentication failure.

+  @retval EFI_UNSUPPORTED           After ExitBootServices() has been called, this return code may be returned

+                                    if no variable storage is supported. The platform should describe this

+                                    runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE

+                                    configuration table.

 

 **/

 EFI_STATUS

@@ -2479,6 +2488,11 @@ Done:
                                     GUID of an existing variable.

   @retval EFI_INVALID_PARAMETER     Null-terminator is not found in the first VariableNameSize bytes of

                                     the input VariableName buffer.

+  @retval EFI_DEVICE_ERROR          The variable could not be retrieved due to a hardware error.

+  @retval EFI_UNSUPPORTED           After ExitBootServices() has been called, this return code may be returned

+                                    if no variable storage is supported. The platform should describe this

+                                    runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE

+                                    configuration table.

 

 **/

 EFI_STATUS

@@ -2576,11 +2590,19 @@ VariableServiceGetNextVariableName (
                                           data, this value contains the required size.

   @param Data                             Data pointer.

 

-  @return EFI_INVALID_PARAMETER           Invalid parameter.

-  @return EFI_SUCCESS                     Set successfully.

-  @return EFI_OUT_OF_RESOURCES            Resource not enough to set variable.

-  @return EFI_NOT_FOUND                   Not found.

-  @return EFI_WRITE_PROTECTED             Variable is read-only.

+  @retval EFI_SUCCESS                     The function completed successfully.

+  @retval EFI_NOT_FOUND                   The variable was not found.

+  @retval EFI_BUFFER_TOO_SMALL            The DataSize is too small for the result.

+  @retval EFI_INVALID_PARAMETER           VariableName is NULL.

+  @retval EFI_INVALID_PARAMETER           VendorGuid is NULL.

+  @retval EFI_INVALID_PARAMETER           DataSize is NULL.

+  @retval EFI_INVALID_PARAMETER           The DataSize is not too small and Data is NULL.

+  @retval EFI_DEVICE_ERROR                The variable could not be retrieved due to a hardware error.

+  @retval EFI_SECURITY_VIOLATION          The variable could not be retrieved due to an authentication failure.

+  @retval EFI_UNSUPPORTED                 After ExitBootServices() has been called, this return code may be returned

+                                          if no variable storage is supported. The platform should describe this

+                                          runtime service as unsupported at runtime via an EFI_RT_PROPERTIES_TABLE

+                                          configuration table.

 

 **/

 EFI_STATUS