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

/** @file\r
  Provides the parent dispatch service for a given SMI source generator.\r
  The EFI_SMM_ICHN_DISPATCH_PROTOCOL provides the ability to install child handlers for\r
  the given event types.\r
\r
  Copyright (c) 2008 - 2009, 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
  @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_ICHN_DISPATCH_H_\r
#define _EFI_SMM_ICHN_DISPATCH_H_\r
\r
\r
//\r
// Global ID for the ICH SMI Protocol\r
//\r
#define EFI_SMM_ICHN_DISPATCH_PROTOCOL_GUID \\r
  { \\r
    0xc50b323e, 0x9075, 0x4f2a, {0xac, 0x8e, 0xd2, 0x59, 0x6a, 0x10, 0x85, 0xcc } \\r
  }\r
\r
typedef struct _EFI_SMM_ICHN_DISPATCH_PROTOCOL  EFI_SMM_ICHN_DISPATCH_PROTOCOL;\r
\r
//\r
// Related Definitions\r
//\r
//\r
// ICHN Specific SMIs.  These are miscellaneous SMI sources that are supported by the\r
// ICHN specific SMI implementation.  These may change over time.  TrapNumber is only\r
// valid if the Type is Trap.\r
//\r
typedef enum {\r
  //\r
  // NOTE: NEVER delete items from this list/enumeration!  Doing so will prevent other versions\r
  // of the code from compiling.  If the ICH version your driver is written for doesn't support\r
  // some of these SMIs, then simply return EFI_UNSUPPORTED when a child/client tries to register\r
  // for them.\r
  //\r
  IchnMch,\r
  IchnPme,\r
  IchnRtcAlarm,\r
  IchnRingIndicate,\r
  IchnAc97Wake,\r
  IchnSerialIrq,\r
  IchnY2KRollover,\r
  IchnTcoTimeout,\r
  IchnOsTco,\r
  IchnNmi,\r
  IchnIntruderDetect,\r
  IchnBiosWp,\r
  IchnMcSmi,\r
  IchnPmeB0,\r
  IchnThrmSts,\r
  IchnSmBus,\r
  IchnIntelUsb2,\r
  IchnMonSmi7,\r
  IchnMonSmi6,\r
  IchnMonSmi5,\r
  IchnMonSmi4,\r
  IchnDevTrap13,\r
  IchnDevTrap12,\r
  IchnDevTrap11,\r
  IchnDevTrap10,\r
  IchnDevTrap9,\r
  IchnDevTrap8,\r
  IchnDevTrap7,\r
  IchnDevTrap6,\r
  IchnDevTrap5,\r
  IchnDevTrap3,\r
  IchnDevTrap2,\r
  IchnDevTrap1,\r
  IchnDevTrap0,\r
  IchnIoTrap3,\r
  IchnIoTrap2,\r
  IchnIoTrap1,\r
  IchnIoTrap0,\r
  IchnPciExpress,\r
  IchnMonitor,\r
  IchnSpi,\r
  IchnQRT,\r
  IchnGpioUnlock,\r
  //\r
  // INSERT NEW ITEMS JUST BEFORE THIS LINE\r
  //\r
  NUM_ICHN_TYPES  // the number of items in this enumeration\r
} EFI_SMM_ICHN_SMI_TYPE;\r
\r
typedef struct {\r
  EFI_SMM_ICHN_SMI_TYPE Type;\r
} EFI_SMM_ICHN_DISPATCH_CONTEXT;\r
\r
//\r
// Member functions\r
//\r
/**\r
  Dispatch function for a ICHN specific 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_ICHN_DISPATCH)(\r
  IN  EFI_HANDLE                      DispatchHandle,\r
  IN  EFI_SMM_ICHN_DISPATCH_CONTEXT   *DispatchContext\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_ICHN_DISPATCH_PROTOCOL instance.\r
  @param  DispatchFunction      Function to install.\r
  @param  DispatchContext       Pointer to the dispatch function's context.\r
                                The caller fills in this context before calling\r
                                the register function to indicate to the register\r
                                function the ICHN SMI source for which the dispatch\r
                                function should be invoked.\r
  @param  DispatchHandle        Handle generated by the dispatcher to track the function\r
                                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 could not 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 ICHN input value\r
                                is not within valid range.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_SMM_ICHN_REGISTER)(\r
  IN EFI_SMM_ICHN_DISPATCH_PROTOCOL            *This,\r
  IN EFI_SMM_ICHN_DISPATCH                     DispatchFunction,\r
  IN EFI_SMM_ICHN_DISPATCH_CONTEXT             *DispatchContext,\r
  OUT EFI_HANDLE                               *DispatchHandle\r
  );\r
\r
/**\r
  Unregister a child SMI source dispatch function with a parent SMM driver\r
\r
  @param  This                  Pointer to the EFI_SMM_ICHN_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_ICHN_UNREGISTER)(\r
  IN EFI_SMM_ICHN_DISPATCH_PROTOCOL            *This,\r
  IN EFI_HANDLE                                DispatchHandle\r
  );\r
\r
//\r
// Interface structure for the SMM ICHN specific SMI Dispatch Protocol\r
//\r
/**\r
  Provides the parent dispatch service for a given SMI source generator.\r
**/\r
struct _EFI_SMM_ICHN_DISPATCH_PROTOCOL {\r
  EFI_SMM_ICHN_REGISTER   Register;     ///< Installs a child service to be dispatched by this protocol.\r
  EFI_SMM_ICHN_UNREGISTER UnRegister;   ///< Removes a child service dispatched by this protocol.\r
};\r
\r
extern EFI_GUID gEfiSmmIchnDispatchProtocolGuid;\r
\r
#endif\r
Commit	Line	Data
79964ac8	1	/** @file\r
8411f1c0	2	Provides the parent dispatch service for a given SMI source generator.\r
	3	The EFI_SMM_ICHN_DISPATCH_PROTOCOL provides the ability to install child handlers for\r
	4	the given event types.\r
79964ac8	5	\r
2bbaeb0d	6	Copyright (c) 2008 - 2009, Intel Corporation\r
79964ac8	7	All rights reserved. This program and the accompanying materials\r
	8	are licensed and made available under the terms and conditions of the BSD License\r
	9	which accompanies this distribution. The full text of the license may be found at\r
	10	http://opensource.org/licenses/bsd-license.php\r
	11	\r
	12	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	13	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	14	\r
79964ac8	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_ICHN_DISPATCH_H_\r
	22	#define _EFI_SMM_ICHN_DISPATCH_H_\r
	23	\r
b80fbe85	24	\r
79964ac8	25	//\r
	26	// Global ID for the ICH SMI Protocol\r
	27	//\r
	28	#define EFI_SMM_ICHN_DISPATCH_PROTOCOL_GUID \\r
	29	{ \\r
	30	0xc50b323e, 0x9075, 0x4f2a, {0xac, 0x8e, 0xd2, 0x59, 0x6a, 0x10, 0x85, 0xcc } \\r
	31	}\r
	32	\r
	33	typedef struct _EFI_SMM_ICHN_DISPATCH_PROTOCOL EFI_SMM_ICHN_DISPATCH_PROTOCOL;\r
	34	\r
	35	//\r
	36	// Related Definitions\r
	37	//\r
	38	//\r
	39	// ICHN Specific SMIs. These are miscellaneous SMI sources that are supported by the\r
	40	// ICHN specific SMI implementation. These may change over time. TrapNumber is only\r
	41	// valid if the Type is Trap.\r
	42	//\r
	43	typedef enum {\r
	44	//\r
	45	// NOTE: NEVER delete items from this list/enumeration! Doing so will prevent other versions\r
	46	// of the code from compiling. If the ICH version your driver is written for doesn't support\r
	47	// some of these SMIs, then simply return EFI_UNSUPPORTED when a child/client tries to register\r
	48	// for them.\r
	49	//\r
	50	IchnMch,\r
	51	IchnPme,\r
	52	IchnRtcAlarm,\r
	53	IchnRingIndicate,\r
	54	IchnAc97Wake,\r
	55	IchnSerialIrq,\r
	56	IchnY2KRollover,\r
	57	IchnTcoTimeout,\r
	58	IchnOsTco,\r
	59	IchnNmi,\r
	60	IchnIntruderDetect,\r
	61	IchnBiosWp,\r
	62	IchnMcSmi,\r
	63	IchnPmeB0,\r
	64	IchnThrmSts,\r
	65	IchnSmBus,\r
	66	IchnIntelUsb2,\r
	67	IchnMonSmi7,\r
	68	IchnMonSmi6,\r
	69	IchnMonSmi5,\r
	70	IchnMonSmi4,\r
	71	IchnDevTrap13,\r
	72	IchnDevTrap12,\r
	73	IchnDevTrap11,\r
	74	IchnDevTrap10,\r
	75	IchnDevTrap9,\r
	76	IchnDevTrap8,\r
	77	IchnDevTrap7,\r
	78	IchnDevTrap6,\r
	79	IchnDevTrap5,\r
	80	IchnDevTrap3,\r
	81	IchnDevTrap2,\r
	82	IchnDevTrap1,\r
	83	IchnDevTrap0,\r
	84	IchnIoTrap3,\r
	85	IchnIoTrap2,\r
	86	IchnIoTrap1,\r
	87	IchnIoTrap0,\r
9d198522	88	IchnPciExpress,\r
	89	IchnMonitor,\r
	90	IchnSpi,\r
	91	IchnQRT,\r
	92	IchnGpioUnlock,\r
79964ac8	93	//\r
	94	// INSERT NEW ITEMS JUST BEFORE THIS LINE\r
	95	//\r
	96	NUM_ICHN_TYPES // the number of items in this enumeration\r
	97	} EFI_SMM_ICHN_SMI_TYPE;\r
	98	\r
	99	typedef struct {\r
	100	EFI_SMM_ICHN_SMI_TYPE Type;\r
	101	} EFI_SMM_ICHN_DISPATCH_CONTEXT;\r
	102	\r
	103	//\r
	104	// Member functions\r
	105	//\r
	106	/**\r
700a7869	107	Dispatch function for a ICHN specific SMI handler.\r
79964ac8	108	\r
	109	@param DispatchHandle Handle of this dispatch function.\r
	110	@param DispatchContext Pointer to the dispatch function's context.\r
	111	The DispatchContext fields are filled in\r
	112	by the dispatching driver prior to\r
	113	invoking this dispatch function.\r
	114	\r
700a7869	115	@return None\r
79964ac8	116	\r
	117	**/\r
	118	typedef\r
	119	VOID\r
69686d56	120	(EFIAPI *EFI_SMM_ICHN_DISPATCH)(\r
79964ac8	121	IN EFI_HANDLE DispatchHandle,\r
	122	IN EFI_SMM_ICHN_DISPATCH_CONTEXT *DispatchContext\r
	123	);\r
	124	\r
	125	/**\r
	126	Register a child SMI source dispatch function with a parent SMM driver\r
	127	\r
700a7869	128	@param This Pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance.\r
700a7869	129	@param DispatchFunction Function to install.\r
79964ac8	130	@param DispatchContext Pointer to the dispatch function's context.\r
5259c97d	131	The caller fills in this context before calling\r
79964ac8	132	the register function to indicate to the register\r
	133	function the ICHN SMI source for which the dispatch\r
	134	function should be invoked.\r
700a7869	135	@param DispatchHandle Handle generated by the dispatcher to track the function\r
700a7869	136	instance.\r
79964ac8	137	\r
	138	@retval EFI_SUCCESS The dispatch function has been successfully\r
	139	registered and the SMI source has been enabled.\r
5259c97d	140	@retval EFI_DEVICE_ERROR The driver could not enable the SMI source.\r
79964ac8	141	@retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this\r
	142	child.\r
	143	@retval EFI_INVALID_PARAMETER DispatchContext is invalid. The ICHN input value\r
	144	is not within valid range.\r
	145	\r
	146	**/\r
	147	typedef\r
	148	EFI_STATUS\r
69686d56	149	(EFIAPI *EFI_SMM_ICHN_REGISTER)(\r
700a7869	150	IN EFI_SMM_ICHN_DISPATCH_PROTOCOL *This,\r
	151	IN EFI_SMM_ICHN_DISPATCH DispatchFunction,\r
	152	IN EFI_SMM_ICHN_DISPATCH_CONTEXT *DispatchContext,\r
	153	OUT EFI_HANDLE *DispatchHandle\r
79964ac8	154	);\r
	155	\r
	156	/**\r
	157	Unregister a child SMI source dispatch function with a parent SMM driver\r
	158	\r
700a7869	159	@param This Pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance.\r
700a7869	160	@param DispatchHandle Handle of the service to remove.\r
79964ac8	161	\r
	162	@retval EFI_SUCCESS The dispatch function has been successfully\r
	163	unregistered and the SMI source has been disabled\r
	164	if there are no other registered child dispatch\r
	165	functions for this SMI source.\r
	166	@retval EFI_INVALID_PARAMETER Handle is invalid.\r
79964ac8	167	\r
	168	**/\r
	169	typedef\r
	170	EFI_STATUS\r
69686d56	171	(EFIAPI *EFI_SMM_ICHN_UNREGISTER)(\r
700a7869	172	IN EFI_SMM_ICHN_DISPATCH_PROTOCOL *This,\r
700a7869	173	IN EFI_HANDLE DispatchHandle\r
79964ac8	174	);\r
	175	\r
	176	//\r
700a7869	177	// Interface structure for the SMM ICHN specific SMI Dispatch Protocol\r
79964ac8	178	//\r
79964ac8	179	/**\r
79964ac8	180	Provides the parent dispatch service for a given SMI source generator.\r
79964ac8	181	**/\r
79964ac8	182	struct _EFI_SMM_ICHN_DISPATCH_PROTOCOL {\r
2bbaeb0d	183	EFI_SMM_ICHN_REGISTER Register; ///< Installs a child service to be dispatched by this protocol.\r
2bbaeb0d	184	EFI_SMM_ICHN_UNREGISTER UnRegister; ///< Removes a child service dispatched by this protocol.\r
79964ac8	185	};\r
	186	\r
	187	extern EFI_GUID gEfiSmmIchnDispatchProtocolGuid;\r
	188	\r
	189	#endif\r