[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, Intel Corporation\r
  All rights reserved. This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
  Module Name:  SmmPeriodicTimerDispatch.h\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
#include <PiDxe.h>\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
// Period is the minimum period of time in 100 nanosecond units that child gets called.\r
// The child will be called back after a time greater than the time Period.\r
//\r
// SmiTickInterval is 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
//    Example: A chipset supports periodic SMIs on every 64ms or 2 seconds.\r
//      A child wishes schedule a period SMI to fire on a period of 3 seconds, there\r
//      are several ways to approach the problem:\r
//      1. The child may accept a 4 second periodic rate, in which case it registers with\r
//           Period = 40000\r
//           SmiTickInterval = 20000\r
//         The resulting SMI will occur every 2 seconds with the child called back on\r
//         every 2nd SMI.\r
//         NOTE: the same result would occur if the child set SmiTickInterval = 0.\r
//      2. The child may choose the finer granularity SMI (64ms):\r
//           Period = 30000\r
//           SmiTickInterval = 640\r
//         The resulting SMI will occur every 64ms with the child called back on\r
//         every 47th SMI.\r
//         NOTE: the child driver should be aware that this will result in more\r
//           SMIs occuring during system runtime which can negatively impact system\r
//           performance.\r
//\r
// ElapsedTime is the actual time in 100 nanosecond units elapsed since last called, a\r
// value of 0 indicates an unknown amount of time.\r
//\r
typedef struct {\r
  UINT64  Period;\r
  UINT64  SmiTickInterval;\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        Handle of this dispatch function.\r
  @param  DispatchContext       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                  Protocol instance pointer.\r
  @param  SmiTickInterval       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                  Pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL instance.\r
  @param  DispatchFunction      Function to install.\r
  @param  DispatchContext       Pointer to the dispatch function's context.\r
                                The caller fills this context in before calling\r
                                the register function to indicate to the register\r
                                function the period at which the dispatch function\r
                                should be invoked.\r
  @param  DispatchHandle        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                  Pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL instance.\r
  @param  DispatchHandle        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 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
  @par Protocol Description:\r
  Provides the parent dispatch service for the periodical timer SMI source generator.\r
\r
  @param Register\r
  Installs a child service to be dispatched by this protocol.\r
\r
  @param UnRegister\r
  Removes a child service dispatched by this protocol.\r
\r
  @param GetNextShorterInterval\r
  Returns the next SMI tick period that is supported by the chipset.\r
\r
**/\r
struct _EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL {\r
  EFI_SMM_PERIODIC_TIMER_REGISTER   Register;\r
  EFI_SMM_PERIODIC_TIMER_UNREGISTER UnRegister;\r
  EFI_SMM_PERIODIC_TIMER_INTERVAL   GetNextShorterInterval;\r
};\r
\r
extern EFI_GUID gEfiSmmPeriodicTimerDispatchProtocolGuid;\r
\r
#endif\r
Commit	Line	Data
79964ac8	1	/** @file\r
8411f1c0	2	Provides the parent dispatch service for the periodical timer SMI source generator.\r
79964ac8	3	\r
	4	Copyright (c) 2007, Intel Corporation\r
	5	All rights reserved. This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
	13	Module Name: SmmPeriodicTimerDispatch.h\r
	14	\r
	15	@par Revision Reference:\r
	16	This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
	17	Version 0.9.\r
	18	\r
	19	**/\r
	20	\r
	21	#ifndef _EFI_SMM_PERIODIC_TIMER_DISPATCH_H_\r
	22	#define _EFI_SMM_PERIODIC_TIMER_DISPATCH_H_\r
	23	\r
b80fbe85	24	#include <PiDxe.h>\r
b80fbe85	25	\r
79964ac8	26	//\r
	27	// Global ID for the Periodic Timer SMI Protocol\r
	28	//\r
	29	#define EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL_GUID \\r
	30	{ \\r
	31	0x9cca03fc, 0x4c9e, 0x4a19, {0x9b, 0x6, 0xed, 0x7b, 0x47, 0x9b, 0xde, 0x55 } \\r
	32	}\r
	33	\r
	34	typedef struct _EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL;\r
	35	\r
	36	//\r
	37	// Related Definitions\r
	38	//\r
	39	//\r
	40	// Period is the minimum period of time in 100 nanosecond units that child gets called.\r
	41	// The child will be called back after a time greater than the time Period.\r
	42	//\r
	43	// SmiTickInterval is the period of time interval between SMIs. Children of this interface\r
	44	// should use this field when registering for periodic timer intervals when a finer\r
	45	// granularity periodic SMI is desired. Valid values for this field are those returned\r
	46	// by GetNextInterval. A value of 0 indicates the parent is allowed to use any SMI\r
	47	// interval period to satisfy the requested period.\r
	48	// Example: A chipset supports periodic SMIs on every 64ms or 2 seconds.\r
	49	// A child wishes schedule a period SMI to fire on a period of 3 seconds, there\r
	50	// are several ways to approach the problem:\r
	51	// 1. The child may accept a 4 second periodic rate, in which case it registers with\r
	52	// Period = 40000\r
	53	// SmiTickInterval = 20000\r
	54	// The resulting SMI will occur every 2 seconds with the child called back on\r
	55	// every 2nd SMI.\r
	56	// NOTE: the same result would occur if the child set SmiTickInterval = 0.\r
	57	// 2. The child may choose the finer granularity SMI (64ms):\r
	58	// Period = 30000\r
	59	// SmiTickInterval = 640\r
	60	// The resulting SMI will occur every 64ms with the child called back on\r
	61	// every 47th SMI.\r
	62	// NOTE: the child driver should be aware that this will result in more\r
	63	// SMIs occuring during system runtime which can negatively impact system\r
	64	// performance.\r
	65	//\r
	66	// ElapsedTime is the actual time in 100 nanosecond units elapsed since last called, a\r
	67	// value of 0 indicates an unknown amount of time.\r
	68	//\r
	69	typedef struct {\r
	70	UINT64 Period;\r
	71	UINT64 SmiTickInterval;\r
	72	UINT64 ElapsedTime;\r
	73	} EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT;\r
	74	\r
	75	//\r
	76	// Member functions\r
	77	//\r
	78	/**\r
	79	Dispatch function for a Periodic Timer SMI handler.\r
	80	\r
	81	@param DispatchHandle Handle of this dispatch function.\r
	82	@param DispatchContext Pointer to the dispatch function's context.\r
	83	The DispatchContext fields are filled in\r
	84	by the dispatching driver prior to\r
	85	invoking this dispatch function.\r
	86	\r
700a7869	87	@return None\r
79964ac8	88	\r
	89	**/\r
	90	typedef\r
	91	VOID\r
69686d56	92	(EFIAPI *EFI_SMM_PERIODIC_TIMER_DISPATCH)(\r
700a7869	93	IN EFI_HANDLE DispatchHandle,\r
700a7869	94	IN EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT *DispatchContext\r
79964ac8	95	);\r
	96	\r
	97	/**\r
	98	Returns the next SMI tick period supported by the chipset. The order\r
	99	returned is from longest to shortest interval period.\r
	100	\r
	101	@param This Protocol instance pointer.\r
	102	@param SmiTickInterval Pointer to pointer of next shorter SMI interval\r
	103	period supported by the child. This parameter works as a get-first,\r
	104	get-next field.The first time this function is called, *SmiTickInterval\r
	105	should be set to NULL to get the longest SMI interval.The returned\r
	106	*SmiTickInterval should be passed in on subsequent calls to get the\r
	107	next shorter interval period until *SmiTickInterval = NULL.\r
	108	\r
	109	@retval EFI_SUCCESS The service returned successfully.\r
	110	\r
	111	**/\r
	112	typedef\r
	113	EFI_STATUS\r
69686d56	114	(EFIAPI *EFI_SMM_PERIODIC_TIMER_INTERVAL)(\r
79964ac8	115	IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL *This,\r
	116	IN OUT UINT64 **SmiTickInterval\r
	117	);\r
	118	\r
	119	/**\r
	120	Register a child SMI source dispatch function with a parent SMM driver\r
	121	\r
700a7869	122	@param This Pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL instance.\r
700a7869	123	@param DispatchFunction Function to install.\r
79964ac8	124	@param DispatchContext Pointer to the dispatch function's context.\r
	125	The caller fills this context in before calling\r
	126	the register function to indicate to the register\r
	127	function the period at which the dispatch function\r
	128	should be invoked.\r
700a7869	129	@param DispatchHandle Handle generated by the dispatcher to track the function instance.\r
79964ac8	130	\r
	131	@retval EFI_SUCCESS The dispatch function has been successfully\r
	132	registered and the SMI source has been enabled.\r
	133	@retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.\r
	134	@retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this\r
	135	child.\r
	136	@retval EFI_INVALID_PARAMETER DispatchContext is invalid. The period input value\r
	137	is not within valid range.\r
	138	\r
	139	**/\r
	140	typedef\r
	141	EFI_STATUS\r
69686d56	142	(EFIAPI *EFI_SMM_PERIODIC_TIMER_REGISTER)(\r
700a7869	143	IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL *This,\r
	144	IN EFI_SMM_PERIODIC_TIMER_DISPATCH DispatchFunction,\r
	145	IN EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT *DispatchContext,\r
	146	OUT EFI_HANDLE *DispatchHandle\r
79964ac8	147	);\r
	148	\r
	149	/**\r
700a7869	150	Unregisters a periodic timer service.\r
79964ac8	151	\r
700a7869	152	@param This Pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL instance.\r
700a7869	153	@param DispatchHandle Handle of the service to remove.\r
79964ac8	154	\r
	155	@retval EFI_SUCCESS The dispatch function has been successfully\r
	156	unregistered and the SMI source has been disabled\r
	157	if there are no other registered child dispatch\r
	158	functions for this SMI source.\r
	159	@retval EFI_INVALID_PARAMETER Handle is invalid.\r
	160	\r
	161	**/\r
	162	typedef\r
	163	EFI_STATUS\r
69686d56	164	(EFIAPI *EFI_SMM_PERIODIC_TIMER_UNREGISTER)(\r
700a7869	165	IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL *This,\r
700a7869	166	IN EFI_HANDLE DispatchHandle\r
79964ac8	167	);\r
	168	\r
	169	//\r
	170	// Interface structure for the SMM Periodic Timer Dispatch Protocol\r
	171	//\r
	172	/**\r
	173	@par Protocol Description:\r
	174	Provides the parent dispatch service for the periodical timer SMI source generator.\r
	175	\r
	176	@param Register\r
	177	Installs a child service to be dispatched by this protocol.\r
	178	\r
	179	@param UnRegister\r
	180	Removes a child service dispatched by this protocol.\r
	181	\r
	182	@param GetNextShorterInterval\r
	183	Returns the next SMI tick period that is supported by the chipset.\r
	184	\r
	185	**/\r
	186	struct _EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL {\r
	187	EFI_SMM_PERIODIC_TIMER_REGISTER Register;\r
	188	EFI_SMM_PERIODIC_TIMER_UNREGISTER UnRegister;\r
	189	EFI_SMM_PERIODIC_TIMER_INTERVAL GetNextShorterInterval;\r
	190	};\r
	191	\r
	192	extern EFI_GUID gEfiSmmPeriodicTimerDispatchProtocolGuid;\r
	193	\r
	194	#endif\r