]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/IndustryStandard/DmaRemappingReportingTable.h
MdePkg/include: Add Acpi.h to DMAR table.
[mirror_edk2.git] / MdePkg / Include / IndustryStandard / DmaRemappingReportingTable.h
CommitLineData
846ea5f5
GM
1/** @file\r
2 DMA Remapping Reporting (DMAR) ACPI table definition from Intel(R)\r
3 Virtualization Technology for Directed I/O (VT-D) Architecture Specification.\r
4\r
5 Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r
6 This program and the accompanying materials\r
7 are licensed and made available under the terms and conditions of the BSD License\r
8 which accompanies this distribution. The full text of the license may be found at\r
9 http://opensource.org/licenses/bsd-license.php\r
10\r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14 @par Revision Reference:\r
15 - Intel(R) Virtualization Technology for Directed I/O (VT-D) Architecture\r
16 Specification v2.4, Dated June 2016.\r
17 http://www.intel.com/content/dam/www/public/us/en/documents/product-specifications/vt-directed-io-spec.pdf\r
18\r
19 @par Glossary:\r
20 - HPET - High Precision Event Timer\r
21 - NUMA - Non-uniform Memory Access\r
22**/\r
23#ifndef _DMA_REMAPPING_REPORTING_TABLE_H_\r
24#define _DMA_REMAPPING_REPORTING_TABLE_H_\r
25\r
83a45784
JY
26#include <IndustryStandard/Acpi.h>\r
27\r
846ea5f5
GM
28#pragma pack(1)\r
29\r
30///\r
31/// DMA-Remapping Reporting Structure definitions from section 8.1\r
32///@{\r
33#define EFI_ACPI_DMAR_REVISION 0x01\r
34\r
35#define EFI_ACPI_DMAR_FLAGS_INTR_REMAP BIT0\r
36#define EFI_ACPI_DMAR_FLAGS_X2APIC_OPT_OUT BIT1\r
37///@}\r
38\r
39///\r
40/// Remapping Structure Types definitions from section 8.2\r
41///@{\r
42#define EFI_ACPI_DMAR_TYPE_DRHD 0x00\r
43#define EFI_ACPI_DMAR_TYPE_RMRR 0x01\r
44#define EFI_ACPI_DMAR_TYPE_ATSR 0x02\r
45#define EFI_ACPI_DMAR_TYPE_RHSA 0x03\r
46#define EFI_ACPI_DMAR_TYPE_ANDD 0x04\r
47///@}\r
48\r
49///\r
50/// DMA-Remapping Hardware Unit definitions from section 8.3\r
51///\r
52#define EFI_ACPI_DMAR_DRHD_FLAGS_INCLUDE_PCI_ALL BIT0\r
53\r
54///\r
55/// DMA-Remapping Device Scope Entry Structure definitions from section 8.3.1\r
56///@{\r
57#define EFI_ACPI_DEVICE_SCOPE_ENTRY_TYPE_PCI_ENDPOINT 0x01\r
58#define EFI_ACPI_DEVICE_SCOPE_ENTRY_TYPE_PCI_BRIDGE 0x02\r
59#define EFI_ACPI_DEVICE_SCOPE_ENTRY_TYPE_IOAPIC 0x03\r
60#define EFI_ACPI_DEVICE_SCOPE_ENTRY_TYPE_MSI_CAPABLE_HPET 0x04\r
61#define EFI_ACPI_DEVICE_SCOPE_ENTRY_TYPE_ACPI_NAMESPACE_DEVICE 0x05\r
62///@}\r
63\r
64///\r
65/// Root Port ATS Capability Reporting Structure definitions from section 8.5\r
66///\r
67#define EFI_ACPI_DMAR_ATSR_FLAGS_ALL_PORTS BIT0\r
68\r
69///\r
70/// Definition for DMA Remapping Structure Header\r
71///\r
72typedef struct {\r
73 UINT16 Type;\r
74 UINT16 Length;\r
75} EFI_ACPI_DMAR_STRUCTURE_HEADER;\r
76\r
77///\r
78/// Definition for DMA-Remapping PCI Path\r
79///\r
80typedef struct {\r
81 UINT8 Device;\r
82 UINT8 Function;\r
83} EFI_ACPI_DMAR_PCI_PATH;\r
84\r
85///\r
86/// Device Scope Structure is defined in section 8.3.1\r
87///\r
88typedef struct {\r
89 UINT8 Type;\r
90 UINT8 Length;\r
91 UINT16 Reserved2;\r
92 UINT8 EnumerationId;\r
93 UINT8 StartBusNumber;\r
94} EFI_ACPI_DMAR_DEVICE_SCOPE_STRUCTURE_HEADER;\r
95\r
96/**\r
97 DMA-remapping hardware unit definition (DRHD) structure is defined in\r
98 section 8.3. This uniquely represents a remapping hardware unit present\r
99 in the platform. There must be at least one instance of this structure\r
100 for each PCI segment in the platform.\r
101**/\r
102typedef struct {\r
103 EFI_ACPI_DMAR_STRUCTURE_HEADER Header;\r
104 /**\r
105 - Bit[0]: INCLUDE_PCI_ALL\r
106 - If Set, this remapping hardware unit has under its scope all\r
107 PCI compatible devices in the specified Segment, except devices\r
108 reported under the scope of other remapping hardware units for\r
109 the same Segment.\r
110 - If Clear, this remapping hardware unit has under its scope only\r
111 devices in the specified Segment that are explicitly identified\r
112 through the DeviceScope field.\r
113 - Bits[7:1] Reserved.\r
114 **/\r
115 UINT8 Flags;\r
116 UINT8 Reserved;\r
117 ///\r
118 /// The PCI Segment associated with this unit.\r
119 ///\r
120 UINT16 SegmentNumber;\r
121 ///\r
122 /// Base address of remapping hardware register-set for this unit.\r
123 ///\r
124 UINT64 RegisterBaseAddress;\r
125} EFI_ACPI_DMAR_DRHD_HEADER;\r
126\r
127/**\r
128 Reserved Memory Region Reporting Structure (RMRR) is described in section 8.4\r
129 Reserved memory ranges that may be DMA targets may be reported through the\r
130 RMRR structures, along with the devices that requires access to the specified\r
131 reserved memory region.\r
132**/\r
133typedef struct {\r
134 EFI_ACPI_DMAR_STRUCTURE_HEADER Header;\r
135 UINT8 Reserved[2];\r
136 ///\r
137 /// PCI Segment Number associated with devices identified through\r
138 /// the Device Scope field.\r
139 ///\r
140 UINT16 SegmentNumber;\r
141 ///\r
142 /// Base address of 4KB-aligned reserved memory region\r
143 ///\r
144 UINT64 ReservedMemoryRegionBaseAddress;\r
145 /**\r
146 Last address of the reserved memory region. Value in this field must be\r
147 greater than the value in Reserved Memory Region Base Address field.\r
148 The reserved memory region size (Limit - Base + 1) must be an integer\r
149 multiple of 4KB.\r
150 **/\r
151 UINT64 ReservedMemoryRegionLimitAddress;\r
152} EFI_ACPI_DMAR_RMRR_HEADER;\r
153\r
154/**\r
155 Root Port ATS Capability Reporting (ATSR) structure is defined in section 8.5.\r
156 This structure is applicable only for platforms supporting Device-TLBs as\r
157 reported through the Extended Capability Register. For each PCI Segment in\r
158 the platform that supports Device-TLBs, BIOS provides an ATSR structure. The\r
159 ATSR structures identifies PCI-Express Root-Ports supporting Address\r
160 Translation Services (ATS) transactions. Software must enable ATS on endpoint\r
161 devices behind a Root Port only if the Root Port is reported as supporting\r
162 ATS transactions.\r
163**/\r
164typedef struct {\r
165 EFI_ACPI_DMAR_STRUCTURE_HEADER Header;\r
166 /**\r
167 - Bit[0]: ALL_PORTS:\r
168 - If Set, indicates all PCI Express Root Ports in the specified\r
169 PCI Segment supports ATS transactions.\r
170 - If Clear, indicates ATS transactions are supported only on\r
171 Root Ports identified through the Device Scope field.\r
172 - Bits[7:1] Reserved.\r
173 **/\r
174 UINT8 Flags;\r
175 UINT8 Reserved;\r
176 ///\r
177 /// The PCI Segment associated with this ATSR structure\r
178 ///\r
179 UINT16 SegmentNumber;\r
180} EFI_ACPI_DMAR_ATSR_HEADER;\r
181\r
182/**\r
183 Remapping Hardware Static Affinity (RHSA) is an optional structure defined\r
184 in section 8.6. This is intended to be used only on NUMA platforms with\r
185 Remapping hardware units and memory spanned across multiple nodes.\r
186 When used, there must be a RHSA structure for each Remapping hardware unit\r
187 reported through DRHD structure.\r
188**/\r
189typedef struct {\r
190 EFI_ACPI_DMAR_STRUCTURE_HEADER Header;\r
191 UINT8 Reserved[4];\r
192 ///\r
193 /// Register Base Address of this Remap hardware unit reported in the\r
194 /// corresponding DRHD structure.\r
195 ///\r
196 UINT64 RegisterBaseAddress;\r
197 ///\r
198 /// Proximity Domain to which the Remap hardware unit identified by the\r
199 /// Register Base Address field belongs.\r
200 ///\r
201 UINT32 ProximityDomain;\r
202} EFI_ACPI_DMAR_RHSA_HEADER;\r
203\r
204/**\r
205 An ACPI Name-space Device Declaration (ANDD) structure is defined in section\r
206 8.7 and uniquely represents an ACPI name-space enumerated device capable of\r
207 issuing DMA requests in the platform. ANDD structures are used in conjunction\r
208 with Device-Scope entries of type ACPI_NAMESPACE_DEVICE.\r
209**/\r
210typedef struct {\r
211 EFI_ACPI_DMAR_STRUCTURE_HEADER Header;\r
212 UINT8 Reserved[3];\r
213 /**\r
214 Each ACPI device enumerated through an ANDD structure must have a unique\r
215 value for this field. To report an ACPI device with ACPI Device Number\r
216 value of X, under the scope of a DRHD unit, a Device-Scope entry of type\r
217 ACPI_NAMESPACE_DEVICE is used with value of X in the Enumeration ID field.\r
218 The Start Bus Number and Path fields in the Device-Scope together\r
219 provides the 16-bit source-id allocated by platform for the ACPI device.\r
220 **/\r
221 UINT8 AcpiDeviceNumber;\r
222} EFI_ACPI_DMAR_ANDD_HEADER;\r
223\r
224/**\r
225 DMA Remapping Reporting Structure Header as defined in section 8.1\r
226 This header will be followed by list of Remapping Structures listed below\r
227 - DMA Remapping Hardware Unit Definition (DRHD)\r
228 - Reserved Memory Region Reporting (RMRR)\r
229 - Root Port ATS Capability Reporting (ATSR)\r
230 - Remapping Hardware Static Affinity (RHSA)\r
231 - ACPI Name-space Device Declaration (ANDD)\r
232 These structure types must by reported in numerical order.\r
233 i.e., All remapping structures of type 0 (DRHD) enumerated before remapping\r
234 structures of type 1 (RMRR), and so forth.\r
235**/\r
236typedef struct {\r
237 EFI_ACPI_DESCRIPTION_HEADER Header;\r
238 /**\r
239 This field indicates the maximum DMA physical addressability supported by\r
240 this platform. The system address map reported by the BIOS indicates what\r
241 portions of this addresses are populated. The Host Address Width (HAW) of\r
242 the platform is computed as (N+1), where N is the value reported in this\r
243 field.\r
244 For example, for a platform supporting 40 bits of physical addressability,\r
245 the value of 100111b is reported in this field.\r
246 **/\r
247 UINT8 HostAddressWidth;\r
248 /**\r
249 - Bit[0]: INTR_REMAP - If Clear, the platform does not support interrupt\r
250 remapping. If Set, the platform supports interrupt remapping.\r
251 - Bit[1]: X2APIC_OPT_OUT - For firmware compatibility reasons, platform\r
252 firmware may Set this field to request system software to opt\r
253 out of enabling Extended xAPIC (X2APIC) mode. This field is\r
254 valid only when the INTR_REMAP field (bit 0) is Set.\r
255 - Bits[7:2] Reserved.\r
256 **/\r
257 UINT8 Flags;\r
258 UINT8 Reserved[10];\r
259} EFI_ACPI_DMAR_HEADER;\r
260\r
261#pragma pack()\r
262\r
263#endif\r