Grammatical and disclaimer changes (does not follow internal C coding stds.)

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

diff --git a/IntelFrameworkPkg/Include/Framework/SmmCis.h b/IntelFrameworkPkg/Include/Framework/SmmCis.h
index 5ad5d56eb98a61125e1189e26d9a6ac4377aad11..4ac9926a98cf7d7b62ed5fb65240eb5c906b5b39 100644 (file)
--- a/IntelFrameworkPkg/Include/Framework/SmmCis.h
+++ b/IntelFrameworkPkg/Include/Framework/SmmCis.h
@@ -2,14 +2,14 @@
   Include file for definitions in the Intel Platform Innovation Framework for EFI\r
   System Management Mode Core Interface Specification (SMM CIS) version 0.91.\r
 \r
-  Copyright (c) 2007 - 2010, 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
 **/\r
 \r
@@ -30,13 +30,14 @@ typedef struct _EFI_SMM_SYSTEM_TABLE      EFI_SMM_SYSTEM_TABLE;
 #define EFI_SMM_SYSTEM_TABLE_REVISION (0 << 16) | (0x09)\r
 \r
 /**\r
-  Allocates pool memory from SMRAM for IA-32 or runtime memory for\r
+  Allocates pool memory from SMRAM for IA-32, or runtime memory for\r
   the Itanium processor family.\r
 \r
-  @param  PoolType         The type of pool to allocate. The only supported type is EfiRuntimeServicesData\r
+  @param  PoolType         The type of pool to allocate. The only supported type \r
+                           is EfiRuntimeServicesData.\r
   @param  Size             The number of bytes to allocate from the pool.\r
-  @param  Buffer           A pointer to a pointer to the allocated buffer if the call\r
-                           succeeds; undefined otherwise.\r
+  @param  Buffer           A pointer to a pointer to the allocated buffer if the \r
+                           call succeeds.  Otherwise, undefined.\r
 \r
   @retval EFI_SUCCESS           The requested number of bytes was allocated.\r
   @retval EFI_OUT_OF_RESOURCES  The pool requested could not be allocated.\r
@@ -56,7 +57,7 @@ EFI_STATUS
 /**\r
   Returns pool memory to the system.\r
 \r
-  @param  Buffer           Pointer to the buffer to free.\r
+  @param  Buffer           The pointer to the buffer to free.\r
 \r
   @retval EFI_SUCCESS           The memory was returned to the system.\r
   @retval EFI_INVALID_PARAMETER Buffer was invalid.\r
@@ -75,8 +76,8 @@ EFI_STATUS
   Allocates memory pages from the system.\r
 \r
   @param  Type             The type of allocation to perform.\r
-  @param  MemoryType       The only supported type is EfiRuntimeServicesData\r
-  @param  NumberofPages    The number of contiguous 4 KB pages to allocate\r
+  @param  MemoryType       The only supported type is EfiRuntimeServicesData.\r
+  @param  NumberofPages    The number of contiguous 4 KB pages to allocate.\r
   @param  Memory           Pointer to a physical address. On input, the way in which\r
                            the address is used depends on the value of Type. On output, the address\r
                            is set to the base of the page range that was allocated.\r
@@ -85,7 +86,7 @@ EFI_STATUS
   @retval EFI_OUT_OF_RESOURCES  The pages requested could not be allocated.\r
   @retval EFI_NOT_FOUND         The requested pages could not be found.\r
   @retval EFI_INVALID_PARAMETER Type is not AllocateAnyPages or AllocateMaxAddress\r
-                                or AllocateAddress. Or MemoryType is in the range EfiMaxMemoryType..0x7FFFFFFF.\r
+                                or AllocateAddress. Or, MemoryType is in the range EfiMaxMemoryType..0x7FFFFFFF.\r
   @note  Inconsistent with specification here:\r
          In the Framework Spec, this definition is named EFI_SMM_ALLOCATE_PAGES.  \r
          To avoid a naming conflict, the definition here is renamed.\r
@@ -102,7 +103,7 @@ EFI_STATUS
 /**\r
   Frees memory pages for the system.\r
 \r
-  @param  Memory           The base physical address of the pages to be freed\r
+  @param  Memory           The base physical address of the pages to be freed.\r
   @param  NumberOfPages    The number of contiguous 4 KB pages to free.\r
 \r
   @retval EFI_SUCCESS           The requested memory pages were freed.\r
@@ -502,9 +503,9 @@ struct _EFI_SMM_SYSTEM_TABLE {
   // MP service\r
   //\r
   \r
-  ///Inconsistent with specification here:\r
-  ///  In Framework Spec, this definition does not exist. This method is introduced in PI1.1 spec for \r
-  ///  implementation needed.\r
+  /// Inconsistent with specification here:\r
+  ///  In Framework Spec, this definition does not exist. This method is introduced in PI1.1 specification for \r
+  ///  the implementation needed.\r
   EFI_SMM_STARTUP_THIS_AP             SmmStartupThisAp;\r
 \r
   //\r