s390: kernel: Remove redundant license text
[linux/fpc-iii.git] / Documentation / Intel-IOMMU.txt
blob9dae6b47e398b09778b48f1bce6bcf2b1c310a8b
1 ===================
2 Linux IOMMU Support
3 ===================
5 The architecture spec can be obtained from the below location.
7 http://www.intel.com/content/dam/www/public/us/en/documents/product-specifications/vt-directed-io-spec.pdf
9 This guide gives a quick cheat sheet for some basic understanding.
11 Some Keywords
13 - DMAR - DMA remapping
14 - DRHD - DMA Remapping Hardware Unit Definition
15 - RMRR - Reserved memory Region Reporting Structure
16 - ZLR  - Zero length reads from PCI devices
17 - IOVA - IO Virtual address.
19 Basic stuff
20 -----------
22 ACPI enumerates and lists the different DMA engines in the platform, and
23 device scope relationships between PCI devices and which DMA engine  controls
24 them.
26 What is RMRR?
27 -------------
29 There are some devices the BIOS controls, for e.g USB devices to perform
30 PS2 emulation. The regions of memory used for these devices are marked
31 reserved in the e820 map. When we turn on DMA translation, DMA to those
32 regions will fail. Hence BIOS uses RMRR to specify these regions along with
33 devices that need to access these regions. OS is expected to setup
34 unity mappings for these regions for these devices to access these regions.
36 How is IOVA generated?
37 ----------------------
39 Well behaved drivers call pci_map_*() calls before sending command to device
40 that needs to perform DMA. Once DMA is completed and mapping is no longer
41 required, device performs a pci_unmap_*() calls to unmap the region.
43 The Intel IOMMU driver allocates a virtual address per domain. Each PCIE
44 device has its own domain (hence protection). Devices under p2p bridges
45 share the virtual address with all devices under the p2p bridge due to
46 transaction id aliasing for p2p bridges.
48 IOVA generation is pretty generic. We used the same technique as vmalloc()
49 but these are not global address spaces, but separate for each domain.
50 Different DMA engines may support different number of domains.
52 We also allocate guard pages with each mapping, so we can attempt to catch
53 any overflow that might happen.
56 Graphics Problems?
57 ------------------
58 If you encounter issues with graphics devices, you can try adding
59 option intel_iommu=igfx_off to turn off the integrated graphics engine.
60 If this fixes anything, please ensure you file a bug reporting the problem.
62 Some exceptions to IOVA
63 -----------------------
64 Interrupt ranges are not address translated, (0xfee00000 - 0xfeefffff).
65 The same is true for peer to peer transactions. Hence we reserve the
66 address from PCI MMIO ranges so they are not allocated for IOVA addresses.
69 Fault reporting
70 ---------------
71 When errors are reported, the DMA engine signals via an interrupt. The fault
72 reason and device that caused it with fault reason is printed on console.
74 See below for sample.
77 Boot Message Sample
78 -------------------
80 Something like this gets printed indicating presence of DMAR tables
81 in ACPI.
83 ACPI: DMAR (v001 A M I  OEMDMAR  0x00000001 MSFT 0x00000097) @ 0x000000007f5b5ef0
85 When DMAR is being processed and initialized by ACPI, prints DMAR locations
86 and any RMRR's processed::
88         ACPI DMAR:Host address width 36
89         ACPI DMAR:DRHD (flags: 0x00000000)base: 0x00000000fed90000
90         ACPI DMAR:DRHD (flags: 0x00000000)base: 0x00000000fed91000
91         ACPI DMAR:DRHD (flags: 0x00000001)base: 0x00000000fed93000
92         ACPI DMAR:RMRR base: 0x00000000000ed000 end: 0x00000000000effff
93         ACPI DMAR:RMRR base: 0x000000007f600000 end: 0x000000007fffffff
95 When DMAR is enabled for use, you will notice..
97 PCI-DMA: Using DMAR IOMMU
99 Fault reporting
100 ---------------
104         DMAR:[DMA Write] Request device [00:02.0] fault addr 6df084000
105         DMAR:[fault reason 05] PTE Write access is not set
106         DMAR:[DMA Write] Request device [00:02.0] fault addr 6df084000
107         DMAR:[fault reason 05] PTE Write access is not set
110 ----
112 - For compatibility testing, could use unity map domain for all devices, just
113   provide a 1-1 for all useful memory under a single domain for all devices.
114 - API for paravirt ops for abstracting functionality for VMM folks.