Update the copyright notice format

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmControl.h b/IntelFrameworkPkg/Include/Protocol/SmmControl.h
index 685c716c46d81224afebc03b78e9ed67c96e7c7c..d49831ca905fc376a4cd4490c8656f0d487056de 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmControl.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmControl.h
@@ -8,14 +8,14 @@
   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
-  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
-\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
+Copyright (c) 2007 - 2010, 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
 \r
   @par Revision Reference:\r
   This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
@@ -56,10 +56,10 @@ typedef struct {
   Invokes SMI activation from either the preboot or runtime environment.\r
 \r
   @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 periodically repeat activation.\r
-  @param  ActivationInterval    Optional parameter to repeat at this period one\r
+  @param  ArgumentBuffer        The optional sized data to pass into the protocol activation.\r
+  @param  ArgumentBufferSize    The optional size of the data.\r
+  @param  Periodic              An optional mechanism to periodically repeat activation.\r
+  @param  ActivationInterval    An optional parameter to repeat at this period one\r
                                 time or, if the Periodic Boolean is set, periodically.\r
 \r
   @retval EFI_SUCCESS           The SMI/PMI has been engendered.\r
@@ -101,7 +101,7 @@ EFI_STATUS
   Provides information on the source register used to generate the SMI.\r
 \r
   @param  This                  The EFI_SMM_CONTROL_PROTOCOL instance.\r
-  @param  SmiRegister           Pointer to the SMI register description structure\r
+  @param  SmiRegister           A pointer to the SMI register description structure.\r
 \r
   @retval EFI_SUCCESS           The register structure has been returned.\r
   @retval EFI_DEVICE_ERROR      The source could not be cleared.\r
@@ -140,16 +140,18 @@ EFI_STATUS
 /**\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
-  Because of the possibility of performing SMI or PMI IPI transactions, the ability to generate this\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
+  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 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
   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
+  SMI or PMI. There are often I/O ports that, when accessed, will engender the SMI or PMI.\r
+  Also, this hardware optionally supports the periodic genearation of these signals.\r
+\r
 **/\r
 struct _EFI_SMM_CONTROL_PROTOCOL {\r
   ///\r