zbao | 7d94cf9 | 2012-07-02 14:19:14 +0800 | [diff] [blame] | 1 | /* $NoKeywords:$ */ |
| 2 | /** |
| 3 | * @file |
| 4 | * |
| 5 | * AMD AGESA CPU Application Power Management (APM) Functions declarations. |
| 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: 63425 $ @e \$Date: 2011-12-22 11:24:10 -0600 (Thu, 22 Dec 2011) $ |
| 13 | * |
| 14 | */ |
| 15 | /* |
| 16 | ****************************************************************************** |
| 17 | * |
Siyuan Wang | 641f00c | 2013-06-08 11:50:55 +0800 | [diff] [blame] | 18 | * Copyright (c) 2008 - 2012, Advanced Micro Devices, Inc. |
| 19 | * All rights reserved. |
zbao | 7d94cf9 | 2012-07-02 14:19:14 +0800 | [diff] [blame] | 20 | * |
Siyuan Wang | 641f00c | 2013-06-08 11:50:55 +0800 | [diff] [blame] | 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. |
zbao | 7d94cf9 | 2012-07-02 14:19:14 +0800 | [diff] [blame] | 31 | * |
Siyuan Wang | 641f00c | 2013-06-08 11:50:55 +0800 | [diff] [blame] | 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. |
zbao | 7d94cf9 | 2012-07-02 14:19:14 +0800 | [diff] [blame] | 42 | ****************************************************************************** |
| 43 | */ |
| 44 | |
| 45 | #ifndef _CPU_APM_H_ |
| 46 | #define _CPU_APM_H_ |
| 47 | |
| 48 | /*---------------------------------------------------------------------------------------- |
| 49 | * M I X E D (Definitions And Macros / Typedefs, Structures, Enums) |
| 50 | *---------------------------------------------------------------------------------------- |
| 51 | */ |
| 52 | // Forward declaration needed for multi-structure mutual references |
| 53 | AGESA_FORWARD_DECLARATION (APM_FAMILY_SERVICES); |
| 54 | |
| 55 | /*---------------------------------------------------------------------------------------- |
| 56 | * D E F I N I T I O N S A N D M A C R O S |
| 57 | *---------------------------------------------------------------------------------------- |
| 58 | */ |
| 59 | |
| 60 | /*---------------------------------------------------------------------------------------- |
| 61 | * T Y P E D E F S A N D S T R U C T U R E S |
| 62 | *---------------------------------------------------------------------------------------- |
| 63 | */ |
| 64 | |
| 65 | |
| 66 | /*---------------------------------------------------------------------------------------*/ |
| 67 | /** |
| 68 | * Family specific call to check if Application Power Management (APM) is supported. |
| 69 | * |
| 70 | * @param[in] ApmServices APM services. |
| 71 | * @param[in] PlatformConfig Contains the runtime modifiable feature input data. |
| 72 | * @param[in] Socket Zero-based socket number. |
| 73 | * @param[in] StdHeader Config Handle for library, services. |
| 74 | * |
| 75 | * @retval TRUE APM is supported. |
| 76 | * @retval FALSE APM is not supported. |
| 77 | * |
| 78 | */ |
| 79 | typedef BOOLEAN F_APM_IS_SUPPORTED ( |
| 80 | IN APM_FAMILY_SERVICES *CpbServices, |
| 81 | IN PLATFORM_CONFIGURATION *PlatformConfig, |
| 82 | IN UINT32 Socket, |
| 83 | IN AMD_CONFIG_PARAMS *StdHeader |
| 84 | ); |
| 85 | |
| 86 | /// Reference to a Method. |
| 87 | typedef F_APM_IS_SUPPORTED *PF_APM_IS_SUPPORTED; |
| 88 | |
| 89 | /*---------------------------------------------------------------------------------------*/ |
| 90 | /** |
| 91 | * Family specific call to enable APM. |
| 92 | * |
| 93 | * @param[in] ApmServices APM services. |
| 94 | * @param[in] PlatformConfig Contains the runtime modifiable feature input data. |
| 95 | * @param[in] StdHeader Config Handle for library, services. |
| 96 | * |
| 97 | * @return Family specific error value. |
| 98 | * |
| 99 | */ |
| 100 | typedef AGESA_STATUS F_APM_INIT ( |
| 101 | IN APM_FAMILY_SERVICES *ApmServices, |
| 102 | IN PLATFORM_CONFIGURATION *PlatformConfig, |
| 103 | IN AMD_CONFIG_PARAMS *StdHeader |
| 104 | ); |
| 105 | |
| 106 | /// Reference to a Method. |
| 107 | typedef F_APM_INIT *PF_APM_INIT; |
| 108 | |
| 109 | /** |
| 110 | * Provide the interface to the APM Family Specific Services. |
| 111 | * |
| 112 | * Use the methods or data in this struct to adapt the feature code to a specific cpu family or model (or stepping!). |
| 113 | * Each supported Family must provide an implementation for all methods in this interface, even if the |
| 114 | * implementation is a CommonReturn(). |
| 115 | */ |
| 116 | struct _APM_FAMILY_SERVICES { |
| 117 | UINT16 Revision; ///< Interface version |
| 118 | // Public Methods. |
| 119 | PF_APM_IS_SUPPORTED IsApmSupported; ///< Method: Family specific call to check if APM is supported. |
| 120 | PF_APM_INIT EnableApmOnSocket; ///< Method: Family specific call to enable APM. |
| 121 | }; |
| 122 | |
| 123 | |
| 124 | /*---------------------------------------------------------------------------------------- |
| 125 | * F U N C T I O N S P R O T O T Y P E |
| 126 | *---------------------------------------------------------------------------------------- |
| 127 | */ |
| 128 | |
| 129 | #endif // _CPU_APM_H_ |