xref: /spdk/doc/system_configuration.md (revision 75c2135de5d2e752b8a851e3fa55395b02a47bed)
1# System Configuration User Guide {#system_configuration}
2
3This system configuration guide describes how to configure a system for use with SPDK.
4
5# IOMMU configuration {#iommu_config}
6
7An IOMMU may be present and enabled on many platforms. When an IOMMU is present and enabled, it is
8recommended that SPDK applications are deployed with the `vfio-pci` kernel driver. SPDK's
9`scripts/setup.sh` script will automatically select `vfio-pci` in this case.
10
11However, some devices do not function correctly when bound to `vfio-pci` and instead must be
12attached to the `uio_pci_generic` kernel driver. In that case, users should take care to disable
13the IOMMU or to set it into passthrough mode prior to running `scripts/setup.sh`.
14
15To disable the IOMMU or place it into passthrough mode, add `intel_iommu=off`
16or `amd_iommu=off` or `intel_iommu=on iommu=pt` to the GRUB command line on
17x86_64 system, or add `iommu.passthrough=1` on arm64 systems.
18
19There are also some instances where a user may not want to use `uio_pci_generic` or the kernel
20version they are using has a bug where `uio_pci_generic` [fails to bind to NVMe drives](https://github.com/spdk/spdk/issues/399).
21In these cases, users building with the DPDK submodule can build the `igb_uio` kernel module by
22supplying `--with-igb-uio-driver` to `./configure`. Upon a successful make, the file will be
23located at `dpdk/build/build/kmod/igb_uio.ko`. To ensure that the driver is properly bound, users
24should specify `DRIVER_OVERRIDE=/path/to/igb_uio.ko`.
25