From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 5C14B820F9 for ; Tue, 13 Dec 2016 18:50:43 -0800 (PST) Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga101.jf.intel.com with ESMTP; 13 Dec 2016 18:50:42 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.33,344,1477983600"; d="scan'208";a="17791137" Received: from fmsmsx107.amr.corp.intel.com ([10.18.124.205]) by orsmga002.jf.intel.com with ESMTP; 13 Dec 2016 18:50:42 -0800 Received: from fmsmsx158.amr.corp.intel.com (10.18.116.75) by fmsmsx107.amr.corp.intel.com (10.18.124.205) with Microsoft SMTP Server (TLS) id 14.3.248.2; Tue, 13 Dec 2016 18:50:42 -0800 Received: from shsmsx152.ccr.corp.intel.com (10.239.6.52) by fmsmsx158.amr.corp.intel.com (10.18.116.75) with Microsoft SMTP Server (TLS) id 14.3.248.2; Tue, 13 Dec 2016 18:50:42 -0800 Received: from shsmsx103.ccr.corp.intel.com ([169.254.4.11]) by SHSMSX152.ccr.corp.intel.com ([169.254.6.235]) with mapi id 14.03.0248.002; Wed, 14 Dec 2016 10:50:40 +0800 From: "Fan, Jeff" To: "Bi, Dandan" , "edk2-devel@lists.01.org" Thread-Topic: [patch 12/18] UefiCpuPkg: Make the comments align with the functions Thread-Index: AQHSVR0Rk/b+TjWKoEOCQF681Qq+hKEGvwRA Date: Wed, 14 Dec 2016 02:50:40 +0000 Message-ID: <542CF652F8836A4AB8DBFAAD40ED192A4C4E039B@SHSMSX103.ccr.corp.intel.com> References: <1481618428-101904-1-git-send-email-dandan.bi@intel.com> <1481618428-101904-13-git-send-email-dandan.bi@intel.com> In-Reply-To: <1481618428-101904-13-git-send-email-dandan.bi@intel.com> Accept-Language: zh-CN, en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiNmEzYmM3MzItZDM4MS00N2ViLWFjZmEtYTA4MDVmZmY3N2Y2IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE1LjkuNi42IiwiVHJ1c3RlZExhYmVsSGFzaCI6Ik5rbDBPMGN6Z05XdW01K0M3VGxRTHBLZEZJRkNuV1wvZDZHdlNYZzZDMzFzPSJ9 x-ctpclassification: CTP_IC x-originating-ip: [10.239.127.40] MIME-Version: 1.0 Subject: Re: [patch 12/18] UefiCpuPkg: Make the comments align with the functions X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 14 Dec 2016 02:50:43 -0000 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Please help to add missing ']' on @param[out PlatformInformationRecor= d. Reviewed-by: Jeff Fan with this update. Thanks! -----Original Message----- From: Bi, Dandan=20 Sent: Tuesday, December 13, 2016 4:40 PM To: edk2-devel@lists.01.org Cc: Fan, Jeff Subject: [patch 12/18] UefiCpuPkg: Make the comments align with the functio= ns Cc: Jeff Fan Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Dandan Bi --- UefiCpuPkg/CpuDxe/CpuMp.c | 2 +- UefiCpuPkg/Include/Library/MpInitLib.h | 4 ++-- UefiCpuPkg/Library/MpIn= itLib/DxeMpLib.c | 4 ++-- UefiCpuPkg/Library/MpInitLib/MpLib.c | 11 ++++++----- UefiCpuPkg/Library/MpInitLib/MpLib.h | 4 ++-- UefiCpuPkg/Library/MpInitLib/PeiMpLib.c | 4 ++-- UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c | 2 +- UefiCpuPkg/SecCore/SecBist.c | 16 ++++++++-------- 8 files changed, 24 insertions(+), 23 deletions(-) diff --git a/UefiCpuPkg/CpuDxe/CpuMp.c b/UefiCpuPkg/CpuDxe/CpuMp.c index 3e= 4f83f..9659bd2 100644 --- a/UefiCpuPkg/CpuDxe/CpuMp.c +++ b/UefiCpuPkg/CpuDxe/CpuMp.c @@ -320,11 +320,11 @@ StartupAllAPs ( can use the CheckEvent() or WaitForE= vent() services to check the state of event= . Type EFI_EVENT is defined in CreateEvent(= ) in the Unified Extensible Firmware Inte= rface Specification. - @param[in] TimeoutInMicrosecsond Indicates the time limit in microsec= onds for + @param[in] TimeoutInMicroseconds Indicates the time limit in microsec= onds for this AP to finish this Procedure, ei= ther for blocking or non-blocking mode. Zero = means infinity. If the timeout expires be= fore this AP returns from Procedure, then= Procedure on the AP is terminated. The diff --= git a/UefiCpuPkg/Include/Library/MpInitLib.h b/UefiCpuPkg/Include/Library/M= pInitLib.h index 3e19382..05e9c6b 100644 --- a/UefiCpuPkg/Include/Library/MpInitLib.h +++ b/UefiCpuPkg/Include/Library/MpInitLib.h @@ -114,11 +114,11 @@ MpInitLibGetProcessorInfo ( can use the CheckEvent() or WaitForE= vent() services to check the state of event= . Type EFI_EVENT is defined in CreateEvent(= ) in the Unified Extensible Firmware Inte= rface Specification. - @param[in] TimeoutInMicrosecsond Indicates the time limit in microsec= onds for + @param[in] TimeoutInMicroseconds Indicates the time limit in microsec= onds for APs to return from Procedure, either= for blocking or non-blocking mode. Zero = means infinity. If the timeout expires be= fore all APs return from Procedure, then = Procedure on the failed APs is terminated. All= enabled @@ -200,11 +200,11 @@ MpInitLibStartupAllAPs ( can use the CheckEvent() or WaitForE= vent() services to check the state of event= . Type EFI_EVENT is defined in CreateEvent(= ) in the Unified Extensible Firmware Inte= rface Specification. - @param[in] TimeoutInMicrosecsond Indicates the time limit in microsec= onds for + @param[in] TimeoutInMicroseconds Indicates the time limit in microsec= onds for this AP to finish this Procedure, ei= ther for blocking or non-blocking mode. Zero = means infinity. If the timeout expires be= fore this AP returns from Procedure, then= Procedure on the AP is terminated. The diff --= git a/UefiCpuPkg/Library/MpInitLib/DxeMpLib.c b/UefiCpuPkg/Library/MpInitLi= b/DxeMpLib.c index 8f5074b..e75c269 100644 --- a/UefiCpuPkg/Library/MpInitLib/DxeMpLib.c +++ b/UefiCpuPkg/Library/MpInitLib/DxeMpLib.c @@ -408,11 +408,11 @@ InitMpGlobalData ( can use the CheckEvent() or WaitForE= vent() services to check the state of event= . Type EFI_EVENT is defined in CreateEvent(= ) in the Unified Extensible Firmware Inte= rface Specification. - @param[in] TimeoutInMicrosecsond Indicates the time limit in microsec= onds for + @param[in] TimeoutInMicroseconds Indicates the time limit in microsec= onds for APs to return from Procedure, either= for blocking or non-blocking mode. Zero = means infinity. If the timeout expires be= fore all APs return from Procedure, then = Procedure on the failed APs is terminated. All= enabled @@ -518,11 +518,11 @@ MpInitLibStartupAllAPs ( can use the CheckEvent() or WaitForE= vent() services to check the state of event= . Type EFI_EVENT is defined in CreateEvent(= ) in the Unified Extensible Firmware Inte= rface Specification. - @param[in] TimeoutInMicrosecsond Indicates the time limit in microsec= onds for + @param[in] TimeoutInMicroseconds Indicates the time limit in microsec= onds for this AP to finish this Procedure, ei= ther for blocking or non-blocking mode. Zero = means infinity. If the timeout expires be= fore this AP returns from Procedure, then= Procedure on the AP is terminated. The diff --= git a/UefiCpuPkg/Library/MpInitLib/MpLib.c b/UefiCpuPkg/Library/MpInitLib/M= pLib.c index ed22ce6..0495b0f 100644 --- a/UefiCpuPkg/Library/MpInitLib/MpLib.c +++ b/UefiCpuPkg/Library/MpInitLib/MpLib.c @@ -335,12 +335,12 @@ ApInitializeSync ( } =20 /** Find the current Processor number by APIC ID. =20 - @param[in] CpuMpData Pointer to PEI CPU MP Data - @param[in] ProcessorNumber Return the pocessor number found + @param[in] CpuMpData Pointer to PEI CPU MP Data + @param[out] ProcessorNumber Return the pocessor number found =20 @retval EFI_SUCCESS ProcessorNumber is found and returned. @retval EFI_NOT_FOUND ProcessorNumber is not found. **/ EFI_STATUS @@ -418,16 +418,17 @@ CollectProcessorCount ( DEBUG ((DEBUG_INFO, "MpInitLib: Find %d processors in system.\n", CpuMpD= ata->CpuCount)); =20 return CpuMpData->CpuCount; } =20 -/* +/** Initialize CPU AP Data when AP is wakeup at the first time. =20 @param[in, out] CpuMpData Pointer to PEI CPU MP Data @param[in] ProcessorNumber The handle number of processor @param[in] BistData Processor BIST data + @param[in] ApTopOfStack Top of AP stack =20 **/ VOID InitializeApData ( IN OUT CPU_MP_DATA *CpuMpData, @@ -1704,11 +1705,11 @@ MpInitLibGetNumberOfProcessors ( number. If FALSE, then all the enab= led APs execute the function specified by Pr= ocedure simultaneously. @param[in] WaitEvent The event created by the caller with= CreateEvent() service. - @param[in] TimeoutInMicrosecsond Indicates the time limit in microsec= onds for + @param[in] TimeoutInMicroseconds Indicates the time limit in microsec= onds for APs to return from Procedure, either= for blocking or non-blocking mode. @param[in] ProcedureArgument The parameter passed into Procedure = for all APs. @param[out] FailedCpuList If all APs finish successfully, then= its @@ -1858,11 +1859,11 @@ StartupAllAPsWorker ( @param[in] Procedure A pointer to the function to be run = on enabled APs of the system. @param[in] ProcessorNumber The handle number of the AP. @param[in] WaitEvent The event created by the caller with= CreateEvent() service. - @param[in] TimeoutInMicrosecsond Indicates the time limit in microsec= onds for + @param[in] TimeoutInMicroseconds Indicates the time limit in microsec= onds for APs to return from Procedure, either= for blocking or non-blocking mode. @param[in] ProcedureArgument The parameter passed into Procedure = for all APs. @param[out] Finished If AP returns from Procedure before = the diff --git a/UefiCpuPkg/Library/MpInitLib/MpLib.h b/UefiCpuPkg/Library/MpIn= itLib/MpLib.h index 49305ad..9861a5c 100644 --- a/UefiCpuPkg/Library/MpInitLib/MpLib.h +++ b/UefiCpuPkg/Library/MpInitLib/MpLib.h @@ -363,11 +363,11 @@ InitMpGlobalData ( number. If FALSE, then all the enab= led APs execute the function specified by Pr= ocedure simultaneously. @param[in] WaitEvent The event created by the caller with= CreateEvent() service. - @param[in] TimeoutInMicrosecsond Indicates the time limit in microsec= onds for + @param[in] TimeoutInMicroseconds Indicates the time limit in microsec= onds for APs to return from Procedure, either= for blocking or non-blocking mode. @param[in] ProcedureArgument The parameter passed into Procedure = for all APs. @param[out] FailedCpuList If all APs finish successfully, then= its @@ -400,11 +400,11 @@ StartupAllAPsWorker ( @param[in] Procedure A pointer to the function to be run = on enabled APs of the system. @param[in] ProcessorNumber The handle number of the AP. @param[in] WaitEvent The event created by the caller with= CreateEvent() service. - @param[in] TimeoutInMicrosecsond Indicates the time limit in microsec= onds for + @param[in] TimeoutInMicroseconds Indicates the time limit in microsec= onds for APs to return from Procedure, either= for blocking or non-blocking mode. @param[in] ProcedureArgument The parameter passed into Procedure = for all APs. @param[out] Finished If AP returns from Procedure before = the diff --git a/UefiCpuPkg/Library/MpInitLib/PeiMpLib.c b/UefiCpuPkg/Library/M= pInitLib/PeiMpLib.c index 1f2fcb8..a4166a4 100644 --- a/UefiCpuPkg/Library/MpInitLib/PeiMpLib.c +++ b/UefiCpuPkg/Library/MpInitLib/PeiMpLib.c @@ -361,11 +361,11 @@ InitMpGlobalData ( can use the CheckEvent() or WaitForE= vent() services to check the state of event= . Type EFI_EVENT is defined in CreateEvent(= ) in the Unified Extensible Firmware Inte= rface Specification. - @param[in] TimeoutInMicrosecsond Indicates the time limit in microsec= onds for + @param[in] TimeoutInMicroseconds Indicates the time limit in microsec= onds for APs to return from Procedure, either= for blocking or non-blocking mode. Zero = means infinity. If the timeout expires be= fore all APs return from Procedure, then = Procedure on the failed APs is terminated. All= enabled @@ -461,11 +461,11 @@ MpInitLibStartupAllAPs ( can use the CheckEvent() or WaitForE= vent() services to check the state of event= . Type EFI_EVENT is defined in CreateEvent(= ) in the Unified Extensible Firmware Inte= rface Specification. - @param[in] TimeoutInMicrosecsond Indicates the time limit in microsec= onds for + @param[in] TimeoutInMicroseconds Indicates the time limit in microsec= onds for this AP to finish this Procedure, ei= ther for blocking or non-blocking mode. Zero = means infinity. If the timeout expires be= fore this AP returns from Procedure, then= Procedure on the AP is terminated. The diff --= git a/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c b/UefiCpuPkg/PiSmmCpuDxeSmm/MpS= ervice.c index c146795..c7aa48b 100644 --- a/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c +++ b/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c @@ -897,11 +897,11 @@ SetCacheability ( /** Schedule a procedure to run on the specified CPU. =20 @param[in] Procedure The address of the procedure t= o run @param[in] CpuIndex Target CPU Index - @param[in, OUT] ProcArguments The parameter to pass to the p= rocedure + @param[in, out] ProcArguments The parameter to pass to the p= rocedure @param[in] BlockingMode Startup AP in blocking mode or= not =20 @retval EFI_INVALID_PARAMETER CpuNumber not valid @retval EFI_INVALID_PARAMETER CpuNumber specifying BSP @retval EFI_INVALID_PARAMETER The AP specified by CpuNumber did not e= nter SMM diff --git a/UefiCpuPkg/SecCore/SecBist.c b/UefiCpuPkg/SecCore/SecBist.c in= dex ba7d7ca..5eb8b3a 100644 --- a/UefiCpuPkg/SecCore/SecBist.c +++ b/UefiCpuPkg/SecCore/SecBist.c @@ -35,12 +35,12 @@ EFI_PEI_PPI_DESCRIPTOR mPeiSecPlatformInformation2 =3D = { }; =20 /** Worker function to parse CPU BIST information from Guided HOB. =20 - @param[out] StructureSize Pointer to the variable describing size of= the input buffer. - @param[out] StructureBuffer Pointer to the buffer save CPU BIST inform= ation. + @param[in, out] StructureSize Pointer to the variable describing siz= e of the input buffer. + @param[in, out] StructureBuffer Pointer to the buffer save CPU BIST in= formation. =20 @retval EFI_SUCCESS The data was successfully returned. @retval EFI_BUFFER_TOO_SMALL The buffer was too small. =20 **/ @@ -77,13 +77,13 @@ GetBistFromHob ( } =20 /** Implementation of the PlatformInformation service in EFI_SEC_PLATFORM_IN= FORMATION_PPI. =20 - @param[in] PeiServices Pointer to the PEI Services Table= . - @param[out] StructureSize Pointer to the variable describin= g size of the input buffer. - @param[out PlatformInformationRecord Pointer to the EFI_SEC_PLATFORM_I= NFORMATION_RECORD. + @param[in] PeiServices Pointer to the PEI Services T= able. + @param[in, out] StructureSize Pointer to the variable descr= ibing size of the input buffer. + @param[out PlatformInformationRecord Pointer to the EFI_SEC_PLATFO= RM_INFORMATION_RECORD. =20 @retval EFI_SUCCESS The data was successfully returne= d. @retval EFI_BUFFER_TOO_SMALL The buffer was too small. =20 **/ @@ -99,13 +99,13 @@ SecPlatformInformationBist ( } =20 /** Implementation of the PlatformInformation2 service in EFI_SEC_PLATFORM_I= NFORMATION2_PPI. =20 - @param[in] PeiServices The pointer to the PEI Services T= able. - @param[out] StructureSize The pointer to the variable descr= ibing size of the input buffer. - @param[out] PlatformInformationRecord2 The pointer to the EFI_SEC_PLATFO= RM_INFORMATION_RECORD2. + @param[in] PeiServices The pointer to the PEI Servic= es Table. + @param[in, out] StructureSize The pointer to the variable d= escribing size of the input buffer. + @param[out] PlatformInformationRecord2 The pointer to the EFI_SEC_PL= ATFORM_INFORMATION_RECORD2. =20 @retval EFI_SUCCESS The data was successfully returne= d. @retval EFI_BUFFER_TOO_SMALL The buffer was too small. The cur= rent buffer size needed to hold the record is returned in St= ructureSize. =20 -- 1.9.5.msysgit.1