MdePkg/MpService.h: 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>

diff --git a/MdePkg/Include/Protocol/MpService.h b/MdePkg/Include/Protocol/MpService.h
index 5934727fd89d3f895fb151796487a832e40c2a4c..043a10ab3ea5625ad552b3b90c97d1471af1c7a8 100644 (file)
--- a/MdePkg/Include/Protocol/MpService.h
+++ b/MdePkg/Include/Protocol/MpService.h
@@ -27,7 +27,7 @@
   APs to help test system memory in parallel with other device initialization.\r
   Diagnostics applications may also use this protocol for multi-processor.\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed and made available under \r
 the terms and conditions of the BSD License that accompanies this distribution.  \r
 The full text of the license may be found at\r
@@ -388,8 +388,8 @@ EFI_STATUS
 \r
   @param[in]  This                    A pointer to the EFI_MP_SERVICES_PROTOCOL\r
                                       instance.\r
-  @param[in]  Procedure               A pointer to the function to be run on \r
-                                      enabled APs of the system. See type\r
+  @param[in]  Procedure               A pointer to the function to be run on the\r
+                                      designated AP of the system. See type\r
                                       EFI_AP_PROCEDURE.\r
   @param[in]  ProcessorNumber         The handle number of the AP. The range is \r
                                       from 0 to the total number of logical\r
@@ -398,13 +398,13 @@ EFI_STATUS
                                       EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors().\r
   @param[in]  WaitEvent               The event created by the caller with CreateEvent()\r
                                       service.  If it is NULL, then execute in \r
-                                      blocking mode. BSP waits until all APs finish \r
+                                      blocking mode. BSP waits until this AP finish \r
                                       or TimeoutInMicroSeconds expires.  If it's \r
                                       not NULL, then execute in non-blocking mode. \r
                                       BSP requests the function specified by \r
-                                      Procedure to be started on all the enabled \r
-                                      APs, and go on executing immediately. If \r
-                                      all return from Procedure or TimeoutInMicroSeconds\r
+                                      Procedure to be started on this AP, \r
+                                      and go on executing immediately. If this AP\r
+                                      return from Procedure or TimeoutInMicroSeconds\r
                                       expires, this event is signaled. The BSP \r
                                       can use the CheckEvent() or WaitForEvent() \r
                                       services to check the state of event.  Type \r
@@ -412,20 +412,20 @@ EFI_STATUS
                                       the Unified Extensible Firmware Interface \r
                                       Specification.  \r
   @param[in]  TimeoutInMicrosecsond   Indicates the time limit in microseconds for \r
-                                      APs to return from Procedure, either for \r
+                                      this AP to finish this Procedure, either for \r
                                       blocking or non-blocking mode. Zero means \r
                                       infinity.  If the timeout expires before \r
-                                      all APs return from Procedure, then Procedure\r
-                                      on the failed APs is terminated. All enabled \r
-                                      APs are available for next function assigned \r
+                                      this AP returns from Procedure, then Procedure\r
+                                      on the AP is terminated. The \r
+                                      AP is available for next function assigned \r
                                       by EFI_MP_SERVICES_PROTOCOL.StartupAllAPs() \r
                                       or EFI_MP_SERVICES_PROTOCOL.StartupThisAP().\r
                                       If the timeout expires in blocking mode, \r
                                       BSP returns EFI_TIMEOUT.  If the timeout \r
                                       expires in non-blocking mode, WaitEvent \r
                                       is signaled with SignalEvent().\r
-  @param[in]  ProcedureArgument       The parameter passed into Procedure for \r
-                                      all APs.\r
+  @param[in]  ProcedureArgument       The parameter passed into Procedure on the\r
+                                      specified AP.\r
   @param[out] Finished                If NULL, this parameter is ignored.  In \r
                                       blocking mode, this parameter is ignored.\r
                                       In non-blocking mode, if AP returns from \r
@@ -523,8 +523,8 @@ EFI_STATUS
   from this service, then EFI_UNSUPPORTED must be returned.\r
 \r
   @param[in] This              A pointer to the EFI_MP_SERVICES_PROTOCOL instance.\r
-  @param[in] ProcessorNumber   The handle number of AP that is to become the new \r
-                               BSP. The range is from 0 to the total number of \r
+  @param[in] ProcessorNumber   The handle number of AP.\r
+                               The range is from 0 to the total number of \r
                                logical processors minus 1. The total number of \r
                                logical processors can be retrieved by\r
                                EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors().\r
@@ -570,8 +570,8 @@ EFI_STATUS
   ProcessorNumber, and EFI_SUCCESS is returned.\r
 \r
   @param[in] This              A pointer to the EFI_MP_SERVICES_PROTOCOL instance.\r
-  @param[in] ProcessorNumber   The handle number of AP that is to become the new \r
-                               BSP. The range is from 0 to the total number of \r
+  @param[in] ProcessorNumber   Pointer to the handle number of AP.\r
+                               The range is from 0 to the total number of \r
                                logical processors minus 1. The total number of \r
                                logical processors can be retrieved by\r
                                EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors().\r