]> git.proxmox.com Git - mirror_edk2.git/blame - EdkCompatibilityPkg/Foundation/Include/IndustryStandard/DMARemappingReportingTable.h
Add definition: EFI_ACPI_DMAR_TABLE_FLAGS_INTR_REMAP_CLEAR.
[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Include / IndustryStandard / DMARemappingReportingTable.h
CommitLineData
3eb9473e 1/*++\r
2\r
3Copyright (c) 2007, Intel Corporation \r
4All rights reserved. This program and the accompanying materials \r
5are licensed and made available under the terms and conditions of the BSD License \r
6which accompanies this distribution. The full text of the license may be found at \r
7http://opensource.org/licenses/bsd-license.php \r
8 \r
9THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
10WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
11\r
12Module Name:\r
13\r
14 DMARemappingReportingTable.h\r
15\r
16Abstract:\r
17\r
18 The definition for ACPI DMA-Remapping Reporting (DMAR) Table.\r
19 It is defined in "Intel VT for Direct IO Architecture Specification".\r
20\r
21--*/\r
22\r
23#ifndef _EFI_DMA_REMAPPING_REPORTING_TABLE_H_\r
24#define _EFI_DMA_REMAPPING_REPORTING_TABLE_H_\r
25\r
26#include "AcpiCommon.h"\r
27\r
28//\r
29// "DMAR" DMAR Description Table Signature\r
30//\r
31#define EFI_ACPI_DMAR_DESCRIPTION_TABLE_SIGNATURE 0x52414d44\r
32\r
33//\r
34// DMAR Revision\r
35//\r
36#define EFI_ACPI_DMAR_DESCRIPTION_TABLE_REVISION 0x01\r
37\r
38//\r
39// Ensure proper structure formats\r
40//\r
41#pragma pack (1)\r
42\r
43//\r
44// Definition for DMA Remapping Structure Types\r
45//\r
46#define EFI_ACPI_DMA_REMAPPING_STRUCTURE_TYPE_DRHD 0\r
47#define EFI_ACPI_DMA_REMAPPING_STRUCTURE_TYPE_RMRR 1\r
48#define EFI_ACPI_DMA_REMAPPING_STRUCTURE_TYPE_ATSR 2\r
49\r
50//\r
51// Definition for DMA Remapping Structure Header\r
52//\r
53typedef struct {\r
54 UINT16 Type;\r
55 UINT16 Length;\r
56} EFI_ACPI_DMAR_STRUCTURE_HEADER;\r
57\r
58//\r
59// Definition for DMA-Remapping PCI Path\r
60//\r
61typedef struct {\r
62 UINT8 Device;\r
63 UINT8 Function;\r
64} EFI_ACPI_DMAR_PCI_PATH;\r
65\r
66//\r
67// Definition for DMA-Remapping Device Scope Entry Structure\r
68//\r
69#define EFI_ACPI_DEVICE_SCOPE_ENTRY_TYPE_ENDPOINT 0x01\r
70#define EFI_ACPI_DEVICE_SCOPE_ENTRY_TYPE_BRIDGE 0x02\r
71#define EFI_ACPI_DEVICE_SCOPE_ENTRY_TYPE_IOAPIC 0x03\r
72#define EFI_ACPI_DEVICE_SCOPE_ENTRY_TYPE_MSI_CAPABLE_HPET 0x04\r
73typedef struct {\r
74 UINT8 DeviceScopeEntryType;\r
75 UINT8 Length;\r
76 UINT16 Reserved_2;\r
77 UINT8 EnumerationID;\r
78 UINT8 StartingBusNumber;\r
79} EFI_ACPI_DMAR_DEVICE_SCOPE_ENTRY_STRUCTURE;\r
80\r
81//\r
82// Definition for DMA-Remapping Hardware Definition (DRHD) Structure\r
83//\r
84#define EFI_ACPI_DMAR_DRHD_FLAGS_INCLUDE_ALL_SET 0x1\r
85#define EFI_ACPI_DMAR_DRHD_FLAGS_INCLUDE_ALL_CLEAR 0x0\r
86typedef struct {\r
87 UINT16 Type;\r
88 UINT16 Length;\r
89 UINT8 Flags;\r
90 UINT8 Reserved_5;\r
91 UINT16 SegmentNumber;\r
92 UINT64 RegisterBaseAddress;\r
93} EFI_ACPI_DMAR_HARDWARE_UNIT_DEFINITION_STRUCTURE;\r
94\r
95//\r
96// Definition for Reserved Memory Region Reporting (RMRR) Structure\r
97//\r
98typedef struct {\r
99 UINT16 Type;\r
100 UINT16 Length;\r
101 UINT8 Reserved_4[2];\r
102 UINT16 SegmentNumber;\r
103 UINT64 ReservedMemoryRegionBaseAddress;\r
104 UINT64 ReservedMemoryRegionLimitAddress;\r
105} EFI_ACPI_DMAR_RESERVED_MEMORY_REGION_REPORTING_STRUCTURE;\r
106\r
107//\r
108// Definition for Root Port ATS Capability Reporting (ATSR) Structure\r
109//\r
110#define EFI_ACPI_DMAR_ATSR_FLAGS_ALL_PORTS_SET 0x1\r
111#define EFI_ACPI_DMAR_ATSR_FLAGS_ALL_PORTS_CLEAR 0x0\r
112typedef struct {\r
113 UINT16 Type;\r
114 UINT16 Length;\r
115 UINT8 Flags;\r
116 UINT8 Reserved_5;\r
117 UINT16 SegmentNumber;\r
118} EFI_ACPI_DMAR_ROOT_PORT_ATS_CAPABILITY_REPORTING_STRUCTURE;\r
119\r
120//\r
121// Definition for DMA Remapping Structure\r
122//\r
123typedef union {\r
124 EFI_ACPI_DMAR_STRUCTURE_HEADER DMARStructureHeader;\r
125 EFI_ACPI_DMAR_HARDWARE_UNIT_DEFINITION_STRUCTURE DMARHardwareUnitDefinition;\r
126 EFI_ACPI_DMAR_RESERVED_MEMORY_REGION_REPORTING_STRUCTURE DMARReservedMemoryRegionReporting;\r
127 EFI_ACPI_DMAR_ROOT_PORT_ATS_CAPABILITY_REPORTING_STRUCTURE DMARRootPortATSCapabilityReporting;\r
128} EFI_ACPI_DMA_REMAPPING_STRUCTURE;\r
129\r
130//\r
131// Definition for DMA-Remapping Reporting ACPI Table\r
132//\r
712c0723 133#define EFI_ACPI_DMAR_TABLE_FLAGS_INTR_REMAP_CLEAR 0x00\r
3eb9473e 134#define EFI_ACPI_DMAR_TABLE_FLAGS_INTR_REMAP_SET 0x01\r
135typedef struct {\r
136 EFI_ACPI_DESCRIPTION_HEADER Header;\r
137 UINT8 HostAddressWidth;\r
138 UINT8 Flags;\r
139 UINT8 Reserved_38[10];\r
140} EFI_ACPI_DMAR_DESCRIPTION_TABLE;\r
141\r
142//\r
143// The Platform specific definition can be as follows:\r
144// NOTE: we use /**/ as comment for user convenience to copy it.\r
145//\r
146\r
147/*\r
148\r
149//\r
150// Dmar.h\r
151//\r
152\r
153#define EFI_ACPI_MAX_NUM_PCI_PATH_ENTRIES 0x01 // user need to update\r
154typedef struct {\r
155 EFI_ACPI_DMAR_DEVICE_SCOPE_ENTRY_STRUCTURE Header;\r
156 EFI_ACPI_DMAR_PCI_PATH PciPath[EFI_ACPI_MAX_NUM_PCI_PATH_ENTRIES]; \r
157} EFI_ACPI_3_0_DMAR_DEVICE_SCOPE_ENTRY_STRUCTURE;\r
158\r
159#define EFI_ACPI_MAX_NUM_OF_DEVICE_SCOPE_PER_DHRD_ENTRY 0x01 // user need to update\r
160typedef struct {\r
161 EFI_ACPI_DMAR_HARDWARE_UNIT_DEFINITION_STRUCTURE Header;\r
162 EFI_ACPI_3_0_DMAR_DEVICE_SCOPE_ENTRY_STRUCTURE DeviceScopeEntry[EFI_ACPI_MAX_NUM_OF_DEVICE_SCOPE_PER_DHRD_ENTRY];\r
163} EFI_ACPI_3_0_DMAR_HARDWARE_UNIT_DEFINITION_STRUCTURE;\r
164\r
165#define EFI_ACPI_MAX_NUM_OF_DEVICE_SCOPE_PER_RMRR_ENTRY 0x01 // user need to update\r
166typedef struct {\r
167 EFI_ACPI_DMAR_RESERVED_MEMORY_REGION_REPORTING_STRUCTURE Header;\r
168 EFI_ACPI_3_0_DMAR_DEVICE_SCOPE_ENTRY_STRUCTURE DeviceScopeEntry[EFI_ACPI_MAX_NUM_OF_DEVICE_SCOPE_PER_RMRR_ENTRY];\r
169} EFI_ACPI_3_0_DMAR_RESERVED_MEMORY_REGION_REPORTING_STRUCTURE;\r
170\r
171#define EFI_ACPI_MAX_NUM_OF_DEVICE_SCOPE_PER_ATSR_ENTRY 0x01 // user need to update\r
172typedef struct {\r
173 EFI_ACPI_DMAR_ROOT_PORT_ATS_CAPABILITY_REPORTING_STRUCTURE Header;\r
174 EFI_ACPI_3_0_DMAR_DEVICE_SCOPE_ENTRY_STRUCTURE DeviceScopeEntry[EFI_ACPI_MAX_NUM_OF_DEVICE_SCOPE_PER_ATSR_ENTRY];\r
175} EFI_ACPI_3_0_DMAR_ROOT_PORT_ATS_CAPABILITY_REPORTING_STRUCTURE;\r
176\r
177#define EFI_ACPI_DMAR_DHRD_ENTRY_COUNT 0x1 // user need to update\r
178#define EFI_ACPI_DMAR_RMRR_ENTRY_COUNT 0x1 // user need to update\r
179#define EFI_ACPI_DMAR_ATSR_ENTRY_COUNT 0x1 // user need to update\r
180\r
181typedef struct {\r
182 EFI_ACPI_DMAR_DESCRIPTION_TABLE Header;\r
183\r
184#if EFI_ACPI_3_0_DMAR_DHRD_ENTRY_COUNT > 0\r
185 EFI_ACPI_3_0_DMAR_HARDWARE_UNIT_DEFINITION_STRUCTURE Dhrd[EFI_ACPI_DMAR_DHRD_ENTRY_COUNT];\r
186#endif\r
187\r
188#if EFI_ACPI_3_0_DMAR_RMRR_ENTRY_COUNT > 0\r
189 EFI_ACPI_3_0_DMAR_RESERVED_MEMORY_REGION_REPORTING_STRUCTURE Rmrr[EFI_ACPI_DMAR_RMRR_ENTRY_COUNT];\r
190#endif\r
191\r
192#if EFI_ACPI_3_0_DMAR_ATSR_ENTRY_COUNT > 0\r
193 EFI_ACPI_3_0_DMAR_ROOT_PORT_ATS_CAPABILITY_REPORTING_STRUCTURE Atsr[EFI_ACPI_DMAR_ATSR_ENTRY_COUNT];\r
194#endif\r
195\r
196} EFI_ACPI_3_0_DMA_REMAPPING_REPORTING_TABLE;\r
197\r
198*/\r
199\r
200#pragma pack()\r
201\r
202#endif\r
203\r