2 Provides the parent dispatch service for a given SMI source generator.
3 The EFI_SMM_ICHN_DISPATCH_PROTOCOL provides the ability to install child handlers for
6 Copyright (c) 2008 - 2009, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 Module Name: SmmIchnDispatch.h
17 @par Revision Reference:
18 This Protocol is defined in Framework of EFI SMM Core Interface Spec
23 #ifndef _EFI_SMM_ICHN_DISPATCH_H_
24 #define _EFI_SMM_ICHN_DISPATCH_H_
28 // Global ID for the ICH SMI Protocol
30 #define EFI_SMM_ICHN_DISPATCH_PROTOCOL_GUID \
32 0xc50b323e, 0x9075, 0x4f2a, {0xac, 0x8e, 0xd2, 0x59, 0x6a, 0x10, 0x85, 0xcc } \
35 typedef struct _EFI_SMM_ICHN_DISPATCH_PROTOCOL EFI_SMM_ICHN_DISPATCH_PROTOCOL
;
38 // Related Definitions
41 // ICHN Specific SMIs. These are miscellaneous SMI sources that are supported by the
42 // ICHN specific SMI implementation. These may change over time. TrapNumber is only
43 // valid if the Type is Trap.
47 // NOTE: NEVER delete items from this list/enumeration! Doing so will prevent other versions
48 // of the code from compiling. If the ICH version your driver is written for doesn't support
49 // some of these SMIs, then simply return EFI_UNSUPPORTED when a child/client tries to register
96 // INSERT NEW ITEMS JUST BEFORE THIS LINE
98 NUM_ICHN_TYPES
// the number of items in this enumeration
99 } EFI_SMM_ICHN_SMI_TYPE
;
102 EFI_SMM_ICHN_SMI_TYPE Type
;
103 } EFI_SMM_ICHN_DISPATCH_CONTEXT
;
109 Dispatch function for a ICHN specific SMI handler.
111 @param DispatchHandle Handle of this dispatch function.
112 @param DispatchContext Pointer to the dispatch function's context.
113 The DispatchContext fields are filled in
114 by the dispatching driver prior to
115 invoking this dispatch function.
122 (EFIAPI
*EFI_SMM_ICHN_DISPATCH
)(
123 IN EFI_HANDLE DispatchHandle
,
124 IN EFI_SMM_ICHN_DISPATCH_CONTEXT
*DispatchContext
128 Register a child SMI source dispatch function with a parent SMM driver
130 @param This Pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance.
131 @param DispatchFunction Function to install.
132 @param DispatchContext Pointer to the dispatch function's context.
133 The caller fills this context in before calling
134 the register function to indicate to the register
135 function the ICHN SMI source for which the dispatch
136 function should be invoked.
137 @param DispatchHandle Handle generated by the dispatcher to track the function
140 @retval EFI_SUCCESS The dispatch function has been successfully
141 registered and the SMI source has been enabled.
142 @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
143 @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
145 @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The ICHN input value
146 is not within valid range.
151 (EFIAPI
*EFI_SMM_ICHN_REGISTER
)(
152 IN EFI_SMM_ICHN_DISPATCH_PROTOCOL
*This
,
153 IN EFI_SMM_ICHN_DISPATCH DispatchFunction
,
154 IN EFI_SMM_ICHN_DISPATCH_CONTEXT
*DispatchContext
,
155 OUT EFI_HANDLE
*DispatchHandle
159 Unregister a child SMI source dispatch function with a parent SMM driver
161 @param This Pointer to the EFI_SMM_ICHN_DISPATCH_PROTOCOL instance.
162 @param DispatchHandle Handle of the service to remove.
164 @retval EFI_SUCCESS The dispatch function has been successfully
165 unregistered and the SMI source has been disabled
166 if there are no other registered child dispatch
167 functions for this SMI source.
168 @retval EFI_INVALID_PARAMETER Handle is invalid.
173 (EFIAPI
*EFI_SMM_ICHN_UNREGISTER
)(
174 IN EFI_SMM_ICHN_DISPATCH_PROTOCOL
*This
,
175 IN EFI_HANDLE DispatchHandle
179 // Interface structure for the SMM ICHN specific SMI Dispatch Protocol
182 Provides the parent dispatch service for a given SMI source generator.
184 struct _EFI_SMM_ICHN_DISPATCH_PROTOCOL
{
185 EFI_SMM_ICHN_REGISTER Register
; ///< Installs a child service to be dispatched by this protocol.
186 EFI_SMM_ICHN_UNREGISTER UnRegister
; ///< Removes a child service dispatched by this protocol.
189 extern EFI_GUID gEfiSmmIchnDispatchProtocolGuid
;