Update the copyright notice format

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
index e4cf74219cb9693865421b12c72c2e6767db81ce..c3e08132105e5243b2d9a334bcd5ae2c9d5fba26 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
-\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
+Copyright (c) 2007 - 2010, 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
 \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,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
@@ -78,15 +73,15 @@ VOID
 /**\r
   Register a child SMI source dispatch function with a parent SMM driver.\r
 \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
+  @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[in]  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[out] 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
@@ -110,7 +105,7 @@ EFI_STATUS
 /**\r
   Unregisters a USB service.\r
 \r
-  @param[in]  This              Pointer to the EFI_SMM_USB_DISPATCH_PROTOCOL instance.\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