text: /* $NoKeywords:$ */
  /**
   * @file
   *
   * mpodtpat.c
   *
   * A sub-engine which extracts ODT pattern value.
   *
   * @xrefitem bom "File Content Label" "Release Content"
   * @e project: AGESA
   * @e sub-project: (Mem/Ps)
   * @e \$Revision: 44324 $ @e \$Date: 2010-12-22 17:16:51 +0800 (Wed, 22 Dec 2010) $
   *
   **/
  /*****************************************************************************
  *
  * Copyright (c) 2011, Advanced Micro Devices, Inc.
   * All rights reserved.
   *
   * Redistribution and use in source and binary forms, with or without
   * modification, are permitted provided that the following conditions are met:
   *     * Redistributions of source code must retain the above copyright
   *       notice, this list of conditions and the following disclaimer.
   *     * Redistributions in binary form must reproduce the above copyright
   *       notice, this list of conditions and the following disclaimer in the
   *       documentation and/or other materials provided with the distribution.
   *     * Neither the name of Advanced Micro Devices, Inc. nor the names of
   *       its contributors may be used to endorse or promote products derived
   *       from this software without specific prior written permission.
   *
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
   * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
   * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED. IN NO EVENT SHALL ADVANCED MICRO DEVICES, INC. BE LIABLE FOR ANY
   * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
   * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  * ***************************************************************************
  *
  */
  /*
   *----------------------------------------------------------------------------
   *                                MODULES USED
   *
   *----------------------------------------------------------------------------
   */
  
  
  
  #include "AGESA.h"
  #include "AdvancedApi.h"
  #include "amdlib.h"
  #include "Ids.h"
  #include "cpuFamRegisters.h"
  #include "cpuRegisters.h"
  #include "OptionMemory.h"
  #include "PlatformMemoryConfiguration.h"
  #include "mu.h"
  #include "ma.h"
  #include "mp.h"
  #include "Filecode.h"
  CODE_GROUP (G2_PEI)
  RDATA_GROUP (G2_PEI)
  #define FILECODE PROC_MEM_PS_MPODTPAT_FILECODE
  
  
  /*----------------------------------------------------------------------------
   *                          DEFINITIONS AND MACROS
   *
   *----------------------------------------------------------------------------
   */
  
  /*----------------------------------------------------------------------------
   *                           TYPEDEFS AND STRUCTURES
   *
   *----------------------------------------------------------------------------
   */
  /*----------------------------------------------------------------------------
   *                        PROTOTYPES OF LOCAL FUNCTIONS
   *
   *----------------------------------------------------------------------------
   */
  BOOLEAN
  MemPGetODTPattern (
    IN OUT   MEM_NB_BLOCK *NBPtr,
    IN       MEM_PSC_TABLE_BLOCK *EntryOfTables
    );
  
  /*----------------------------------------------------------------------------
   *                            EXPORTED FUNCTIONS
   *
   *----------------------------------------------------------------------------
   */
  /* -----------------------------------------------------------------------------*/
  /**
   *
   *    A sub-function which extracts ODT Pattern value from a input table and stores extracted
   *    value to a specific address.
   *
   *     @param[in,out]   *NBPtr   - Pointer to the MEM_NB_BLOCK
   *     @param[in]       *EntryOfTables     - Pointer to MEM_PSC_TABLE_BLOCK
   *
   *     @return          TRUE - Table values can be extracted per dimm population and ranks type.
   *     @return          FALSE - Table values cannot be extracted per dimm population and ranks type.
   *
   */
  BOOLEAN
  MemPGetODTPattern (
    IN OUT   MEM_NB_BLOCK *NBPtr,
    IN       MEM_PSC_TABLE_BLOCK *EntryOfTables
    )
  {
    UINT8 i;
    UINT16 RankTypeInTable;
    UINT16 RankTypeOfPopulatedDimm;
    UINT8 MaxDimmPerCh;
    UINT8 NOD;
    UINT8 TableSize;
    DIMM_TYPE DimmType;
    CPU_LOGICAL_ID LogicalCpuid;
    UINT8 PackageType;
    PSCFG_3D_ODTPAT_ENTRY *TblPtr;
    CH_DEF_STRUCT *CurrentChannel;
  
    CurrentChannel = NBPtr->ChannelPtr;
  
    TblPtr = NULL;
    TableSize = 0;
    PackageType = 0;
    LogicalCpuid.Family = (UINT64) AMD_FAMILY_UNKNOWN;
    MaxDimmPerCh = GetMaxDimmsPerChannel (NBPtr->RefPtr->PlatformMemoryConfiguration, NBPtr->MCTPtr->SocketId, CurrentChannel->ChannelID);
    NOD = (UINT8) 1 << (MaxDimmPerCh - 1);
  
    if (CurrentChannel->RegDimmPresent != 0) {
      DimmType = RDIMM_TYPE;
    } else if (CurrentChannel->SODimmPresent != 0) {
      DimmType = SODIMM_TYPE;
    } else if (CurrentChannel->LrDimmPresent != 0) {
      DimmType = LRDIMM_TYPE;
    } else {
      DimmType = UDIMM_TYPE;
    }
  
    i = 0;
    // Obtain table pointer, table size, Logical Cpuid and PSC type according to Dimm, NB and package type.
    while (EntryOfTables->TblEntryOfODTPattern[i] != NULL) {
      if (((EntryOfTables->TblEntryOfODTPattern[i])->Header.DimmType & DimmType) != 0) {
        if (((EntryOfTables->TblEntryOfODTPattern[i])->Header.NumOfDimm & NOD) != 0) {
          //
          // Determine if this is the expected NB Type
          //
          LogicalCpuid = (EntryOfTables->TblEntryOfODTPattern[i])->Header.LogicalCpuid;
          PackageType = (EntryOfTables->TblEntryOfODTPattern[i])->Header.PackageType;
          if (MemPIsIdSupported (NBPtr, LogicalCpuid, PackageType)) {
            TblPtr = (PSCFG_3D_ODTPAT_ENTRY *) ((EntryOfTables->TblEntryOfODTPattern[i])->TBLPtr);
            TableSize = (EntryOfTables->TblEntryOfODTPattern[i])->TableSize;
            break;
          }
        }
      }
      i++;
    }
  
    // Check whether no table entry is found.
    if (EntryOfTables->TblEntryOfODTPattern[i] == NULL) {
      IDS_HDT_CONSOLE (MEM_FLOW, "\nNo ODT table\n");
      return FALSE;
    }
  
    RankTypeOfPopulatedDimm = MemPGetPsRankType (CurrentChannel);
  
    for (i = 0; i < TableSize; i++) {
      MemPConstructRankTypeMap ((UINT16) TblPtr->Dimm0, (UINT16) TblPtr->Dimm1, (UINT16) TblPtr->Dimm2, &RankTypeInTable);
      if ((RankTypeInTable & RankTypeOfPopulatedDimm) == RankTypeOfPopulatedDimm) {
        CurrentChannel->PhyRODTCSHigh = TblPtr->RdODTCSHigh;
        CurrentChannel->PhyRODTCSLow = TblPtr->RdODTCSLow;
        CurrentChannel->PhyWODTCSHigh = TblPtr->WrODTCSHigh;
        CurrentChannel->PhyWODTCSLow = TblPtr->WrODTCSLow;
  
        //WL ODT
        CurrentChannel->PhyWLODT[0] = (UINT8) (CurrentChannel->PhyWODTCSLow & 0x0F);
        CurrentChannel->PhyWLODT[1] = (UINT8) ((CurrentChannel->PhyWODTCSLow  >> 16) & 0x0F);
        CurrentChannel->PhyWLODT[2] = (UINT8) (CurrentChannel->PhyWODTCSHigh & 0x0F);
        CurrentChannel->PhyWLODT[3] = (UINT8) ((CurrentChannel->PhyWODTCSHigh >> 16) & 0x0F);
  
        return TRUE;
      }
      TblPtr++;
    }
    IDS_HDT_CONSOLE (MEM_FLOW, "\nNo ODT entries\n");
    return FALSE;
  }