MdePkg/Include/Protocol/SmmPeriodicTimerDispatch2.h File Reference


Data Structures

struct  EFI_SMM_PERIODIC_TIMER_REGISTER_CONTEXT
struct  EFI_SMM_PERIODIC_TIMER_CONTEXT
struct  _EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL

Defines

#define EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL_GUID

Typedefs

typedef struct
_EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL 
EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL
typedef EFI_STATUS(EFIAPI * EFI_SMM_PERIODIC_TIMER_REGISTER2 )(IN CONST EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL *This, IN EFI_SMM_HANDLER_ENTRY_POINT2 DispatchFunction, IN CONST EFI_SMM_PERIODIC_TIMER_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle)
typedef EFI_STATUS(EFIAPI * EFI_SMM_PERIODIC_TIMER_UNREGISTER2 )(IN CONST EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL *This, IN EFI_HANDLE DispatchHandle)
typedef EFI_STATUS(EFIAPI * EFI_SMM_PERIODIC_TIMER_INTERVAL2 )(IN CONST EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL *This, IN OUT UINT64 **SmiTickInterval)

Variables

EFI_GUID gEfiSmmPeriodicTimerDispatch2ProtocolGuid

Detailed Description

SMM Periodic Timer Dispatch Protocol as defined in PI 1.1 Specification Volume 4 System Management Mode Core Interface.

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

Value:

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


Typedef Documentation

typedef EFI_STATUS(EFIAPI * EFI_SMM_PERIODIC_TIMER_INTERVAL2)(IN CONST EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL *This, IN OUT UINT64 **SmiTickInterval)

Returns the next SMI tick period supported by the chipset.

The order returned is from longest to shortest interval period.

Parameters:
[in] This Pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL instance.
[in,out] SmiTickInterval Pointer to pointer of next shorter SMI interval period supported by the child. This parameter works as a get-first, get-next field.The first time this function is called, *SmiTickInterval should be set to NULL to get the longest SMI interval.The returned SmiTickInterval should be passed in on subsequent calls to get the next shorter interval period until *SmiTickInterval = NULL.
Return values:
EFI_SUCCESS The service returned successfully.

typedef EFI_STATUS(EFIAPI * EFI_SMM_PERIODIC_TIMER_REGISTER2)(IN CONST EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL *This, IN EFI_SMM_HANDLER_ENTRY_POINT2 DispatchFunction, IN CONST EFI_SMM_PERIODIC_TIMER_REGISTER_CONTEXT *RegisterContext, OUT EFI_HANDLE *DispatchHandle)

Register a child SMI source dispatch function for SMM 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_SMM_PERIODIC_TIMER_CONTEXT and CommBufferSize pointing to its size.

Parameters:
[in] This Pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH2_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 SMI source has been enabled.
EFI_DEVICE_ERROR The driver was unable to enable the SMI 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 SMM) to manage this child.

typedef EFI_STATUS(EFIAPI * EFI_SMM_PERIODIC_TIMER_UNREGISTER2)(IN CONST EFI_SMM_PERIODIC_TIMER_DISPATCH2_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_SMM_PERIODIC_TIMER_DISPATCH2_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


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