Add Framework MP Services Protocol

[mirror_edk2.git] / IntelFrameworkPkg / Include / Framework / DxeCis.h

diff --git a/IntelFrameworkPkg/Include/Framework/DxeCis.h b/IntelFrameworkPkg/Include/Framework/DxeCis.h
index f0f8f7e295fb083507ce7820e79167abaa6ae016..86d96ddd4125ecf5c4457d83189ab73887991200 100644 (file)
--- a/IntelFrameworkPkg/Include/Framework/DxeCis.h
+++ b/IntelFrameworkPkg/Include/Framework/DxeCis.h
@@ -18,19 +18,23 @@
 \r
 #include <Protocol/StatusCode.h>\r
 \r
-//\r
-// Function prototype for invoking a function on an Application Processor\r
-// Used by both the SMM infrastructure and the MP Services Protocol\r
-//\r
+/**\r
+  Functions of this type are used with the Framework MP Services Protocol and\r
+  the  SMM Services Table to execute a procedure on enabled APs.  The context \r
+  the AP should use durng execution is specified by Buffer.\r
+  \r
+  @param[in]  Buffer   Pointer to the procedure's argument.\r
+\r
+**/\r
 typedef\r
 VOID\r
-(EFIAPI *EFI_AP_PROCEDURE)(\r
-  IN  VOID                          *Buffer\r
+(EFIAPI *FRAMEWORK_EFI_AP_PROCEDURE)(\r
+  IN  VOID  *Buffer\r
   );\r
 \r
-//\r
-// Framework EFI Runtime Services Table as extension to EFI 1.10 Runtime Services Table\r
-//\r
+///\r
+/// Framework EFI Runtime Services Table as extension to EFI 1.10 Runtime Services Table\r
+///\r
 typedef struct {\r
   //\r
   // Table header for the Framework EFI Runtime Services Table\r
@@ -59,10 +63,10 @@ typedef struct {
   //\r
   EFI_GET_NEXT_HIGH_MONO_COUNT      GetNextHighMonotonicCount;\r
   EFI_RESET_SYSTEM                  ResetSystem;\r
-  //\r
-  // Framework extension to EFI 1.10 runtime table\r
-  // It was moved to a protocol to not conflict with UEFI 2.0\r
-  //\r
+  ///\r
+  /// Framework extension to EFI 1.10 runtime table\r
+  /// It was moved to a protocol to not conflict with UEFI 2.0\r
+  ///\r
   EFI_REPORT_STATUS_CODE            ReportStatusCode;\r
 } FRAMEWORK_EFI_RUNTIME_SERVICES;\r
 \r