src/vendorcode/amd/agesa/f15/Proc/CPU/Feature/cpuCpb.h

   1 /* $NoKeywords:$ */
   2 /**
   3  * @file
   4  *
   5  * AMD AGESA CPU Core Performance Boost Functions declarations.
   6  *
   7  * Contains code that declares the AGESA CPU CPB related APIs
   8  *
   9  * @xrefitem bom "File Content Label" "Release Content"
  10  * @e project:      AGESA
  11  * @e sub-project:  CPU/Feature
  12  * @e \$Revision: 44324 $   @e \$Date: 2010-12-22 02:16:51 -0700 (Wed, 22 Dec 2010) $
  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 #ifndef _CPU_CPB_H_
  47 #define _CPU_CPB_H_
  48
  49 /*----------------------------------------------------------------------------------------
  50  *          M I X E D   (Definitions And Macros / Typedefs, Structures, Enums)
  51  *----------------------------------------------------------------------------------------
  52  */
  53 //  Forward declaration needed for multi-structure mutual references
  54 AGESA_FORWARD_DECLARATION (CPB_FAMILY_SERVICES);
  55
  56 /*----------------------------------------------------------------------------------------
  57  *                 D E F I N I T I O N S     A N D     M A C R O S
  58  *----------------------------------------------------------------------------------------
  59  */
  60
  61 /*----------------------------------------------------------------------------------------
  62  *                    T Y P E D E F S     A N D     S T R U C T U R E S
  63  *----------------------------------------------------------------------------------------
  64  */
  65
  66
  67 /*---------------------------------------------------------------------------------------*/
  68 /**
  69  *  Family specific call to check if CPB is supported.
  70  *
  71  * @param[in]    CpbServices        Core Performance Boost 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.
  75  *
  76  * @retval       TRUE               CPB is supported.
  77  * @retval       FALSE              CPB is not supported.
  78  *
  79  */
  80 typedef BOOLEAN F_CPB_IS_SUPPORTED (
  81   IN       CPB_FAMILY_SERVICES    *CpbServices,
  82   IN       PLATFORM_CONFIGURATION *PlatformConfig,
  83   IN       UINT32                 Socket,
  84   IN       AMD_CONFIG_PARAMS      *StdHeader
  85   );
  86
  87 /// Reference to a Method.
  88 typedef F_CPB_IS_SUPPORTED *PF_CPB_IS_SUPPORTED;
  89
  90 /*---------------------------------------------------------------------------------------*/
  91 /**
  92  *  Family specific call to enable CPB.
  93  *
  94  * @param[in]    CpbServices        Core Performance Boost services.
  95  * @param[in]    PlatformConfig     Contains the runtime modifiable feature input data.
  96  * @param[in]    EntryPoint         Timepoint designator.
  97  * @param[in]    Socket             Zero-based socket number.
  98  * @param[in]    StdHeader          Config Handle for library, services.
  99  *
 100  * @return       Family specific error value.
 101  *
 102  */
 103 typedef AGESA_STATUS F_CPB_INIT (
 104   IN       CPB_FAMILY_SERVICES    *CpbServices,
 105   IN       PLATFORM_CONFIGURATION *PlatformConfig,
 106   IN       UINT64                 EntryPoint,
 107   IN       UINT32                 Socket,
 108   IN       AMD_CONFIG_PARAMS      *StdHeader
 109   );
 110
 111 /// Reference to a Method.
 112 typedef F_CPB_INIT *PF_CPB_INIT;
 113
 114 /**
 115  * Provide the interface to the CPB Family Specific Services.
 116  *
 117  * Use the methods or data in this struct to adapt the feature code to a specific cpu family or model (or stepping!).
 118  * Each supported Family must provide an implementation for all methods in this interface, even if the
 119  * implementation is a CommonReturn().
 120  */
 121 struct _CPB_FAMILY_SERVICES {
 122   UINT16          Revision;                                             ///< Interface version
 123   // Public Methods.
 124   PF_CPB_IS_SUPPORTED IsCpbSupported;                                   ///< Method: Family specific call to check if CPB is supported.
 125   PF_CPB_INIT         EnableCpbOnSocket;                                ///< Method: Family specific call to enable CPB.
 126 };
 127
 128
 129 /*----------------------------------------------------------------------------------------
 130  *                          F U N C T I O N S     P R O T O T Y P E
 131  *----------------------------------------------------------------------------------------
 132  */
 133
 134 #endif  // _CPU_CPB_H_