MmUsbDispatch.h File Reference

Data Structures
struct	EFI_MM_USB_REGISTER_CONTEXT
struct	_EFI_MM_USB_DISPATCH_PROTOCOL

Macros
#define	EFI_MM_USB_DISPATCH_PROTOCOL_GUID

Typedefs
typedef struct _EFI_MM_USB_DISPATCH_PROTOCOL	EFI_MM_USB_DISPATCH_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EFI_MM_USB_REGISTER )(IN CONST EFI_MM_USB_DISPATCH_PROTOCOL *This, IN EFI_MM_HANDLER_ENTRY_POINT DispatchFunction, IN CONST EFI_MM_USB_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle)
typedef EFI_STATUS(EFIAPI *	EFI_MM_USB_UNREGISTER )(IN CONST EFI_MM_USB_DISPATCH_PROTOCOL *This, IN EFI_HANDLE DispatchHandle)

Enumerations
enum	EFI_USB_MMI_TYPE { UsbLegacy, UsbWake }

Variables
EFI_GUID	gEfiMmUsbDispatchProtocolGuid

Detailed Description

MM USB Dispatch Protocol as defined in PI 1.5 Specification Volume 4 Management Mode Core Interface.

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

Copyright (c) 2017, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Revision Reference:

This protocol is from PI Version 1.5.

Macro Definition Documentation

#define EFI_MM_USB_DISPATCH_PROTOCOL_GUID

Value:

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

Typedef Documentation

typedef struct _EFI_MM_USB_DISPATCH_PROTOCOL EFI_MM_USB_DISPATCH_PROTOCOL

typedef EFI_STATUS(EFIAPI * EFI_MM_USB_REGISTER)(IN CONST EFI_MM_USB_DISPATCH_PROTOCOL *This, IN EFI_MM_HANDLER_ENTRY_POINT DispatchFunction, IN CONST EFI_MM_USB_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle)

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

This service registers a function (DispatchFunction) which will be called when the USB- related MMI 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_MM_USB_DISPATCH_PROTOCOL instance.
[in]	DispatchFunction	Function to register for handler when a USB-related MMI 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 MMI 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 MMI source has been enabled.
EFI_DEVICE_ERROR	The driver was unable to enable the MMI source.
EFI_INVALID_PARAMETER	RegisterContext is invalid. The USB MMI type is not within valid range.
EFI_OUT_OF_RESOURCES	There is not enough memory (system or MM) to manage this child.

typedef EFI_STATUS(EFIAPI * EFI_MM_USB_UNREGISTER)(IN CONST EFI_MM_USB_DISPATCH_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_MM_USB_DISPATCH_PROTOCOL instance.
[in]	DispatchHandle	Handle of the service to remove.

Return values

EFI_SUCCESS	The dispatch function has been successfully unregistered and the MMI source has been disabled if there are no other registered child dispatch functions for this MMI source.
EFI_INVALID_PARAMETER	The DispatchHandle was not valid.

Enumeration Type Documentation

enum EFI_USB_MMI_TYPE

USB MMI event types

Enumerator
UsbLegacy
UsbWake

Variable Documentation

EFI_GUID gEfiMmUsbDispatchProtocolGuid