From patchwork Mon Mar 23 16:19:50 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 4114 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id EE3B55A51; Mon, 23 Mar 2015 17:22:52 +0100 (CET) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id 1153D5A7A for ; Mon, 23 Mar 2015 17:22:51 +0100 (CET) Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga101.jf.intel.com with ESMTP; 23 Mar 2015 09:19:52 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.11,452,1422950400"; d="scan'208";a="696432723" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by fmsmga002.fm.intel.com with ESMTP; 23 Mar 2015 09:19:53 -0700 Received: from sivswdev01.ir.intel.com (sivswdev01.ir.intel.com [10.237.217.45]) by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id t2NGJpPN027942; Mon, 23 Mar 2015 16:19:51 GMT Received: from sivswdev01.ir.intel.com (localhost [127.0.0.1]) by sivswdev01.ir.intel.com with ESMTP id t2NGJpS8017943; Mon, 23 Mar 2015 16:19:51 GMT Received: (from bricha3@localhost) by sivswdev01.ir.intel.com with id t2NGJoap017938; Mon, 23 Mar 2015 16:19:50 GMT From: Bruce Richardson To: dev@dpdk.org Date: Mon, 23 Mar 2015 16:19:50 +0000 Message-Id: <1427127590-17899-1-git-send-email-bruce.richardson@intel.com> X-Mailer: git-send-email 1.7.4.1 Subject: [dpdk-dev] [PATCH] doc: add note on needing igb_uio module for VF devs X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Since the uio_pci_generic module requires that the device to which it is being bound supports legacy interrupts, there can be problems using it with VF devices. Add a note to the GSG doc to document this fact, and provide information on loading igb_uio as a replacement. Signed-off-by: Bruce Richardson Acked-by: Bernard Iremonger Acked-by: Siobhan Butler --- doc/guides/linux_gsg/build_dpdk.rst | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/doc/guides/linux_gsg/build_dpdk.rst b/doc/guides/linux_gsg/build_dpdk.rst index 255d6dc..5f0f3ae 100644 --- a/doc/guides/linux_gsg/build_dpdk.rst +++ b/doc/guides/linux_gsg/build_dpdk.rst @@ -166,7 +166,7 @@ Loading Modules to Enable Userspace IO for DPDK ----------------------------------------------- To run any DPDK application, a suitable uio module can be loaded into the running kernel. -In most cases, the standard uio_pci_generic module included in the linux kernel +In many cases, the standard uio_pci_generic module included in the linux kernel can provide the uio capability. This module can be loaded using the command .. code-block:: console @@ -174,7 +174,18 @@ can provide the uio capability. This module can be loaded using the command sudo modprobe uio_pci_generic As an alternative to the uio_pci_generic, the DPDK also includes the igb_uio -module which can be found in the kmod subdirectory referred to above. +module which can be found in the kmod subdirectory referred to above. It can +be loaded as shown below: + +.. code-block:: console + + sudo modprobe uio + sudo insmod kmod/igb_uio.ko + +.. note:: + + For some devices which lack support for legacy interrupts, e.g. virtual function + (VF) devices, the igb_uio module may be needed in place of uio_pci_generic. Since DPDK release 1.7 onward provides VFIO support, use of UIO is optional for platforms that support using VFIO.