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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
|
/** @file
eSPI SMI Dispatch header
Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _PCH_SMM_ESPI_H_
#define _PCH_SMM_ESPI_H_
#include "PchSmmHelpers.h"
#define ESPI_SMI_INSTANCE_SIGNATURE SIGNATURE_32 ('E', 'S', 'P', 'I')
#define ESPI_SMI_RECORD_SIGNATURE SIGNATURE_32 ('E', 'S', 'R', 'C')
#define ESPI_INSTANCE_FROM_THIS(_this) CR (_this, ESPI_SMI_INSTANCE, EfiEspiSmiDispatchProtocol, ESPI_SMI_INSTANCE_SIGNATURE)
#define ESPI_RECORD_FROM_LINK(_link) CR (_link, ESPI_SMI_RECORD, Link, ESPI_SMI_RECORD_SIGNATURE)
typedef enum {
EspiBiosWrProtect, ///< BIOS Write Protect
EspiSerialIrq, ///< eSPI Master Asserted SMI
EspiPmc, ///< eSPI PMC SMI
EspiTopLevelTypeMax
} ESPI_TOP_LEVEL_TYPE;
typedef enum {
BiosWrProtect, ///< BIOS Write Protect
BiosWrReport, ///< Peripheral Channel BIOS Write Protect
PcNonFatalErr, ///< Peripheral Channel Non Fatal Error
PcFatalErr, ///< Peripheral Channel Fatal Error
VwNonFatalErr, ///< Virtual Wire Non Fatal Error
VwFatalErr, ///< Virtual Wire Fatal Error
FlashNonFatalErr, ///< Flash Channel Non Fatal Error
FlashFatalErr, ///< Flash Channel Fatal Error
LnkType1Err, ///< Link Error
EspiSlaveSmi, ///< Espi Slave SMI
EspiSmiTypeMax
} ESPI_SMI_TYPE;
///
/// This is used to classify ESPI_SMI_TYPE to ESPI_TOP_LEVEL_TYPE.
/// Used during dispatching and unregistering
///
typedef struct {
ESPI_SMI_TYPE Start;
ESPI_SMI_TYPE End;
} ESPI_SMI_TYPE_BARRIER;
typedef struct _ESPI_SMI_INSTANCE {
///
/// Signature associated with this instance
///
UINT32 Signature;
///
/// EFI_HANDLE acquired when installing PchEspiSmiDispatchProtocol
///
EFI_HANDLE Handle;
///
/// The protocol to register or unregister eSPI SMI callbacks
///
PCH_ESPI_SMI_DISPATCH_PROTOCOL PchEspiSmiDispatchProtocol;
///
/// The handle acquired when registering eSPI SMI callback to PchSmiDispatch
///
EFI_HANDLE PchSmiEspiHandle[EspiTopLevelTypeMax];
///
/// The linked list for record database.
///
LIST_ENTRY CallbackDataBase[EspiSmiTypeMax];
///
/// This is an internal counter to track the number of eSPI master events have been registered.
/// When unregistering, we can disable the SMI if the counter is zero
///
UINTN EspiSmiEventCounter[EspiSmiTypeMax];
///
/// Instance of barrier
///
CONST ESPI_SMI_TYPE_BARRIER Barrier[EspiTopLevelTypeMax];
} ESPI_SMI_INSTANCE;
typedef struct _ESPI_DESCRIPTOR {
PCH_SMM_ADDRESS Address;
UINT32 SourceIsActiveAndMask;
UINT32 SourceIsActiveValue;
UINT32 ClearStatusAndMask;
UINT32 ClearStatusOrMask;
} ESPI_DESCRIPTOR;
///
/// A simple record to store the callbacks associated with an eSPI SMI source
///
typedef struct _ESPI_SMI_RECORD {
UINT32 Signature;
LIST_ENTRY Link;
PCH_ESPI_SMI_DISPATCH_CALLBACK Callback;
} ESPI_SMI_RECORD;
/**
Installs and initialize this protocol
@param[in] ImageHandle Not used
@retval EFI_SUCCESS Installation succeed
@retval others Installation failed
**/
EFI_STATUS
EFIAPI
InstallEspiSmi (
IN EFI_HANDLE ImageHandle
);
/**
eSPI SMI Dispatch Protocol instance to register a BIOS Write Protect event
@param[in] This Not used
@param[in] DispatchFunction The callback to execute
@param[out] DispatchHandle The handle for this callback registration
@retval EFI_SUCCESS Registration succeed
@retval EFI_ACCESS_DENIED Return access denied if the SmmReadyToLock event has been triggered
@retval others Registration failed
**/
EFI_STATUS
EFIAPI
BiosWrProtectRegister (
IN PCH_ESPI_SMI_DISPATCH_PROTOCOL *This,
IN PCH_ESPI_SMI_DISPATCH_CALLBACK DispatchFunction,
OUT EFI_HANDLE *DispatchHandle
);
/**
eSPI SMI Dispatch Protocol instance to register a BIOS Write Report event
@param[in] This Not used
@param[in] DispatchFunction The callback to execute
@param[out] DispatchHandle The handle for this callback registration
@retval EFI_SUCCESS Registration succeed
@retval EFI_ACCESS_DENIED Return access denied if the SmmReadyToLock event has been triggered
@retval others Registration failed
**/
EFI_STATUS
EFIAPI
BiosWrReportRegister (
IN PCH_ESPI_SMI_DISPATCH_PROTOCOL *This,
IN PCH_ESPI_SMI_DISPATCH_CALLBACK DispatchFunction,
OUT EFI_HANDLE *DispatchHandle
);
/**
eSPI SMI Dispatch Protocol instance to register a Peripheral Channel Non Fatal Error event
@param[in] This Not used
@param[in] DispatchFunction The callback to execute
@param[out] DispatchHandle The handle for this callback registration
@retval EFI_SUCCESS Registration succeed
@retval EFI_ACCESS_DENIED Return access denied if the SmmReadyToLock event has been triggered
@retval others Registration failed
**/
EFI_STATUS
EFIAPI
PcNonFatalErrRegister (
IN PCH_ESPI_SMI_DISPATCH_PROTOCOL *This,
IN PCH_ESPI_SMI_DISPATCH_CALLBACK DispatchFunction,
OUT EFI_HANDLE *DispatchHandle
);
/**
eSPI SMI Dispatch Protocol instance to register a Peripheral Channel Fatal Error event
@param[in] This Not used
@param[in] DispatchFunction The callback to execute
@param[out] DispatchHandle The handle for this callback registration
@retval EFI_SUCCESS Registration succeed
@retval EFI_ACCESS_DENIED Return access denied if the SmmReadyToLock event has been triggered
@retval others Registration failed
**/
EFI_STATUS
EFIAPI
PcFatalErrRegister (
IN PCH_ESPI_SMI_DISPATCH_PROTOCOL *This,
IN PCH_ESPI_SMI_DISPATCH_CALLBACK DispatchFunction,
OUT EFI_HANDLE *DispatchHandle
);
/**
eSPI SMI Dispatch Protocol instance to register a Virtual Wire Non Fatal Error event
@param[in] This Not used
@param[in] DispatchFunction The callback to execute
@param[out] DispatchHandle The handle for this callback registration
@retval EFI_SUCCESS Registration succeed
@retval EFI_ACCESS_DENIED Return access denied if the SmmReadyToLock event has been triggered
@retval others Registration failed
**/
EFI_STATUS
EFIAPI
VwNonFatalErrRegister (
IN PCH_ESPI_SMI_DISPATCH_PROTOCOL *This,
IN PCH_ESPI_SMI_DISPATCH_CALLBACK DispatchFunction,
OUT EFI_HANDLE *DispatchHandle
);
/**
eSPI SMI Dispatch Protocol instance to register a Virtual Wire Fatal Error event
@param[in] This Not used
@param[in] DispatchFunction The callback to execute
@param[out] DispatchHandle The handle for this callback registration
@retval EFI_SUCCESS Registration succeed
@retval EFI_ACCESS_DENIED Return access denied if the SmmReadyToLock event has been triggered
@retval others Registration failed
**/
EFI_STATUS
EFIAPI
VwFatalErrRegister (
IN PCH_ESPI_SMI_DISPATCH_PROTOCOL *This,
IN PCH_ESPI_SMI_DISPATCH_CALLBACK DispatchFunction,
OUT EFI_HANDLE *DispatchHandle
);
/**
eSPI SMI Dispatch Protocol instance to register a Flash Channel Non Fatal Error event
@param[in] This Not used
@param[in] DispatchFunction The callback to execute
@param[out] DispatchHandle The handle for this callback registration
@retval EFI_SUCCESS Registration succeed
@retval EFI_ACCESS_DENIED Return access denied if the SmmReadyToLock event has been triggered
@retval others Registration failed
**/
EFI_STATUS
EFIAPI
FlashNonFatalErrRegister (
IN PCH_ESPI_SMI_DISPATCH_PROTOCOL *This,
IN PCH_ESPI_SMI_DISPATCH_CALLBACK DispatchFunction,
OUT EFI_HANDLE *DispatchHandle
);
/**
eSPI SMI Dispatch Protocol instance to register a Flash Channel Fatal Error event
@param[in] This Not used
@param[in] DispatchFunction The callback to execute
@param[out] DispatchHandle The handle for this callback registration
@retval EFI_SUCCESS Registration succeed
@retval EFI_ACCESS_DENIED Return access denied if the SmmReadyToLock event has been triggered
@retval others Registration failed
**/
EFI_STATUS
EFIAPI
FlashFatalErrRegister (
IN PCH_ESPI_SMI_DISPATCH_PROTOCOL *This,
IN PCH_ESPI_SMI_DISPATCH_CALLBACK DispatchFunction,
OUT EFI_HANDLE *DispatchHandle
);
/**
eSPI SMI Dispatch Protocol instance to register a Link Error event
@param[in] This Not used
@param[in] DispatchFunction The callback to execute
@param[out] DispatchHandle The handle for this callback registration
@retval EFI_SUCCESS Registration succeed
@retval EFI_ACCESS_DENIED Return access denied if the SmmReadyToLock event has been triggered
@retval others Registration failed
**/
EFI_STATUS
EFIAPI
LnkType1ErrRegister (
IN PCH_ESPI_SMI_DISPATCH_PROTOCOL *This,
IN PCH_ESPI_SMI_DISPATCH_CALLBACK DispatchFunction,
OUT EFI_HANDLE *DispatchHandle
);
/**
eSPI SMI Dispatch Protocol instance to register a eSPI slave SMI
NOTE: The register function is not available when the ESPI_SMI_LOCK bit is set.
This runtine will also lock donw ESPI_SMI_LOCK bit after registration and
prevent this handler from unregistration.
On platform that supports more than 1 device through another chip select (SPT-H),
the SMI handler itself needs to inspect both the eSPI devices' interrupt status registers
(implementation specific for each Slave) in order to identify and service the cause.
After servicing it, it has to clear the Slaves' internal SMI# status registers
@param[in] This Not used
@param[in] DispatchFunction The callback to execute
@param[out] DispatchHandle The handle for this callback registration
@retval EFI_SUCCESS Registration succeed
@retval EFI_ACCESS_DENIED Return access denied if the SmmReadyToLock event has been triggered
@retval EFI_ACCESS_DENIED The ESPI_SMI_LOCK is set and register is blocked.
@retval others Registration failed
**/
EFI_STATUS
EFIAPI
EspiSlaveSmiRegister (
IN PCH_ESPI_SMI_DISPATCH_PROTOCOL *This,
IN PCH_ESPI_SMI_DISPATCH_CALLBACK DispatchFunction,
OUT EFI_HANDLE *DispatchHandle
);
/**
eSPI SMI Dispatch Protocol instance to unregister a callback based on handle
@param[in] This Not used
@param[in] DispatchHandle Handle acquired during registration
@retval EFI_SUCCESS Unregister successful
@retval EFI_INVALID_PARAMETER DispatchHandle is null
@retval EFI_INVALID_PARAMETER DispatchHandle's forward link has bad pointer
@retval EFI_INVALID_PARAMETER DispatchHandle does not exist in database
@retval EFI_ACCESS_DENIED Unregistration is done after end of DXE
@retval EFI_ACCESS_DENIED DispatchHandle is not allowed to unregistered
**/
EFI_STATUS
EFIAPI
EspiSmiUnRegister (
IN PCH_ESPI_SMI_DISPATCH_PROTOCOL *This,
IN EFI_HANDLE DispatchHandle
);
#endif
|
