Committing changes to the comments, after review with engineers.

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

diff --git a/IntelFrameworkPkg/Include/Framework/SmmCis.h b/IntelFrameworkPkg/Include/Framework/SmmCis.h
index b580dbe6396fffe8dea4777745bf338beab02b21..708e4b1c59ba2f25ab7499d370b6cd1abe3483b8 100644 (file)
--- a/IntelFrameworkPkg/Include/Framework/SmmCis.h
+++ b/IntelFrameworkPkg/Include/Framework/SmmCis.h
@@ -51,8 +51,8 @@ typedef enum {
   @param  Width            Signifies the width of the I/O operations.\r
   @param  Address          The base address of the I/O operations.\r
   @param  Count            The number of I/O operations to perform.\r
-  @param  Buffer           For read operations, the destination buffer to store the results.\r
-                           For write operations, the source buffer from which to write data.\r
+  @param  Buffer           For read operations, the destination buffer to store the results (out parameter).\r
+                           For write operations, the source buffer from which to write data (in parameter).\r
 \r
   @retval EFI_SUCCESS           The data was read from or written to the device.\r
   @retval EFI_UNSUPPORTED       The Address is not valid for this system.\r
@@ -94,7 +94,7 @@ struct _EFI_SMM_CPU_IO_INTERFACE {
   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 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
@@ -123,8 +123,8 @@ EFI_STATUS
   @retval EFI_INVALID_PARAMETER Buffer was invalid.\r
   @retval EFI_UNSUPPORTED       In runtime.\r
   @note: Inconsistent with specification here:\r
-         In Framework Spec, This definition is naming EFI_SMM_FREE_POOL However, \r
-         To avoid the naming conflict, the definition is renamed.\r
+         In the Framework Spec, this definition is named EFI_SMM_FREE_POOL.  \r
+         To avoid a naming conflict, the definition here is renamed. \r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -148,8 +148,8 @@ EFI_STATUS
   @retval EFI_INVALID_PARAMETER Type is not AllocateAnyPages or AllocateMaxAddress\r
                                 or AllocateAddress. Or MemoryType is in the range EfiMaxMemoryType..0x7FFFFFFF.\r
   @note: Inconsistent with specification here:\r
-         In Framework Spec, This definition is naming EFI_SMM_ALLOCATE_PAGES However, \r
-         To avoid the naming conflict, the definition is renamed.\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
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -171,8 +171,8 @@ EFI_STATUS
   @retval EFI_NOT_FOUND         The requested memory pages were not allocated with SmmAllocatePages().\r
   \r
   @note: Inconsistent with specification here:\r
-         In Framework Spec, This definition is naming EFI_SMM_FREE_PAGES However, \r
-         To avoid the naming conflict, the definition is renamed.\r
+         In the Framework Spec, this definition is named EFI_SMM_FREE_PAGES.  \r
+         To avoid a naming conflict, the definition here is renamed.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -197,8 +197,8 @@ EFI_STATUS
   @retval EFI_INVALID_PARAMETER The CPU cannot support an additional service invocation.\r
   \r
   @note: Inconsistent with specification here:\r
-         In Framework Spec, No this definition. This method is introduced in PI1.0 spec for \r
-         implementation needed.\r
+         In Framework Spec, this definition does not exist. This method is introduced in PI1.0 spec for \r
+         implementation needs.\r
          \r
 **/\r
 typedef\r
@@ -592,7 +592,7 @@ struct _EFI_SMM_SYSTEM_TABLE {
   //\r
   \r
   ///Inconsistent with specification here:\r
-  ///  In Framework Spec, No this definition. This method is introduced in PI1.0 spec for \r
+  ///  In Framework Spec, this definition does not exist. This method is introduced in PI1.0 spec for \r
   ///  implementation needed.\r
   EFI_SMM_STARTUP_THIS_AP             SmmStartupThisAp;\r
 \r