From patchwork Mon Nov 28 23:19:38 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Chautru, Nicolas" X-Patchwork-Id: 120212 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: 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]) by inbox.dpdk.org (Postfix) with ESMTP id 4A161A0093; Tue, 29 Nov 2022 00:20:07 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id B0C9540693; Tue, 29 Nov 2022 00:20:06 +0100 (CET) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by mails.dpdk.org (Postfix) with ESMTP id D54324021E for ; Tue, 29 Nov 2022 00:20:04 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1669677605; x=1701213605; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=2c75Y+96JfwOAmY8il+su+n/BVYxRnsXrkk8MGY1S6o=; b=SPgmyUMOrbOpLbxWDmK7B3xLaBCI3+6vdp0a9uCLu1dSfts2fiyl7Aw0 CXmtMRFO4s9mlP40VhPXi0nW0dp5TSWns8rvNfQTV1+ZXWXoCoezEntK6 6iBi+lamLMuo4/QyRohGoVGvYnMWfH74CskGbeDWVy45tNBtIBD0Su2eV ISDtk9JY6Dtysd2njTdAHwoFNZmceCypw09FKf+XTqvra3AJBfaCiMgiI +bSmuUIf8W9gmTExz+2e/WOVXiaHWMZoSULKEjFnZLVsgNjOT2fr6zvQn zjEXnp2ZRRCH+mIp5ENFPnIlVGWVWsWZiLKmmgtA/Zv/J1IrP0RikXOZS w==; X-IronPort-AV: E=McAfee;i="6500,9779,10545"; a="379231957" X-IronPort-AV: E=Sophos;i="5.96,201,1665471600"; d="scan'208";a="379231957" Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 28 Nov 2022 15:20:03 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6500,9779,10545"; a="594049123" X-IronPort-AV: E=Sophos;i="5.96,201,1665471600"; d="scan'208";a="594049123" Received: from unknown (HELO icx-npg-scs1-cp1.localdomain) ([10.233.180.245]) by orsmga003.jf.intel.com with ESMTP; 28 Nov 2022 15:20:02 -0800 From: Nicolas Chautru To: dev@dpdk.org, thomas@monjalon.net Cc: maxime.coquelin@redhat.com, hernan.vargas@intel.com, Nicolas Chautru Subject: [PATCH v4 1/3] doc: make the Linux drivers doc more generic Date: Mon, 28 Nov 2022 15:19:38 -0800 Message-Id: <20221128231940.15961-2-nicolas.chautru@intel.com> X-Mailer: git-send-email 2.37.1 In-Reply-To: <20221128231940.15961-1-nicolas.chautru@intel.com> References: <20221128231940.15961-1-nicolas.chautru@intel.com> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Minor change so that for the documentation to be less NIC centric, as these steps can apply more generally to PCIe devices. Signed-off-by: Nicolas Chautru Acked-by: Stephen Hemminger --- doc/guides/linux_gsg/linux_drivers.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/guides/linux_gsg/linux_drivers.rst b/doc/guides/linux_gsg/linux_drivers.rst index 2f3f079aab..7d73893e5a 100644 --- a/doc/guides/linux_gsg/linux_drivers.rst +++ b/doc/guides/linux_gsg/linux_drivers.rst @@ -12,12 +12,12 @@ Linux Drivers Different PMDs may require different kernel drivers in order to work properly. Depending on the PMD being used, a corresponding kernel driver should be loaded, -and network ports should be bound to that driver. +and network ports or other hardware devices should be bound to that driver. .. _linux_gsg_binding_kernel: -Binding and Unbinding Network Ports to/from the Kernel Modules --------------------------------------------------------------- +Binding and Unbinding to/from the Kernel Modules +------------------------------------------------ .. note:: @@ -39,7 +39,7 @@ For such PMDs, any network ports or other hardware under Linux* control will be To bind ports to the ``vfio-pci`` module for DPDK use, or to return ports to Linux control, a utility script called ``dpdk-devbind.py`` is provided in the ``usertools`` subdirectory. -This utility can be used to provide a view of the current state of the network ports on the system, +This utility can be used to provide a view of the current state of the devices on the system, and to bind and unbind those ports from the different kernel modules, including the VFIO and UIO modules. The following are some examples of how the script can be used. @@ -65,10 +65,10 @@ should be loaded into the kernel before running the ``dpdk-devbind.py`` script. .. note:: While any user can run the ``dpdk-devbind.py`` script - to view the status of the network ports, - binding or unbinding network ports requires root privileges. + to view the status of the devices, + binding or unbinding devices requires root privileges. -To see the status of all network ports on the system: +To see the status of all devices on the system: .. code-block:: console