BaseTools/Capsule: Do not support -o with --dump-info

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
index 7993b724f2b81f7e232ade1c929956ebd7318682..9bdbe00588ee6fb257f008b6742cfdce9e844d08 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
@@ -1,14 +1,14 @@
 /** @file\r
   Provides the parent dispatch service for the USB SMI source generator.\r
 \r
-  Copyright (c) 2007 - 2009, 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
+Copyright (c) 2007 - 2018, 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
+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
   @par Revision Reference:\r
   This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
@@ -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,26 +34,18 @@
 \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
   /// emulation event, such as port-trap on the PS/2* keyboard control registers, or to a\r
-  /// USB wake event, such as resumption from a sleep state. \r
+  /// USB wake event, such as resumption from a sleep state.\r
   ///\r
   EFI_USB_SMI_TYPE          Type;\r
   ///\r
   /// The device path is part of the context structure and describes the location of the\r
   /// particular USB host controller in the system for which this register event will occur.\r
   /// This location is important because of the possible integration of several USB host\r
-  /// controllers in a system. \r
+  /// controllers in a system.\r
   ///\r
   EFI_DEVICE_PATH_PROTOCOL  *Device;\r
 } EFI_SMM_USB_DISPATCH_CONTEXT;\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              The pointer to the EFI_SMM_USB_DISPATCH_PROTOCOL instance.\r
+  @param[in]  DispatchFunction  The 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   The 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    The handle generated by the dispatcher to track the\r
                                 function instance.\r
 \r
   @retval EFI_SUCCESS           The dispatch function has been successfully\r
@@ -101,7 +96,7 @@ VOID
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_SMM_USB_REGISTER)(\r
-  IN EFI_SMM_USB_DISPATCH_PROTOCOL            *This,\r
+  IN  EFI_SMM_USB_DISPATCH_PROTOCOL           *This,\r
   IN  EFI_SMM_USB_DISPATCH                    DispatchFunction,\r
   IN  EFI_SMM_USB_DISPATCH_CONTEXT            *DispatchContext,\r
   OUT EFI_HANDLE                              *DispatchHandle\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              The 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