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
|
/* $NoKeywords:$ */
/**
* @file
*
* ACPI S3 support definitions.
*
* @xrefitem bom "File Content Label" "Release Content"
* @e project: AGESA
* @e sub-project: CPU
* @e \$Revision: 63425 $ @e \$Date: 2011-12-22 11:24:10 -0600 (Thu, 22 Dec 2011) $
*
*/
/*
*****************************************************************************
*
* Copyright 2008 - 2012 ADVANCED MICRO DEVICES, INC. All Rights Reserved.
*
* AMD is granting you permission to use this software (the Materials)
* pursuant to the terms and conditions of your Software License Agreement
* with AMD. This header does *NOT* give you permission to use the Materials
* or any rights under AMD's intellectual property. Your use of any portion
* of these Materials shall constitute your acceptance of those terms and
* conditions. If you do not agree to the terms and conditions of the Software
* License Agreement, please do not use any portion of these Materials.
*
* CONFIDENTIALITY: The Materials and all other information, identified as
* confidential and provided to you by AMD shall be kept confidential in
* accordance with the terms and conditions of the Software License Agreement.
*
* LIMITATION OF LIABILITY: THE MATERIALS AND ANY OTHER RELATED INFORMATION
* PROVIDED TO YOU BY AMD ARE PROVIDED "AS IS" WITHOUT ANY EXPRESS OR IMPLIED
* WARRANTY OF ANY KIND, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
* MERCHANTABILITY, NONINFRINGEMENT, TITLE, FITNESS FOR ANY PARTICULAR PURPOSE,
* OR WARRANTIES ARISING FROM CONDUCT, COURSE OF DEALING, OR USAGE OF TRADE.
* IN NO EVENT SHALL AMD OR ITS LICENSORS BE LIABLE FOR ANY DAMAGES WHATSOEVER
* (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS
* INTERRUPTION, OR LOSS OF INFORMATION) ARISING OUT OF AMD'S NEGLIGENCE,
* GROSS NEGLIGENCE, THE USE OF OR INABILITY TO USE THE MATERIALS OR ANY OTHER
* RELATED INFORMATION PROVIDED TO YOU BY AMD, EVEN IF AMD HAS BEEN ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGES. BECAUSE SOME JURISDICTIONS PROHIBIT THE
* EXCLUSION OR LIMITATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES,
* THE ABOVE LIMITATION MAY NOT APPLY TO YOU.
*
* AMD does not assume any responsibility for any errors which may appear in
* the Materials or any other related information provided to you by AMD, or
* result from use of the Materials or any related information.
*
* You agree that you will not reverse engineer or decompile the Materials.
*
* NO SUPPORT OBLIGATION: AMD is not obligated to furnish, support, or make any
* further information, software, technical information, know-how, or show-how
* available to you. Additionally, AMD retains the right to modify the
* Materials at any time, without notice, and is not obligated to provide such
* modified Materials to you.
*
* U.S. GOVERNMENT RESTRICTED RIGHTS: The Materials are provided with
* "RESTRICTED RIGHTS." Use, duplication, or disclosure by the Government is
* subject to the restrictions as set forth in FAR 52.227-14 and
* DFAR252.227-7013, et seq., or its successor. Use of the Materials by the
* Government constitutes acknowledgement of AMD's proprietary rights in them.
*
* EXPORT ASSURANCE: You agree and certify that neither the Materials, nor any
* direct product thereof will be exported directly or indirectly, into any
* country prohibited by the United States Export Administration Act and the
* regulations thereunder, without the required authorization from the U.S.
* government nor will be used for any purpose prohibited by the same.
* ***************************************************************************
*
*/
#ifndef _S3_H_
#define _S3_H_
/*---------------------------------------------------------------------------------------
* M I X E D (Definitions And Macros / Typedefs, Structures, Enums)
*---------------------------------------------------------------------------------------
*/
/*---------------------------------------------------------------------------------------
* D E F I N I T I O N S A N D M A C R O S
*---------------------------------------------------------------------------------------
*/
#define RESTART_FROM_BEGINNING_LIST 0xFFFFFFFFul
/*---------------------------------------------------------------------------------------
* T Y P E D E F S, S T R U C T U R E S, E N U M S
*---------------------------------------------------------------------------------------
*/
/* Device related definitions */
/// Header at the beginning of a context save buffer.
typedef struct {
UINT16 Version; ///< Version of header
UINT16 NumDevices; ///< Number of devices in the list
UINT16 RelativeOrMaskOffset; ///< Size of device list + header
} DEVICE_BLOCK_HEADER;
/// S3 device types
typedef enum {
DEV_TYPE_PCI_PRE_ESR, ///< PCI device before exiting self-refresh
DEV_TYPE_PCI, ///< PCI device after exiting self-refresh
DEV_TYPE_CPCI_PRE_ESR, ///< 'conditional' PCI device before exiting self-refresh
DEV_TYPE_CPCI, ///< 'conditional' PCI device after exiting self-refresh
DEV_TYPE_MSR_PRE_ESR, ///< MSR device before exiting self-refresh
DEV_TYPE_MSR, ///< MSR device after exiting self-refresh
DEV_TYPE_CMSR_PRE_ESR, ///< 'conditional' MSR device before exiting self-refresh
DEV_TYPE_CMSR ///< 'conditional' MSR device after exiting self-refresh
} S3_DEVICE_TYPES;
/// S3 restoration call points
typedef enum {
INIT_RESUME, ///< AMD_INIT_RESUME
S3_LATE_RESTORE ///< AMD_S3LATE_RESTORE
} CALL_POINTS;
/// S3 device common header
typedef struct {
UINT32 RegisterListID; ///< Unique ID of this device
UINT8 Type; ///< Appropriate S3_DEVICE_TYPES type
} DEVICE_DESCRIPTOR;
/// S3 PCI device header
typedef struct {
UINT32 RegisterListID; ///< Unique ID of this device
UINT8 Type; ///< DEV_TYPE_PCI / DEV_TYPE_PCI_PRE_ESR
UINT8 Node; ///< Zero-based node number
} PCI_DEVICE_DESCRIPTOR;
/// S3 'conditional' PCI device header
typedef struct {
UINT32 RegisterListID; ///< Unique ID of this device
UINT8 Type; ///< DEV_TYPE_CPCI / DEV_TYPE_CPCI_PRE_ESR
UINT8 Node; ///< Zero-based node number
UINT8 Mask1; ///< Conditional mask 1
UINT8 Mask2; ///< Conditional mask 2
} CONDITIONAL_PCI_DEVICE_DESCRIPTOR;
/// S3 MSR device header
typedef struct {
UINT32 RegisterListID; ///< Unique ID of this device
UINT8 Type; ///< DEV_TYPE_MSR / DEV_TYPE_MSR_PRE_ESR
} MSR_DEVICE_DESCRIPTOR;
/// S3 'conditional' MSR device header
typedef struct {
UINT32 RegisterListID; ///< Unique ID of this device
UINT8 Type; ///< DEV_TYPE_CMSR / DEV_TYPE_CMSR_PRE_ESR
UINT8 Mask1; ///< Conditional mask 1
UINT8 Mask2; ///< Conditional mask 2
} CONDITIONAL_MSR_DEVICE_DESCRIPTOR;
/* Special case related definitions */
/**
* PCI special case save handler
*
* @param[in] AccessWidth 8, 16, or 32 bit wide access
* @param[in] Address full PCI address of the register to save
* @param[out] Value Value read from the register
* @param[in] ConfigPtr AMD standard header config parameter
*
*/
typedef VOID (*PF_S3_SPECIAL_PCI_SAVE) (
IN ACCESS_WIDTH AccessWidth,
IN PCI_ADDR Address,
OUT VOID *Value,
IN VOID *ConfigPtr
);
/**
* PCI special case restore handler
*
* @param[in] AccessWidth 8, 16, or 32 bit wide access
* @param[in] Address full PCI address of the register to save
* @param[in] Value Value to write to the register
* @param[in] ConfigPtr AMD standard header config parameter
*
*/
typedef VOID (*PF_S3_SPECIAL_PCI_RESTORE) (
IN ACCESS_WIDTH AccessWidth,
IN PCI_ADDR PciAddress,
IN VOID *Value,
IN VOID *StdHeader
);
/**
* MSR special case save handler
*
* @param[in] MsrAddress Address of model specific register to save
* @param[out] Value Value read from the register
* @param[in] ConfigPtr AMD standard header config parameter
*
*/
typedef VOID (*PF_S3_SPECIAL_MSR_SAVE) (
IN UINT32 MsrAddress,
OUT UINT64 *Value,
IN VOID *StdHeader
);
/**
* MSR special case restore handler
*
* @param[in] MsrAddress Address of model specific register to restore
* @param[in] Value Value to write to the register
* @param[in] ConfigPtr AMD standard header config parameter
*
*/
typedef VOID (*PF_S3_SPECIAL_MSR_RESTORE) (
IN UINT32 MsrAddress,
IN UINT64 *Value,
IN VOID *StdHeader
);
/// PCI special case save/restore structure.
typedef struct {
PF_S3_SPECIAL_PCI_SAVE Save; ///< Save routine
PF_S3_SPECIAL_PCI_RESTORE Restore; ///< Restore routine
} PCI_SPECIAL_CASE;
/// MSR special case save/restore structure.
typedef struct {
PF_S3_SPECIAL_MSR_SAVE Save; ///< Save routine
PF_S3_SPECIAL_MSR_RESTORE Restore; ///< Restore routine
} MSR_SPECIAL_CASE;
/* Register related definitions */
/// S3 register type bit fields
typedef struct {
UINT8 SpecialCaseIndex:4; ///< Special Case array index
UINT8 RegisterSize:3; ///< For PCI, 1 = byte, 2 = word, else = dword.
///< For MSR, don't care
UINT8 SpecialCaseFlag:1; ///< Indicates special case
} S3_REGISTER_TYPE;
/// S3 PCI register descriptor.
typedef struct {
S3_REGISTER_TYPE Type; ///< Type[7] = special case flag,
///< Type[6:3] = register size in bytes,
///< Type[2:0] = special case index
UINT8 Function; ///< PCI function of the register
UINT16 Offset; ///< PCI offset of the register
UINT32 AndMask; ///< AND mask to be applied to the value before saving
} PCI_REG_DESCRIPTOR;
/// S3 'conditional' PCI register descriptor.
typedef struct {
S3_REGISTER_TYPE Type; ///< Type[7] = special case flag,
///< Type[6:3] = register size in bytes,
///< Type[2:0] = special case index
UINT8 Function; ///< PCI function of the register
UINT16 Offset; ///< PCI offset of the register
UINT32 AndMask; ///< AND mask to be applied to the value before saving
UINT8 Mask1; ///< conditional mask 1
UINT8 Mask2; ///< conditional mask 2
} CONDITIONAL_PCI_REG_DESCRIPTOR;
/// S3 MSR register descriptor.
typedef struct {
S3_REGISTER_TYPE Type; ///< Type[7] = special case flag,
///< Type[6:3] = reserved,
///< Type[2:0] = special case index
UINT32 Address; ///< MSR address
UINT64 AndMask; ///< AND mask to be applied to the value before saving
} MSR_REG_DESCRIPTOR;
/// S3 'conditional' MSR register descriptor.
typedef struct {
S3_REGISTER_TYPE Type; ///< Type[7] = special case flag,
///< Type[6:3] = reserved,
///< Type[2:0] = special case index
UINT32 Address; ///< MSR address
UINT64 AndMask; ///< AND mask to be applied to the value before saving
UINT8 Mask1; ///< conditional mask 1
UINT8 Mask2; ///< conditional mask 2
} CONDITIONAL_MSR_REG_DESCRIPTOR;
/// Common header at the beginning of an S3 register list.
typedef struct {
UINT16 Version; ///< Version of header
UINT16 NumRegisters; ///< Number of registers in the list
} REGISTER_BLOCK_HEADER;
/// S3 PCI register list header.
typedef struct {
UINT16 Version; ///< Version of header
UINT16 NumRegisters; ///< Number of registers in the list
PCI_REG_DESCRIPTOR *RegisterList; ///< Pointer to the first register descriptor
PCI_SPECIAL_CASE *SpecialCases; ///< Pointer to array of special case handlers
} PCI_REGISTER_BLOCK_HEADER;
/// S3 'conditional' PCI register list header.
typedef struct {
UINT16 Version; ///< Version of header
UINT16 NumRegisters; ///< Number of registers in the list
CONDITIONAL_PCI_REG_DESCRIPTOR *RegisterList; ///< Pointer to the first register descriptor
PCI_SPECIAL_CASE *SpecialCases; ///< Pointer to array of special case handlers
} CPCI_REGISTER_BLOCK_HEADER;
/// S3 MSR register list header.
typedef struct {
UINT16 Version; ///< Version of header
UINT16 NumRegisters; ///< Number of registers in the list
MSR_REG_DESCRIPTOR *RegisterList; ///< Pointer to the first register descriptor
MSR_SPECIAL_CASE *SpecialCases; ///< Pointer to array of special case handlers
} MSR_REGISTER_BLOCK_HEADER;
/// S3 'conditional' MSR register list header.
typedef struct {
UINT16 Version; ///< Version of header
UINT16 NumRegisters; ///< Number of registers in the list
CONDITIONAL_MSR_REG_DESCRIPTOR *RegisterList; ///< Pointer to the first register descriptor
MSR_SPECIAL_CASE *SpecialCases; ///< Pointer to array of special case handlers
} CMSR_REGISTER_BLOCK_HEADER;
/// S3 device descriptor pointers for ease of proper pointer advancement.
typedef union {
DEVICE_DESCRIPTOR *CommonDeviceHeader; ///< Common header
PCI_DEVICE_DESCRIPTOR *PciDevice; ///< PCI header
CONDITIONAL_PCI_DEVICE_DESCRIPTOR *CPciDevice; ///< 'conditional' PCI header
MSR_DEVICE_DESCRIPTOR *MsrDevice; ///< MSR header
CONDITIONAL_MSR_DEVICE_DESCRIPTOR *CMsrDevice; ///< 'conditional' MSR header
} DEVICE_DESCRIPTORS;
/// S3 register list header pointers for ease of proper pointer advancement.
typedef union {
DEVICE_DESCRIPTOR *CommonDeviceHeader; ///< Common header
PCI_REGISTER_BLOCK_HEADER *PciRegisters; ///< PCI header
CPCI_REGISTER_BLOCK_HEADER *CPciRegisters; ///< 'conditional' PCI header
MSR_REGISTER_BLOCK_HEADER *MsrRegisters; ///< MSR header
CMSR_REGISTER_BLOCK_HEADER *CMsrRegisters; ///< 'conditional' MSR header
} REGISTER_BLOCK_HEADERS;
/// S3 Volatile Storage Header
typedef struct {
UINT32 HeapOffset; ///< Offset to beginning of heap data
UINT32 HeapSize; ///< Size of the heap data
UINT32 RegisterDataOffset; ///< Offset to beginning of raw save data
UINT32 RegisterDataSize; ///< Size of raw save data
} S3_VOLATILE_STORAGE_HEADER;
/*---------------------------------------------------------------------------------------
* F U N C T I O N P R O T O T Y P E
*---------------------------------------------------------------------------------------
*/
UINT32
GetWorstCaseContextSize (
IN DEVICE_BLOCK_HEADER *DeviceList,
IN CALL_POINTS CallPoint,
IN AMD_CONFIG_PARAMS *StdHeader
);
VOID
SaveDeviceListContext (
IN DEVICE_BLOCK_HEADER *DeviceList,
IN VOID *Storage,
IN CALL_POINTS CallPoint,
OUT UINT32 *ActualBufferSize,
IN AMD_CONFIG_PARAMS *StdHeader
);
VOID
RestorePreESRContext (
OUT VOID **OrMaskPtr,
IN VOID *Storage,
IN CALL_POINTS CallPoint,
IN AMD_CONFIG_PARAMS *StdHeader
);
VOID
RestorePostESRContext (
IN VOID *OrMaskPtr,
IN VOID *Storage,
IN CALL_POINTS CallPoint,
IN AMD_CONFIG_PARAMS *StdHeader
);
VOID
AmdS3ParamsInitializer (
OUT AMD_S3_PARAMS *S3Params
);
VOID
GetNonMemoryRelatedDeviceList (
OUT DEVICE_BLOCK_HEADER **NonMemoryRelatedDeviceList,
IN AMD_CONFIG_PARAMS *StdHeader
);
AGESA_STATUS
S3GetPciDeviceRegisterList (
IN PCI_DEVICE_DESCRIPTOR *Device,
OUT PCI_REGISTER_BLOCK_HEADER **RegisterHdr,
IN AMD_CONFIG_PARAMS *StdHeader
);
AGESA_STATUS
S3GetCPciDeviceRegisterList (
IN CONDITIONAL_PCI_DEVICE_DESCRIPTOR *Device,
OUT CPCI_REGISTER_BLOCK_HEADER **RegisterHdr,
IN AMD_CONFIG_PARAMS *StdHeader
);
AGESA_STATUS
S3GetMsrDeviceRegisterList (
IN MSR_DEVICE_DESCRIPTOR *Device,
OUT MSR_REGISTER_BLOCK_HEADER **RegisterHdr,
IN AMD_CONFIG_PARAMS *StdHeader
);
AGESA_STATUS
S3GetCMsrDeviceRegisterList (
IN CONDITIONAL_MSR_DEVICE_DESCRIPTOR *Device,
OUT CMSR_REGISTER_BLOCK_HEADER **RegisterHdr,
IN AMD_CONFIG_PARAMS *StdHeader
);
#endif // _S3_H_
|