From a95a92208d6c5413dac9e551a30f429f98faa121 Mon Sep 17 00:00:00 2001 From: Seth Howell Date: Tue, 11 Feb 2020 12:46:35 -0700 Subject: [PATCH] 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: Seth Howell Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/814 Reviewed-by: Paul Luse Reviewed-by: Aleksey Marchuk Reviewed-by: Shuhei Matsumoto Reviewed-by: Darek Stojaczyk Reviewed-by: Ben Walker Tested-by: SPDK CI Jenkins --- doc/system_configuration.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/system_configuration.md b/doc/system_configuration.md index a71092595..bbdebdf01 100644 --- a/doc/system_configuration.md +++ b/doc/system_configuration.md @@ -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`.