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

   1 /* $NoKeywords:$ */
   2 /**
   3  * @file
   4  *
   5  * AMD AGESA CPU HW C1e Functions declarations.
   6  *
   7  * Contains code that declares the AGESA CPU C1e 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_HW_C1E_H_
  47 #define _CPU_HW_C1E_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 (HW_C1E_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  *  Family specific call to check if hardware C1e is supported.
  68  *
  69  * @param[in]    HwC1eServices      Hardware C1e services.
  70  * @param[in]    StdHeader          Config Handle for library, services.
  71  *
  72  * @retval       TRUE               HW C1e is supported.
  73  * @retval       FALSE              HW C1e is not supported.
  74  *
  75  */
  76 typedef BOOLEAN F_HW_C1E_IS_SUPPORTED (
  77   IN       HW_C1E_FAMILY_SERVICES *HwC1eServices,
  78   IN       AMD_CONFIG_PARAMS *StdHeader
  79   );
  80
  81 /// Reference to a Method.
  82 typedef F_HW_C1E_IS_SUPPORTED *PF_HW_C1E_IS_SUPPORTED;
  83
  84 /*---------------------------------------------------------------------------------------*/
  85 /**
  86  *  Family specific call to enable hardware C1e.
  87  *
  88  * @param[in]    HwC1eServices      Hardware C1e services.
  89  * @param[in]    EntryPoint         Timepoint designator.
  90  * @param[in]    PlatformConfig     Contains the runtime modifiable feature input data.
  91  * @param[in]    StdHeader          Config Handle for library, services.
  92  *
  93  * @return       Family specific error value.
  94  *
  95  */
  96 typedef AGESA_STATUS F_HW_C1E_INIT (
  97   IN       HW_C1E_FAMILY_SERVICES *HwC1eServices,
  98   IN       UINT64 EntryPoint,
  99   IN       PLATFORM_CONFIGURATION *PlatformConfig,
 100   IN       AMD_CONFIG_PARAMS *StdHeader
 101   );
 102
 103 /// Reference to a Method.
 104 typedef F_HW_C1E_INIT *PF_HW_C1E_INIT;
 105
 106 /**
 107  * Provide the interface to the hardware C1e Family Specific Services.
 108  *
 109  * Use the methods or data in this struct to adapt the feature code to a specific cpu family or model (or stepping!).
 110  * Each supported Family must provide an implementation for all methods in this interface, even if the
 111  * implementation is a CommonReturn().
 112  */
 113 struct _HW_C1E_FAMILY_SERVICES {
 114   UINT16          Revision;                                             ///< Interface version
 115   // Public Methods.
 116   PF_HW_C1E_IS_SUPPORTED IsHwC1eSupported;                              ///< Method: Family specific call to check if hardware C1e is supported.
 117   PF_HW_C1E_INIT InitializeHwC1e;                                       ///< Method: Family specific call to enable hardware C1e.
 118 };
 119
 120
 121 /*----------------------------------------------------------------------------------------
 122  *                          F U N C T I O N S     P R O T O T Y P E
 123  *----------------------------------------------------------------------------------------
 124  */
 125
 126 #endif  // _CPU_HW_C1E_H_