Synchronize code with specs.

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
index 5887951e98debb9832182e0333eacc5721f5c344..c2f70aceebaa73be3aeeec6b9f22f221b94c0f3a 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
@@ -41,7 +41,18 @@ typedef enum {
 } 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
+  ///\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
+  ///\r
   EFI_DEVICE_PATH_PROTOCOL  *Device;\r
 } EFI_SMM_USB_DISPATCH_CONTEXT;\r
 \r