1 /*****************************************************************************
2 * AMD Generic Encapsulated Software Architecture */
6 * Agesa structures and definitions
8 * Contains AMD AGESA/CIMx core interface
10 * @xrefitem bom "File Content Label" "Release Content"
12 * @e sub-project: Include
13 * @e \$Revision:$ @e \$Date:$
16 *****************************************************************************
18 * This file is part of the coreboot project.
20 * Copyright (C) 2011 Advanced Micro Devices, Inc.
22 * This program is free software; you can redistribute it and/or modify
23 * it under the terms of the GNU General Public License as published by
24 * the Free Software Foundation; version 2 of the License.
26 * This program is distributed in the hope that it will be useful,
27 * but WITHOUT ANY WARRANTY; without even the implied warranty of
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29 * GNU General Public License for more details.
31 * You should have received a copy of the GNU General Public License
32 * along with this program; if not, write to the Free Software
33 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
34 * ***************************************************************************
42 // AGESA Types and Definitions
47 #define LAST_ENTRY 0xFFFFFFFF
54 #define Int16FromChar(a,b) ((a) << 0 | (b) << 8)
57 #define Int32FromChar(a,b,c,d) ((a) << 0 | (b) << 8 | (c) << 16 | (d) << 24)
60 #define IMAGE_SIGNATURE Int32FromChar ('$', 'A', 'M', 'D')
62 typedef unsigned int AGESA_STATUS;
64 #define AGESA_SUCCESS ((AGESA_STATUS) 0x0)
65 #define AGESA_ALERT ((AGESA_STATUS) 0x40000000)
66 #define AGESA_WARNING ((AGESA_STATUS) 0x40000001)
67 #define AGESA_UNSUPPORTED ((AGESA_STATUS) 0x80000003)
68 #define AGESA_ERROR ((AGESA_STATUS) 0xC0000001)
69 #define AGESA_CRITICAL ((AGESA_STATUS) 0xC0000002)
70 #define AGESA_FATAL ((AGESA_STATUS) 0xC0000003)
72 typedef AGESA_STATUS (*CALLOUT_ENTRY) (unsigned int Param1, unsigned int Param2, void* ConfigPtr);
73 typedef AGESA_STATUS (*IMAGE_ENTRY) (IN OUT void* ConfigPtr);
74 typedef AGESA_STATUS (*MODULE_ENTRY) (IN OUT void* ConfigPtr);
76 ///This allocation type is used by the AmdCreateStruct entry point
78 PreMemHeap = 0, ///< Create heap in cache.
79 PostMemDram, ///< Create heap in memory.
80 ByHost ///< Create heap by Host.
83 /// These width descriptors are used by the library function, and others, to specify the data size
84 typedef enum ACCESS_WIDTH {
85 AccessWidth8 = 1, ///< Access width is 8 bits.
86 AccessWidth16, ///< Access width is 16 bits.
87 AccessWidth32, ///< Access width is 32 bits.
88 AccessWidth64, ///< Access width is 64 bits.
90 AccessS3SaveWidth8 = 0x81, ///< Save 8 bits data.
91 AccessS3SaveWidth16, ///< Save 16 bits data.
92 AccessS3SaveWidth32, ///< Save 32 bits data.
93 AccessS3SaveWidth64, ///< Save 64 bits data.
98 /// The standard header for all AGESA services.
99 typedef struct _AMD_CONFIG_PARAMS {
100 IN unsigned int ImageBasePtr; ///< The AGESA Image base address.
101 IN unsigned int Func; ///< The service desired, @sa dispatch.h.
102 IN unsigned int AltImageBasePtr; ///< Alternate Image location
103 IN unsigned int PcieBasePtr; ///< PCIe MMIO Base address, if configured.
104 union { ///< Callback pointer
105 IN unsigned long long PlaceHolder; ///< Place holder
106 IN CALLOUT_ENTRY CalloutPtr; ///< For Callout from AGESA
108 IN OUT unsigned int Reserved[2]; ///< This space is reserved for future use.
112 /// AGESA Binary module header structure
113 typedef struct _AMD_IMAGE_HEADER {
114 IN unsigned int Signature; ///< Binary Signature
115 IN signed char CreatorID[8]; ///< 8 characters ID
116 IN signed char Version[12]; ///< 12 characters version
117 IN unsigned int ModuleInfoOffset; ///< Offset of module
118 IN unsigned int EntryPointAddress; ///< Entry address
119 IN unsigned int ImageBase; ///< Image base
120 IN unsigned int RelocTableOffset; ///< Relocate Table offset
121 IN unsigned int ImageSize; ///< Size
122 IN unsigned short Checksum; ///< Checksum
123 IN unsigned char ImageType; ///< Type
124 IN unsigned char V_Reserved; ///< Reserved
127 /// AGESA Binary module header structure
128 typedef struct _AMD_MODULE_HEADER {
129 IN unsigned int ModuleHeaderSignature; ///< Module signature
130 IN signed char ModuleIdentifier[8]; ///< 8 characters ID
131 IN signed char ModuleVersion[12]; ///< 12 characters version
132 IN MODULE_ENTRY ModuleDispatcherPtr; ///< A pointer point to dispatcher
133 IN struct _AMD_MODULE_HEADER *NextBlockPtr; ///< Next module header link
136 #define FUNC_0 0 // bit-placed for PCI address creation
145 // SBDFO - Segment Bus Device Function Offset
146 // 31:28 Segment (4-bits)
147 // 27:20 Bus (8-bits)
148 // 19:15 Device (5-bits)
149 // 14:12 Function (3-bits)
150 // 11:00 Offset (12-bits)
153 #define MAKE_SBDFO(Seg, Bus, Dev, Fun, Off) ((((unsigned int) (Seg)) << 28) | (((unsigned int) (Bus)) << 20) | \
154 (((unsigned int) (Dev)) << 15) | (((unsigned int) (Fun)) << 12) | ((unsigned int) (Off)))
156 #define ILLEGAL_SBDFO 0xFFFFFFFF
159 /// CPUID data received registers format
160 typedef struct _SB_CPUID_DATA {
161 IN OUT unsigned int EAX_Reg; ///< CPUID instruction result in EAX
162 IN OUT unsigned int EBX_Reg; ///< CPUID instruction result in EBX
163 IN OUT unsigned int ECX_Reg; ///< CPUID instruction result in ECX
164 IN OUT unsigned int EDX_Reg; ///< CPUID instruction result in EDX
169 #define COLD_RESET 2 // Cold reset
170 #define RESET_CPU 4 // Triggers a CPU reset
172 /// HT frequency for external callbacks
174 HT_FREQUENCY_200M = 0, ///< HT speed 200 for external callbacks
175 HT_FREQUENCY_400M = 2, ///< HT speed 400 for external callbacks
176 HT_FREQUENCY_600M = 4, ///< HT speed 600 for external callbacks
177 HT_FREQUENCY_800M = 5, ///< HT speed 800 for external callbacks
178 HT_FREQUENCY_1000M = 6, ///< HT speed 1000 for external callbacks
179 HT_FREQUENCY_1200M = 7, ///< HT speed 1200 for external callbacks
180 HT_FREQUENCY_1400M = 8, ///< HT speed 1400 for external callbacks
181 HT_FREQUENCY_1600M = 9, ///< HT speed 1600 for external callbacks
182 HT_FREQUENCY_1800M = 10, ///< HT speed 1800 for external callbacks
183 HT_FREQUENCY_2000M = 11, ///< HT speed 2000 for external callbacks
184 HT_FREQUENCY_2200M = 12, ///< HT speed 2200 for external callbacks
185 HT_FREQUENCY_2400M = 13, ///< HT speed 2400 for external callbacks
186 HT_FREQUENCY_2600M = 14, ///< HT speed 2600 for external callbacks
187 HT_FREQUENCY_2800M = 17, ///< HT speed 2800 for external callbacks
188 HT_FREQUENCY_3000M = 18, ///< HT speed 3000 for external callbacks
189 HT_FREQUENCY_3200M = 19 ///< HT speed 3200 for external callbacks
193 #define BIT0 0x0000000000000001ull
196 #define BIT1 0x0000000000000002ull
199 #define BIT2 0x0000000000000004ull
202 #define BIT3 0x0000000000000008ull
205 #define BIT4 0x0000000000000010ull
208 #define BIT5 0x0000000000000020ull
211 #define BIT6 0x0000000000000040ull
214 #define BIT7 0x0000000000000080ull
217 #define BIT8 0x0000000000000100ull
220 #define BIT9 0x0000000000000200ull
223 #define BIT10 0x0000000000000400ull
226 #define BIT11 0x0000000000000800ull
229 #define BIT12 0x0000000000001000ull
232 #define BIT13 0x0000000000002000ull
235 #define BIT14 0x0000000000004000ull
238 #define BIT15 0x0000000000008000ull
241 #define BIT16 0x0000000000010000ull
244 #define BIT17 0x0000000000020000ull
247 #define BIT18 0x0000000000040000ull
250 #define BIT19 0x0000000000080000ull
253 #define BIT20 0x0000000000100000ull
256 #define BIT21 0x0000000000200000ull
259 #define BIT22 0x0000000000400000ull
262 #define BIT23 0x0000000000800000ull
265 #define BIT24 0x0000000001000000ull
268 #define BIT25 0x0000000002000000ull
271 #define BIT26 0x0000000004000000ull
274 #define BIT27 0x0000000008000000ull
277 #define BIT28 0x0000000010000000ull
280 #define BIT29 0x0000000020000000ull
283 #define BIT30 0x0000000040000000ull
286 #define BIT31 0x0000000080000000ull
289 #define BIT32 0x0000000100000000ull
292 #define BIT33 0x0000000200000000ull
295 #define BIT34 0x0000000400000000ull
298 #define BIT35 0x0000000800000000ull
301 #define BIT36 0x0000001000000000ull
304 #define BIT37 0x0000002000000000ull
307 #define BIT38 0x0000004000000000ull
310 #define BIT39 0x0000008000000000ull
313 #define BIT40 0x0000010000000000ull
316 #define BIT41 0x0000020000000000ull
319 #define BIT42 0x0000040000000000ull
322 #define BIT43 0x0000080000000000ull
325 #define BIT44 0x0000100000000000ull
328 #define BIT45 0x0000200000000000ull
331 #define BIT46 0x0000400000000000ull
334 #define BIT47 0x0000800000000000ull
337 #define BIT48 0x0001000000000000ull
340 #define BIT49 0x0002000000000000ull
343 #define BIT50 0x0004000000000000ull
346 #define BIT51 0x0008000000000000ull
349 #define BIT52 0x0010000000000000ull
352 #define BIT53 0x0020000000000000ull
355 #define BIT54 0x0040000000000000ull
358 #define BIT55 0x0080000000000000ull
361 #define BIT56 0x0100000000000000ull
364 #define BIT57 0x0200000000000000ull
367 #define BIT58 0x0400000000000000ull
370 #define BIT59 0x0800000000000000ull
373 #define BIT60 0x1000000000000000ull
376 #define BIT61 0x2000000000000000ull
379 #define BIT62 0x4000000000000000ull
382 #define BIT63 0x8000000000000000ull