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

   1 /* $NoKeywords:$ */
   2 /**
   3  * @file
   4  *
   5  * AMD AGESA CPU Pstate HPC mode Functions declarations.
   6  *
   7  * Contains code that declares the AGESA CPU Pstate HPC mode related APIs
   8  *
   9  * @xrefitem bom "File Content Label" "Release Content"
  10  * @e project:      AGESA
  11  * @e sub-project:  CPU/Feature
  12  * @e \$Revision: 52150 $   @e \$Date: 2011-05-03 01:01:08 -0600 (Tue, 03 May 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 #ifndef _CPU_PSTATE_HPC_MODE_H_
  47 #define _CPU_PSTATE_HPC_MODE_H_
  48
  49 /*----------------------------------------------------------------------------------------
  50  *          M I X E D   (Definitions And Macros / Typedefs, Structures, Enums)
  51  *----------------------------------------------------------------------------------------
  52  */
  53 AGESA_FORWARD_DECLARATION (PSTATE_HPC_MODE_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  *  Family specific call to enable P-state HPC mode
  67  *
  68  * @param[in]    PstateHpcModeService P-state HPC mode services.
  69  * @param[in]    PlatformConfig       Contains the runtime modifiable feature input data.
  70  * @param[in]    StdHeader            Config Handle for library, services.
  71  *
  72  * @return       Family specific error value.
  73  *
  74  */
  75 typedef AGESA_STATUS F_PSTATE_HPC_MODE_INIT (
  76   IN       PSTATE_HPC_MODE_FAMILY_SERVICES *PstateHpcModeService,
  77   IN       PLATFORM_CONFIGURATION *PlatformConfig,
  78   IN       AMD_CONFIG_PARAMS      *StdHeader
  79   );
  80
  81 /// Reference to a Method.
  82 typedef F_PSTATE_HPC_MODE_INIT *PF_PSTATE_HPC_MODE_INIT;
  83
  84 /**
  85  * Provide the interface to the P-state HPC mode Family Specific Services.
  86  *
  87  * Use the methods or data in this struct to adapt the feature code to a specific cpu family or model (or stepping!).
  88  * Each supported Family must provide an implementation for all methods in this interface, even if the
  89  * implementation is a CommonReturn().
  90  */
  91 struct _PSTATE_HPC_MODE_FAMILY_SERVICES {
  92   UINT16          Revision;                                             ///< Interface version
  93   // Public Methods.
  94   PF_PSTATE_HPC_MODE_INIT         EnablePstateHpcMode;              ///< Method: Family specific call to enable P-state HPC mode.
  95 };
  96 /*----------------------------------------------------------------------------------------
  97  *                          F U N C T I O N S     P R O T O T Y P E
  98  *----------------------------------------------------------------------------------------
  99  */
 100
 101 #endif  // _CPU_PSTATE_HPC_MODE_H_