blob: b85398ade4b3b95a469290c09d88c33ea647af18 [file] [log] [blame]
zbao7d94cf92012-07-02 14:19:14 +08001/* $NoKeywords:$ */
2/**
3 * @file
4 *
5 * mfParallelTraining.h
6 *
7 * Header file for the parallel training feature
8 *
9 * @xrefitem bom "File Content Label" "Release Content"
10 * @e project: AGESA
11 * @e sub-project: (Mem)
12 * @e \$Revision: 63425 $ @e \$Date: 2011-12-22 11:24:10 -0600 (Thu, 22 Dec 2011) $
13 *
14 **/
15/*****************************************************************************
16 *
Siyuan Wang641f00c2013-06-08 11:50:55 +080017 * Copyright (c) 2008 - 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.
zbao7d94cf92012-07-02 14:19:14 +080041 * ***************************************************************************
42 *
43 */
44
45
46#ifndef _MFPARALLELTRAINING_H_
47#define _MFPARALLELTRAINING_H_
48
49/*----------------------------------------------------------------------------
50 * Mixed (DEFINITIONS AND MACROS / TYPEDEFS, STRUCTURES, ENUMS)
51 *
52 *----------------------------------------------------------------------------
53 */
54
55/*-----------------------------------------------------------------------------
56 * DEFINITIONS AND MACROS
57 *
58 *-----------------------------------------------------------------------------
59 */
60
61/*----------------------------------------------------------------------------
62 * TYPEDEFS, STRUCTURES, ENUMS
63 *
64 *----------------------------------------------------------------------------
65 */
66
67typedef BOOLEAN (*REMOTE_NBBLOCK_CONSTRUCTOR) (
68 IN OUT MEM_NB_BLOCK *NBPtr,
69 IN DIE_STRUCT *MCTPtr,
70 IN MEM_FEAT_BLOCK_NB *FeatPtr
71);
72
73///< This structure defines the environment on the AP for parallel training
74typedef struct _REMOTE_TRAINING_ENV {
75 IN OUT AMD_CONFIG_PARAMS StdHeader; ///< Config pointer of BSP
76 IN OUT AGESA_STATUS (*GetPlatformCfg[MAX_PLATFORM_TYPES]) (struct _MEM_DATA_STRUCT *MemData, UINT8 SocketID, CH_DEF_STRUCT *CurrentChannel); ///< look-up platform info
77 IN OUT BOOLEAN (*ErrorHandling)(struct _DIE_STRUCT *MCTPtr, UINT8 DCT, UINT16 ChipSelMask, AMD_CONFIG_PARAMS *StdHeader); ///< Error Handling
78 IN REMOTE_NBBLOCK_CONSTRUCTOR NBBlockCtor; ///< NB Block constructor
79 IN MEM_FEAT_BLOCK_NB *FeatPtr; ///< Feature block pointer
80 IN UINT8 *TableBasedAlterations; ///< Point to an array of data bytes describing desired modifications to register settings
81 IN PSO_TABLE *PlatformMemoryConfiguration; ///< Point to platform config table
82 IN UINT32 HoleBase; ///< Used for Memtyping
83 IN UINT32 UmaSize; ///< Used for Memtyping
84 IN UINT16 BottomIo; ///< Used for Memtyping
85 IN UINT32 SysLimit; ///< Used for Memtyping
86 IN UINT8 BspSocket; ///< Socket number of BSP
87 IN UINT8 BspCore; ///< Core number of BSP
88 IN DIE_STRUCT DieStruct; ///< Remote copy of Die Struct
89} REMOTE_TRAINING_ENV;
90
91///< This structure defines Die information
92typedef struct _DIE_INFO {
93 IN OUT UINT8 Socket; ///< Socket number
94 IN OUT UINT8 Core; ///< Core number
95 IN OUT BOOLEAN Training; ///< Training Flag, 1 = Training has been started on this core
96} DIE_INFO;
97
98
99/*----------------------------------------------------------------------------
100 * FUNCTIONS PROTOTYPE
101 *
102 *----------------------------------------------------------------------------
103 */
104
105BOOLEAN
106MemFParallelTraining (
107 IN OUT REMOTE_TRAINING_ENV *EnvPtr,
108 IN OUT AMD_CONFIG_PARAMS *StdHeader
109 );
110
111#endif /* _MFPARALLELTRAINING_H_ */
112
113