Re: [edk2-devel] [PATCH V3 4/5] ArmPlatformPkg: Align PL031 library function headers with return values

["Leif Lindholm" <quic_llindhol@quicinc.com>]

On 2024-02-02 08:20, Suqiang Ren wrote:
> RealTimeClockLib 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
> 
> Signed-off-by: Suqiang Ren <suqiangx.ren@intel.com>
> Cc: Leif Lindholm <quic_llindhol@quicinc.com>
> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>

Reviewed-by: Leif Lindholm <quic_llindhol@quicinc.com>

/
     Leif

> ---
>   .../PL031RealTimeClockLib.c                   | 22 +++++++++++++++----
>   1 file changed, 18 insertions(+), 4 deletions(-)
> 
> diff --git a/ArmPlatformPkg/Library/PL031RealTimeClockLib/PL031RealTimeClockLib.c b/ArmPlatformPkg/Library/PL031RealTimeClockLib/PL031RealTimeClockLib.c
> index 1896f9d16d3b..6ab3e9948335 100644
> --- a/ArmPlatformPkg/Library/PL031RealTimeClockLib/PL031RealTimeClockLib.c
> +++ b/ArmPlatformPkg/Library/PL031RealTimeClockLib/PL031RealTimeClockLib.c
> @@ -111,7 +111,9 @@ EXIT:
>     @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_SECURITY_VIOLATION The time could not be retrieved due to an authentication failure.
> +  @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
> @@ -172,6 +174,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
> @@ -224,8 +229,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
> @@ -248,9 +258,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



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#115049): https://edk2.groups.io/g/devel/message/115049
Mute This Topic: https://groups.io/mt/104115880/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-