Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/108745/?format=api
{ "id": 108745, "url": "http://patches.dpdk.org/api/patches/108745/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20220316134551.1099599-8-bruce.richardson@intel.com/", "project": { "id": 1, "url": "http://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20220316134551.1099599-8-bruce.richardson@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20220316134551.1099599-8-bruce.richardson@intel.com", "date": "2022-03-16T13:45:49", "name": "[v2,7/9] doc: move GSG section on UIO to the end of drivers page", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": true, "hash": "4631c6079ac2ebacce23861db020997e3aeed46c", "submitter": { "id": 20, "url": "http://patches.dpdk.org/api/people/20/?format=api", "name": "Bruce Richardson", "email": "bruce.richardson@intel.com" }, "delegate": { "id": 1, "url": "http://patches.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20220316134551.1099599-8-bruce.richardson@intel.com/mbox/", "series": [ { "id": 22162, "url": "http://patches.dpdk.org/api/series/22162/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=22162", "date": "2022-03-16T13:45:42", "name": "Improve Linux drivers GSG section", "version": 2, "mbox": "http://patches.dpdk.org/series/22162/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/108745/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/108745/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 70EA2A0032;\n\tWed, 16 Mar 2022 14:47:00 +0100 (CET)", "from [217.70.189.124] (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id BE1AF41172;\n\tWed, 16 Mar 2022 14:46:22 +0100 (CET)", "from mga14.intel.com (mga14.intel.com [192.55.52.115])\n by mails.dpdk.org (Postfix) with ESMTP id 396644116E;\n Wed, 16 Mar 2022 14:46:14 +0100 (CET)", "from orsmga005.jf.intel.com ([10.7.209.41])\n by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;\n 16 Mar 2022 06:46:13 -0700", "from silpixa00399126.ir.intel.com ([10.237.223.34])\n by orsmga005.jf.intel.com with ESMTP; 16 Mar 2022 06:46:08 -0700" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple;\n d=intel.com; i=@intel.com; q=dns/txt; s=Intel;\n t=1647438374; x=1678974374;\n h=from:to:cc:subject:date:message-id:in-reply-to:\n references:mime-version:content-transfer-encoding;\n bh=Cj9LcwcfQ2wRE6ZH8iBKgBeeTq3XhxZdVgW1sWmKzGQ=;\n b=G/oBsItoOPUd3fr5DzEh6Y8DTDxrVIjY8CqvBvBBTeZcToX9vMoqbJkm\n iOnOZKAHozlTNBhYJSp8cCDb6nokVqhLHKCMTUtOlHLQzJ4vQvPcFHO4p\n iD36xZXYMu11E/dQfnOooKxpoxNs07MV3bpD23Nm6FIYYPpWy0PtdP8gp\n 6U8SzZOL8KSWMp/y8go3OehvMPyCb+Ip8jFOcFgV3ArBTJGE5Pao5cC3O\n fnzTFaY7D5Ev8l1GGH0xYxBUcTFRu4cA/per/ecElJBdWGWeMbQPRuu0b\n KH3CJAwX8rn16s8mhPs6mLMIpYgMda7V3Rs9PmYETa8GbWOmmhm41e1fq w==;", "X-IronPort-AV": [ "E=McAfee;i=\"6200,9189,10286\"; a=\"256780596\"", "E=Sophos;i=\"5.90,186,1643702400\"; d=\"scan'208\";a=\"256780596\"", "E=Sophos;i=\"5.90,186,1643702400\"; d=\"scan'208\";a=\"714606516\"" ], "X-ExtLoop1": "1", "From": "Bruce Richardson <bruce.richardson@intel.com>", "To": "dev@dpdk.org", "Cc": "Bruce Richardson <bruce.richardson@intel.com>,\n\tstable@dpdk.org", "Subject": "[PATCH v2 7/9] doc: move GSG section on UIO to the end of drivers\n page", "Date": "Wed, 16 Mar 2022 13:45:49 +0000", "Message-Id": "<20220316134551.1099599-8-bruce.richardson@intel.com>", "X-Mailer": "git-send-email 2.32.0", "In-Reply-To": "<20220316134551.1099599-1-bruce.richardson@intel.com>", "References": "<20220302172217.472279-1-bruce.richardson@intel.com>\n <20220316134551.1099599-1-bruce.richardson@intel.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "To further de-emphasise UIO over the alternatives, we can move the UIO\nsection of the drivers page to the end of the document, giving more\nprominence to VFIO and bifurcated drivers.\n\nCc: stable@dpdk.org\n\nSigned-off-by: Bruce Richardson <bruce.richardson@intel.com>\n---\n doc/guides/linux_gsg/linux_drivers.rst | 104 ++++++++++++-------------\n 1 file changed, 52 insertions(+), 52 deletions(-)\n\n--\n2.32.0", "diff": "diff --git a/doc/guides/linux_gsg/linux_drivers.rst b/doc/guides/linux_gsg/linux_drivers.rst\nindex f9c24e9456..6ff8586940 100644\n--- a/doc/guides/linux_gsg/linux_drivers.rst\n+++ b/doc/guides/linux_gsg/linux_drivers.rst\n@@ -250,58 +250,6 @@ After that, VFIO can be used with hardware devices as usual.\n to keep the degree of device access and programming that VFIO has,\n in situations where IOMMU is not available.\n\n-.. _uio:\n-\n-UIO\n----\n-\n-.. warning::\n-\n- Using UIO drivers is inherently unsafe due to this method lacking IOMMU protection,\n- and can only be done by root user.\n-\n-In situations where using VFIO is not an option, there are alternative drivers one can use.\n-In many cases, the standard ``uio_pci_generic`` module included in the Linux kernel\n-can be used as a substitute for VFIO. This module can be loaded using the command:\n-\n-.. code-block:: console\n-\n- sudo modprobe uio_pci_generic\n-\n-.. note::\n-\n- ``uio_pci_generic`` module doesn't support the creation of virtual functions.\n-\n-As an alternative to the ``uio_pci_generic``, there is the ``igb_uio`` module\n-which can be found in the repository `dpdk-kmods <http://git.dpdk.org/dpdk-kmods>`_.\n-It can be loaded as shown below:\n-\n-.. code-block:: console\n-\n- sudo modprobe uio\n- sudo insmod igb_uio.ko\n-\n-.. note::\n-\n- For some devices which lack support for legacy interrupts, e.g. virtual function\n- (VF) devices, the ``igb_uio`` module may be needed in place of ``uio_pci_generic``.\n-\n-.. note::\n-\n- If UEFI secure boot is enabled,\n- the Linux kernel may disallow the use of UIO on the system.\n- Therefore, devices for use by DPDK should be bound to the ``vfio-pci`` kernel module\n- rather than any UIO-based module.\n- For more details see :ref:`linux_gsg_binding_kernel` below.\n-\n-.. note::\n-\n- If the devices used for DPDK are bound to a UIO-based kernel module,\n- please make sure that the IOMMU is disabled or is in passthrough mode.\n- One can add ``intel_iommu=off`` or ``amd_iommu=off`` or ``intel_iommu=on iommu=pt``\n- in GRUB command line on x86_64 systems,\n- or add ``iommu.passthrough=1`` on aarch64 systems.\n-\n .. _bifurcated_driver:\n\n Bifurcated Driver\n@@ -372,3 +320,55 @@ This can be checked in the boot configuration of your system:\n If ``CONFIG_VFIO_NOIOMMU`` is not enabled in the kernel configuration,\n VFIO driver will not support the no-IOMMU mode,\n and other alternatives (such as UIO drivers) will have to be used.\n+\n+.. _uio:\n+\n+UIO\n+---\n+\n+.. warning::\n+\n+ Using UIO drivers is inherently unsafe due to this method lacking IOMMU protection,\n+ and can only be done by root user.\n+\n+In situations where using VFIO is not an option, there are alternative drivers one can use.\n+In many cases, the standard ``uio_pci_generic`` module included in the Linux kernel\n+can be used as a substitute for VFIO. This module can be loaded using the command:\n+\n+.. code-block:: console\n+\n+ sudo modprobe uio_pci_generic\n+\n+.. note::\n+\n+ ``uio_pci_generic`` module doesn't support the creation of virtual functions.\n+\n+As an alternative to the ``uio_pci_generic``, there is the ``igb_uio`` module\n+which can be found in the repository `dpdk-kmods <http://git.dpdk.org/dpdk-kmods>`_.\n+It can be loaded as shown below:\n+\n+.. code-block:: console\n+\n+ sudo modprobe uio\n+ sudo insmod igb_uio.ko\n+\n+.. note::\n+\n+ For some devices which lack support for legacy interrupts, e.g. virtual function\n+ (VF) devices, the ``igb_uio`` module may be needed in place of ``uio_pci_generic``.\n+\n+.. note::\n+\n+ If UEFI secure boot is enabled,\n+ the Linux kernel may disallow the use of UIO on the system.\n+ Therefore, devices for use by DPDK should be bound to the ``vfio-pci`` kernel module\n+ rather than any UIO-based module.\n+ For more details see :ref:`linux_gsg_binding_kernel` below.\n+\n+.. note::\n+\n+ If the devices used for DPDK are bound to a UIO-based kernel module,\n+ please make sure that the IOMMU is disabled or is in passthrough mode.\n+ One can add ``intel_iommu=off`` or ``amd_iommu=off`` or ``intel_iommu=on iommu=pt``\n+ in GRUB command line on x86_64 systems,\n+ or add ``iommu.passthrough=1`` on aarch64 systems.\n", "prefixes": [ "v2", "7/9" ] }