src/vendorcode/amd/agesa/f15/Proc/Mem/Feat/MEMCLR/mfmemclr.c

   1 /* $NoKeywords:$ */
   2 /**
   3  * @file
   4  *
   5  * mfmemclr.c
   6  *
   7  * Feature function for memory clear operation
   8  *
   9  * @xrefitem bom "File Content Label" "Release Content"
  10  * @e project: AGESA
  11  * @e sub-project: (Mem/Feat/Memclr)
  12  * @e \$Revision: 44324 $ @e \$Date: 2010-12-22 02:16:51 -0700 (Wed, 22 Dec 2010) $
  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
  49 #include "AGESA.h"
  50 #include "mm.h"
  51 #include "mn.h"
  52 #include "mfmemclr.h"
  53 #include "Ids.h"
  54 #include "merrhdl.h"
  55 #include "Filecode.h"
  56 CODE_GROUP (G2_PEI)
  57 RDATA_GROUP (G2_PEI)
  58
  59 #define FILECODE PROC_MEM_FEAT_MEMCLR_MFMEMCLR_FILECODE
  60 /*----------------------------------------------------------------------------
  61  *                          DEFINITIONS AND MACROS
  62  *
  63  *----------------------------------------------------------------------------
  64  */
  65
  66 /*----------------------------------------------------------------------------
  67  *                           TYPEDEFS AND STRUCTURES
  68  *
  69  *----------------------------------------------------------------------------
  70  */
  71
  72 /*----------------------------------------------------------------------------
  73  *                        PROTOTYPES OF LOCAL FUNCTIONS
  74  *
  75  *----------------------------------------------------------------------------
  76  */
  77
  78 /*
  79  *-----------------------------------------------------------------------------
  80  *                                EXPORTED FUNCTIONS
  81  *
  82  *-----------------------------------------------------------------------------
  83  */
  84
  85 /* -----------------------------------------------------------------------------*/
  86 /**
  87  *
  88  *
  89  *   Initiates memory clear operation on one node with Dram on it.
  90  *
  91  *     @param[in,out]   *NBPtr   - Pointer to the MEM_NB_BLOCK
  92  *
  93  */
  94
  95 BOOLEAN
  96 MemFMctMemClr_Init (
  97   IN OUT   MEM_NB_BLOCK *NBPtr
  98   )
  99 {
 100   AGESA_TESTPOINT (TpProcMemMemClr, &NBPtr->MemPtr->StdHeader);
 101   if (NBPtr->RefPtr->EnableMemClr == TRUE) {
 102     if (NBPtr->MCTPtr->NodeMemSize != 0) {
 103       if (!NBPtr->MemCleared) {
 104         NBPtr->PollBitField (NBPtr, BFMemClrBusy, 0, SPECIAL_PCI_ACCESS_TIMEOUT, FALSE);
 105         if (NBPtr->GetBitField (NBPtr, BFDramEnabled) == 1) {
 106           NBPtr->FamilySpecificHook[BeforeMemClr] (NBPtr, NBPtr);
 107           NBPtr->SetBitField (NBPtr, BFDramBaseAddr, 0);
 108           NBPtr->SetBitField (NBPtr, BFMemClrInit, 1);
 109         }
 110       }
 111     }
 112   }
 113   return TRUE;
 114 }
 115
 116 /* -----------------------------------------------------------------------------*/
 117 /**
 118  *
 119  *
 120  *   Ensures memory clear operation has completed on one node with Dram on it.
 121  *
 122  *     @param[in,out]   *NBPtr   - Pointer to the MEM_NB_BLOCK
 123  *
 124  */
 125
 126 BOOLEAN
 127 MemFMctMemClr_Sync (
 128   IN OUT   MEM_NB_BLOCK *NBPtr
 129   )
 130 {
 131   UINT32 MicroSecondToWait;
 132
 133   MicroSecondToWait = 0;
 134   if (NBPtr->RefPtr->EnableMemClr == TRUE) {
 135     if (NBPtr->MCTPtr->NodeMemSize != 0) {
 136       // Calculate Timeout value:
 137       // Timeout (in microsecond) = Memory Size * 1.5 ns / 8 Byte * 4 (Margin) * 1000 (change millisecond to us)
 138       // NodeMemSize is system address right shifted by 16, so shift it 4 bits to right to convert it to MB.
 139       // 1.5 / 8 * 4 * 1000 = 750
 140       MicroSecondToWait = (NBPtr->MCTPtr->NodeMemSize >> 4) * 750;
 141
 142       if (!NBPtr->MemCleared) {
 143         NBPtr->PollBitField (NBPtr, BFMemClrBusy, 0, MicroSecondToWait, FALSE);
 144         NBPtr->PollBitField (NBPtr, BFMemCleared, 1, MicroSecondToWait, FALSE);
 145         NBPtr->SetBitField (NBPtr, BFDramBaseAddr, NBPtr->MCTPtr->NodeSysBase >> (27 - 16));
 146         NBPtr->MemCleared = TRUE;
 147       }
 148     }
 149   }
 150   return TRUE;
 151 }
 152