update comments to allign with spec

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmBase.h b/IntelFrameworkPkg/Include/Protocol/SmmBase.h
index 69cd2b8f295260e6a097950a58a8f7261d006450..e21b495eb6f24305de980841b576312f9b756a3b 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmBase.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmBase.h
@@ -87,9 +87,11 @@ EFI_STATUS
   @param  SourceBuffer          Optional source buffer in case of the image file\r
                                 being in memory.\r
   @param  SourceSize            Size of the source image file, if in memory.\r
-  @param  ImageHandle           Pointer to the handle that reflects the driver\r
-                                loaded into SMM.\r
-  @param  LegacyIA32Binary      The binary image to load is legacy 16 bit code.\r
+  @param  ImageHandle           The handle that the base driver uses to decode \r
+                                the handler. Unique among SMM handlers only, \r
+                                not unique across DXE/EFI.\r
+  @param  LegacyIA32Binary      An optional parameter that details that the associated \r
+                                file is a real-mode IA-32 binary.\r
 \r
   @retval EFI_SUCCESS           The operation was successful.\r
   @retval EFI_OUT_OF_RESOURCES  There were no additional SMRAM resources to load the handler\r
@@ -110,12 +112,11 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Remove a given driver SMRAM.  This is the equivalent of performing\r
-  the UnloadImage System Management Mode.\r
+  Removes a handler from execution within SMRAM.  This is the equivalent of performing\r
+  the UnloadImage in System Management Mode.\r
 \r
   @param  This                  Protocol instance pointer.\r
-  @param  ImageHandle           Pointer to the handle that reflects the driver\r
-                                loaded into SMM.\r
+  @param  ImageHandle           The handler to be removed.\r
 \r
   @retval EFI_SUCCESS           The operation was successful\r
   @retval EFI_INVALID_PARAMETER The handler did not exist\r
@@ -133,13 +134,12 @@ EFI_STATUS
   The SMM Inter-module Communicate Service Communicate() function\r
   provides a services to send/received messages from a registered\r
   EFI service.  The BASE protocol driver is responsible for doing\r
-  any of the copies such that the data lives in boot-service accessible RAM.\r
+  any of the copies such that the data lives in boot-service-accessible RAM.\r
 \r
   @param  This                  Protocol instance pointer.\r
-  @param  ImageHandle           Pointer to the handle that reflects the driver\r
-                                loaded into SMM.\r
+  @param  ImageHandle           The handle of the registered driver.\r
   @param  CommunicationBuffer   Pointer to the buffer to convey into SMRAM.\r
-  @param  SourceSize            Size of the contents of buffer..\r
+  @param  SourceSize            The size of the data buffer being passed in.\r
 \r
   @retval EFI_SUCCESS           The message was successfully posted\r
   @retval EFI_INVALID_PARAMETER The buffer was NULL\r
@@ -156,14 +156,13 @@ EFI_STATUS
 \r
 /**\r
   Register a callback to execute within SMM.\r
-  This allows receipt of messages created with the Boot Service COMMUNICATE.\r
+  This allows receipt of messages created with EFI_SMM_BASE_PROTOCOL.Communicate().\r
 \r
   @param  This                  Protocol instance pointer.\r
-  @param  CallbackAddress       Address of the callback service\r
-  @param  MakeFirst             If present, will stipulate that the handler is posted\r
-                                to be the first module executed in the dispatch table.\r
-  @param  MakeLast              If present, will stipulate that the handler is posted\r
-                                to be last executed in the dispatch table.\r
+  @param  SmmImageHandle        Handle of the callback service.\r
+  @param  CallbackAddress       Address of the callback service.\r
+  @param  MakeLast              If present, will stipulate that the handler is posted to \r
+                                be executed last in the dispatch table.\r
   @param  FloatingPointSave     This is an optional parameter which informs the\r
                                 EFI_SMM_ACCESS_PROTOCOL Driver core if it needs to save\r
                                 the floating point register state. If any of the handlers\r
@@ -172,7 +171,7 @@ EFI_STATUS
   @retval EFI_SUCCESS           The operation was successful\r
   @retval EFI_OUT_OF_RESOURCES  Not enough space in the dispatch queue\r
   @retval EFI_UNSUPPORTED       In runtime.\r
-  @retval EFI_UNSUPPORTED       Not in SMM.\r
+  @retval EFI_UNSUPPORTED       The caller is not in SMM.\r
 \r
 **/\r
 typedef\r
@@ -194,7 +193,9 @@ EFI_STATUS
   @param  This                  Protocol instance pointer.\r
   @param  PoolType              The type of pool to allocate.\r
                                 The only supported type is EfiRuntimeServicesData;\r
-                                the interface will internally map this runtime request to SMRAM.\r
+                                the interface will internally map this runtime request to \r
+                                SMRAM for IA-32 and leave as this type for the Itanium \r
+                                processor family. Other types can be ignored.\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