Remove IntelFrameworkModulePkg

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / SmmPeriodicTimerDispatch.h

/** @file\r
  Provides the parent dispatch service for the periodical timer SMI source generator.\r
\r
Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Revision Reference:\r
  This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
  Version 0.9.\r
\r
**/\r
\r
#ifndef _EFI_SMM_PERIODIC_TIMER_DISPATCH_H_\r
#define _EFI_SMM_PERIODIC_TIMER_DISPATCH_H_\r
\r
\r
//\r
// Global ID for the Periodic Timer SMI Protocol\r
//\r
#define EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL_GUID \\r
  { \\r
    0x9cca03fc, 0x4c9e, 0x4a19, {0x9b, 0x6, 0xed, 0x7b, 0x47, 0x9b, 0xde, 0x55 } \\r
  }\r
\r
typedef struct _EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL  EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL;\r
\r
//\r
// Related Definitions\r
//\r
\r
typedef struct {\r
  ///\r
  /// The minimum period of time that the child gets called, in 100 nanosecond units.\r
  /// The child will be called back after a time greater than the time Period.\r
  ///\r
  UINT64  Period;\r
  ///\r
  /// The period of time interval between SMIs.  Children of this interface\r
  /// should use this field when registering for periodic timer intervals when a finer\r
  /// granularity periodic SMI is desired.  Valid values for this field are those returned\r
  /// by GetNextInterval.  A value of 0 indicates the parent is allowed to use any SMI\r
  /// interval period to satisfy the requested period.\r
  ///\r
  UINT64  SmiTickInterval;\r
  ///\r
  /// The actual time in 100 nanosecond units elapsed since last called. A\r
  /// value of 0 indicates an unknown amount of time.\r
  ///\r
  UINT64  ElapsedTime;\r
} EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT;\r
\r
//\r
// Member functions\r
//\r
/**\r
  Dispatch function for a Periodic Timer SMI handler.\r
\r
  @param  DispatchHandle        The handle of this dispatch function.\r
  @param  DispatchContext       The pointer to the dispatch function's context.\r
                                The DispatchContext fields are filled in\r
                                by the dispatching driver prior to\r
                                invoking this dispatch function.\r
\r
  @return None\r
\r
**/\r
typedef\r
VOID\r
(EFIAPI *EFI_SMM_PERIODIC_TIMER_DISPATCH)(\r
  IN EFI_HANDLE                                DispatchHandle,\r
  IN EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT   *DispatchContext\r
  );\r
\r
/**\r
  Returns the next SMI tick period supported by the chipset.  The order\r
  returned is from longest to shortest interval period.\r
\r
  @param  This                  The protocol instance pointer.\r
  @param  SmiTickInterval       The pointer to pointer of next shorter SMI interval\r
                                period supported by the child. This parameter works as a get-first,\r
                                get-next field. The first time this function is called, *SmiTickInterval\r
                                should be set to NULL to get the longest SMI interval. The returned\r
                                *SmiTickInterval should be passed in on subsequent calls to get the\r
                                next shorter interval period until *SmiTickInterval = NULL.\r
\r
  @retval EFI_SUCCESS           The service returned successfully.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_SMM_PERIODIC_TIMER_INTERVAL)(\r
  IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL           *This,\r
  IN OUT UINT64                                         **SmiTickInterval\r
  );\r
\r
/**\r
  Register a child SMI source dispatch function with a parent SMM driver\r
\r
  @param  This                  The pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL instance.\r
  @param  DispatchFunction      The function to install.\r
  @param  DispatchContext       The pointer to the dispatch function's context.\r
                                Indicates to the register\r
                                function the period at which the dispatch function\r
                                should be invoked.\r
  @param  DispatchHandle        The handle generated by the dispatcher to track the function instance.\r
\r
  @retval EFI_SUCCESS           The dispatch function has been successfully\r
                                registered, and the SMI source has been enabled.\r
  @retval EFI_DEVICE_ERROR      The driver was unable to enable the SMI source.\r
  @retval EFI_OUT_OF_RESOURCES  Not enough memory (system or SMM) to manage this\r
                                child.\r
  @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The period input value\r
                                is not within valid range.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_SMM_PERIODIC_TIMER_REGISTER)(\r
  IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL          *This,\r
  IN EFI_SMM_PERIODIC_TIMER_DISPATCH                   DispatchFunction,\r
  IN EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT           *DispatchContext,\r
  OUT EFI_HANDLE                                       *DispatchHandle\r
  );\r
\r
/**\r
  Unregisters a periodic timer service.\r
\r
  @param  This                  The pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL instance.\r
  @param  DispatchHandle        The handle of the service to remove.\r
\r
  @retval EFI_SUCCESS           The dispatch function has been successfully\r
                                unregistered, and the SMI source has been disabled\r
                                if there are no other registered child dispatch\r
                                functions for this SMI source.\r
  @retval EFI_INVALID_PARAMETER The handle is invalid.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_SMM_PERIODIC_TIMER_UNREGISTER)(\r
  IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL          *This,\r
  IN EFI_HANDLE                                        DispatchHandle\r
  );\r
\r
//\r
// Interface structure for the SMM Periodic Timer Dispatch Protocol\r
//\r
/**\r
  Provides the parent dispatch service for the periodical timer SMI source generator.\r
**/\r
struct _EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL {\r
  ///\r
  /// Installs a child service to be dispatched by this protocol.\r
  ///\r
  EFI_SMM_PERIODIC_TIMER_REGISTER   Register;\r
\r
  ///\r
  /// Removes a child service dispatched by this protocol.\r
  ///\r
  EFI_SMM_PERIODIC_TIMER_UNREGISTER UnRegister;\r
\r
  ///\r
  /// Returns the next SMI tick period that is supported by the chipset.\r
  ///\r
  EFI_SMM_PERIODIC_TIMER_INTERVAL   GetNextShorterInterval;\r
};\r
\r
extern EFI_GUID gEfiSmmPeriodicTimerDispatchProtocolGuid;\r
\r
#endif\r