IntelFrameworkPkg: Clean up source files

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

diff --git a/IntelFrameworkPkg/Include/Framework/DxeCis.h b/IntelFrameworkPkg/Include/Framework/DxeCis.h
index f0f8f7e295fb083507ce7820e79167abaa6ae016..8cb905e3a3a27b7c01548915114b438fd2c031d8 100644 (file)
--- a/IntelFrameworkPkg/Include/Framework/DxeCis.h
+++ b/IntelFrameworkPkg/Include/Framework/DxeCis.h
@@ -1,36 +1,40 @@
 /** @file\r
   Include file for definitions in the Intel Platform Innovation Framework for EFI\r
-  Driver Execution Environment Core Interface Specification (DXE CIS) Version 0.9.\r
+  Driver Execution Environment Core Interface Specification (DXE CIS) Version 0.91.\r
 \r
-  Copyright (c) 2007 - 2009, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials\r
-  are licensed and made available under the terms and conditions of the BSD License\r
-  which accompanies this distribution.  The full text of the license may be found at\r
-  http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2007 - 2018, 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
+http://opensource.org/licenses/bsd-license.php.\r
 \r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
 \r
-#ifndef _DXE_CIS_H_\r
-#define _DXE_CIS_H_\r
+#ifndef _DXECIS_H_\r
+#define _DXECIS_H_\r
 \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   The 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
+/// The Framework EFI Runtime Services Table as an extension to the EFI 1.10 Runtime Services Table.\r
+///\r
 typedef struct {\r
   //\r
   // Table header for the Framework EFI Runtime Services Table\r
@@ -59,15 +63,15 @@ 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
+  /// A Framework extension to the EFI 1.10 runtime table.\r
+  /// It was moved to a protocol to avoid conflict with UEFI 2.0.\r
+  ///\r
   EFI_REPORT_STATUS_CODE            ReportStatusCode;\r
 } FRAMEWORK_EFI_RUNTIME_SERVICES;\r
 \r
 ///\r
-/// Framework EFI Boot Services Table which comply with DxeCis spec.\r
+/// The Framework EFI Boot Services Table. Complies with the DxeCis specification.\r
 ///\r
 typedef struct {\r
   ///\r