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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
|
//*************************************************************************
//*************************************************************************
//** **
//** (C)Copyright 1985-2011, American Megatrends, Inc. **
//** **
//** All Rights Reserved. **
//** **
//** 5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093 **
//** **
//** Phone: (770)-246-8600 **
//** **
//*************************************************************************
//*************************************************************************
//*************************************************************************
// $Header: /Alaska/BIN/Chipset/Intel/SouthBridge/LynxPoint/Intel Pch SB Chipset/SleepSmi/SleepSmi.c 4 9/26/12 3:59a Victortu $
//
// $Revision: 4 $
//
// $Date: 9/26/12 3:59a $
//*************************************************************************
// Revision History
// ----------------
// $Log: /Alaska/BIN/Chipset/Intel/SouthBridge/LynxPoint/Intel Pch SB Chipset/SleepSmi/SleepSmi.c $
//
// 4 9/26/12 3:59a Victortu
// [TAG] None
// [Category] Improvement
// [Description] Update for PCH LP GPIO compatible.
// [Files] SB.sdl, SB.H, AcpiModeEnable.c, AcpiModeEnable.sdl,
// SBDxe.c, SBGeneric.c, SBPEI.c, SBSMI.c, SleepSmi.c,
// SmiHandlerPorting.c, SmiHandlerPorting2.c
//
// 3 7/27/12 6:17a Victortu
// [TAG] None
// [Category] Improvement
// [Description] Update to support ULT Platform.
// [Files] SB.H, SB.mak, SB.sdl, SB.sd, SBSetup.c,
// AcpiModeEnable.c, SBDxe.c, SBPEI.c, SBSMI.c, SleepSmi.c,
// SmiHandlerPorting.c, SmiHandlerPorting2.c, SBPPI.h, Pch.sdl
//
// 2 6/13/12 11:29p Victortu
// [TAG] None
// [Category] Improvement
// [Description] Program AfterG3 bit depend the setup question in
// S3/S4/S5.
// [Files] SleepSmi.c
//
// 1 2/08/12 8:30a Yurenlai
// Intel Lynx Point/SB eChipset initially releases.
//
//*************************************************************************
//<AMI_FHDR_START>
//
// Name: SleepSmi.C
//
// Description: Provide functions to register and handle Sleep SMI
// functionality.
//
//<AMI_FHDR_END>
//*************************************************************************
//---------------------------------------------------------------------------
// Include(s)
//---------------------------------------------------------------------------
#include <Token.h>
#include <Setup.h>
#include <AmiDxeLib.h>
#include <AmiCspLib.h>
#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)&&(CORE_COMBINED_VERSION >= 0x4028B)
#include <Protocol\SmmBase2.h>
#include <Protocol\SmmSxDispatch2.h>
#else
#include <Protocol\SmmBase.h>
#include <Protocol\SmmSxDispatch.h>
#endif
#include <PchAccess.h>
//---------------------------------------------------------------------------
// Constant, Macro and Type Definition(s)
//---------------------------------------------------------------------------
// Constant Definition(s)
#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)&&(CORE_COMBINED_VERSION >= 0x4028B)
#define AMI_SMM_SX_DISPATCH_PROTOCOL EFI_SMM_SX_DISPATCH2_PROTOCOL
#define AMI_SMM_SX_DISPATCH_CONTEXT EFI_SMM_SX_REGISTER_CONTEXT
#define SMM_CHILD_DISPATCH_SUCCESS EFI_SUCCESS
#else
#define AMI_SMM_SX_DISPATCH_PROTOCOL EFI_SMM_SX_DISPATCH_PROTOCOL
#define AMI_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)
BOOLEAN gIsLastState = FALSE;
BOOLEAN gPchWakeOnLan = FALSE;
#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)&&(CORE_COMBINED_VERSION >= 0x4028B)
EFI_SMM_BASE2_PROTOCOL *gSmmBase2;
#endif
// GUID Definition(s)
EFI_GUID gThisFileGuid = \
{0x6298fe18, 0xd5ef, 0x42b7, 0xbb, 0xc, 0x29, 0x53, 0x28, 0x3f, 0x57, 0x4};
// {6298FE18-D5EF-42b7-BB0C-2953283F5704}
// Protocol Definition(s)
// External Declaration(s)
// Function Definition(s)
//---------------------------------------------------------------------------
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
//
// Procedure: ProgramAfterG3Bit
//
// Description: This function will set AfterG3 bit depend the setup question.
//
// Input: None
//
// Output: None
//
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
VOID ProgramAfterG3Bit(VOID)
{
if (gIsLastState) SET_PCI8_SB(SB_REG_GEN_PMCON_3, 1); // 0xA4
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
//
// Procedure: S1SleepSmiOccurred
//
// Description: This function will be called by EfiSmmSxDispatch when a Sleep
// SMI occurs and the sleep state is S1.
//
// Input: DispatchHandle - SMI dispatcher handle
// *DispatchContext - Pointer to the dispatch context
//
// Output: Nothing
//
// Notes: This function does not need to put the system to sleep. This is
// handled by PutToSleep.
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)&&(CORE_COMBINED_VERSION >= 0x4028B)
EFI_STATUS S1SleepSmiOccurred (
IN EFI_HANDLE DispatchHandle,
IN CONST VOID *DispatchContext OPTIONAL,
IN OUT VOID *CommBuffer OPTIONAL,
IN OUT UINTN *CommBufferSize OPTIONAL )
#else
VOID S1SleepSmiOccurred (
IN EFI_HANDLE DispatchHandle,
IN EFI_SMM_SX_DISPATCH_CONTEXT *DispatchContext )
#endif
{
// Porting required if any workaround is needed.
return SMM_CHILD_DISPATCH_SUCCESS;
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
//
// Procedure: S3SleepSmiOccurred
//
// Description: This function will be called by EfiSmmSxDispatch when a Sleep
// SMI occurs and the sleep state is S3.
//
// Input: DispatchHandle - SMI dispatcher handle
// *DispatchContext - Pointer to the dispatch context
//
// Output: Nothing
//
// Notes: This function does not need to put the system to sleep. This is
// handled by PutToSleep.
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)&&(CORE_COMBINED_VERSION >= 0x4028B)
EFI_STATUS S3SleepSmiOccurred (
IN EFI_HANDLE DispatchHandle,
IN CONST VOID *DispatchContext OPTIONAL,
IN OUT VOID *CommBuffer OPTIONAL,
IN OUT UINTN *CommBufferSize OPTIONAL )
#else
VOID S3SleepSmiOccurred (
IN EFI_HANDLE DispatchHandle,
IN EFI_SMM_SX_DISPATCH_CONTEXT *DispatchContext )
#endif
{
BOOLEAN IsGpioLocked;
UINT16 LpcDeviceId;
LpcDeviceId = READ_PCI16_SB(R_PCH_LPC_DEVICE_ID);
IsGpioLocked = (READ_PCI8_SB(SB_REG_GC) & BIT00)? TRUE:FALSE;
if (IS_PCH_LPT_LPC_DEVICE_ID_MOBILE (LpcDeviceId)) {
// Reset GPIO Lockdown Enable (GLE)
if (IsGpioLocked)
RESET_PCI8_SB(SB_REG_GC, BIT00);
// Set GPIO 60 to low (S3 power)
if (GetPchSeries() == PchLp) {
RESET_IO32( GPIO_BASE_ADDRESS + (GP_IOREG_GP_GPN_CFG1 + GP_GPIO_CONFIG_SIZE*60), ~BIT31); // 0x38
} else {
RESET_IO32( GPIO_BASE_ADDRESS + GP_IOREG_GP_LVL2, ~0xEFFFFFFF); // 0x38
}
// Set GPIO Lockdown Enable (GLE)
if (IsGpioLocked)
SET_PCI8_SB(SB_REG_GC, BIT00);
}
ProgramAfterG3Bit();
return SMM_CHILD_DISPATCH_SUCCESS;
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
//
// Procedure: S4SleepSmiOccurred
//
// Description: This function will be called by EfiSmmSxDispatch when a Sleep
// SMI occurs and the sleep state is S4.
//
// Input: DispatchHandle - SMI dispatcher handle
// *DispatchContext - Pointer to the dispatch context
//
// Output: Nothing
//
// Notes: This function does not need to put the system to sleep. This is
// handled by PutToSleep.
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)&&(CORE_COMBINED_VERSION >= 0x4028B)
EFI_STATUS S4SleepSmiOccurred (
IN EFI_HANDLE DispatchHandle,
IN CONST VOID *DispatchContext OPTIONAL,
IN OUT VOID *CommBuffer OPTIONAL,
IN OUT UINTN *CommBufferSize OPTIONAL )
#else
VOID S4SleepSmiOccurred (
IN EFI_HANDLE DispatchHandle,
IN EFI_SMM_SX_DISPATCH_CONTEXT *DispatchContext )
#endif
{
ClearMeWakeSts();
ProgramAfterG3Bit();
return SMM_CHILD_DISPATCH_SUCCESS;
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
//
// Procedure: S5SleepSmiOccurred
//
// Description: This function will be called by EfiSmmSxDispatch when a Sleep
// SMI occurs and the sleep state is S1.
//
// Input: DispatchHandle - SMI dispatcher handle
// *DispatchContext - Pointer to the dispatch context
//
// Output: Nothing
//
// Notes: This function does not need to put the system to sleep. This is
// handled by PutToSleep.
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)&&(CORE_COMBINED_VERSION >= 0x4028B)
EFI_STATUS S5SleepSmiOccurred (
IN EFI_HANDLE DispatchHandle,
IN CONST VOID *DispatchContext OPTIONAL,
IN OUT VOID *CommBuffer OPTIONAL,
IN OUT UINTN *CommBufferSize OPTIONAL )
#else
VOID S5SleepSmiOccurred (
IN EFI_HANDLE DispatchHandle,
IN EFI_SMM_SX_DISPATCH_CONTEXT *DispatchContext )
#endif
{
ClearMeWakeSts();
SBLib_BeforeShutdown();
if (gPchWakeOnLan) Enable_GbE_PME();
// Program AfterG3 bit depend the setup question.
ProgramAfterG3Bit();
return SMM_CHILD_DISPATCH_SUCCESS;
}
//----------------------------------------------------------------------------
//
// Procedure: InSmmFunction
//
// Description: Install Sleep SMI Handlers for south bridge.
//
// Input: ImageHandle - Image handle
// *SystemTable - Pointer to the system table
//
// Output: EFI_STATUS
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS InSmmFunction (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable )
{
EFI_STATUS Status;
EFI_HANDLE hS1Smi;
EFI_HANDLE hS3Smi;
EFI_HANDLE hS4Smi;
EFI_HANDLE hS5Smi;
AMI_SMM_SX_DISPATCH_PROTOCOL *SxDispatch;
AMI_SMM_SX_DISPATCH_CONTEXT S1DispatchContext = {SxS1, SxEntry};
AMI_SMM_SX_DISPATCH_CONTEXT S3DispatchContext = {SxS3, SxEntry};
AMI_SMM_SX_DISPATCH_CONTEXT S4DispatchContext = {SxS4, SxEntry};
AMI_SMM_SX_DISPATCH_CONTEXT S5DispatchContext = {SxS5, SxEntry};
#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)&&(CORE_COMBINED_VERSION >= 0x4028B)
EFI_SMM_SYSTEM_TABLE2 *pSmst2;
#endif
#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)&&(CORE_COMBINED_VERSION >= 0x4028B)
Status = InitAmiSmmLib( ImageHandle, SystemTable );
if (EFI_ERROR(Status)) return Status;
// We are in SMM, retrieve the pointer to SMM System Table
Status = gSmmBase2->GetSmstLocation( gSmmBase2, &pSmst2);
if (EFI_ERROR(Status)) return EFI_UNSUPPORTED;
Status = pSmst2->SmmLocateProtocol( &gEfiSmmSxDispatch2ProtocolGuid , \
NULL, \
&SxDispatch );
TRACE((TRACE_ALWAYS, "Smm Locate Protocol gEfiSmmSxDispatch2ProtocolGuid, Status = %r\n",Status));
#else
Status = pBS->LocateProtocol( &gEfiSmmSxDispatchProtocolGuid , \
NULL, \
&SxDispatch );
#endif
if (EFI_ERROR(Status)) return Status;
// Register Sleep SMI Handlers
Status = SxDispatch->Register( SxDispatch, \
S1SleepSmiOccurred, \
&S1DispatchContext, \
&hS1Smi );
if (EFI_ERROR(Status)) return Status;
Status = SxDispatch->Register( SxDispatch, \
S3SleepSmiOccurred, \
&S3DispatchContext, \
&hS3Smi );
if (EFI_ERROR(Status)) return Status;
Status = SxDispatch->Register( SxDispatch, \
S4SleepSmiOccurred, \
&S4DispatchContext, \
&hS4Smi );
if (EFI_ERROR(Status)) return Status;
Status = SxDispatch->Register( SxDispatch, \
S5SleepSmiOccurred, \
&S5DispatchContext, \
&hS5Smi );
return Status;
}
//<AMI_PHDR_START>
//----------------------------------------------------------------------------
//
// Procedure: InitSleepSmi
//
// Description: This function Registers Sleep SMI functionality.
//
// Input: ImageHandle - Handle for this FFS image
// *SystemTable- Pointer to the system table
//
// Output: EFI_STATUS
//----------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS InitSleepSmi (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable )
{
EFI_STATUS Status;
SB_SETUP_DATA *SbSetupData = NULL;
UINTN VariableSize = sizeof(SB_SETUP_DATA);
InitAmiLib( ImageHandle, SystemTable );
#if defined(PI_SPECIFICATION_VERSION)&&(PI_SPECIFICATION_VERSION>=0x0001000A)&&(CORE_COMBINED_VERSION >= 0x4028B)
Status = SystemTable->BootServices->LocateProtocol( \
&gEfiSmmBase2ProtocolGuid, \
NULL, \
&gSmmBase2 );
ASSERT_EFI_ERROR(Status);
#endif
// Porting Required
// Put the Setup Vairable to SMM if needed.
Status = pBS->AllocatePool( EfiBootServicesData, \
VariableSize, \
&SbSetupData );
ASSERT_EFI_ERROR(Status);
GetSbSetupData( pRS, SbSetupData, FALSE );
gIsLastState = (SbSetupData->LastState == 2) ? TRUE : FALSE;
gPchWakeOnLan = (SbSetupData->PchWakeOnLan == 1) ? TRUE : FALSE;
Status = pBS->FreePool( SbSetupData );
// Porting End
return InitSmmHandler( ImageHandle, SystemTable, InSmmFunction, NULL );
}
//*************************************************************************
//*************************************************************************
//** **
//** (C)Copyright 1985-2011, American Megatrends, Inc. **
//** **
//** All Rights Reserved. **
//** **
//** 5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093 **
//** **
//** Phone: (770)-246-8600 **
//** **
//*************************************************************************
//*************************************************************************
|
