Commit a95a9220 authored by Seth Howell's avatar Seth Howell Committed by Tomasz Zawadzki
Browse files

doc: update system_config to include igb_uio. 



This will be a useful workaround for kernels which don't support binding
NVMe drives to uio_pci_generic.

Change-Id: Idf895882c1a5adb50935083c9176b3af0ddd637e
Signed-off-by: default avatarSeth Howell <seth.howell@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/814


Reviewed-by: default avatarPaul Luse <paul.e.luse@intel.com>
Reviewed-by: default avatarAleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: default avatarDarek Stojaczyk <dariusz.stojaczyk@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
parent b4aa3074

doc/system_configuration.md

+7 −0
Original line number Diff line number Diff line
@@ -15,3 +15,10 @@ the IOMMU or to set it into passthrough mode prior to running `scripts/setup.sh` 
To disable the IOMMU or place it into passthrough mode, add `intel_iommu=off`

or `amd_iommu=off` or `intel_iommu=on iommu=pt` to the GRUB command line on

x86_64 system, or add `iommu.passthrough=1` on arm64 systems.



There are also some instances where a user may not want to use `uio_pci_generic` or the kernel

version they are using has a bug where `uio_pci_generic` [fails to bind to NVMe drives](https://github.com/spdk/spdk/issues/399).

In these cases, users building with the DPDK submodule can build the `igb_uio` kernel module by

supplying `--with-igb-uio-driver` to `./configure`. Upon a successful make, the file will be

located at `dpdk/build/build/kmod/igb_uio.ko`. To ensure that the driver is properly bound, users

should specify `DRIVER_OVERRIDE=/path/to/igb_uio.ko`.