Gitiles
Code Review Sign In
review.coreboot.org / coreboot / dbdf170dcdf9edbc860766606e53c6d647d89d38 / . / src / vendorcode / amd / agesa / f14 / Proc / CPU / Feature / cpuLowPwrPstate.h
blob: 3ce3cdf40d220065301294ca4b88c4dfe4577ffe [file] [log] [blame]
Frank Vibrans2b4c8312011-02-14 18:30:54 +0000[diff] [blame]1/* $NoKeywords:$ */
2/**
3 * @file
4 *
5 * AMD AGESA CPU create low power P-state for PROCHOT_L throttling Functions declarations.
6 *
7 * Contains code that declares the AGESA CPU low power P-state related APIs
8 *
9 * @xrefitem bom "File Content Label" "Release Content"
10 * @e project: AGESA
11 * @e sub-project: CPU/Feature
12 * @e \$Revision: 36567 $ @e \$Date: 2010-08-21 02:35:15 +0800 (Sat, 21 Aug 2010) $
13 *
14 */
15/*
16 *****************************************************************************
17 *
18 * Copyright (c) 2011, Advanced Micro Devices, Inc.
19 * All rights reserved.
Edward O'Callaghane963b382014-07-06 19:27:14 +1000[diff] [blame]20 *
Frank Vibrans2b4c8312011-02-14 18:30:54 +0000[diff] [blame]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.
Edward O'Callaghane963b382014-07-06 19:27:14 +1000[diff] [blame]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
Frank Vibrans2b4c8312011-02-14 18:30:54 +0000[diff] [blame]30 * from this software without specific prior written permission.
Edward O'Callaghane963b382014-07-06 19:27:14 +1000[diff] [blame]31 *
Frank Vibrans2b4c8312011-02-14 18:30:54 +0000[diff] [blame]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.
Edward O'Callaghane963b382014-07-06 19:27:14 +1000[diff] [blame]42 *
Frank Vibrans2b4c8312011-02-14 18:30:54 +0000[diff] [blame]43 * ***************************************************************************
44 *
45 */
46
47#ifndef _CPU_LOW_PWR_PSTATE_H_
48#define _CPU_LOW_PWR_PSTATE_H_
49
50/*----------------------------------------------------------------------------------------
51 * M I X E D (Definitions And Macros / Typedefs, Structures, Enums)
52 *----------------------------------------------------------------------------------------
53 */
54// Forward declaration needed for multi-structure mutual references
55AGESA_FORWARD_DECLARATION (LOW_PWR_PSTATE_FAMILY_SERVICES);
56
57/*----------------------------------------------------------------------------------------
58 * D E F I N I T I O N S A N D M A C R O S
59 *----------------------------------------------------------------------------------------
60 */
61
62/*----------------------------------------------------------------------------------------
63 * T Y P E D E F S A N D S T R U C T U R E S
64 *----------------------------------------------------------------------------------------
65 */
66
67
68/*---------------------------------------------------------------------------------------*/
69/**
70 * Family specific call to check if Low Power P-state is supported.
71 *
72 * @param[in] LowPwrPstateService Low Power P-state services.
73 * @param[in] PlatformConfig Contains the runtime modifiable feature input data.
74 * @param[in] Socket Zero-based socket number.
75 * @param[in] StdHeader Config Handle for library, services.
76 *
77 * @retval TRUE Low Power P-state is supported.
78 * @retval FALSE Low Power P-state is not supported.
79 *
80 */
81typedef BOOLEAN F_LOW_PWR_PSTATE_IS_SUPPORTED (
82 IN LOW_PWR_PSTATE_FAMILY_SERVICES *LowPwrPstateService,
83 IN PLATFORM_CONFIGURATION *PlatformConfig,
84 IN UINT32 Socket,
85 IN AMD_CONFIG_PARAMS *StdHeader
86 );
87
88/// Reference to a Method.
89typedef F_LOW_PWR_PSTATE_IS_SUPPORTED *PF_LOW_PWR_PSTATE_IS_SUPPORTED;
90
91/*---------------------------------------------------------------------------------------*/
92/**
93 * Family specific call to enable Low Power P-state
94 *
95 * @param[in] LowPwrPstateService Low Power P-state services.
96 * @param[in] PlatformConfig Contains the runtime modifiable feature input data.
97 * @param[in] EntryPoint Timepoint designator.
98 * @param[in] StdHeader Config Handle for library, services.
99 *
100 * @return Family specific error value.
101 *
102 */
103typedef AGESA_STATUS F_LOW_PWR_PSTATE_INIT (
104 IN LOW_PWR_PSTATE_FAMILY_SERVICES *LowPwrPstateService,
105 IN PLATFORM_CONFIGURATION *PlatformConfig,
106 IN UINT64 EntryPoint,
107 IN AMD_CONFIG_PARAMS *StdHeader
108 );
109
110/// Reference to a Method.
111typedef F_LOW_PWR_PSTATE_INIT *PF_LOW_PWR_PSTATE_INIT;
112
113/**
114 * Provide the interface to the Low Power P-state Family Specific Services.
115 *
116 * Use the methods or data in this struct to adapt the feature code to a specific cpu family or model (or stepping!).
117 * Each supported Family must provide an implementation for all methods in this interface, even if the
118 * implementation is a CommonReturn().
119 */
120struct _LOW_PWR_PSTATE_FAMILY_SERVICES {
121 UINT16 Revision; ///< Interface version
122 // Public Methods.
123 PF_LOW_PWR_PSTATE_IS_SUPPORTED IsLowPwrPstateSupported; ///< Method: Family specific call to check if Low Power P-state is supported.
124 PF_LOW_PWR_PSTATE_INIT EnableLowPwrPstate; ///< Method: Family specific call to enable Low Power P-state.
125};
126
127
128/*----------------------------------------------------------------------------------------
129 * F U N C T I O N S P R O T O T Y P E
130 *----------------------------------------------------------------------------------------
131 */
132
133#endif // _CPU_LOW_PWR_PSTATE_H_