pveum: improve tfa section

[pve-docs.git] / qm-pci-passthrough.adoc

diff --git a/qm-pci-passthrough.adoc b/qm-pci-passthrough.adoc
index 8ea05ab096fb547bbaf839ec1fcb57a5a0b0003c..abb9075abd163ad59761834435a3b771e6f0e855 100644 (file)
--- a/qm-pci-passthrough.adoc
+++ b/qm-pci-passthrough.adoc
@@ -1,6 +1,9 @@
 [[qm_pci_passthrough]]
 PCI(e) Passthrough
 ------------------
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
 
 PCI(e) passthrough is a mechanism to give a virtual machine control over
 a PCI device from the host. This can have some advantages over using
@@ -30,7 +33,7 @@ Further, server grade hardware has often better support than consumer grade
 hardware, but even then, many modern system can support this.
 
 Please refer to your hardware vendor to check if they support this feature
-under Linux for your specific setup
+under Linux for your specific setup.
 
 
 Configuration
@@ -42,9 +45,10 @@ some configuration to enable PCI(e) passthrough.
 
 .IOMMU
 
-The IOMMU has to be activated on the kernel commandline. The easiest way is to
-enable trough grub. Edit `'/etc/default/grub'' and add the following to the
-'GRUB_CMDLINE_LINUX_DEFAULT' variable:
+The IOMMU has to be activated on the
+xref:sysboot_edit_kernel_cmdline[kernel commandline].
+
+The command line parameters are:
 
 * for Intel CPUs:
 +
@@ -57,12 +61,6 @@ enable trough grub. Edit `'/etc/default/grub'' and add the following to the
  amd_iommu=on
 ----
 
-[[qm_pci_passthrough_update_grub]]
-To bring this change in effect, make sure you run:
-
-----
-# update-grub
-----
 
 .Kernel Modules
 
@@ -90,7 +88,7 @@ Finally reboot to bring the changes into effect and check that it is indeed
 enabled.
 
 ----
-# dmesg -e DMAR -e IOMMU -e AMD-Vi
+# dmesg | grep -e DMAR -e IOMMU -e AMD-Vi
 ----
 
 should display that `IOMMU`, `Directed I/O` or `Interrupt Remapping` is
@@ -151,7 +149,7 @@ PCI(e) card, for example a GPU or a network card.
 Host Configuration
 ^^^^^^^^^^^^^^^^^^
 
-In this case, the host cannot use the card. There are two methods to achieve
+In this case, the host must not use the card. There are two methods to achieve
 this:
 
 * pass the device IDs to the options of the 'vfio-pci' modules by adding
@@ -164,7 +162,7 @@ to a .conf file in */etc/modprobe.d/* where `1234:5678` and `4321:8765` are
 the vendor and device IDs obtained by:
 +
 ----
-# lcpci -nn
+# lspci -nn
 ----
 
 * blacklist the driver completely on the host, ensuring that it is free to bind
@@ -180,6 +178,23 @@ For both methods you need to
 xref:qm_pci_passthrough_update_initramfs[update the `initramfs`] again and
 reboot after that.
 
+.Verify Configuration
+
+To check if your changes were successful, you can use
+
+----
+# lspci -nnk
+----
+
+and check your device entry. If it says
+
+----
+Kernel driver in use: vfio-pci
+----
+
+or the 'in use' line is missing entirely, the device is ready to be used for
+passthrough.
+
 [[qm_pci_passthrough_vm_config]]
 VM Configuration
 ^^^^^^^^^^^^^^^^
@@ -190,7 +205,7 @@ configuration, for example by executing:
 # qm set VMID -hostpci0 00:02.0
 ----
 
-If your device has multiple functions (e.g., ``00:02.0`' and ``00:02.1`'),
+If your device has multiple functions (e.g., ``00:02.0`' and ``00:02.1`' ),
 you can pass them through all together with the shortened syntax ``00:02`'
 
 There are some options to which may be necessary, depending on the device
@@ -292,7 +307,7 @@ vendor.
 Mediated Devices (vGPU, GVT-g)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Mediated devices are another method to use reuse features and performance from
+Mediated devices are another method to reuse features and performance from
 physical hardware for virtualized hardware. These are found most common in
 virtualized GPU setups such as Intels GVT-g and Nvidias vGPUs used in their
 GRID technology.
@@ -306,17 +321,16 @@ Host Configuration
 ^^^^^^^^^^^^^^^^^^
 
 In general your card's driver must support that feature, otherwise it will
-not work. So please refer to your vendor for compatbile drivers and how to
+not work. So please refer to your vendor for compatible drivers and how to
 configure them.
 
-Intels drivers for GVT-g are integraded in the Kernel and should work
-with the 5th, 6th and 7th generation Intel Core Processors, further E3 v4, E3
-v5 and E3 v6 Xeon Processors are supported.
+Intels drivers for GVT-g are integrated in the Kernel and should work
+with 5th, 6th and 7th generation Intel Core Processors, as well as E3 v4, E3
+v5 and E3 v6 Xeon Processors.
 
-To enable it for Intel Graphcs, you have to make sure to load the module
-'kvmgt' (for example via `/etc/modules`) and to enable it on the Kernel
-commandline. For this you can edit `'/etc/default/grub'' and add the following
-to the 'GRUB_CMDLINE_LINUX_DEFAULT' variable:
+To enable it for Intel Graphics, you have to make sure to load the module
+'kvmgt' (for example via `/etc/modules`) and to enable it on the
+xref:sysboot_edit_kernel_cmdline[Kernel commandline] and add the following parameter:
 
 ----
  i915.enable_gvt=1
@@ -324,8 +338,7 @@ to the 'GRUB_CMDLINE_LINUX_DEFAULT' variable:
 
 After that remember to
 xref:qm_pci_passthrough_update_initramfs[update the `initramfs`],
-xref:qm_pci_passthrough_update_grub[update grub] and
-reboot your host.
+and reboot your host.
 
 VM Configuration
 ^^^^^^^^^^^^^^^^
@@ -356,3 +369,12 @@ Example configuration with an `Intel GVT-g vGPU` (`Intel Skylake 6700k`):
 
 With this set, {pve} automatically creates such a device on VM start, and
 cleans it up again when the VM stops.
+
+ifdef::wiki[]
+
+See Also
+~~~~~~~~
+
+* link:/wiki/Pci_passthrough[PCI Passthrough Examples]
+
+endif::wiki[]