Re: [edk2-devel] [PATCH V3 5/5] OvmfPkg: Align XenRealTimeClockLib function headers with return values

["Laszlo Ersek" <lersek@redhat.com>]

CC Anthony

On 2/2/24 09:20, Suqiang Ren wrote:
> XenRealTimeClockLib 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: Ard Biesheuvel <ardb+tianocore@kernel.org>
> Cc: Jiewen Yao <jiewen.yao@intel.com>
> Cc: Laszlo Ersek <lersek@redhat.com>
> ---
>  .../XenRealTimeClockLib/XenRealTimeClockLib.c | 22 +++++++++++++++----
>  1 file changed, 18 insertions(+), 4 deletions(-)
> 
> diff --git a/OvmfPkg/Library/XenRealTimeClockLib/XenRealTimeClockLib.c b/OvmfPkg/Library/XenRealTimeClockLib/XenRealTimeClockLib.c
> index 30c258313135..6d7f452a7550 100644
> --- a/OvmfPkg/Library/XenRealTimeClockLib/XenRealTimeClockLib.c
> +++ b/OvmfPkg/Library/XenRealTimeClockLib/XenRealTimeClockLib.c
> @@ -80,6 +80,9 @@ EpochToEfiTime (
>    @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
> @@ -109,6 +112,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
> @@ -128,9 +134,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       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
> @@ -152,9 +162,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 (#115046): https://edk2.groups.io/g/devel/message/115046
Mute This Topic: https://groups.io/mt/104115882/7686176
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io]
-=-=-=-=-=-=-=-=-=-=-=-