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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
|
//*************************************************************************
//*************************************************************************
//** **
//** (C)Copyright 1985-2013, American Megatrends, Inc. **
//** **
//** All Rights Reserved. **
//** **
//** 5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093 **
//** **
//** Phone: (770)-246-8600 **
//** **
//*************************************************************************
//*************************************************************************
//*************************************************************************
// $Header: /Alaska/Projects/Intel/Haswell/LynxPoint_SharkBay-DT_Crb_1AQQW/CRB/CRBSmi.c 2 4/16/13 5:29a Thomaschen $
//
// $Revision: 2 $
//
// $Date: 4/16/13 5:29a $
//*************************************************************************
// Revision History
// ----------------
// $Log: /Alaska/Projects/Intel/Haswell/LynxPoint_SharkBay-DT_Crb_1AQQW/CRB/CRBSmi.c $
//
// 2 4/16/13 5:29a Thomaschen
//
// 1 2/12/12 10:38p Victortu
// Intel SharkBay CRB initially releases.
//
//*************************************************************************
//<AMI_FHDR_START>
//
// Name: CRBSMI.c
//
// Description: This file contains code for all CRB SMI events
//
//<AMI_FHDR_END>
//*************************************************************************
//---------------------------------------------------------------------------
// Include(s)
//---------------------------------------------------------------------------
#include <Token.h>
#include <AmiDxeLib.h>
#include <AmiCspLib.h>
// Produced Protocols
// Consumed Protocols
#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)
#include <Protocol\S3SmmSaveState.h>
#include <Protocol\SmmBase2.h>
#include <Protocol\SmmSwDispatch2.h>
#include <Protocol\SmmSxDispatch2.h>
#else
#include <Protocol\SmmBase.h>
#include <Protocol\SmmSwDispatch.h>
#include <Protocol\SmmSxDispatch.h>
#endif
//---------------------------------------------------------------------------
// Constant, Macro and Type Definition(s)
//---------------------------------------------------------------------------
// Constant Definition(s)
#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)
#define CRB_S3_SAVE_PROTOCOL EFI_S3_SAVE_STATE_PROTOCOL
#define CRB_SMM_SW_DISPATCH_PROTOCOL EFI_SMM_SW_DISPATCH2_PROTOCOL
#define CRB_SMM_SW_DISPATCH_CONTEXT EFI_SMM_SW_REGISTER_CONTEXT
#define CRB_SMM_SX_DISPATCH_PROTOCOL EFI_SMM_SX_DISPATCH2_PROTOCOL
#define CRB_SMM_SX_DISPATCH_CONTEXT EFI_SMM_SX_REGISTER_CONTEXT
#define SMM_CHILD_DISPATCH_SUCCESS EFI_SUCCESS
#else
#define CRB_S3_SAVE_PROTOCOL EFI_BOOT_SCRIPT_SAVE_PROTOCOL
#define CRB_SMM_SW_DISPATCH_PROTOCOL EFI_SMM_SW_DISPATCH_PROTOCOL
#define CRB_SMM_SW_DISPATCH_CONTEXT EFI_SMM_SW_DISPATCH_CONTEXT
#define CRB_SMM_SX_DISPATCH_PROTOCOL EFI_SMM_SX_DISPATCH_PROTOCOL
#define CRB_SMM_SX_DISPATCH_CONTEXT EFI_SMM_SX_DISPATCH_CONTEXT
#define SMM_CHILD_DISPATCH_SUCCESS
#endif
// Macro Definition(s)
// Type Definition(s)
// Function Prototype(s)
//---------------------------------------------------------------------------
// Variable and External Declaration(s)
//---------------------------------------------------------------------------
// Variable Declaration(s)
CRB_S3_SAVE_PROTOCOL *gBootScriptSave = NULL;
// GUID Definition(s)
// Protocol Definition(s)
// External Declaration(s)
// Function Definition(s)
//---------------------------------------------------------------------------
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
//
// Procedure: GetCRBSmiContext
//
// Description: This is a template CRB SMI GetContext for Porting.
//
// Input: None
//
// Output: None
//
// Notes: Here is the control flow of this function:
// 1. Check if CRB Smi source.
// 2. If yes, return TRUE.
// 3. If not, return FALSE.
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
BOOLEAN GetCRBSmiContext (VOID)
{
// Porting if needed
return FALSE;
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
//
// Procedure: CRBSmiHandler
//
// Description: This is a template CRB SMI Handler for Porting.
//
// Input: None
//
// Output: None
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
VOID CRBSmiHandler (VOID)
{
// Porting if needed
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
//
// Procedure: CRBSwSmiHandler
//
// Description: This is a template CRB software SMI Handler for Porting.
//
// Input: PI 0.91, 1.0
// DispatchHandle - SMI dispatcher handle
// *DispatchContext - Pointer to the dispatch context
// PI 1.1, 1.2
// DispatchHandle - SMI dispatcher handle
// *DispatchContext- Points to an optional S/W SMI context
// CommBuffer - Points to the optional communication
// buffer
// CommBufferSize - Points to the size of the optional
// communication buffer
//
// Output: EFI_STATUS if the new SMM PI is applied.
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)
EFI_STATUS CRBSwSmiHandler (
IN EFI_HANDLE DispatchHandle,
IN CONST VOID *DispatchContext OPTIONAL,
IN OUT VOID *CommBuffer OPTIONAL,
IN OUT UINTN *CommBufferSize OPTIONAL )
#else
VOID CRBSwSmiHandler (
IN EFI_HANDLE DispatchHandle,
IN EFI_SMM_SW_DISPATCH_CONTEXT *DispatchContext )
#endif
{
// Porting if needed
return SMM_CHILD_DISPATCH_SUCCESS;
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
//
// Procedure: CRBSxSmiHandler
//
// Description: This is a template CRB Sx SMI Handler for Porting.
//
// Input: PI 0.91, 1.0
// DispatchHandle - SMI dispatcher handle
// *DispatchContext - Pointer to the dispatch context
// PI 1.1, 1.2
// DispatchHandle - SMI dispatcher handle
// *DispatchContext- Points to an optional Sx SMI context
// CommBuffer - Points to the optional communication
// buffer
// CommBufferSize - Points to the size of the optional
// communication buffer
//
// Output: EFI_STATUS if the new SMM PI is applied.
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)
EFI_STATUS CRBSxSmiHandler (
IN EFI_HANDLE DispatchHandle,
IN CONST VOID *DispatchContext OPTIONAL,
IN OUT VOID *CommBuffer OPTIONAL,
IN OUT UINTN *CommBufferSize OPTIONAL )
#else
VOID CRBSxSmiHandler (
IN EFI_HANDLE DispatchHandle,
IN EFI_SMM_SX_DISPATCH_CONTEXT *DispatchContext )
#endif
{
// Porting if needed
return SMM_CHILD_DISPATCH_SUCCESS;
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
//
// Procedure: CRBChildDispatcher
//
// Description: This is an entry for CRB SMM Child Dispatcher Handler.
//
// Input: PI 0.91, 1.0
// SmmImageHandle - SMI Image Hander
// *CommunicationBuffer - Pointer to optional communication
// buffer
// *SourceSize - Pointer to size of communication
// buffer
// PI 1.1, 1.2
// DispatchHandle - SMI dispatcher handle
// *DispatchContext- Pointer to the dispatched context
// CommBuffer - Pointer to a collection of data in
// memory that will be conveyed from a
// non-SMM environment into an SMM
// environment
// CommBufferSize - Pointer to the size of the CommBuffer
//
// Output: EFI_STATUS
// EFI_HANDLER_SUCCESS
//
// Referrals: GetCRBSmiContext, CRBSmiHandler
//
// Notes: Here is the control flow of this function:
// 1. Read SMI source status registers.
// 2. If source, call handler.
// 3. Repeat #2 for all sources registered.
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS CRBChildDispatcher (
#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)
IN EFI_HANDLE DispatchHandle,
IN CONST VOID *DispatchContext OPTIONAL,
IN OUT VOID *CommBuffer OPTIONAL,
IN OUT UINTN *CommBufferSize OPTIONAL )
#else
IN EFI_HANDLE SmmImageHandle,
IN OUT VOID *CommunicationBuffer OPTIONAL,
IN OUT UINTN *SourceSize OPTIONAL )
#endif
{
if (GetCRBSmiContext()) CRBSmiHandler();
return EFI_HANDLER_SUCCESS;
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
//
// Procedure: InSmmFunction
//
// Description: Installs CRB SMM Child Dispatcher Handler.
//
// Input: ImageHandle - Image handle
// *SystemTable - Pointer to the system table
//
// Output: EFI_STATUS
// EFI_NOT_FOUND - The SMM Base protocol is not found.
// EFI_SUCCESS - Installs CRB SMM Child Dispatcher Handler
// successfully.
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS InSmmFunction (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable )
{
EFI_STATUS Status;
CRB_SMM_SW_DISPATCH_PROTOCOL *pSwDispatch;
CRB_SMM_SX_DISPATCH_PROTOCOL *pSxDispatch;
CRB_SMM_SW_DISPATCH_CONTEXT SwContext = {CRB_SWSMI};
CRB_SMM_SX_DISPATCH_CONTEXT SxContext = {SxS3, SxEntry};
EFI_HANDLE Handle;
#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)
EFI_HANDLE RootHandle;
#else
EFI_SMM_BASE_PROTOCOL *SmmBaseProtocol;
#endif
#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)
Status = InitAmiSmmLib( ImageHandle, SystemTable );
if (EFI_ERROR(Status)) return Status;
Status = pSmst->SmmLocateProtocol( &gEfiSmmSwDispatch2ProtocolGuid, \
NULL, \
&pSwDispatch );
if (!EFI_ERROR(Status)) {
Status = pSwDispatch->Register( pSwDispatch, \
CRBSwSmiHandler, \
&SwContext, \
&Handle );
}
Status = pSmst->SmmLocateProtocol( &gEfiSmmSxDispatch2ProtocolGuid, \
NULL, \
&pSxDispatch );
if (!EFI_ERROR(Status)) {
Status = pSxDispatch->Register( pSxDispatch, \
CRBSxSmiHandler, \
&SxContext, \
&Handle );
}
Status = pSmst->SmmLocateProtocol( &gEfiS3SmmSaveStateProtocolGuid, \
NULL, \
&gBootScriptSave );
ASSERT_EFI_ERROR(Status);
Status = pSmst->SmiHandlerRegister( CRBChildDispatcher, \
NULL, \
&RootHandle );
#else
Status = pBS->LocateProtocol( &gEfiSmmBaseProtocolGuid, \
NULL, \
&SmmBaseProtocol );
if (EFI_ERROR(Status)) return Status;
Status = pBS->LocateProtocol( &gEfiSmmSwDispatchProtocolGuid, \
NULL, \
&pSwDispatch );
if (!EFI_ERROR(Status)) {
Status = pSwDispatch->Register( pSwDispatch, \
CRBSwSmiHandler, \
&SwContext, \
&Handle );
}
Status = pBS->LocateProtocol( &gEfiSmmSxDispatchProtocolGuid, \
NULL, \
&pSxDispatch );
if (!EFI_ERROR(Status)) {
Status = pSxDispatch->Register( pSxDispatch, \
CRBSxSmiHandler, \
&SxContext, \
&Handle );
}
Status = pBS->LocateProtocol( &gEfiBootScriptSaveGuid, \
NULL, \
&gBootScriptSave );
ASSERT_EFI_ERROR(Status);
//Register call backs
Status = SmmBaseProtocol->RegisterCallback( SmmBaseProtocol, \
ImageHandle, \
CRBChildDispatcher, \
FALSE, \
FALSE );
#endif
return Status;
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
//
// Procedure: InitializeCRBSmm
//
// Description: Installs CRB SMM Child Dispatcher Handler.
//
// Input: ImageHandle - Image handle
// *SystemTable - Pointer to the system table
//
// Output: EFI_STATUS
// EFI_NOT_FOUND - The SMM Base protocol is not found.
// EFI_SUCCESS - Installs CRB SMM Child Dispatcher Handler
// successfully.
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS InitializeCRBSmm (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable )
{
InitAmiLib(ImageHandle, SystemTable);
return InitSmmHandler(ImageHandle, SystemTable, InSmmFunction, NULL);
}
//*************************************************************************
//*************************************************************************
//** **
//** (C)Copyright 1985-2013, American Megatrends, Inc. **
//** **
//** All Rights Reserved. **
//** **
//** 5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093 **
//** **
//** Phone: (770)-246-8600 **
//** **
//*************************************************************************
//*************************************************************************
|
