MmPeriodicTimerDispatch.h File Reference

Data Structures
struct	EFI_MM_PERIODIC_TIMER_REGISTER_CONTEXT
struct	EFI_MM_PERIODIC_TIMER_CONTEXT
struct	_EFI_MM_PERIODIC_TIMER_DISPATCH_PROTOCOL

Macros
#define	EFI_MM_PERIODIC_TIMER_DISPATCH_PROTOCOL_GUID

Typedefs
typedef struct _EFI_MM_PERIODIC_TIMER_DISPATCH_PROTOCOL	EFI_MM_PERIODIC_TIMER_DISPATCH_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EFI_MM_PERIODIC_TIMER_REGISTER )(IN CONST EFI_MM_PERIODIC_TIMER_DISPATCH_PROTOCOL *This, IN EFI_MM_HANDLER_ENTRY_POINT DispatchFunction, IN CONST EFI_MM_PERIODIC_TIMER_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle)
typedef EFI_STATUS(EFIAPI *	EFI_MM_PERIODIC_TIMER_UNREGISTER )(IN CONST EFI_MM_PERIODIC_TIMER_DISPATCH_PROTOCOL *This, IN EFI_HANDLE DispatchHandle)
typedef EFI_STATUS(EFIAPI *	EFI_MM_PERIODIC_TIMER_INTERVAL )(IN CONST EFI_MM_PERIODIC_TIMER_DISPATCH_PROTOCOL *This, IN OUT UINT64 **MmiTickInterval)

Variables
EFI_GUID	gEfiMmPeriodicTimerDispatchProtocolGuid

Detailed Description

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

This protocol provides the parent dispatch service for the periodical timer 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_PERIODIC_TIMER_DISPATCH_PROTOCOL_GUID

Value:

{ \
    0x4cec368e, 0x8e8e, 0x4d71, {0x8b, 0xe1, 0x95, 0x8c, 0x45, 0xfc, 0x8a, 0x53 } \
  }

Typedef Documentation

typedef struct _EFI_MM_PERIODIC_TIMER_DISPATCH_PROTOCOL EFI_MM_PERIODIC_TIMER_DISPATCH_PROTOCOL

typedef EFI_STATUS(EFIAPI * EFI_MM_PERIODIC_TIMER_INTERVAL)(IN CONST EFI_MM_PERIODIC_TIMER_DISPATCH_PROTOCOL *This, IN OUT UINT64 **MmiTickInterval)

Returns the next MMI tick period supported by the chipset.

The order returned is from longest to shortest interval period.

Parameters

[in]	This	Pointer to the EFI_MM_PERIODIC_TIMER_DISPATCH_PROTOCOL instance.
[in,out]	MmiTickInterval	Pointer to pointer of next shorter MMI interval period supported by the child. This parameter works as a get-first, get-next field.The first time this function is called, *MmiTickInterval should be set to NULL to get the longest MMI interval.The returned MmiTickInterval should be passed in on subsequent calls to get the next shorter interval period until *MmiTickInterval = NULL.

Return values

EFI_SUCCESS

The service returned successfully.

typedef EFI_STATUS(EFIAPI * EFI_MM_PERIODIC_TIMER_REGISTER)(IN CONST EFI_MM_PERIODIC_TIMER_DISPATCH_PROTOCOL *This, IN EFI_MM_HANDLER_ENTRY_POINT DispatchFunction, IN CONST EFI_MM_PERIODIC_TIMER_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle)

Register a child MMI source dispatch function for MM periodic timer.

This service registers a function (DispatchFunction) which will be called when at least the amount of time specified by RegisterContext has elapsed. 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 an instance of EFI_MM_PERIODIC_TIMER_CONTEXT and CommBufferSize pointing to its size.

Parameters

[in]	This	Pointer to the EFI_MM_PERIODIC_TIMER_DISPATCH_PROTOCOL instance.
[in]	DispatchFunction	Function to register for handler when at least the specified amount of time has elapsed.
[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 period at 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 period 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_PERIODIC_TIMER_UNREGISTER)(IN CONST EFI_MM_PERIODIC_TIMER_DISPATCH_PROTOCOL *This, IN EFI_HANDLE DispatchHandle)

Unregisters a periodic timer service.

This service removes the handler associated with DispatchHandle so that it will no longer be called when the time has elapsed.

Parameters

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

Return values

EFI_SUCCESS	The service has been successfully removed.
EFI_INVALID_PARAMETER	The DispatchHandle was not valid.

Variable Documentation

EFI_GUID gEfiMmPeriodicTimerDispatchProtocolGuid