hc
2024-03-22 a0752693d998599af469473b8dc239ef973a012f
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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
/** @file
  This file contains PSF routines
 
Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
 
**/
#include <Base.h>
#include <Uefi/UefiBaseType.h>
#include <Library/IoLib.h>
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>
#include <PchAccess.h>
#include <Library/PchPcrLib.h>
#include <Library/PchPsfLib.h>
#include <Library/PchInfoLib.h>
 
GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mPchLpSerialIoPsfRegs[PCH_SERIALIO_MAX_CONTROLLERS] =
{
  R_PCH_LP_PCR_PSF3_T0_SHDW_I2C0_REG_BASE,
  R_PCH_LP_PCR_PSF3_T0_SHDW_I2C1_REG_BASE,
  R_PCH_LP_PCR_PSF3_T0_SHDW_I2C2_REG_BASE,
  R_PCH_LP_PCR_PSF3_T0_SHDW_I2C3_REG_BASE,
  R_PCH_LP_PCR_PSF3_T0_SHDW_I2C4_REG_BASE,
  R_PCH_LP_PCR_PSF3_T0_SHDW_I2C5_REG_BASE,
  R_PCH_LP_PCR_PSF3_T0_SHDW_SPI0_REG_BASE,
  R_PCH_LP_PCR_PSF3_T0_SHDW_SPI1_REG_BASE,
  R_PCH_LP_PCR_PSF3_T0_SHDW_UART0_REG_BASE,
  R_PCH_LP_PCR_PSF3_T0_SHDW_UART1_REG_BASE,
  R_PCH_LP_PCR_PSF3_T0_SHDW_UART2_REG_BASE
};
 
GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mPchHSerialIoPsfRegs[PCH_SERIALIO_MAX_CONTROLLERS] =
{
  R_PCH_H_PCR_PSF3_T0_SHDW_I2C0_REG_BASE,
  R_PCH_H_PCR_PSF3_T0_SHDW_I2C1_REG_BASE,
  R_PCH_H_PCR_PSF3_T0_SHDW_I2C2_REG_BASE,
  R_PCH_H_PCR_PSF3_T0_SHDW_I2C3_REG_BASE,
  0,
  0,
  R_PCH_H_PCR_PSF3_T0_SHDW_SPI0_REG_BASE,
  R_PCH_H_PCR_PSF3_T0_SHDW_SPI1_REG_BASE,
  R_PCH_H_PCR_PSF3_T0_SHDW_UART0_REG_BASE,
  R_PCH_H_PCR_PSF3_T0_SHDW_UART1_REG_BASE,
  R_PCH_H_PCR_PSF3_T0_SHDW_UART2_REG_BASE
};
 
/**
  This procedure will enable SerialIO device BAR1 at PSF level
 
  @param[in] SerialIoDevice  SERIAL IO device (I2C0-5, SPI0-1, UART0-2)
 
  @retval None
**/
VOID
PsfEnableSerialIoDeviceBar1 (
  IN PCH_SERIAL_IO_CONTROLLER  SerialIoDevice
  )
{
  UINT32  *SerialIoPsfReg;
 
 
  if (GetPchSeries () == PchLp) {
    SerialIoPsfReg = mPchLpSerialIoPsfRegs;
  } else {
    SerialIoPsfReg = mPchHSerialIoPsfRegs;
    if ((SerialIoDevice == PchSerialIoIndexI2C4) ||
       (SerialIoDevice == PchSerialIoIndexI2C5)) {
      ASSERT (FALSE);
    }
  }
 
  //
  // Set AGNT_T0_SHDW_PCIEN[19:18] = 00b
  // SerialIo device BAR is 64bit wide so to enable BAR1
  // at PSF both BAR2 (32bit wide) and BAR3 (32bit wide) need to be enabled
  //
  PchPcrAndThenOr32 (
    PID_PSF3,
    (UINT16)SerialIoPsfReg[SerialIoDevice] + R_PCH_PCR_PSFX_T0_SHDW_PCIEN,
    (UINT32)~(B_PCH_PCR_PSFX_T0_SHDW_PCIEN_BAR2DIS | B_PCH_PCR_PSFX_T0_SHDW_PCIEN_BAR3DIS),
    0
    );
}
 
/**
  This procedure will disable SerialIO device BAR1 at PSF level
 
  @param[in] SerialIoDevice  SERIAL IO device (I2C0-5, SPI0-1, UART0-2)
 
  @retval None
**/
VOID
PsfDisableSerialIoDeviceBar1 (
  IN PCH_SERIAL_IO_CONTROLLER  SerialIoDevice
  )
{
  UINT32  *SerialIoPsfReg;
 
  if (GetPchSeries () == PchLp) {
    SerialIoPsfReg = mPchLpSerialIoPsfRegs;
  } else {
    SerialIoPsfReg = mPchHSerialIoPsfRegs;
    if ((SerialIoDevice == PchSerialIoIndexI2C4) ||
       (SerialIoDevice == PchSerialIoIndexI2C5)) {
      ASSERT (FALSE);
    }
  }
 
  //
  // Set AGNT_T0_SHDW_PCIEN[19:18] = 11b
  // SerialIo device BAR is 64bit wide so to disable BAR1
  // at PSF both BAR2 (32bit wide) and BAR3 (32bit wide) need to be disabled
  //
  PchPcrAndThenOr32 (
    PID_PSF3,
    (UINT16)SerialIoPsfReg[SerialIoDevice] + R_PCH_PCR_PSFX_T0_SHDW_PCIEN,
    ~0u,
    (B_PCH_PCR_PSFX_T0_SHDW_PCIEN_BAR2DIS | B_PCH_PCR_PSFX_T0_SHDW_PCIEN_BAR3DIS)
    );
}
 
/**
  This procedure will disable SerailIO device at PSF level
 
  @param[in] SerialIoDevice  SERIAL IO device (I2C0-5, SPI0-1, UART0-2)
 
  @retval None
**/
VOID
PsfDisableSerialIoDevice (
  IN PCH_SERIAL_IO_CONTROLLER  SerialIoDevice
  )
{
  UINT32  *SerialIoPsfReg;
 
  if (GetPchSeries () == PchLp) {
    SerialIoPsfReg = mPchLpSerialIoPsfRegs;
  } else {
    SerialIoPsfReg = mPchHSerialIoPsfRegs;
    if ((SerialIoDevice == PchSerialIoIndexI2C4) ||
       (SerialIoDevice == PchSerialIoIndexI2C5)) {
      ASSERT (FALSE);
    }
  }
 
  PchPcrAndThenOr32 (
    PID_PSF3,
    (UINT16)SerialIoPsfReg[SerialIoDevice] + R_PCH_PCR_PSFX_T0_SHDW_PCIEN,
    0xFFFFFFFF,
    B_PCH_PCR_PSFX_T0_SHDW_PCIEN_FUNDIS
    );
}
 
/**
  This procedure will hide SerialIo device PciCfgSpace at PSF level
 
  @param[in] SerialIoDevice  SERIAL IO device (I2C0-5, SPI0-1, UART0-2)
 
  @retval None
**/
VOID
PsfHideSerialIoDevice (
  IN PCH_SERIAL_IO_CONTROLLER  SerialIoDevice
  )
{
  UINT32  *SerialIoPsfReg;
 
  if (GetPchSeries () == PchLp) {
    SerialIoPsfReg = mPchLpSerialIoPsfRegs;
  } else {
    SerialIoPsfReg = mPchHSerialIoPsfRegs;
    if ((SerialIoDevice == PchSerialIoIndexI2C4) ||
       (SerialIoDevice == PchSerialIoIndexI2C5)) {
      ASSERT (FALSE);
    }
  }
 
  PchPcrAndThenOr32 (
    PID_PSF3,
    (UINT16)SerialIoPsfReg[SerialIoDevice] + R_PCH_PCR_PSFX_T0_SHDW_CFG_DIS,
    ~0u,
    B_PCH_PCR_PSFX_T0_SHDW_CFG_DIS_CFGDIS
    );
}
 
/**
  This procedure will reveal SerialIo device PciCfgSpace at PSF level
 
  @param[in] SerialIoDevice  SERIAL IO device (I2C0-5, SPI0-1, UART0-2)
 
  @retval None
**/
VOID
PsfRevealSerialIoDevice (
  IN PCH_SERIAL_IO_CONTROLLER  SerialIoDevice
  )
{
  UINT32  *SerialIoPsfReg;
 
  if (GetPchSeries () == PchLp) {
    SerialIoPsfReg = mPchLpSerialIoPsfRegs;
  } else {
    SerialIoPsfReg = mPchHSerialIoPsfRegs;
    if ((SerialIoDevice == PchSerialIoIndexI2C4) ||
       (SerialIoDevice == PchSerialIoIndexI2C5)) {
      ASSERT (FALSE);
    }
  }
 
  PchPcrAndThenOr32 (
    PID_PSF3,
    (UINT16)SerialIoPsfReg[SerialIoDevice] + R_PCH_PCR_PSFX_T0_SHDW_CFG_DIS,
    (UINT32) ~(B_PCH_PCR_PSFX_T0_SHDW_CFG_DIS_CFGDIS),
    0
    );
}
 
/**
  This procedure will set BARx value for TraceHub ACPI device at PSF level
 
  @param[in] BarNum          BAR Number (0:BAR0, 1:BAR1)
  @param[in] BarValue        32bit BAR value
 
  @retval None
**/
VOID
PsfSetTraceHubAcpiDeviceBarValue (
  IN UINT8   BarNum,
  IN UINT32  BarValue
  )
{
  UINT16  RegOffset;
 
  if (BarNum > 1) {
    ASSERT (FALSE);
  }
 
  RegOffset = R_PCH_PCR_PSF3_T0_SHDW_TRACE_HUB_ACPI_REG_BASE + R_PCH_PCR_PSFX_T0_SHDW_BAR0 + BarNum * 0x4;
 
  PchPcrAndThenOr32 (
    PID_PSF3,
    RegOffset,
    0x0,
    BarValue
    );
}
 
/**
  This procedure will enable MSE for TraceHub ACPI device at PSF level
 
  @param[in] None
 
  @retval None
**/
VOID
PsfEnableTraceHubAcpiDeviceMemorySpace (
  VOID
  )
{
  PchPcrAndThenOr8 (
    PID_PSF3, R_PCH_PCR_PSF3_T0_SHDW_TRACE_HUB_ACPI_REG_BASE + R_PCH_PCR_PSFX_T0_SHDW_PCIEN,
    0xFF,
    B_PCH_PCR_PSFX_T0_SHDW_PCIEN_MEMEN
    );
}
 
GLOBAL_REMOVE_IF_UNREFERENCED UINT16 mPchLpHeciPsfRegBase[] =
{
  R_PCH_LP_PCR_PSF1_T0_SHDW_HECI1_REG_BASE,
  R_PCH_LP_PCR_PSF1_T0_SHDW_HECI2_REG_BASE,
  R_PCH_LP_PCR_PSF1_T0_SHDW_HECI3_REG_BASE
};
 
GLOBAL_REMOVE_IF_UNREFERENCED UINT16 mPchHHeciPsfRegBase[] =
{
  R_PCH_H_PCR_PSF1_T0_SHDW_HECI1_REG_BASE,
  R_PCH_H_PCR_PSF1_T0_SHDW_HECI2_REG_BASE,
  R_PCH_H_PCR_PSF1_T0_SHDW_HECI3_REG_BASE
};
 
/**
  Enable HECI device at PSF level
 
  @param[in] HeciDevice       HECIx Device (HECI1-3)
 
  @retval None
**/
VOID
PsfEnableHeciDevice (
  IN UINT8      HeciDevice
  )
{
  UINT16     *DevPsfBase;
 
  if ((HeciDevice < 1) || (HeciDevice > 3)) {
    ASSERT (FALSE);
  }
 
  if (GetPchSeries () == PchLp) {
    DevPsfBase = mPchLpHeciPsfRegBase;
  } else {
    DevPsfBase = mPchHHeciPsfRegBase;
  }
 
  PchPcrAndThenOr32 (
    PID_PSF1, DevPsfBase[HeciDevice - 1] + R_PCH_PCR_PSFX_T0_SHDW_PCIEN,
    (UINT32) ~(B_PCH_PCR_PSFX_T0_SHDW_PCIEN_FUNDIS),
    0
    );
}
 
/**
  Disable HECI device at PSF level
 
  @param[in] HeciDevice       HECIx Device (HECI1-3)
 
  @retval None
**/
VOID
PsfDisableHeciDevice (
  IN UINT8      HeciDevice
  )
{
  UINT16     *DevPsfBase;
 
  if ((HeciDevice < 1) || (HeciDevice > 3)) {
    ASSERT (FALSE);
  }
 
  if (GetPchSeries () == PchLp) {
    DevPsfBase = mPchLpHeciPsfRegBase;
  } else {
    DevPsfBase = mPchHHeciPsfRegBase;
  }
 
  PchPcrAndThenOr32 (
    PID_PSF1, DevPsfBase[HeciDevice - 1] + R_PCH_PCR_PSFX_T0_SHDW_PCIEN,
    ~0u,
    B_PCH_PCR_PSFX_T0_SHDW_PCIEN_FUNDIS
    );
}
 
/**
  Enable IDER device at PSF level
 
  @retval None
**/
VOID
PsfEnableIderDevice (
  VOID
  )
{
  UINT16     DevPsfBase;
 
  if (GetPchSeries () == PchLp) {
    DevPsfBase = R_PCH_LP_PCR_PSF1_T0_SHDW_IDER_REG_BASE;
  } else {
    DevPsfBase = R_PCH_H_PCR_PSF1_T0_SHDW_IDER_REG_BASE;
  }
 
  PchPcrAndThenOr32 (
    PID_PSF1, DevPsfBase + R_PCH_PCR_PSFX_T0_SHDW_PCIEN,
    (UINT32) ~(B_PCH_PCR_PSFX_T0_SHDW_PCIEN_FUNDIS),
    0
    );
}
 
/**
  Disable IDER device at PSF level
 
  @retval None
**/
VOID
PsfDisableIderDevice (
  VOID
  )
{
  UINT16     DevPsfBase;
 
  if (GetPchSeries () == PchLp) {
    DevPsfBase = R_PCH_LP_PCR_PSF1_T0_SHDW_IDER_REG_BASE;
  } else {
    DevPsfBase = R_PCH_H_PCR_PSF1_T0_SHDW_IDER_REG_BASE;
  }
 
  PchPcrAndThenOr32 (
    PID_PSF1, DevPsfBase + R_PCH_PCR_PSFX_T0_SHDW_PCIEN,
    ~0u,
    B_PCH_PCR_PSFX_T0_SHDW_PCIEN_FUNDIS
    );
}
 
/**
  Enable SOL device at PSF level
 
  @retval None
**/
VOID
PsfEnableSolDevice (
  VOID
  )
{
  UINT16     DevPsfBase;
 
  if (GetPchSeries () == PchLp) {
    DevPsfBase = R_PCH_LP_PCR_PSF1_T0_SHDW_KT_REG_BASE;
  } else {
    DevPsfBase = R_PCH_H_PCR_PSF1_T0_SHDW_KT_REG_BASE;
  }
 
  PchPcrAndThenOr32 (
    PID_PSF1, DevPsfBase + R_PCH_PCR_PSFX_T0_SHDW_PCIEN,
    (UINT32) ~(B_PCH_PCR_PSFX_T0_SHDW_PCIEN_FUNDIS),
    0
    );
}
 
/**
  Disable SOL device at PSF level
 
  @retval None
**/
VOID
PsfDisableSolDevice (
  VOID
  )
{
  UINT16     DevPsfBase;
 
  if (GetPchSeries () == PchLp) {
    DevPsfBase = R_PCH_LP_PCR_PSF1_T0_SHDW_KT_REG_BASE;
  } else {
    DevPsfBase = R_PCH_H_PCR_PSF1_T0_SHDW_KT_REG_BASE;
  }
 
  PchPcrAndThenOr32 (
    PID_PSF1, DevPsfBase + R_PCH_PCR_PSFX_T0_SHDW_PCIEN,
    ~0u,
    B_PCH_PCR_PSFX_T0_SHDW_PCIEN_FUNDIS
    );
}