AGESA F15: AMD family15 AGESA code
[coreboot.git] / src / vendorcode / amd / agesa / f15 / Proc / CPU / Feature / cpuApm.c
1 /* $NoKeywords:$ */
2 /**
3  * @file
4  *
5  * AMD AGESA CPU Application Power Management (APM) feature support code.
6  *
7  * Contains code that declares the AGESA CPU APM related APIs
8  *
9  * @xrefitem bom "File Content Label" "Release Content"
10  * @e project:      AGESA
11  * @e sub-project:  CPU/Feature
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 "GeneralServices.h"
52 #include "cpuFamilyTranslation.h"
53 #include "cpuApicUtilities.h"
54 #include "cpuFeatures.h"
55 #include "cpuApm.h"
56 #include "Filecode.h"
57 CODE_GROUP (G1_PEICC)
58 RDATA_GROUP (G2_PEI)
59
60 #define FILECODE PROC_CPU_FEATURE_CPUAPM_FILECODE
61
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 VOID
77 STATIC
78 EnableApmOnSocket (
79   IN       VOID *PlatformConfig,
80   IN       AMD_CONFIG_PARAMS *StdHeader
81   );
82
83 /*----------------------------------------------------------------------------------------
84  *                          E X P O R T E D    F U N C T I O N S
85  *----------------------------------------------------------------------------------------
86  */
87 extern CPU_FAMILY_SUPPORT_TABLE ApmFamilyServiceTable;
88
89 /*---------------------------------------------------------------------------------------*/
90 /**
91  *  Should Application Power Management (APM) be enabled
92  *
93  * @param[in]    PlatformConfig     Contains the runtime modifiable feature input data.
94  * @param[in]    StdHeader          Config Handle for library, services.
95  *
96  * @retval       TRUE               APM is supported.
97  * @retval       FALSE              APM cannot be enabled.
98  *
99  */
100 BOOLEAN
101 STATIC
102 IsApmFeatureEnabled (
103   IN       PLATFORM_CONFIGURATION *PlatformConfig,
104   IN       AMD_CONFIG_PARAMS      *StdHeader
105   )
106 {
107   UINT32              Socket;
108   BOOLEAN             IsEnabled;
109   APM_FAMILY_SERVICES *FamilyServices;
110
111   IsEnabled = FALSE;
112
113   for (Socket = 0; Socket < GetPlatformNumberOfSockets (); Socket++) {
114     if (IsProcessorPresent (Socket, StdHeader)) {
115       GetFeatureServicesOfSocket (&ApmFamilyServiceTable, Socket, (CONST VOID **)&FamilyServices, StdHeader);
116       if (FamilyServices != NULL) {
117         if (FamilyServices->IsApmSupported (FamilyServices, PlatformConfig, Socket, StdHeader)) {
118           IsEnabled = TRUE;
119           break;
120         }
121       }
122     }
123   }
124   return IsEnabled;
125 }
126
127 /*---------------------------------------------------------------------------------------*/
128 /**
129  *  Enable Application Power Management (APM)
130  *
131  * @param[in]    EntryPoint         Timepoint designator.
132  * @param[in]    PlatformConfig     Contains the runtime modifiable feature input data.
133  * @param[in]    StdHeader          Config Handle for library, services.
134  *
135  * @retval       AGESA_SUCCESS      Always succeeds.
136  *
137  */
138 AGESA_STATUS
139 STATIC
140 InitializeApmFeature (
141   IN       UINT64                 EntryPoint,
142   IN       PLATFORM_CONFIGURATION *PlatformConfig,
143   IN       AMD_CONFIG_PARAMS      *StdHeader
144   )
145 {
146   UINT32       BscSocket;
147   UINT32       Ignored;
148   UINT32       Socket;
149   UINT32       NumberOfSockets;
150   AP_TASK      TaskPtr;
151   AGESA_STATUS IgnoredSts;
152
153   IDS_HDT_CONSOLE (CPU_TRACE, "    APM mode is enabled\n");
154
155   IdentifyCore (StdHeader, &BscSocket, &Ignored, &Ignored, &IgnoredSts);
156   NumberOfSockets = GetPlatformNumberOfSockets ();
157
158   TaskPtr.FuncAddress.PfApTaskI = EnableApmOnSocket;
159   TaskPtr.DataTransfer.DataSizeInDwords = 2;
160   TaskPtr.DataTransfer.DataPtr = PlatformConfig;
161   TaskPtr.DataTransfer.DataTransferFlags = 0;
162   TaskPtr.ExeFlags = WAIT_FOR_CORE;
163
164   for (Socket = 0; Socket < NumberOfSockets; Socket++) {
165     if (IsProcessorPresent (Socket, StdHeader)) {
166       if (Socket != BscSocket) {
167         ApUtilRunCodeOnSocketCore ((UINT8) Socket, 0, &TaskPtr, StdHeader);
168       }
169     }
170   }
171
172   EnableApmOnSocket (PlatformConfig, StdHeader);
173   return AGESA_SUCCESS;
174 }
175
176 /*---------------------------------------------------------------------------------------*/
177 /**
178  *  AP task to enable APM
179  *
180  * @param[in]    PlatformConfig     Contains the runtime modifiable feature input data.
181  * @param[in]    StdHeader          Config Handle for library, services.
182  *
183  */
184 VOID
185 STATIC
186 EnableApmOnSocket (
187   IN       VOID *PlatformConfig,
188   IN       AMD_CONFIG_PARAMS *StdHeader
189   )
190 {
191   APM_FAMILY_SERVICES *FamilyServices;
192
193   GetFeatureServicesOfCurrentCore (&ApmFamilyServiceTable, (CONST VOID **)&FamilyServices, StdHeader);
194   FamilyServices->EnableApmOnSocket (FamilyServices,
195                                      PlatformConfig,
196                                      StdHeader);
197 }
198
199 CONST CPU_FEATURE_DESCRIPTOR ROMDATA CpuFeatureApm =
200 {
201   CpuApm,
202   (CPU_FEAT_BEFORE_RELINQUISH_AP | CPU_FEAT_AFTER_RESUME_MTRR_SYNC),
203   IsApmFeatureEnabled,
204   InitializeApmFeature
205 };