Committing changes to the comments, after review with engineers.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / SmmControl.h

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmControl.h b/IntelFrameworkPkg/Include/Protocol/SmmControl.h
index 1097179b4d6cb55ea08998b3a9026c80e73e278e..685c716c46d81224afebc03b78e9ed67c96e7c7c 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmControl.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmControl.h
@@ -1,12 +1,11 @@
 /** @file\r
-  This file declares SMM Control abstraction protocol.\r
-  This protocol is used initiate SMI/PMI activations. This protocol could be published by either of\r
-  the following:\r
+  This file declares the SMM Control abstraction protocol.\r
+  This protocol is used to initiate SMI/PMI activations. This protocol could be published by either:\r
   - A processor driver to abstract the SMI/PMI IPI\r
   - The driver that abstracts the ASIC that is supporting the APM port, such as the ICH in an\r
   Intel chipset\r
   Because of the possibility of performing SMI or PMI IPI transactions, the ability to generate this\r
-  event from a platform chipset agent is an optional capability for both IA-32 and Itanium based\r
+  event from a platform chipset agent is an optional capability for both IA-32 and Itanium-based\r
   systems.\r
 \r
   Copyright (c) 2007,2009 Intel Corporation\r
@@ -18,8 +17,6 @@
   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
-  Module Name:  SmmControl.h\r
-\r
   @par Revision Reference:\r
   This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
   Version 0.9.\r
@@ -29,7 +26,6 @@
 #ifndef _SMM_CONTROL_H_\r
 #define _SMM_CONTROL_H_\r
 \r
-#include <PiDxe.h>\r
 \r
 typedef struct _EFI_SMM_CONTROL_PROTOCOL              EFI_SMM_CONTROL_PROTOCOL;\r
 \r
@@ -62,7 +58,7 @@ typedef struct {
   @param  This                  The EFI_SMM_CONTROL_PROTOCOL instance.\r
   @param  ArgumentBuffer        Optional sized data to pass into the protocol activation.\r
   @param  ArgumentBufferSize    Optional size of the data.\r
-  @param  Periodic              Optional mechanism to engender a periodic stream.\r
+  @param  Periodic              Optional mechanism to periodically repeat activation.\r
   @param  ActivationInterval    Optional parameter to repeat at this period one\r
                                 time or, if the Periodic Boolean is set, periodically.\r
 \r
@@ -121,7 +117,7 @@ EFI_STATUS
 \r
 /**\r
   @par Protocol Description:\r
-  This protocol is used initiate SMI/PMI activations.\r
+  This protocol is used to initiate SMI/PMI activations.\r
 \r
   @param Trigger\r
   Initiates the SMI/PMI activation.\r
@@ -142,17 +138,17 @@ EFI_STATUS
 // SMM Control Protocol\r
 //\r
 /**\r
-  This protocol is used initiate SMI/PMI activations. \r
-  This protocol could be published by either of the following:\r
+  This protocol is used to initiate SMI/PMI activations. \r
+  This protocol could be published by either:\r
     - A processor driver to abstract the SMI/PMI IPI\r
-    - The driver that abstracts the ASIC that is supporting the APM port, such as the ICH in an Intel® chipset\r
+    - The driver that abstracts the ASIC that is supporting the APM port, such as the ICH in an Intel chipset\r
   Because of the possibility of performing SMI or PMI IPI transactions, the ability to generate this\r
   \r
   The EFI_SMM_CONTROL_PROTOCOL is used by the platform chipset or processor driver. This\r
-  protocol is useable both in boot services and runtime. The runtime aspect is so that an\r
-  implementation of EFI_SMM_BASE_PROTOCOL.Communicate() can layer upon this service\r
+  protocol is usable both in boot services and at runtime. The runtime aspect enables an\r
+  implementation of EFI_SMM_BASE_PROTOCOL.Communicate() to layer upon this service\r
   and provide an SMI callback from a general EFI runtime driver.\r
-  The purpose of this protocol is to provide an abstraction to the platform hardware that generates an\r
+  This protocol provides an abstraction to the platform hardware that generates an\r
   SMI or PMI. There are often I/O ports that, when accessed, will engender the\r
 **/\r
 struct _EFI_SMM_CONTROL_PROTOCOL {\r