1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
/** @file
SmmIchnDispatch Extended Protocol
@copyright
Copyright (c) 2008 - 2012 Intel Corporation. All rights reserved
This software and associated documentation (if any) is furnished
under a license and may only be used or copied in accordance
with the terms of the license. Except as permitted by such
license, no part of this software or documentation may be
reproduced, stored in a retrieval system, or transmitted in any
form or by any means without the express written consent of
Intel Corporation.
This file contains a 'Sample Driver' and is licensed as such
under the terms of your license agreement with Intel or your
vendor. This file may be modified by the user, subject to
the additional terms of the license agreement
**/
#ifndef _EFI_SMM_ICHN_DISPATCH_EX_H_
#define _EFI_SMM_ICHN_DISPATCH_EX_H_
///
/// GUID for the SmmIchnDispatch Extended Protocol
///
/// EDK and EDKII have different GUID formats
///
#if !defined(EDK_RELEASE_VERSION) || (EDK_RELEASE_VERSION < 0x00020000)
#define EFI_SMM_ICHN_DISPATCH_EX_PROTOCOL_GUID \
{ \
0x3920405b, 0xc897, 0x44da, 0x88, 0xf3, 0x4c, 0x49, 0x8a, 0x6f, 0xf7, 0x36 \
}
#else
#define EFI_SMM_ICHN_DISPATCH_EX_PROTOCOL_GUID \
{ \
0x3920405b, 0xc897, 0x44da, \
{ \
0x88, 0xf3, 0x4c, 0x49, 0x8a, 0x6f, 0xf7, 0x36 \
} \
}
#endif
//
// Extern the GUID for protocol users.
//
extern EFI_GUID gEfiSmmIchnDispatchExProtocolGuid;
//
// Forward reference for ANSI C compatibility
//
typedef struct _EFI_SMM_ICHN_DISPATCH_EX_PROTOCOL EFI_SMM_ICHN_DISPATCH_EX_PROTOCOL;
//
// Related Definitions
//
///
/// Ichn Dispatch Extended Types
///
typedef enum {
IchnExPciExpress = NUM_ICHN_TYPES + 1,
IchnExMonitor,
IchnExSpi,
IchnExQRT,
IchnExGpioUnlock,
IchnExTmrOverflow,
IchnExPcie0Hotplug,
IchnExPcie1Hotplug,
IchnExPcie2Hotplug,
IchnExPcie3Hotplug,
IchnExPcie4Hotplug,
IchnExPcie5Hotplug,
IchnExPcie6Hotplug,
IchnExPcie7Hotplug,
IchnExPcie0LinkActive,
IchnExPcie1LinkActive,
IchnExPcie2LinkActive,
IchnExPcie3LinkActive,
IchnExPcie4LinkActive,
IchnExPcie5LinkActive,
IchnExPcie6LinkActive,
IchnExPcie7LinkActive,
//
// INSERT NEW ITEMS JUST BEFORE THIS LINE
//
IchnExTypeMAX ///< the maximum number of items in this enumeration
} EFI_SMM_ICHN_EX_SMI_TYPE;
typedef struct {
EFI_SMM_ICHN_EX_SMI_TYPE Type;
} EFI_SMM_ICHN_DISPATCH_EX_CONTEXT;
//
// Member functions
//
/**
Dispatch function for a ICH n Extended specific SMI handler.
@param[in] DispatchHandle Handle of this dispatch function.
@param[in] DispatchContext Pointer to the dispatch function's context.
The DispatchContext fields are filled in
by the dispatching driver prior to
invoking this dispatch function.
@retval None
**/
typedef
VOID
(EFIAPI *EFI_SMM_ICHN_DISPATCH_EX) (
IN EFI_HANDLE DispatchHandle,
IN EFI_SMM_ICHN_DISPATCH_EX_CONTEXT * DispatchContext
);
/**
Register a child SMI source dispatch function with a parent SMM driver
@param[in] This Protocol instance pointer.
@param[in] DispatchFunction Pointer to dispatch function to be invoked for
this SMI source
@param[in] DispatchContext Pointer to the dispatch function's context.
The caller fills this context in before calling
the register function to indicate to the register
function the ICHN SMI source for which the dispatch
function should be invoked.
@param[out] DispatchHandle Handle of dispatch function, for when interfacing
with the parent SMM driver.
@retval EFI_SUCCESS The dispatch function has been successfully
registered and the SMI source has been enabled.
@retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
@retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
child.
@retval EFI_INVALID_PARAMETER DispatchContext is invalid. The ICHN input value
is not within valid range.
**/
typedef
EFI_STATUS
(EFIAPI *EFI_SMM_ICHN_EX_REGISTER) (
IN EFI_SMM_ICHN_DISPATCH_EX_PROTOCOL * This,
IN EFI_SMM_ICHN_DISPATCH_EX DispatchFunction,
IN EFI_SMM_ICHN_DISPATCH_EX_CONTEXT * DispatchContext,
OUT EFI_HANDLE * DispatchHandle
);
/**
Unregister a child SMI source dispatch function with a parent SMM driver
@param[in] This Protocol instance pointer.
@param[in] DispatchHandle Handle of dispatch function to deregister.
@retval EFI_SUCCESS The dispatch function has been successfully
unregistered and the SMI source has been disabled
if there are no other registered child dispatch
functions for this SMI source.
@retval EFI_INVALID_PARAMETER Handle is invalid.
@retval Others TBD
**/
typedef
EFI_STATUS
(EFIAPI *EFI_SMM_ICHN_EX_UNREGISTER) (
IN EFI_SMM_ICHN_DISPATCH_EX_PROTOCOL * This,
IN EFI_HANDLE DispatchHandle
);
///
/// Interface structure for the SMM Ich n specific SMI Dispatch Protocol
///
/// This protocol provides the ability to dispatch function for a ICHn specific SMI.
/// This protocol acts as an extension to the EFI_SMM_ICHN_DISPATCH_PROTOCOL capabilities
/// by defining several new SMI types: IchnExPciExpress, IchnExMonitor, IchnExSpi,
/// IchnExQRT, IchnGpioUnlockSmi, IchnExTmrOverflow, IchnExPcieXHotplug, IchnExPcieXLinkActive.
///
struct _EFI_SMM_ICHN_DISPATCH_EX_PROTOCOL {
EFI_SMM_ICHN_EX_REGISTER Register; ///< Register a child SMI source dispatch function with a parent SMM driver.
EFI_SMM_ICHN_EX_UNREGISTER UnRegister; ///< Un-register a child SMI source dispatch function with a parent SMM driver.
};
#endif
|
