VirtualBox

source: vbox/trunk/include/VBox/iommu-amd.h@ 87304

Last change on this file since 87304 was 87304, checked in by vboxsync, 4 years ago

AMD IOMMU: bugref:9654 Add IRTE_GVA_T if we need to implement interrupt virtualization when guest APIC is enabled.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 122.5 KB
Line 
1/** @file
2 * IOMMU - Input/Output Memory Management Unit (AMD).
3 */
4
5/*
6 * Copyright (C) 2020 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef VBOX_INCLUDED_iommu_amd_h
27#define VBOX_INCLUDED_iommu_amd_h
28#ifndef RT_WITHOUT_PRAGMA_ONCE
29# pragma once
30#endif
31
32#include <iprt/types.h>
33#include <iprt/assertcompile.h>
34
35/**
36 * @name PCI configuration register offsets.
37 * In accordance with the AMD spec.
38 * @{
39 */
40#define IOMMU_PCI_OFF_CAP_HDR 0x40
41#define IOMMU_PCI_OFF_BASE_ADDR_REG_LO 0x44
42#define IOMMU_PCI_OFF_BASE_ADDR_REG_HI 0x48
43#define IOMMU_PCI_OFF_RANGE_REG 0x4c
44#define IOMMU_PCI_OFF_MISCINFO_REG_0 0x50
45#define IOMMU_PCI_OFF_MISCINFO_REG_1 0x54
46#define IOMMU_PCI_OFF_MSI_CAP_HDR 0x64
47#define IOMMU_PCI_OFF_MSI_ADDR_LO 0x68
48#define IOMMU_PCI_OFF_MSI_ADDR_HI 0x6c
49#define IOMMU_PCI_OFF_MSI_DATA 0x70
50#define IOMMU_PCI_OFF_MSI_MAP_CAP_HDR 0x74
51/** @} */
52
53/**
54 * @name MMIO register offsets.
55 * In accordance with the AMD spec.
56 * @{
57 */
58#define IOMMU_MMIO_OFF_QWORD_TABLE_0_START IOMMU_MMIO_OFF_DEV_TAB_BAR
59#define IOMMU_MMIO_OFF_DEV_TAB_BAR 0x00
60#define IOMMU_MMIO_OFF_CMD_BUF_BAR 0x08
61#define IOMMU_MMIO_OFF_EVT_LOG_BAR 0x10
62#define IOMMU_MMIO_OFF_CTRL 0x18
63#define IOMMU_MMIO_OFF_EXCL_BAR 0x20
64#define IOMMU_MMIO_OFF_EXCL_RANGE_LIMIT 0x28
65#define IOMMU_MMIO_OFF_EXT_FEAT 0x30
66
67#define IOMMU_MMIO_OFF_PPR_LOG_BAR 0x38
68#define IOMMU_MMIO_OFF_HW_EVT_HI 0x40
69#define IOMMU_MMIO_OFF_HW_EVT_LO 0x48
70#define IOMMU_MMIO_OFF_HW_EVT_STATUS 0x50
71
72#define IOMMU_MMIO_OFF_SMI_FLT_FIRST 0x60
73#define IOMMU_MMIO_OFF_SMI_FLT_LAST 0xd8
74
75#define IOMMU_MMIO_OFF_GALOG_BAR 0xe0
76#define IOMMU_MMIO_OFF_GALOG_TAIL_ADDR 0xe8
77
78#define IOMMU_MMIO_OFF_PPR_LOG_B_BAR 0xf0
79#define IOMMU_MMIO_OFF_PPR_EVT_B_BAR 0xf8
80
81#define IOMMU_MMIO_OFF_DEV_TAB_SEG_FIRST 0x100
82#define IOMMU_MMIO_OFF_DEV_TAB_SEG_1 0x100
83#define IOMMU_MMIO_OFF_DEV_TAB_SEG_2 0x108
84#define IOMMU_MMIO_OFF_DEV_TAB_SEG_3 0x110
85#define IOMMU_MMIO_OFF_DEV_TAB_SEG_4 0x118
86#define IOMMU_MMIO_OFF_DEV_TAB_SEG_5 0x120
87#define IOMMU_MMIO_OFF_DEV_TAB_SEG_6 0x128
88#define IOMMU_MMIO_OFF_DEV_TAB_SEG_7 0x130
89#define IOMMU_MMIO_OFF_DEV_TAB_SEG_LAST 0x130
90
91#define IOMMU_MMIO_OFF_DEV_SPECIFIC_FEAT 0x138
92#define IOMMU_MMIO_OFF_DEV_SPECIFIC_CTRL 0x140
93#define IOMMU_MMIO_OFF_DEV_SPECIFIC_STATUS 0x148
94
95#define IOMMU_MMIO_OFF_MSI_VECTOR_0 0x150
96#define IOMMU_MMIO_OFF_MSI_VECTOR_1 0x154
97#define IOMMU_MMIO_OFF_MSI_CAP_HDR 0x158
98#define IOMMU_MMIO_OFF_MSI_ADDR_LO 0x15c
99#define IOMMU_MMIO_OFF_MSI_ADDR_HI 0x160
100#define IOMMU_MMIO_OFF_MSI_DATA 0x164
101#define IOMMU_MMIO_OFF_MSI_MAPPING_CAP_HDR 0x168
102
103#define IOMMU_MMIO_OFF_PERF_OPT_CTRL 0x16c
104
105#define IOMMU_MMIO_OFF_XT_GEN_INTR_CTRL 0x170
106#define IOMMU_MMIO_OFF_XT_PPR_INTR_CTRL 0x178
107#define IOMMU_MMIO_OFF_XT_GALOG_INT_CTRL 0x180
108#define IOMMU_MMIO_OFF_QWORD_TABLE_0_END (IOMMU_MMIO_OFF_XT_GALOG_INT_CTRL + 8)
109
110#define IOMMU_MMIO_OFF_QWORD_TABLE_1_START IOMMU_MMIO_OFF_MARC_APER_BAR_0
111#define IOMMU_MMIO_OFF_MARC_APER_BAR_0 0x200
112#define IOMMU_MMIO_OFF_MARC_APER_RELOC_0 0x208
113#define IOMMU_MMIO_OFF_MARC_APER_LEN_0 0x210
114#define IOMMU_MMIO_OFF_MARC_APER_BAR_1 0x218
115#define IOMMU_MMIO_OFF_MARC_APER_RELOC_1 0x220
116#define IOMMU_MMIO_OFF_MARC_APER_LEN_1 0x228
117#define IOMMU_MMIO_OFF_MARC_APER_BAR_2 0x230
118#define IOMMU_MMIO_OFF_MARC_APER_RELOC_2 0x238
119#define IOMMU_MMIO_OFF_MARC_APER_LEN_2 0x240
120#define IOMMU_MMIO_OFF_MARC_APER_BAR_3 0x248
121#define IOMMU_MMIO_OFF_MARC_APER_RELOC_3 0x250
122#define IOMMU_MMIO_OFF_MARC_APER_LEN_3 0x258
123#define IOMMU_MMIO_OFF_QWORD_TABLE_1_END (IOMMU_MMIO_OFF_MARC_APER_LEN_3 + 8)
124
125#define IOMMU_MMIO_OFF_QWORD_TABLE_2_START IOMMU_MMIO_OFF_RSVD_REG
126#define IOMMU_MMIO_OFF_RSVD_REG 0x1ff8
127
128#define IOMMU_MMIO_OFF_CMD_BUF_HEAD_PTR 0x2000
129#define IOMMU_MMIO_OFF_CMD_BUF_TAIL_PTR 0x2008
130#define IOMMU_MMIO_OFF_EVT_LOG_HEAD_PTR 0x2010
131#define IOMMU_MMIO_OFF_EVT_LOG_TAIL_PTR 0x2018
132
133#define IOMMU_MMIO_OFF_STATUS 0x2020
134
135#define IOMMU_MMIO_OFF_PPR_LOG_HEAD_PTR 0x2030
136#define IOMMU_MMIO_OFF_PPR_LOG_TAIL_PTR 0x2038
137
138#define IOMMU_MMIO_OFF_GALOG_HEAD_PTR 0x2040
139#define IOMMU_MMIO_OFF_GALOG_TAIL_PTR 0x2048
140
141#define IOMMU_MMIO_OFF_PPR_LOG_B_HEAD_PTR 0x2050
142#define IOMMU_MMIO_OFF_PPR_LOG_B_TAIL_PTR 0x2058
143
144#define IOMMU_MMIO_OFF_EVT_LOG_B_HEAD_PTR 0x2070
145#define IOMMU_MMIO_OFF_EVT_LOG_B_TAIL_PTR 0x2078
146
147#define IOMMU_MMIO_OFF_PPR_LOG_AUTO_RESP 0x2080
148#define IOMMU_MMIO_OFF_PPR_LOG_OVERFLOW_EARLY 0x2088
149#define IOMMU_MMIO_OFF_PPR_LOG_B_OVERFLOW_EARLY 0x2090
150#define IOMMU_MMIO_OFF_QWORD_TABLE_2_END (IOMMU_MMIO_OFF_PPR_LOG_B_OVERFLOW_EARLY + 8)
151/** @} */
152
153/**
154 * @name MMIO register-access table offsets.
155 * Each table [first..last] (both inclusive) represents the range of registers
156 * covered by a distinct register-access table. This is done due to arbitrary large
157 * gaps in the MMIO register offsets themselves.
158 * @{
159 */
160#define IOMMU_MMIO_OFF_TABLE_0_FIRST 0x00
161#define IOMMU_MMIO_OFF_TABLE_0_LAST 0x258
162
163#define IOMMU_MMIO_OFF_TABLE_1_FIRST 0x1ff8
164#define IOMMU_MMIO_OFF_TABLE_1_LAST 0x2090
165/** @} */
166
167/**
168 * @name Commands.
169 * In accordance with the AMD spec.
170 * @{
171 */
172#define IOMMU_CMD_COMPLETION_WAIT 0x01
173#define IOMMU_CMD_INV_DEV_TAB_ENTRY 0x02
174#define IOMMU_CMD_INV_IOMMU_PAGES 0x03
175#define IOMMU_CMD_INV_IOTLB_PAGES 0x04
176#define IOMMU_CMD_INV_INTR_TABLE 0x05
177#define IOMMU_CMD_PREFETCH_IOMMU_PAGES 0x06
178#define IOMMU_CMD_COMPLETE_PPR_REQ 0x07
179#define IOMMU_CMD_INV_IOMMU_ALL 0x08
180/** @} */
181
182/**
183 * @name Event codes.
184 * In accordance with the AMD spec.
185 * @{
186 */
187#define IOMMU_EVT_ILLEGAL_DEV_TAB_ENTRY 0x01
188#define IOMMU_EVT_IO_PAGE_FAULT 0x02
189#define IOMMU_EVT_DEV_TAB_HW_ERROR 0x03
190#define IOMMU_EVT_PAGE_TAB_HW_ERROR 0x04
191#define IOMMU_EVT_ILLEGAL_CMD_ERROR 0x05
192#define IOMMU_EVT_COMMAND_HW_ERROR 0x06
193#define IOMMU_EVT_IOTLB_INV_TIMEOUT 0x07
194#define IOMMU_EVT_INVALID_DEV_REQ 0x08
195#define IOMMU_EVT_INVALID_PPR_REQ 0x09
196#define IOMMU_EVT_EVENT_COUNTER_ZERO 0x10
197#define IOMMU_EVT_GUEST_EVENT_FAULT 0x11
198/** @} */
199
200/**
201 * @name IOMMU Capability Header.
202 * In accordance with the AMD spec.
203 * @{
204 */
205/** CapId: Capability ID. */
206#define IOMMU_BF_CAPHDR_CAP_ID_SHIFT 0
207#define IOMMU_BF_CAPHDR_CAP_ID_MASK UINT32_C(0x000000ff)
208/** CapPtr: Capability Pointer. */
209#define IOMMU_BF_CAPHDR_CAP_PTR_SHIFT 8
210#define IOMMU_BF_CAPHDR_CAP_PTR_MASK UINT32_C(0x0000ff00)
211/** CapType: Capability Type. */
212#define IOMMU_BF_CAPHDR_CAP_TYPE_SHIFT 16
213#define IOMMU_BF_CAPHDR_CAP_TYPE_MASK UINT32_C(0x00070000)
214/** CapRev: Capability Revision. */
215#define IOMMU_BF_CAPHDR_CAP_REV_SHIFT 19
216#define IOMMU_BF_CAPHDR_CAP_REV_MASK UINT32_C(0x00f80000)
217/** IoTlbSup: IO TLB Support. */
218#define IOMMU_BF_CAPHDR_IOTLB_SUP_SHIFT 24
219#define IOMMU_BF_CAPHDR_IOTLB_SUP_MASK UINT32_C(0x01000000)
220/** HtTunnel: HyperTransport Tunnel translation support. */
221#define IOMMU_BF_CAPHDR_HT_TUNNEL_SHIFT 25
222#define IOMMU_BF_CAPHDR_HT_TUNNEL_MASK UINT32_C(0x02000000)
223/** NpCache: Not Present table entries Cached. */
224#define IOMMU_BF_CAPHDR_NP_CACHE_SHIFT 26
225#define IOMMU_BF_CAPHDR_NP_CACHE_MASK UINT32_C(0x04000000)
226/** EFRSup: Extended Feature Register (EFR) Supported. */
227#define IOMMU_BF_CAPHDR_EFR_SUP_SHIFT 27
228#define IOMMU_BF_CAPHDR_EFR_SUP_MASK UINT32_C(0x08000000)
229/** CapExt: Miscellaneous Information Register Supported . */
230#define IOMMU_BF_CAPHDR_CAP_EXT_SHIFT 28
231#define IOMMU_BF_CAPHDR_CAP_EXT_MASK UINT32_C(0x10000000)
232/** Bits 31:29 reserved. */
233#define IOMMU_BF_CAPHDR_RSVD_29_31_SHIFT 29
234#define IOMMU_BF_CAPHDR_RSVD_29_31_MASK UINT32_C(0xe0000000)
235RT_BF_ASSERT_COMPILE_CHECKS(IOMMU_BF_CAPHDR_, UINT32_C(0), UINT32_MAX,
236 (CAP_ID, CAP_PTR, CAP_TYPE, CAP_REV, IOTLB_SUP, HT_TUNNEL, NP_CACHE, EFR_SUP, CAP_EXT, RSVD_29_31));
237/** @} */
238
239/**
240 * @name IOMMU Base Address Low Register.
241 * In accordance with the AMD spec.
242 * @{
243 */
244/** Enable: Enables access to the address specified in the Base Address Register. */
245#define IOMMU_BF_BASEADDR_LO_ENABLE_SHIFT 0
246#define IOMMU_BF_BASEADDR_LO_ENABLE_MASK UINT32_C(0x00000001)
247/** Bits 13:1 reserved. */
248#define IOMMU_BF_BASEADDR_LO_RSVD_1_13_SHIFT 1
249#define IOMMU_BF_BASEADDR_LO_RSVD_1_13_MASK UINT32_C(0x00003ffe)
250/** Base Address[31:14]: Low Base address of IOMMU MMIO control registers. */
251#define IOMMU_BF_BASEADDR_LO_ADDR_SHIFT 14
252#define IOMMU_BF_BASEADDR_LO_ADDR_MASK UINT32_C(0xffffc000)
253RT_BF_ASSERT_COMPILE_CHECKS(IOMMU_BF_BASEADDR_LO_, UINT32_C(0), UINT32_MAX,
254 (ENABLE, RSVD_1_13, ADDR));
255/** @} */
256
257/**
258 * @name IOMMU Range Register.
259 * In accordance with the AMD spec.
260 * @{
261 */
262/** UnitID: HyperTransport Unit ID. */
263#define IOMMU_BF_RANGE_UNIT_ID_SHIFT 0
264#define IOMMU_BF_RANGE_UNIT_ID_MASK UINT32_C(0x0000001f)
265/** Bits 6:5 reserved. */
266#define IOMMU_BF_RANGE_RSVD_5_6_SHIFT 5
267#define IOMMU_BF_RANGE_RSVD_5_6_MASK UINT32_C(0x00000060)
268/** RngValid: Range valid. */
269#define IOMMU_BF_RANGE_VALID_SHIFT 7
270#define IOMMU_BF_RANGE_VALID_MASK UINT32_C(0x00000080)
271/** BusNumber: Device range bus number. */
272#define IOMMU_BF_RANGE_BUS_NUMBER_SHIFT 8
273#define IOMMU_BF_RANGE_BUS_NUMBER_MASK UINT32_C(0x0000ff00)
274/** First Device. */
275#define IOMMU_BF_RANGE_FIRST_DEVICE_SHIFT 16
276#define IOMMU_BF_RANGE_FIRST_DEVICE_MASK UINT32_C(0x00ff0000)
277/** Last Device. */
278#define IOMMU_BF_RANGE_LAST_DEVICE_SHIFT 24
279#define IOMMU_BF_RANGE_LAST_DEVICE_MASK UINT32_C(0xff000000)
280RT_BF_ASSERT_COMPILE_CHECKS(IOMMU_BF_RANGE_, UINT32_C(0), UINT32_MAX,
281 (UNIT_ID, RSVD_5_6, VALID, BUS_NUMBER, FIRST_DEVICE, LAST_DEVICE));
282/** @} */
283
284/**
285 * @name IOMMU Miscellaneous Information Register 0.
286 * In accordance with the AMD spec.
287 * @{
288 */
289/** MsiNum: MSI message number. */
290#define IOMMU_BF_MISCINFO_0_MSI_NUM_SHIFT 0
291#define IOMMU_BF_MISCINFO_0_MSI_NUM_MASK UINT32_C(0x0000001f)
292/** GvaSize: Guest Virtual Address Size. */
293#define IOMMU_BF_MISCINFO_0_GVA_SIZE_SHIFT 5
294#define IOMMU_BF_MISCINFO_0_GVA_SIZE_MASK UINT32_C(0x000000e0)
295/** PaSize: Physical Address Size. */
296#define IOMMU_BF_MISCINFO_0_PA_SIZE_SHIFT 8
297#define IOMMU_BF_MISCINFO_0_PA_SIZE_MASK UINT32_C(0x00007f00)
298/** VaSize: Virtual Address Size. */
299#define IOMMU_BF_MISCINFO_0_VA_SIZE_SHIFT 15
300#define IOMMU_BF_MISCINFO_0_VA_SIZE_MASK UINT32_C(0x003f8000)
301/** HtAtsResv: HyperTransport ATS Response Address range Reserved. */
302#define IOMMU_BF_MISCINFO_0_HT_ATS_RESV_SHIFT 22
303#define IOMMU_BF_MISCINFO_0_HT_ATS_RESV_MASK UINT32_C(0x00400000)
304/** Bits 26:23 reserved. */
305#define IOMMU_BF_MISCINFO_0_RSVD_23_26_SHIFT 23
306#define IOMMU_BF_MISCINFO_0_RSVD_23_26_MASK UINT32_C(0x07800000)
307/** MsiNumPPR: Peripheral Page Request MSI message number. */
308#define IOMMU_BF_MISCINFO_0_MSI_NUM_PPR_SHIFT 27
309#define IOMMU_BF_MISCINFO_0_MSI_NUM_PPR_MASK UINT32_C(0xf8000000)
310RT_BF_ASSERT_COMPILE_CHECKS(IOMMU_BF_MISCINFO_0_, UINT32_C(0), UINT32_MAX,
311 (MSI_NUM, GVA_SIZE, PA_SIZE, VA_SIZE, HT_ATS_RESV, RSVD_23_26, MSI_NUM_PPR));
312/** @} */
313
314/**
315 * @name IOMMU Miscellaneous Information Register 1.
316 * In accordance with the AMD spec.
317 * @{
318 */
319/** MsiNumGA: MSI message number for guest virtual-APIC log. */
320#define IOMMU_BF_MISCINFO_1_MSI_NUM_GA_SHIFT 0
321#define IOMMU_BF_MISCINFO_1_MSI_NUM_GA_MASK UINT32_C(0x0000001f)
322/** Bits 31:5 reserved. */
323#define IOMMU_BF_MISCINFO_1_RSVD_5_31_SHIFT 5
324#define IOMMU_BF_MISCINFO_1_RSVD_5_31_MASK UINT32_C(0xffffffe0)
325RT_BF_ASSERT_COMPILE_CHECKS(IOMMU_BF_MISCINFO_1_, UINT32_C(0), UINT32_MAX,
326 (MSI_NUM_GA, RSVD_5_31));
327/** @} */
328
329/**
330 * @name MSI Capability Header Register.
331 * In accordance with the AMD spec.
332 * @{
333 */
334/** MsiCapId: Capability ID. */
335#define IOMMU_BF_MSI_CAP_HDR_CAP_ID_SHIFT 0
336#define IOMMU_BF_MSI_CAP_HDR_CAP_ID_MASK UINT32_C(0x000000ff)
337/** MsiCapPtr: Pointer (PCI config offset) to the next capability. */
338#define IOMMU_BF_MSI_CAP_HDR_CAP_PTR_SHIFT 8
339#define IOMMU_BF_MSI_CAP_HDR_CAP_PTR_MASK UINT32_C(0x0000ff00)
340/** MsiEn: Message Signal Interrupt enable. */
341#define IOMMU_BF_MSI_CAP_HDR_EN_SHIFT 16
342#define IOMMU_BF_MSI_CAP_HDR_EN_MASK UINT32_C(0x00010000)
343/** MsiMultMessCap: MSI Multi-Message Capability. */
344#define IOMMU_BF_MSI_CAP_HDR_MULTMESS_CAP_SHIFT 17
345#define IOMMU_BF_MSI_CAP_HDR_MULTMESS_CAP_MASK UINT32_C(0x000e0000)
346/** MsiMultMessEn: MSI Mult-Message Enable. */
347#define IOMMU_BF_MSI_CAP_HDR_MULTMESS_EN_SHIFT 20
348#define IOMMU_BF_MSI_CAP_HDR_MULTMESS_EN_MASK UINT32_C(0x00700000)
349/** Msi64BitEn: MSI 64-bit Enabled. */
350#define IOMMU_BF_MSI_CAP_HDR_64BIT_EN_SHIFT 23
351#define IOMMU_BF_MSI_CAP_HDR_64BIT_EN_MASK UINT32_C(0x00800000)
352/** Bits 31:24 reserved. */
353#define IOMMU_BF_MSI_CAP_HDR_RSVD_24_31_SHIFT 24
354#define IOMMU_BF_MSI_CAP_HDR_RSVD_24_31_MASK UINT32_C(0xff000000)
355RT_BF_ASSERT_COMPILE_CHECKS(IOMMU_BF_MSI_CAP_HDR_, UINT32_C(0), UINT32_MAX,
356 (CAP_ID, CAP_PTR, EN, MULTMESS_CAP, MULTMESS_EN, 64BIT_EN, RSVD_24_31));
357/** @} */
358
359/**
360 * @name MSI Mapping Capability Header Register.
361 * In accordance with the AMD spec.
362 * @{
363 */
364/** MsiMapCapId: Capability ID. */
365#define IOMMU_BF_MSI_MAP_CAPHDR_CAP_ID_SHIFT 0
366#define IOMMU_BF_MSI_MAP_CAPHDR_CAP_ID_MASK UINT32_C(0x000000ff)
367/** MsiMapCapPtr: Pointer (PCI config offset) to the next capability. */
368#define IOMMU_BF_MSI_MAP_CAPHDR_CAP_PTR_SHIFT 8
369#define IOMMU_BF_MSI_MAP_CAPHDR_CAP_PTR_MASK UINT32_C(0x0000ff00)
370/** MsiMapEn: MSI mapping capability enable. */
371#define IOMMU_BF_MSI_MAP_CAPHDR_EN_SHIFT 16
372#define IOMMU_BF_MSI_MAP_CAPHDR_EN_MASK UINT32_C(0x00010000)
373/** MsiMapFixd: MSI interrupt mapping range is not programmable. */
374#define IOMMU_BF_MSI_MAP_CAPHDR_FIXED_SHIFT 17
375#define IOMMU_BF_MSI_MAP_CAPHDR_FIXED_MASK UINT32_C(0x00020000)
376/** Bits 18:28 reserved. */
377#define IOMMU_BF_MSI_MAP_CAPHDR_RSVD_18_28_SHIFT 18
378#define IOMMU_BF_MSI_MAP_CAPHDR_RSVD_18_28_MASK UINT32_C(0x07fc0000)
379/** MsiMapCapType: MSI mapping capability. */
380#define IOMMU_BF_MSI_MAP_CAPHDR_CAP_TYPE_SHIFT 27
381#define IOMMU_BF_MSI_MAP_CAPHDR_CAP_TYPE_MASK UINT32_C(0xf8000000)
382RT_BF_ASSERT_COMPILE_CHECKS(IOMMU_BF_MSI_MAP_CAPHDR_, UINT32_C(0), UINT32_MAX,
383 (CAP_ID, CAP_PTR, EN, FIXED, RSVD_18_28, CAP_TYPE));
384/** @} */
385
386/**
387 * @name IOMMU Status Register Bits.
388 * In accordance with the AMD spec.
389 * @{
390 */
391/** EventOverflow: Event log overflow. */
392#define IOMMU_STATUS_EVT_LOG_OVERFLOW RT_BIT_64(0)
393/** EventLogInt: Event log interrupt. */
394#define IOMMU_STATUS_EVT_LOG_INTR RT_BIT_64(1)
395/** ComWaitInt: Completion wait interrupt. */
396#define IOMMU_STATUS_COMPLETION_WAIT_INTR RT_BIT_64(2)
397/** EventLogRun: Event log is running. */
398#define IOMMU_STATUS_EVT_LOG_RUNNING RT_BIT_64(3)
399/** CmdBufRun: Command buffer is running. */
400#define IOMMU_STATUS_CMD_BUF_RUNNING RT_BIT_64(4)
401/** PprOverflow: Peripheral page request log overflow. */
402#define IOMMU_STATUS_PPR_LOG_OVERFLOW RT_BIT_64(5)
403/** PprInt: Peripheral page request log interrupt. */
404#define IOMMU_STATUS_PPR_LOG_INTR RT_BIT_64(6)
405/** PprLogRun: Peripheral page request log is running. */
406#define IOMMU_STATUS_PPR_LOG_RUN RT_BIT_64(7)
407/** GALogRun: Guest virtual-APIC log is running. */
408#define IOMMU_STATUS_GA_LOG_RUN RT_BIT_64(8)
409/** GALOverflow: Guest virtual-APIC log overflow. */
410#define IOMMU_STATUS_GA_LOG_OVERFLOW RT_BIT_64(9)
411/** GAInt: Guest virtual-APIC log interrupt. */
412#define IOMMU_STATUS_GA_LOG_INTR RT_BIT_64(10)
413/** PprOvrflwB: PPR Log B overflow. */
414#define IOMMU_STATUS_PPR_LOG_B_OVERFLOW RT_BIT_64(11)
415/** PprLogActive: PPR Log B is active. */
416#define IOMMU_STATUS_PPR_LOG_B_ACTIVE RT_BIT_64(12)
417/** EvtOvrflwB: Event log B overflow. */
418#define IOMMU_STATUS_EVT_LOG_B_OVERFLOW RT_BIT_64(15)
419/** EventLogActive: Event log B active. */
420#define IOMMU_STATUS_EVT_LOG_B_ACTIVE RT_BIT_64(16)
421/** PprOvrflwEarlyB: PPR log B overflow early warning. */
422#define IOMMU_STATUS_PPR_LOG_B_OVERFLOW_EARLY RT_BIT_64(17)
423/** PprOverflowEarly: PPR log overflow early warning. */
424#define IOMMU_STATUS_PPR_LOG_OVERFLOW_EARLY RT_BIT_64(18)
425/** @} */
426
427/** @name IOMMU_IO_PERM_XXX: IOMMU I/O access permissions bits.
428 * In accordance with the AMD spec.
429 *
430 * These values match the shifted values of the IR and IW field of the DTE and the
431 * PTE, PDE of the I/O page tables.
432 *
433 * @{ */
434#define IOMMU_IO_PERM_NONE (0)
435#define IOMMU_IO_PERM_READ RT_BIT_64(0)
436#define IOMMU_IO_PERM_WRITE RT_BIT_64(1)
437#define IOMMU_IO_PERM_READ_WRITE (IOMMU_IO_PERM_READ | IOMMU_IO_PERM_WRITE)
438#define IOMMU_IO_PERM_SHIFT 61
439#define IOMMU_IO_PERM_MASK 0x3
440/** @} */
441
442/** @name SYSMGT_TYPE_XXX: System Management Message Enable Types.
443 * In accordance with the AMD spec.
444 * @{ */
445#define SYSMGTTYPE_DMA_DENY (0)
446#define SYSMGTTYPE_MSG_ALL_ALLOW (1)
447#define SYSMGTTYPE_MSG_INT_ALLOW (2)
448#define SYSMGTTYPE_DMA_ALLOW (3)
449/** @} */
450
451/** @name IOMMU_INTR_CTRL_XX: DTE::IntCtl field values.
452 * These are control bits for handling fixed and arbitrated interrupts.
453 * In accordance with the AMD spec.
454 * @{ */
455#define IOMMU_INTR_CTRL_TARGET_ABORT (0)
456#define IOMMU_INTR_CTRL_FWD_UNMAPPED (1)
457#define IOMMU_INTR_CTRL_REMAP (2)
458#define IOMMU_INTR_CTRL_RSVD (3)
459/** @} */
460
461/** Gets the device table length (in bytes) given the device table pointer. */
462#define IOMMU_GET_DEV_TAB_LEN(a_pDevTab) (((a_pDevTab)->n.u9Size + 1) << X86_PAGE_4K_SHIFT)
463
464/**
465 * The Device ID.
466 * In accordance with VirtualBox's PCI configuration.
467 */
468typedef union
469{
470 struct
471 {
472 RT_GCC_EXTENSION uint16_t u3Function : 3; /**< Bits 2:0 - Function. */
473 RT_GCC_EXTENSION uint16_t u9Device : 9; /**< Bits 11:3 - Device. */
474 RT_GCC_EXTENSION uint16_t u4Bus : 4; /**< Bits 15:12 - Bus. */
475 } n;
476 /** The unsigned integer view. */
477 uint16_t u;
478} DEVICE_ID_T;
479AssertCompileSize(DEVICE_ID_T, 2);
480
481/**
482 * Device Table Entry (DTE).
483 * In accordance with the AMD spec.
484 */
485typedef union
486{
487 struct
488 {
489 RT_GCC_EXTENSION uint64_t u1Valid : 1; /**< Bit 0 - V: Valid. */
490 RT_GCC_EXTENSION uint64_t u1TranslationValid : 1; /**< Bit 1 - TV: Translation information Valid. */
491 RT_GCC_EXTENSION uint64_t u5Rsvd0 : 5; /**< Bits 6:2 - Reserved. */
492 RT_GCC_EXTENSION uint64_t u2Had : 2; /**< Bits 8:7 - HAD: Host Access Dirty. */
493 RT_GCC_EXTENSION uint64_t u3Mode : 3; /**< Bits 11:9 - Mode: Paging mode. */
494 RT_GCC_EXTENSION uint64_t u40PageTableRootPtrLo : 40; /**< Bits 51:12 - Page Table Root Pointer. */
495 RT_GCC_EXTENSION uint64_t u1Ppr : 1; /**< Bit 52 - PPR: Peripheral Page Request. */
496 RT_GCC_EXTENSION uint64_t u1GstPprRespPasid : 1; /**< Bit 53 - GRPR: Guest PPR Response with PASID. */
497 RT_GCC_EXTENSION uint64_t u1GstIoValid : 1; /**< Bit 54 - GIoV: Guest I/O Protection Valid. */
498 RT_GCC_EXTENSION uint64_t u1GstTranslateValid : 1; /**< Bit 55 - GV: Guest translation Valid. */
499 RT_GCC_EXTENSION uint64_t u2GstMode : 2; /**< Bits 57:56 - GLX: Guest Paging mode levels. */
500 RT_GCC_EXTENSION uint64_t u3GstCr3TableRootPtrLo : 3; /**< Bits 60:58 - GCR3 TRP: Guest CR3 Table Root Ptr (Lo). */
501 RT_GCC_EXTENSION uint64_t u1IoRead : 1; /**< Bit 61 - IR: I/O Read permission. */
502 RT_GCC_EXTENSION uint64_t u1IoWrite : 1; /**< Bit 62 - IW: I/O Write permission. */
503 RT_GCC_EXTENSION uint64_t u1Rsvd0 : 1; /**< Bit 63 - Reserved. */
504 RT_GCC_EXTENSION uint64_t u16DomainId : 16; /**< Bits 79:64 - Domain ID. */
505 RT_GCC_EXTENSION uint64_t u16GstCr3TableRootPtrMid : 16; /**< Bits 95:80 - GCR3 TRP: Guest CR3 Table Root Ptr (Mid). */
506 RT_GCC_EXTENSION uint64_t u1IoTlbEnable : 1; /**< Bit 96 - I: IOTLB Enable. */
507 RT_GCC_EXTENSION uint64_t u1SuppressPfEvents : 1; /**< Bit 97 - SE: Supress Page-fault events. */
508 RT_GCC_EXTENSION uint64_t u1SuppressAllPfEvents : 1; /**< Bit 98 - SA: Supress All Page-fault events. */
509 RT_GCC_EXTENSION uint64_t u2IoCtl : 2; /**< Bits 100:99 - IoCtl: Port I/O Control. */
510 RT_GCC_EXTENSION uint64_t u1Cache : 1; /**< Bit 101 - Cache: IOTLB Cache Hint. */
511 RT_GCC_EXTENSION uint64_t u1SnoopDisable : 1; /**< Bit 102 - SD: Snoop Disable. */
512 RT_GCC_EXTENSION uint64_t u1AllowExclusion : 1; /**< Bit 103 - EX: Allow Exclusion. */
513 RT_GCC_EXTENSION uint64_t u2SysMgt : 2; /**< Bits 105:104 - SysMgt: System Management message enable. */
514 RT_GCC_EXTENSION uint64_t u1Rsvd1 : 1; /**< Bit 106 - Reserved. */
515 RT_GCC_EXTENSION uint64_t u21GstCr3TableRootPtrHi : 21; /**< Bits 127:107 - GCR3 TRP: Guest CR3 Table Root Ptr (Hi). */
516 RT_GCC_EXTENSION uint64_t u1IntrMapValid : 1; /**< Bit 128 - IV: Interrupt map Valid. */
517 RT_GCC_EXTENSION uint64_t u4IntrTableLength : 4; /**< Bits 132:129 - IntTabLen: Interrupt Table Length. */
518 RT_GCC_EXTENSION uint64_t u1IgnoreUnmappedIntrs : 1; /**< Bits 133 - IG: Ignore unmapped interrupts. */
519 RT_GCC_EXTENSION uint64_t u46IntrTableRootPtr : 46; /**< Bits 179:134 - Interrupt Root Table Pointer. */
520 RT_GCC_EXTENSION uint64_t u4Rsvd0 : 4; /**< Bits 183:180 - Reserved. */
521 RT_GCC_EXTENSION uint64_t u1InitPassthru : 1; /**< Bits 184 - INIT Pass-through. */
522 RT_GCC_EXTENSION uint64_t u1ExtIntPassthru : 1; /**< Bits 185 - External Interrupt Pass-through. */
523 RT_GCC_EXTENSION uint64_t u1NmiPassthru : 1; /**< Bits 186 - NMI Pass-through. */
524 RT_GCC_EXTENSION uint64_t u1Rsvd2 : 1; /**< Bits 187 - Reserved. */
525 RT_GCC_EXTENSION uint64_t u2IntrCtrl : 2; /**< Bits 189:188 - IntCtl: Interrupt Control. */
526 RT_GCC_EXTENSION uint64_t u1Lint0Passthru : 1; /**< Bit 190 - Lint0Pass: LINT0 Pass-through. */
527 RT_GCC_EXTENSION uint64_t u1Lint1Passthru : 1; /**< Bit 191 - Lint1Pass: LINT1 Pass-through. */
528 RT_GCC_EXTENSION uint64_t u32Rsvd0 : 32; /**< Bits 223:192 - Reserved. */
529 RT_GCC_EXTENSION uint64_t u22Rsvd0 : 22; /**< Bits 245:224 - Reserved. */
530 RT_GCC_EXTENSION uint64_t u1AttrOverride : 1; /**< Bit 246 - AttrV: Attribute Override. */
531 RT_GCC_EXTENSION uint64_t u1Mode0FC : 1; /**< Bit 247 - Mode0FC. */
532 RT_GCC_EXTENSION uint64_t u8SnoopAttr : 8; /**< Bits 255:248 - Snoop Attribute. */
533 } n;
534 /** The 32-bit unsigned integer view. */
535 uint32_t au32[8];
536 /** The 64-bit unsigned integer view. */
537 uint64_t au64[4];
538} DTE_T;
539AssertCompileSize(DTE_T, 32);
540/** Pointer to a device table entry. */
541typedef DTE_T *PDTE_T;
542/** Pointer to a const device table entry. */
543typedef DTE_T const *PCDTE_T;
544
545/** Mask of valid bits for EPHSUP (Enhanced Peripheral Page Request Handling
546 * Support) feature (bits 52:53). */
547#define IOMMU_DTE_QWORD_0_FEAT_EPHSUP_MASK UINT64_C(0x0030000000000000)
548
549/** Mask of valid bits for GTSup (Guest Translation Support) feature (bits 55:60,
550 * bits 80:95). */
551#define IOMMU_DTE_QWORD_0_FEAT_GTSUP_MASK UINT64_C(0x1f80000000000000)
552#define IOMMU_DTE_QWORD_1_FEAT_GTSUP_MASK UINT64_C(0x00000000ffff0000)
553
554/** Mask of valid bits for GIoSup (Guest I/O Protection Support) feature (bit 54). */
555#define IOMMU_DTE_QWORD_0_FEAT_GIOSUP_MASK UINT64_C(0x0040000000000000)
556
557/** Mask of valid DTE feature bits. */
558#define IOMMU_DTE_QWORD_0_FEAT_MASK ( IOMMU_DTE_QWORD_0_FEAT_EPHSUP_MASK \
559 | IOMMU_DTE_QWORD_0_FEAT_GTSUP_MASK \
560 | IOMMU_DTE_QWORD_0_FEAT_GIOSUP_MASK)
561#define IOMMU_DTE_QWORD_1_FEAT_MASK (IOMMU_DTE_QWORD_0_FEAT_GIOSUP_MASK)
562
563/** Mask of all valid DTE bits (including all feature bits). */
564#define IOMMU_DTE_QWORD_0_VALID_MASK UINT64_C(0x7fffffffffffff83)
565#define IOMMU_DTE_QWORD_1_VALID_MASK UINT64_C(0xfffffbffffffffff)
566#define IOMMU_DTE_QWORD_2_VALID_MASK UINT64_C(0xff0fffffffffffff)
567#define IOMMU_DTE_QWORD_3_VALID_MASK UINT64_C(0xffc0000000000000)
568
569/** Mask of the interrupt table root pointer. */
570#define IOMMU_DTE_IRTE_ROOT_PTR_MASK UINT64_C(0x000fffffffffffc0)
571/** Number of bits to shift to get the interrupt root table pointer at
572 qword 2 (qword 0 being the first one) - 128-byte aligned. */
573#define IOMMU_DTE_IRTE_ROOT_PTR_SHIFT 6
574
575/** Maximum encoded IRTE length (exclusive). */
576#define IOMMU_DTE_INTR_TAB_LEN_MAX 12
577/** Gets the interrupt table entries (in bytes) given the DTE pointer. */
578#define IOMMU_GET_INTR_TAB_ENTRIES(a_pDte) (UINT64_C(1) << (a_pDte)->n.u4IntrTableLength)
579/** Gets the interrupt table length (in bytes) given the DTE pointer. */
580#define IOMMU_GET_INTR_TAB_LEN(a_pDte) (IOMMU_GET_INTR_TAB_ENTRIES(a_pDte) * sizeof(IRTE_T))
581
582/**
583 * I/O Page Translation Entry.
584 * In accordance with the AMD spec.
585 */
586typedef union
587{
588 struct
589 {
590 RT_GCC_EXTENSION uint64_t u1Present : 1; /**< Bit 0 - PR: Present. */
591 RT_GCC_EXTENSION uint64_t u4Ign0 : 4; /**< Bits 4:1 - Ignored. */
592 RT_GCC_EXTENSION uint64_t u1Accessed : 1; /**< Bit 5 - A: Accessed. */
593 RT_GCC_EXTENSION uint64_t u1Dirty : 1; /**< Bit 6 - D: Dirty. */
594 RT_GCC_EXTENSION uint64_t u2Ign0 : 2; /**< Bits 8:7 - Ignored. */
595 RT_GCC_EXTENSION uint64_t u3NextLevel : 3; /**< Bits 11:9 - Next Level: Next page translation level. */
596 RT_GCC_EXTENSION uint64_t u40PageAddr : 40; /**< Bits 51:12 - Page address. */
597 RT_GCC_EXTENSION uint64_t u7Rsvd0 : 7; /**< Bits 58:52 - Reserved. */
598 RT_GCC_EXTENSION uint64_t u1UntranslatedAccess : 1; /**< Bit 59 - U: Untranslated Access Only. */
599 RT_GCC_EXTENSION uint64_t u1ForceCoherent : 1; /**< Bit 60 - FC: Force Coherent. */
600 RT_GCC_EXTENSION uint64_t u1IoRead : 1; /**< Bit 61 - IR: I/O Read permission. */
601 RT_GCC_EXTENSION uint64_t u1IoWrite : 1; /**< Bit 62 - IW: I/O Wead permission. */
602 RT_GCC_EXTENSION uint64_t u1Ign0 : 1; /**< Bit 63 - Ignored. */
603 } n;
604 /** The 64-bit unsigned integer view. */
605 uint64_t u64;
606} IOPTE_T;
607AssertCompileSize(IOPTE_T, 8);
608
609/**
610 * I/O Page Directory Entry.
611 * In accordance with the AMD spec.
612 */
613typedef union
614{
615 struct
616 {
617 RT_GCC_EXTENSION uint64_t u1Present : 1; /**< Bit 0 - PR: Present. */
618 RT_GCC_EXTENSION uint64_t u4Ign0 : 4; /**< Bits 4:1 - Ignored. */
619 RT_GCC_EXTENSION uint64_t u1Accessed : 1; /**< Bit 5 - A: Accessed. */
620 RT_GCC_EXTENSION uint64_t u3Ign0 : 3; /**< Bits 8:6 - Ignored. */
621 RT_GCC_EXTENSION uint64_t u3NextLevel : 3; /**< Bits 11:9 - Next Level: Next page translation level. */
622 RT_GCC_EXTENSION uint64_t u40PageAddr : 40; /**< Bits 51:12 - Page address (Next Table Address). */
623 RT_GCC_EXTENSION uint64_t u9Rsvd0 : 9; /**< Bits 60:52 - Reserved. */
624 RT_GCC_EXTENSION uint64_t u1IoRead : 1; /**< Bit 61 - IR: I/O Read permission. */
625 RT_GCC_EXTENSION uint64_t u1IoWrite : 1; /**< Bit 62 - IW: I/O Wead permission. */
626 RT_GCC_EXTENSION uint64_t u1Ign0 : 1; /**< Bit 63 - Ignored. */
627 } n;
628 /** The 64-bit unsigned integer view. */
629 uint64_t u64;
630} IOPDE_T;
631AssertCompileSize(IOPDE_T, 8);
632
633/**
634 * I/O Page Table Entity.
635 * In accordance with the AMD spec.
636 *
637 * This a common subset of an DTE.au64[0], PTE and PDE.
638 * Named as an "entity" to avoid confusing it with PTE.
639 */
640typedef union
641{
642 struct
643 {
644 RT_GCC_EXTENSION uint64_t u1Present : 1; /**< Bit 0 - PR: Present. */
645 RT_GCC_EXTENSION uint64_t u8Ign0 : 8; /**< Bits 8:1 - Ignored. */
646 RT_GCC_EXTENSION uint64_t u3NextLevel : 3; /**< Bits 11:9 - Mode / Next Level: Next page translation level. */
647 RT_GCC_EXTENSION uint64_t u40Addr : 40; /**< Bits 51:12 - Page address. */
648 RT_GCC_EXTENSION uint64_t u9Ign0 : 9; /**< Bits 60:52 - Ignored. */
649 RT_GCC_EXTENSION uint64_t u1IoRead : 1; /**< Bit 61 - IR: I/O Read permission. */
650 RT_GCC_EXTENSION uint64_t u1IoWrite : 1; /**< Bit 62 - IW: I/O Wead permission. */
651 RT_GCC_EXTENSION uint64_t u1Ign0 : 1; /**< Bit 63 - Ignored. */
652 } n;
653 /** The 64-bit unsigned integer view. */
654 uint64_t u64;
655} IOPTENTITY_T;
656AssertCompileSize(IOPTENTITY_T, 8);
657AssertCompile(sizeof(IOPTENTITY_T) == sizeof(IOPTE_T));
658AssertCompile(sizeof(IOPTENTITY_T) == sizeof(IOPDE_T));
659/** Pointer to an IOPT_ENTITY_T struct. */
660typedef IOPTENTITY_T *PIOPTENTITY_T;
661/** Pointer to a const IOPT_ENTITY_T struct. */
662typedef IOPTENTITY_T const *PCIOPTENTITY_T;
663/** Mask of the address field. */
664#define IOMMU_PTENTITY_ADDR_MASK UINT64_C(0x000ffffffffff000)
665
666/**
667 * Interrupt Remapping Table Entry (IRTE) - Basic Format.
668 * In accordance with the AMD spec.
669 */
670typedef union
671{
672 struct
673 {
674 uint32_t u1RemapEnable : 1; /**< Bit 0 - RemapEn: Remap Enable. */
675 uint32_t u1SuppressIoPf : 1; /**< Bit 1 - SupIOPF: Supress I/O Page Fault. */
676 uint32_t u3IntrType : 3; /**< Bits 4:2 - IntType: Interrupt Type. */
677 uint32_t u1ReqEoi : 1; /**< Bit 5 - RqEoi: Request EOI. */
678 uint32_t u1DestMode : 1; /**< Bit 6 - DM: Destination Mode. */
679 uint32_t u1GuestMode : 1; /**< Bit 7 - GuestMode. */
680 uint32_t u8Dest : 8; /**< Bits 15:8 - Destination. */
681 uint32_t u8Vector : 8; /**< Bits 23:16 - Vector. */
682 uint32_t u8Rsvd0 : 8; /**< Bits 31:24 - Reserved. */
683 } n;
684 /** The 32-bit unsigned integer view. */
685 uint32_t u32;
686} IRTE_T;
687AssertCompileSize(IRTE_T, 4);
688/** Pointer to an IRTE_T struct. */
689typedef IRTE_T *PIRTE_T;
690/** Pointer to a const IRTE_T struct. */
691typedef IRTE_T const *PCIRTE_T;
692
693/** The IRTE offset corresponds directly to bits 10:0 of the originating MSI
694 * interrupt message. See AMD IOMMU spec. 2.2.5 "Interrupt Remapping Tables". */
695#define IOMMU_MSI_DATA_IRTE_OFFSET_MASK UINT32_C(0x000007ff)
696
697/**
698 * Interrupt Remapping Table Entry (IRTE) - Guest Virtual APIC Enabled.
699 * In accordance with the AMD spec.
700 */
701typedef union
702{
703 struct
704 {
705 uint32_t u1RemapEnable : 1; /**< Bit 0 - RemapEn: Remap Enable. */
706 uint32_t u1SuppressIoPf : 1; /**< Bit 1 - SupIOPF: Supress I/O Page Fault. */
707 uint32_t u1GALogIntr : 1; /**< Bit 2 - GALogIntr: Guest APIC Log Interrupt. */
708 uint32_t u3Rsvd : 3; /**< Bits 5:3 - Reserved. */
709 uint32_t u1IsRunning : 1; /**< Bit 6 - IsRun: Hint whether the guest is running. */
710 uint32_t u1GuestMode : 1; /**< Bit 7 - GuestMode. */
711 uint32_t u8Dest : 8; /**< Bits 15:8 - Destination. */
712 uint32_t u8Rsvd0 : 8; /**< Bits 31:16 - Reserved. */
713 uint32_t u32GATag : 32; /**< Bits 63:31 - GATag: Tag used when writing to GA log. */
714 uint32_t u8Vector : 8; /**< Bits 71:64 - Vector: Interrupt vector. */
715 uint32_t u4Reserved : 4; /**< Bits 75:72 - Reserved or ignored depending on RemapEn. */
716 uint32_t u20GATableRootPtrLo : 20; /**< Bits 95:76 - Bits [31:12] of Guest vAPIC Table Root Pointer. */
717 uint32_t u20GATableRootPtrHi : 20; /**< Bits 115:76 - Bits [51:32] of Guest vAPIC Table Root Pointer. */
718 uint32_t u12Rsvd : 12; /**< Bits 127:116 - Reserved. */
719 } n;
720 /** The 64-bit unsigned integer view. */
721 uint64_t u64[2];
722} IRTE_GVA_T;
723AssertCompileSize(IRTE_GVA_T, 16);
724/** Pointer to an IRTE_GVA_T struct. */
725typedef IRTE_GVA_T *PIRTE_GVA_T;
726/** Pointer to a const IRTE_GVA_T struct. */
727typedef IRTE_GVA_T const *PCIRTE_GVA_T;
728
729/**
730 * Command: Generic Command Buffer Entry.
731 * In accordance with the AMD spec.
732 */
733typedef union
734{
735 struct
736 {
737 uint32_t u32Operand1Lo; /**< Bits 31:0 - Operand 1 (Lo). */
738 uint32_t u28Operand1Hi : 28; /**< Bits 59:32 - Operand 1 (Hi). */
739 uint32_t u4Opcode : 4; /**< Bits 63:60 - Op Code. */
740 uint64_t u64Operand2; /**< Bits 127:64 - Operand 2. */
741 } n;
742 /** The 64-bit unsigned integer view. */
743 uint64_t au64[2];
744} CMD_GENERIC_T;
745AssertCompileSize(CMD_GENERIC_T, 16);
746/** Pointer to a generic command buffer entry. */
747typedef CMD_GENERIC_T *PCMD_GENERIC_T;
748/** Pointer to a const generic command buffer entry. */
749typedef CMD_GENERIC_T const *PCCMD_GENERIC_T;
750
751/** Number of bits to shift the byte offset of a command in the command buffer to
752 * get its index. */
753#define IOMMU_CMD_GENERIC_SHIFT 4
754
755/**
756 * Command: COMPLETION_WAIT.
757 * In accordance with the AMD spec.
758 */
759typedef union
760{
761 struct
762 {
763 uint32_t u1Store : 1; /**< Bit 0 - S: Completion Store. */
764 uint32_t u1Interrupt : 1; /**< Bit 1 - I: Completion Interrupt. */
765 uint32_t u1Flush : 1; /**< Bit 2 - F: Flush Queue. */
766 uint32_t u29StoreAddrLo : 29; /**< Bits 31:3 - Store Address (Lo). */
767 uint32_t u20StoreAddrHi : 20; /**< Bits 51:32 - Store Address (Hi). */
768 uint32_t u8Rsvd0 : 8; /**< Bits 59:52 - Reserved. */
769 uint32_t u4OpCode : 4; /**< Bits 63:60 - OpCode (Command). */
770 uint64_t u64StoreData; /**< Bits 127:64 - Store Data. */
771 } n;
772 /** The 64-bit unsigned integer view. */
773 uint64_t au64[2];
774} CMD_COMWAIT_T;
775AssertCompileSize(CMD_COMWAIT_T, 16);
776/** Pointer to a completion wait command. */
777typedef CMD_COMWAIT_T *PCMD_COMWAIT_T;
778/** Pointer to a const completion wait command. */
779typedef CMD_COMWAIT_T const *PCCMD_COMWAIT_T;
780#define IOMMU_CMD_COM_WAIT_QWORD_0_VALID_MASK UINT64_C(0xf00fffffffffffff)
781
782/**
783 * Command: INVALIDATE_DEVTAB_ENTRY.
784 * In accordance with the AMD spec.
785 */
786typedef union
787{
788 struct
789 {
790 uint16_t u16DevId; /**< Bits 15:0 - Device ID. */
791 uint16_t u16Rsvd0; /**< Bits 31:16 - Reserved. */
792 uint32_t u28Rsvd0 : 28; /**< Bits 59:32 - Reserved. */
793 uint32_t u4OpCode : 4; /**< Bits 63:60 - Op Code (Command). */
794 uint64_t u64Rsvd0; /**< Bits 127:64 - Reserved. */
795 } n;
796 /** The 64-bit unsigned integer view. */
797 uint64_t au64[2];
798} CMD_INV_DTE_T;
799AssertCompileSize(CMD_INV_DTE_T, 16);
800
801/**
802 * Command: INVALIDATE_IOMMU_PAGES.
803 * In accordance with the AMD spec.
804 */
805typedef union
806{
807 struct
808 {
809 uint32_t u20Pasid : 20; /**< Bits 19:0 - PASID: Process Address-Space ID. */
810 uint32_t u12Rsvd0 : 12; /**< Bits 31:20 - Reserved. */
811 uint32_t u16DomainId : 16; /**< Bits 47:32 - Domain ID. */
812 uint32_t u12Rsvd1 : 12; /**< Bits 59:48 - Reserved. */
813 uint32_t u4OpCode : 4; /**< Bits 63:60 - Op Code (Command). */
814 uint32_t u1Size : 1; /**< Bit 64 - S: Size. */
815 uint32_t u1PageDirEntries : 1; /**< Bit 65 - PDE: Page Directory Entries. */
816 uint32_t u1GuestOrNested : 1; /**< Bit 66 - GN: Guest (GPA) or Nested (GVA). */
817 uint32_t u9Rsvd0 : 9; /**< Bits 75:67 - Reserved. */
818 uint32_t u20AddrLo : 20; /**< Bits 95:76 - Address (Lo). */
819 uint32_t u32AddrHi; /**< Bits 127:96 - Address (Hi). */
820 } n;
821 /** The 64-bit unsigned integer view. */
822 uint64_t au64[2];
823} CMD_INV_IOMMU_PAGES_T;
824AssertCompileSize(CMD_INV_IOMMU_PAGES_T, 16);
825
826/**
827 * Command: INVALIDATE_IOTLB_PAGES.
828 * In accordance with the AMD spec.
829 */
830typedef union
831{
832 struct
833 {
834 uint16_t u16DevId; /**< Bits 15:0 - Device ID. */
835 uint8_t u8PasidLo; /**< Bits 23:16 - PASID: Process Address-Space ID (Lo). */
836 uint8_t u8MaxPend; /**< Bits 31:24 - Maxpend: Maximum simultaneous in-flight transactions. */
837 uint32_t u16QueueId : 16; /**< Bits 47:32 - Queue ID. */
838 uint32_t u12PasidHi : 12; /**< Bits 59:48 - PASID: Process Address-Space ID (Hi). */
839 uint32_t u4OpCode : 4; /**< Bits 63:60 - Op Code (Command). */
840 uint32_t u1Size : 1; /**< Bit 64 - S: Size. */
841 uint32_t u1Rsvd0: 1; /**< Bit 65 - Reserved. */
842 uint32_t u1GuestOrNested : 1; /**< Bit 66 - GN: Guest (GPA) or Nested (GVA). */
843 uint32_t u1Rsvd1 : 1; /**< Bit 67 - Reserved. */
844 uint32_t u2Type : 2; /**< Bit 69:68 - Type. */
845 uint32_t u6Rsvd0 : 6; /**< Bits 75:70 - Reserved. */
846 uint32_t u20AddrLo : 20; /**< Bits 95:76 - Address (Lo). */
847 uint32_t u32AddrHi; /**< Bits 127:96 - Address (Hi). */
848 } n;
849 /** The 64-bit unsigned integer view. */
850 uint64_t au64[2];
851} CMD_INV_IOTLB_PAGES_T;
852AssertCompileSize(CMD_INV_IOTLB_PAGES_T, 16);
853
854/**
855 * Command: INVALIDATE_INTR_TABLE.
856 * In accordance with the AMD spec.
857 */
858typedef union
859{
860 struct
861 {
862 uint16_t u16DevId; /**< Bits 15:0 - Device ID. */
863 uint16_t u16Rsvd0; /**< Bits 31:16 - Reserved. */
864 uint32_t u32Rsvd0 : 28; /**< Bits 59:32 - Reserved. */
865 uint32_t u4OpCode : 4; /**< Bits 63:60 - Op Code (Command). */
866 uint64_t u64Rsvd0; /**< Bits 127:64 - Reserved. */
867 } u;
868 /** The 64-bit unsigned integer view. */
869 uint64_t au64[2];
870} CMD_INV_INTR_TABLE_T;
871AssertCompileSize(CMD_INV_INTR_TABLE_T, 16);
872
873/**
874 * Command: COMPLETE_PPR_REQ.
875 * In accordance with the AMD spec.
876 */
877typedef union
878{
879 struct
880 {
881 uint16_t u16DevId; /**< Bits 15:0 - Device ID. */
882 uint16_t u16Rsvd0; /**< Bits 31:16 - Reserved. */
883 uint32_t u20Pasid : 20; /**< Bits 51:32 - PASID: Process Address-Space ID. */
884 uint32_t u8Rsvd0 : 8; /**< Bits 59:52 - Reserved. */
885 uint32_t u4OpCode : 4; /**< Bits 63:60 - Op Code (Command). */
886 uint32_t u2Rsvd0 : 2; /**< Bits 65:64 - Reserved. */
887 uint32_t u1GuestOrNested : 1; /**< Bit 66 - GN: Guest (GPA) or Nested (GVA). */
888 uint32_t u29Rsvd0 : 29; /**< Bits 95:67 - Reserved. */
889 uint32_t u16CompletionTag : 16; /**< Bits 111:96 - Completion Tag. */
890 uint32_t u16Rsvd1 : 16; /**< Bits 127:112 - Reserved. */
891 } n;
892 /** The 64-bit unsigned integer view. */
893 uint64_t au64[2];
894} CMD_COMPLETE_PPR_REQ_T;
895AssertCompileSize(CMD_COMPLETE_PPR_REQ_T, 16);
896
897/**
898 * Command: INV_IOMMU_ALL.
899 * In accordance with the AMD spec.
900 */
901typedef union
902{
903 struct
904 {
905 uint32_t u32Rsvd0; /**< Bits 31:0 - Reserved. */
906 uint32_t u28Rsvd0 : 28; /**< Bits 59:32 - Reserved. */
907 uint32_t u4OpCode : 4; /**< Bits 63:60 - Op Code (Command). */
908 uint64_t u64Rsvd0; /**< Bits 127:64 - Reserved. */
909 } n;
910 /** The 64-bit unsigned integer view. */
911 uint64_t au64[2];
912} CMD_IOMMU_ALL_T;
913AssertCompileSize(CMD_IOMMU_ALL_T, 16);
914
915/**
916 * Event Log Entry: Generic.
917 * In accordance with the AMD spec.
918 */
919typedef union
920{
921 struct
922 {
923 uint32_t u32Operand1Lo; /**< Bits 31:0 - Operand 1 (Lo). */
924 uint32_t u28Operand1Hi : 28; /**< Bits 59:32 - Operand 1 (Hi). */
925 uint32_t u4EvtCode : 4; /**< Bits 63:60 - Event code. */
926 uint32_t u32Operand2Lo; /**< Bits 95:64 - Operand 2 (Lo). */
927 uint32_t u32Operand2Hi; /**< Bits 127:96 - Operand 2 (Hi). */
928 } n;
929 /** The 32-bit unsigned integer view. */
930 uint32_t au32[4];
931} EVT_GENERIC_T;
932AssertCompileSize(EVT_GENERIC_T, 16);
933/** Number of bits to shift the byte offset of an event entry in the event log
934 * buffer to get its index. */
935#define IOMMU_EVT_GENERIC_SHIFT 4
936/** Pointer to a generic event log entry. */
937typedef EVT_GENERIC_T *PEVT_GENERIC_T;
938/** Pointer to a const generic event log entry. */
939typedef const EVT_GENERIC_T *PCEVT_GENERIC_T;
940
941/**
942 * Hardware event types.
943 * In accordance with the AMD spec.
944 */
945typedef enum HWEVTTYPE
946{
947 HWEVTTYPE_RSVD = 0,
948 HWEVTTYPE_MASTER_ABORT,
949 HWEVTTYPE_TARGET_ABORT,
950 HWEVTTYPE_DATA_ERROR
951} HWEVTTYPE;
952AssertCompileSize(HWEVTTYPE, 4);
953
954/**
955 * Event Log Entry: ILLEGAL_DEV_TABLE_ENTRY.
956 * In accordance with the AMD spec.
957 */
958typedef union
959{
960 struct
961 {
962 uint16_t u16DevId; /**< Bits 15:0 - Device ID. */
963 RT_GCC_EXTENSION uint16_t u4PasidHi : 4; /**< Bits 19:16 - PASID: Process Address-Space ID (Hi). */
964 RT_GCC_EXTENSION uint16_t u12Rsvd0 : 12; /**< Bits 31:20 - Reserved. */
965 uint16_t u16PasidLo; /**< Bits 47:32 - PASID: Process Address-Space ID (Lo). */
966 RT_GCC_EXTENSION uint16_t u1GuestOrNested : 1; /**< Bit 48 - GN: Guest (GPA) or Nested (GVA). */
967 RT_GCC_EXTENSION uint16_t u2Rsvd0 : 2; /**< Bits 50:49 - Reserved. */
968 RT_GCC_EXTENSION uint16_t u1Interrupt : 1; /**< Bit 51 - I: Interrupt. */
969 RT_GCC_EXTENSION uint16_t u1Rsvd0 : 1; /**< Bit 52 - Reserved. */
970 RT_GCC_EXTENSION uint16_t u1ReadWrite : 1; /**< Bit 53 - RW: Read/Write. */
971 RT_GCC_EXTENSION uint16_t u1Rsvd1 : 1; /**< Bit 54 - Reserved. */
972 RT_GCC_EXTENSION uint16_t u1RsvdNotZero : 1; /**< Bit 55 - RZ: Reserved bit not Zero (0=invalid level encoding). */
973 RT_GCC_EXTENSION uint16_t u1Translation : 1; /**< Bit 56 - TN: Translation. */
974 RT_GCC_EXTENSION uint16_t u3Rsvd0 : 3; /**< Bits 59:57 - Reserved. */
975 RT_GCC_EXTENSION uint16_t u4EvtCode : 4; /**< Bits 63:60 - Event code. */
976 uint64_t u64Addr; /**< Bits 127:64 - Address: I/O Virtual Address (IOVA). */
977 } n;
978 /** The 32-bit unsigned integer view. */
979 uint32_t au32[4];
980 /** The 64-bit unsigned integer view. */
981 uint64_t au64[2];
982} EVT_ILLEGAL_DTE_T;
983AssertCompileSize(EVT_ILLEGAL_DTE_T, 16);
984/** Pointer to an illegal device table entry event. */
985typedef EVT_ILLEGAL_DTE_T *PEVT_ILLEGAL_DTE_T;
986/** Pointer to a const illegal device table entry event. */
987typedef EVT_ILLEGAL_DTE_T const *PCEVT_ILLEGAL_DTE_T;
988
989/**
990 * Event Log Entry: IO_PAGE_FAULT_EVENT.
991 * In accordance with the AMD spec.
992 */
993typedef union
994{
995 struct
996 {
997 uint16_t u16DevId; /**< Bits 15:0 - Device ID. */
998 RT_GCC_EXTENSION uint16_t u4PasidHi : 4; /**< Bits 19:16 - PASID: Process Address-Space ID (Hi). */
999 RT_GCC_EXTENSION uint16_t u16DomainOrPasidLo; /**< Bits 47:32 - D/P: Domain ID or Process Address-Space ID (Lo). */
1000 RT_GCC_EXTENSION uint16_t u1GuestOrNested : 1; /**< Bit 48 - GN: Guest (GPA) or Nested (GVA). */
1001 RT_GCC_EXTENSION uint16_t u1NoExecute : 1; /**< Bit 49 - NX: No Execute. */
1002 RT_GCC_EXTENSION uint16_t u1User : 1; /**< Bit 50 - US: User/Supervisor. */
1003 RT_GCC_EXTENSION uint16_t u1Interrupt : 1; /**< Bit 51 - I: Interrupt. */
1004 RT_GCC_EXTENSION uint16_t u1Present : 1; /**< Bit 52 - PR: Present. */
1005 RT_GCC_EXTENSION uint16_t u1ReadWrite : 1; /**< Bit 53 - RW: Read/Write. */
1006 RT_GCC_EXTENSION uint16_t u1PermDenied : 1; /**< Bit 54 - PE: Permission Indicator. */
1007 RT_GCC_EXTENSION uint16_t u1RsvdNotZero : 1; /**< Bit 55 - RZ: Reserved bit not Zero (0=invalid level encoding). */
1008 RT_GCC_EXTENSION uint16_t u1Translation : 1; /**< Bit 56 - TN: Translation. */
1009 RT_GCC_EXTENSION uint16_t u3Rsvd0 : 3; /**< Bit 59:57 - Reserved. */
1010 RT_GCC_EXTENSION uint16_t u4EvtCode : 4; /**< Bits 63:60 - Event code. */
1011 uint64_t u64Addr; /**< Bits 127:64 - Address: I/O Virtual Address (IOVA). */
1012 } n;
1013 /** The 32-bit unsigned integer view. */
1014 uint32_t au32[4];
1015 /** The 64-bit unsigned integer view. */
1016 uint64_t au64[2];
1017} EVT_IO_PAGE_FAULT_T;
1018AssertCompileSize(EVT_IO_PAGE_FAULT_T, 16);
1019/** Pointer to an I/O page fault event. */
1020typedef EVT_IO_PAGE_FAULT_T *PEVT_IO_PAGE_FAULT_T;
1021/** Pointer to a const I/O page fault event. */
1022typedef EVT_IO_PAGE_FAULT_T const *PCEVT_IO_PAGE_FAULT_T;
1023
1024
1025/**
1026 * Event Log Entry: DEV_TAB_HARDWARE_ERROR.
1027 * In accordance with the AMD spec.
1028 */
1029typedef union
1030{
1031 struct
1032 {
1033 uint16_t u16DevId; /**< Bits 15:0 - Device ID. */
1034 uint16_t u16Rsvd0; /**< Bits 31:16 - Reserved. */
1035 uint32_t u19Rsvd0 : 19; /**< Bits 50:32 - Reserved. */
1036 uint32_t u1Intr : 1; /**< Bit 51 - I: Interrupt (1=interrupt request, 0=memory request). */
1037 uint32_t u1Rsvd0 : 1; /**< Bit 52 - Reserved. */
1038 uint32_t u1ReadWrite : 1; /**< Bit 53 - RW: Read/Write transaction (only meaninful when I=0 and TR=0). */
1039 uint32_t u2Rsvd0 : 2; /**< Bits 55:54 - Reserved. */
1040 uint32_t u1Translation : 1; /**< Bit 56 - TR: Translation (1=translation, 0=transaction). */
1041 uint32_t u2Type : 2; /**< Bits 58:57 - Type: The type of hardware error. */
1042 uint32_t u1Rsvd1 : 1; /**< Bit 59 - Reserved. */
1043 uint32_t u4EvtCode : 4; /**< Bits 63:60 - Event code. */
1044 uint64_t u64Addr; /**< Bits 127:64 - Address. */
1045 } n;
1046 /** The 32-bit unsigned integer view. */
1047 uint32_t au32[4];
1048 /** The 64-bit unsigned integer view. */
1049 uint64_t au64[2];
1050} EVT_DEV_TAB_HW_ERROR_T;
1051AssertCompileSize(EVT_DEV_TAB_HW_ERROR_T, 16);
1052/** Pointer to a device table hardware error event. */
1053typedef EVT_DEV_TAB_HW_ERROR_T *PEVT_DEV_TAB_HW_ERROR_T;
1054/** Pointer to a const device table hardware error event. */
1055typedef EVT_DEV_TAB_HW_ERROR_T const *PCEVT_DEV_TAB_HW_ERROR_T;
1056
1057/**
1058 * Event Log Entry: EVT_PAGE_TAB_HARDWARE_ERROR.
1059 * In accordance with the AMD spec.
1060 */
1061typedef union
1062{
1063 struct
1064 {
1065 uint16_t u16DevId; /**< Bits 15:0 - Device ID. */
1066 uint16_t u16Rsvd0; /**< Bits 31:16 - Reserved. */
1067 uint32_t u16DomainOrPasidLo : 16; /**< Bits 47:32 - D/P: Domain ID or Process Address-Space ID (Lo). */
1068 uint32_t u1GuestOrNested : 1; /**< Bit 48 - GN: Guest (GPA) or Nested (GVA). */
1069 uint32_t u2Rsvd0 : 2; /**< Bits 50:49 - Reserved. */
1070 uint32_t u1Interrupt : 1; /**< Bit 51 - I: Interrupt. */
1071 uint32_t u1Rsvd0 : 1; /**< Bit 52 - Reserved. */
1072 uint32_t u1ReadWrite : 1; /**< Bit 53 - RW: Read/Write. */
1073 uint32_t u2Rsvd1 : 2; /**< Bit 55:54 - Reserved. */
1074 uint32_t u1Translation : 1; /**< Bit 56 - TR: Translation. */
1075 uint32_t u2Type : 2; /**< Bits 58:57 - Type: The type of hardware error. */
1076 uint32_t u1Rsvd1 : 1; /**< Bit 59 - Reserved. */
1077 uint32_t u4EvtCode : 4; /**< Bit 63:60 - Event code. */
1078 /** @todo r=ramshankar: Figure 55: PAGE_TAB_HARDWARE_ERROR says Addr[31:3] but
1079 * table 58 mentions Addr[31:4], we just use the full 64-bits. Looks like a
1080 * typo in the figure.See AMD AMD IOMMU spec (3.05-PUB, Jan 2020). */
1081 uint64_t u64Addr; /** Bits 127:64 - Address: SPA of the page table entry. */
1082 } n;
1083 /** The 32-bit unsigned integer view. */
1084 uint32_t au32[4];
1085 /** The 64-bit unsigned integer view. */
1086 uint64_t au64[2];
1087} EVT_PAGE_TAB_HW_ERR_T;
1088AssertCompileSize(EVT_PAGE_TAB_HW_ERR_T, 16);
1089/** Pointer to a page table hardware error event. */
1090typedef EVT_PAGE_TAB_HW_ERR_T *PEVT_PAGE_TAB_HW_ERR_T;
1091/** Pointer to a const page table hardware error event. */
1092typedef EVT_PAGE_TAB_HW_ERR_T const *PCEVT_PAGE_TAB_HW_ERR_T;
1093
1094/**
1095 * Event Log Entry: ILLEGAL_COMMAND_ERROR.
1096 * In accordance with the AMD spec.
1097 */
1098typedef union
1099{
1100 struct
1101 {
1102 uint32_t u32Rsvd0; /**< Bits 31:0 - Reserved. */
1103 uint32_t u28Rsvd0 : 28; /**< Bits 47:32 - Reserved. */
1104 uint32_t u4EvtCode : 4; /**< Bits 63:60 - Event code. */
1105 uint64_t u64Addr; /**< Bits 127:64 - Address: SPA of the invalid command. */
1106 } n;
1107 /** The 32-bit unsigned integer view. */
1108 uint32_t au32[4];
1109 /** The 64-bit unsigned integer view. */
1110 uint64_t au64[2];
1111} EVT_ILLEGAL_CMD_ERR_T;
1112AssertCompileSize(EVT_ILLEGAL_CMD_ERR_T, 16);
1113/** Pointer to an illegal command error event. */
1114typedef EVT_ILLEGAL_CMD_ERR_T *PEVT_ILLEGAL_CMD_ERR_T;
1115/** Pointer to a const illegal command error event. */
1116typedef EVT_ILLEGAL_CMD_ERR_T const *PCEVT_ILLEGAL_CMD_ERR_T;
1117
1118/**
1119 * Event Log Entry: COMMAND_HARDWARE_ERROR.
1120 * In accordance with the AMD spec.
1121 */
1122typedef union
1123{
1124 struct
1125 {
1126 uint32_t u32Rsvd0; /**< Bits 31:0 - Reserved. */
1127 uint32_t u25Rsvd1 : 25; /**< Bits 56:32 - Reserved. */
1128 uint32_t u2Type : 2; /**< Bits 58:57 - Type: The type of hardware error. */
1129 uint32_t u1Rsvd1 : 1; /**< Bit 59 - Reserved. */
1130 uint32_t u4EvtCode : 4; /**< Bits 63:60 - Event code. */
1131 uint64_t u64Addr; /**< Bits 128:64 - Address: SPA of the attempted access. */
1132 } n;
1133 /** The 32-bit unsigned integer view. */
1134 uint32_t au32[4];
1135 /** The 64-bit unsigned integer view. */
1136 uint64_t au64[2];
1137} EVT_CMD_HW_ERR_T;
1138AssertCompileSize(EVT_CMD_HW_ERR_T, 16);
1139/** Pointer to a command hardware error event. */
1140typedef EVT_CMD_HW_ERR_T *PEVT_CMD_HW_ERR_T;
1141/** Pointer to a const command hardware error event. */
1142typedef EVT_CMD_HW_ERR_T const *PCEVT_CMD_HW_ERR_T;
1143
1144/**
1145 * Event Log Entry: IOTLB_INV_TIMEOUT.
1146 * In accordance with the AMD spec.
1147 */
1148typedef union
1149{
1150 struct
1151 {
1152 uint16_t u16DevId; /**< Bits 15:0 - Device ID. */
1153 uint16_t u16Rsvd0; /**< Bits 31:16 - Reserved.*/
1154 uint32_t u28Rsvd0 : 28; /**< Bits 59:32 - Reserved. */
1155 uint32_t u4EvtCode : 4; /**< Bits 63:60 - Event code. */
1156 uint32_t u4Rsvd0 : 4; /**< Bits 67:64 - Reserved. */
1157 uint32_t u28AddrLo : 28; /**< Bits 95:68 - Address: SPA of the invalidation command that timedout (Lo). */
1158 uint32_t u32AddrHi; /**< Bits 127:96 - Address: SPA of the invalidation command that timedout (Hi). */
1159 } n;
1160 /** The 32-bit unsigned integer view. */
1161 uint32_t au32[4];
1162} EVT_IOTLB_INV_TIMEOUT_T;
1163AssertCompileSize(EVT_IOTLB_INV_TIMEOUT_T, 16);
1164
1165/**
1166 * Event Log Entry: INVALID_DEVICE_REQUEST.
1167 * In accordance with the AMD spec.
1168 */
1169typedef union
1170{
1171 struct
1172 {
1173 uint32_t u16DevId : 16; /***< Bits 15:0 - Device ID. */
1174 uint32_t u4PasidHi : 4; /***< Bits 19:16 - PASID: Process Address-Space ID (Hi). */
1175 uint32_t u12Rsvd0 : 12; /***< Bits 31:20 - Reserved. */
1176 uint32_t u16PasidLo : 16; /***< Bits 47:32 - PASID: Process Address-Space ID (Lo). */
1177 uint32_t u1GuestOrNested : 1; /***< Bit 48 - GN: Guest (GPA) or Nested (GVA). */
1178 uint32_t u1User : 1; /***< Bit 49 - US: User/Supervisor. */
1179 uint32_t u6Rsvd0 : 6; /***< Bits 55:50 - Reserved. */
1180 uint32_t u1Translation: 1; /***< Bit 56 - TR: Translation. */
1181 uint32_t u3Type: 3; /***< Bits 59:57 - Type: The type of hardware error. */
1182 uint32_t u4EvtCode : 4; /***< Bits 63:60 - Event code. */
1183 uint64_t u64Addr; /***< Bits 127:64 - Address: Translation or access address. */
1184 } n;
1185 /** The 32-bit unsigned integer view. */
1186 uint32_t au32[4];
1187} EVT_INVALID_DEV_REQ_T;
1188AssertCompileSize(EVT_INVALID_DEV_REQ_T, 16);
1189
1190/**
1191 * Event Log Entry: EVENT_COUNTER_ZERO.
1192 * In accordance with the AMD spec.
1193 */
1194typedef union
1195{
1196 struct
1197 {
1198 uint32_t u32Rsvd0; /**< Bits 31:0 - Reserved. */
1199 uint32_t u28Rsvd0 : 28; /**< Bits 59:32 - Reserved. */
1200 uint32_t u4EvtCode : 4; /**< Bits 63:60 - Event code. */
1201 uint32_t u20CounterNoteHi : 20; /**< Bits 83:64 - CounterNote: Counter value for the event counter register (Hi). */
1202 uint32_t u12Rsvd0 : 12; /**< Bits 95:84 - Reserved. */
1203 uint32_t u32CounterNoteLo; /**< Bits 127:96 - CounterNote: Counter value for the event cuonter register (Lo). */
1204 } n;
1205 /** The 32-bit unsigned integer view. */
1206 uint32_t au32[4];
1207} EVT_EVENT_COUNTER_ZERO_T;
1208AssertCompileSize(EVT_EVENT_COUNTER_ZERO_T, 16);
1209
1210/**
1211 * IOMMU Capability Header (PCI).
1212 * In accordance with the AMD spec.
1213 */
1214typedef union
1215{
1216 struct
1217 {
1218 uint32_t u8CapId : 8; /**< Bits 7:0 - CapId: Capability ID. */
1219 uint32_t u8CapPtr : 8; /**< Bits 15:8 - CapPtr: Pointer (PCI config offset) to the next capability. */
1220 uint32_t u3CapType : 3; /**< Bits 18:16 - CapType: Capability Type. */
1221 uint32_t u5CapRev : 5; /**< Bits 23:19 - CapRev: Capability revision. */
1222 uint32_t u1IoTlbSup : 1; /**< Bit 24 - IotlbSup: IOTLB Support. */
1223 uint32_t u1HtTunnel : 1; /**< Bit 25 - HtTunnel: HyperTransport Tunnel translation support. */
1224 uint32_t u1NpCache : 1; /**< Bit 26 - NpCache: Not Present table entries are cached. */
1225 uint32_t u1EfrSup : 1; /**< Bit 27 - EFRSup: Extended Feature Register Support. */
1226 uint32_t u1CapExt : 1; /**< Bit 28 - CapExt: Misc. Information Register 1 Support. */
1227 uint32_t u3Rsvd0 : 3; /**< Bits 31:29 - Reserved. */
1228 } n;
1229 /** The 32-bit unsigned integer view. */
1230 uint32_t u32;
1231} IOMMU_CAP_HDR_T;
1232AssertCompileSize(IOMMU_CAP_HDR_T, 4);
1233
1234/**
1235 * IOMMU Base Address (Lo and Hi) Register (PCI).
1236 * In accordance with the AMD spec.
1237 */
1238typedef union
1239{
1240 struct
1241 {
1242 uint32_t u1Enable : 1; /**< Bit 1 - Enable: RW1S - Enable IOMMU MMIO region. */
1243 uint32_t u12Rsvd0 : 12; /**< Bits 13:1 - Reserved. */
1244 uint32_t u18BaseAddrLo : 18; /**< Bits 31:14 - Base address (Lo) of the MMIO region. */
1245 uint32_t u32BaseAddrHi; /**< Bits 63:32 - Base address (Hi) of the MMIO region. */
1246 } n;
1247 /** The 32-bit unsigned integer view. */
1248 uint32_t au32[2];
1249 /** The 64-bit unsigned integer view. */
1250 uint64_t u64;
1251} IOMMU_BAR_T;
1252AssertCompileSize(IOMMU_BAR_T, 8);
1253#define IOMMU_BAR_VALID_MASK UINT64_C(0xffffffffffffc001)
1254
1255/**
1256 * IOMMU Range Register (PCI).
1257 * In accordance with the AMD spec.
1258 */
1259typedef union
1260{
1261 struct
1262 {
1263 uint32_t u5HtUnitId : 5; /**< Bits 4:0 - UnitID: IOMMU HyperTransport Unit ID (not used). */
1264 uint32_t u2Rsvd0 : 2; /**< Bits 6:5 - Reserved. */
1265 uint32_t u1RangeValid : 1; /**< Bit 7 - RngValid: Range Valid. */
1266 uint32_t u8Bus : 8; /**< Bits 15:8 - BusNumber: Bus number of the first and last device. */
1267 uint32_t u8FirstDevice : 8; /**< Bits 23:16 - FirstDevice: Device and function number of the first device. */
1268 uint32_t u8LastDevice: 8; /**< Bits 31:24 - LastDevice: Device and function number of the last device. */
1269 } n;
1270 /** The 32-bit unsigned integer view. */
1271 uint32_t u32;
1272} IOMMU_RANGE_T;
1273AssertCompileSize(IOMMU_RANGE_T, 4);
1274
1275/**
1276 * Device Table Base Address Register (MMIO).
1277 * In accordance with the AMD spec.
1278 */
1279typedef union
1280{
1281 struct
1282 {
1283 RT_GCC_EXTENSION uint64_t u9Size : 9; /**< Bits 8:0 - Size: Size of the device table. */
1284 RT_GCC_EXTENSION uint64_t u3Rsvd0 : 3; /**< Bits 11:9 - Reserved. */
1285 RT_GCC_EXTENSION uint64_t u40Base : 40; /**< Bits 51:12 - DevTabBase: Device table base address. */
1286 RT_GCC_EXTENSION uint64_t u12Rsvd0 : 12; /**< Bits 63:52 - Reserved. */
1287 } n;
1288 /** The 64-bit unsigned integer view. */
1289 uint64_t u64;
1290} DEV_TAB_BAR_T;
1291AssertCompileSize(DEV_TAB_BAR_T, 8);
1292#define IOMMU_DEV_TAB_BAR_VALID_MASK UINT64_C(0x000ffffffffff1ff)
1293#define IOMMU_DEV_TAB_SEG_BAR_VALID_MASK UINT64_C(0x000ffffffffff0ff)
1294
1295/**
1296 * Command Buffer Base Address Register (MMIO).
1297 * In accordance with the AMD spec.
1298 */
1299typedef union
1300{
1301 struct
1302 {
1303 RT_GCC_EXTENSION uint64_t u12Rsvd0 : 12; /**< Bits 11:0 - Reserved. */
1304 RT_GCC_EXTENSION uint64_t u40Base : 40; /**< Bits 51:12 - ComBase: Command buffer base address. */
1305 RT_GCC_EXTENSION uint64_t u4Rsvd0 : 4; /**< Bits 55:52 - Reserved. */
1306 RT_GCC_EXTENSION uint64_t u4Len : 4; /**< Bits 59:56 - ComLen: Command buffer length. */
1307 RT_GCC_EXTENSION uint64_t u4Rsvd1 : 4; /**< Bits 63:60 - Reserved. */
1308 } n;
1309 /** The 64-bit unsigned integer view. */
1310 uint64_t u64;
1311} CMD_BUF_BAR_T;
1312AssertCompileSize(CMD_BUF_BAR_T, 8);
1313#define IOMMU_CMD_BUF_BAR_VALID_MASK UINT64_C(0x0f0ffffffffff000)
1314
1315/**
1316 * Event Log Base Address Register (MMIO).
1317 * In accordance with the AMD spec.
1318 */
1319typedef union
1320{
1321 struct
1322 {
1323 RT_GCC_EXTENSION uint64_t u12Rsvd0 : 12; /**< Bits 11:0 - Reserved. */
1324 RT_GCC_EXTENSION uint64_t u40Base : 40; /**< Bits 51:12 - EventBase: Event log base address. */
1325 RT_GCC_EXTENSION uint64_t u4Rsvd0 : 4; /**< Bits 55:52 - Reserved. */
1326 RT_GCC_EXTENSION uint64_t u4Len : 4; /**< Bits 59:56 - EventLen: Event log length. */
1327 RT_GCC_EXTENSION uint64_t u4Rsvd1 : 4; /**< Bits 63:60 - Reserved. */
1328 } n;
1329 /** The 64-bit unsigned integer view. */
1330 uint64_t u64;
1331} EVT_LOG_BAR_T;
1332AssertCompileSize(EVT_LOG_BAR_T, 8);
1333#define IOMMU_EVT_LOG_BAR_VALID_MASK UINT64_C(0x0f0ffffffffff000)
1334
1335/**
1336 * IOMMU Control Register (MMIO).
1337 * In accordance with the AMD spec.
1338 */
1339typedef union
1340{
1341 struct
1342 {
1343 uint32_t u1IommuEn : 1; /**< Bit 0 - IommuEn: IOMMU Enable. */
1344 uint32_t u1HtTunEn : 1; /**< Bit 1 - HtTunEn: HyperTransport Tunnel Enable. */
1345 uint32_t u1EvtLogEn : 1; /**< Bit 2 - EventLogEn: Event Log Enable. */
1346 uint32_t u1EvtIntrEn : 1; /**< Bit 3 - EventIntEn: Event Log Interrupt Enable. */
1347 uint32_t u1CompWaitIntrEn : 1; /**< Bit 4 - ComWaitIntEn: Completion Wait Interrupt Enable. */
1348 uint32_t u3InvTimeOut : 3; /**< Bits 7:5 - InvTimeOut: Invalidation Timeout. */
1349 uint32_t u1PassPW : 1; /**< Bit 8 - PassPW: Pass Posted Write. */
1350 uint32_t u1ResPassPW : 1; /**< Bit 9 - ResPassPW: Response Pass Posted Write. */
1351 uint32_t u1Coherent : 1; /**< Bit 10 - Coherent: HT read request packet Coherent bit. */
1352 uint32_t u1Isoc : 1; /**< Bit 11 - Isoc: HT read request packet Isochronous bit. */
1353 uint32_t u1CmdBufEn : 1; /**< Bit 12 - CmdBufEn: Command Buffer Enable. */
1354 uint32_t u1PprLogEn : 1; /**< Bit 13 - PprLogEn: Peripheral Page Request (PPR) Log Enable. */
1355 uint32_t u1PprIntrEn : 1; /**< Bit 14 - PprIntrEn: Peripheral Page Request Interrupt Enable. */
1356 uint32_t u1PprEn : 1; /**< Bit 15 - PprEn: Peripheral Page Request processing Enable. */
1357 uint32_t u1GstTranslateEn : 1; /**< Bit 16 - GTEn: Guest Translate Enable. */
1358 uint32_t u1GstVirtApicEn : 1; /**< Bit 17 - GAEn: Guest Virtual-APIC Enable. */
1359 uint32_t u4Crw : 1; /**< Bits 21:18 - CRW: Intended for future use (not documented). */
1360 uint32_t u1SmiFilterEn : 1; /**< Bit 22 - SmiFEn: SMI Filter Enable. */
1361 uint32_t u1SelfWriteBackDis : 1; /**< Bit 23 - SlfWBDis: Self Write-Back Disable. */
1362 uint32_t u1SmiFilterLogEn : 1; /**< Bit 24 - SmiFLogEn: SMI Filter Log Enable. */
1363 uint32_t u3GstVirtApicModeEn : 3; /**< Bits 27:25 - GAMEn: Guest Virtual-APIC Mode Enable. */
1364 uint32_t u1GstLogEn : 1; /**< Bit 28 - GALogEn: Guest Virtual-APIC GA Log Enable. */
1365 uint32_t u1GstIntrEn : 1; /**< Bit 29 - GAIntEn: Guest Virtual-APIC Interrupt Enable. */
1366 uint32_t u2DualPprLogEn : 2; /**< Bits 31:30 - DualPprLogEn: Dual Peripheral Page Request Log Enable. */
1367 uint32_t u2DualEvtLogEn : 2; /**< Bits 33:32 - DualEventLogEn: Dual Event Log Enable. */
1368 uint32_t u3DevTabSegEn : 3; /**< Bits 36:34 - DevTblSegEn: Device Table Segment Enable. */
1369 uint32_t u2PrivAbortEn : 2; /**< Bits 38:37 - PrivAbrtEn: Privilege Abort Enable. */
1370 uint32_t u1PprAutoRespEn : 1; /**< Bit 39 - PprAutoRspEn: Peripheral Page Request Auto Response Enable. */
1371 uint32_t u1MarcEn : 1; /**< Bit 40 - MarcEn: Memory Address Routing and Control Enable. */
1372 uint32_t u1BlockStopMarkEn : 1; /**< Bit 41 - BlkStopMarkEn: Block StopMark messages Enable. */
1373 uint32_t u1PprAutoRespAlwaysOnEn : 1; /**< Bit 42 - PprAutoRspAon:: PPR Auto Response - Always On Enable. */
1374 uint32_t u1DomainIDPNE : 1; /**< Bit 43 - DomainIDPE: Reserved (not documented). */
1375 uint32_t u1Rsvd0 : 1; /**< Bit 44 - Reserved. */
1376 uint32_t u1EnhancedPpr : 1; /**< Bit 45 - EPHEn: Enhanced Peripheral Page Request Handling Enable. */
1377 uint32_t u2HstAccDirtyBitUpdate : 2; /**< Bits 47:46 - HADUpdate: Access and Dirty Bit updated in host page table. */
1378 uint32_t u1GstDirtyUpdateDis : 1; /**< Bit 48 - GDUpdateDis: Disable hardare update of Dirty bit in GPT. */
1379 uint32_t u1Rsvd1 : 1; /**< Bit 49 - Reserved. */
1380 uint32_t u1X2ApicEn : 1; /**< Bit 50 - XTEn: Enable X2APIC. */
1381 uint32_t u1X2ApicIntrGenEn : 1; /**< Bit 51 - IntCapXTEn: Enable IOMMU X2APIC Interrupt generation. */
1382 uint32_t u2Rsvd0 : 2; /**< Bits 53:52 - Reserved. */
1383 uint32_t u1GstAccessUpdateDis : 1; /**< Bit 54 - GAUpdateDis: Disable hardare update of Access bit in GPT. */
1384 uint32_t u8Rsvd0 : 8; /**< Bits 63:55 - Reserved. */
1385 } n;
1386 /** The 64-bit unsigned integer view. */
1387 uint64_t u64;
1388} IOMMU_CTRL_T;
1389AssertCompileSize(IOMMU_CTRL_T, 8);
1390#define IOMMU_CTRL_VALID_MASK UINT64_C(0x004defffffffffff)
1391#define IOMMU_CTRL_CMD_BUF_EN_MASK UINT64_C(0x0000000000001001)
1392
1393/**
1394 * IOMMU Exclusion Base Register (MMIO).
1395 * In accordance with the AMD spec.
1396 */
1397typedef union
1398{
1399 struct
1400 {
1401 RT_GCC_EXTENSION uint64_t u1ExclEnable : 1; /**< Bit 0 - ExEn: Exclusion Range Enable. */
1402 RT_GCC_EXTENSION uint64_t u1AllowAll : 1; /**< Bit 1 - Allow: Allow All Devices. */
1403 RT_GCC_EXTENSION uint64_t u10Rsvd0 : 10; /**< Bits 11:2 - Reserved. */
1404 RT_GCC_EXTENSION uint64_t u40ExclRangeBase : 40; /**< Bits 51:12 - Exclusion Range Base Address. */
1405 RT_GCC_EXTENSION uint64_t u12Rsvd0 : 12; /**< Bits 63:52 - Reserved. */
1406 } n;
1407 /** The 64-bit unsigned integer view. */
1408 uint64_t u64;
1409} IOMMU_EXCL_RANGE_BAR_T;
1410AssertCompileSize(IOMMU_EXCL_RANGE_BAR_T, 8);
1411#define IOMMU_EXCL_RANGE_BAR_VALID_MASK UINT64_C(0x000ffffffffff003)
1412
1413/**
1414 * IOMMU Exclusion Range Limit Register (MMIO).
1415 * In accordance with the AMD spec.
1416 */
1417typedef union
1418{
1419 struct
1420 {
1421 RT_GCC_EXTENSION uint64_t u52ExclLimit : 52; /**< Bits 51:0 - Exclusion Range Limit (last 12 bits are treated as 1s). */
1422 RT_GCC_EXTENSION uint64_t u12Rsvd1 : 12; /**< Bits 63:52 - Reserved. */
1423 } n;
1424 /** The 64-bit unsigned integer view. */
1425 uint64_t u64;
1426} IOMMU_EXCL_RANGE_LIMIT_T;
1427AssertCompileSize(IOMMU_EXCL_RANGE_LIMIT_T, 8);
1428#define IOMMU_EXCL_RANGE_LIMIT_VALID_MASK UINT64_C(0x000fffffffffffff)
1429
1430/**
1431 * IOMMU Extended Feature Register (MMIO).
1432 * In accordance with the AMD spec.
1433 */
1434typedef union
1435{
1436 struct
1437 {
1438 uint32_t u1PrefetchSup : 1; /**< Bit 0 - PreFSup: Prefetch Support. */
1439 uint32_t u1PprSup : 1; /**< Bit 1 - PPRSup: Peripheral Page Request Support. */
1440 uint32_t u1X2ApicSup : 1; /**< Bit 2 - XTSup: x2Apic Support. */
1441 uint32_t u1NoExecuteSup : 1; /**< Bit 3 - NXSup: No-Execute and Privilege Level Support. */
1442 uint32_t u1GstTranslateSup : 1; /**< Bit 4 - GTSup: Guest Translations (for GVAs) Support. */
1443 uint32_t u1Rsvd0 : 1; /**< Bit 5 - Reserved. */
1444 uint32_t u1InvAllSup : 1; /**< Bit 6 - IASup: Invalidate-All Support. */
1445 uint32_t u1GstVirtApicSup : 1; /**< Bit 7 - GASup: Guest Virtual-APIC Support. */
1446 uint32_t u1HwErrorSup : 1; /**< Bit 8 - HESup: Hardware Error registers Support. */
1447 uint32_t u1PerfCounterSup : 1; /**< Bit 9 - PCSup: Performance Counter Support. */
1448 uint32_t u2HostAddrTranslateSize : 2; /**< Bits 11:10 - HATS: Host Address Translation Size. */
1449 uint32_t u2GstAddrTranslateSize : 2; /**< Bits 13:12 - GATS: Guest Address Translation Size. */
1450 uint32_t u2GstCr3RootTblLevel : 2; /**< Bits 15:14 - GLXSup: Guest CR3 Root Table Level (Max) Size Support. */
1451 uint32_t u2SmiFilterSup : 2; /**< Bits 17:16 - SmiFSup: SMI Filter Register Support. */
1452 uint32_t u3SmiFilterCount : 3; /**< Bits 20:18 - SmiFRC: SMI Filter Register Count. */
1453 uint32_t u3GstVirtApicModeSup : 3; /**< Bits 23:21 - GAMSup: Guest Virtual-APIC Modes Supported. */
1454 uint32_t u2DualPprLogSup : 2; /**< Bits 25:24 - DualPprLogSup: Dual Peripheral Page Request Log Support. */
1455 uint32_t u2Rsvd0 : 2; /**< Bits 27:26 - Reserved. */
1456 uint32_t u2DualEvtLogSup : 2; /**< Bits 29:28 - DualEventLogSup: Dual Event Log Support. */
1457 uint32_t u2Rsvd1 : 2; /**< Bits 31:30 - Reserved. */
1458 uint32_t u5MaxPasidSup : 5; /**< Bits 36:32 - PASMax: Maximum PASID Supported. */
1459 uint32_t u1UserSupervisorSup : 1; /**< Bit 37 - USSup: User/Supervisor Page Protection Support. */
1460 uint32_t u2DevTabSegSup : 2; /**< Bits 39:38 - DevTlbSegSup: Segmented Device Table Support. */
1461 uint32_t u1PprLogOverflowWarn : 1; /**< Bit 40 - PprOvrflwEarlySup: PPR Log Overflow Early Warning Support. */
1462 uint32_t u1PprAutoRespSup : 1; /**< Bit 41 - PprAutoRspSup: PPR Automatic Response Support. */
1463 uint32_t u2MarcSup : 2; /**< Bit 43:42 - MarcSup: Memory Access Routing and Control Support. */
1464 uint32_t u1BlockStopMarkSup : 1; /**< Bit 44 - BlkStopMarkSup: Block StopMark messages Support. */
1465 uint32_t u1PerfOptSup : 1; /**< Bit 45 - PerfOptSup: IOMMU Performance Optimization Support. */
1466 uint32_t u1MsiCapMmioSup : 1; /**< Bit 46 - MsiCapMmioSup: MSI Capability Register MMIO Access Support. */
1467 uint32_t u1Rsvd1 : 1; /**< Bit 47 - Reserved. */
1468 uint32_t u1GstIoSup : 1; /**< Bit 48 - GIoSup: Guest I/O Protection Support. */
1469 uint32_t u1HostAccessSup : 1; /**< Bit 49 - HASup: Host Access Support. */
1470 uint32_t u1EnhancedPprSup : 1; /**< Bit 50 - EPHSup: Enhanced Peripheral Page Request Handling Support. */
1471 uint32_t u1AttrForwardSup : 1; /**< Bit 51 - AttrFWSup: Attribute Forward Support. */
1472 uint32_t u1HostDirtySup : 1; /**< Bit 52 - HDSup: Host Dirty Support. */
1473 uint32_t u1Rsvd2 : 1; /**< Bit 53 - Reserved. */
1474 uint32_t u1InvIoTlbTypeSup : 1; /**< Bit 54 - InvIotlbTypeSup: Invalidate IOTLB Type Support. */
1475 uint32_t u6Rsvd0 : 6; /**< Bit 60:55 - Reserved. */
1476 uint32_t u1GstUpdateDisSup : 1; /**< Bit 61 - GAUpdateDisSup: Disable hardware update on GPT Support. */
1477 uint32_t u1ForcePhysDstSup : 1; /**< Bit 62 - ForcePhyDestSup: Force Phys. Dst. Mode for Remapped Intr. */
1478 uint32_t u1Rsvd3 : 1; /**< Bit 63 - Reserved. */
1479 } n;
1480 /** The 64-bit unsigned integer view. */
1481 uint64_t u64;
1482} IOMMU_EXT_FEAT_T;
1483AssertCompileSize(IOMMU_EXT_FEAT_T, 8);
1484
1485/**
1486 * Peripheral Page Request Log Base Address Register (MMIO).
1487 * In accordance with the AMD spec.
1488 */
1489typedef union
1490{
1491 struct
1492 {
1493 RT_GCC_EXTENSION uint64_t u12Rsvd0 : 12; /**< Bit 11:0 - Reserved. */
1494 RT_GCC_EXTENSION uint64_t u40Base : 40; /**< Bits 51:12 - PPRLogBase: Peripheral Page Request Log Base Address. */
1495 RT_GCC_EXTENSION uint64_t u4Rsvd0 : 4; /**< Bits 55:52 - Reserved. */
1496 RT_GCC_EXTENSION uint64_t u4Len : 4; /**< Bits 59:56 - PPRLogLen: Peripheral Page Request Log Length. */
1497 RT_GCC_EXTENSION uint64_t u4Rsvd1 : 4; /**< Bits 63:60 - Reserved. */
1498 } n;
1499 /** The 64-bit unsigned integer view. */
1500 uint64_t u64;
1501} PPR_LOG_BAR_T;
1502AssertCompileSize(PPR_LOG_BAR_T, 8);
1503#define IOMMU_PPR_LOG_BAR_VALID_MASK UINT64_C(0x0f0ffffffffff000)
1504
1505/**
1506 * IOMMU Hardware Event Upper Register (MMIO).
1507 * In accordance with the AMD spec.
1508 */
1509typedef union
1510{
1511 struct
1512 {
1513 RT_GCC_EXTENSION uint64_t u60FirstOperand : 60; /**< Bits 59:0 - First event code dependent operand. */
1514 RT_GCC_EXTENSION uint64_t u4EvtCode : 4; /**< Bits 63:60 - Event Code. */
1515 } n;
1516 /** The 64-bit unsigned integer view. */
1517 uint64_t u64;
1518} IOMMU_HW_EVT_HI_T;
1519AssertCompileSize(IOMMU_HW_EVT_HI_T, 8);
1520
1521/**
1522 * IOMMU Hardware Event Lower Register (MMIO).
1523 * In accordance with the AMD spec.
1524 */
1525typedef uint64_t IOMMU_HW_EVT_LO_T;
1526
1527/**
1528 * IOMMU Hardware Event Status (MMIO).
1529 * In accordance with the AMD spec.
1530 */
1531typedef union
1532{
1533 struct
1534 {
1535 uint32_t u1Valid : 1; /**< Bit 0 - HEV: Hardware Event Valid. */
1536 uint32_t u1Overflow : 1; /**< Bit 1 - HEO: Hardware Event Overflow. */
1537 uint32_t u30Rsvd0 : 30; /**< Bits 31:2 - Reserved. */
1538 uint32_t u32Rsvd0; /**< Bits 63:32 - Reserved. */
1539 } n;
1540 /** The 64-bit unsigned integer view. */
1541 uint64_t u64;
1542} IOMMU_HW_EVT_STATUS_T;
1543AssertCompileSize(IOMMU_HW_EVT_STATUS_T, 8);
1544#define IOMMU_HW_EVT_STATUS_VALID_MASK UINT64_C(0x0000000000000003)
1545
1546/**
1547 * Guest Virtual-APIC Log Base Address Register (MMIO).
1548 * In accordance with the AMD spec.
1549 */
1550typedef union
1551{
1552 struct
1553 {
1554 RT_GCC_EXTENSION uint64_t u12Rsvd0 : 12; /**< Bit 11:0 - Reserved. */
1555 RT_GCC_EXTENSION uint64_t u40Base : 40; /**< Bits 51:12 - GALogBase: Guest Virtual-APIC Log Base Address. */
1556 RT_GCC_EXTENSION uint64_t u4Rsvd0 : 4; /**< Bits 55:52 - Reserved. */
1557 RT_GCC_EXTENSION uint64_t u4Len : 4; /**< Bits 59:56 - GALogLen: Guest Virtual-APIC Log Length. */
1558 RT_GCC_EXTENSION uint64_t u4Rsvd1 : 4; /**< Bits 63:60 - Reserved. */
1559 } n;
1560 /** The 64-bit unsigned integer view. */
1561 uint64_t u64;
1562} GALOG_BAR_T;
1563AssertCompileSize(GALOG_BAR_T, 8);
1564
1565/**
1566 * Guest Virtual-APIC Log Tail Address Register (MMIO).
1567 * In accordance with the AMD spec.
1568 */
1569typedef union
1570{
1571 struct
1572 {
1573 RT_GCC_EXTENSION uint64_t u3Rsvd0 : 3; /**< Bits 2:0 - Reserved. */
1574 RT_GCC_EXTENSION uint64_t u40GALogTailAddr : 48; /**< Bits 51:3 - GATAddr: Guest Virtual-APIC Tail Log Address. */
1575 RT_GCC_EXTENSION uint64_t u11Rsvd1 : 11; /**< Bits 63:52 - Reserved. */
1576 } n;
1577 /** The 64-bit unsigned integer view. */
1578 uint64_t u64;
1579} GALOG_TAIL_ADDR_T;
1580AssertCompileSize(GALOG_TAIL_ADDR_T, 8);
1581
1582/**
1583 * PPR Log B Base Address Register (MMIO).
1584 * In accordance with the AMD spec.
1585 * Currently identical to PPR_LOG_BAR_T.
1586 */
1587typedef PPR_LOG_BAR_T PPR_LOG_B_BAR_T;
1588
1589/**
1590 * Event Log B Base Address Register (MMIO).
1591 * In accordance with the AMD spec.
1592 * Currently identical to EVT_LOG_BAR_T.
1593 */
1594typedef EVT_LOG_BAR_T EVT_LOG_B_BAR_T;
1595
1596/**
1597 * Device-specific Feature Extension (DSFX) Register (MMIO).
1598 * In accordance with the AMD spec.
1599 */
1600typedef union
1601{
1602 struct
1603 {
1604 uint32_t u24DevSpecFeat : 24; /**< Bits 23:0 - DevSpecificFeatSupp: Implementation specific features. */
1605 uint32_t u4RevMinor : 4; /**< Bits 27:24 - RevMinor: Minor revision identifier. */
1606 uint32_t u4RevMajor : 4; /**< Bits 31:28 - RevMajor: Major revision identifier. */
1607 uint32_t u32Rsvd0; /**< Bits 63:32 - Reserved.*/
1608 } n;
1609 /** The 64-bit unsigned integer view. */
1610 uint64_t u64;
1611} DEV_SPECIFIC_FEAT_T;
1612AssertCompileSize(DEV_SPECIFIC_FEAT_T, 8);
1613
1614/**
1615 * Device-specific Control Extension (DSCX) Register (MMIO).
1616 * In accordance with the AMD spec.
1617 */
1618typedef union
1619{
1620 struct
1621 {
1622 uint32_t u24DevSpecCtrl : 24; /**< Bits 23:0 - DevSpecificFeatCntrl: Implementation specific control. */
1623 uint32_t u4RevMinor : 4; /**< Bits 27:24 - RevMinor: Minor revision identifier. */
1624 uint32_t u4RevMajor : 4; /**< Bits 31:28 - RevMajor: Major revision identifier. */
1625 uint32_t u32Rsvd0; /**< Bits 63:32 - Reserved.*/
1626 } n;
1627 /** The 64-bit unsigned integer view. */
1628 uint64_t u64;
1629} DEV_SPECIFIC_CTRL_T;
1630AssertCompileSize(DEV_SPECIFIC_CTRL_T, 8);
1631
1632/**
1633 * Device-specific Status Extension (DSSX) Register (MMIO).
1634 * In accordance with the AMD spec.
1635 */
1636typedef union
1637{
1638 struct
1639 {
1640 uint32_t u24DevSpecStatus : 24; /**< Bits 23:0 - DevSpecificFeatStatus: Implementation specific status. */
1641 uint32_t u4RevMinor : 4; /**< Bits 27:24 - RevMinor: Minor revision identifier. */
1642 uint32_t u4RevMajor : 4; /**< Bits 31:28 - RevMajor: Major revision identifier. */
1643 uint32_t u32Rsvd0; /**< Bits 63:32 - Reserved.*/
1644 } n;
1645 /** The 64-bit unsigned integer view. */
1646 uint64_t u64;
1647} DEV_SPECIFIC_STATUS_T;
1648AssertCompileSize(DEV_SPECIFIC_STATUS_T, 8);
1649
1650/**
1651 * MSI Information Register 0 and 1 (PCI) / MSI Vector Register 0 and 1 (MMIO).
1652 * In accordance with the AMD spec.
1653 */
1654typedef union
1655{
1656 struct
1657 {
1658 uint32_t u5MsiNumEvtLog : 5; /**< Bits 4:0 - MsiNum: Event Log MSI message number. */
1659 uint32_t u3GstVirtAddrSize: 3; /**< Bits 7:5 - GVAsize: Guest Virtual Address Size. */
1660 uint32_t u7PhysAddrSize : 7; /**< Bits 14:8 - PAsize: Physical Address Size. */
1661 uint32_t u7VirtAddrSize : 7; /**< Bits 21:15 - VAsize: Virtual Address Size. */
1662 uint32_t u1HtAtsResv: 1; /**< Bit 22 - HtAtsResv: HyperTransport ATS Response Address range Reserved. */
1663 uint32_t u4Rsvd0 : 4; /**< Bits 26:23 - Reserved. */
1664 uint32_t u5MsiNumPpr : 5; /**< Bits 31:27 - MsiNumPPR: Peripheral Page Request MSI message number. */
1665 uint32_t u5MsiNumGa : 5; /**< Bits 36:32 - MsiNumGa: MSI message number for guest virtual-APIC log. */
1666 uint32_t u27Rsvd0: 27; /**< Bits 63:37 - Reserved. */
1667 } n;
1668 /** The 32-bit unsigned integer view. */
1669 uint32_t au32[2];
1670 /** The 64-bit unsigned integer view. */
1671 uint64_t u64;
1672} MSI_MISC_INFO_T;
1673AssertCompileSize(MSI_MISC_INFO_T, 8);
1674/** MSI Vector Register 0 and 1 (MMIO). */
1675typedef MSI_MISC_INFO_T MSI_VECTOR_T;
1676/** Mask of valid bits in MSI Vector Register 1 (or high dword of MSI Misc.
1677 * info). */
1678#define IOMMU_MSI_VECTOR_1_VALID_MASK UINT32_C(0x1f)
1679
1680/**
1681 * MSI Capability Header Register (PCI + MMIO).
1682 * In accordance with the AMD spec.
1683 */
1684typedef union
1685{
1686 struct
1687 {
1688 uint32_t u8MsiCapId : 8; /**< Bits 7:0 - MsiCapId: Capability ID. */
1689 uint32_t u8MsiCapPtr : 8; /**< Bits 15:8 - MsiCapPtr: Pointer (PCI config offset) to the next capability. */
1690 uint32_t u1MsiEnable : 1; /**< Bit 16 - MsiEn: Message Signal Interrupt Enable. */
1691 uint32_t u3MsiMultiMessCap : 3; /**< Bits 19:17 - MsiMultMessCap: MSI Multi-Message Capability. */
1692 uint32_t u3MsiMultiMessEn : 3; /**< Bits 22:20 - MsiMultMessEn: MSI Multi-Message Enable. */
1693 uint32_t u1Msi64BitEn : 1; /**< Bit 23 - Msi64BitEn: MSI 64-bit Enable. */
1694 uint32_t u8Rsvd0 : 8; /**< Bits 31:24 - Reserved. */
1695 } n;
1696 /** The 32-bit unsigned integer view. */
1697 uint32_t u32;
1698} MSI_CAP_HDR_T;
1699AssertCompileSize(MSI_CAP_HDR_T, 4);
1700#define IOMMU_MSI_CAP_HDR_MSI_EN_MASK RT_BIT(16)
1701
1702/**
1703 * MSI Mapping Capability Header Register (PCI + MMIO).
1704 * In accordance with the AMD spec.
1705 */
1706typedef union
1707{
1708 struct
1709 {
1710 uint32_t u8MsiMapCapId : 8; /**< Bits 7:0 - MsiMapCapId: MSI Map capability ID. */
1711 uint32_t u8Rsvd0 : 8; /**< Bits 15:8 - Reserved. */
1712 uint32_t u1MsiMapEn : 1; /**< Bit 16 - MsiMapEn: MSI Map enable. */
1713 uint32_t u1MsiMapFixed : 1; /**< Bit 17 - MsiMapFixd: MSI Map fixed. */
1714 uint32_t u9Rsvd0 : 9; /**< Bits 26:18 - Reserved. */
1715 uint32_t u5MapCapType : 5; /**< Bits 31:27 - MsiMapCapType: MSI Mapping capability type. */
1716 } n;
1717 /** The 32-bit unsigned integer view. */
1718 uint32_t u32;
1719} MSI_MAP_CAP_HDR_T;
1720AssertCompileSize(MSI_MAP_CAP_HDR_T, 4);
1721
1722/**
1723 * Performance Optimization Control Register (MMIO).
1724 * In accordance with the AMD spec.
1725 */
1726typedef union
1727{
1728 struct
1729 {
1730 uint32_t u13Rsvd0 : 13; /**< Bits 12:0 - Reserved. */
1731 uint32_t u1PerfOptEn : 1; /**< Bit 13 - PerfOptEn: Performance Optimization Enable. */
1732 uint32_t u17Rsvd0 : 18; /**< Bits 31:14 - Reserved. */
1733 } n;
1734 /** The 32-bit unsigned integer view. */
1735 uint32_t u32;
1736} IOMMU_PERF_OPT_CTRL_T;
1737AssertCompileSize(IOMMU_PERF_OPT_CTRL_T, 4);
1738
1739/**
1740 * XT (x2APIC) IOMMU General Interrupt Control Register (MMIO).
1741 * In accordance with the AMD spec.
1742 */
1743typedef union
1744{
1745 struct
1746 {
1747 uint32_t u2Rsvd0 : 2; /**< Bits 1:0 - Reserved.*/
1748 uint32_t u1X2ApicIntrDstMode : 1; /**< Bit 2 - Destination Mode for general interrupt.*/
1749 uint32_t u4Rsvd0 : 4; /**< Bits 7:3 - Reserved.*/
1750 uint32_t u24X2ApicIntrDstLo : 24; /**< Bits 31:8 - Destination for general interrupt (Lo).*/
1751 uint32_t u8X2ApicIntrVector : 8; /**< Bits 39:32 - Vector for general interrupt.*/
1752 uint32_t u1X2ApicIntrDeliveryMode : 1; /**< Bit 40 - Delivery Mode for general interrupt.*/
1753 uint32_t u15Rsvd0 : 15; /**< Bits 55:41 - Reserved.*/
1754 uint32_t u7X2ApicIntrDstHi : 7; /**< Bits 63:56 - Destination for general interrupt (Hi) .*/
1755 } n;
1756 /** The 64-bit unsigned integer view. */
1757 uint64_t u64;
1758} IOMMU_XT_GEN_INTR_CTRL_T;
1759AssertCompileSize(IOMMU_XT_GEN_INTR_CTRL_T, 8);
1760
1761/**
1762 * XT (x2APIC) IOMMU General Interrupt Control Register (MMIO).
1763 * In accordance with the AMD spec.
1764 */
1765typedef union
1766{
1767 struct
1768 {
1769 uint32_t u2Rsvd0 : 2; /**< Bits 1:0 - Reserved.*/
1770 uint32_t u1X2ApicIntrDstMode : 1; /**< Bit 2 - Destination Mode for the interrupt.*/
1771 uint32_t u4Rsvd0 : 4; /**< Bits 7:3 - Reserved.*/
1772 uint32_t u24X2ApicIntrDstLo : 24; /**< Bits 31:8 - Destination for the interrupt (Lo).*/
1773 uint32_t u8X2ApicIntrVector : 8; /**< Bits 39:32 - Vector for the interrupt.*/
1774 uint32_t u1X2ApicIntrDeliveryMode : 1; /**< Bit 40 - Delivery Mode for the interrupt.*/
1775 uint32_t u15Rsvd0 : 15; /**< Bits 55:41 - Reserved.*/
1776 uint32_t u7X2ApicIntrDstHi : 7; /**< Bits 63:56 - Destination for the interrupt (Hi) .*/
1777 } n;
1778 /** The 64-bit unsigned integer view. */
1779 uint64_t u64;
1780} IOMMU_XT_INTR_CTRL_T;
1781AssertCompileSize(IOMMU_XT_INTR_CTRL_T, 8);
1782
1783/**
1784 * XT (x2APIC) IOMMU PPR Interrupt Control Register (MMIO).
1785 * In accordance with the AMD spec.
1786 * Currently identical to IOMMU_XT_INTR_CTRL_T.
1787 */
1788typedef IOMMU_XT_INTR_CTRL_T IOMMU_XT_PPR_INTR_CTRL_T;
1789
1790/**
1791 * XT (x2APIC) IOMMU GA (Guest Address) Log Control Register (MMIO).
1792 * In accordance with the AMD spec.
1793 * Currently identical to IOMMU_XT_INTR_CTRL_T.
1794 */
1795typedef IOMMU_XT_INTR_CTRL_T IOMMU_XT_GALOG_INTR_CTRL_T;
1796
1797/**
1798 * Memory Access and Routing Control (MARC) Aperture Base Register (MMIO).
1799 * In accordance with the AMD spec.
1800 */
1801typedef union
1802{
1803 struct
1804 {
1805 RT_GCC_EXTENSION uint64_t u12Rsvd0 : 12; /**< Bits 11:0 - Reserved. */
1806 RT_GCC_EXTENSION uint64_t u40MarcBaseAddr : 40; /**< Bits 51:12 - MarcBaseAddr: MARC Aperture Base Address. */
1807 RT_GCC_EXTENSION uint64_t u12Rsvd1 : 12; /**< Bits 63:52 - Reserved. */
1808 } n;
1809 /** The 64-bit unsigned integer view. */
1810 uint64_t u64;
1811} MARC_APER_BAR_T;
1812AssertCompileSize(MARC_APER_BAR_T, 8);
1813
1814/**
1815 * Memory Access and Routing Control (MARC) Relocation Register (MMIO).
1816 * In accordance with the AMD spec.
1817 */
1818typedef union
1819{
1820 struct
1821 {
1822 RT_GCC_EXTENSION uint64_t u1RelocEn : 1; /**< Bit 0 - RelocEn: Relocation Enabled. */
1823 RT_GCC_EXTENSION uint64_t u1ReadOnly : 1; /**< Bit 1 - ReadOnly: Whether only read-only acceses allowed. */
1824 RT_GCC_EXTENSION uint64_t u10Rsvd0 : 10; /**< Bits 11:2 - Reserved. */
1825 RT_GCC_EXTENSION uint64_t u40MarcRelocAddr : 40; /**< Bits 51:12 - MarcRelocAddr: MARC Aperture Relocation Address. */
1826 RT_GCC_EXTENSION uint64_t u12Rsvd1 : 12; /**< Bits 63:52 - Reserved. */
1827 } n;
1828 /** The 64-bit unsigned integer view. */
1829 uint64_t u64;
1830} MARC_APER_RELOC_T;
1831AssertCompileSize(MARC_APER_RELOC_T, 8);
1832
1833/**
1834 * Memory Access and Routing Control (MARC) Length Register (MMIO).
1835 * In accordance with the AMD spec.
1836 */
1837typedef union
1838{
1839 struct
1840 {
1841 RT_GCC_EXTENSION uint64_t u12Rsvd0 : 12; /**< Bits 11:0 - Reserved. */
1842 RT_GCC_EXTENSION uint64_t u40MarcLength : 40; /**< Bits 51:12 - MarcLength: MARC Aperture Length. */
1843 RT_GCC_EXTENSION uint64_t u12Rsvd1 : 12; /**< Bits 63:52 - Reserved. */
1844 } n;
1845 /** The 64-bit unsigned integer view. */
1846 uint64_t u64;
1847} MARC_APER_LEN_T;
1848
1849/**
1850 * Memory Access and Routing Control (MARC) Aperture Register.
1851 * This combines other registers to match the MMIO layout for convenient access.
1852 */
1853typedef struct
1854{
1855 MARC_APER_BAR_T Base;
1856 MARC_APER_RELOC_T Reloc;
1857 MARC_APER_LEN_T Length;
1858} MARC_APER_T;
1859AssertCompileSize(MARC_APER_T, 24);
1860
1861/**
1862 * IOMMU Reserved Register (MMIO).
1863 * In accordance with the AMD spec.
1864 * This register is reserved for hardware use (although RW?).
1865 */
1866typedef uint64_t IOMMU_RSVD_REG_T;
1867
1868/**
1869 * Command Buffer Head Pointer Register (MMIO).
1870 * In accordance with the AMD spec.
1871 */
1872typedef union
1873{
1874 struct
1875 {
1876 uint32_t off; /**< Bits 31:0 - Buffer pointer (offset; 16 byte aligned, 512 KB max). */
1877 uint32_t u32Rsvd0; /**< Bits 63:32 - Reserved. */
1878 } n;
1879 /** The 32-bit unsigned integer view. */
1880 uint32_t au32[2];
1881 /** The 64-bit unsigned integer view. */
1882 uint64_t u64;
1883} CMD_BUF_HEAD_PTR_T;
1884AssertCompileSize(CMD_BUF_HEAD_PTR_T, 8);
1885#define IOMMU_CMD_BUF_HEAD_PTR_VALID_MASK UINT64_C(0x000000000007fff0)
1886
1887/**
1888 * Command Buffer Tail Pointer Register (MMIO).
1889 * In accordance with the AMD spec.
1890 * Currently identical to CMD_BUF_HEAD_PTR_T.
1891 */
1892typedef CMD_BUF_HEAD_PTR_T CMD_BUF_TAIL_PTR_T;
1893#define IOMMU_CMD_BUF_TAIL_PTR_VALID_MASK IOMMU_CMD_BUF_HEAD_PTR_VALID_MASK
1894
1895/**
1896 * Event Log Head Pointer Register (MMIO).
1897 * In accordance with the AMD spec.
1898 * Currently identical to CMD_BUF_HEAD_PTR_T.
1899 */
1900typedef CMD_BUF_HEAD_PTR_T EVT_LOG_HEAD_PTR_T;
1901#define IOMMU_EVT_LOG_HEAD_PTR_VALID_MASK IOMMU_CMD_BUF_HEAD_PTR_VALID_MASK
1902
1903/**
1904 * Event Log Tail Pointer Register (MMIO).
1905 * In accordance with the AMD spec.
1906 * Currently identical to CMD_BUF_HEAD_PTR_T.
1907 */
1908typedef CMD_BUF_HEAD_PTR_T EVT_LOG_TAIL_PTR_T;
1909#define IOMMU_EVT_LOG_TAIL_PTR_VALID_MASK IOMMU_CMD_BUF_HEAD_PTR_VALID_MASK
1910
1911
1912/**
1913 * IOMMU Status Register (MMIO).
1914 * In accordance with the AMD spec.
1915 */
1916typedef union
1917{
1918 struct
1919 {
1920 uint32_t u1EvtOverflow : 1; /**< Bit 0 - EventOverflow: Event log overflow. */
1921 uint32_t u1EvtLogIntr : 1; /**< Bit 1 - EventLogInt: Event log interrupt. */
1922 uint32_t u1CompWaitIntr : 1; /**< Bit 2 - ComWaitInt: Completion wait interrupt . */
1923 uint32_t u1EvtLogRunning : 1; /**< Bit 3 - EventLogRun: Event logging is running. */
1924 uint32_t u1CmdBufRunning : 1; /**< Bit 4 - CmdBufRun: Command buffer is running. */
1925 uint32_t u1PprOverflow : 1; /**< Bit 5 - PprOverflow: Peripheral Page Request Log (PPR) overflow. */
1926 uint32_t u1PprIntr : 1; /**< Bit 6 - PprInt: PPR interrupt. */
1927 uint32_t u1PprLogRunning : 1; /**< Bit 7 - PprLogRun: PPR logging is running. */
1928 uint32_t u1GstLogRunning : 1; /**< Bit 8 - GALogRun: Guest virtual-APIC logging is running. */
1929 uint32_t u1GstLogOverflow : 1; /**< Bit 9 - GALOverflow: Guest virtual-APIC log overflow. */
1930 uint32_t u1GstLogIntr : 1; /**< Bit 10 - GAInt: Guest virtual-APIC log interrupt. */
1931 uint32_t u1PprOverflowB : 1; /**< Bit 11 - PprOverflowB: PPR log B overflow. */
1932 uint32_t u1PprLogActive : 1; /**< Bit 12 - PprLogActive: PPR log A is active. */
1933 uint32_t u2Rsvd0 : 2; /**< Bits 14:13 - Reserved. */
1934 uint32_t u1EvtOverflowB : 1; /**< Bit 15 - EvtOverflowB: Event log B overflow. */
1935 uint32_t u1EvtLogActive : 1; /**< Bit 16 - EvtLogActive: Event log A active. */
1936 uint32_t u1PprOverflowEarlyB : 1; /**< Bit 17 - PprOverflowEarlyB: PPR log B overflow early warning. */
1937 uint32_t u1PprOverflowEarly : 1; /**< Bit 18 - PprOverflowEarly: PPR log overflow early warning. */
1938 uint32_t u13Rsvd0 : 13; /**< Bits 31:19 - Reserved. */
1939 uint32_t u32Rsvd0; /**< Bits 63:32 - Reserved . */
1940 } n;
1941 /** The 32-bit unsigned integer view. */
1942 uint32_t au32[2];
1943 /** The 64-bit unsigned integer view. */
1944 uint64_t u64;
1945} IOMMU_STATUS_T;
1946AssertCompileSize(IOMMU_STATUS_T, 8);
1947#define IOMMU_STATUS_VALID_MASK UINT64_C(0x0000000000079fff)
1948#define IOMMU_STATUS_RW1C_MASK UINT64_C(0x0000000000068e67)
1949
1950/**
1951 * PPR Log Head Pointer Register (MMIO).
1952 * In accordance with the AMD spec.
1953 * Currently identical to CMD_BUF_HEAD_PTR_T.
1954 */
1955typedef CMD_BUF_HEAD_PTR_T PPR_LOG_HEAD_PTR_T;
1956
1957/**
1958 * PPR Log Tail Pointer Register (MMIO).
1959 * In accordance with the AMD spec.
1960 * Currently identical to CMD_BUF_HEAD_PTR_T.
1961 */
1962typedef CMD_BUF_HEAD_PTR_T PPR_LOG_TAIL_PTR_T;
1963
1964/**
1965 * Guest Virtual-APIC Log Head Pointer Register (MMIO).
1966 * In accordance with the AMD spec.
1967 */
1968typedef union
1969{
1970 struct
1971 {
1972 uint32_t u2Rsvd0 : 2; /**< Bits 2:0 - Reserved. */
1973 uint32_t u12GALogPtr : 12; /**< Bits 15:3 - Guest Virtual-APIC Log Head or Tail Pointer. */
1974 uint32_t u16Rsvd0 : 16; /**< Bits 31:16 - Reserved. */
1975 uint32_t u32Rsvd0; /**< Bits 63:32 - Reserved. */
1976 } n;
1977 /** The 32-bit unsigned integer view. */
1978 uint32_t au32[2];
1979 /** The 64-bit unsigned integer view. */
1980 uint64_t u64;
1981} GALOG_HEAD_PTR_T;
1982AssertCompileSize(GALOG_HEAD_PTR_T, 8);
1983
1984/**
1985 * Guest Virtual-APIC Log Tail Pointer Register (MMIO).
1986 * In accordance with the AMD spec.
1987 * Currently identical to GALOG_HEAD_PTR_T.
1988 */
1989typedef GALOG_HEAD_PTR_T GALOG_TAIL_PTR_T;
1990
1991/**
1992 * PPR Log B Head Pointer Register (MMIO).
1993 * In accordance with the AMD spec.
1994 * Currently identical to CMD_BUF_HEAD_PTR_T.
1995 */
1996typedef CMD_BUF_HEAD_PTR_T PPR_LOG_B_HEAD_PTR_T;
1997
1998/**
1999 * PPR Log B Tail Pointer Register (MMIO).
2000 * In accordance with the AMD spec.
2001 * Currently identical to CMD_BUF_HEAD_PTR_T.
2002 */
2003typedef CMD_BUF_HEAD_PTR_T PPR_LOG_B_TAIL_PTR_T;
2004
2005/**
2006 * Event Log B Head Pointer Register (MMIO).
2007 * In accordance with the AMD spec.
2008 * Currently identical to CMD_BUF_HEAD_PTR_T.
2009 */
2010typedef CMD_BUF_HEAD_PTR_T EVT_LOG_B_HEAD_PTR_T;
2011
2012/**
2013 * Event Log B Tail Pointer Register (MMIO).
2014 * In accordance with the AMD spec.
2015 * Currently identical to CMD_BUF_HEAD_PTR_T.
2016 */
2017typedef CMD_BUF_HEAD_PTR_T EVT_LOG_B_TAIL_PTR_T;
2018
2019/**
2020 * PPR Log Auto Response Register (MMIO).
2021 * In accordance with the AMD spec.
2022 */
2023typedef union
2024{
2025 struct
2026 {
2027 uint32_t u4AutoRespCode : 4; /**< Bits 3:0 - PprAutoRespCode: PPR log Auto Response Code. */
2028 uint32_t u1AutoRespMaskGen : 1; /**< Bit 4 - PprAutoRespMaskGn: PPR log Auto Response Mask Gen. */
2029 uint32_t u27Rsvd0 : 27; /**< Bits 31:5 - Reserved. */
2030 uint32_t u32Rsvd0; /**< Bits 63:32 - Reserved.*/
2031 } n;
2032 /** The 32-bit unsigned integer view. */
2033 uint32_t au32[2];
2034 /** The 64-bit unsigned integer view. */
2035 uint64_t u64;
2036} PPR_LOG_AUTO_RESP_T;
2037AssertCompileSize(PPR_LOG_AUTO_RESP_T, 8);
2038
2039/**
2040 * PPR Log Overflow Early Indicator Register (MMIO).
2041 * In accordance with the AMD spec.
2042 */
2043typedef union
2044{
2045 struct
2046 {
2047 uint32_t u15Threshold : 15; /**< Bits 14:0 - PprOvrflwEarlyThreshold: Overflow early indicator threshold. */
2048 uint32_t u15Rsvd0 : 15; /**< Bits 29:15 - Reserved. */
2049 uint32_t u1IntrEn : 1; /**< Bit 30 - PprOvrflwEarlyIntEn: Overflow early indicator interrupt enable. */
2050 uint32_t u1Enable : 1; /**< Bit 31 - PprOvrflwEarlyEn: Overflow early indicator enable. */
2051 uint32_t u32Rsvd0; /**< Bits 63:32 - Reserved. */
2052 } n;
2053 /** The 32-bit unsigned integer view. */
2054 uint32_t au32[2];
2055 /** The 64-bit unsigned integer view. */
2056 uint64_t u64;
2057} PPR_LOG_OVERFLOW_EARLY_T;
2058AssertCompileSize(PPR_LOG_OVERFLOW_EARLY_T, 8);
2059
2060/**
2061 * PPR Log B Overflow Early Indicator Register (MMIO).
2062 * In accordance with the AMD spec.
2063 * Currently identical to PPR_LOG_OVERFLOW_EARLY_T.
2064 */
2065typedef PPR_LOG_OVERFLOW_EARLY_T PPR_LOG_B_OVERFLOW_EARLY_T;
2066
2067/**
2068 * ILLEGAL_DEV_TABLE_ENTRY Event Types.
2069 * In accordance with the AMD spec.
2070 */
2071typedef enum EVT_ILLEGAL_DTE_TYPE_T
2072{
2073 kIllegalDteType_RsvdNotZero = 0,
2074 kIllegalDteType_RsvdIntTabLen,
2075 kIllegalDteType_RsvdIoCtl,
2076 kIllegalDteType_RsvdIntCtl
2077} EVT_ILLEGAL_DTE_TYPE_T;
2078
2079/**
2080 * ILLEGAL_DEV_TABLE_ENTRY Event Types.
2081 * In accordance with the AMD spec.
2082 */
2083typedef enum EVT_IO_PAGE_FAULT_TYPE_T
2084{
2085 /* Memory transaction. */
2086 kIoPageFaultType_DteRsvdPagingMode = 0,
2087 kIoPageFaultType_PteInvalidPageSize,
2088 kIoPageFaultType_PteInvalidLvlEncoding,
2089 kIoPageFaultType_SkippedLevelIovaNotZero,
2090 kIoPageFaultType_PteRsvdNotZero,
2091 kIoPageFaultType_PteValidNotSet,
2092 kIoPageFaultType_DteTranslationDisabled,
2093 kIoPageFaultType_PasidInvalidRange,
2094 kIoPageFaultType_PermDenied,
2095 kIoPageFaultType_UserSupervisor,
2096 /* Interrupt remapping */
2097 kIoPageFaultType_IrteAddrInvalid,
2098 kIoPageFaultType_IrteRsvdNotZero,
2099 kIoPageFaultType_IrteRemapEn,
2100 kIoPageFaultType_IrteRsvdIntType,
2101 kIoPageFaultType_IntrReqAborted,
2102 kIoPageFaultType_IntrWithPasid,
2103 kIoPageFaultType_SmiFilterMismatch,
2104 /* Memory transaction or interrupt remapping. */
2105 kIoPageFaultType_DevId_Invalid
2106} EVT_IO_PAGE_FAULT_TYPE_T;
2107
2108/**
2109 * IOTLB_INV_TIMEOUT Event Types.
2110 * In accordance with the AMD spec.
2111 */
2112typedef enum EVT_IOTLB_INV_TIMEOUT_TYPE_T
2113{
2114 InvTimeoutType_NoResponse = 0
2115} EVT_IOTLB_INV_TIMEOUT_TYPE_T;
2116
2117/**
2118 * INVALID_DEVICE_REQUEST Event Types.
2119 * In accordance with the AMD spec.
2120 */
2121typedef enum EVT_INVALID_DEV_REQ_TYPE_T
2122{
2123 /* Access. */
2124 kInvalidDevReqType_ReadOrNonPostedWrite = 0,
2125 kInvalidDevReqType_PretranslatedTransaction,
2126 kInvalidDevReqType_PortIo,
2127 kInvalidDevReqType_SysMgt,
2128 kInvalidDevReqType_IntrRange,
2129 kInvalidDevReqType_RsvdIntrRange,
2130 kInvalidDevReqType_SysMgtAddr,
2131 /* Translation Request. */
2132 kInvalidDevReqType_TrAccessInvalid,
2133 kInvalidDevReqType_TrDisabled,
2134 kInvalidDevReqType_DevIdInvalid
2135} EVT_INVALID_DEV_REQ_TYPE_T;
2136
2137/**
2138 * INVALID_PPR_REQUEST Event Types.
2139 * In accordance with the AMD spec.
2140 */
2141typedef enum EVT_INVALID_PPR_REQ_TYPE_T
2142{
2143 kInvalidPprReqType_PriNotSupported,
2144 kInvalidPprReqType_GstTranslateDisabled
2145} EVT_INVALID_PPR_REQ_TYPE_T;
2146
2147
2148/** @name IVRS format revision field.
2149 * In accordance with the AMD spec.
2150 * @{ */
2151/** Fixed: Supports only pre-assigned device IDs and type 10h and 11h IVHD
2152 * blocks. */
2153#define ACPI_IVRS_FMT_REV_FIXED 0x1
2154/** Mixed: Supports pre-assigned and ACPI HID device naming and all IVHD blocks. */
2155#define ACPI_IVRS_FMT_REV_MIXED 0x2
2156/** @} */
2157
2158/** @name IVHD special device entry variety field.
2159 * In accordance with the AMD spec.
2160 * @{ */
2161/** I/O APIC. */
2162#define ACPI_IVHD_VARIETY_IOAPIC 0x1
2163/** HPET. */
2164#define ACPI_IVHD_VARIETY_HPET 0x2
2165/** @} */
2166
2167/** @name IVHD device entry type codes.
2168 * In accordance with the AMD spec.
2169 * @{ */
2170/** Reserved. */
2171#define ACPI_IVHD_DEVENTRY_TYPE_RSVD 0x0
2172/** All: DTE setting applies to all Device IDs. */
2173#define ACPI_IVHD_DEVENTRY_TYPE_ALL 0x1
2174/** Select: DTE setting applies to the device specified in DevId field. */
2175#define ACPI_IVHD_DEVENTRY_TYPE_SELECT 0x2
2176/** Start of range: DTE setting applies to all devices from start of range specified
2177 * by the DevId field. */
2178#define ACPI_IVHD_DEVENTRY_TYPE_START_RANGE 0x3
2179/** End of range: DTE setting from previous type 3 entry applies to all devices
2180 * incl. DevId specified by this entry. */
2181#define ACPI_IVHD_DEVENTRY_TYPE_END_RANGE 0x4
2182/** @} */
2183
2184/** @name IVHD DTE (Device Table Entry) Settings.
2185 * In accordance with the AMD spec.
2186 * @{ */
2187/** INITPass: Identifies a device able to assert INIT interrupts. */
2188#define ACPI_IVHD_DTE_INIT_PASS_SHIFT 0
2189#define ACPI_IVHD_DTE_INIT_PASS_MASK UINT8_C(0x01)
2190/** EIntPass: Identifies a device able to assert ExtInt interrupts. */
2191#define ACPI_IVHD_DTE_EXTINT_PASS_SHIFT 1
2192#define ACPI_IVHD_DTE_EXTINT_PASS_MASK UINT8_C(0x02)
2193/** NMIPass: Identifies a device able to assert NMI interrupts. */
2194#define ACPI_IVHD_DTE_NMI_PASS_SHIFT 2
2195#define ACPI_IVHD_DTE_NMI_PASS_MASK UINT8_C(0x04)
2196/** Bit 3 reserved. */
2197#define ACPI_IVHD_DTE_RSVD_3_SHIFT 3
2198#define ACPI_IVHD_DTE_RSVD_3_MASK UINT8_C(0x08)
2199/** SysMgt: Identifies a device able to assert system management messages. */
2200#define ACPI_IVHD_DTE_SYS_MGT_SHIFT 4
2201#define ACPI_IVHD_DTE_SYS_MGT_MASK UINT8_C(0x30)
2202/** Lint0Pass: Identifies a device able to assert LINT0 interrupts. */
2203#define ACPI_IVHD_DTE_LINT0_PASS_SHIFT 6
2204#define ACPI_IVHD_DTE_LINT0_PASS_MASK UINT8_C(0x40)
2205/** Lint0Pass: Identifies a device able to assert LINT1 interrupts. */
2206#define ACPI_IVHD_DTE_LINT1_PASS_SHIFT 7
2207#define ACPI_IVHD_DTE_LINT1_PASS_MASK UINT8_C(0x80)
2208RT_BF_ASSERT_COMPILE_CHECKS(ACPI_IVHD_DTE_, UINT8_C(0), UINT8_MAX,
2209 (INIT_PASS, EXTINT_PASS, NMI_PASS, RSVD_3, SYS_MGT, LINT0_PASS, LINT1_PASS));
2210/** @} */
2211
2212/**
2213 * AMD IOMMU: IVHD (I/O Virtualization Hardware Definition) Device Entry (4-byte).
2214 * In accordance with the AMD spec.
2215 */
2216#pragma pack(1)
2217typedef struct ACPIIVHDDEVENTRY4
2218{
2219 uint8_t u8DevEntryType; /**< Device entry type. */
2220 uint16_t u16DevId; /**< Device ID. */
2221 uint8_t u8DteSetting; /**< DTE (Device Table Entry) setting. */
2222} ACPIIVHDDEVENTRY4;
2223#pragma pack()
2224AssertCompileSize(ACPIIVHDDEVENTRY4, 4);
2225
2226/**
2227 * AMD IOMMU: IVHD (I/O Virtualization Hardware Definition) Device Entry (8-byte).
2228 * In accordance with the AMD spec.
2229 */
2230#pragma pack(1)
2231typedef struct ACPIIVHDDEVENTRY8
2232{
2233 uint8_t u8DevEntryType; /**< Device entry type. */
2234 union
2235 {
2236 /** Reserved: When u8DevEntryType is 0x40, 0x41, 0x44 or 0x45 (or 0x49-0x7F). */
2237 struct
2238 {
2239 uint8_t au8Rsvd0[7]; /**< Reserved (MBZ). */
2240 } rsvd;
2241 /** Alias Select: When u8DevEntryType is 0x42 or 0x43. */
2242 struct
2243 {
2244 uint16_t u16DevIdA; /**< Device ID A. */
2245 uint8_t u8DteSetting; /**< DTE (Device Table Entry) setting. */
2246 uint8_t u8Rsvd0; /**< Reserved (MBZ). */
2247 uint16_t u16DevIdB; /**< Device ID B. */
2248 uint8_t u8Rsvd1; /**< Reserved (MBZ). */
2249 } alias;
2250 /** Extended Select: When u8DevEntryType is 0x46 or 0x47. */
2251 struct
2252 {
2253 uint16_t u16DevId; /**< Device ID. */
2254 uint8_t u8DteSetting; /**< DTE (Device Table Entry) setting. */
2255 uint32_t u32ExtDteSetting; /**< Extended DTE setting. */
2256 } ext;
2257 /** Special Device: When u8DevEntryType is 0x48. */
2258 struct
2259 {
2260 uint16_t u16Rsvd0; /**< Reserved (MBZ). */
2261 uint8_t u8DteSetting; /**< DTE (Device Table Entry) setting. */
2262 uint8_t u8Handle; /**< Handle contains I/O APIC ID or HPET number. */
2263 uint16_t u16DevIdB; /**< Device ID B (I/O APIC or HPET). */
2264 uint8_t u8Variety; /**< Whether this is the HPET or I/O APIC. */
2265 } special;
2266 } u;
2267} ACPIIVHDDEVENTRY8;
2268#pragma pack()
2269AssertCompileSize(ACPIIVHDDEVENTRY8, 8);
2270
2271/** @name IVHD Type 10h Flags.
2272 * In accordance with the AMD spec.
2273 * @{ */
2274/** Peripheral page request support. */
2275#define ACPI_IVHD_10H_F_PPR_SUP RT_BIT(7)
2276/** Prefetch IOMMU pages command support. */
2277#define ACPI_IVHD_10H_F_PREF_SUP RT_BIT(6)
2278/** Coherent control. */
2279#define ACPI_IVHD_10H_F_COHERENT RT_BIT(5)
2280/** Remote IOTLB support. */
2281#define ACPI_IVHD_10H_F_IOTLB_SUP RT_BIT(4)
2282/** Isochronous control. */
2283#define ACPI_IVHD_10H_F_ISOC RT_BIT(3)
2284/** Response Pass Posted Write. */
2285#define ACPI_IVHD_10H_F_RES_PASS_PW RT_BIT(2)
2286/** Pass Posted Write. */
2287#define ACPI_IVHD_10H_F_PASS_PW RT_BIT(1)
2288/** HyperTransport Tunnel. */
2289#define ACPI_IVHD_10H_F_HT_TUNNEL RT_BIT(0)
2290/** @} */
2291
2292/** @name IVRS IVinfo field.
2293 * In accordance with the AMD spec.
2294 * @{ */
2295/** EFRSup: Extended Feature Support. */
2296#define ACPI_IVINFO_BF_EFR_SUP_SHIFT 0
2297#define ACPI_IVINFO_BF_EFR_SUP_MASK UINT32_C(0x00000001)
2298/** DMA Remap Sup: DMA remapping support (pre-boot DMA protection with
2299 * mandatory remapping of device accessed memory). */
2300#define ACPI_IVINFO_BF_DMA_REMAP_SUP_SHIFT 1
2301#define ACPI_IVINFO_BF_DMA_REMAP_SUP_MASK UINT32_C(0x00000002)
2302/** Bits 4:2 reserved. */
2303#define ACPI_IVINFO_BF_RSVD_2_4_SHIFT 2
2304#define ACPI_IVINFO_BF_RSVD_2_4_MASK UINT32_C(0x0000001c)
2305/** GVASize: Guest virtual-address size. */
2306#define ACPI_IVINFO_BF_GVA_SIZE_SHIFT 5
2307#define ACPI_IVINFO_BF_GVA_SIZE_MASK UINT32_C(0x000000e0)
2308/** PASize: System physical address size. */
2309#define ACPI_IVINFO_BF_PA_SIZE_SHIFT 8
2310#define ACPI_IVINFO_BF_PA_SIZE_MASK UINT32_C(0x00007f00)
2311/** VASize: Virtual address size. */
2312#define ACPI_IVINFO_BF_VA_SIZE_SHIFT 15
2313#define ACPI_IVINFO_BF_VA_SIZE_MASK UINT32_C(0x003f8000)
2314/** HTAtsResv: HyperTransport ATS-response address translation range reserved. */
2315#define ACPI_IVINFO_BF_HT_ATS_RESV_SHIFT 22
2316#define ACPI_IVINFO_BF_HT_ATS_RESV_MASK UINT32_C(0x00400000)
2317/** Bits 31:23 reserved. */
2318#define ACPI_IVINFO_BF_RSVD_23_31_SHIFT 23
2319#define ACPI_IVINFO_BF_RSVD_23_31_MASK UINT32_C(0xff800000)
2320RT_BF_ASSERT_COMPILE_CHECKS(ACPI_IVINFO_BF_, UINT32_C(0), UINT32_MAX,
2321 (EFR_SUP, DMA_REMAP_SUP, RSVD_2_4, GVA_SIZE, PA_SIZE, VA_SIZE, HT_ATS_RESV, RSVD_23_31));
2322/** @} */
2323
2324/** @name IVHD IOMMU info flags.
2325 * In accordance with the AMD spec.
2326 * @{ */
2327/** MSI message number for the event log. */
2328#define ACPI_IOMMU_INFO_BF_MSI_NUM_SHIFT 0
2329#define ACPI_IOMMU_INFO_BF_MSI_NUM_MASK UINT16_C(0x001f)
2330/** Bits 7:5 reserved. */
2331#define ACPI_IOMMU_INFO_BF_RSVD_5_7_SHIFT 5
2332#define ACPI_IOMMU_INFO_BF_RSVD_5_7_MASK UINT16_C(0x00e0)
2333/** IOMMU HyperTransport Unit ID number. */
2334#define ACPI_IOMMU_INFO_BF_UNIT_ID_SHIFT 8
2335#define ACPI_IOMMU_INFO_BF_UNIT_ID_MASK UINT16_C(0x1f00)
2336/** Bits 15:13 reserved. */
2337#define ACPI_IOMMU_INFO_BF_RSVD_13_15_SHIFT 13
2338#define ACPI_IOMMU_INFO_BF_RSVD_13_15_MASK UINT16_C(0xe000)
2339RT_BF_ASSERT_COMPILE_CHECKS(ACPI_IOMMU_INFO_BF_, UINT16_C(0), UINT16_MAX,
2340 (MSI_NUM, RSVD_5_7, UNIT_ID, RSVD_13_15));
2341/** @} */
2342
2343/** @name IVHD IOMMU feature reporting field.
2344 * In accordance with the AMD spec.
2345 * @{ */
2346/** x2APIC supported for peripherals. */
2347#define ACPI_IOMMU_FEAT_BF_XT_SUP_SHIFT 0
2348#define ACPI_IOMMU_FEAT_BF_XT_SUP_MASK UINT32_C(0x00000001)
2349/** NX supported for I/O. */
2350#define ACPI_IOMMU_FEAT_BF_NX_SUP_SHIFT 1
2351#define ACPI_IOMMU_FEAT_BF_NX_SUP_MASK UINT32_C(0x00000002)
2352/** GT (Guest Translation) supported. */
2353#define ACPI_IOMMU_FEAT_BF_GT_SUP_SHIFT 2
2354#define ACPI_IOMMU_FEAT_BF_GT_SUP_MASK UINT32_C(0x00000004)
2355/** GLX (Number of guest CR3 tables) supported. */
2356#define ACPI_IOMMU_FEAT_BF_GLX_SUP_SHIFT 3
2357#define ACPI_IOMMU_FEAT_BF_GLX_SUP_MASK UINT32_C(0x00000018)
2358/** IA (INVALIDATE_IOMMU_ALL) command supported. */
2359#define ACPI_IOMMU_FEAT_BF_IA_SUP_SHIFT 5
2360#define ACPI_IOMMU_FEAT_BF_IA_SUP_MASK UINT32_C(0x00000020)
2361/** GA (Guest virtual APIC) supported. */
2362#define ACPI_IOMMU_FEAT_BF_GA_SUP_SHIFT 6
2363#define ACPI_IOMMU_FEAT_BF_GA_SUP_MASK UINT32_C(0x00000040)
2364/** HE (Hardware error) registers supported. */
2365#define ACPI_IOMMU_FEAT_BF_HE_SUP_SHIFT 7
2366#define ACPI_IOMMU_FEAT_BF_HE_SUP_MASK UINT32_C(0x00000080)
2367/** PASMax (maximum PASID) supported. Ignored if PPRSup=0. */
2368#define ACPI_IOMMU_FEAT_BF_PAS_MAX_SHIFT 8
2369#define ACPI_IOMMU_FEAT_BF_PAS_MAX_MASK UINT32_C(0x00001f00)
2370/** PNCounters (Number of performance counters per counter bank) supported. */
2371#define ACPI_IOMMU_FEAT_BF_PN_COUNTERS_SHIFT 13
2372#define ACPI_IOMMU_FEAT_BF_PN_COUNTERS_MASK UINT32_C(0x0001e000)
2373/** PNBanks (Number of performance counter banks) supported. */
2374#define ACPI_IOMMU_FEAT_BF_PN_BANKS_SHIFT 17
2375#define ACPI_IOMMU_FEAT_BF_PN_BANKS_MASK UINT32_C(0x007e0000)
2376/** MSINumPPR (MSI number for peripheral page requests). */
2377#define ACPI_IOMMU_FEAT_BF_MSI_NUM_PPR_SHIFT 23
2378#define ACPI_IOMMU_FEAT_BF_MSI_NUM_PPR_MASK UINT32_C(0x0f800000)
2379/** GATS (Guest address translation size). MBZ when GTSup=0. */
2380#define ACPI_IOMMU_FEAT_BF_GATS_SHIFT 28
2381#define ACPI_IOMMU_FEAT_BF_GATS_MASK UINT32_C(0x30000000)
2382/** HATS (Host address translation size). */
2383#define ACPI_IOMMU_FEAT_BF_HATS_SHIFT 30
2384#define ACPI_IOMMU_FEAT_BF_HATS_MASK UINT32_C(0xc0000000)
2385RT_BF_ASSERT_COMPILE_CHECKS(ACPI_IOMMU_FEAT_BF_, UINT32_C(0), UINT32_MAX,
2386 (XT_SUP, NX_SUP, GT_SUP, GLX_SUP, IA_SUP, GA_SUP, HE_SUP, PAS_MAX, PN_COUNTERS, PN_BANKS,
2387 MSI_NUM_PPR, GATS, HATS));
2388/** @} */
2389
2390/** @name IOMMU Extended Feature Register (PCI/MMIO/ACPI).
2391 * In accordance with the AMD spec.
2392 * @{ */
2393/** PreFSup: Prefetch support (RO). */
2394#define IOMMU_EXT_FEAT_BF_PREF_SUP_SHIFT 0
2395#define IOMMU_EXT_FEAT_BF_PREF_SUP_MASK UINT64_C(0x0000000000000001)
2396/** PPRSup: Peripheral Page Request (PPR) support (RO). */
2397#define IOMMU_EXT_FEAT_BF_PPR_SUP_SHIFT 1
2398#define IOMMU_EXT_FEAT_BF_PPR_SUP_MASK UINT64_C(0x0000000000000002)
2399/** XTSup: x2APIC support (RO). */
2400#define IOMMU_EXT_FEAT_BF_X2APIC_SUP_SHIFT 2
2401#define IOMMU_EXT_FEAT_BF_X2APIC_SUP_MASK UINT64_C(0x0000000000000004)
2402/** NXSup: No Execute (PMR and PRIV) support (RO). */
2403#define IOMMU_EXT_FEAT_BF_NO_EXEC_SUP_SHIFT 3
2404#define IOMMU_EXT_FEAT_BF_NO_EXEC_SUP_MASK UINT64_C(0x0000000000000008)
2405/** GTSup: Guest Translation support (RO). */
2406#define IOMMU_EXT_FEAT_BF_GT_SUP_SHIFT 4
2407#define IOMMU_EXT_FEAT_BF_GT_SUP_MASK UINT64_C(0x0000000000000010)
2408/** Bit 5 reserved. */
2409#define IOMMU_EXT_FEAT_BF_RSVD_5_SHIFT 5
2410#define IOMMU_EXT_FEAT_BF_RSVD_5_MASK UINT64_C(0x0000000000000020)
2411/** IASup: INVALIDATE_IOMMU_ALL command support (RO). */
2412#define IOMMU_EXT_FEAT_BF_IA_SUP_SHIFT 6
2413#define IOMMU_EXT_FEAT_BF_IA_SUP_MASK UINT64_C(0x0000000000000040)
2414/** GASup: Guest virtual-APIC support (RO). */
2415#define IOMMU_EXT_FEAT_BF_GA_SUP_SHIFT 7
2416#define IOMMU_EXT_FEAT_BF_GA_SUP_MASK UINT64_C(0x0000000000000080)
2417/** HESup: Hardware error registers support (RO). */
2418#define IOMMU_EXT_FEAT_BF_HE_SUP_SHIFT 8
2419#define IOMMU_EXT_FEAT_BF_HE_SUP_MASK UINT64_C(0x0000000000000100)
2420/** PCSup: Performance counters support (RO). */
2421#define IOMMU_EXT_FEAT_BF_PC_SUP_SHIFT 9
2422#define IOMMU_EXT_FEAT_BF_PC_SUP_MASK UINT64_C(0x0000000000000200)
2423/** HATS: Host Address Translation Size (RO). */
2424#define IOMMU_EXT_FEAT_BF_HATS_SHIFT 10
2425#define IOMMU_EXT_FEAT_BF_HATS_MASK UINT64_C(0x0000000000000c00)
2426/** GATS: Guest Address Translation Size (RO). */
2427#define IOMMU_EXT_FEAT_BF_GATS_SHIFT 12
2428#define IOMMU_EXT_FEAT_BF_GATS_MASK UINT64_C(0x0000000000003000)
2429/** GLXSup: Guest CR3 root table level support (RO). */
2430#define IOMMU_EXT_FEAT_BF_GLX_SUP_SHIFT 14
2431#define IOMMU_EXT_FEAT_BF_GLX_SUP_MASK UINT64_C(0x000000000000c000)
2432/** SmiFSup: SMI filter register support (RO). */
2433#define IOMMU_EXT_FEAT_BF_SMI_FLT_SUP_SHIFT 16
2434#define IOMMU_EXT_FEAT_BF_SMI_FLT_SUP_MASK UINT64_C(0x0000000000030000)
2435/** SmiFRC: SMI filter register count (RO). */
2436#define IOMMU_EXT_FEAT_BF_SMI_FLT_REG_CNT_SHIFT 18
2437#define IOMMU_EXT_FEAT_BF_SMI_FLT_REG_CNT_MASK UINT64_C(0x00000000001c0000)
2438/** GAMSup: Guest virtual-APIC modes support (RO). */
2439#define IOMMU_EXT_FEAT_BF_GAM_SUP_SHIFT 21
2440#define IOMMU_EXT_FEAT_BF_GAM_SUP_MASK UINT64_C(0x0000000000e00000)
2441/** DualPprLogSup: Dual PPR Log support (RO). */
2442#define IOMMU_EXT_FEAT_BF_DUAL_PPR_LOG_SUP_SHIFT 24
2443#define IOMMU_EXT_FEAT_BF_DUAL_PPR_LOG_SUP_MASK UINT64_C(0x0000000003000000)
2444/** Bits 27:26 reserved. */
2445#define IOMMU_EXT_FEAT_BF_RSVD_26_27_SHIFT 26
2446#define IOMMU_EXT_FEAT_BF_RSVD_26_27_MASK UINT64_C(0x000000000c000000)
2447/** DualEventLogSup: Dual Event Log support (RO). */
2448#define IOMMU_EXT_FEAT_BF_DUAL_EVT_LOG_SUP_SHIFT 28
2449#define IOMMU_EXT_FEAT_BF_DUAL_EVT_LOG_SUP_MASK UINT64_C(0x0000000030000000)
2450/** Bits 31:30 reserved. */
2451#define IOMMU_EXT_FEAT_BF_RSVD_30_31_SHIFT 30
2452#define IOMMU_EXT_FEAT_BF_RSVD_30_31_MASK UINT64_C(0x00000000c0000000)
2453/** PASMax: Maximum PASID support (RO). */
2454#define IOMMU_EXT_FEAT_BF_PASID_MAX_SHIFT 32
2455#define IOMMU_EXT_FEAT_BF_PASID_MAX_MASK UINT64_C(0x0000001f00000000)
2456/** USSup: User/Supervisor support (RO). */
2457#define IOMMU_EXT_FEAT_BF_US_SUP_SHIFT 37
2458#define IOMMU_EXT_FEAT_BF_US_SUP_MASK UINT64_C(0x0000002000000000)
2459/** DevTblSegSup: Segmented Device Table support (RO). */
2460#define IOMMU_EXT_FEAT_BF_DEV_TBL_SEG_SUP_SHIFT 38
2461#define IOMMU_EXT_FEAT_BF_DEV_TBL_SEG_SUP_MASK UINT64_C(0x000000c000000000)
2462/** PprOverflwEarlySup: PPR Log Overflow Early warning support (RO). */
2463#define IOMMU_EXT_FEAT_BF_PPR_OVERFLOW_EARLY_SHIFT 40
2464#define IOMMU_EXT_FEAT_BF_PPR_OVERFLOW_EARLY_MASK UINT64_C(0x0000010000000000)
2465/** PprAutoRspSup: PPR Automatic Response support (RO). */
2466#define IOMMU_EXT_FEAT_BF_PPR_AUTO_RES_SUP_SHIFT 41
2467#define IOMMU_EXT_FEAT_BF_PPR_AUTO_RES_SUP_MASK UINT64_C(0x0000020000000000)
2468/** MarcSup: Memory Access and Routing (MARC) support (RO). */
2469#define IOMMU_EXT_FEAT_BF_MARC_SUP_SHIFT 42
2470#define IOMMU_EXT_FEAT_BF_MARC_SUP_MASK UINT64_C(0x00000c0000000000)
2471/** BlkStopMrkSup: Block StopMark message support (RO). */
2472#define IOMMU_EXT_FEAT_BF_BLKSTOP_MARK_SUP_SHIFT 44
2473#define IOMMU_EXT_FEAT_BF_BLKSTOP_MARK_SUP_MASK UINT64_C(0x0000100000000000)
2474/** PerfOptSup: IOMMU Performance Optimization support (RO). */
2475#define IOMMU_EXT_FEAT_BF_PERF_OPT_SUP_SHIFT 45
2476#define IOMMU_EXT_FEAT_BF_PERF_OPT_SUP_MASK UINT64_C(0x0000200000000000)
2477/** MsiCapMmioSup: MSI-Capability Register MMIO access support (RO). */
2478#define IOMMU_EXT_FEAT_BF_MSI_CAP_MMIO_SUP_SHIFT 46
2479#define IOMMU_EXT_FEAT_BF_MSI_CAP_MMIO_SUP_MASK UINT64_C(0x0000400000000000)
2480/** Bit 47 reserved. */
2481#define IOMMU_EXT_FEAT_BF_RSVD_47_SHIFT 47
2482#define IOMMU_EXT_FEAT_BF_RSVD_47_MASK UINT64_C(0x0000800000000000)
2483/** GIoSup: Guest I/O Protection support (RO). */
2484#define IOMMU_EXT_FEAT_BF_GST_IO_PROT_SUP_SHIFT 48
2485#define IOMMU_EXT_FEAT_BF_GST_IO_PROT_SUP_MASK UINT64_C(0x0001000000000000)
2486/** HASup: Host Access support (RO). */
2487#define IOMMU_EXT_FEAT_BF_HST_ACCESS_SUP_SHIFT 49
2488#define IOMMU_EXT_FEAT_BF_HST_ACCESS_SUP_MASK UINT64_C(0x0002000000000000)
2489/** EPHSup: Enhandled PPR Handling support (RO). */
2490#define IOMMU_EXT_FEAT_BF_ENHANCED_PPR_SUP_SHIFT 50
2491#define IOMMU_EXT_FEAT_BF_ENHANCED_PPR_SUP_MASK UINT64_C(0x0004000000000000)
2492/** AttrFWSup: Attribute Forward support (RO). */
2493#define IOMMU_EXT_FEAT_BF_ATTR_FW_SUP_SHIFT 51
2494#define IOMMU_EXT_FEAT_BF_ATTR_FW_SUP_MASK UINT64_C(0x0008000000000000)
2495/** HDSup: Host Dirty Support (RO). */
2496#define IOMMU_EXT_FEAT_BF_HST_DIRTY_SUP_SHIFT 52
2497#define IOMMU_EXT_FEAT_BF_HST_DIRTY_SUP_MASK UINT64_C(0x0010000000000000)
2498/** Bit 53 reserved. */
2499#define IOMMU_EXT_FEAT_BF_RSVD_53_SHIFT 53
2500#define IOMMU_EXT_FEAT_BF_RSVD_53_MASK UINT64_C(0x0020000000000000)
2501/** InvIotlbTypeSup: Invalidate IOTLB type support (RO). */
2502#define IOMMU_EXT_FEAT_BF_INV_IOTLB_TYPE_SUP_SHIFT 54
2503#define IOMMU_EXT_FEAT_BF_INV_IOTLB_TYPE_SUP_MASK UINT64_C(0x0040000000000000)
2504/** Bits 60:55 reserved. */
2505#define IOMMU_EXT_FEAT_BF_RSVD_55_60_SHIFT 55
2506#define IOMMU_EXT_FEAT_BF_RSVD_55_60_MASK UINT64_C(0x1f80000000000000)
2507/** GAUpdateDisSup: Support disabling hardware update on guest page table access
2508 * (RO). */
2509#define IOMMU_EXT_FEAT_BF_GA_UPDATE_DIS_SUP_SHIFT 61
2510#define IOMMU_EXT_FEAT_BF_GA_UPDATE_DIS_SUP_MASK UINT64_C(0x2000000000000000)
2511/** ForcePhysDestSup: Force Physical Destination Mode for Remapped Interrupt
2512 * support (RO). */
2513#define IOMMU_EXT_FEAT_BF_FORCE_PHYS_DST_SUP_SHIFT 62
2514#define IOMMU_EXT_FEAT_BF_FORCE_PHYS_DST_SUP_MASK UINT64_C(0x4000000000000000)
2515/** Bit 63 reserved. */
2516#define IOMMU_EXT_FEAT_BF_RSVD_63_SHIFT 63
2517#define IOMMU_EXT_FEAT_BF_RSVD_63_MASK UINT64_C(0x8000000000000000)
2518RT_BF_ASSERT_COMPILE_CHECKS(IOMMU_EXT_FEAT_BF_, UINT64_C(0), UINT64_MAX,
2519 (PREF_SUP, PPR_SUP, X2APIC_SUP, NO_EXEC_SUP, GT_SUP, RSVD_5, IA_SUP, GA_SUP, HE_SUP, PC_SUP,
2520 HATS, GATS, GLX_SUP, SMI_FLT_SUP, SMI_FLT_REG_CNT, GAM_SUP, DUAL_PPR_LOG_SUP, RSVD_26_27,
2521 DUAL_EVT_LOG_SUP, RSVD_30_31, PASID_MAX, US_SUP, DEV_TBL_SEG_SUP, PPR_OVERFLOW_EARLY,
2522 PPR_AUTO_RES_SUP, MARC_SUP, BLKSTOP_MARK_SUP, PERF_OPT_SUP, MSI_CAP_MMIO_SUP, RSVD_47,
2523 GST_IO_PROT_SUP, HST_ACCESS_SUP, ENHANCED_PPR_SUP, ATTR_FW_SUP, HST_DIRTY_SUP, RSVD_53,
2524 INV_IOTLB_TYPE_SUP, RSVD_55_60, GA_UPDATE_DIS_SUP, FORCE_PHYS_DST_SUP, RSVD_63));
2525/** @} */
2526
2527/**
2528 * IVHD (I/O Virtualization Hardware Definition) Type 10h.
2529 * In accordance with the AMD spec.
2530 */
2531#pragma pack(1)
2532typedef struct ACPIIVHDTYPE10
2533{
2534 uint8_t u8Type; /**< Type: Must be 0x10. */
2535 uint8_t u8Flags; /**< Flags (see ACPI_IVHD_10H_F_XXX). */
2536 uint16_t u16Length; /**< Length of IVHD including IVHD device entries. */
2537 uint16_t u16DeviceId; /**< Device ID of the IOMMU. */
2538 uint16_t u16CapOffset; /**< Offset in Capability space for control fields of IOMMU. */
2539 uint64_t u64BaseAddress; /**< Base address of IOMMU control registers in MMIO space. */
2540 uint16_t u16PciSegmentGroup; /**< PCI segment group number. */
2541 uint16_t u16IommuInfo; /**< Interrupt number and Unit ID. */
2542 uint32_t u32Features; /**< IOMMU feature reporting. */
2543 /* IVHD device entry block follows. */
2544} ACPIIVHDTYPE10;
2545#pragma pack()
2546AssertCompileSize(ACPIIVHDTYPE10, 24);
2547AssertCompileMemberOffset(ACPIIVHDTYPE10, u8Type, 0);
2548AssertCompileMemberOffset(ACPIIVHDTYPE10, u8Flags, 1);
2549AssertCompileMemberOffset(ACPIIVHDTYPE10, u16Length, 2);
2550AssertCompileMemberOffset(ACPIIVHDTYPE10, u16DeviceId, 4);
2551AssertCompileMemberOffset(ACPIIVHDTYPE10, u16CapOffset, 6);
2552AssertCompileMemberOffset(ACPIIVHDTYPE10, u64BaseAddress, 8);
2553AssertCompileMemberOffset(ACPIIVHDTYPE10, u16PciSegmentGroup, 16);
2554AssertCompileMemberOffset(ACPIIVHDTYPE10, u16IommuInfo, 18);
2555AssertCompileMemberOffset(ACPIIVHDTYPE10, u32Features, 20);
2556
2557/** @name IVHD Type 11h Flags.
2558 * In accordance with the AMD spec.
2559 * @{ */
2560/** Coherent control. */
2561#define ACPI_IVHD_11H_F_COHERENT RT_BIT(5)
2562/** Remote IOTLB support. */
2563#define ACPI_IVHD_11H_F_IOTLB_SUP RT_BIT(4)
2564/** Isochronous control. */
2565#define ACPI_IVHD_11H_F_ISOC RT_BIT(3)
2566/** Response Pass Posted Write. */
2567#define ACPI_IVHD_11H_F_RES_PASS_PW RT_BIT(2)
2568/** Pass Posted Write. */
2569#define ACPI_IVHD_11H_F_PASS_PW RT_BIT(1)
2570/** HyperTransport Tunnel. */
2571#define ACPI_IVHD_11H_F_HT_TUNNEL RT_BIT(0)
2572/** @} */
2573
2574/** @name IVHD IOMMU Type 11 Attributes field.
2575 * In accordance with the AMD spec.
2576 * @{ */
2577/** Bits 12:0 reserved. */
2578#define ACPI_IOMMU_ATTR_BF_RSVD_0_12_SHIFT 0
2579#define ACPI_IOMMU_ATTR_BF_RSVD_0_12_MASK UINT32_C(0x00001fff)
2580/** PNCounters: Number of performance counters per counter bank. */
2581#define ACPI_IOMMU_ATTR_BF_PN_COUNTERS_SHIFT 13
2582#define ACPI_IOMMU_ATTR_BF_PN_COUNTERS_MASK UINT32_C(0x0001e000)
2583/** PNBanks: Number of performance counter banks. */
2584#define ACPI_IOMMU_ATTR_BF_PN_BANKS_SHIFT 17
2585#define ACPI_IOMMU_ATTR_BF_PN_BANKS_MASK UINT32_C(0x007e0000)
2586/** MSINumPPR: MSI number for peripheral page requests (PPR). */
2587#define ACPI_IOMMU_ATTR_BF_MSI_NUM_PPR_SHIFT 23
2588#define ACPI_IOMMU_ATTR_BF_MSI_NUM_PPR_MASK UINT32_C(0x0f800000)
2589/** Bits 31:28 reserved. */
2590#define ACPI_IOMMU_ATTR_BF_RSVD_28_31_SHIFT 28
2591#define ACPI_IOMMU_ATTR_BF_RSVD_28_31_MASK UINT32_C(0xf0000000)
2592RT_BF_ASSERT_COMPILE_CHECKS(ACPI_IOMMU_ATTR_BF_, UINT32_C(0), UINT32_MAX,
2593 (RSVD_0_12, PN_COUNTERS, PN_BANKS, MSI_NUM_PPR, RSVD_28_31));
2594/** @} */
2595
2596/**
2597 * AMD IOMMU: IVHD (I/O Virtualization Hardware Definition) Type 11h.
2598 * In accordance with the AMD spec.
2599 */
2600#pragma pack(1)
2601typedef struct ACPIIVHDTYPE11
2602{
2603 uint8_t u8Type; /**< Type: Must be 0x11. */
2604 uint8_t u8Flags; /**< Flags. */
2605 uint16_t u16Length; /**< Length: Size starting from Type fields incl. IVHD device entries. */
2606 uint16_t u16DeviceId; /**< Device ID of the IOMMU. */
2607 uint16_t u16CapOffset; /**< Offset in Capability space for control fields of IOMMU. */
2608 uint64_t u64BaseAddress; /**< Base address of IOMMU control registers in MMIO space. */
2609 uint16_t u16PciSegmentGroup; /**< PCI segment group number. */
2610 uint16_t u16IommuInfo; /**< Interrupt number and unit ID. */
2611 uint32_t u32IommuAttr; /**< IOMMU info. not reported in EFR. */
2612 uint64_t u64EfrRegister; /**< Extended Feature Register (must be identical to its MMIO shadow). */
2613 uint64_t u64Rsvd0; /**< Reserved for future. */
2614 /* IVHD device entry block follows. */
2615} ACPIIVHDTYPE11;
2616#pragma pack()
2617AssertCompileSize(ACPIIVHDTYPE11, 40);
2618AssertCompileMemberOffset(ACPIIVHDTYPE11, u8Type, 0);
2619AssertCompileMemberOffset(ACPIIVHDTYPE11, u8Flags, 1);
2620AssertCompileMemberOffset(ACPIIVHDTYPE11, u16Length, 2);
2621AssertCompileMemberOffset(ACPIIVHDTYPE11, u16DeviceId, 4);
2622AssertCompileMemberOffset(ACPIIVHDTYPE11, u16CapOffset, 6);
2623AssertCompileMemberOffset(ACPIIVHDTYPE11, u64BaseAddress, 8);
2624AssertCompileMemberOffset(ACPIIVHDTYPE11, u16PciSegmentGroup, 16);
2625AssertCompileMemberOffset(ACPIIVHDTYPE11, u16IommuInfo, 18);
2626AssertCompileMemberOffset(ACPIIVHDTYPE11, u32IommuAttr, 20);
2627AssertCompileMemberOffset(ACPIIVHDTYPE11, u64EfrRegister, 24);
2628AssertCompileMemberOffset(ACPIIVHDTYPE11, u64Rsvd0, 32);
2629
2630/**
2631 * AMD IOMMU: IVHD (I/O Virtualization Hardware Definition) Type 40h.
2632 * In accordance with the AMD spec.
2633 */
2634typedef struct ACPIIVHDTYPE11 ACPIIVHDTYPE40;
2635
2636#endif /* !VBOX_INCLUDED_iommu_amd_h */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette