From patchwork Mon Nov 2 17:45:00 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 83425 X-Patchwork-Delegate: david.marchand@redhat.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 0155DA04E7; Mon, 2 Nov 2020 18:45:39 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 1B5AC2E8F; Mon, 2 Nov 2020 18:45:35 +0100 (CET) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id 7C8312E8F for ; Mon, 2 Nov 2020 18:45:32 +0100 (CET) IronPort-SDR: bQSBZuRwfbOb0UYyBKPWEBkTIcdJCj2um8sCU2Y5s4J2Ak7yoMp89cV1mNPfNXUX1UVKKEAbVF fauarzohyOMA== X-IronPort-AV: E=McAfee;i="6000,8403,9793"; a="155911686" X-IronPort-AV: E=Sophos;i="5.77,445,1596524400"; d="scan'208";a="155911686" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 02 Nov 2020 09:45:30 -0800 IronPort-SDR: D2FN8SdVWG2Oq9emMrzEkqi6cS9vfAQxnslmgkuzRLNYfVdY+L+EOSmzy/+yuD1QqmSxElzx4f mVnesqn0IQ6Q== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,445,1596524400"; d="scan'208";a="336243364" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by orsmga002.jf.intel.com with ESMTP; 02 Nov 2020 09:45:29 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson , Guy Kaneti , Luca Boccassi , Rosen Xu , Andrew Rybchenko Date: Mon, 2 Nov 2020 17:45:00 +0000 Message-Id: <20201102174507.1085128-2-bruce.richardson@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20201102174507.1085128-1-bruce.richardson@intel.com> References: <20201102174507.1085128-1-bruce.richardson@intel.com> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH 1/8] regex/octeontx2: fix unnecessary name override X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Since the device class is now part of the standard filenames, it's no longer needed in name overrides in specific drivers. Fixes: a20b2c01a7a1 ("build: standardize component names and defines") Signed-off-by: Bruce Richardson --- drivers/regex/octeontx2/meson.build | 1 - 1 file changed, 1 deletion(-) diff --git a/drivers/regex/octeontx2/meson.build b/drivers/regex/octeontx2/meson.build index 398a981c07..0ab32f7788 100644 --- a/drivers/regex/octeontx2/meson.build +++ b/drivers/regex/octeontx2/meson.build @@ -38,7 +38,6 @@ foreach flag: extra_flags endif endforeach -name = 'octeontx2_regex' deps += ['bus_pci', 'common_octeontx2', 'regexdev'] includes += include_directories('../../common/octeontx2') From patchwork Mon Nov 2 17:45:01 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 83426 X-Patchwork-Delegate: david.marchand@redhat.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 7E5AFA04E7; Mon, 2 Nov 2020 18:45:58 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 7F349354D; Mon, 2 Nov 2020 18:45:39 +0100 (CET) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id D9E113421 for ; Mon, 2 Nov 2020 18:45:37 +0100 (CET) IronPort-SDR: KdgIspzewF4S6IsW/l3gQNJMM+u363baP9EPjKUpVNtD9XO3T82OMmRiZqahAJaVqmcxVMww7/ 9/9dsSFZX5UA== X-IronPort-AV: E=McAfee;i="6000,8403,9793"; a="166332076" X-IronPort-AV: E=Sophos;i="5.77,445,1596524400"; d="scan'208";a="166332076" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 02 Nov 2020 09:45:35 -0800 IronPort-SDR: V0Jf4Wh/EkINDdnUNSpown396RGA14hBLHxptS1Lse77ObGyH4lGXRqieaYxMqO/Phha70jeGO SyLYJdXGwI4w== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,445,1596524400"; d="scan'208";a="336243417" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by orsmga002.jf.intel.com with ESMTP; 02 Nov 2020 09:45:33 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson , Lee Daly , Ashish Gupta , Sunila Sahu , Luca Boccassi , Andrew Rybchenko , Rosen Xu Date: Mon, 2 Nov 2020 17:45:01 +0000 Message-Id: <20201102174507.1085128-3-bruce.richardson@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20201102174507.1085128-1-bruce.richardson@intel.com> References: <20201102174507.1085128-1-bruce.richardson@intel.com> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH 2/8] doc: fix driver names in compression devices guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Since the built driver filenames have changed in DPDK 20.11, we need to update the driver doc to match. Fixes: a20b2c01a7a1 ("build: standardize component names and defines") Signed-off-by: Bruce Richardson Reviewed-by: David Marchand --- doc/guides/compressdevs/isal.rst | 2 +- doc/guides/compressdevs/octeontx.rst | 2 +- doc/guides/compressdevs/zlib.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/guides/compressdevs/isal.rst b/doc/guides/compressdevs/isal.rst index 1d146fb4a6..029f8e23d2 100644 --- a/doc/guides/compressdevs/isal.rst +++ b/doc/guides/compressdevs/isal.rst @@ -4,7 +4,7 @@ ISA-L Compression Poll Mode Driver ================================== -The ISA-L PMD (**librte_pmd_isal_comp**) provides poll mode compression & +The ISA-L PMD (**librte_compress_isal**) provides poll mode compression & decompression driver support for utilizing Intel ISA-L library, which implements the deflate algorithm for both Deflate(compression) and Inflate(decompression). diff --git a/doc/guides/compressdevs/octeontx.rst b/doc/guides/compressdevs/octeontx.rst index 8c658721b9..db779fcd1c 100644 --- a/doc/guides/compressdevs/octeontx.rst +++ b/doc/guides/compressdevs/octeontx.rst @@ -4,7 +4,7 @@ OCTEON TX ZIP Compression Poll Mode Driver ========================================== -The OCTEON TX ZIP PMD (**librte_pmd_octeontx_zip**) provides poll mode +The OCTEON TX ZIP PMD (**librte_compress_octeontx**) provides poll mode compression & decompression driver for ZIP HW offload device, found in **Cavium OCTEON TX** SoC family. diff --git a/doc/guides/compressdevs/zlib.rst b/doc/guides/compressdevs/zlib.rst index 6e397ecd7e..8afa7dfbbb 100644 --- a/doc/guides/compressdevs/zlib.rst +++ b/doc/guides/compressdevs/zlib.rst @@ -4,7 +4,7 @@ ZLIB Compression Poll Mode Driver ================================== -The ZLIB PMD (**librte_pmd_zlib**) provides poll mode compression & +The ZLIB PMD (**librte_compress_zlib**) provides poll mode compression & decompression driver based on SW zlib library, Features From patchwork Mon Nov 2 17:45:02 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 83427 X-Patchwork-Delegate: david.marchand@redhat.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id DC7EAA04E7; Mon, 2 Nov 2020 18:46:19 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 1E14837B0; Mon, 2 Nov 2020 18:45:43 +0100 (CET) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id E4D4637B0 for ; Mon, 2 Nov 2020 18:45:40 +0100 (CET) IronPort-SDR: IUqPMKKsYlrPnWdMaoyLho1eEt9jj5R7AzWho7azNrIyKJampXJvyhJsSX8KVffSyiiU5Dm3u6 Rca7jBh6IGMA== X-IronPort-AV: E=McAfee;i="6000,8403,9793"; a="166332086" X-IronPort-AV: E=Sophos;i="5.77,445,1596524400"; d="scan'208";a="166332086" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 02 Nov 2020 09:45:40 -0800 IronPort-SDR: SFKoXzkJlpHNbxZeaA4j4K7Vzq/JvUG1lRX0XxK3FMqmkqtca3MB0UVJDXlwqkt8c0ypoDDRM5 9nL6+e0p0ikg== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,445,1596524400"; d="scan'208";a="336243454" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by orsmga002.jf.intel.com with ESMTP; 02 Nov 2020 09:45:38 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson , Declan Doherty , Pablo de Lara , Somalapuram Amaranath , Fan Zhang , Rosen Xu , Andrew Rybchenko , Luca Boccassi Date: Mon, 2 Nov 2020 17:45:02 +0000 Message-Id: <20201102174507.1085128-4-bruce.richardson@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20201102174507.1085128-1-bruce.richardson@intel.com> References: <20201102174507.1085128-1-bruce.richardson@intel.com> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH 3/8] doc: fix driver names in crypto devices guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Since the built driver filenames have changed in DPDK 20.11, we need to update the driver doc to match. Fixes: a20b2c01a7a1 ("build: standardize component names and defines") Signed-off-by: Bruce Richardson Reviewed-by: David Marchand --- doc/guides/cryptodevs/aesni_gcm.rst | 2 +- doc/guides/cryptodevs/aesni_mb.rst | 2 +- doc/guides/cryptodevs/ccp.rst | 2 +- doc/guides/cryptodevs/kasumi.rst | 2 +- doc/guides/cryptodevs/null.rst | 2 +- doc/guides/cryptodevs/scheduler.rst | 4 ++-- doc/guides/cryptodevs/zuc.rst | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/guides/cryptodevs/aesni_gcm.rst b/doc/guides/cryptodevs/aesni_gcm.rst index e4f244a991..2fd32b021f 100644 --- a/doc/guides/cryptodevs/aesni_gcm.rst +++ b/doc/guides/cryptodevs/aesni_gcm.rst @@ -5,7 +5,7 @@ AES-NI GCM Crypto Poll Mode Driver ================================== -The AES-NI GCM PMD (**librte_pmd_aesni_gcm**) provides poll mode crypto driver +The AES-NI GCM PMD (**librte_crypto_aesni_gcm**) provides poll mode crypto driver support for utilizing Intel multi buffer library (see AES-NI Multi-buffer PMD documentation to learn more about it, including installation). diff --git a/doc/guides/cryptodevs/aesni_mb.rst b/doc/guides/cryptodevs/aesni_mb.rst index 32850c977c..042d95baee 100644 --- a/doc/guides/cryptodevs/aesni_mb.rst +++ b/doc/guides/cryptodevs/aesni_mb.rst @@ -5,7 +5,7 @@ AESN-NI Multi Buffer Crypto Poll Mode Driver ============================================ -The AESNI MB PMD (**librte_pmd_aesni_mb**) provides poll mode crypto driver +The AESNI MB PMD (**librte_crypto_aesni_mb**) provides poll mode crypto driver support for utilizing Intel multi buffer library, see the white paper `Fast Multi-buffer IPsec Implementations on Intel® Architecture Processors `_. diff --git a/doc/guides/cryptodevs/ccp.rst b/doc/guides/cryptodevs/ccp.rst index 4cf9f5907e..36dae090f9 100644 --- a/doc/guides/cryptodevs/ccp.rst +++ b/doc/guides/cryptodevs/ccp.rst @@ -5,7 +5,7 @@ AMD CCP Poll Mode Driver ======================== This code provides the initial implementation of the ccp poll mode driver. -The CCP poll mode driver library (librte_pmd_ccp) implements support for +The CCP poll mode driver library (**librte_crypto_ccp**) implements support for AMD’s cryptographic co-processor (CCP). The CCP PMD is a virtual crypto poll mode driver which schedules crypto operations to one or more available CCP hardware engines on the platform. The CCP PMD provides poll mode crypto diff --git a/doc/guides/cryptodevs/kasumi.rst b/doc/guides/cryptodevs/kasumi.rst index 5770a60cb2..4790f0ff77 100644 --- a/doc/guides/cryptodevs/kasumi.rst +++ b/doc/guides/cryptodevs/kasumi.rst @@ -4,7 +4,7 @@ KASUMI Crypto Poll Mode Driver =============================== -The KASUMI PMD (**librte_pmd_kasumi**) provides poll mode crypto driver support for +The KASUMI PMD (**librte_crypto_kasumi**) provides poll mode crypto driver support for utilizing `Intel IPSec Multi-buffer library `_ which implements F8 and F9 functions for KASUMI UEA1 cipher and UIA1 hash algorithms. diff --git a/doc/guides/cryptodevs/null.rst b/doc/guides/cryptodevs/null.rst index aac5904b1d..12577fa0bf 100644 --- a/doc/guides/cryptodevs/null.rst +++ b/doc/guides/cryptodevs/null.rst @@ -4,7 +4,7 @@ Null Crypto Poll Mode Driver ============================ -The Null Crypto PMD (**librte_pmd_null_crypto**) provides a crypto poll mode +The Null Crypto PMD (**librte_crypto_null**) provides a crypto poll mode driver which provides a minimal implementation for a software crypto device. As a null device it does not modify the data in the mbuf on which the crypto operation is to operate and it only has support for a single cipher and diff --git a/doc/guides/cryptodevs/scheduler.rst b/doc/guides/cryptodevs/scheduler.rst index 0b731fe8ad..835d999cfa 100644 --- a/doc/guides/cryptodevs/scheduler.rst +++ b/doc/guides/cryptodevs/scheduler.rst @@ -13,14 +13,14 @@ crypto ops among them in a certain manner. Cryptodev Scheduler Overview -The Cryptodev Scheduler PMD library (**librte_pmd_crypto_scheduler**) acts as +The Cryptodev Scheduler PMD library (**librte_crypto_scheduler**) acts as a software crypto PMD and shares the same API provided by librte_cryptodev. The PMD supports attaching multiple crypto PMDs, software or hardware, as workers, and distributes the crypto workload to them with certain behavior. The behaviors are categorizes as different "modes". Basically, a scheduling mode defines certain actions for scheduling crypto ops to its workers. -The librte_pmd_crypto_scheduler library exports a C API which provides an API +The librte_crypto_scheduler library exports a C API which provides an API for attaching/detaching workers, set/get scheduling modes, and enable/disable crypto ops reordering. diff --git a/doc/guides/cryptodevs/zuc.rst b/doc/guides/cryptodevs/zuc.rst index 907840ef05..800d371f4b 100644 --- a/doc/guides/cryptodevs/zuc.rst +++ b/doc/guides/cryptodevs/zuc.rst @@ -4,7 +4,7 @@ ZUC Crypto Poll Mode Driver =========================== -The ZUC PMD (**librte_pmd_zuc**) provides poll mode crypto driver support for +The ZUC PMD (**librte_crypto_zuc**) provides poll mode crypto driver support for utilizing `Intel IPSec Multi-buffer library `_ which implements F8 and F9 functions for ZUC EEA3 cipher and EIA3 hash algorithms. From patchwork Mon Nov 2 17:45:03 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 83428 X-Patchwork-Delegate: david.marchand@redhat.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 3CCAAA04E7; Mon, 2 Nov 2020 18:46:39 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 6536A4C89; Mon, 2 Nov 2020 18:45:52 +0100 (CET) Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id F34D64C87 for ; Mon, 2 Nov 2020 18:45:49 +0100 (CET) IronPort-SDR: YYJTU1WmHT18+SiqAPkp1RssI1Xb5VaNR7yP1bLSp8ah/pDp7Ht2hgMzopGHzMi2i8axqvi6Kf YvXl81yTg6Jg== X-IronPort-AV: E=McAfee;i="6000,8403,9793"; a="169056356" X-IronPort-AV: E=Sophos;i="5.77,445,1596524400"; d="scan'208";a="169056356" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga102.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 02 Nov 2020 09:45:47 -0800 IronPort-SDR: JETMOHsUuLYYsUrw/0T3W8OvmTgSdrtsD1WcIlbcyyVLt6/UVSyulIVadPYgKJFp2CBxYtS5zB kcPliQQZggyQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,445,1596524400"; d="scan'208";a="336243531" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by orsmga002.jf.intel.com with ESMTP; 02 Nov 2020 09:45:46 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson , Jerin Jacob , Pavan Nikhilesh , Andrew Rybchenko , Luca Boccassi , Rosen Xu Date: Mon, 2 Nov 2020 17:45:03 +0000 Message-Id: <20201102174507.1085128-5-bruce.richardson@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20201102174507.1085128-1-bruce.richardson@intel.com> References: <20201102174507.1085128-1-bruce.richardson@intel.com> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH 4/8] doc: fix driver names in event devices guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Since the built driver filenames have changed in DPDK 20.11, we need to update the driver doc to match. Fixes: a20b2c01a7a1 ("build: standardize component names and defines") Signed-off-by: Bruce Richardson Reviewed-by: David Marchand --- doc/guides/eventdevs/octeontx.rst | 2 +- doc/guides/eventdevs/octeontx2.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/guides/eventdevs/octeontx.rst b/doc/guides/eventdevs/octeontx.rst index 4621ebe80a..79cae9f7d9 100644 --- a/doc/guides/eventdevs/octeontx.rst +++ b/doc/guides/eventdevs/octeontx.rst @@ -4,7 +4,7 @@ OCTEON TX SSOVF Eventdev Driver =============================== -The OCTEON TX SSOVF PMD (**librte_pmd_octeontx_ssovf**) provides poll mode +The OCTEON TX SSOVF PMD (**librte_event_octeontx**) provides poll mode eventdev driver support for the inbuilt event device found in the **Cavium OCTEON TX** SoC family as well as their virtual functions (VF) in SR-IOV context. diff --git a/doc/guides/eventdevs/octeontx2.rst b/doc/guides/eventdevs/octeontx2.rst index 4f06e06984..242d283965 100644 --- a/doc/guides/eventdevs/octeontx2.rst +++ b/doc/guides/eventdevs/octeontx2.rst @@ -4,7 +4,7 @@ OCTEON TX2 SSO Eventdev Driver =============================== -The OCTEON TX2 SSO PMD (**librte_pmd_octeontx2_event**) provides poll mode +The OCTEON TX2 SSO PMD (**librte_event_octeontx2**) provides poll mode eventdev driver support for the inbuilt event device found in the **Marvell OCTEON TX2** SoC family. From patchwork Mon Nov 2 17:45:04 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 83429 X-Patchwork-Delegate: david.marchand@redhat.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id CBAFDA04E7; Mon, 2 Nov 2020 18:46:56 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id CD6F94C73; Mon, 2 Nov 2020 18:46:07 +0100 (CET) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by dpdk.org (Postfix) with ESMTP id 2B2F0493D for ; Mon, 2 Nov 2020 18:46:04 +0100 (CET) IronPort-SDR: SD7qfO93OgBJg/04ryA9eJ80THbp/cla96ZW0jUT/SVN7sibqpIIEmQsvKKUjSgoOKEZwLhUef pGaZH3o0iw+Q== X-IronPort-AV: E=McAfee;i="6000,8403,9793"; a="233092733" X-IronPort-AV: E=Sophos;i="5.77,445,1596524400"; d="scan'208";a="233092733" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 02 Nov 2020 09:46:03 -0800 IronPort-SDR: 6QxeXhLupYzu9kjbrnj6ylGDmS6XABXaPr2ffiI/kbjcAGfXIES16X8QjUWiauXK5mdRWZrlVz NSStQ6FqM3ew== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,445,1596524400"; d="scan'208";a="336243663" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by orsmga002.jf.intel.com with ESMTP; 02 Nov 2020 09:45:52 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson , Shepard Siegel , Ed Czeck , John Miller , Somalapuram Amaranath , Rasesh Mody , Shahed Shaikh , Ajit Khaparde , Somnath Kotur , Rahul Lakkireddy , Hemant Agrawal , Sachin Saxena , Marcin Wojtas , Michal Krawczyk , Guy Tzalik , Evgeny Schemeilin , Igor Chauskin , Gagandeep Singh , Gaetan Rivet , Ziyang Xuan , Xiaoyun Wang , Guoyang Zhou , "Wei Hu (Xavier)" , "Min Hu (Connor)" , Yisen Zhuang , Beilei Xing , Jeff Guo , Qiming Yang , Qi Zhang , Haiyue Wang , Rosen Xu , Shijith Thotton , Srisivasubramanian Srinivasan , Matan Azrad , Shahaf Shuler , Viacheslav Ovsiienko , Zyta Szpak , Liron Himi , Harman Kalra , Jerin Jacob , Nithin Dabilpuram , Kiran Kumar K , Ferruh Yigit , Akhil Goyal , Andrew Rybchenko , Maciej Czekaj , Luca Boccassi Date: Mon, 2 Nov 2020 17:45:04 +0000 Message-Id: <20201102174507.1085128-6-bruce.richardson@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20201102174507.1085128-1-bruce.richardson@intel.com> References: <20201102174507.1085128-1-bruce.richardson@intel.com> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH 5/8] doc: fix driver names in NIC devices guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Since the built driver filenames have changed in DPDK 20.11, we need to update the driver doc to match. Most drivers start their section with the driver filename highlighted in bold, while a number were missing the highlight. When updating the names, add the markers for bold text to any missing it, so as to have things more consistent. Fixes: a20b2c01a7a1 ("build: standardize component names and defines") Signed-off-by: Bruce Richardson Reviewed-by: David Marchand Reviewed-by: Rosen Xu Acked-by: Ajit Khaparde --- NOTE: the mlx4 and mlx5 chapters include a lot of output text which includes the driver name. I have updated this in the patch to use the new name, but at least for mlx4 I can't see some of the quoted printouts in the code any more, and for both drivers I think the output needs to be double-checked for correctness by maintainers. --- doc/guides/nics/ark.rst | 2 +- doc/guides/nics/axgbe.rst | 2 +- doc/guides/nics/bnx2x.rst | 2 +- doc/guides/nics/bnxt.rst | 2 +- doc/guides/nics/cxgbe.rst | 8 ++-- doc/guides/nics/dpaa.rst | 2 +- doc/guides/nics/dpaa2.rst | 2 +- doc/guides/nics/ena.rst | 2 +- doc/guides/nics/enetc.rst | 2 +- doc/guides/nics/fail_safe.rst | 2 +- doc/guides/nics/hinic.rst | 2 +- doc/guides/nics/hns3.rst | 2 +- doc/guides/nics/i40e.rst | 2 +- doc/guides/nics/ice.rst | 2 +- doc/guides/nics/igb.rst | 2 +- doc/guides/nics/igc.rst | 2 +- doc/guides/nics/ipn3ke.rst | 2 +- doc/guides/nics/liquidio.rst | 2 +- doc/guides/nics/mlx4.rst | 52 +++++++++++++------------- doc/guides/nics/mlx5.rst | 66 ++++++++++++++++----------------- doc/guides/nics/mvneta.rst | 2 +- doc/guides/nics/mvpp2.rst | 2 +- doc/guides/nics/octeontx.rst | 2 +- doc/guides/nics/octeontx2.rst | 2 +- doc/guides/nics/pcap_ring.rst | 4 +- doc/guides/nics/pfe.rst | 2 +- doc/guides/nics/qede.rst | 4 +- doc/guides/nics/sfc_efx.rst | 2 +- doc/guides/nics/thunderx.rst | 4 +- doc/guides/nics/vdev_netvsc.rst | 2 +- 30 files changed, 93 insertions(+), 93 deletions(-) diff --git a/doc/guides/nics/ark.rst b/doc/guides/nics/ark.rst index d9eafa3b88..18434c7a48 100644 --- a/doc/guides/nics/ark.rst +++ b/doc/guides/nics/ark.rst @@ -202,7 +202,7 @@ Usage Example Follow instructions available in the document :ref:`compiling and testing a PMD for a NIC ` to launch -**testpmd** with Atomic Rules ARK devices managed by librte_pmd_ark. +**testpmd** with Atomic Rules ARK devices managed by librte_net_ark. Example output: diff --git a/doc/guides/nics/axgbe.rst b/doc/guides/nics/axgbe.rst index 10bf86fa54..961b5c967d 100644 --- a/doc/guides/nics/axgbe.rst +++ b/doc/guides/nics/axgbe.rst @@ -4,7 +4,7 @@ AXGBE Poll Mode Driver ====================== -The AXGBE poll mode driver library (**librte_pmd_axgbe**) implements support +The AXGBE poll mode driver library (**librte_net_axgbe**) implements support for AMD 10 Gbps family of adapters. It is compiled and tested in standard linux distro like Ubuntu. Detailed information about SoCs that use these devices can be found here: diff --git a/doc/guides/nics/bnx2x.rst b/doc/guides/nics/bnx2x.rst index 3aa8c6c9b0..9ad4f9f410 100644 --- a/doc/guides/nics/bnx2x.rst +++ b/doc/guides/nics/bnx2x.rst @@ -4,7 +4,7 @@ BNX2X Poll Mode Driver ====================== -The BNX2X poll mode driver library (**librte_pmd_bnx2x**) implements support +The BNX2X poll mode driver library (**librte_net_bnx2x**) implements support for **QLogic 578xx** 10/20 Gbps family of adapters as well as their virtual functions (VF) in SR-IOV context. It is supported on several standard Linux distros like RHEL and SLES. It is compile-tested under FreeBSD OS. diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst index 2540ddd5c2..33b2f3fcc0 100644 --- a/doc/guides/nics/bnxt.rst +++ b/doc/guides/nics/bnxt.rst @@ -4,7 +4,7 @@ BNXT Poll Mode Driver ===================== -The Broadcom BNXT PMD (**librte_pmd_bnxt**) implements support for adapters +The Broadcom BNXT PMD (**librte_net_bnxt**) implements support for adapters based on Ethernet controllers and SoCs belonging to the Broadcom BCM574XX/BCM575XX NetXtreme-E® Family of Ethernet Network Controllers, the Broadcom BCM588XX Stingray Family of Smart NIC Adapters, and the Broadcom diff --git a/doc/guides/nics/cxgbe.rst b/doc/guides/nics/cxgbe.rst index 442ab1511c..3fa77d7458 100644 --- a/doc/guides/nics/cxgbe.rst +++ b/doc/guides/nics/cxgbe.rst @@ -5,7 +5,7 @@ CXGBE Poll Mode Driver ====================== -The CXGBE PMD (**librte_pmd_cxgbe**) provides poll mode driver support +The CXGBE PMD (**librte_net_cxgbe**) provides poll mode driver support for **Chelsio Terminator** 10/25/40/100 Gbps family of adapters. CXGBE PMD has support for the latest Linux and FreeBSD operating systems. @@ -36,7 +36,7 @@ Limitations ----------- The Chelsio Terminator series of devices provide two/four ports but -expose a single PCI bus address, thus, librte_pmd_cxgbe registers +expose a single PCI bus address, thus, librte_net_cxgbe registers itself as a PCI driver that allocates one Ethernet device per detected port. @@ -410,7 +410,7 @@ Running testpmd ~~~~~~~~~~~~~~~ This section demonstrates how to launch **testpmd** with Chelsio -devices managed by librte_pmd_cxgbe in Linux operating system. +devices managed by librte_net_cxgbe in Linux operating system. #. Load the kernel module: @@ -660,7 +660,7 @@ Running testpmd ~~~~~~~~~~~~~~~ This section demonstrates how to launch **testpmd** with Chelsio -devices managed by librte_pmd_cxgbe in FreeBSD operating system. +devices managed by librte_net_cxgbe in FreeBSD operating system. #. Change to DPDK source directory where the target has been compiled in section :ref:`driver-compilation`: diff --git a/doc/guides/nics/dpaa.rst b/doc/guides/nics/dpaa.rst index 1deb7faaa5..ae1642b15e 100644 --- a/doc/guides/nics/dpaa.rst +++ b/doc/guides/nics/dpaa.rst @@ -5,7 +5,7 @@ DPAA Poll Mode Driver ===================== -The DPAA NIC PMD (**librte_pmd_dpaa**) provides poll mode driver +The DPAA NIC PMD (**librte_net_dpaa**) provides poll mode driver support for the inbuilt NIC found in the **NXP DPAA** SoC family. More information can be found at `NXP Official Website diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst index 01e37d4621..c9deb53349 100644 --- a/doc/guides/nics/dpaa2.rst +++ b/doc/guides/nics/dpaa2.rst @@ -5,7 +5,7 @@ DPAA2 Poll Mode Driver ====================== -The DPAA2 NIC PMD (**librte_pmd_dpaa2**) provides poll mode driver +The DPAA2 NIC PMD (**librte_net_dpaa2**) provides poll mode driver support for the inbuilt NIC found in the **NXP DPAA2** SoC family. More information can be found at `NXP Official Website diff --git a/doc/guides/nics/ena.rst b/doc/guides/nics/ena.rst index 3312acba52..9fc88f5d99 100644 --- a/doc/guides/nics/ena.rst +++ b/doc/guides/nics/ena.rst @@ -226,7 +226,7 @@ Usage example Follow instructions available in the document :ref:`compiling and testing a PMD for a NIC ` to launch -**testpmd** with Amazon ENA devices managed by librte_pmd_ena. +**testpmd** with Amazon ENA devices managed by librte_net_ena. Example output: diff --git a/doc/guides/nics/enetc.rst b/doc/guides/nics/enetc.rst index 6203f4d799..e2be764bc4 100644 --- a/doc/guides/nics/enetc.rst +++ b/doc/guides/nics/enetc.rst @@ -4,7 +4,7 @@ ENETC Poll Mode Driver ====================== -The ENETC NIC PMD (**librte_pmd_enetc**) provides poll mode driver +The ENETC NIC PMD (**librte_net_enetc**) provides poll mode driver support for the inbuilt NIC found in the **NXP LS1028** SoC. More information can be found at `NXP Official Website diff --git a/doc/guides/nics/fail_safe.rst b/doc/guides/nics/fail_safe.rst index e1b5c80d6c..27ff306b1a 100644 --- a/doc/guides/nics/fail_safe.rst +++ b/doc/guides/nics/fail_safe.rst @@ -4,7 +4,7 @@ Fail-safe poll mode driver library ================================== -The Fail-safe poll mode driver library (**librte_pmd_failsafe**) implements a +The Fail-safe poll mode driver library (**librte_net_failsafe**) implements a virtual device that allows using device supporting hotplug, without modifying other components relying on such device (application, other PMDs). In this context, hotplug support is meant as plugging or removing a device diff --git a/doc/guides/nics/hinic.rst b/doc/guides/nics/hinic.rst index fe13c582e7..3610023122 100644 --- a/doc/guides/nics/hinic.rst +++ b/doc/guides/nics/hinic.rst @@ -5,7 +5,7 @@ HINIC Poll Mode Driver ====================== -The hinic PMD (librte_pmd_hinic) provides poll mode driver support +The hinic PMD (**librte_net_hinic**) provides poll mode driver support for 25Gbps Huawei Intelligent PCIE Network Adapters based on the Huawei Ethernet Controller Hi1822. diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst index d96ad5d445..cc0a8e4edc 100644 --- a/doc/guides/nics/hns3.rst +++ b/doc/guides/nics/hns3.rst @@ -4,7 +4,7 @@ HNS3 Poll Mode Driver =============================== -The hns3 PMD (librte_pmd_hns3) provides poll mode driver support +The hns3 PMD (**librte_net_hns3**) provides poll mode driver support for the inbuilt Hisilicon Network Subsystem(HNS) network engine found in the Hisilicon Kunpeng 920 SoC. diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst index 5cf85d94cc..b8ce2a652b 100644 --- a/doc/guides/nics/i40e.rst +++ b/doc/guides/nics/i40e.rst @@ -4,7 +4,7 @@ I40E Poll Mode Driver ====================== -The i40e PMD (librte_pmd_i40e) provides poll mode driver support for +The i40e PMD (**librte_net_i40e**) provides poll mode driver support for 10/25/40 Gbps Intel® Ethernet 700 Series Network Adapters based on the Intel Ethernet Controller X710/XL710/XXV710 and Intel Ethernet Connection X722 (only support part of features). diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst index a2aea12333..11c7420ed5 100644 --- a/doc/guides/nics/ice.rst +++ b/doc/guides/nics/ice.rst @@ -4,7 +4,7 @@ ICE Poll Mode Driver ====================== -The ice PMD (librte_pmd_ice) provides poll mode driver support for +The ice PMD (**librte_net_ice**) provides poll mode driver support for 10/25/50/100 Gbps Intel® Ethernet 810 Series Network Adapters based on the Intel Ethernet Controller E810. diff --git a/doc/guides/nics/igb.rst b/doc/guides/nics/igb.rst index 0171622f45..8231f9eef4 100644 --- a/doc/guides/nics/igb.rst +++ b/doc/guides/nics/igb.rst @@ -4,7 +4,7 @@ IGB Poll Mode Driver ==================== -The IGB PMD (``librte_pmd_e1000``) provides poll mode driver +The IGB PMD (**librte_net_e1000**) provides poll mode driver support for Intel 1GbE nics. Features diff --git a/doc/guides/nics/igc.rst b/doc/guides/nics/igc.rst index 3b096236bf..320014bd90 100644 --- a/doc/guides/nics/igc.rst +++ b/doc/guides/nics/igc.rst @@ -4,7 +4,7 @@ IGC Poll Mode Driver ====================== -The IGC PMD (librte_pmd_igc) provides poll mode driver support for Foxville +The IGC PMD (**librte_net_igc**) provides poll mode driver support for Foxville I225 Series Network Adapters. - For information about I225, please refer to: diff --git a/doc/guides/nics/ipn3ke.rst b/doc/guides/nics/ipn3ke.rst index 5d4534e4da..a89e3719f2 100644 --- a/doc/guides/nics/ipn3ke.rst +++ b/doc/guides/nics/ipn3ke.rst @@ -4,7 +4,7 @@ IPN3KE Poll Mode Driver ======================= -The ipn3ke PMD (librte_pmd_ipn3ke) provides poll mode driver support +The ipn3ke PMD (**librte_net_ipn3ke**) provides poll mode driver support for Intel® FPGA PAC(Programmable Acceleration Card) N3000 based on the Intel Ethernet Controller X710/XXV710 and Intel Arria 10 FPGA. diff --git a/doc/guides/nics/liquidio.rst b/doc/guides/nics/liquidio.rst index 65c7d2d0b0..f893b3b539 100644 --- a/doc/guides/nics/liquidio.rst +++ b/doc/guides/nics/liquidio.rst @@ -4,7 +4,7 @@ LiquidIO VF Poll Mode Driver ============================ -The LiquidIO VF PMD library (librte_pmd_lio) provides poll mode driver support for +The LiquidIO VF PMD library (**librte_net_liquidio**) provides poll mode driver support for Cavium LiquidIO® II server adapter VFs. PF management and VF creation can be done using kernel driver. diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst index ed920e91ad..c408ab7138 100644 --- a/doc/guides/nics/mlx4.rst +++ b/doc/guides/nics/mlx4.rst @@ -5,7 +5,7 @@ MLX4 poll mode driver library ============================= -The MLX4 poll mode driver library (**librte_pmd_mlx4**) implements support +The MLX4 poll mode driver library (**librte_net_mlx4**) implements support for **Mellanox ConnectX-3** and **Mellanox ConnectX-3 Pro** 10/40 Gbps adapters as well as their virtual functions (VF) in SR-IOV context. @@ -21,14 +21,14 @@ Implementation details ---------------------- Most Mellanox ConnectX-3 devices provide two ports but expose a single PCI -bus address, thus unlike most drivers, librte_pmd_mlx4 registers itself as a +bus address, thus unlike most drivers, librte_net_mlx4 registers itself as a PCI driver that allocates one Ethernet device per detected port. For this reason, one cannot white/blacklist a single port without also white/blacklisting the others on the same device. Besides its dependency on libibverbs (that implies libmlx4 and associated -kernel support), librte_pmd_mlx4 relies heavily on system calls for control +kernel support), librte_net_mlx4 relies heavily on system calls for control operations such as querying/updating the MTU and flow control parameters. For security reasons and robustness, this driver only deals with virtual @@ -43,7 +43,7 @@ long as they share the same MAC address. The :ref:`flow_isolated_mode` is supported. -Compiling librte_pmd_mlx4 causes DPDK to be linked against libibverbs. +Compiling librte_net_mlx4 causes DPDK to be linked against libibverbs. Configuration ------------- @@ -77,7 +77,7 @@ Environment variables Run-time configuration ~~~~~~~~~~~~~~~~~~~~~~ -- librte_pmd_mlx4 brings kernel network interfaces up during initialization +- librte_net_mlx4 brings kernel network interfaces up during initialization because it is affected by their state. Forcing them down prevents packets reception. @@ -104,7 +104,7 @@ Kernel module parameters ~~~~~~~~~~~~~~~~~~~~~~~~ The **mlx4_core** kernel module has several parameters that affect the -behavior and/or the performance of librte_pmd_mlx4. Some of them are described +behavior and/or the performance of librte_net_mlx4. Some of them are described below. - **num_vfs** (integer or triplet, optionally prefixed by device address @@ -151,7 +151,7 @@ DPDK and must be installed separately: - **libibverbs** (provided by rdma-core package) - User space verbs framework used by librte_pmd_mlx4. This library provides + User space verbs framework used by librte_net_mlx4. This library provides a generic interface between the kernel and low-level user space drivers such as libmlx4. @@ -353,7 +353,7 @@ Usage example ------------- This section demonstrates how to launch **testpmd** with Mellanox ConnectX-3 -devices managed by librte_pmd_mlx4. +devices managed by librte_net_mlx4. #. Load the kernel modules:: @@ -415,33 +415,33 @@ devices managed by librte_pmd_mlx4. [...] EAL: PCI device 0000:83:00.0 on NUMA socket 1 - EAL: probe driver: 15b3:1007 librte_pmd_mlx4 - PMD: librte_pmd_mlx4: PCI information matches, using device "mlx4_0" (VF: false) - PMD: librte_pmd_mlx4: 2 port(s) detected - PMD: librte_pmd_mlx4: port 1 MAC address is 00:02:c9:b5:b7:50 - PMD: librte_pmd_mlx4: port 2 MAC address is 00:02:c9:b5:b7:51 + EAL: probe driver: 15b3:1007 librte_net_mlx4 + PMD: librte_net_mlx4: PCI information matches, using device "mlx4_0" (VF: false) + PMD: librte_net_mlx4: 2 port(s) detected + PMD: librte_net_mlx4: port 1 MAC address is 00:02:c9:b5:b7:50 + PMD: librte_net_mlx4: port 2 MAC address is 00:02:c9:b5:b7:51 EAL: PCI device 0000:84:00.0 on NUMA socket 1 - EAL: probe driver: 15b3:1007 librte_pmd_mlx4 - PMD: librte_pmd_mlx4: PCI information matches, using device "mlx4_1" (VF: false) - PMD: librte_pmd_mlx4: 2 port(s) detected - PMD: librte_pmd_mlx4: port 1 MAC address is 00:02:c9:b5:ba:b0 - PMD: librte_pmd_mlx4: port 2 MAC address is 00:02:c9:b5:ba:b1 + EAL: probe driver: 15b3:1007 librte_net_mlx4 + PMD: librte_net_mlx4: PCI information matches, using device "mlx4_1" (VF: false) + PMD: librte_net_mlx4: 2 port(s) detected + PMD: librte_net_mlx4: port 1 MAC address is 00:02:c9:b5:ba:b0 + PMD: librte_net_mlx4: port 2 MAC address is 00:02:c9:b5:ba:b1 Interactive-mode selected Configuring Port 0 (socket 0) - PMD: librte_pmd_mlx4: 0x867d60: TX queues number update: 0 -> 2 - PMD: librte_pmd_mlx4: 0x867d60: RX queues number update: 0 -> 2 + PMD: librte_net_mlx4: 0x867d60: TX queues number update: 0 -> 2 + PMD: librte_net_mlx4: 0x867d60: RX queues number update: 0 -> 2 Port 0: 00:02:C9:B5:B7:50 Configuring Port 1 (socket 0) - PMD: librte_pmd_mlx4: 0x867da0: TX queues number update: 0 -> 2 - PMD: librte_pmd_mlx4: 0x867da0: RX queues number update: 0 -> 2 + PMD: librte_net_mlx4: 0x867da0: TX queues number update: 0 -> 2 + PMD: librte_net_mlx4: 0x867da0: RX queues number update: 0 -> 2 Port 1: 00:02:C9:B5:B7:51 Configuring Port 2 (socket 0) - PMD: librte_pmd_mlx4: 0x867de0: TX queues number update: 0 -> 2 - PMD: librte_pmd_mlx4: 0x867de0: RX queues number update: 0 -> 2 + PMD: librte_net_mlx4: 0x867de0: TX queues number update: 0 -> 2 + PMD: librte_net_mlx4: 0x867de0: RX queues number update: 0 -> 2 Port 2: 00:02:C9:B5:BA:B0 Configuring Port 3 (socket 0) - PMD: librte_pmd_mlx4: 0x867e20: TX queues number update: 0 -> 2 - PMD: librte_pmd_mlx4: 0x867e20: RX queues number update: 0 -> 2 + PMD: librte_net_mlx4: 0x867e20: TX queues number update: 0 -> 2 + PMD: librte_net_mlx4: 0x867e20: RX queues number update: 0 -> 2 Port 3: 00:02:C9:B5:BA:B1 Checking link statuses... Port 0 Link Up - speed 10000 Mbps - full-duplex diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index afa65a1379..de9b8674a0 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -7,7 +7,7 @@ MLX5 poll mode driver ===================== -The MLX5 poll mode driver library (**librte_pmd_mlx5**) provides support +The MLX5 poll mode driver library (**librte_net_mlx5**) provides support for **Mellanox ConnectX-4**, **Mellanox ConnectX-4 Lx** , **Mellanox ConnectX-5**, **Mellanox ConnectX-6**, **Mellanox ConnectX-6 Dx** and **Mellanox BlueField** families of 10/25/40/50/100/200 Gb/s adapters @@ -25,7 +25,7 @@ Design ------ Besides its dependency on libibverbs (that implies libmlx5 and associated -kernel support), librte_pmd_mlx5 relies heavily on system calls for control +kernel support), librte_net_mlx5 relies heavily on system calls for control operations such as querying/updating the MTU and flow control parameters. For security reasons and robustness, this driver only deals with virtual @@ -51,7 +51,7 @@ to get the best performances: - DevX allows to access firmware objects - Direct Rules manages flow steering at low-level hardware layer -Enabling librte_pmd_mlx5 causes DPDK applications to be linked against +Enabling librte_net_mlx5 causes DPDK applications to be linked against libibverbs. Features @@ -370,7 +370,7 @@ Environment variables Run-time configuration ~~~~~~~~~~~~~~~~~~~~~~ -- librte_pmd_mlx5 brings kernel network interfaces up during initialization +- librte_net_mlx5 brings kernel network interfaces up during initialization because it is affected by their state. Forcing them down prevents packets reception. @@ -1000,7 +1000,7 @@ DPDK and must be installed separately: - **libibverbs** - User space Verbs framework used by librte_pmd_mlx5. This library provides + User space Verbs framework used by librte_net_mlx5. This library provides a generic interface between the kernel and low-level user space drivers such as libmlx5. @@ -1444,13 +1444,13 @@ The application should re-create the flows as required after the port restart. Notes for testpmd ----------------- -Compared to librte_pmd_mlx4 that implements a single RSS configuration per -port, librte_pmd_mlx5 supports per-protocol RSS configuration. +Compared to librte_net_mlx4 that implements a single RSS configuration per +port, librte_net_mlx5 supports per-protocol RSS configuration. Since ``testpmd`` defaults to IP RSS mode and there is currently no command-line parameter to enable additional protocols (UDP and TCP as well as IP), the following commands must be entered from its CLI to get the same -behavior as librte_pmd_mlx4:: +behavior as librte_net_mlx4:: > port stop all > port config all rss all @@ -1460,7 +1460,7 @@ Usage example ------------- This section demonstrates how to launch **testpmd** with Mellanox -ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_pmd_mlx5. +ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_net_mlx5. #. Load the kernel modules:: @@ -1517,41 +1517,41 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_pmd_mlx5. [...] EAL: PCI device 0000:05:00.0 on NUMA socket 0 - EAL: probe driver: 15b3:1013 librte_pmd_mlx5 - PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_0" (VF: false) - PMD: librte_pmd_mlx5: 1 port(s) detected - PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fe + EAL: probe driver: 15b3:1013 librte_net_mlx5 + PMD: librte_net_mlx5: PCI information matches, using device "mlx5_0" (VF: false) + PMD: librte_net_mlx5: 1 port(s) detected + PMD: librte_net_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fe EAL: PCI device 0000:05:00.1 on NUMA socket 0 - EAL: probe driver: 15b3:1013 librte_pmd_mlx5 - PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_1" (VF: false) - PMD: librte_pmd_mlx5: 1 port(s) detected - PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:ff + EAL: probe driver: 15b3:1013 librte_net_mlx5 + PMD: librte_net_mlx5: PCI information matches, using device "mlx5_1" (VF: false) + PMD: librte_net_mlx5: 1 port(s) detected + PMD: librte_net_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:ff EAL: PCI device 0000:06:00.0 on NUMA socket 0 - EAL: probe driver: 15b3:1013 librte_pmd_mlx5 - PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_2" (VF: false) - PMD: librte_pmd_mlx5: 1 port(s) detected - PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fa + EAL: probe driver: 15b3:1013 librte_net_mlx5 + PMD: librte_net_mlx5: PCI information matches, using device "mlx5_2" (VF: false) + PMD: librte_net_mlx5: 1 port(s) detected + PMD: librte_net_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fa EAL: PCI device 0000:06:00.1 on NUMA socket 0 - EAL: probe driver: 15b3:1013 librte_pmd_mlx5 - PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_3" (VF: false) - PMD: librte_pmd_mlx5: 1 port(s) detected - PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fb + EAL: probe driver: 15b3:1013 librte_net_mlx5 + PMD: librte_net_mlx5: PCI information matches, using device "mlx5_3" (VF: false) + PMD: librte_net_mlx5: 1 port(s) detected + PMD: librte_net_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fb Interactive-mode selected Configuring Port 0 (socket 0) - PMD: librte_pmd_mlx5: 0x8cba80: TX queues number update: 0 -> 2 - PMD: librte_pmd_mlx5: 0x8cba80: RX queues number update: 0 -> 2 + PMD: librte_net_mlx5: 0x8cba80: TX queues number update: 0 -> 2 + PMD: librte_net_mlx5: 0x8cba80: RX queues number update: 0 -> 2 Port 0: E4:1D:2D:E7:0C:FE Configuring Port 1 (socket 0) - PMD: librte_pmd_mlx5: 0x8ccac8: TX queues number update: 0 -> 2 - PMD: librte_pmd_mlx5: 0x8ccac8: RX queues number update: 0 -> 2 + PMD: librte_net_mlx5: 0x8ccac8: TX queues number update: 0 -> 2 + PMD: librte_net_mlx5: 0x8ccac8: RX queues number update: 0 -> 2 Port 1: E4:1D:2D:E7:0C:FF Configuring Port 2 (socket 0) - PMD: librte_pmd_mlx5: 0x8cdb10: TX queues number update: 0 -> 2 - PMD: librte_pmd_mlx5: 0x8cdb10: RX queues number update: 0 -> 2 + PMD: librte_net_mlx5: 0x8cdb10: TX queues number update: 0 -> 2 + PMD: librte_net_mlx5: 0x8cdb10: RX queues number update: 0 -> 2 Port 2: E4:1D:2D:E7:0C:FA Configuring Port 3 (socket 0) - PMD: librte_pmd_mlx5: 0x8ceb58: TX queues number update: 0 -> 2 - PMD: librte_pmd_mlx5: 0x8ceb58: RX queues number update: 0 -> 2 + PMD: librte_net_mlx5: 0x8ceb58: TX queues number update: 0 -> 2 + PMD: librte_net_mlx5: 0x8ceb58: RX queues number update: 0 -> 2 Port 3: E4:1D:2D:E7:0C:FB Checking link statuses... Port 0 Link Up - speed 40000 Mbps - full-duplex diff --git a/doc/guides/nics/mvneta.rst b/doc/guides/nics/mvneta.rst index e8abde42da..4238b00066 100644 --- a/doc/guides/nics/mvneta.rst +++ b/doc/guides/nics/mvneta.rst @@ -6,7 +6,7 @@ MVNETA Poll Mode Driver ======================= -The MVNETA PMD (librte_pmd_mvneta) provides poll mode driver support +The MVNETA PMD (**librte_net_mvneta**) provides poll mode driver support for the Marvell NETA 1/2.5 Gbps adapter. Detailed information about SoCs that use PPv2 can be obtained here: diff --git a/doc/guides/nics/mvpp2.rst b/doc/guides/nics/mvpp2.rst index 6fbce8358e..17e8e347bb 100644 --- a/doc/guides/nics/mvpp2.rst +++ b/doc/guides/nics/mvpp2.rst @@ -7,7 +7,7 @@ MVPP2 Poll Mode Driver ====================== -The MVPP2 PMD (librte_pmd_mvpp2) provides poll mode driver support +The MVPP2 PMD (**librte_net_mvpp2**) provides poll mode driver support for the Marvell PPv2 (Packet Processor v2) 1/10 Gbps adapter. Detailed information about SoCs that use PPv2 can be obtained here: diff --git a/doc/guides/nics/octeontx.rst b/doc/guides/nics/octeontx.rst index c01ae09bb3..b1a868b054 100644 --- a/doc/guides/nics/octeontx.rst +++ b/doc/guides/nics/octeontx.rst @@ -4,7 +4,7 @@ OCTEON TX Poll Mode driver ========================== -The OCTEON TX ETHDEV PMD (**librte_pmd_octeontx**) provides poll mode ethdev +The OCTEON TX ETHDEV PMD (**librte_net_octeontx**) provides poll mode ethdev driver support for the inbuilt network device found in the **Cavium OCTEON TX** SoC family as well as their virtual functions (VF) in SR-IOV context. diff --git a/doc/guides/nics/octeontx2.rst b/doc/guides/nics/octeontx2.rst index 7c04b5e600..18566a2c66 100644 --- a/doc/guides/nics/octeontx2.rst +++ b/doc/guides/nics/octeontx2.rst @@ -4,7 +4,7 @@ OCTEON TX2 Poll Mode driver =========================== -The OCTEON TX2 ETHDEV PMD (**librte_pmd_octeontx2**) provides poll mode ethdev +The OCTEON TX2 ETHDEV PMD (**librte_net_octeontx2**) provides poll mode ethdev driver support for the inbuilt network device found in **Marvell OCTEON TX2** SoC family as well as for their virtual functions (VF) in SR-IOV context. diff --git a/doc/guides/nics/pcap_ring.rst b/doc/guides/nics/pcap_ring.rst index 3734c29083..acb1f00e30 100644 --- a/doc/guides/nics/pcap_ring.rst +++ b/doc/guides/nics/pcap_ring.rst @@ -7,10 +7,10 @@ Libpcap and Ring Based Poll Mode Drivers In addition to Poll Mode Drivers (PMDs) for physical and virtual hardware, the DPDK also includes pure-software PMDs, two of these drivers are: -* A libpcap -based PMD (librte_pmd_pcap) that reads and writes packets using libpcap, +* A libpcap -based PMD (**librte_net_pcap**) that reads and writes packets using libpcap, - both from files on disk, as well as from physical NIC devices using standard Linux kernel drivers. -* A ring-based PMD (librte_pmd_ring) that allows a set of software FIFOs (that is, rte_ring) +* A ring-based PMD (**librte_net_ring**) that allows a set of software FIFOs (that is, rte_ring) to be accessed using the PMD APIs, as though they were physical NICs. .. note:: diff --git a/doc/guides/nics/pfe.rst b/doc/guides/nics/pfe.rst index c1b4a3e472..5261984884 100644 --- a/doc/guides/nics/pfe.rst +++ b/doc/guides/nics/pfe.rst @@ -4,7 +4,7 @@ PFE Poll Mode Driver ====================== -The PFE NIC PMD (**librte_pmd_pfe**) provides poll mode driver +The PFE NIC PMD (**librte_net_pfe**) provides poll mode driver support for the inbuilt NIC found in the **NXP LS1012** SoC. More information can be found at `NXP Official Website diff --git a/doc/guides/nics/qede.rst b/doc/guides/nics/qede.rst index da9af95373..bb127ca216 100644 --- a/doc/guides/nics/qede.rst +++ b/doc/guides/nics/qede.rst @@ -5,7 +5,7 @@ QEDE Poll Mode Driver ====================== -The QEDE poll mode driver library (**librte_pmd_qede**) implements support +The QEDE poll mode driver library (**librte_net_qede**) implements support for **QLogic FastLinQ QL4xxxx 10G/25G/40G/50G/100G Intelligent Ethernet Adapters (IEA) and Converged Network Adapters (CNA)** family of adapters as well as SR-IOV virtual functions (VF). It is supported on several standard Linux distros like RHEL, SLES, Ubuntu etc. It is compile-tested under FreeBSD OS. @@ -190,7 +190,7 @@ SR-IOV: Prerequisites and Sample Application Notes This section provides instructions to configure SR-IOV with Linux OS. -**Note**: librte_pmd_qede will be used to bind to SR-IOV VF device and Linux native kernel driver (qede) will function as SR-IOV PF driver. Requires PF driver to be 8.20.x.x or higher. +**Note**: librte_net_qede will be used to bind to SR-IOV VF device and Linux native kernel driver (qede) will function as SR-IOV PF driver. Requires PF driver to be 8.20.x.x or higher. #. Verify SR-IOV and ARI capability is enabled on the adapter using ``lspci``: diff --git a/doc/guides/nics/sfc_efx.rst b/doc/guides/nics/sfc_efx.rst index 959b52c1c3..3af63c318b 100644 --- a/doc/guides/nics/sfc_efx.rst +++ b/doc/guides/nics/sfc_efx.rst @@ -8,7 +8,7 @@ Solarflare libefx-based Poll Mode Driver ======================================== -The SFC EFX PMD (**librte_pmd_sfc_efx**) provides poll mode driver support +The SFC EFX PMD (**librte_net_sfc_efx**) provides poll mode driver support for **Solarflare SFN7xxx and SFN8xxx** family of 10/40 Gbps adapters, **Solarflare XtremeScale X2xxx** family of 10/25/40/50/100 Gbps adapters and **Alveo SN1000 SmartNICs** family of 10/25/40/50/100 Gbps adapters. diff --git a/doc/guides/nics/thunderx.rst b/doc/guides/nics/thunderx.rst index a928a790e3..6f99008834 100644 --- a/doc/guides/nics/thunderx.rst +++ b/doc/guides/nics/thunderx.rst @@ -4,7 +4,7 @@ ThunderX NICVF Poll Mode Driver =============================== -The ThunderX NICVF PMD (**librte_pmd_thunderx_nicvf**) provides poll mode driver +The ThunderX NICVF PMD (**librte_net_thunderx**) provides poll mode driver support for the inbuilt NIC found in the **Cavium ThunderX** SoC family as well as their virtual functions (VF) in SR-IOV context. @@ -163,7 +163,7 @@ This section provides instructions to configure SR-IOV with Linux OS. ... - PMD: rte_nicvf_pmd_init(): librte_pmd_thunderx nicvf version 1.0 + PMD: rte_nicvf_pmd_init(): librte_net_thunderx nicvf version 1.0 ... EAL: probe driver: 177d:11 rte_nicvf_pmd diff --git a/doc/guides/nics/vdev_netvsc.rst b/doc/guides/nics/vdev_netvsc.rst index d9f6319b9f..5c1dcbf78d 100644 --- a/doc/guides/nics/vdev_netvsc.rst +++ b/doc/guides/nics/vdev_netvsc.rst @@ -5,7 +5,7 @@ VDEV_NETVSC driver ================== -The VDEV_NETVSC driver (librte_pmd_vdev_netvsc) provides support for NetVSC +The VDEV_NETVSC driver (**librte_net_vdev_netvsc**) provides support for NetVSC interfaces and associated SR-IOV virtual function (VF) devices found in Linux virtual machines running on Microsoft Hyper-V_ (including Azure) platforms. From patchwork Mon Nov 2 17:45:05 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 83430 X-Patchwork-Delegate: david.marchand@redhat.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 9478BA04E7; Mon, 2 Nov 2020 18:47:18 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 728895A0F; Mon, 2 Nov 2020 18:46:09 +0100 (CET) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by dpdk.org (Postfix) with ESMTP id 1C27D54AE for ; Mon, 2 Nov 2020 18:46:07 +0100 (CET) IronPort-SDR: d3Bkh5XBmjN9PzQLPVZAcikedZPTNVPYA3zmWOzne0ezSCf/gk906mdrkuX9Ct3R/9lY4jvqKu 8nFVopAYZTNg== X-IronPort-AV: E=McAfee;i="6000,8403,9793"; a="233092759" X-IronPort-AV: E=Sophos;i="5.77,445,1596524400"; d="scan'208";a="233092759" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 02 Nov 2020 09:46:07 -0800 IronPort-SDR: bmnpszbx/TPdw3C3fmOkjgPrOkS6GGejHVnF934tRbEpEwWpcCEtRAkF+Rnd7j26yzn49J3gJQ JnyGOftHzBFw== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,445,1596524400"; d="scan'208";a="336243692" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by orsmga002.jf.intel.com with ESMTP; 02 Nov 2020 09:46:05 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson , Ori Kam , Guy Kaneti , Rosen Xu , Andrew Rybchenko , Luca Boccassi Date: Mon, 2 Nov 2020 17:45:05 +0000 Message-Id: <20201102174507.1085128-7-bruce.richardson@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20201102174507.1085128-1-bruce.richardson@intel.com> References: <20201102174507.1085128-1-bruce.richardson@intel.com> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH 6/8] doc: fix driver names in regex devices guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Since the built driver filenames have changed in DPDK 20.11, we need to update the driver doc to match. Fixes: a20b2c01a7a1 ("build: standardize component names and defines") Signed-off-by: Bruce Richardson Reviewed-by: David Marchand --- doc/guides/regexdevs/mlx5.rst | 4 ++-- doc/guides/regexdevs/octeontx2.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/guides/regexdevs/mlx5.rst b/doc/guides/regexdevs/mlx5.rst index 0e6ee8ccfc..faaa6ac11d 100644 --- a/doc/guides/regexdevs/mlx5.rst +++ b/doc/guides/regexdevs/mlx5.rst @@ -7,7 +7,7 @@ MLX5 RegEx driver ================= The MLX5 RegEx (Regular Expression) driver library -(**librte_pmd_mlx5_regex**) provides support for **Mellanox BlueField 2** +(**librte_regex_mlx5**) provides support for **Mellanox BlueField 2** families of 25/50/100/200 Gb/s adapters. Design @@ -26,7 +26,7 @@ to get the best performances: - Direct Verbs is a device-specific API - DevX allows to access firmware objects -Enabling librte_pmd_mlx5_regex causes DPDK applications to be linked against +Enabling librte_regex_mlx5 causes DPDK applications to be linked against libibverbs. Mellanox mlx5 pci device can be probed by number of different pci devices, diff --git a/doc/guides/regexdevs/octeontx2.rst b/doc/guides/regexdevs/octeontx2.rst index 4ea800f949..b39d457d60 100644 --- a/doc/guides/regexdevs/octeontx2.rst +++ b/doc/guides/regexdevs/octeontx2.rst @@ -4,7 +4,7 @@ OCTEON TX2 REE Regexdev Driver ============================== -The OCTEON TX2 REE PMD (**librte_pmd_octeontx2_regex**) provides poll mode +The OCTEON TX2 REE PMD (**librte_regex_octeontx2**) provides poll mode regexdev driver support for the inbuilt regex device found in the **Marvell OCTEON TX2** SoC family. From patchwork Mon Nov 2 17:45:06 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 83431 X-Patchwork-Delegate: david.marchand@redhat.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 75C11A04E7; Mon, 2 Nov 2020 18:47:36 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id E2A262BEA; Mon, 2 Nov 2020 18:46:14 +0100 (CET) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by dpdk.org (Postfix) with ESMTP id 7430D2BD5 for ; Mon, 2 Nov 2020 18:46:12 +0100 (CET) IronPort-SDR: +7aeVnSvkgivhT8odtx6uKzDyQJgD1lKKVks0ETsTs9qOm+N5k/p+Lesj6TB2QvzggxO34ixN6 DSHrWYx5S0ww== X-IronPort-AV: E=McAfee;i="6000,8403,9793"; a="233092779" X-IronPort-AV: E=Sophos;i="5.77,445,1596524400"; d="scan'208";a="233092779" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 02 Nov 2020 09:46:12 -0800 IronPort-SDR: PEKz6qqXoV/jGlO4uYYyLsHpSaKJbTx3qX+tUUYmWkwCcdgMRRnoyIsQFsbOmjGaohCiC0De0l bvqtW0eyvUqg== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,445,1596524400"; d="scan'208";a="336243710" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by orsmga002.jf.intel.com with ESMTP; 02 Nov 2020 09:46:10 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson , Matan Azrad , Viacheslav Ovsiienko , Rosen Xu , Luca Boccassi , Andrew Rybchenko Date: Mon, 2 Nov 2020 17:45:06 +0000 Message-Id: <20201102174507.1085128-8-bruce.richardson@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20201102174507.1085128-1-bruce.richardson@intel.com> References: <20201102174507.1085128-1-bruce.richardson@intel.com> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH 7/8] doc: fix driver names in vDPA devices guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Since the built driver filenames have changed in DPDK 20.11, we need to update the driver doc to match. Fixes: a20b2c01a7a1 ("build: standardize component names and defines") Signed-off-by: Bruce Richardson Reviewed-by: David Marchand --- doc/guides/vdpadevs/mlx5.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/guides/vdpadevs/mlx5.rst b/doc/guides/vdpadevs/mlx5.rst index 9a11eefd2c..9d10fee2b6 100644 --- a/doc/guides/vdpadevs/mlx5.rst +++ b/doc/guides/vdpadevs/mlx5.rst @@ -7,7 +7,7 @@ MLX5 vDPA driver ================ The MLX5 vDPA (vhost data path acceleration) driver library -(**librte_pmd_mlx5_vdpa**) provides support for **Mellanox ConnectX-6**, +(**librte_vdpa_mlx5**) provides support for **Mellanox ConnectX-6**, **Mellanox ConnectX-6 Dx** and **Mellanox BlueField** families of 10/25/40/50/100/200 Gb/s adapters as well as their virtual functions (VF) in SR-IOV context. @@ -37,7 +37,7 @@ to get the best performances: - DevX allows to access firmware objects - Direct Rules manages flow steering at low-level hardware layer -Enabling librte_pmd_mlx5_vdpa causes DPDK applications to be linked against +Enabling librte_vdpa_mlx5 causes DPDK applications to be linked against libibverbs. A Mellanox mlx5 PCI device can be probed by either net/mlx5 driver or vdpa/mlx5 From patchwork Mon Nov 2 17:45:07 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 83432 X-Patchwork-Delegate: david.marchand@redhat.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 6C785A04E7; Mon, 2 Nov 2020 18:47:55 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 519162B93; Mon, 2 Nov 2020 18:46:22 +0100 (CET) Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id BA15E160 for ; Mon, 2 Nov 2020 18:46:19 +0100 (CET) IronPort-SDR: 7KM+q7SkMYWeTmETJaokMPoyu/INeiPGJsrvjqRMyUIUHDQKmbqeLtpDRVnVyhVTXsiCA845Xd bVVP6xDgJb4g== X-IronPort-AV: E=McAfee;i="6000,8403,9793"; a="165419805" X-IronPort-AV: E=Sophos;i="5.77,445,1596524400"; d="scan'208";a="165419805" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga102.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 02 Nov 2020 09:46:17 -0800 IronPort-SDR: O5C0WCkzhtOICxs95L/RchojLIDhwkyVKXTcixhqvLkPtk9PU3snKAjw+8UedR8jkvjhA7eP13 1h/D9bsYERIQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,445,1596524400"; d="scan'208";a="336243739" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by orsmga002.jf.intel.com with ESMTP; 02 Nov 2020 09:46:15 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson , Chas Williams , "Min Hu (Connor)" , Andrew Rybchenko , Luca Boccassi , Rosen Xu Date: Mon, 2 Nov 2020 17:45:07 +0000 Message-Id: <20201102174507.1085128-9-bruce.richardson@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20201102174507.1085128-1-bruce.richardson@intel.com> References: <20201102174507.1085128-1-bruce.richardson@intel.com> MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH 8/8] doc: fix driver names in programmers guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Since the built driver filenames have changed in DPDK 20.11, we need to update the programmers guide doc to match. Fixes: a20b2c01a7a1 ("build: standardize component names and defines") Signed-off-by: Bruce Richardson Reviewed-by: David Marchand --- .../prog_guide/link_bonding_poll_mode_drv_lib.rst | 10 +++++----- doc/guides/prog_guide/source_org.rst | 3 ++- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst b/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst index 244dca56c4..30c56cd375 100644 --- a/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst +++ b/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst @@ -13,7 +13,7 @@ allows physical PMDs to be bonded together to create a single logical PMD. Bonded PMDs -The Link Bonding PMD library(librte_pmd_bond) supports bonding of groups of +The Link Bonding PMD library(librte_net_bond) supports bonding of groups of ``rte_eth_dev`` ports of the same speed and duplex to provide similar capabilities to that found in Linux bonding driver to allow the aggregation of multiple (slave) NICs into a single logical interface between a server @@ -21,7 +21,7 @@ and a switch. The new bonded PMD will then process these interfaces based on the mode of operation specified to provide support for features such as redundant links, fault tolerance and/or load balancing. -The librte_pmd_bond library exports a C API which provides an API for the +The librte_net_bond library exports a C API which provides an API for the creation of bonded devices as well as the configuration and management of the bonded device and its slave devices. @@ -133,7 +133,7 @@ Currently the Link Bonding PMD library supports following modes of operation: Implementation Details ---------------------- -The librte_pmd_bond bonded device are compatible with the Ethernet device API +The librte_net_bond bonded device are compatible with the Ethernet device API exported by the Ethernet PMDs described in the *DPDK API Reference*. The Link Bonding Library supports the creation of bonded devices at application @@ -329,7 +329,7 @@ and UDP protocols for load balancing. Using Link Bonding Devices -------------------------- -The librte_pmd_bond library supports two modes of device creation, the libraries +The librte_net_bond library supports two modes of device creation, the libraries export full C API or using the EAL command line to statically configure link bonding devices at application startup. Using the EAL option it is possible to use link bonding functionality transparently without specific knowledge of the @@ -340,7 +340,7 @@ the link bonding C API. Using the Poll Mode Driver from an Application ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Using the librte_pmd_bond libraries API it is possible to dynamically create +Using the librte_net_bond libraries API it is possible to dynamically create and manage link bonding device from within any application. Link bonding devices are created using the ``rte_eth_bond_create`` API which requires a unique device name, the link bonding mode to initial the device in and finally diff --git a/doc/guides/prog_guide/source_org.rst b/doc/guides/prog_guide/source_org.rst index 8d531bd9ef..5e4333460a 100644 --- a/doc/guides/prog_guide/source_org.rst +++ b/doc/guides/prog_guide/source_org.rst @@ -21,7 +21,8 @@ Drivers Drivers are special libraries which provide poll-mode driver implementations for devices: either hardware devices or pseudo/virtual devices. They are contained in the *drivers* subdirectory, classified by type, and each compiles to a -library with the format ``librte_pmd_X.a`` where ``X`` is the driver name. +library with the format ``librte_X_Y.a`` where ``X`` is the device class +name and ``Y`` is the driver name. .. note::