mirror of https://github.com/acidanthera/audk.git
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> Reviewed-by: Jeff Fan <jeff.fan@intel.com>
This commit is contained in:
parent
67c09dd5ce
commit
367284e773
|
@ -322,7 +322,7 @@ StartupAllAPs (
|
|||
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
|
||||
|
|
|
@ -116,7 +116,7 @@ MpInitLibGetProcessorInfo (
|
|||
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
|
||||
|
@ -202,7 +202,7 @@ MpInitLibStartupAllAPs (
|
|||
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
|
||||
|
|
|
@ -410,7 +410,7 @@ InitMpGlobalData (
|
|||
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
|
||||
|
@ -520,7 +520,7 @@ MpInitLibStartupAllAPs (
|
|||
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
|
||||
|
|
|
@ -337,8 +337,8 @@ 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.
|
||||
|
@ -420,12 +420,13 @@ CollectProcessorCount (
|
|||
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
|
||||
|
@ -1706,7 +1707,7 @@ MpInitLibGetNumberOfProcessors (
|
|||
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
|
||||
|
@ -1860,7 +1861,7 @@ StartupAllAPsWorker (
|
|||
@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
|
||||
|
|
|
@ -365,7 +365,7 @@ InitMpGlobalData (
|
|||
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
|
||||
|
@ -402,7 +402,7 @@ StartupAllAPsWorker (
|
|||
@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
|
||||
|
|
|
@ -363,7 +363,7 @@ InitMpGlobalData (
|
|||
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
|
||||
|
@ -463,7 +463,7 @@ MpInitLibStartupAllAPs (
|
|||
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
|
||||
|
|
|
@ -899,7 +899,7 @@ SetCacheability (
|
|||
|
||||
@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
|
||||
|
|
|
@ -37,8 +37,8 @@ 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.
|
||||
|
@ -79,9 +79,9 @@ 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.
|
||||
|
@ -101,9 +101,9 @@ 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
|
||||
|
|
Loading…
Reference in New Issue