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, 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_
29 // Global ID for the ICH SMI Protocol
31 #define EFI_SMM_ICHN_DISPATCH_PROTOCOL_GUID \
33 0xc50b323e, 0x9075, 0x4f2a, {0xac, 0x8e, 0xd2, 0x59, 0x6a, 0x10, 0x85, 0xcc } \
36 typedef struct _EFI_SMM_ICHN_DISPATCH_PROTOCOL EFI_SMM_ICHN_DISPATCH_PROTOCOL
;
39 // Related Definitions
42 // ICHN Specific SMIs. These are miscellaneous SMI sources that are supported by the
43 // ICHN specific SMI implementation. These may change over time. TrapNumber is only
44 // valid if the Type is Trap.
48 // NOTE: NEVER delete items from this list/enumeration! Doing so will prevent other versions
49 // of the code from compiling. If the ICH version your driver is written for doesn't support
50 // some of these SMIs, then simply return EFI_UNSUPPORTED when a child/client tries to register
97 // INSERT NEW ITEMS JUST BEFORE THIS LINE
99 NUM_ICHN_TYPES
// the number of items in this enumeration
100 } EFI_SMM_ICHN_SMI_TYPE
;
103 EFI_SMM_ICHN_SMI_TYPE Type
;
104 } EFI_SMM_ICHN_DISPATCH_CONTEXT
;
110 Dispatch function for a ICH n specific SMI handler.
112 @param DispatchHandle Handle of this dispatch function.
113 @param DispatchContext Pointer to the dispatch function's context.
114 The DispatchContext fields are filled in
115 by the dispatching driver prior to
116 invoking this dispatch function.
123 (EFIAPI
*EFI_SMM_ICHN_DISPATCH
) (
124 IN EFI_HANDLE DispatchHandle
,
125 IN EFI_SMM_ICHN_DISPATCH_CONTEXT
*DispatchContext
129 Register a child SMI source dispatch function with a parent SMM driver
131 @param This Protocol instance pointer.
132 @param DispatchFunction Pointer to dispatch function to be invoked for
134 @param DispatchContext Pointer to the dispatch function's context.
135 The caller fills this context in before calling
136 the register function to indicate to the register
137 function the ICHN SMI source for which the dispatch
138 function should be invoked.
139 @param DispatchHandle Handle of dispatch function, for when interfacing
140 with the parent Sx state SMM driver.
142 @retval EFI_SUCCESS The dispatch function has been successfully
143 registered and the SMI source has been enabled.
144 @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
145 @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
147 @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The ICHN input value
148 is not within valid range.
153 (EFIAPI
*EFI_SMM_ICHN_REGISTER
) (
154 IN EFI_SMM_ICHN_DISPATCH_PROTOCOL
*This
,
155 IN EFI_SMM_ICHN_DISPATCH DispatchFunction
,
156 IN EFI_SMM_ICHN_DISPATCH_CONTEXT
*DispatchContext
,
157 OUT EFI_HANDLE
*DispatchHandle
161 Unregister a child SMI source dispatch function with a parent SMM driver
163 @param This Protocol instance pointer.
164 @param DispatchHandle Handle of dispatch function to deregister.
166 @retval EFI_SUCCESS The dispatch function has been successfully
167 unregistered and the SMI source has been disabled
168 if there are no other registered child dispatch
169 functions for this SMI source.
170 @retval EFI_INVALID_PARAMETER Handle is invalid.
176 (EFIAPI
*EFI_SMM_ICHN_UNREGISTER
) (
177 IN EFI_SMM_ICHN_DISPATCH_PROTOCOL
*This
,
178 IN EFI_HANDLE DispatchHandle
182 // Interface structure for the SMM Ich n specific SMI Dispatch Protocol
185 @par Protocol Description:
186 Provides the parent dispatch service for a given SMI source generator.
189 Installs a child service to be dispatched by this protocol.
192 Removes a child service dispatched by this protocol.
195 struct _EFI_SMM_ICHN_DISPATCH_PROTOCOL
{
196 EFI_SMM_ICHN_REGISTER Register
;
197 EFI_SMM_ICHN_UNREGISTER UnRegister
;
200 extern EFI_GUID gEfiSmmIchnDispatchProtocolGuid
;