From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail02.groups.io (mail02.groups.io [66.175.222.108]) by spool.mail.gandi.net (Postfix) with ESMTPS id 0896B740038 for ; Thu, 1 Feb 2024 18:35:47 +0000 (UTC) DKIM-Signature: a=rsa-sha256; bh=CM7dow9zoj5BgIzw4Qk23liqko4VNXzoYwLNypRtimY=; c=relaxed/simple; d=groups.io; h=Message-ID:Date:MIME-Version:User-Agent:Subject:To:References:From:In-Reply-To:Precedence:List-Subscribe:List-Help:Sender:List-Id:Mailing-List:Delivered-To:Reply-To:List-Unsubscribe-Post:List-Unsubscribe:Content-Language:Content-Type:Content-Transfer-Encoding; s=20140610; t=1706812546; v=1; b=Z/qArs/0QQcYY4b7mffZdq8JmSsEePmDmPi52e1zH/pudNLtmg7QWbAOGxlB49zj1M3xAo+j +tdaMXTWYlLitOXJDpeAXTKHwyo4ngZdLPAa1IXIq4J6yik7km5bJUabFjwrg+eVAVh0iVjHd3q 68qLR2zuvviLIagdDDiaewoM= X-Received: by 127.0.0.2 with SMTP id 2jA4YY7687511xAN6c7BMUkz; Thu, 01 Feb 2024 10:35:46 -0800 X-Received: from mx0a-0031df01.pphosted.com (mx0a-0031df01.pphosted.com [205.220.168.131]) by mx.groups.io with SMTP id smtpd.web10.3357.1706812545766954962 for ; Thu, 01 Feb 2024 10:35:45 -0800 X-Received: from pps.filterd (m0279863.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.17.1.24/8.17.1.24) with ESMTP id 411FDdwk026842; Thu, 1 Feb 2024 18:35:45 GMT X-Received: from nasanppmta02.qualcomm.com (i-global254.qualcomm.com [199.106.103.254]) by mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 3w0aws8xyk-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Thu, 01 Feb 2024 18:35:45 +0000 (GMT) X-Received: from nasanex01c.na.qualcomm.com (nasanex01c.na.qualcomm.com [10.45.79.139]) by NASANPPMTA02.qualcomm.com (8.17.1.5/8.17.1.5) with ESMTPS id 411IZibA022048 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Thu, 1 Feb 2024 18:35:44 GMT X-Received: from [10.111.143.216] (10.80.80.8) by nasanex01c.na.qualcomm.com (10.45.79.139) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1118.40; Thu, 1 Feb 2024 10:35:42 -0800 Message-ID: <3e6aaf3a-3a85-4dc5-a470-11d511140b35@quicinc.com> Date: Thu, 1 Feb 2024 18:35:40 +0000 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: FW: [edk2-devel] [PATCH V2 4/5] ArmPlatformPkg: Update some Runtime Service functions header To: "Kinney, Michael D" , "devel@edk2.groups.io" , "Ren, SuqiangX" , "ardb+tianocore@kernel.org" References: <17AEB08976789B0D.21687@groups.io> From: "Leif Lindholm" In-Reply-To: X-Originating-IP: [10.80.80.8] X-ClientProxiedBy: nasanex01b.na.qualcomm.com (10.46.141.250) To nasanex01c.na.qualcomm.com (10.45.79.139) X-QCInternal: smtphost X-Proofpoint-GUID: 5M0CTi6X-tKBNwOamtAEr_P0wxlLELeR X-Proofpoint-ORIG-GUID: 5M0CTi6X-tKBNwOamtAEr_P0wxlLELeR X-MIME-Autoconverted: from 8bit to quoted-printable by mx0a-0031df01.pphosted.com id 411FDdwk026842 Precedence: Bulk List-Subscribe: List-Help: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,quic_llindhol@quicinc.com List-Unsubscribe-Post: List-Unsubscribe=One-Click List-Unsubscribe: X-Gm-Message-State: e0V4lVAnc4JaFHVIfe2Ala4Px7686176AA= Content-Language: en-GB Content-Type: text/plain; charset="UTF-8"; format=flowed Content-Transfer-Encoding: quoted-printable X-GND-Status: LEGIT Authentication-Results: spool.mail.gandi.net; dkim=pass header.d=groups.io header.s=20140610 header.b="Z/qArs/0"; dmarc=fail reason="SPF not aligned (relaxed), DKIM not aligned (relaxed)" header.from=quicinc.com (policy=none); spf=pass (spool.mail.gandi.net: domain of bounce@groups.io designates 66.175.222.108 as permitted sender) smtp.mailfrom=bounce@groups.io On 2024-01-31 20:04, Kinney, Michael D wrote: > Hi Leif, >=20 > The only reference to these APIs are in the .c files in ArmPlatformPkg. >=20 > RealTimeClockLib.h that defines these APIs is in EmbeddedPkg and this > patch series also has changes against EmbeddedPkg. Oh, you're absolutely correct. My bad, I must have been distracted while grepping. Apologies. > So other than the commit message, are the code changes correct? The commit message is all that needs changing. / Leif > Mike >=20 >> -----Original Message----- >> From: devel@edk2.groups.io On Behalf Of Leif >> Lindholm >> Sent: Wednesday, January 31, 2024 11:13 AM >> To: Ren, SuqiangX ; ardb+tianocore@kernel.org; >> devel@edk2.groups.io >> Subject: Re: FW: [edk2-devel] [PATCH V2 4/5] ArmPlatformPkg: Update some >> Runtime Service functions header >> >> On 2024-01-30 08:33, Ren, SuqiangX wrote: >>> Hi All, >>> >>> Could you please help to review this patch on edk2? >>> https://edk2.groups.io/g/devel/message/114661 >>> >>> Thanks >>> Ren, Suqiang >> >> Hi, >> >> Sorry, your original email seems to be corrupted in my mailbox, so >> replying here. >> >>> -----Original Message----- >>> From: devel@edk2.groups.io On Behalf Of Ren, >> Suqiang >>> Sent: Monday, January 29, 2024 10:30 AM >>> To: devel@edk2.groups.io >>> Cc: Leif Lindholm ; Ard Biesheuvel >> >>> Subject: [edk2-devel] [PATCH V2 4/5] ArmPlatformPkg: Update some >> Runtime Service functions header >>> >>> Update some Runtime Service functions header to align with UEFI spec >> 2.10. >>> >>> REF: UEFI spec 2.10 section 8 Services =E2=80=94 Runtime Services >> >> Nothing that is being changed by this patch is described by the UEFI >> specification. The commit message should describe what a patch does, >> the overall purpose of the set should be described in the cover letter >> (and you do describe that here). >> >> Here is my proposed changed commit message: >> --- >> ArmPlatformPkg: align PL031 library function headers with UEFI return >> values >> >> 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 2.10. >> --- >> >> Apart from that, the function comment headers exist both in the .h and >> the .c. If the .h is being updated, so should the .c. >> >> Best Regards, >> >> Leif >> >>> Signed-off-by: Suqiang Ren >>> Cc: Leif Lindholm >>> Cc: Ard Biesheuvel >>> --- >>> .../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 >> >> >> >>=20 >> >=20 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#114953): https://edk2.groups.io/g/devel/message/114953 Mute This Topic: https://groups.io/mt/104081753/7686176 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [rebecca@openfw.io] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-