/** @file\r
- This file declares EFI Smm ICH [N] Specific Smi Child Protocol\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) 2007, Intel Corporation\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
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
#ifndef _EFI_SMM_ICHN_DISPATCH_H_\r
#define _EFI_SMM_ICHN_DISPATCH_H_\r
\r
-#include <PiDxe.h>\r
\r
//\r
// Global ID for the ICH SMI Protocol\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
// Member functions\r
//\r
/**\r
- Dispatch function for a ICH n specific SMI handler.\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
by the dispatching driver prior to\r
invoking this dispatch function.\r
\r
- Nothing\r
+ @return None\r
\r
**/\r
typedef\r
VOID\r
-(EFIAPI *EFI_SMM_ICHN_DISPATCH) (\r
+(EFIAPI *EFI_SMM_ICHN_DISPATCH)(\r
IN EFI_HANDLE DispatchHandle,\r
IN EFI_SMM_ICHN_DISPATCH_CONTEXT *DispatchContext\r
);\r
/**\r
Register a child SMI source dispatch function with a parent SMM driver\r
\r
- @param This Protocol instance pointer.\r
- @param DispatchFunction Pointer to dispatch function to be invoked for\r
- this SMI source\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 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 of dispatch function, for when interfacing\r
- with the parent Sx state SMM driver.\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_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
**/\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
+(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 Protocol instance pointer.\r
- @param DispatchHandle Handle of dispatch function to deregister.\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
- @retval other TBD\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
+(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 Ich n specific SMI Dispatch Protocol\r
+// Interface structure for the SMM ICHN specific SMI Dispatch Protocol\r
//\r
/**\r
- @par Protocol Description:\r
Provides the parent dispatch service for a given 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
**/\r
struct _EFI_SMM_ICHN_DISPATCH_PROTOCOL {\r
- EFI_SMM_ICHN_REGISTER Register;\r
- EFI_SMM_ICHN_UNREGISTER UnRegister;\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
projects / mirror_edk2.git / blobdiff