EmbeddedPkg: Align RealTimeClock function headers with return values

RealTimeClock 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: Leif Lindholm <quic_llindhol@quicinc.com>
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Abner Chang <abner.chang@amd.com>
Signed-off-by: Suqiang Ren <suqiangx.ren@intel.com>
Reviewed-by: Abner Chang <abner.chang@amd.com>
Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>

2 files changed, 30 insertions, 4 deletions

diff --git a/EmbeddedPkg/Include/Library/RealTimeClockLib.h b/EmbeddedPkg/Include/Library/RealTimeClockLib.h
index b2ff3f233b..6c034513f5 100644
--- a/EmbeddedPkg/Include/Library/RealTimeClockLib.h
+++ b/EmbeddedPkg/Include/Library/RealTimeClockLib.h
@@ -23,6 +23,9 @@
   @retval EFI_SUCCESS           The operation completed successfully.

   @retval EFI_INVALID_PARAMETER Time is NULL.

   @retval EFI_DEVICE_ERROR      The time could not be retrieved due to hardware error.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -40,6 +43,9 @@ LibGetTime (
   @retval EFI_SUCCESS           The operation completed successfully.

   @retval EFI_INVALID_PARAMETER A time field is out of range.

   @retval EFI_DEVICE_ERROR      The time could not be set due to hardware error.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -56,8 +62,13 @@ LibSetTime (
   @param  Time                  The current alarm setting.

 

   @retval EFI_SUCCESS           The alarm settings were returned.

-  @retval EFI_INVALID_PARAMETER Any parameter is NULL.

+  @retval EFI_INVALID_PARAMETER Enabled is NULL.

+  @retval EFI_INVALID_PARAMETER Pending is NULL.

+  @retval EFI_INVALID_PARAMETER Time is NULL.

   @retval EFI_DEVICE_ERROR      The wakeup time could not be retrieved due to a hardware error.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -76,9 +87,13 @@ LibGetWakeupTime (
 

   @retval EFI_SUCCESS           If Enable is TRUE, then the wakeup alarm was enabled. If

                                 Enable is FALSE, then the wakeup alarm was disabled.

-  @retval EFI_INVALID_PARAMETER A time field is out of range.

+  @retval EFI_INVALID_PARAMETER Enabled is NULL.

+  @retval EFI_INVALID_PARAMETER Pending is NULL.

+  @retval EFI_INVALID_PARAMETER Time is NULL.

   @retval EFI_DEVICE_ERROR      The wakeup time could not be set due to a hardware error.

-  @retval EFI_UNSUPPORTED       A wakeup timer is not supported on this platform.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

diff --git a/EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClock.c b/EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClock.c
index 17dde432c4..0b2e4d1fcc 100644
--- a/EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClock.c
+++ b/EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClock.c
@@ -44,6 +44,9 @@ STATIC NON_VOLATILE_TIME_SETTINGS  mTimeSettings;
   @retval EFI_SUCCESS           The operation completed successfully.

   @retval EFI_INVALID_PARAMETER Time is NULL.

   @retval EFI_DEVICE_ERROR      The time could not be retrieved due to hardware error.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -75,6 +78,9 @@ GetTime (
   @retval EFI_SUCCESS           The operation completed successfully.

   @retval EFI_INVALID_PARAMETER A time field is out of range.

   @retval EFI_DEVICE_ERROR      The time could not be set due to hardware error.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -132,6 +138,9 @@ SetTime (
   @retval EFI_SUCCESS           The alarm settings were returned.

   @retval EFI_INVALID_PARAMETER Any parameter is NULL.

   @retval EFI_DEVICE_ERROR      The wakeup time could not be retrieved due to a hardware error.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS

@@ -166,7 +175,9 @@ GetWakeupTime (
                                 Enable is FALSE, then the wakeup alarm was disabled.

   @retval EFI_INVALID_PARAMETER A time field is out of range.

   @retval EFI_DEVICE_ERROR      The wakeup time could not be set due to a hardware error.

-  @retval EFI_UNSUPPORTED       A wakeup timer is not supported on this platform.

+  @retval EFI_UNSUPPORTED       This call is not supported by this platform at the time the call is made.

+                                The platform should describe this runtime service as unsupported at runtime

+                                via an EFI_RT_PROPERTIES_TABLE configuration table.

 

 **/

 EFI_STATUS