Gitiles
Code Review Sign In
review.coreboot.org / coreboot / dbdf170dcdf9edbc860766606e53c6d647d89d38 / . / src / vendorcode / amd / agesa / f14 / Proc / CPU / Feature / cpuC6State.h
blob: 5f406ef6e3579eb7db3ff5e617d8be94a0f4aca7 [file] [log] [blame]
Frank Vibrans2b4c8312011-02-14 18:30:54 +0000[diff] [blame]1/* $NoKeywords:$ */
2/**
3 * @file
4 *
5 * AMD AGESA CPU C6 Functions declarations.
6 *
7 * Contains code that declares the AGESA CPU C6 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_C6_STATE_H_
48#define _CPU_C6_STATE_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 (C6_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 * Family specific call to check if C6 is supported.
70 *
71 * @param[in] C6Services C6 C-state services.
72 * @param[in] Socket Zero-based socket number.
73 * @param[in] StdHeader Config Handle for library, services.
74 *
75 * @retval TRUE C6 is supported.
76 * @retval FALSE C6 is not supported.
77 *
78 */
79typedef BOOLEAN F_C6_IS_SUPPORTED (
80 IN C6_FAMILY_SERVICES *C6Services,
81 IN UINT32 Socket,
82 IN AMD_CONFIG_PARAMS *StdHeader
83 );
84
85/// Reference to a Method.
86typedef F_C6_IS_SUPPORTED *PF_C6_IS_SUPPORTED;
87
88/*---------------------------------------------------------------------------------------*/
89/**
90 * Family specific call to enable C6.
91 *
92 * @param[in] C6Services C6 services.
93 * @param[in] EntryPoint Timepoint designator.
94 * @param[in] PlatformConfig Contains the runtime modifiable feature input data.
95 * @param[in] StdHeader Config Handle for library, services.
96 *
97 * @return Family specific error value.
98 *
99 */
100typedef AGESA_STATUS F_C6_INIT (
101 IN C6_FAMILY_SERVICES *C6Services,
102 IN UINT64 EntryPoint,
103 IN PLATFORM_CONFIGURATION *PlatformConfig,
104 IN AMD_CONFIG_PARAMS *StdHeader
105 );
106
107/// Reference to a Method.
108typedef F_C6_INIT *PF_C6_INIT;
109
110/*---------------------------------------------------------------------------------------*/
111/**
112 * Family specific call to reload microcode patch after memory is initialized.
113 *
114 * @param[in] StdHeader Config Handle for library, services.
115 *
116 */
117typedef VOID F_C6_RELOAD_MICORCODE_PATCH_AFTER_MEM_INIT (
118 IN AMD_CONFIG_PARAMS *StdHeader
119 );
120
121/// Reference to a Method.
122typedef F_C6_RELOAD_MICORCODE_PATCH_AFTER_MEM_INIT *PF_C6_RELOAD_MICORCODE_PATCH_AFTER_MEM_INIT;
123
124/**
125 * Provide the interface to the C6 Family Specific Services.
126 *
127 * Use the methods or data in this struct to adapt the feature code to a specific cpu family or model (or stepping!).
128 * Each supported Family must provide an implementation for all methods in this interface, even if the
129 * implementation is a CommonReturn().
130 */
131struct _C6_FAMILY_SERVICES {
132 UINT16 Revision; ///< Interface version
133 // Public Methods.
134 PF_C6_IS_SUPPORTED IsC6Supported; ///< Method: Family specific call to check if C6 is supported.
135 PF_C6_INIT InitializeC6; ///< Method: Family specific call to enable C6.
136 PF_C6_RELOAD_MICORCODE_PATCH_AFTER_MEM_INIT ReloadMicrocodePatchAfterMemInit; ///< Method: Family specific call to reload microcode patch after memory is initialized.
137};
138
139/*---------------------------------------------------------------------------------------*/
140/**
141 * Reload microcode patch after memory is initialized.
142 *
143 * @param[in] StdHeader Config Handle for library, services.
144 *
145 */
146VOID
147ReloadMicrocodePatchAfterMemInit (
148 IN AMD_CONFIG_PARAMS *StdHeader
149 );
150
151/*----------------------------------------------------------------------------------------
152 * F U N C T I O N S P R O T O T Y P E
153 *----------------------------------------------------------------------------------------
154 */
155
156#endif // _CPU_C6_STATE_H_