aboutsummaryrefslogtreecommitdiff
path: root/src/vendorcode/amd/cimx/rd890/nbLib.h
blob: af10946b9a934c7bb10150eaac46c49ec6bd620c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
/**
 * @file
 *
 * CNB Library function
 *
 *
 *
 * @xrefitem bom "File Content Label" "Release Content"
 * @e project:      CIMx-NB
 * @e sub-project:
 * @e \$Revision:$   @e \$Date:$
 *
 */
/*****************************************************************************
 *
 * Copyright (C) 2012 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.
 *
 *
 ***************************************************************************/

#ifndef _NBLIB_H_
#define _NBLIB_H_

#pragma pack(push, 1)

/// NB_MCU_MODE
typedef enum {
  AssertReset,                              ///< Assert reset
  DeAssertReset                             ///< Deassert reset
} NB_MCU_MODE;

/// SMU Firmware revision
typedef struct {
  UINT16              MajorRev;             ///< Major revision
  UINT16              MinorRev;             ///< Minor revision
} SMU_FIRMWARE_REV;

/// Firmware block
typedef struct {
  UINT16              Address;              ///< Block Address
  UINT16              Length;               ///< Block length in DWORD
  UINT32              *Data;                ///< Pointer to data array
} SMU_FIRMWARE_BLOCK;

/// Firmware header
typedef struct {
  SMU_FIRMWARE_REV    Revision;              ///< Revision info
  UINT16              NumberOfBlock;         ///< Number of blocks
  SMU_FIRMWARE_BLOCK  *BlockArray;           ///< Pointer to block definition array
} SMU_FIRMWARE_HEADER;


NB_INFO
LibNbGetRevisionInfo (
  IN      AMD_NB_CONFIG       *NbConfigPtr
  );

AGESA_STATUS
LibNbCallBack (
  IN      UINT32              CallBackId,
  IN  OUT UINTN               Data,
  IN  OUT AMD_NB_CONFIG       *NbConfigPtr
  );

VOID
LibNbPciWrite (
  IN      UINT32              Address,
  IN      ACCESS_WIDTH        Width,
  IN      VOID                *Value,
  IN      AMD_NB_CONFIG       *NbConfigPtr
  );

VOID
LibNbPciRead (
  IN       UINT32              Address,
  IN       ACCESS_WIDTH        Width,
     OUT   VOID                *Value,
  IN       AMD_NB_CONFIG       *NbConfigPtr
  );

VOID
LibNbPciRMW (
  IN      UINT32              Address,
  IN      ACCESS_WIDTH        Width,
  IN      UINT32              Mask,
  IN      UINT32              Data,
  IN      AMD_NB_CONFIG       *NbConfigPtr
  );

VOID
LibNbPciIndexRead (
  IN       UINT32              Address,
  IN       UINT32              Index,
  IN       ACCESS_WIDTH        Width,
     OUT   UINT32              *Value,
  IN       AMD_NB_CONFIG       *NbConfigPtr
  );

VOID
LibNbPciIndexWrite (
  IN      UINT32              Address,
  IN      UINT32              Index,
  IN      ACCESS_WIDTH        Width,
  IN      UINT32              *Value,
  IN      AMD_NB_CONFIG       *NbConfigPtr
  );

VOID
LibNbPciIndexRMW (
  IN      UINT32              Address,
  IN      UINT32              Index,
  IN      ACCESS_WIDTH        Width,
  IN      UINT32              Mask,
  IN      UINT32              Data,
  IN      AMD_NB_CONFIG       *NbConfigPtr
  );

VOID
LibNbIndirectTableInit (
  IN      UINT32              Address,
  IN      UINT32              Index,
  IN      INDIRECT_REG_ENTRY  *pTable,
  IN      UINTN               Length,
  IN      AMD_NB_CONFIG       *NbConfigPtr
  );

UINT8
LibNbFindPciCapability (
  IN      UINT32              Address,
  IN      UINT8               CapabilityId,
  IN      AMD_NB_CONFIG       *NbConfigPtr
  );

VOID
LibNbIoRMW (
  IN      UINT16              Address,
  IN      ACCESS_WIDTH                Width,
  IN      UINT32              Mask,
  IN      UINT32              Data,
  IN      AMD_NB_CONFIG       *NbConfigPtr
  );

VOID
LibNbCpuHTLinkPhyRead (
  IN        UINT8               Node,
  IN        UINT8               Link,
  IN        UINT16              Register,
     OUT    UINT32              *Value,
  IN        AMD_NB_CONFIG        *NbConfigPtr
 );

VOID
LibNbCpuHTLinkPhyWrite (
  IN      UINT8               Node,
  IN      UINT8               Link,
  IN      UINT16              Register,
  IN      UINT32              *Value,
  IN      AMD_NB_CONFIG       *NbConfigPtr
);

VOID
LibNbCpuHTLinkPhyRMW (
  IN      UINT8               Node,
  IN      UINT8               Link,
  IN      UINT16              Register,
  IN      UINT32              Mask,
  IN      UINT32              Data,
  IN      AMD_NB_CONFIG       *NbConfigPtr
);

VOID
LibNbEnableClkConfig (
  IN      AMD_NB_CONFIG       *pConfig
  );

VOID
LibNbDisableClkConfig (
  IN      AMD_NB_CONFIG       *pConfig
  );

BOOLEAN
LibNbIsDevicePresent (
  IN      PCI_ADDR            Device,
  IN      AMD_NB_CONFIG       *NbConfigPtr
  );

UINT32
LibNbBitReverse (
  IN      UINT32              Data,
  IN      UINT8               StartBit,
  IN      UINT8               StopBit
  );

UINT32
LibNbGetCpuFamily (
  VOID
  );

VOID
LibNbIoWrite (
  IN      UINT16              Address,
  IN      ACCESS_WIDTH        Width,
  IN      VOID                *Value,
  IN      AMD_NB_CONFIG       *NbConfigPtr
  );

VOID
LibNbIoRead (
  IN       UINT16             Address,
  IN       ACCESS_WIDTH       Width,
     OUT   VOID               *Value,
  IN       AMD_NB_CONFIG      *NbConfigPtr
  );

VOID
LibNbLoadMcuFirmwareBlock (
  IN      UINT16          Address,
  IN      UINT16          Size,
  IN      UINT32          *FirmwareBlockPtr,
  IN      AMD_NB_CONFIG   *NbConfigPtr
  );

UINT32
LibNbReadMcuRam (
  IN      UINT16          Address,
  IN      AMD_NB_CONFIG   *NbConfigPtr
  );

VOID
LibNbMcuControl (
  IN      NB_MCU_MODE     Operation,
  IN      AMD_NB_CONFIG   *NbConfigPtr
  );


AGESA_STATUS
LibSystemApiCall (
  IN       SYSTEM_API            SystemApi,
  IN OUT   AMD_NB_CONFIG_BLOCK   *ConfigPtr
  );

AGESA_STATUS
LibNbApiCall (
  IN       NB_API                NbApi,
  IN OUT   AMD_NB_CONFIG_BLOCK   *ConfigPtr
  );

VOID
LibNbMemRMW (
  IN      UINT64          Address,
  IN      ACCESS_WIDTH    Width,
  IN      UINT32          Mask,
  IN      UINT32          Data,
  IN      AMD_NB_CONFIG   *NbConfigPtr
  );

VOID
LibNbMemRead (
  IN      UINT64          Address,
  IN      ACCESS_WIDTH    Width,
  IN      VOID            *Value,
  IN      AMD_NB_CONFIG   *NbConfigPtr
  );

VOID
LibNbMemWrite (
  IN      UINT64          Address,
  IN      ACCESS_WIDTH    Width,
     OUT  VOID            *Value,
  IN      AMD_NB_CONFIG   *NbConfigPtr
  );

struct _PCI_SCAN_PROTOCOL;
typedef struct _PCI_SCAN_PROTOCOL PCI_SCAN_PROTOCOL;
typedef UINT32  SCAN_STATUS;

typedef SCAN_STATUS (*SCAN_ENTRY) (PCI_SCAN_PROTOCOL *This, PCI_ADDR  Device);

#define SCAN_FINISHED                   0x0
#define SCAN_STOP_DEVICE_ENUMERATION    0x1
#define SCAN_STOP_BUS_ENUMERATION       0x2


/// PCI topology scan protocol
struct _PCI_SCAN_PROTOCOL {
  SCAN_ENTRY    ScanBus;                ///< Pointer to function to scan device on PCI bus.
  SCAN_ENTRY    ScanDevice;             ///< Pointer to function to scan function on PCI device.
  SCAN_ENTRY    ScanFunction;           ///< Pointer to scan PCI function.
  AMD_NB_CONFIG *pConfig;               ///< NB configuration info.
};

SCAN_STATUS
LibNbScanPciBus (
  IN      PCI_SCAN_PROTOCOL   *This,
  IN      PCI_ADDR            Device
  );

SCAN_STATUS
LibNbScanPciDevice (
  IN      PCI_SCAN_PROTOCOL   *This,
  IN      PCI_ADDR            Device
  );

SCAN_STATUS
LibNbScanPciBridgeBuses (
  IN      PCI_SCAN_PROTOCOL   *This,
  IN      PCI_ADDR            Bridge
  );

VOID
LibNbSetDefaultIndexes (
  IN      AMD_NB_CONFIG   *NbConfigPtr
  );

UINT16
LibNbFindPcieExtendedCapability (
  IN      UINT32        Address,
  IN      UINT16        ExtendedCapabilityId,
  IN      AMD_NB_CONFIG *NbConfigPtr
  );

BOOLEAN
LibNbIsIommuEnabled (
  IN      AMD_NB_CONFIG     *NbConfigPtr
  );

#pragma pack(pop)

#endif