Re: [edk2-devel] [PATCH V3 3/5] EmbeddedPkg: Align RealTimeClock function headers with return values

["Ren, Suqiang" <suqiangx.ren@intel.com>]

Sorry for missed to add EDK2 group. Add this review-by in EDK2 group.


Thanks
Ren, Suqiang

-----Original Message-----
From: Chang, Abner <Abner.Chang@amd.com> 
Sent: Monday, February 5, 2024 2:54 PM
To: Ren, SuqiangX <suqiangx.ren@intel.com>; Leif Lindholm <quic_llindhol@quicinc.com>; Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Tan, Ming <ming.tan@intel.com>; Shang, Qingyu <qingyu.shang@intel.com>; Li, Yi1 <yi1.li@intel.com>
Subject: RE: [edk2-devel] [PATCH V3 3/5] EmbeddedPkg: Align RealTimeClock function headers with return values

[AMD Official Use Only - General]

Reviewed-by: Abner Chang <abner.chang@amd.com>

> -----Original Message-----
> From: Ren, SuqiangX <suqiangx.ren@intel.com>
> Sent: Monday, February 5, 2024 10:44 AM
> To: Leif Lindholm <quic_llindhol@quicinc.com>; Ard Biesheuvel 
> <ardb+tianocore@kernel.org>; Chang, Abner <Abner.Chang@amd.com>
> Cc: Tan, Ming <ming.tan@intel.com>; Shang, Qingyu 
> <qingyu.shang@intel.com>; Li, Yi1 <yi1.li@intel.com>
> Subject: RE: [edk2-devel] [PATCH V3 3/5] EmbeddedPkg: Align 
> RealTimeClock function headers with return values
>
> Caution: This message originated from an External Source. Use proper 
> caution when opening attachments, clicking links, or responding.
>
>
> Hi All,
>
>         Could you please help to review this patch on edk2?
>         https://edk2.groups.io/g/devel/message/115030
>
>         Compared with V2, this V3 patch only updated the commit message.
>
> Thanks
> Ren, Suqiang
>
> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Ren, 
> Suqiang
> Sent: Friday, February 2, 2024 4:21 PM
> To: devel@edk2.groups.io
> Cc: Leif Lindholm <quic_llindhol@quicinc.com>; Ard Biesheuvel 
> <ardb+tianocore@kernel.org>; Abner Chang <abner.chang@amd.com>
> Subject: [edk2-devel] [PATCH V3 3/5] 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
>
> Signed-off-by: Suqiang Ren <suqiangx.ren@intel.com>
> Cc: Leif Lindholm <quic_llindhol@quicinc.com>
> Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
> Cc: Abner Chang <abner.chang@amd.com>
> ---
>  .../Include/Library/RealTimeClockLib.h        | 21 ++++++++++++++++---
>  .../RealTimeClockRuntimeDxe/RealTimeClock.c   | 13 +++++++++++-
>  2 files changed, 30 insertions(+), 4 deletions(-)
>
> diff --git a/EmbeddedPkg/Include/Library/RealTimeClockLib.h
> b/EmbeddedPkg/Include/Library/RealTimeClockLib.h
> index b2ff3f233bea..6c034513f51c 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 17dde432c4eb..0b2e4d1fcc38 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
> --
> 2.26.2.windows.1
>
>
>
> 
>



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