MdePkg/Include/Protocol/SmmUsbDispatch2.h File Reference


Data Structures

struct  EFI_SMM_USB_REGISTER_CONTEXT
struct  _EFI_SMM_USB_DISPATCH2_PROTOCOL

Defines

#define EFI_SMM_USB_DISPATCH2_PROTOCOL_GUID

Typedefs

typedef struct
_EFI_SMM_USB_DISPATCH2_PROTOCOL 
EFI_SMM_USB_DISPATCH2_PROTOCOL
typedef EFI_STATUS(EFIAPI * EFI_SMM_USB_REGISTER2 )(IN CONST EFI_SMM_USB_DISPATCH2_PROTOCOL *This, IN EFI_SMM_HANDLER_ENTRY_POINT2 DispatchFunction, IN CONST EFI_SMM_USB_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle)
typedef EFI_STATUS(EFIAPI * EFI_SMM_USB_UNREGISTER2 )(IN CONST EFI_SMM_USB_DISPATCH2_PROTOCOL *This, IN EFI_HANDLE DispatchHandle)

Enumerations

enum  EFI_USB_SMI_TYPE { UsbLegacy, UsbWake }

Variables

EFI_GUID gEfiSmmUsbDispatch2ProtocolGuid

Detailed Description

SMM USB Dispatch2 Protocol as defined in PI 1.1 Specification Volume 4 System Management Mode Core Interface.

Provides the parent dispatch service for the USB SMI source generator.

Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Revision Reference:
This protocol is from PI Version 1.1.

Define Documentation

#define EFI_SMM_USB_DISPATCH2_PROTOCOL_GUID

Value:

{ \
    0xee9b8d90, 0xc5a6, 0x40a2, {0xbd, 0xe2, 0x52, 0x55, 0x8d, 0x33, 0xcc, 0xa1 } \
  }


Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_SMM_USB_REGISTER2)(IN CONST EFI_SMM_USB_DISPATCH2_PROTOCOL *This, IN EFI_SMM_HANDLER_ENTRY_POINT2 DispatchFunction, IN CONST EFI_SMM_USB_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle)

Provides the parent dispatch service for the USB SMI source generator.

This service registers a function (DispatchFunction) which will be called when the USB- related SMI specified by RegisterContext has occurred. On return, DispatchHandle contains a unique handle which may be used later to unregister the function using UnRegister(). The DispatchFunction will be called with Context set to the same value as was passed into this function in RegisterContext and with CommBuffer containing NULL and CommBufferSize containing zero.

Parameters:
[in] This Pointer to the EFI_SMM_USB_DISPATCH2_PROTOCOL instance.
[in] DispatchFunction Function to register for handler when a USB-related SMI occurs.
[in] RegisterContext Pointer to the dispatch function's context. The caller fills this context in before calling the register function to indicate to the register function the USB SMI types for which the dispatch function should be invoked.
[out] DispatchHandle Handle generated by the dispatcher to track the function instance.
Return values:
EFI_SUCCESS The dispatch function has been successfully registered and the SMI source has been enabled.
EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
EFI_INVALID_PARAMETER RegisterContext is invalid. The USB SMI type is not within valid range.
EFI_OUT_OF_RESOURCES There is not enough memory (system or SMM) to manage this child.

typedef EFI_STATUS(EFIAPI * EFI_SMM_USB_UNREGISTER2)(IN CONST EFI_SMM_USB_DISPATCH2_PROTOCOL *This, IN EFI_HANDLE DispatchHandle)

Unregisters a USB service.

This service removes the handler associated with DispatchHandle so that it will no longer be called when the USB event occurs.

Parameters:
[in] This Pointer to the EFI_SMM_USB_DISPATCH2_PROTOCOL instance.
[in] DispatchHandle Handle of the service to remove.
Return values:
EFI_SUCCESS The dispatch function has been successfully unregistered and the SMI source has been disabled if there are no other registered child dispatch functions for this SMI source.
EFI_INVALID_PARAMETER The DispatchHandle was not valid.


Enumeration Type Documentation

USB SMI event types

Enumerator:
UsbLegacy 
UsbWake 


Variable Documentation


Generated on Wed Sep 23 16:24:24 2015 for MdePkg[ALL] by  doxygen 1.5.7.1