5 * AMD AGESA CPU Application Power Management (APM) Functions declarations.
7 * Contains code that declares the AGESA CPU APM related APIs
9 * @xrefitem bom "File Content Label" "Release Content"
11 * @e sub-project: CPU/Feature
12 * @e \$Revision: 54493 $ @e \$Date: 2011-06-08 15:21:06 -0600 (Wed, 08 Jun 2011) $
16 ******************************************************************************
18 * Copyright (C) 2012 Advanced Micro Devices, Inc.
19 * All rights reserved.
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.
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.
43 ******************************************************************************
49 /*----------------------------------------------------------------------------------------
50 * M I X E D (Definitions And Macros / Typedefs, Structures, Enums)
51 *----------------------------------------------------------------------------------------
53 // Forward declaration needed for multi-structure mutual references
54 AGESA_FORWARD_DECLARATION (APM_FAMILY_SERVICES);
56 /*----------------------------------------------------------------------------------------
57 * D E F I N I T I O N S A N D M A C R O S
58 *----------------------------------------------------------------------------------------
61 /*----------------------------------------------------------------------------------------
62 * T Y P E D E F S A N D S T R U C T U R E S
63 *----------------------------------------------------------------------------------------
67 /*---------------------------------------------------------------------------------------*/
69 * Family specific call to check if Application Power Management (APM) is supported.
71 * @param[in] ApmServices APM services.
72 * @param[in] PlatformConfig Contains the runtime modifiable feature input data.
73 * @param[in] Socket Zero-based socket number.
74 * @param[in] StdHeader Config Handle for library, services.
76 * @retval TRUE APM is supported.
77 * @retval FALSE APM is not supported.
80 typedef BOOLEAN F_APM_IS_SUPPORTED (
81 IN APM_FAMILY_SERVICES *CpbServices,
82 IN PLATFORM_CONFIGURATION *PlatformConfig,
84 IN AMD_CONFIG_PARAMS *StdHeader
87 /// Reference to a Method.
88 typedef F_APM_IS_SUPPORTED *PF_APM_IS_SUPPORTED;
90 /*---------------------------------------------------------------------------------------*/
92 * Family specific call to enable APM.
94 * @param[in] ApmServices APM services.
95 * @param[in] PlatformConfig Contains the runtime modifiable feature input data.
96 * @param[in] StdHeader Config Handle for library, services.
98 * @return Family specific error value.
101 typedef AGESA_STATUS F_APM_INIT (
102 IN APM_FAMILY_SERVICES *ApmServices,
103 IN PLATFORM_CONFIGURATION *PlatformConfig,
104 IN AMD_CONFIG_PARAMS *StdHeader
107 /// Reference to a Method.
108 typedef F_APM_INIT *PF_APM_INIT;
111 * Provide the interface to the APM Family Specific Services.
113 * Use the methods or data in this struct to adapt the feature code to a specific cpu family or model (or stepping!).
114 * Each supported Family must provide an implementation for all methods in this interface, even if the
115 * implementation is a CommonReturn().
117 struct _APM_FAMILY_SERVICES {
118 UINT16 Revision; ///< Interface version
120 PF_APM_IS_SUPPORTED IsApmSupported; ///< Method: Family specific call to check if APM is supported.
121 PF_APM_INIT EnableApmOnSocket; ///< Method: Family specific call to enable APM.
125 /*----------------------------------------------------------------------------------------
126 * F U N C T I O N S P R O T O T Y P E
127 *----------------------------------------------------------------------------------------
130 #endif // _CPU_APM_H_