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
|
/* $NoKeywords:$ */
/**
* @file
*
* AMD AGESA Basic Level Public APIs
*
* Contains basic Level Initialization routines.
*
* @xrefitem bom "File Content Label" "Release Content"
* @e project: AGESA
* @e sub-project: Interface
* @e \$Revision: 55552 $ @e \$Date: 2011-06-22 09:31:58 -0600 (Wed, 22 Jun 2011) $
*
*/
/*****************************************************************************
*
* Copyright (C) 2012 Advanced Micro Devices, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of Advanced Micro Devices, Inc. nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL ADVANCED MICRO DEVICES, INC. BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
******************************************************************************
*/
/*----------------------------------------------------------------------------------------
* M O D U L E S U S E D
*----------------------------------------------------------------------------------------
*/
#include "AGESA.h"
#include "amdlib.h"
#include "Ids.h"
#include "mm.h"
#include "mn.h"
#include "S3.h"
#include "mfs3.h"
#include "CommonInits.h"
#include "AmdFch.h"
#include "Filecode.h"
#include "heapManager.h"
#include "CreateStruct.h"
CODE_GROUP (G3_DXE)
RDATA_GROUP (G3_DXE)
#define FILECODE PROC_COMMON_AMDS3SAVE_FILECODE
extern BLDOPT_FCH_FUNCTION BldoptFchFunction;
/*----------------------------------------------------------------------------------------
* D E F I N I T I O N S A N D M A C R O S
*----------------------------------------------------------------------------------------
*/
/*----------------------------------------------------------------------------------------
* T Y P E D E F S A N D S T R U C T U R E S
*----------------------------------------------------------------------------------------
*/
CONST UINT32 ROMDATA S3LateHeapTable[] =
{
EVENT_LOG_BUFFER_HANDLE,
SOCKET_DIE_MAP_HANDLE,
NODE_ID_MAP_HANDLE,
LOCAL_AP_MAIL_BOX_CACHE_HANDLE,
IDS_CONTROL_HANDLE,
AMD_S3_SCRIPT_SAVE_TABLE_HANDLE,
AMD_PCIE_COMPLEX_DATA_HANDLE
};
#define S3LATE_TABLE_SIZE (sizeof (S3LateHeapTable) / sizeof (UINT32)) //(sizeof (S3LateHeapTable) / sizeof (S3LATE_HEAP_ELEMENT))
/*----------------------------------------------------------------------------------------
* P R O T O T Y P E S O F L O C A L F U N C T I O N S
*----------------------------------------------------------------------------------------
*/
AGESA_STATUS
AmdS3SavePlatformConfigInit (
IN OUT PLATFORM_CONFIGURATION *PlatformConfig,
IN OUT AMD_CONFIG_PARAMS *StdHeader
);
/*----------------------------------------------------------------------------------------
* E X P O R T E D F U N C T I O N S
*----------------------------------------------------------------------------------------
*/
extern BUILD_OPT_CFG UserOptions;
/*---------------------------------------------------------------------------------------*/
/**
* Main entry point for the AMD_S3_SAVE function.
*
* This entry point is responsible for saving silicon component registers to the
* SMM save area in preparation of entering system suspend-to-RAM mode.
*
* @param[in,out] AmdS3SaveParams Required input parameters for the AMD_S3_SAVE
* entry point.
*
* @return Aggregated status across all internal AMD S3 save calls invoked.
*
*/
AGESA_STATUS
AmdS3Save (
IN OUT AMD_S3SAVE_PARAMS *AmdS3SaveParams
)
{
UINTN i;
UINT32 EarlyBufferSize;
UINT32 LateBufferSize;
UINT32 LateContextSize;
UINT32 HeapSize;
UINT8 *BufferPointer;
UINT8 HeapStatus;
ALLOCATE_HEAP_PARAMS HeapParams;
LOCATE_HEAP_PTR LocateHeap;
BUFFER_NODE *FreeSpaceNode;
ALLOCATE_HEAP_PARAMS AllocParams;
DEVICE_BLOCK_HEADER *MemoryRelatedDeviceList;
DEVICE_BLOCK_HEADER *NonMemoryRelatedDeviceList;
AGESA_STATUS ReturnStatus;
VOID *HeapPtrs[S3LATE_TABLE_SIZE];
UINT32 HeapSizes[S3LATE_TABLE_SIZE];
UINT32 HeapBuffersPresent;
HEAP_MANAGER *HeapPtr;
AGESA_TESTPOINT (TpIfAmdS3SaveEntry, &AmdS3SaveParams->StdHeader);
ASSERT (AmdS3SaveParams != NULL);
HeapBuffersPresent = 0;
EarlyBufferSize = 0;
LateBufferSize = 0;
LateContextSize = 0;
HeapSize = 0;
NonMemoryRelatedDeviceList = NULL;
MemoryRelatedDeviceList = NULL;
ReturnStatus = AGESA_SUCCESS;
IDS_SKIP_HOOK (IDS_BEFORE_S3_SAVE, AmdS3SaveParams, &(AmdS3SaveParams->StdHeader)) {
// Get memory device list
MemFS3GetDeviceList (&MemoryRelatedDeviceList, &AmdS3SaveParams->StdHeader);
if (MemoryRelatedDeviceList != NULL) {
// Determine size needed
EarlyBufferSize = GetWorstCaseContextSize (MemoryRelatedDeviceList, INIT_RESUME, &AmdS3SaveParams->StdHeader);
}
if (UserOptions.CfgS3LateRestore) {
for (i = 0; i < S3LATE_TABLE_SIZE; i++) {
LocateHeap.BufferHandle = S3LateHeapTable[i];
if (HeapLocateBuffer (&LocateHeap, &AmdS3SaveParams->StdHeader) == AGESA_SUCCESS) {
HeapBuffersPresent++;
HeapSize += LocateHeap.BufferSize;
HeapPtrs[i] = LocateHeap.BufferPtr;
HeapSizes[i] = LocateHeap.BufferSize;
} else {
HeapPtrs[i] = NULL;
HeapSizes[i] = 0;
}
}
// Determine heap data size requirements
if (HeapBuffersPresent != 0) {
HeapSize += ((sizeof (HEAP_MANAGER)) + (HeapBuffersPresent * ((sizeof (BUFFER_NODE)) + (NUM_OF_SENTINEL * SIZE_OF_SENTINEL) + 0xF))); // reserve 0xF per buffer node for 16 byte alignment
}
// Get non memory device list
GetNonMemoryRelatedDeviceList (&NonMemoryRelatedDeviceList, &AmdS3SaveParams->StdHeader);
if (NonMemoryRelatedDeviceList != NULL) {
// Determine size needed
LateContextSize = GetWorstCaseContextSize (NonMemoryRelatedDeviceList, S3_LATE_RESTORE, &AmdS3SaveParams->StdHeader);
}
LateBufferSize = HeapSize + LateContextSize;
if (LateBufferSize != 0) {
LateBufferSize += sizeof (S3_VOLATILE_STORAGE_HEADER);
}
}
if ((EarlyBufferSize != 0) || (LateBufferSize != 0)) {
//
// Allocate a buffer
//
AllocParams.RequestedBufferSize = EarlyBufferSize + LateBufferSize;
AllocParams.BufferHandle = AMD_S3_INFO_BUFFER_HANDLE;
AllocParams.Persist = 0;
AGESA_TESTPOINT (TpIfBeforeAllocateS3SaveBuffer, &AmdS3SaveParams->StdHeader);
if (HeapAllocateBuffer (&AllocParams, &AmdS3SaveParams->StdHeader) != AGESA_SUCCESS) {
if (AGESA_ERROR > ReturnStatus) {
ReturnStatus = AGESA_ERROR;
}
}
AGESA_TESTPOINT (TpIfAfterAllocateS3SaveBuffer, &AmdS3SaveParams->StdHeader);
if (EarlyBufferSize != 0) {
AmdS3SaveParams->S3DataBlock.NvStorage = AllocParams.BufferPtr;
SaveDeviceListContext (MemoryRelatedDeviceList,
AmdS3SaveParams->S3DataBlock.NvStorage,
INIT_RESUME,
&EarlyBufferSize,
&AmdS3SaveParams->StdHeader);
AmdS3SaveParams->S3DataBlock.NvStorageSize = EarlyBufferSize;
}
if (LateBufferSize != 0) {
BufferPointer = AllocParams.BufferPtr;
AmdS3SaveParams->S3DataBlock.VolatileStorage = &(BufferPointer[EarlyBufferSize]);
((S3_VOLATILE_STORAGE_HEADER *) AmdS3SaveParams->S3DataBlock.VolatileStorage)->HeapOffset = 0;
((S3_VOLATILE_STORAGE_HEADER *) AmdS3SaveParams->S3DataBlock.VolatileStorage)->HeapSize = HeapSize;
((S3_VOLATILE_STORAGE_HEADER *) AmdS3SaveParams->S3DataBlock.VolatileStorage)->RegisterDataOffset = 0;
((S3_VOLATILE_STORAGE_HEADER *) AmdS3SaveParams->S3DataBlock.VolatileStorage)->RegisterDataSize = LateContextSize;
if (HeapSize != 0) {
// Transfer heap contents
((S3_VOLATILE_STORAGE_HEADER *) AmdS3SaveParams->S3DataBlock.VolatileStorage)->HeapOffset = sizeof (S3_VOLATILE_STORAGE_HEADER);
HeapPtr = (HEAP_MANAGER *) &BufferPointer[EarlyBufferSize + sizeof (S3_VOLATILE_STORAGE_HEADER)];
HeapPtr->UsedSize = sizeof (HEAP_MANAGER);
HeapPtr->Signature = HEAP_SIGNATURE_VALID;
HeapPtr->FirstActiveBufferOffset = AMD_HEAP_INVALID_HEAP_OFFSET;
HeapPtr->FirstFreeSpaceOffset = sizeof (HEAP_MANAGER);
FreeSpaceNode = (BUFFER_NODE *) ((UINT8 *) HeapPtr + sizeof (HEAP_MANAGER));
FreeSpaceNode->BufferSize = HeapSize - sizeof (HEAP_MANAGER) - sizeof (BUFFER_NODE);
FreeSpaceNode->OffsetOfNextNode = AMD_HEAP_INVALID_HEAP_OFFSET;
HeapStatus = AmdS3SaveParams->StdHeader.HeapStatus;
AmdS3SaveParams->StdHeader.HeapStatus = HEAP_S3_RESUME;
AmdS3SaveParams->StdHeader.HeapBasePtr = (UINT64) HeapPtr;
for (i = 0; i < S3LATE_TABLE_SIZE; i++) {
if (HeapPtrs[i] != NULL) {
HeapParams.RequestedBufferSize = HeapSizes[i]; // S3LateHeapTable[i].BufferLength;
HeapParams.BufferHandle = S3LateHeapTable[i];
HeapParams.Persist = HEAP_S3_RESUME;
if (HeapAllocateBuffer (&HeapParams, &AmdS3SaveParams->StdHeader) == AGESA_SUCCESS) {
LibAmdMemCopy ((VOID *) HeapParams.BufferPtr, HeapPtrs[i], HeapSizes[i], &AmdS3SaveParams->StdHeader);
}
}
}
AmdS3SaveParams->StdHeader.HeapStatus = HeapStatus;
}
if (LateContextSize != 0) {
((S3_VOLATILE_STORAGE_HEADER *) AmdS3SaveParams->S3DataBlock.VolatileStorage)->RegisterDataOffset = HeapSize + sizeof (S3_VOLATILE_STORAGE_HEADER);
SaveDeviceListContext (NonMemoryRelatedDeviceList,
&(BufferPointer[EarlyBufferSize + HeapSize + sizeof (S3_VOLATILE_STORAGE_HEADER)]),
S3_LATE_RESTORE,
&LateContextSize,
&AmdS3SaveParams->StdHeader);
}
AmdS3SaveParams->S3DataBlock.VolatileStorageSize = HeapSize + LateContextSize + sizeof (S3_VOLATILE_STORAGE_HEADER);
}
}
}
ReturnStatus = BldoptFchFunction.InitLate (AmdS3SaveParams);
IDS_OPTION_HOOK (IDS_AFTER_S3_SAVE, AmdS3SaveParams, &AmdS3SaveParams->StdHeader);
AGESA_TESTPOINT (TpIfAmdS3SaveExit, &AmdS3SaveParams->StdHeader);
return ReturnStatus;
}
/*---------------------------------------------------------------------------------------*/
/**
* Constructor for the AMD_S3_SAVE function.
*
* This routine is responsible for setting default values for the
* input parameters needed by the AMD_S3_SAVE entry point.
*
* @param[in] StdHeader The standard header.
* @param[in,out] S3SaveParams Required input parameters for the AMD_S3_SAVE
* entry point.
*
* @retval AGESA_SUCCESS Always Succeeds.
*
*/
AGESA_STATUS
AmdS3SaveInitializer (
IN OUT AMD_CONFIG_PARAMS *StdHeader,
IN OUT AMD_S3SAVE_PARAMS *S3SaveParams
)
{
ASSERT (StdHeader != NULL);
ASSERT (S3SaveParams != NULL);
S3SaveParams->StdHeader = *StdHeader;
AmdS3ParamsInitializer (&S3SaveParams->S3DataBlock);
AmdS3SavePlatformConfigInit (&S3SaveParams->PlatformConfig, &S3SaveParams->StdHeader);
BldoptFchFunction.InitLateConstructor (S3SaveParams);
return AGESA_SUCCESS;
}
/*---------------------------------------------------------------------------------------*/
/**
* Destructor for the AMD_S3_SAVE function.
*
* This routine is responsible for deallocation of heap space allocated during
* AMD_S3_SAVE entry point.
*
* @param[in] StdHeader The standard header.
* @param[in,out] S3SaveParams Required input parameters for the AMD_INIT_RESUME
* entry point.
*
* @retval AGESA_STATUS
*
*/
AGESA_STATUS
AmdS3SaveDestructor (
IN AMD_CONFIG_PARAMS *StdHeader,
IN OUT AMD_S3SAVE_PARAMS *S3SaveParams
)
{
AGESA_STATUS ReturnStatus;
AGESA_STATUS RetVal;
ASSERT (S3SaveParams != NULL);
ReturnStatus = AGESA_SUCCESS;
// Deallocate heap space allocated during memory S3 save
RetVal = MemS3Deallocate (&S3SaveParams->StdHeader);
if (RetVal > ReturnStatus) {
ReturnStatus = RetVal;
}
RetVal = HeapDeallocateBuffer (AMD_S3_NB_INFO_BUFFER_HANDLE, StdHeader);
if (RetVal > ReturnStatus) {
ReturnStatus = RetVal;
}
RetVal = HeapDeallocateBuffer (AMD_S3_INFO_BUFFER_HANDLE, StdHeader);
if (RetVal > ReturnStatus) {
ReturnStatus = RetVal;
}
return ReturnStatus;
}
/*------------------------------------------------------------------------------------*/
/**
* Initialize AmdS3Save stage platform profile and user option input.
*
* @param[in,out] PlatformConfig Platform profile/build option config structure
* @param[in,out] StdHeader AMD standard header config param
*
* @retval AGESA_SUCCESS Always Succeeds.
*
*/
AGESA_STATUS
AmdS3SavePlatformConfigInit (
IN OUT PLATFORM_CONFIGURATION *PlatformConfig,
IN OUT AMD_CONFIG_PARAMS *StdHeader
)
{
CommonPlatformConfigInit (PlatformConfig, StdHeader);
return AGESA_SUCCESS;
}
|