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
|
/** @file
Intel VTd library definitions.
Copyright (c) 2023 Intel Corporation. All rights reserved. <BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef _INTEL_VTD_PEI_DXE_LIB_H_
#define _INTEL_VTD_PEI_DXE_LIB_H_
//
// Include files
//
#include <Uefi/UefiBaseType.h>
#include <Library/DebugLib.h>
#include <Protocol/VtdLog.h>
#include <Protocol/PlatformVtdPolicy.h>
#if defined (EXT_CALLBACK)
#define _VTDLIB_DEBUG(PrintLevel, ...) \
do { \
VtdLogEventCallback (Context, CallbackHandle, PrintLevel, ##__VA_ARGS__); \
} while (FALSE)
#define VTDLIB_DEBUG(Expression) _VTDLIB_DEBUG Expression
#else
#define VTDLIB_DEBUG(Expression) DEBUG(Expression)
#endif
#pragma pack(1)
typedef struct {
UINT8 DeviceType;
VTD_SOURCE_ID PciSourceId;
EDKII_PLATFORM_VTD_PCI_DEVICE_ID PciDeviceId;
// for statistic analysis
UINT64 AccessCount;
} PCI_DEVICE_DATA;
typedef struct {
BOOLEAN IncludeAllFlag;
UINT16 Segment;
UINT32 PciDeviceDataMaxNumber;
UINT32 PciDeviceDataNumber;
PCI_DEVICE_DATA PciDeviceData[1];
} PCI_DEVICE_INFORMATION;
typedef struct {
UINT64 Uint64Lo;
UINT64 Uint64Hi;
}VTD_UINT128;
typedef struct {
UINT64 BaseAddress;
UINT32 VerReg;
UINT64 CapReg;
UINT64 EcapReg;
UINT32 GstsReg;
UINT64 RtaddrReg;
UINT64 CcmdReg;
UINT32 FstsReg;
UINT32 FectlReg;
UINT32 FedataReg;
UINT32 FeaddrReg;
UINT32 FeuaddrReg;
UINT64 IqercdReg;
UINT64 IvaReg;
UINT64 IotlbReg;
UINT16 FrcdRegNum; // Number of FRCD Registers
VTD_UINT128 FrcdReg[1];
} VTD_REGESTER_INFO;
typedef struct {
UINT64 BaseAddress;
UINT32 FstsReg;
UINT64 IqercdReg;
} VTD_REGESTER_QI_INFO;
typedef struct {
UINT64 BaseAddress;
UINT32 GstsReg;
UINT64 RtaddrReg;
UINT32 FstsReg;
UINT32 FectlReg;
UINT64 IqercdReg;
UINT16 FrcdRegNum; // Number of FRCD Registers
VTD_UINT128 FrcdReg[1];
} VTD_REGESTER_THIN_INFO;
typedef struct {
VTD_SOURCE_ID SourceId;
EFI_PHYSICAL_ADDRESS DeviceAddress;
UINT64 Length;
UINT64 IoMmuAccess;
EFI_STATUS Status;
} VTD_PROTOCOL_SET_ATTRIBUTE;
typedef struct {
UINT64 BaseAddress;
UINT64 TableAddress;
BOOLEAN Is5LevelPaging;
} VTD_ROOT_TABLE_INFO;
#pragma pack()
/**
@brief This callback function is to handle the Vtd log strings.
[Consumption]
Dump VTd log
@param[in] Context Context
@param[in] ErrorLevel The error level of the debug message.
@param[in] Buffer Event string
**/
typedef
VOID
(EFIAPI *EDKII_VTD_LIB_STRING_CB) (
IN VOID *Context,
IN UINTN ErrorLevel,
IN CHAR8 *Buffer
);
/**
@brief This function is to dump DMAR ACPI table.
[Consumption]
Dump VTd log
@param[in] Context Event Context
@param[in out] CallbackHandle Callback Handler
@param[in] Dmar DMAR ACPI table
**/
VOID
VtdLibDumpAcpiDmar (
IN VOID *Context,
IN OUT EDKII_VTD_LIB_STRING_CB CallbackHandle,
IN EFI_ACPI_DMAR_HEADER *Dmar
);
/**
@brief This function is to dump DRHD DMAR ACPI table.
[Consumption]
Dump VTd log
@param[in] Context Event Context
@param[in out] CallbackHandle Callback Handler
@param[in] Dmar DMAR ACPI table
**/
VOID
VtdLibDumpAcpiDmarDrhd (
IN VOID *Context,
IN OUT EDKII_VTD_LIB_STRING_CB CallbackHandle,
IN EFI_ACPI_DMAR_HEADER *Dmar
);
/**
@brief This function is to dump the PCI device information of the VTd engine.
[Consumption]
Dump VTd log
@param[in] Context Event Context
@param[in out] CallbackHandle Callback Handler
@param[in] PciDeviceInfo PCI device information
**/
VOID
VtdLibDumpPciDeviceInfo (
IN VOID *Context,
IN OUT EDKII_VTD_LIB_STRING_CB CallbackHandle,
IN PCI_DEVICE_INFORMATION *PciDeviceInfo
);
/**
@brief This function is to dump DMAR context entry table.
[Consumption]
Dump VTd log
@param[in] Context Event context
@param[in out] CallbackHandle Callback handler
@param[in] RootEntry DMAR root entry.
@param[in] Is5LevelPaging If it is the 5 level paging.
**/
VOID
VtdLibDumpDmarContextEntryTable (
IN VOID *Context,
IN OUT EDKII_VTD_LIB_STRING_CB CallbackHandle,
IN VTD_ROOT_ENTRY *RootEntry,
IN BOOLEAN Is5LevelPaging
);
/**
@brief This function is to dump DMAR extended context entry table.
[Consumption]
Dump VTd log
@param[in] Context Event context
@param[in out] CallbackHandle Callback handler
@param[in] ExtRootEntry DMAR extended root entry.
@param[in] Is5LevelPaging If it is the 5 level paging.
**/
VOID
VtdLibDumpDmarExtContextEntryTable (
IN VOID *Context,
IN OUT EDKII_VTD_LIB_STRING_CB CallbackHandle,
IN VTD_EXT_ROOT_ENTRY *ExtRootEntry,
IN BOOLEAN Is5LevelPaging
);
/**
@brief This function is to dump VTd registers.
[Consumption]
Dump VTd log
@param[in] Context Event context
@param[in out] CallbackHandle Callback handler
@param[in] VtdRegInfo Registers Information
**/
VOID
VtdLibDumpVtdRegsAll (
IN VOID *Context,
IN OUT EDKII_VTD_LIB_STRING_CB CallbackHandle,
IN VTD_REGESTER_INFO *VtdRegInfo
);
/**
@brief This function is to dump VTd registers.
[Consumption]
Dump VTd log
@param[in] Context Event context
@param[in out] CallbackHandle Callback handler
@param[in] VtdRegInfo Registers Information
**/
VOID
VtdLibDumpVtdRegsThin (
IN VOID *Context,
IN OUT EDKII_VTD_LIB_STRING_CB CallbackHandle,
IN VTD_REGESTER_THIN_INFO *VtdRegInfo
);
/**
@brief This function is to decode log event context.
[Consumption]
Dump VTd log
@param[in] Context Event context
@param[in out] CallbackHandle Callback handler
@param[in] Event Event struct
@retval TRUE Decode event success
@retval FALSE Unknown event
**/
BOOLEAN
VtdLibDecodeEvent (
IN VOID *Context,
IN OUT EDKII_VTD_LIB_STRING_CB CallbackHandle,
IN VTDLOG_EVENT *Event
);
/**
@brief Pre-boot DMA protection End Process
+----------------------+
| OnExitBootServices |
+----------------------+
||
\/
+-------------------------------------------------+
| Flush Write Buffer |
| VtdLibFlushWriteBuffer () |
+-------------------------------------------------+
||
\/
+-------------------------------------------------+
| Invalidate Context Cache |
| VtdLibSubmitQueuedInvalidationDescriptor () |
+-------------------------------------------------+
||
\/
+-------------------------------------------------+
| Invalidate IOTLB |
| VtdLibSubmitQueuedInvalidationDescriptor () |
+-------------------------------------------------+
||
\/
+-------------------------------------------------+
| Disable DMAR |
| VtdLibDisableDmar () |
+-------------------------------------------------+
||
\/
+-------------------------------------------------+
| Disable Queued Invalidation interface |
| VtdLibDisableQueuedInvalidationInterface () |
+-------------------------------------------------+
**/
/**
@brief This function is to flush VTd engine write buffer.
[Consumption]
Operate VTd engine
@param[in] VtdUnitBaseAddress The base address of the VTd engine.
**/
VOID
VtdLibFlushWriteBuffer (
IN UINTN VtdUnitBaseAddress
);
/**
@brief This function is to clear Global Command Register Bits.
[Consumption]
Operate VTd engine
@param[in] VtdUnitBaseAddress The base address of the VTd engine.
@param[in] BitMask Bit mask.
**/
VOID
VtdLibClearGlobalCommandRegisterBits (
IN UINTN VtdUnitBaseAddress,
IN UINT32 BitMask
);
/**
@brief This function is to set VTd Global Command Register Bits.
[Consumption]
Operate VTd engine
@param[in] VtdUnitBaseAddress The base address of the VTd engine.
@param[in] BitMask Bit mask.
**/
VOID
VtdLibSetGlobalCommandRegisterBits (
IN UINTN VtdUnitBaseAddress,
IN UINT32 BitMask
);
/**
@brief This function is to disable DMAR.
[Consumption]
Operate VTd engine
@param[in] VtdUnitBaseAddress The base address of the VTd engine.
@retval EFI_SUCCESS DMAR translation is disabled.
**/
EFI_STATUS
VtdLibDisableDmar (
IN UINTN VtdUnitBaseAddress
);
/**
@brief This function is to disable PMR.
[Consumption]
Operate VTd engine
@param[in] VtdUnitBaseAddress The base address of the VTd engine.
@retval EFI_SUCCESS PMR is disabled.
@retval EFI_UNSUPPORTED PMR is not supported.
@retval EFI_NOT_STARTED PMR was not enabled.
**/
EFI_STATUS
VtdLibDisablePmr (
IN UINTN VtdUnitBaseAddress
);
/**
@brief This function is to disable queued invalidation interface
[Introduction]
Disable queued invalidation interface.
[Consumption]
Operate VTd engine
@param[in] VtdUnitBaseAddress The base address of the VTd engine.
**/
VOID
VtdLibDisableQueuedInvalidationInterface (
IN UINTN VtdUnitBaseAddress
);
/**
@brief This function is to submit a queued invalidation descriptor
[Introduction]
Submit the queued invalidation descriptor to the remapping
hardware unit and wait for its completion.
[Consumption]
Operate VTd engine
@param[in] VtdUnitBaseAddress The base address of the VTd engine.
@param[in] Desc The invalidate descriptor
@param[in] ClearFaultBits TRUE - This API will clear the queued invalidation fault bits if any.
FALSE - The caller need to check and clear the queued invalidation fault bits.
@retval EFI_SUCCESS The operation was successful.
@retval RETURN_DEVICE_ERROR A fault is detected.
@retval EFI_INVALID_PARAMETER Parameter is invalid.
@retval EFI_DEVICE_ERROR Detect fault, need to clear fault bits if ClearFaultBits is FALSE
**/
EFI_STATUS
VtdLibSubmitQueuedInvalidationDescriptor (
IN UINTN VtdUnitBaseAddress,
IN VOID *Desc,
IN BOOLEAN ClearFaultBits
);
#endif
|
