[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
  Module Name:  SmmIchnDispatch.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_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 this context in 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 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 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
	15	Module Name: SmmIchnDispatch.h\r
	16	\r
	17	@par Revision Reference:\r
	18	This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
	19	Version 0.9.\r
	20	\r
	21	**/\r
	22	\r
	23	#ifndef _EFI_SMM_ICHN_DISPATCH_H_\r
	24	#define _EFI_SMM_ICHN_DISPATCH_H_\r
	25	\r
b80fbe85	26	\r
79964ac8	27	//\r
	28	// Global ID for the ICH SMI Protocol\r
	29	//\r
	30	#define EFI_SMM_ICHN_DISPATCH_PROTOCOL_GUID \\r
	31	{ \\r
	32	0xc50b323e, 0x9075, 0x4f2a, {0xac, 0x8e, 0xd2, 0x59, 0x6a, 0x10, 0x85, 0xcc } \\r
	33	}\r
	34	\r
	35	typedef struct _EFI_SMM_ICHN_DISPATCH_PROTOCOL EFI_SMM_ICHN_DISPATCH_PROTOCOL;\r
	36	\r
	37	//\r
	38	// Related Definitions\r
	39	//\r
	40	//\r
	41	// ICHN Specific SMIs. These are miscellaneous SMI sources that are supported by the\r
	42	// ICHN specific SMI implementation. These may change over time. TrapNumber is only\r
	43	// valid if the Type is Trap.\r
	44	//\r
	45	typedef enum {\r
	46	//\r
	47	// NOTE: NEVER delete items from this list/enumeration! Doing so will prevent other versions\r
	48	// of the code from compiling. If the ICH version your driver is written for doesn't support\r
	49	// some of these SMIs, then simply return EFI_UNSUPPORTED when a child/client tries to register\r
	50	// for them.\r
	51	//\r
	52	IchnMch,\r
	53	IchnPme,\r
	54	IchnRtcAlarm,\r
	55	IchnRingIndicate,\r
	56	IchnAc97Wake,\r
	57	IchnSerialIrq,\r
	58	IchnY2KRollover,\r
	59	IchnTcoTimeout,\r
	60	IchnOsTco,\r
	61	IchnNmi,\r
	62	IchnIntruderDetect,\r
	63	IchnBiosWp,\r
	64	IchnMcSmi,\r
	65	IchnPmeB0,\r
	66	IchnThrmSts,\r
	67	IchnSmBus,\r
	68	IchnIntelUsb2,\r
	69	IchnMonSmi7,\r
	70	IchnMonSmi6,\r
	71	IchnMonSmi5,\r
	72	IchnMonSmi4,\r
	73	IchnDevTrap13,\r
	74	IchnDevTrap12,\r
	75	IchnDevTrap11,\r
	76	IchnDevTrap10,\r
	77	IchnDevTrap9,\r
	78	IchnDevTrap8,\r
	79	IchnDevTrap7,\r
	80	IchnDevTrap6,\r
	81	IchnDevTrap5,\r
	82	IchnDevTrap3,\r
	83	IchnDevTrap2,\r
	84	IchnDevTrap1,\r
	85	IchnDevTrap0,\r
	86	IchnIoTrap3,\r
	87	IchnIoTrap2,\r
	88	IchnIoTrap1,\r
	89	IchnIoTrap0,\r
9d198522	90	IchnPciExpress,\r
	91	IchnMonitor,\r
	92	IchnSpi,\r
	93	IchnQRT,\r
	94	IchnGpioUnlock,\r
79964ac8	95	//\r
	96	// INSERT NEW ITEMS JUST BEFORE THIS LINE\r
	97	//\r
	98	NUM_ICHN_TYPES // the number of items in this enumeration\r
	99	} EFI_SMM_ICHN_SMI_TYPE;\r
	100	\r
	101	typedef struct {\r
	102	EFI_SMM_ICHN_SMI_TYPE Type;\r
	103	} EFI_SMM_ICHN_DISPATCH_CONTEXT;\r
	104	\r
	105	//\r
	106	// Member functions\r
	107	//\r
	108	/**\r
700a7869	109	Dispatch function for a ICHN specific SMI handler.\r
79964ac8	110	\r
	111	@param DispatchHandle Handle of this dispatch function.\r
	112	@param DispatchContext Pointer to the dispatch function's context.\r
	113	The DispatchContext fields are filled in\r
	114	by the dispatching driver prior to\r
	115	invoking this dispatch function.\r
	116	\r
700a7869	117	@return None\r
79964ac8	118	\r
	119	**/\r
	120	typedef\r
	121	VOID\r
69686d56	122	(EFIAPI *EFI_SMM_ICHN_DISPATCH)(\r
79964ac8	123	IN EFI_HANDLE DispatchHandle,\r
	124	IN EFI_SMM_ICHN_DISPATCH_CONTEXT *DispatchContext\r
	125	);\r
	126	\r
	127	/**\r
	128	Register a child SMI source dispatch function with a parent SMM driver\r
	129	\r
700a7869	130	@param This Pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance.\r
700a7869	131	@param DispatchFunction Function to install.\r
79964ac8	132	@param DispatchContext Pointer to the dispatch function's context.\r
	133	The caller fills this context in before calling\r
	134	the register function to indicate to the register\r
	135	function the ICHN SMI source for which the dispatch\r
	136	function should be invoked.\r
700a7869	137	@param DispatchHandle Handle generated by the dispatcher to track the function\r
700a7869	138	instance.\r
79964ac8	139	\r
	140	@retval EFI_SUCCESS The dispatch function has been successfully\r
	141	registered and the SMI source has been enabled.\r
	142	@retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.\r
	143	@retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this\r
	144	child.\r
	145	@retval EFI_INVALID_PARAMETER DispatchContext is invalid. The ICHN input value\r
	146	is not within valid range.\r
	147	\r
	148	**/\r
	149	typedef\r
	150	EFI_STATUS\r
69686d56	151	(EFIAPI *EFI_SMM_ICHN_REGISTER)(\r
700a7869	152	IN EFI_SMM_ICHN_DISPATCH_PROTOCOL *This,\r
	153	IN EFI_SMM_ICHN_DISPATCH DispatchFunction,\r
	154	IN EFI_SMM_ICHN_DISPATCH_CONTEXT *DispatchContext,\r
	155	OUT EFI_HANDLE *DispatchHandle\r
79964ac8	156	);\r
	157	\r
	158	/**\r
	159	Unregister a child SMI source dispatch function with a parent SMM driver\r
	160	\r
700a7869	161	@param This Pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance.\r
700a7869	162	@param DispatchHandle Handle of the service to remove.\r
79964ac8	163	\r
	164	@retval EFI_SUCCESS The dispatch function has been successfully\r
	165	unregistered and the SMI source has been disabled\r
	166	if there are no other registered child dispatch\r
	167	functions for this SMI source.\r
	168	@retval EFI_INVALID_PARAMETER Handle is invalid.\r
79964ac8	169	\r
	170	**/\r
	171	typedef\r
	172	EFI_STATUS\r
69686d56	173	(EFIAPI *EFI_SMM_ICHN_UNREGISTER)(\r
700a7869	174	IN EFI_SMM_ICHN_DISPATCH_PROTOCOL *This,\r
700a7869	175	IN EFI_HANDLE DispatchHandle\r
79964ac8	176	);\r
	177	\r
	178	//\r
700a7869	179	// Interface structure for the SMM ICHN specific SMI Dispatch Protocol\r
79964ac8	180	//\r
79964ac8	181	/**\r
79964ac8	182	Provides the parent dispatch service for a given SMI source generator.\r
79964ac8	183	**/\r
79964ac8	184	struct _EFI_SMM_ICHN_DISPATCH_PROTOCOL {\r
2bbaeb0d	185	EFI_SMM_ICHN_REGISTER Register; ///< Installs a child service to be dispatched by this protocol.\r
2bbaeb0d	186	EFI_SMM_ICHN_UNREGISTER UnRegister; ///< Removes a child service dispatched by this protocol.\r
79964ac8	187	};\r
	188	\r
	189	extern EFI_GUID gEfiSmmIchnDispatchProtocolGuid;\r
	190	\r
	191	#endif\r