MmGpiDispatch.h File Reference

Data Structures
struct	EFI_MM_GPI_REGISTER_CONTEXT
struct	_EFI_MM_GPI_DISPATCH_PROTOCOL

Macros
#define	EFI_MM_GPI_DISPATCH_PROTOCOL_GUID

Typedefs
typedef struct _EFI_MM_GPI_DISPATCH_PROTOCOL	EFI_MM_GPI_DISPATCH_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EFI_MM_GPI_REGISTER )(IN CONST EFI_MM_GPI_DISPATCH_PROTOCOL *This, IN EFI_MM_HANDLER_ENTRY_POINT DispatchFunction, IN CONST EFI_MM_GPI_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle)
typedef EFI_STATUS(EFIAPI *	EFI_MM_GPI_UNREGISTER )(IN CONST EFI_MM_GPI_DISPATCH_PROTOCOL *This, IN EFI_HANDLE DispatchHandle)

Variables
EFI_GUID	gEfiMmGpiDispatchProtocolGuid

Detailed Description

MM General Purpose Input (GPI) Dispatch Protocol as defined in PI 1.5 Specification Volume 4 Management Mode Core Interface.

This protocol provides the parent dispatch service for the General Purpose Input (GPI) MMI source generator.

The EFI_MM_GPI_DISPATCH_PROTOCOL provides the ability to install child handlers for the given event types. Several inputs can be enabled. This purpose of this interface is to generate an MMI in response to any of these inputs having a true value provided.

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_GPI_DISPATCH_PROTOCOL_GUID

Value:

{ \
    0x25566b03, 0xb577, 0x4cbf, {0x95, 0x8c, 0xed, 0x66, 0x3e, 0xa2, 0x43, 0x80 } \
  }

Typedef Documentation

typedef struct _EFI_MM_GPI_DISPATCH_PROTOCOL EFI_MM_GPI_DISPATCH_PROTOCOL

typedef EFI_STATUS(EFIAPI * EFI_MM_GPI_REGISTER)(IN CONST EFI_MM_GPI_DISPATCH_PROTOCOL *This, IN EFI_MM_HANDLER_ENTRY_POINT DispatchFunction, IN CONST EFI_MM_GPI_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle)

Registers a child MMI source dispatch function with a parent MM driver.

This service registers a function (DispatchFunction) which will be called when an MMI is generated because of one or more of the GPIs specified by RegisterContext. 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 pointing to another instance of EFI_MM_GPI_REGISTER_CONTEXT describing the GPIs which actually caused the MMI and CommBufferSize pointing to the size of the structure.

Parameters

[in]	This	Pointer to the EFI_MM_GPI_DISPATCH_PROTOCOL instance.
[in]	DispatchFunction	Function to register for handler when the specified GPI causes an MMI.
[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 GPI(s) 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 GPI input value 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_GPI_UNREGISTER)(IN CONST EFI_MM_GPI_DISPATCH_PROTOCOL *This, IN EFI_HANDLE DispatchHandle)

Unregisters a General Purpose Input (GPI) service.

This service removes the handler associated with DispatchHandle so that it will no longer be called when the GPI triggers an MMI.

Parameters

[in]	This	Pointer to the EFI_MM_GPI_DISPATCH_PROTOCOL instance.
[in]	DispatchHandle	Handle of the service to remove.

Return values

EFI_SUCCESS	Handle of the service to remove.
EFI_INVALID_PARAMETER	The DispatchHandle was not valid.

Variable Documentation

EFI_GUID gEfiMmGpiDispatchProtocolGuid