/** @file\r
- This file declares EFI Smm USB Smi Child Protocol.\r
+ Provides the parent dispatch service for the USB SMI source generator.\r
\r
Copyright (c) 2007, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
#ifndef _EFI_SMM_USB_DISPATCH_H_\r
#define _EFI_SMM_USB_DISPATCH_H_\r
\r
+#include <PiDxe.h>\r
+\r
//\r
// Global ID for the USB Protocol\r
//\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
+ ///\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
by the dispatching driver prior to\r
invoking this dispatch function.\r
\r
- Nothing\r
+ @return None\r
\r
**/\r
typedef\r
VOID\r
-(EFIAPI *EFI_SMM_USB_DISPATCH) (\r
+(EFIAPI *EFI_SMM_USB_DISPATCH)(\r
IN EFI_HANDLE DispatchHandle,\r
IN EFI_SMM_USB_DISPATCH_CONTEXT *DispatchContext\r
);\r
/**\r
Register a child SMI source dispatch function with a parent SMM driver\r
\r
- @param This Protocol instance pointer.\r
- @param DispatchFunction Pointer to dispatch function to be invoked for\r
- this SMI source\r
+ @param This Pointer to the EFI_SMM_USB_DISPATCH_PROTOCOL instance.\r
+ @param DispatchFunction Pointer to dispatch function to be invoked \r
+ for this SMI source.\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
function the USB SMI types for which the dispatch\r
function should be invoked.\r
- @param DispatchHandle Handle of dispatch function, for when interfacing\r
- with the parent Sx state SMM driver.\r
+ @param DispatchHandle Handle generated by the dispatcher to track the \r
+ function instance.\r
\r
@retval EFI_SUCCESS The dispatch function has been successfully\r
registered and the SMI source has been enabled.\r
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMM_USB_REGISTER) (\r
+(EFIAPI *EFI_SMM_USB_REGISTER)(\r
IN EFI_SMM_USB_DISPATCH_PROTOCOL *This,\r
IN EFI_SMM_USB_DISPATCH DispatchFunction,\r
IN EFI_SMM_USB_DISPATCH_CONTEXT *DispatchContext,\r
);\r
\r
/**\r
- Unregister a child SMI source dispatch function with a parent SMM driver\r
+ Unregisters a USB service\r
\r
- @param This Protocol instance pointer.\r
- @param DispatchHandle Handle of dispatch function to deregister.\r
+ @param This Pointer to the EFI_SMM_USB_DISPATCH_PROTOCOL instance.\r
+ @param 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
**/\r
typedef\r
EFI_STATUS\r
-(EFIAPI *EFI_SMM_USB_UNREGISTER) (\r
+(EFIAPI *EFI_SMM_USB_UNREGISTER)(\r
IN EFI_SMM_USB_DISPATCH_PROTOCOL *This,\r
IN EFI_HANDLE DispatchHandle\r
);\r