src/vendorcode/amd/agesa/f15/Proc/HT/NbCommon/htNbUtilities.h

   1 /* $NoKeywords:$ */
   2 /**
   3  * @file
   4  *
   5  * Northbridge utility routines.
   6  *
   7  * @xrefitem bom "File Content Label" "Release Content"
   8  * @e project:      AGESA
   9  * @e sub-project:  HyperTransport
  10  * @e \$Revision: 44324 $   @e \$Date: 2010-12-22 02:16:51 -0700 (Wed, 22 Dec 2010) $
  11  *
  12  */
  13 /*
  14 *****************************************************************************
  15 *
  16 * Copyright (C) 2012 Advanced Micro Devices, Inc.
  17 * All rights reserved.
  18 *
  19 * Redistribution and use in source and binary forms, with or without
  20 * modification, are permitted provided that the following conditions are met:
  21 *     * Redistributions of source code must retain the above copyright
  22 *       notice, this list of conditions and the following disclaimer.
  23 *     * Redistributions in binary form must reproduce the above copyright
  24 *       notice, this list of conditions and the following disclaimer in the
  25 *       documentation and/or other materials provided with the distribution.
  26 *     * Neither the name of Advanced Micro Devices, Inc. nor the names of
  27 *       its contributors may be used to endorse or promote products derived
  28 *       from this software without specific prior written permission.
  29 *
  30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  31 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  32 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  33 * DISCLAIMED. IN NO EVENT SHALL ADVANCED MICRO DEVICES, INC. BE LIABLE FOR ANY
  34 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  35 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  36 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  37 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  38 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  39 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40 *
  41 * ***************************************************************************
  42 *
  43 */
  44
  45 /**
  46  * Return the HT Host capability base PCI config address for a Link.
  47  *
  48  */
  49 PCI_ADDR
  50 MakeLinkBase (
  51   IN       UINT8       Node,
  52   IN       UINT8       Link,
  53   IN       NORTHBRIDGE *Nb
  54   );
  55
  56 /**
  57  * Return the LinkFailed status AFTER an attempt is made to clear the bit.
  58  *
  59  */
  60 BOOLEAN
  61 ReadTrueLinkFailStatus (
  62   IN       UINT8       Node,
  63   IN       UINT8       Link,
  64   IN       STATE_DATA  *State,
  65   IN       NORTHBRIDGE *Nb
  66   );
  67
  68 /**
  69  * Write the total number of cores and Nodes to the Node
  70  *
  71  */
  72 VOID
  73 SetTotalNodesAndCores (
  74   IN       UINT8       Node,
  75   IN       UINT8       TotalNodes,
  76   IN       UINT8       TotalCores,
  77   IN       NORTHBRIDGE *Nb
  78   );
  79
  80 /**
  81  * Get the Count (1 based) of Nodes in the system.
  82  *
  83  */
  84 UINT8
  85 GetNodeCount (
  86   IN       NORTHBRIDGE *Nb
  87   );
  88
  89 /**
  90  * Limit coherent config accesses to cpus as indicated by Nodecnt.
  91  *
  92  */
  93 VOID
  94 LimitNodes (
  95   IN       UINT8       Node,
  96   IN       NORTHBRIDGE *Nb
  97   );
  98
  99 /**
 100  * Get the Package Link number, given the node and real link number.
 101  *
 102  */
 103 UINT8
 104 GetPackageLink (
 105   IN       UINT8       Node,
 106   IN       UINT8       Link,
 107   IN       NORTHBRIDGE *Nb
 108   );