Remove IntelFrameworkModulePkg

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

/** @file\r
  Provides the parent dispatch service for the USB SMI source generator.\r
\r
Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Revision Reference:\r
  This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
  Version 0.9.\r
\r
**/\r
\r
#ifndef _EFI_SMM_USB_DISPATCH_H_\r
#define _EFI_SMM_USB_DISPATCH_H_\r
\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
//\r
#define EFI_SMM_USB_DISPATCH_PROTOCOL_GUID \\r
  { \\r
    0xa05b6ffd, 0x87af, 0x4e42, {0x95, 0xc9, 0x62, 0x28, 0xb6, 0x3c, 0xf3, 0xf3 } \\r
  }\r
\r
typedef struct _EFI_SMM_USB_DISPATCH_PROTOCOL  EFI_SMM_USB_DISPATCH_PROTOCOL;\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
//\r
// Member functions\r
//\r
/**\r
  Dispatch function for a USB SMI handler.\r
\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
\r
**/\r
typedef\r
VOID\r
(EFIAPI *EFI_SMM_USB_DISPATCH)(\r
  IN  EFI_HANDLE                    DispatchHandle,\r
  IN  EFI_SMM_USB_DISPATCH_CONTEXT  *DispatchContext\r
  );\r
\r
/**\r
  Register a child SMI source dispatch function with a parent SMM driver.\r
\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   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    The 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
  @retval EFI_DEVICE_ERROR      The driver was unable to enable the SMI source.\r
  @retval EFI_OUT_OF_RESOURCES  Not enough memory (system or SMM) to manage this\r
                                child.\r
  @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The USB SMI type\r
                                is not within valid range.\r
\r
**/\r
typedef\r
EFI_STATUS\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
  OUT EFI_HANDLE                              *DispatchHandle\r
  );\r
\r
/**\r
  Unregisters a USB service.\r
\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
                                if there are no other registered child dispatch\r
                                functions for this SMI source.\r
  @retval EFI_INVALID_PARAMETER The DispatchHandle was not valid.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_SMM_USB_UNREGISTER)(\r
  IN EFI_SMM_USB_DISPATCH_PROTOCOL            *This,\r
  IN EFI_HANDLE                               DispatchHandle\r
  );\r
\r
///\r
/// The EFI_SMM_USB_DISPATCH_PROTOCOL provides the ability to install child handlers for the\r
/// given event types.\r
///\r
struct _EFI_SMM_USB_DISPATCH_PROTOCOL {\r
  EFI_SMM_USB_REGISTER    Register;\r
  EFI_SMM_USB_UNREGISTER  UnRegister;\r
};\r
\r
extern EFI_GUID gEfiSmmUsbDispatchProtocolGuid;\r
\r
#endif\r