UefiCpuPkg/CpuDxe: Fixed typo in function header to match PI spec

Cc: Liming Gao <liming.gao@intel.com>
Cc: Michael Kinney <michael.d.kinney@intel.com>
Cc: Feng Tian <feng.tian@intel.com>
Cc: Giri P Mudusuru <giri.p.mudusuru@intel.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Jeff Fan <jeff.fan@intel.com>
Reviewed-by: Giri P Mudusuru <giri.p.mudusuru@intel.com>
Reviewed-by: Michael Kinney <michael.d.kinney@intel.com>
Tested-by: Michael Kinney <michael.d.kinney@intel.com>
This commit is contained in:
Jeff Fan 2016-07-30 01:43:17 +08:00
parent 8f3446d8ee
commit f3b91fa04a

View File

@ -299,8 +299,8 @@ StartupAllAPs (
@param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL @param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL
instance. instance.
@param[in] Procedure A pointer to the function to be run on @param[in] Procedure A pointer to the function to be run on the
enabled APs of the system. See type designated AP of the system. See type
EFI_AP_PROCEDURE. EFI_AP_PROCEDURE.
@param[in] ProcessorNumber The handle number of the AP. The range is @param[in] ProcessorNumber The handle number of the AP. The range is
from 0 to the total number of logical from 0 to the total number of logical
@ -309,34 +309,34 @@ StartupAllAPs (
EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors(). EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors().
@param[in] WaitEvent The event created by the caller with CreateEvent() @param[in] WaitEvent The event created by the caller with CreateEvent()
service. If it is NULL, then execute in service. If it is NULL, then execute in
blocking mode. BSP waits until all APs finish blocking mode. BSP waits until this AP finish
or TimeoutInMicroseconds expires. If it's or TimeoutInMicroSeconds expires. If it's
not NULL, then execute in non-blocking mode. not NULL, then execute in non-blocking mode.
BSP requests the function specified by BSP requests the function specified by
Procedure to be started on all the enabled Procedure to be started on this AP,
APs, and go on executing immediately. If and go on executing immediately. If this AP
all return from Procedure or TimeoutInMicroseconds return from Procedure or TimeoutInMicroSeconds
expires, this event is signaled. The BSP expires, this event is signaled. The BSP
can use the CheckEvent() or WaitForEvent() can use the CheckEvent() or WaitForEvent()
services to check the state of event. Type services to check the state of event. Type
EFI_EVENT is defined in CreateEvent() in EFI_EVENT is defined in CreateEvent() in
the Unified Extensible Firmware Interface the Unified Extensible Firmware Interface
Specification. Specification.
@param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
APs to return from Procedure, either for this AP to finish this Procedure, either for
blocking or non-blocking mode. Zero means blocking or non-blocking mode. Zero means
infinity. If the timeout expires before infinity. If the timeout expires before
all APs return from Procedure, then Procedure this AP returns from Procedure, then Procedure
on the failed APs is terminated. All enabled on the AP is terminated. The
APs are available for next function assigned AP is available for next function assigned
by EFI_MP_SERVICES_PROTOCOL.StartupAllAPs() by EFI_MP_SERVICES_PROTOCOL.StartupAllAPs()
or EFI_MP_SERVICES_PROTOCOL.StartupThisAP(). or EFI_MP_SERVICES_PROTOCOL.StartupThisAP().
If the timeout expires in blocking mode, If the timeout expires in blocking mode,
BSP returns EFI_TIMEOUT. If the timeout BSP returns EFI_TIMEOUT. If the timeout
expires in non-blocking mode, WaitEvent expires in non-blocking mode, WaitEvent
is signaled with SignalEvent(). is signaled with SignalEvent().
@param[in] ProcedureArgument The parameter passed into Procedure for @param[in] ProcedureArgument The parameter passed into Procedure on the
all APs. specified AP.
@param[out] Finished If NULL, this parameter is ignored. In @param[out] Finished If NULL, this parameter is ignored. In
blocking mode, this parameter is ignored. blocking mode, this parameter is ignored.
In non-blocking mode, if AP returns from In non-blocking mode, if AP returns from
@ -447,8 +447,8 @@ SwitchBSP (
from this service, then EFI_UNSUPPORTED must be returned. from this service, then EFI_UNSUPPORTED must be returned.
@param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL instance. @param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL instance.
@param[in] ProcessorNumber The handle number of AP that is to become the new @param[in] ProcessorNumber The handle number of AP.
BSP. The range is from 0 to the total number of The range is from 0 to the total number of
logical processors minus 1. The total number of logical processors minus 1. The total number of
logical processors can be retrieved by logical processors can be retrieved by
EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors(). EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors().
@ -497,8 +497,8 @@ EnableDisableAP (
ProcessorNumber, and EFI_SUCCESS is returned. ProcessorNumber, and EFI_SUCCESS is returned.
@param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL instance. @param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL instance.
@param[out] ProcessorNumber The handle number of AP that is to become the new @param[out] ProcessorNumber Pointer to the handle number of AP.
BSP. The range is from 0 to the total number of The range is from 0 to the total number of
logical processors minus 1. The total number of logical processors minus 1. The total number of
logical processors can be retrieved by logical processors can be retrieved by
EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors(). EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors().