AGESA F15: AMD family15 AGESA code
[coreboot.git] / src / vendorcode / amd / agesa / f15 / Proc / Mem / Main / mmMemClr.c
1 /* $NoKeywords:$ */
2 /**
3  * @file
4  *
5  * mmMemclr.c
6  *
7  * Main Memory Feature implementation file for Memory Clear.
8  *
9  * @xrefitem bom "File Content Label" "Release Content"
10  * @e project: AGESA
11  * @e sub-project: (Mem/Main)
12  * @e \$Revision: 53955 $ @e \$Date: 2011-05-29 20:54:54 -0600 (Sun, 29 May 2011) $
13  *
14  **/
15 /*****************************************************************************
16 *
17 * Copyright (C) 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.
41 *
42 * ***************************************************************************
43 *
44 */
45
46 /*
47  *----------------------------------------------------------------------------
48  *                                MODULES USED
49  *
50  *----------------------------------------------------------------------------
51  */
52
53
54 #include "AGESA.h"
55 #include "OptionMemory.h"
56 #include "mm.h"
57 #include "mn.h"
58 #include "Ids.h"
59 #include "mfmemclr.h"
60 #include "Filecode.h"
61 CODE_GROUP (G2_PEI)
62 RDATA_GROUP (G2_PEI)
63
64 #define FILECODE PROC_MEM_MAIN_MMMEMCLR_FILECODE
65 /*----------------------------------------------------------------------------
66  *                        PROTOTYPES OF LOCAL FUNCTIONS
67  *
68  *----------------------------------------------------------------------------
69  */
70 BOOLEAN
71 MemMMctMemClr (
72   IN OUT   MEM_MAIN_DATA_BLOCK *MemMainPtr
73   );
74
75 /*-----------------------------------------------------------------------------
76 *                                EXPORTED FUNCTIONS
77 *
78 *-----------------------------------------------------------------------------
79 */
80
81
82 /* -----------------------------------------------------------------------------*/
83 /**
84  *
85  *
86  *   Initiates/synchronizes memory clear on all nodes with Dram on it.
87  *
88  *     @param[in,out]   *MemMainPtr   - Pointer to the MEM_MAIN_DATA_BLOCK
89  *
90  *     @return          TRUE -  No fatal error occurs.
91  *     @return          FALSE - Fatal error occurs.
92  */
93 BOOLEAN
94 MemMMctMemClr (
95   IN OUT   MEM_MAIN_DATA_BLOCK *MemMainPtr
96   )
97 {
98   UINT8   Node;
99   UINT8   NodeCnt;
100   BOOLEAN RetVal;
101   MEM_NB_BLOCK  *NBPtr;
102
103   NBPtr = MemMainPtr->NBPtr;
104   NodeCnt = MemMainPtr->DieCount;
105   RetVal = TRUE;
106
107   IDS_OPTION_HOOK (IDS_BEFORE_MEMCLR, NULL, &NBPtr->MemPtr->StdHeader);
108
109   for (Node = 0; Node < NodeCnt; Node++) {
110     MemFMctMemClr_Init (&NBPtr[Node]);
111   }
112
113   for (Node = 0; Node < NodeCnt; Node++) {
114     MemFMctMemClr_Sync (&NBPtr[Node]);
115     RetVal &= (BOOLEAN) (NBPtr[Node].MCTPtr->ErrCode < AGESA_FATAL);
116   }
117
118   return RetVal;
119 }