MmIoTrapDispatch.h File Reference

Data Structures
struct	EFI_MM_IO_TRAP_REGISTER_CONTEXT
struct	EFI_MM_IO_TRAP_CONTEXT
struct	_EFI_MM_IO_TRAP_DISPATCH_PROTOCOL

Macros
#define	EFI_MM_IO_TRAP_DISPATCH_PROTOCOL_GUID

Typedefs
typedef struct _EFI_MM_IO_TRAP_DISPATCH_PROTOCOL	EFI_MM_IO_TRAP_DISPATCH_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EFI_MM_IO_TRAP_DISPATCH_REGISTER )(IN CONST EFI_MM_IO_TRAP_DISPATCH_PROTOCOL *This, IN EFI_MM_HANDLER_ENTRY_POINT DispatchFunction, IN OUT EFI_MM_IO_TRAP_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle)
typedef EFI_STATUS(EFIAPI *	EFI_MM_IO_TRAP_DISPATCH_UNREGISTER )(IN CONST EFI_MM_IO_TRAP_DISPATCH_PROTOCOL *This, IN EFI_HANDLE DispatchHandle)

Enumerations
enum	EFI_MM_IO_TRAP_DISPATCH_TYPE { WriteTrap, ReadTrap, ReadWriteTrap, IoTrapTypeMaximum }

Variables
EFI_GUID	gEfiMmIoTrapDispatchProtocolGuid

Detailed Description

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

This protocol provides a parent dispatch service for IO trap MMI sources.

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_IO_TRAP_DISPATCH_PROTOCOL_GUID

Value:

{ \
    0x58dc368d, 0x7bfa, 0x4e77, {0xab, 0xbc, 0xe, 0x29, 0x41, 0x8d, 0xf9, 0x30 } \
  }

Typedef Documentation

typedef struct _EFI_MM_IO_TRAP_DISPATCH_PROTOCOL EFI_MM_IO_TRAP_DISPATCH_PROTOCOL

typedef EFI_STATUS(EFIAPI * EFI_MM_IO_TRAP_DISPATCH_REGISTER)(IN CONST EFI_MM_IO_TRAP_DISPATCH_PROTOCOL *This, IN EFI_MM_HANDLER_ENTRY_POINT DispatchFunction, IN OUT EFI_MM_IO_TRAP_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle)

Register an IO trap MMI child handler for a specified MMI.

This service registers a function (DispatchFunction) which will be called when an MMI is generated because of an access to an I/O port specified by RegisterContext. On return, DispatchHandle contains a unique handle which may be used later to unregister the function using UnRegister(). If the base of the I/O range specified is zero, then an I/O range with the specified length and characteristics will be allocated and the Address field in RegisterContext updated. If no range could be allocated, then EFI_OUT_OF_RESOURCES will be returned.

The service will not perform GCD allocation if the base address is non-zero or EFI_MM_READY_TO_LOCK has been installed. In this case, the caller is responsible for the existence and allocation of the specific IO range. An error may be returned if some or all of the requested resources conflict with an existing IO trap child handler.

It is not required that implementations will allow multiple children for a single IO trap MMI source. Some implementations may support multiple children. The DispatchFunction will be called with Context updated to contain information concerning the I/O action that actually happened and is passed in RegisterContext, with CommBuffer pointing to the data actually written and CommBufferSize pointing to the size of the data in CommBuffer.

Parameters

[in]	This	Pointer to the EFI_MM_IO_TRAP_DISPATCH_PROTOCOL instance.
[in]	DispatchFunction	Function to register for handler when I/O trap location is accessed.
[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 IO trap MMI source for which the dispatch function should be invoked.
[out]	DispatchHandle	Handle of the dispatch function, for when interfacing with the parent MM driver.

Return values

EFI_SUCCESS	The dispatch function has been successfully registered.
EFI_DEVICE_ERROR	The driver was unable to complete due to hardware error.
EFI_OUT_OF_RESOURCES	Insufficient resources are available to fulfill the IO trap range request.
EFI_INVALID_PARAMETER	RegisterContext is invalid. The input value is not within a valid range.

typedef EFI_STATUS(EFIAPI * EFI_MM_IO_TRAP_DISPATCH_UNREGISTER)(IN CONST EFI_MM_IO_TRAP_DISPATCH_PROTOCOL *This, IN EFI_HANDLE DispatchHandle)

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

This service removes a previously installed child dispatch handler. This does not guarantee that the system resources will be freed from the GCD.

Parameters

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

Return values

EFI_SUCCESS	The dispatch function has been successfully unregistered.
EFI_INVALID_PARAMETER	The DispatchHandle was not valid.

Enumeration Type Documentation

enum EFI_MM_IO_TRAP_DISPATCH_TYPE

IO Trap valid types

Enumerator
WriteTrap
ReadTrap
ReadWriteTrap
IoTrapTypeMaximum

Variable Documentation

EFI_GUID gEfiMmIoTrapDispatchProtocolGuid