From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 1544BA0521; Tue, 3 Nov 2020 13:37:59 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 8705ACA1A; Tue, 3 Nov 2020 13:36:59 +0100 (CET) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id 67CB8C9E2 for ; Tue, 3 Nov 2020 13:36:57 +0100 (CET) IronPort-SDR: jH48lBx34kMsi0+C1Uqb4GXJeb+xolQqgIl0ghG8he8wcfToig04vUW2iNVxxwAoNMmgT2fPUT BSTCsXvgJgCQ== X-IronPort-AV: E=McAfee;i="6000,8403,9793"; a="156032897" X-IronPort-AV: E=Sophos;i="5.77,448,1596524400"; d="scan'208";a="156032897" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 03 Nov 2020 04:36:54 -0800 IronPort-SDR: Y+k9O5XQgj0hVkpGo7eKo7+5lUdAE//r6KUUEpLKV8kQeEZkDM9HLhlwi5fiY6Vyt39J24oWq7 T0rTek5q7rNA== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,448,1596524400"; d="scan'208";a="528468557" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by fmsmga005.fm.intel.com with ESMTP; 03 Nov 2020 04:36:45 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson , David Marchand , Rosen Xu , Ajit Khaparde , Shepard Siegel , Ed Czeck , John Miller , Somalapuram Amaranath , Rasesh Mody , Shahed Shaikh , 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 , 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: Tue, 3 Nov 2020 12:36:05 +0000 Message-Id: <20201103123608.1114433-5-bruce.richardson@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20201103123608.1114433-1-bruce.richardson@intel.com> References: <20201102174507.1085128-1-bruce.richardson@intel.com> <20201103123608.1114433-1-bruce.richardson@intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v2 4/7] 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 --- 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. -- 2.25.1