From: "Fan, Jeff" <jeff.fan@intel.com>
To: "Bi, Dandan" <dandan.bi@intel.com>,
"edk2-devel@lists.01.org" <edk2-devel@lists.01.org>
Subject: Re: [patch 12/18] UefiCpuPkg: Make the comments align with the functions
Date: Wed, 14 Dec 2016 02:50:40 +0000 [thread overview]
Message-ID: <542CF652F8836A4AB8DBFAAD40ED192A4C4E039B@SHSMSX103.ccr.corp.intel.com> (raw)
In-Reply-To: <1481618428-101904-13-git-send-email-dandan.bi@intel.com>
Please help to add missing ']' on @param[out PlatformInformationRecord.
Reviewed-by: Jeff Fan <jeff.fan@intel.com> with this update.
Thanks!
-----Original Message-----
From: Bi, Dandan
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 functions
Cc: Jeff Fan <jeff.fan@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
---
UefiCpuPkg/CpuDxe/CpuMp.c | 2 +-
UefiCpuPkg/Include/Library/MpInitLib.h | 4 ++-- UefiCpuPkg/Library/MpInitLib/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 3e4f83f..9659bd2 100644
--- a/UefiCpuPkg/CpuDxe/CpuMp.c
+++ b/UefiCpuPkg/CpuDxe/CpuMp.c
@@ -320,11 +320,11 @@ StartupAllAPs (
can use the CheckEvent() or WaitForEvent()
services to check the state of event. Type
EFI_EVENT is defined in CreateEvent() in
the Unified Extensible Firmware Interface
Specification.
- @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
+ @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
this AP to finish this Procedure, either for
blocking or non-blocking mode. Zero means
infinity. If the timeout expires before
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/MpInitLib.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 WaitForEvent()
services to check the state of event. Type
EFI_EVENT is defined in CreateEvent() in
the Unified Extensible Firmware Interface
Specification.
- @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
+ @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
APs to return from Procedure, either for
blocking or non-blocking mode. Zero means
infinity. If the timeout expires before
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 WaitForEvent()
services to check the state of event. Type
EFI_EVENT is defined in CreateEvent() in
the Unified Extensible Firmware Interface
Specification.
- @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
+ @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
this AP to finish this Procedure, either for
blocking or non-blocking mode. Zero means
infinity. If the timeout expires before
this AP returns from Procedure, then Procedure
on the AP is terminated. The diff --git a/UefiCpuPkg/Library/MpInitLib/DxeMpLib.c b/UefiCpuPkg/Library/MpInitLib/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 WaitForEvent()
services to check the state of event. Type
EFI_EVENT is defined in CreateEvent() in
the Unified Extensible Firmware Interface
Specification.
- @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
+ @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
APs to return from Procedure, either for
blocking or non-blocking mode. Zero means
infinity. If the timeout expires before
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 WaitForEvent()
services to check the state of event. Type
EFI_EVENT is defined in CreateEvent() in
the Unified Extensible Firmware Interface
Specification.
- @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
+ @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
this AP to finish this Procedure, either for
blocking or non-blocking mode. Zero means
infinity. If the timeout expires before
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/MpLib.c
index ed22ce6..0495b0f 100644
--- a/UefiCpuPkg/Library/MpInitLib/MpLib.c
+++ b/UefiCpuPkg/Library/MpInitLib/MpLib.c
@@ -335,12 +335,12 @@ ApInitializeSync ( }
/**
Find the current Processor number by APIC ID.
- @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
@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", CpuMpData->CpuCount));
return CpuMpData->CpuCount;
}
-/*
+/**
Initialize CPU AP Data when AP is wakeup at the first time.
@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
**/
VOID
InitializeApData (
IN OUT CPU_MP_DATA *CpuMpData,
@@ -1704,11 +1705,11 @@ MpInitLibGetNumberOfProcessors (
number. If FALSE, then all the enabled APs
execute the function specified by Procedure
simultaneously.
@param[in] WaitEvent The event created by the caller with CreateEvent()
service.
- @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
+ @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds 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 microseconds for
+ @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds 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/MpInitLib/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 enabled APs
execute the function specified by Procedure
simultaneously.
@param[in] WaitEvent The event created by the caller with CreateEvent()
service.
- @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
+ @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds 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 microseconds for
+ @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds 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/MpInitLib/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 WaitForEvent()
services to check the state of event. Type
EFI_EVENT is defined in CreateEvent() in
the Unified Extensible Firmware Interface
Specification.
- @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
+ @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
APs to return from Procedure, either for
blocking or non-blocking mode. Zero means
infinity. If the timeout expires before
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 WaitForEvent()
services to check the state of event. Type
EFI_EVENT is defined in CreateEvent() in
the Unified Extensible Firmware Interface
Specification.
- @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
+ @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
this AP to finish this Procedure, either for
blocking or non-blocking mode. Zero means
infinity. If the timeout expires before
this AP returns from Procedure, then Procedure
on the AP is terminated. The diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c b/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.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.
@param[in] Procedure The address of the procedure to run
@param[in] CpuIndex Target CPU Index
- @param[in, OUT] ProcArguments The parameter to pass to the procedure
+ @param[in, out] ProcArguments The parameter to pass to the procedure
@param[in] BlockingMode Startup AP in blocking mode or not
@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 enter SMM
diff --git a/UefiCpuPkg/SecCore/SecBist.c b/UefiCpuPkg/SecCore/SecBist.c index ba7d7ca..5eb8b3a 100644
--- a/UefiCpuPkg/SecCore/SecBist.c
+++ b/UefiCpuPkg/SecCore/SecBist.c
@@ -35,12 +35,12 @@ EFI_PEI_PPI_DESCRIPTOR mPeiSecPlatformInformation2 = { };
/**
Worker function to parse CPU BIST information from Guided HOB.
- @param[out] StructureSize Pointer to the variable describing size of the input buffer.
- @param[out] StructureBuffer Pointer to the buffer save CPU BIST information.
+ @param[in, out] StructureSize Pointer to the variable describing size of the input buffer.
+ @param[in, out] StructureBuffer Pointer to the buffer save CPU BIST information.
@retval EFI_SUCCESS The data was successfully returned.
@retval EFI_BUFFER_TOO_SMALL The buffer was too small.
**/
@@ -77,13 +77,13 @@ GetBistFromHob (
}
/**
Implementation of the PlatformInformation service in EFI_SEC_PLATFORM_INFORMATION_PPI.
- @param[in] PeiServices Pointer to the PEI Services Table.
- @param[out] StructureSize Pointer to the variable describing size of the input buffer.
- @param[out PlatformInformationRecord Pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.
+ @param[in] PeiServices Pointer to the PEI Services Table.
+ @param[in, out] StructureSize Pointer to the variable describing size of the input buffer.
+ @param[out PlatformInformationRecord Pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD.
@retval EFI_SUCCESS The data was successfully returned.
@retval EFI_BUFFER_TOO_SMALL The buffer was too small.
**/
@@ -99,13 +99,13 @@ SecPlatformInformationBist ( }
/**
Implementation of the PlatformInformation2 service in EFI_SEC_PLATFORM_INFORMATION2_PPI.
- @param[in] PeiServices The pointer to the PEI Services Table.
- @param[out] StructureSize The pointer to the variable describing size of the input buffer.
- @param[out] PlatformInformationRecord2 The pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD2.
+ @param[in] PeiServices The pointer to the PEI Services Table.
+ @param[in, out] StructureSize The pointer to the variable describing size of the input buffer.
+ @param[out] PlatformInformationRecord2 The pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD2.
@retval EFI_SUCCESS The data was successfully returned.
@retval EFI_BUFFER_TOO_SMALL The buffer was too small. The current buffer size needed to
hold the record is returned in StructureSize.
--
1.9.5.msysgit.1
next prev parent reply other threads:[~2016-12-14 2:50 UTC|newest]
Thread overview: 39+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-12-13 8:40 [patch 00/18] Fix coding style issues Dandan Bi
2016-12-13 8:40 ` [patch 01/18] ShellPkg/UefiShellDebug1CommandsLib: " Dandan Bi
2016-12-13 16:16 ` Carsey, Jaben
2016-12-13 8:40 ` [patch 02/18] ShellPkg/UefiShellNetwork1CommandsLib: Fix incorrect Protocol format Dandan Bi
2016-12-13 16:16 ` Carsey, Jaben
2016-12-13 8:40 ` [patch 03/18] ShellPkg/UefiShellNetwork2CommandsLib: " Dandan Bi
2016-12-13 16:16 ` Carsey, Jaben
2016-12-13 8:40 ` [patch 04/18] Security:Add info string to UNI file for PcdPkcs7CertBuffer Dandan Bi
[not found] ` <3C0D5C461C9E904E8F62152F6274C0BB3B856DCA@SHSMSX103.ccr.corp.intel.com>
2016-12-14 2:45 ` Yao, Jiewen
2016-12-13 8:40 ` [patch 05/18] SecurityPkg/FmpAuthenticationLibPkcs7: Fix incorrect Guid format Dandan Bi
2016-12-13 8:50 ` Yao, Jiewen
2016-12-13 8:40 ` [patch 06/18] SecurityPkg/FmpAuthenticationLibRsa2048Sha256: Fix Guid/pcd format issues Dandan Bi
2016-12-13 8:50 ` Yao, Jiewen
2016-12-13 8:40 ` [patch 07/18] SecurityPkg/OpalPasswordDxe: Make comments align with the function Dandan Bi
2016-12-14 5:18 ` Dong, Eric
2016-12-13 8:40 ` [patch 08/18] SignedCapsulePkg/EdkiiSystemCapsuleLib: Fix coding style issues in INF file Dandan Bi
2016-12-13 8:49 ` Yao, Jiewen
2016-12-13 8:40 ` [patch 09/18] SignedCapsulePkg/RecoveryModuleLoadPei: Add source file to " Dandan Bi
2016-12-13 8:49 ` Yao, Jiewen
2016-12-13 8:40 ` [patch 10/18] SignedCapsulePkg/SystemFirmwareUpdate: " Dandan Bi
2016-12-13 8:48 ` Yao, Jiewen
2016-12-13 8:40 ` [patch 11/18] SignedCapsulePkg/IniParsingLib: Update struct name Dandan Bi
2016-12-13 8:49 ` Yao, Jiewen
2016-12-14 2:36 ` Yao, Jiewen
2016-12-13 8:40 ` [patch 12/18] UefiCpuPkg: Make the comments align with the functions Dandan Bi
2016-12-14 2:50 ` Fan, Jeff [this message]
2016-12-13 8:40 ` [patch 13/18] UefiCpuPkg: Add info string to UNI file for PcdCpuSmmStaticPageTable Dandan Bi
[not found] ` <3C0D5C461C9E904E8F62152F6274C0BB3B856DE3@SHSMSX103.ccr.corp.intel.com>
2016-12-14 2:41 ` Yao, Jiewen
2016-12-14 2:51 ` Fan, Jeff
2016-12-13 8:40 ` [patch 14/18] UefiCpuPkg/MicrocodeUpdateDxe: Fix coding style issues in INF file Dandan Bi
2016-12-13 8:46 ` Yao, Jiewen
2016-12-13 8:40 ` [patch 15/18] UefiCpuPkg/Capsule: Fix coding style issues Dandan Bi
2016-12-13 8:47 ` Yao, Jiewen
2016-12-13 8:40 ` [patch 16/18] MdeModulePkg: Make the comments align with the function Dandan Bi
2016-12-13 8:46 ` Yao, Jiewen
2016-12-13 8:40 ` [patch 17/18] MdeModulePkg: Add missing info string for PCDs Dandan Bi
[not found] ` <3C0D5C461C9E904E8F62152F6274C0BB3B856DD7@SHSMSX103.ccr.corp.intel.com>
2016-12-14 2:42 ` Yao, Jiewen
2016-12-13 8:40 ` [patch 18/18] MdeModulePkg/CapsuleApp: Fix GUID/protocol format issues Dandan Bi
2016-12-13 8:46 ` Yao, Jiewen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-list from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=542CF652F8836A4AB8DBFAAD40ED192A4C4E039B@SHSMSX103.ccr.corp.intel.com \
--to=devel@edk2.groups.io \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox