src/vendorcode/amd/agesa/f15/Proc/HT/Fam10/htNbUtilitiesFam10.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 number of cores (1 based count) on Node.
  47  *
  48  */
  49 UINT8
  50 Fam10GetNumCoresOnNode (
  51   IN       UINT8       Node,
  52   IN       NORTHBRIDGE *Nb
  53   );
  54
  55 /**
  56  * Return the number of cores (1 based count) on Node.
  57  *
  58  */
  59 UINT8
  60 Fam10RevDGetNumCoresOnNode (
  61   IN       UINT8       Node,
  62   IN       NORTHBRIDGE *Nb
  63   );
  64
  65 /**
  66  * Get the next link for iterating over the links on a node in the correct order.
  67  *
  68  */
  69 LINK_ITERATOR_STATUS
  70 Fam10GetNextLink (
  71   IN       UINT8       Node,
  72   IN OUT   UINT8       *Link,
  73   IN       NORTHBRIDGE *Nb
  74   );
  75
  76 /**
  77  * Get Info about Module Type of this northbridge
  78  *
  79  */
  80 VOID
  81 Fam10GetModuleInfo (
  82   IN       UINT8       Node,
  83      OUT   UINT8       *ModuleType,
  84      OUT   UINT8       *Module,
  85   IN       NORTHBRIDGE *Nb
  86   );
  87
  88 /**
  89  * Implement the hardware method of doing Socket Naming, by accessing this northbridge's Socket Id register.
  90  *
  91  */
  92 UINT8
  93 Fam10GetSocket (
  94   IN       UINT8       Node,
  95   IN       UINT8       TempNode,
  96   IN       NORTHBRIDGE *Nb
  97   );
  98
  99 /**
 100  * Implement the hardware method of doing Socket Naming, by accessing this northbridge's Socket Id register.
 101  *
 102  */
 103 UINT8
 104 Fam10RevDGetSocket (
 105   IN       UINT8       Node,
 106   IN       UINT8       TempNode,
 107   IN       NORTHBRIDGE *Nb
 108   );
 109
 110 /**
 111  * Post info to AP cores via a mailbox.
 112  *
 113  */
 114 VOID
 115 Fam10PostMailbox (
 116   IN       UINT8 Node,
 117   IN       AP_MAILBOXES ApMailboxes,
 118   IN       NORTHBRIDGE *Nb
 119   );
 120
 121 /**
 122  * Retrieve info from a node's mailbox.
 123  *
 124  */
 125 AP_MAIL_INFO
 126 Fam10RetrieveMailbox (
 127   IN       UINT8 Node,
 128   IN       NORTHBRIDGE *Nb
 129   );