src/vendorcode/amd/agesa/f15/Include/OptionPstate.h

   1 /* $NoKeywords:$ */
   2 /**
   3  * @file
   4  *
   5  * AMD ACPI PState option API.
   6  *
   7  * Contains structures and values used to control the PStates option code.
   8  *
   9  * @xrefitem bom "File Content Label" "Release Content"
  10  * @e project:      AGESA
  11  * @e sub-project:  OPTION
  12  * @e \$Revision: 44324 $   @e \$Date: 2010-12-22 02:16:51 -0700 (Wed, 22 Dec 2010) $
  13  *
  14  */
  15 /*****************************************************************************
  16  *
  17  * Copyright (C) 2012 Advanced Micro Devices, Inc.
  18  * All rights reserved.
  19  *
  20  * Redistribution and use in source and binary forms, with or without
  21  * modification, are permitted provided that the following conditions are met:
  22  *     * Redistributions of source code must retain the above copyright
  23  *       notice, this list of conditions and the following disclaimer.
  24  *     * Redistributions in binary form must reproduce the above copyright
  25  *       notice, this list of conditions and the following disclaimer in the
  26  *       documentation and/or other materials provided with the distribution.
  27  *     * Neither the name of Advanced Micro Devices, Inc. nor the names of
  28  *       its contributors may be used to endorse or promote products derived
  29  *       from this software without specific prior written permission.
  30  *
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  32  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  33  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  34  * DISCLAIMED. IN NO EVENT SHALL ADVANCED MICRO DEVICES, INC. BE LIABLE FOR ANY
  35  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  36  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  37  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  38  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  39  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  40  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  41  *
  42  ******************************************************************************
  43  */
  44
  45 #ifndef _OPTION_PSTATE_H_
  46 #define _OPTION_PSTATE_H_
  47
  48 #include "cpuPstateTables.h"
  49
  50 /*----------------------------------------------------------------------------------------
  51  *          M I X E D   (Definitions And Macros / Typedefs, Structures, Enums)
  52  *----------------------------------------------------------------------------------------
  53  */
  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,   S T R U C T U R E S,    E N U M S
  62  *----------------------------------------------------------------------------------------
  63  */
  64
  65 typedef AGESA_STATUS OPTION_SSDT_FEATURE (
  66   IN       AMD_CONFIG_PARAMS      *StdHeader,
  67   IN       PLATFORM_CONFIGURATION *PlatformConfig,
  68   IN OUT   VOID                   **AcpiPstatePtr
  69   );
  70
  71 typedef UINT32 OPTION_ACPI_FEATURE (
  72   IN       PLATFORM_CONFIGURATION *PlatformConfig,
  73   IN       PSTATE_LEVELING        *PStateLevelingBuffer,
  74   IN OUT   VOID                   **AcpiPStatePtr,
  75   IN       UINT8                  LocalApicId,
  76   IN       AMD_CONFIG_PARAMS      *StdHeader
  77   );
  78
  79 typedef AGESA_STATUS OPTION_PSTATE_GATHER (
  80   IN       AMD_CONFIG_PARAMS *StdHeader,
  81   IN OUT   S_CPU_AMD_PSTATE  *PStateStrucPtr
  82   );
  83
  84 typedef AGESA_STATUS OPTION_PSTATE_LEVELING (
  85   IN OUT   S_CPU_AMD_PSTATE   *PStateStrucPtr,
  86   IN       AMD_CONFIG_PARAMS  *StdHeader
  87   );
  88
  89 #define PSTATE_STRUCT_VERSION  0x01
  90
  91 /// Indirection vectors for POST/PEI PState code
  92 typedef struct  {
  93   UINT16                  OptPstateVersion;     ///< revision of this structure
  94   OPTION_PSTATE_GATHER    *PstateGather;        ///< vector for data gathering routine
  95   OPTION_PSTATE_LEVELING  *PstateLeveling;      ///< vector for leveling routine
  96 } OPTION_PSTATE_POST_CONFIGURATION;
  97
  98 /// Indirection vectors for LATE/DXE PState code
  99 typedef struct  {
 100   UINT16                  OptPstateVersion;     ///< revision of this structure
 101   OPTION_SSDT_FEATURE     *SsdtFeature;         ///< vector for routine to generate SSDT
 102   OPTION_ACPI_FEATURE     *PstateFeature;       ///< vector for routine to generate ACPI PState Objects
 103   OPTION_ACPI_FEATURE     *CstateFeature;       ///< vector for routine to generate ACPI CState Objects
 104   BOOLEAN                 CfgPstatePpc;         ///< boolean for creating _PPC method
 105   BOOLEAN                 CfgPstatePct;         ///< boolean for creating _PCT method
 106   BOOLEAN                 CfgPstatePsd;         ///< boolean for creating _PSD method
 107   BOOLEAN                 CfgPstatePss;         ///< boolean for creating _PSS method
 108   BOOLEAN                 CfgPstateXpss;        ///< boolean for creating _XPSS method
 109 } OPTION_PSTATE_LATE_CONFIGURATION;
 110
 111 /*----------------------------------------------------------------------------------------
 112  *                        F U N C T I O N    P R O T O T Y P E
 113  *----------------------------------------------------------------------------------------
 114  */
 115
 116 #endif  // _OPTION_PSTATE_H_