AGESA F15: AMD family15 AGESA code
[coreboot.git] / src / vendorcode / amd / agesa / f15 / Legacy / Proc / agesaCallouts.c
1 /* $NoKeywords:$ */
2 /**
3  * @file
4  *
5  * AMD CPU AGESA Callout Functions
6  *
7  * Contains code to set / get useful platform information.
8  *
9  * @xrefitem bom "File Content Label" "Release Content"
10  * @e project:      AGESA
11  * @e sub-project:  Common
12  * @e \$Revision: 50871 $   @e \$Date: 2011-04-14 15:39:51 -0600 (Thu, 14 Apr 2011) $
13  *
14  */
15 /*****************************************************************************
16  * AMD Generic Encapsulated Software Architecture
17  *
18  * Description: agesaCallouts.c - AGESA Call out functions
19  *
20  ******************************************************************************
21  *
22  * Copyright (C) 2012 Advanced Micro Devices, Inc.
23  * All rights reserved.
24  *
25  * Redistribution and use in source and binary forms, with or without
26  * modification, are permitted provided that the following conditions are met:
27  *     * Redistributions of source code must retain the above copyright
28  *       notice, this list of conditions and the following disclaimer.
29  *     * Redistributions in binary form must reproduce the above copyright
30  *       notice, this list of conditions and the following disclaimer in the
31  *       documentation and/or other materials provided with the distribution.
32  *     * Neither the name of Advanced Micro Devices, Inc. nor the names of
33  *       its contributors may be used to endorse or promote products derived
34  *       from this software without specific prior written permission.
35  *
36  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
37  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
38  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL ADVANCED MICRO DEVICES, INC. BE LIABLE FOR ANY
40  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
41  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
44  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
45  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
46  *
47  ******************************************************************************
48  */
49
50 /*----------------------------------------------------------------------------------------
51  *                            M O D U L E S    U S E D
52  *----------------------------------------------------------------------------------------
53  */
54 #include "AGESA.h"
55 #include "cpuRegisters.h"
56 #include "Dispatcher.h"
57 #include "cpuServices.h"
58 #include "Ids.h"
59 #include "Filecode.h"
60
61 #define FILECODE LEGACY_PROC_AGESACALLOUTS_FILECODE
62 /*----------------------------------------------------------------------------------------
63  *                   D E F I N I T I O N S    A N D    M A C R O S
64  *----------------------------------------------------------------------------------------
65  */
66
67 /*----------------------------------------------------------------------------------------
68  *                  T Y P E D E F S     A N D     S T R U C T U  R E S
69  *----------------------------------------------------------------------------------------
70  */
71
72 /*----------------------------------------------------------------------------------------
73  *           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
74  *----------------------------------------------------------------------------------------
75  */
76
77 /*----------------------------------------------------------------------------------------
78  *                          E X P O R T E D    F U N C T I O N S
79  *----------------------------------------------------------------------------------------
80  */
81
82
83 /*----------------------------------------------------------------------------------------
84  *                          E X P O R T E D    F U N C T I O N S - (AGESA ONLY)
85  *----------------------------------------------------------------------------------------
86  */
87
88
89 /*---------------------------------------------------------------------------------------*/
90 /**
91  *
92  *  Call the host environment interface to do the warm or cold reset.
93  *
94  *  @param[in]      ResetType       Warm or Cold Reset is requested
95  *  @param[in,out]  StdHeader       Config header
96  *
97  */
98 VOID
99 AgesaDoReset (
100   IN       UINTN             ResetType,
101   IN OUT   AMD_CONFIG_PARAMS *StdHeader
102   )
103 {
104   AGESA_STATUS Status;
105   WARM_RESET_REQUEST Request;
106
107   // Clear warm request bit and set state bits to the current post stage
108   GetWarmResetFlag (StdHeader, &Request);
109   Request.RequestBit = FALSE;
110   Request.StateBits = Request.PostStage;
111   SetWarmResetFlag (StdHeader, &Request);
112
113   Status =  AmdAgesaCallout (AGESA_DO_RESET, (UINT32)ResetType, (VOID *) StdHeader);
114 }
115
116 /*---------------------------------------------------------------------------------------*/
117 /**
118  *
119  * Call the host environment interface to allocate buffer in main system memory.
120  *
121  * @param[in]      FcnData
122  * @param[in,out]  AllocParams  Heap manager parameters
123  *
124  * @return   The AGESA Status returned from the callout.
125  *
126  */
127 AGESA_STATUS
128 AgesaAllocateBuffer (
129   IN       UINTN               FcnData,
130   IN OUT   AGESA_BUFFER_PARAMS *AllocParams
131   )
132 {
133   AGESA_STATUS Status;
134
135   Status =  AmdAgesaCallout (AGESA_ALLOCATE_BUFFER, (UINT32)FcnData, (VOID *) AllocParams);
136
137   return Status;
138 }
139
140
141 /*---------------------------------------------------------------------------------------*/
142 /**
143  * Call the host environment interface to deallocate buffer in main system memory.
144  *
145  * @param[in]      FcnData
146  * @param[in,out]  DeallocParams   Heap Manager parameters
147  *
148  * @return   The AGESA Status returned from the callout.
149  */
150 AGESA_STATUS
151 AgesaDeallocateBuffer (
152   IN       UINTN                 FcnData,
153   IN OUT   AGESA_BUFFER_PARAMS  *DeallocParams
154   )
155 {
156   AGESA_STATUS Status;
157
158   Status =  AmdAgesaCallout (AGESA_DEALLOCATE_BUFFER, (UINT32)FcnData, (VOID *) DeallocParams);
159
160   return Status;
161 }
162
163
164 /*---------------------------------------------------------------------------------------*/
165 /**
166  *
167  * Call the host environment interface to Locate buffer Pointer in main system memory
168  *
169  * @param[in]      FcnData
170  * @param[in,out]  LocateParams   Heap manager parameters
171  *
172  * @return   The AGESA Status returned from the callout.
173  *
174  */
175 AGESA_STATUS
176 AgesaLocateBuffer (
177   IN       UINTN                 FcnData,
178   IN OUT   AGESA_BUFFER_PARAMS  *LocateParams
179   )
180 {
181   AGESA_STATUS Status;
182
183   Status =  AmdAgesaCallout (AGESA_LOCATE_BUFFER, (UINT32)FcnData, (VOID *) LocateParams);
184
185   return Status;
186 }
187
188
189 /*---------------------------------------------------------------------------------------*/
190 /**
191  * Call the host environment interface to launch APs
192  *
193  * @param[in]      ApicIdOfCore
194  * @param[in,out]  LaunchApParams
195  *
196  * @return   The AGESA Status returned from the callout.
197  *
198  */
199 AGESA_STATUS
200 AgesaRunFcnOnAp (
201   IN        UINTN         ApicIdOfCore,
202   IN        AP_EXE_PARAMS *LaunchApParams
203   )
204 {
205   AGESA_STATUS Status;
206
207   Status =  AmdAgesaCallout (AGESA_RUNFUNC_ONAP, (UINT32)ApicIdOfCore, (VOID *) LaunchApParams);
208
209   return Status;
210 }
211
212
213 /*---------------------------------------------------------------------------------------*/
214 /**
215  * Call the host environment interface to read an SPD's content.
216  *
217  * @param[in]      FcnData
218  * @param[in,out]  ReadSpd
219  *
220  * @return   The AGESA Status returned from the callout.
221  *
222  */
223 AGESA_STATUS
224 AgesaReadSpd (
225   IN       UINTN                 FcnData,
226   IN OUT   AGESA_READ_SPD_PARAMS *ReadSpd
227   )
228 {
229   AGESA_STATUS Status;
230
231   Status =  AmdAgesaCallout (AGESA_READ_SPD, (UINT32)FcnData, ReadSpd);
232
233   return Status;
234 }
235
236
237 /*---------------------------------------------------------------------------------------*/
238 /**
239  * Call the host environment interface to read an SPD's content.
240  *
241  * @param[in]      FcnData
242  * @param[in,out]  ReadSpd
243  *
244  * @return   The AGESA Status returned from the callout.
245  *
246  */
247 AGESA_STATUS
248 AgesaReadSpdRecovery (
249   IN       UINTN                 FcnData,
250   IN OUT   AGESA_READ_SPD_PARAMS *ReadSpd
251   )
252 {
253   AGESA_STATUS Status;
254
255   Status =  AmdAgesaCallout (AGESA_READ_SPD_RECOVERY, (UINT32)FcnData, ReadSpd);
256
257   return Status;
258 }
259
260
261 /*---------------------------------------------------------------------------------------*/
262 /**
263  * Call the host environment interface to provide a user hook opportunity.
264  *
265  * @param[in]      FcnData
266  * @param[in,out]  MemData
267  *
268  * @return   The AGESA Status returned from the callout.
269  *
270  */
271 AGESA_STATUS
272 AgesaHookBeforeDramInitRecovery (
273   IN       UINTN           FcnData,
274   IN OUT   MEM_DATA_STRUCT *MemData
275   )
276 {
277   AGESA_STATUS Status;
278
279   Status =  AmdAgesaCallout (AGESA_HOOKBEFORE_DRAM_INIT_RECOVERY, (UINT32)FcnData, MemData);
280
281   return Status;
282 }
283
284
285 /*---------------------------------------------------------------------------------------*/
286 /**
287  * Call the host environment interface to provide a user hook opportunity.
288  *
289  * @param[in]      SocketIdModuleId - (SocketID << 8) | ModuleId
290  * @param[in,out]  MemData
291  *
292  * @return   The AGESA Status returned from the callout.
293  *
294  */
295 AGESA_STATUS
296 AgesaHookBeforeDramInit (
297   IN       UINTN           SocketIdModuleId,
298   IN OUT   MEM_DATA_STRUCT *MemData
299   )
300 {
301   AGESA_STATUS Status;
302
303   Status =  AmdAgesaCallout (AGESA_HOOKBEFORE_DRAM_INIT, (UINT32)SocketIdModuleId, MemData);
304
305   return Status;
306 }
307
308 /*---------------------------------------------------------------------------------------*/
309 /**
310  *  Call the host environment interface to provide a user hook opportunity.
311  *
312  *  @param[in]      SocketIdModuleId - (SocketID << 8) | ModuleId
313  *  @param[in,out]  MemData
314  *
315  * @return   The AGESA Status returned from the callout.
316  *
317  */
318 AGESA_STATUS
319 AgesaHookBeforeDQSTraining (
320   IN       UINTN           SocketIdModuleId,
321   IN OUT   MEM_DATA_STRUCT *MemData
322   )
323 {
324   AGESA_STATUS Status;
325
326   Status =  AmdAgesaCallout (AGESA_HOOKBEFORE_DQS_TRAINING, (UINT32)SocketIdModuleId, MemData);
327
328   return Status;
329 }
330
331 /*---------------------------------------------------------------------------------------*/
332 /**
333  *  Call the host environment interface to provide a user hook opportunity.
334  *
335  *  @param[in]      FcnData
336  *  @param[in,out]  MemData
337  *
338  * @return   The AGESA Status returned from the callout.
339  *
340  */
341 AGESA_STATUS
342 AgesaHookBeforeExitSelfRefresh (
343   IN       UINTN           FcnData,
344   IN OUT   MEM_DATA_STRUCT *MemData
345   )
346 {
347   AGESA_STATUS Status;
348
349   Status =  AmdAgesaCallout (AGESA_HOOKBEFORE_EXIT_SELF_REF, (UINT32)FcnData, MemData);
350
351   return Status;
352 }
353
354 /*---------------------------------------------------------------------------------------*/
355 /**
356  * Call the host environment interface to provide a user hook opportunity.
357  *
358  * @param[in]      Data
359  * @param[in,out]  IdsCalloutData
360  *
361  * @return   The AGESA Status returned from the callout.
362  *
363  */
364
365
366 AGESA_STATUS
367 AgesaGetIdsData  (
368   IN       UINTN              Data,
369   IN OUT   IDS_CALLOUT_STRUCT *IdsCalloutData
370   )
371 {
372   AGESA_STATUS Status;
373
374   Status =  AmdAgesaCallout (AGESA_GET_IDS_INIT_DATA, (UINT32)Data, IdsCalloutData);
375
376   return Status;
377 }
378
379
380 /*----------------------------------------------------------------------------------------*/
381 /**
382  * PCIE slot reset control
383  *
384  *
385  *
386  * @param[in]  FcnData              Function data
387  * @param[in]  ResetInfo            Reset information
388  * @retval     Status               Agesa status
389  */
390
391 AGESA_STATUS
392 AgesaPcieSlotResetControl (
393   IN      UINTN                 FcnData,
394   IN      PCIe_SLOT_RESET_INFO  *ResetInfo
395   )
396 {
397   AGESA_STATUS Status;
398   Status = AmdAgesaCallout (AGESA_GNB_PCIE_SLOT_RESET, (UINT32) FcnData, ResetInfo);
399   return  Status;
400 }
401
402
403 /*----------------------------------------------------------------------------------------*/
404 /**
405  * OEM callout function for FCH data override
406  *
407  *
408  * @param[in]  FchData              FCH data pointer
409  * @retval     Status               This feature is not supported
410  */
411
412 AGESA_STATUS
413 AgesaFchOemCallout (
414   IN      VOID              *FchData
415   )
416 {
417   return AGESA_UNSUPPORTED;
418 }
419
420 /*---------------------------------------------------------------------------------------*/
421 /**
422  * Optional call to the host environment interface to change the external Vref for training.
423  *
424  * @param[in]      SocketIdModuleId - (SocketID << 8) | ModuleId
425  * @param[in,out]  MemData
426  *
427  * @return   The AGESA Status returned from the callout.
428  *
429  */
430 AGESA_STATUS
431 AgesaExternal__TrainVrefChange (
432   IN       UINTN           SocketIdModuleId,
433   IN OUT   MEM_DATA_STRUCT *MemData
434   )
435 {
436   AGESA_STATUS Status;
437
438   Status =  AmdAgesaCallout (AGESA_EXTERNAL____TRAIN_VREF_CHANGE, (UINT32)SocketIdModuleId, MemData);
439
440   return Status;
441 }