AGESA F15: AMD family15 AGESA code
[coreboot.git] / src / vendorcode / amd / agesa / f15 / Proc / HT / Fam15 / htNbUtilitiesFam15.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 Fam15GetNumCoresOnNode (
51   IN       UINT8       Node,
52   IN       NORTHBRIDGE *Nb
53   );
54
55 /**
56  * Get the next link for iterating over the links on a node in the correct order.
57  *
58  */
59 LINK_ITERATOR_STATUS
60 Fam15GetNextLink (
61   IN       UINT8       Node,
62   IN OUT   UINT8       *Link,
63   IN       NORTHBRIDGE *Nb
64   );
65
66 /**
67  * Get Info about Module Type of this northbridge
68  *
69  */
70 VOID
71 Fam15GetModuleInfo (
72   IN       UINT8       Node,
73      OUT   UINT8       *ModuleType,
74      OUT   UINT8       *Module,
75   IN       NORTHBRIDGE *Nb
76   );
77
78 /**
79  * Implement the hardware method of doing Socket Naming, by accessing this northbridge's Socket Id register.
80  *
81  */
82 UINT8
83 Fam15GetSocket (
84   IN       UINT8       Node,
85   IN       UINT8       TempNode,
86   IN       NORTHBRIDGE *Nb
87   );
88
89 /**
90  * Implement the hardware method of doing Socket Naming, by accessing this northbridge's Socket Id register.
91  *
92  */
93 UINT8
94 Fam15StrappedGetSocket (
95   IN       UINT8       Node,
96   IN       UINT8       TempNode,
97   IN       NORTHBRIDGE *Nb
98   );
99
100 /**
101  * Get the enable compute unit status for this node.
102  */
103 UINT8
104 Fam15GetEnabledComputeUnits (
105   IN       UINT8       Node,
106   IN       NORTHBRIDGE *Nb
107   );
108
109 /**
110  * Get the dual core compute unit status for this node.
111  */
112 UINT8
113 Fam15GetDualcoreComputeUnits (
114   IN       UINT8       Node,
115   IN       NORTHBRIDGE *Nb
116   );
117
118 /**
119  * Post info to AP cores via a mailbox.
120  *
121  */
122 VOID
123 Fam15PostMailbox (
124   IN       UINT8 Node,
125   IN       AP_MAILBOXES ApMailboxes,
126   IN       NORTHBRIDGE *Nb
127   );
128
129 /**
130  * Retrieve info from a node's mailbox.
131  *
132  */
133 AP_MAIL_INFO
134 Fam15RetrieveMailbox (
135   IN       UINT8 Node,
136   IN       NORTHBRIDGE *Nb
137   );