Rename PI SMM definitions which has same name with those of Framework SMM spec but...

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
index b37171851bce6cbfbed10997be973276a968372b..e72ce6668703d955c39f631b1d15f0fdd4bb01fd 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
@@ -19,7 +19,10 @@
 #ifndef _EFI_SMM_USB_DISPATCH_H_\r
 #define _EFI_SMM_USB_DISPATCH_H_\r
 \r
-#include <PiDxe.h>\r
+//\r
+// Share some common definitions with PI SMM\r
+//\r
+#include <Protocol/SmmUsbDispatch2.h>\r
 \r
 //\r
 // Global ID for the USB Protocol\r
@@ -31,14 +34,6 @@
 \r
 typedef struct _EFI_SMM_USB_DISPATCH_PROTOCOL  EFI_SMM_USB_DISPATCH_PROTOCOL;\r
 \r
-//\r
-// Related Definitions\r
-//\r
-typedef enum {\r
-  UsbLegacy,\r
-  UsbWake\r
-} EFI_USB_SMI_TYPE;\r
-\r
 typedef struct {\r
   ///\r
   /// Describes whether this child handler will be invoked in response to a USB legacy\r
@@ -61,8 +56,8 @@ typedef struct {
 /**\r
   Dispatch function for a USB SMI handler.\r
 \r
-  @param  DispatchHandle        Handle of this dispatch function.\r
-  @param  DispatchContext       Pointer to the dispatch function's context.\r
+  @param[in]  DispatchHandle    Handle of this dispatch function.\r
+  @param[in]  DispatchContext   Pointer to the dispatch function's context.\r
                                 The DispatchContext fields are filled in\r
                                 by the dispatching driver prior to\r
                                 invoking this dispatch function.\r
@@ -78,15 +73,15 @@ VOID
 /**\r
   Register a child SMI source dispatch function with a parent SMM driver.\r
 \r
-  @param  This                  Pointer to the EFI_SMM_USB_DISPATCH_PROTOCOL instance.\r
-  @param  DispatchFunction      Pointer to dispatch function to be invoked \r
+  @param[in]  This              Pointer to the EFI_SMM_USB_DISPATCH_PROTOCOL instance.\r
+  @param[in]  DispatchFunction  Pointer to dispatch function to be invoked \r
                                 for this SMI source.\r
-  @param  DispatchContext       Pointer to the dispatch function's context.\r
+  @param[in]  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
                                 function the USB SMI types for which the dispatch\r
                                 function should be invoked.\r
-  @param  DispatchHandle        Handle generated by the dispatcher to track the \r
+  @param[out] DispatchHandle    Handle generated by the dispatcher to track the \r
                                 function instance.\r
 \r
   @retval EFI_SUCCESS           The dispatch function has been successfully\r
@@ -110,8 +105,8 @@ EFI_STATUS
 /**\r
   Unregisters a USB service.\r
 \r
-  @param  This                  Pointer to the EFI_SMM_USB_DISPATCH_PROTOCOL instance.\r
-  @param  DispatchHandle        Handle of the service to remove.\r
+  @param[in]  This              Pointer to the EFI_SMM_USB_DISPATCH_PROTOCOL instance.\r
+  @param[in]  DispatchHandle    Handle of the service to remove.\r
 \r
   @retval EFI_SUCCESS           The dispatch function has been successfully\r
                                 unregistered and the SMI source has been disabled\r
@@ -124,7 +119,7 @@ typedef
 EFI_STATUS\r
 (EFIAPI *EFI_SMM_USB_UNREGISTER)(\r
   IN EFI_SMM_USB_DISPATCH_PROTOCOL            *This,\r
-  IN  EFI_HANDLE                              DispatchHandle\r
+  IN EFI_HANDLE                               DispatchHandle\r
   );\r
 \r
 ///\r