src/vendorcode/amd/agesa/f12/Proc/CPU/cpuPowerMgmtSystemTables.h

   1 /* $NoKeywords:$ */
   2 /**
   3  * @file
   4  *
   5  * Power Management Table declarations.
   6  *
   7  * @xrefitem bom "File Content Label" "Release Content"
   8  * @e project:      AGESA
   9  * @e sub-project:  CPU
  10  * @e \$Revision: 44324 $   @e \$Date: 2010-12-22 17:16:51 +0800 (Wed, 22 Dec 2010) $
  11  *
  12  */
  13 /*
  14  ******************************************************************************
  15  *
  16  * Copyright (c) 2011, Advanced Micro Devices, Inc.
  17  * All rights reserved.
  18  *
  19  * Redistribution and use in source and binary forms, with or without
  20  * modification, are permitted provided that the following conditions are met:
  21  *     * Redistributions of source code must retain the above copyright
  22  *       notice, this list of conditions and the following disclaimer.
  23  *     * Redistributions in binary form must reproduce the above copyright
  24  *       notice, this list of conditions and the following disclaimer in the
  25  *       documentation and/or other materials provided with the distribution.
  26  *     * Neither the name of Advanced Micro Devices, Inc. nor the names of
  27  *       its contributors may be used to endorse or promote products derived
  28  *       from this software without specific prior written permission.
  29  *
  30  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  31  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  32  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  33  * DISCLAIMED. IN NO EVENT SHALL ADVANCED MICRO DEVICES, INC. BE LIABLE FOR ANY
  34  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  35  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  36  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  37  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  38  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  39  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40  ******************************************************************************
  41  */
  42
  43 #ifndef _CPU_POWER_MGMT_SYSTEM_TABLES_H_
  44 #define _CPU_POWER_MGMT_SYSTEM_TABLES_H_
  45
  46
  47 /*---------------------------------------------------------------------------------------
  48  *          M I X E D   (Definitions And Macros / Typedefs, Structures, Enums)
  49  *---------------------------------------------------------------------------------------
  50  */
  51
  52
  53 /*---------------------------------------------------------------------------------------
  54  *                 D E F I N I T I O N S     A N D     M A C R O S
  55  *---------------------------------------------------------------------------------------
  56  */
  57 #define PM_EXEFLAGS_WARM_ONLY    0x00000001   /* Skip step if set && cold reset */
  58 #define PM_EXEFLAGS_NOT_ON_S3    0x00000002   /* Skip step if S3 resume */
  59 #define PM_EXEFLAGS_SYSTEM_TASK  0x00000004   /* Future use */
  60 #define PM_EXEFLAGS_SERIAL_EXE   0x00000008   /* BSC will wait for remote core 0 to complete the step*/
  61
  62
  63 /*---------------------------------------------------------------------------------------
  64  *               T Y P E D E F S,   S T R U C T U R E S,    E N U M S
  65  *---------------------------------------------------------------------------------------
  66  */
  67 typedef VOID F_PM_STEP_FUNCTION (
  68   IN       CPU_SPECIFIC_SERVICES *FamilySpecificServices,
  69   IN       AMD_CPU_EARLY_PARAMS  *CpuEarlyParamsPtr,
  70   IN       AMD_CONFIG_PARAMS     *StdHeader
  71   );
  72
  73 /// Reference to a Method.
  74 typedef F_PM_STEP_FUNCTION *PF_PM_STEP_FUNCTION;
  75
  76
  77 /// A structure representing a step in a power management
  78 /// initialization process to be invoked at AmdInitEarly
  79 typedef struct {
  80   UINT32  ExeFlags;                                   ///< Execution flags
  81   PF_PM_STEP_FUNCTION FuncPtr;                        ///< Function pointer
  82 } SYS_PM_TBL_STEP;
  83
  84
  85 /*---------------------------------------------------------------------------------------
  86  *                        F U N C T I O N    P R O T O T Y P E
  87  *---------------------------------------------------------------------------------------
  88  */
  89
  90
  91 #endif  // _CPU_POWER_MGMT_SYSTEM_TABLES_H_/
  92