Clarify @pram b in Base.h. Accepted and edited in Qing Huang changes for @retval...

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
index 938d3725decd6b32f4adca3673ff3bdb15ac7573..fd65f77b368eb86152b9cb659b7a61ba93315f19 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
@@ -19,6 +19,10 @@
 #ifndef _EFI_SMM_SX_DISPATCH_H_\r
 #define _EFI_SMM_SX_DISPATCH_H_\r
 \r
+//\r
+// Share some common definitions with PI SMM\r
+//\r
+#include <Protocol/SmmSxDispatch2.h>\r
 \r
 //\r
 // Global ID for the Sx SMI Protocol\r
@@ -29,24 +33,6 @@
   }\r
 \r
 typedef struct _EFI_SMM_SX_DISPATCH_PROTOCOL  EFI_SMM_SX_DISPATCH_PROTOCOL;\r
-//\r
-// Related Definitions\r
-//\r
-typedef enum {\r
-  SxS0,\r
-  SxS1,\r
-  SxS2,\r
-  SxS3,\r
-  SxS4,\r
-  SxS5,\r
-  EfiMaximumSleepType\r
-} EFI_SLEEP_TYPE;\r
-\r
-typedef enum {\r
-  SxEntry,\r
-  SxExit,\r
-  EfiMaximumPhase\r
-} EFI_SLEEP_PHASE;\r
 \r
 typedef struct {\r
   EFI_SLEEP_TYPE  Type;\r
@@ -83,15 +69,15 @@ VOID
   @param  This                  Pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.\r
   @param  DispatchFunction      Function to install.\r
   @param  DispatchContext       Pointer to the dispatch function's context.\r
-                                The caller fills this context in before calling\r
-                                the register function to indicate to the register\r
+                                The caller fills in this context before calling\r
+                                the register function to indicates to the register\r
                                 function which Sx state type and phase the caller\r
-                                wishes to be called back on. For this intertace,\r
+                                wishes to be called back on. For this interface,\r
                                 the Sx driver will call the registered handlers for\r
                                 all Sx type and phases, so the Sx state handler(s)\r
                                 must check the Type and Phase field of the Dispatch\r
                                 context and act accordingly.\r
-  @param  DispatchHandle        Handle of dispatch function, for when interfacing\r
+  @param  DispatchHandle        Handle of dispatch function, for interfacing\r
                                 with the parent Sx state SMM driver.\r
 \r
   @retval EFI_SUCCESS           The dispatch function has been successfully\r