src/vendorcode/amd/agesa/f15/Proc/Mem/NB/PH/mnPh.h

   1 /* $NoKeywords:$ */
   2 /**
   3  * @file
   4  *
   5  * mnPh.h
   6  *
   7  * Northbridge Ph for Pharaoh Hound
   8  *
   9  * @xrefitem bom "File Content Label" "Release Content"
  10  * @e project: AGESA
  11  * @e sub-project: (Mem)
  12  * @e \$Revision: 56033 $ @e \$Date: 2011-07-06 01:12:20 -0600 (Wed, 06 Jul 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 #ifndef _MNPH_H_
  47 #define _MNPH_H_
  48
  49 /*----------------------------------------------------------------------------
  50  *   Mixed (DEFINITIONS AND MACROS / TYPEDEFS, STRUCTURES, ENUMS)
  51  *
  52  *----------------------------------------------------------------------------
  53  */
  54 /*-----------------------------------------------------------------------------
  55  *                         DEFINITIONS AND MACROS
  56  *
  57  *-----------------------------------------------------------------------------
  58  */
  59
  60 /*----------------------------------------------------------------------------
  61  *                         TYPEDEFS, STRUCTURES, ENUMS
  62  *
  63  *----------------------------------------------------------------------------
  64  */
  65
  66 /*----------------------------------------------------------------------------
  67  *                           FUNCTIONS PROTOTYPE
  68  *
  69  *----------------------------------------------------------------------------
  70  */
  71
  72 BOOLEAN
  73 MemNIsIdSupportedPh (
  74   IN OUT   MEM_NB_BLOCK *NBPtr,
  75   IN       CPU_LOGICAL_ID *LogicalIdPtr
  76   );
  77
  78 BOOLEAN
  79 MemConstructNBBlockPh (
  80   IN OUT   MEM_NB_BLOCK *NBPtr,
  81   IN OUT   MEM_DATA_STRUCT *MemPtr,
  82   IN       MEM_FEAT_BLOCK_NB *FeatPtr,
  83   IN       MEM_SHARED_DATA *SharedPtr,
  84   IN       UINT8 NodeID
  85   );
  86
  87 VOID
  88 MemNInitNBDataPh (
  89   IN OUT   MEM_NB_BLOCK *NBPtr
  90   );
  91
  92 BOOLEAN
  93 MemNPlatformSpecificFormFactorInitPh (
  94   IN OUT   MEM_NB_BLOCK *NBPtr
  95   );
  96
  97 VOID
  98 MemNInitDefaultsPh (
  99   IN OUT   MEM_DATA_STRUCT *MemPtr
 100   );
 101
 102 VOID
 103 MemNWritePatternPh (
 104   IN OUT   MEM_NB_BLOCK *NBPtr,
 105   IN       UINT32 Address,
 106   IN       UINT8 Pattern[],
 107   IN       UINT16 ClCount
 108   );
 109
 110 VOID
 111 MemNReadPatternPh (
 112   IN OUT   MEM_NB_BLOCK *NBPtr,
 113   IN       UINT8 Buffer[],
 114   IN       UINT32 Address,
 115   IN       UINT16 ClCount
 116   );
 117
 118 BOOLEAN
 119 memNEnableTrainSequencePh (
 120   IN OUT   MEM_NB_BLOCK *NBPtr
 121   );
 122
 123 BOOLEAN
 124 MemNFinalizeMctPh (
 125   IN OUT   MEM_NB_BLOCK *NBPtr
 126   );
 127 #endif  /* _MNPH_H_ */
 128
 129