AGESA F15: AMD family15 AGESA code
[coreboot.git] / src / vendorcode / amd / agesa / f15 / Proc / CPU / Family / 0x10 / cpuCommonF10Utilities.c
1 /* $NoKeywords:$ */
2 /**
3  * @file
4  *
5  * AMD Family_10 specific utility functions.
6  *
7  * Provides numerous utility functions specific to family 10h.
8  *
9  * @xrefitem bom "File Content Label" "Release Content"
10  * @e project:      AGESA
11  * @e sub-project:  CPU/F10
12  * @e \$Revision: 56279 $   @e \$Date: 2011-07-11 13:11:28 -0600 (Mon, 11 Jul 2011) $
13  *
14  */
15 /*
16  *****************************************************************************
17  *
18  * Copyright (C) 2012 Advanced Micro Devices, Inc.
19  * All rights reserved.
20  *
21  * Redistribution and use in source and binary forms, with or without
22  * modification, are permitted provided that the following conditions are met:
23  *     * Redistributions of source code must retain the above copyright
24  *       notice, this list of conditions and the following disclaimer.
25  *     * Redistributions in binary form must reproduce the above copyright
26  *       notice, this list of conditions and the following disclaimer in the
27  *       documentation and/or other materials provided with the distribution.
28  *     * Neither the name of Advanced Micro Devices, Inc. nor the names of
29  *       its contributors may be used to endorse or promote products derived
30  *       from this software without specific prior written permission.
31  *
32  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
33  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
34  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
35  * DISCLAIMED. IN NO EVENT SHALL ADVANCED MICRO DEVICES, INC. BE LIABLE FOR ANY
36  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
37  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
38  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
39  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
40  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
41  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42  *
43  ******************************************************************************
44  */
45
46 /*----------------------------------------------------------------------------------------
47  *                             M O D U L E S    U S E D
48  *----------------------------------------------------------------------------------------
49  */
50 #include "AGESA.h"
51 #include "amdlib.h"
52 #include "Ids.h"
53 #include "cpuRegisters.h"
54 #include "cpuServices.h"
55 #include "GeneralServices.h"
56 #include "cpuFamilyTranslation.h"
57 #include "cpuCommonF10Utilities.h"
58 #include "Filecode.h"
59 CODE_GROUP (G1_PEICC)
60 RDATA_GROUP (G2_PEI)
61
62 #define FILECODE PROC_CPU_FAMILY_0X10_CPUCOMMONF10UTILITIES_FILECODE
63
64 /*----------------------------------------------------------------------------------------
65  *                   D E F I N I T I O N S    A N D    M A C R O S
66  *----------------------------------------------------------------------------------------
67  */
68
69 /*----------------------------------------------------------------------------------------
70  *                  T Y P E D E F S     A N D     S T R U C T U R E S
71  *----------------------------------------------------------------------------------------
72  */
73 /**
74  * Node ID MSR register fields.
75  * Provide the layout of fields in the Node ID MSR.
76  */
77 typedef struct {
78   UINT64    NodeId:3;                 ///< The core is on the node with this node id.
79   UINT64    NodesPerProcessor:3;      ///< The number of Nodes in this processor.
80   UINT64    HeapIndex:6;              ///< The AP core heap index.
81   UINT64    :(63 - 11);               ///< Reserved.
82 } NODE_ID_MSR_FIELDS;
83
84 /// Node ID MSR.
85 typedef union {
86   NODE_ID_MSR_FIELDS   Fields;        ///< Access the register as individual fields
87   UINT64               Value;         ///< Access the register value.
88 } NODE_ID_MSR;
89
90 /*----------------------------------------------------------------------------------------
91  *           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
92  *----------------------------------------------------------------------------------------
93  */
94
95 /*----------------------------------------------------------------------------------------
96  *                          E X P O R T E D    F U N C T I O N S
97  *----------------------------------------------------------------------------------------
98  */
99
100 /*---------------------------------------------------------------------------------------*/
101 /**
102  *  Set warm reset status and count
103  *
104  *  @CpuServiceMethod{::F_CPU_SET_WARM_RESET_FLAG}.
105  *
106  *  This function will use bit9, and bit 10 of register F0x6C as a warm reset status and count.
107  *
108  *  @param[in]  FamilySpecificServices   The current Family Specific Services.
109  *  @param[in]  StdHeader                Handle of Header for calling lib functions and services.
110  *  @param[in]  Request                  Indicate warm reset status
111  *
112  */
113 VOID
114 F10SetAgesaWarmResetFlag (
115   IN       CPU_SPECIFIC_SERVICES *FamilySpecificServices,
116   IN       AMD_CONFIG_PARAMS *StdHeader,
117   IN       WARM_RESET_REQUEST *Request
118   )
119 {
120   PCI_ADDR  PciAddress;
121   UINT32    PciData;
122
123   PciAddress.AddressValue = MAKE_SBDFO (0, 0 , PCI_DEV_BASE, FUNC_0, HT_INIT_CTRL);
124   LibAmdPciRead (AccessWidth32, PciAddress, &PciData, StdHeader);
125
126   // bit[5] - indicate a warm reset is or is not required
127   PciData &= ~(HT_INIT_BIOS_RST_DET_0);
128   PciData = PciData | (Request->RequestBit << 5);
129
130   // bit[10,9] - indicate warm reset status and count
131   PciData &= ~(HT_INIT_BIOS_RST_DET_1 | HT_INIT_BIOS_RST_DET_2);
132   PciData |= Request->StateBits << 9;
133
134   LibAmdPciWrite (AccessWidth32, PciAddress, &PciData, StdHeader);
135 }
136
137 /*---------------------------------------------------------------------------------------*/
138 /**
139  *  Get warm reset status and count
140  *
141  *  @CpuServiceMethod{::F_CPU_GET_WARM_RESET_FLAG}.
142  *
143  *  This function will bit9, and bit 10 of register F0x6C as a warm reset status and count.
144  *
145  *  @param[in]   FamilySpecificServices   The current Family Specific Services.
146  *  @param[in]   StdHeader                Config handle for library and services
147  *  @param[out]  Request                  Indicate warm reset status
148  *
149  */
150 VOID
151 F10GetAgesaWarmResetFlag (
152   IN       CPU_SPECIFIC_SERVICES *FamilySpecificServices,
153   IN       AMD_CONFIG_PARAMS *StdHeader,
154      OUT   WARM_RESET_REQUEST *Request
155   )
156 {
157   PCI_ADDR  PciAddress;
158   UINT32    PciData;
159
160   PciAddress.AddressValue = MAKE_SBDFO (0, 0 , PCI_DEV_BASE, FUNC_0, HT_INIT_CTRL);
161   LibAmdPciRead (AccessWidth32, PciAddress, &PciData, StdHeader);
162
163   // bit[5] - indicate a warm reset is or is not required
164   Request->RequestBit = (UINT8) ((PciData & HT_INIT_BIOS_RST_DET_0) >> 5);
165   // bit[10,9] - indicate warm reset status and count
166   Request->StateBits = (UINT8) ((PciData & (HT_INIT_BIOS_RST_DET_1 | HT_INIT_BIOS_RST_DET_2)) >> 9);
167 }
168
169 /*---------------------------------------------------------------------------------------*/
170 /**
171  *  Use the Mailbox Register to get the Ap Mailbox info for the current core.
172  *
173  *  @CpuServiceMethod{::F_CPU_AMD_GET_AP_MAILBOX_FROM_HARDWARE}.
174  *
175  *  Access the mailbox register used with this NB family.  This is valid until the
176  *  point that some init code initializes the mailbox register for its normal use.
177  *  The Machine Check Misc (Thresholding) register is available as both a PCI config
178  *  register and a MSR, so it can be used as a mailbox from HT to other functions.
179  *
180  *  @param[in]     FamilySpecificServices  The current Family Specific Services.
181  *  @param[out]    ApMailboxInfo           The AP Mailbox info
182  *  @param[in]     StdHeader               Handle of Header for calling lib functions and services.
183  *
184  */
185 VOID
186 F10GetApMailboxFromHardware (
187   IN       CPU_SPECIFIC_SERVICES  *FamilySpecificServices,
188      OUT   AP_MAILBOXES           *ApMailboxInfo,
189   IN       AMD_CONFIG_PARAMS      *StdHeader
190   )
191 {
192   UINT64 MailboxInfo;
193
194   LibAmdMsrRead (MSR_MC_MISC_LINK_THRESHOLD, &MailboxInfo, StdHeader);
195   // Mailbox info is in bits 32 thru 43, 12 bits.
196   ApMailboxInfo->ApMailInfo.Info = (((UINT32) (MailboxInfo >> 32)) & (UINT32)0x00000FFF);
197   LibAmdMsrRead (MSR_MC_MISC_L3_THRESHOLD, &MailboxInfo, StdHeader);
198   // Mailbox info is in bits 32 thru 43, 12 bits.
199   ApMailboxInfo->ApMailExtInfo.Info = (((UINT32) (MailboxInfo >> 32)) & (UINT32)0x00000FFF);
200 }
201
202
203 /*---------------------------------------------------------------------------------------*/
204 /**
205  *  Set the system AP core number in the AP's Mailbox.
206  *
207  *  @CpuServiceMethod{::F_CPU_SET_AP_CORE_NUMBER}.
208  *
209  *  Access the mailbox register used with this NB family.  This is only intended to
210  *  run on the BSC at the time of initial AP launch.
211  *
212  *  @param[in]     FamilySpecificServices  The current Family Specific Services.
213  *  @param[in]     Socket                  The AP's socket
214  *  @param[in]     Module                  The AP's module
215  *  @param[in]     ApCoreNumber            The AP's unique core number
216  *  @param[in]     StdHeader               Handle of Header for calling lib functions and services.
217  *
218  */
219 VOID
220 F10SetApCoreNumber (
221   IN       CPU_SPECIFIC_SERVICES  *FamilySpecificServices,
222   IN       UINT32                 Socket,
223   IN       UINT32                 Module,
224   IN       UINT32                 ApCoreNumber,
225   IN       AMD_CONFIG_PARAMS      *StdHeader
226   )
227 {
228   UINT32   LocalPciRegister;
229   PCI_ADDR PciAddress;
230   AGESA_STATUS IgnoredStatus;
231
232   GetPciAddress (StdHeader, Socket, Module, &PciAddress, &IgnoredStatus);
233   PciAddress.Address.Function = FUNC_3;
234   PciAddress.Address.Register = 0x170;
235   LibAmdPciRead (AccessWidth32, PciAddress, &LocalPciRegister, StdHeader);
236   ((AP_MAIL_EXT_INFO *) &LocalPciRegister)->Fields.HeapIndex = ApCoreNumber;
237   LibAmdPciWrite (AccessWidth32, PciAddress, &LocalPciRegister, StdHeader);
238 }
239
240
241 /*---------------------------------------------------------------------------------------*/
242 /**
243  *  Get this AP's system core number from hardware.
244  *
245  *  @CpuServiceMethod{::F_CPU_GET_AP_CORE_NUMBER}.
246  *
247  *  Returns the system core number from the scratch MSR, where
248  *  it was saved at heap initialization.
249  *
250  *  @param[in]     FamilySpecificServices  The current Family Specific Services.
251  *  @param[in]     StdHeader               Handle of Header for calling lib functions and services.
252  *
253  *  @return        The AP's unique core number
254  */
255 UINT32
256 F10GetApCoreNumber (
257   IN       CPU_SPECIFIC_SERVICES  *FamilySpecificServices,
258   IN       AMD_CONFIG_PARAMS      *StdHeader
259   )
260 {
261   NODE_ID_MSR NodeIdMsr;
262
263   LibAmdMsrRead (0xC001100C, &NodeIdMsr.Value, StdHeader);
264   return (UINT32) NodeIdMsr.Fields.HeapIndex;
265 }
266
267
268 /*---------------------------------------------------------------------------------------*/
269 /**
270  *  Move the AP's core number from the mailbox to hardware.
271  *
272  *  @CpuServiceMethod{::F_CPU_TRANSFER_AP_CORE_NUMBER}.
273  *
274  *  Transfers this AP's system core number from the mailbox to
275  *  the NodeId MSR and initializes the other NodeId fields.
276  *
277  *  @param[in]     FamilySpecificServices  The current Family Specific Services.
278  *  @param[in]     StdHeader               Handle of Header for calling lib functions and services.
279  *
280  */
281 VOID
282 F10TransferApCoreNumber (
283   IN       CPU_SPECIFIC_SERVICES  *FamilySpecificServices,
284   IN       AMD_CONFIG_PARAMS      *StdHeader
285   )
286 {
287   AP_MAILBOXES Mailboxes;
288   NODE_ID_MSR NodeIdMsr;
289   UINT64 ExtFeatures;
290
291   NodeIdMsr.Value = 0;
292   FamilySpecificServices->GetApMailboxFromHardware (FamilySpecificServices, &Mailboxes, StdHeader);
293   NodeIdMsr.Fields.HeapIndex = Mailboxes.ApMailExtInfo.Fields.HeapIndex;
294   NodeIdMsr.Fields.NodeId = Mailboxes.ApMailInfo.Fields.Node;
295   NodeIdMsr.Fields.NodesPerProcessor = Mailboxes.ApMailInfo.Fields.ModuleType;
296   LibAmdMsrWrite (0xC001100C, &NodeIdMsr.Value, StdHeader);
297
298   // Indicate that the NodeId MSR is supported.
299   LibAmdMsrRead (MSR_CPUID_EXT_FEATS, &ExtFeatures, StdHeader);
300   ExtFeatures = (ExtFeatures | BIT51);
301   LibAmdMsrWrite (MSR_CPUID_EXT_FEATS, &ExtFeatures, StdHeader);
302 }
303
304
305 /*---------------------------------------------------------------------------------------*/
306 /**
307  * Return a number zero or one, based on the Core ID position in the initial APIC Id.
308  *
309  * @CpuServiceMethod{::F_CORE_ID_POSITION_IN_INITIAL_APIC_ID}.
310  *
311  * @param[in]     FamilySpecificServices  The current Family Specific Services.
312  * @param[in]     StdHeader               Handle of Header for calling lib functions and services.
313  *
314  * @retval        CoreIdPositionZero      Core Id is not low
315  * @retval        CoreIdPositionOne       Core Id is low
316  */
317 CORE_ID_POSITION
318 F10CpuAmdCoreIdPositionInInitialApicId (
319   IN       CPU_SPECIFIC_SERVICES  *FamilySpecificServices,
320   IN       AMD_CONFIG_PARAMS      *StdHeader
321   )
322 {
323   UINT64 InitApicIdCpuIdLo;
324
325   //  Check bit_54 [InitApicIdCpuIdLo] to find core id position.
326   LibAmdMsrRead (MSR_NB_CFG, &InitApicIdCpuIdLo, StdHeader);
327   InitApicIdCpuIdLo = ((InitApicIdCpuIdLo & BIT54) >> 54);
328   return ((InitApicIdCpuIdLo == 0) ? CoreIdPositionZero : CoreIdPositionOne);
329 }