fix driver filenames in the docs
cover fix driver filenames in the docs
Since the driver filenames are now following a new standard naming convention some doc updates are necessary. This patch makes those changes, and also includes a few other fixes, such as the first patch, where we remove an unncessary name override.
Bruce Richardson (8):
regex/octeontx2: fix unnecessary name override
doc: fix driver names in compression devices guide
doc: fix driver names in crypto devices guide
doc: fix driver names in event devices guide
doc: fix driver names in NIC devices guide
doc: fix driver names in regex devices guide
doc: fix driver names in vDPA devices guide
doc: fix driver names in programmers guide
doc/guides/compressdevs/isal.rst | 2 +- doc/guides/compressdevs/octeontx.rst | 2 +- doc/guides/compressdevs/zlib.rst | 2 +- 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 +- doc/guides/eventdevs/octeontx.rst | 2 +- doc/guides/eventdevs/octeontx2.rst | 2 +- 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 +- .../link_bonding_poll_mode_drv_lib.rst | 10 +-- doc/guides/prog_guide/source_org.rst | 3 +- doc/guides/regexdevs/mlx5.rst | 4 +- doc/guides/regexdevs/octeontx2.rst | 2 +- doc/guides/vdpadevs/mlx5.rst | 4 +- drivers/regex/octeontx2/meson.build | 1 - 48 files changed, 118 insertions(+), 118 deletions(-)
Signature · 1 line
2.25.1
PATCH 1/8 regex/octeontx2: fix unnecessary name override
Since the device class is now part of the standard filenames, it's no longer needed in name overrides in specific drivers.
--- drivers/regex/octeontx2/meson.build | 1 - 1 file changed, 1 deletion(-)
drivers/regex/octeontx2/meson.build +0 -1
@@ -38,7 +38,6 @@ foreach flag: extra_flags endif endforeach -name = 'octeontx2_regex' deps += ['bus_pci', 'common_octeontx2', 'regexdev'] includes += include_directories('../../common/octeontx2')
Signature · 1 line
2.25.1
Re: [dpdk-dev] [PATCH 1/8] regex/octeontx2: fix unnecessary name override
Quoted 7 lines · Bruce Richardson
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 <[email protected]>
Equivalent to https://patchwork.dpdk.org/patch/81961/ but maybe better to skip setting fmt_name when it is the same as the default value.
Signature · 1 line
David Marchand
Re: [dpdk-dev] [PATCH 1/8] regex/octeontx2: fix unnecessary name override
02/11/2020 20:48, David Marchand:
Quoted 12 lines
Quoted 7 lines · Bruce Richardson
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 <[email protected]>Equivalent to https://patchwork.dpdk.org/patch/81961/ but maybe better to skip setting
fmt_namewhen it is the same as the default value.
[...]
Quoted 1 line
Quoted 1 line
-name = '
octeontx2_regex'
But it is not the same?
The name will default to "octeontx2", which is fine.
But the fmt_name should not take this default.
I believe fmt_name should be "octeontx2_regex" as I did in my patch.
Re: [dpdk-dev] [PATCH 1/8] regex/octeontx2: fix unnecessary name override
Quoted 7 lines · Thomas Monjalon
Quoted 1 line
Quoted 1 line
-name = '
octeontx2_regex'But it is not the same?
The name will default to "octeontx2", which is fine.
But thefmt_nameshould not take this default.
I believefmt_nameshould be "octeontx2_regex" as I did in my patch.
fmt_name is only for maintaining config compat.
This driver is new to 20.11.
We can drop fmt_name too.
Signature · 1 line
David Marchand
Re: [dpdk-dev] [PATCH 1/8] regex/octeontx2: fix unnecessary name override
03/11/2020 09:19, David Marchand:
Quoted 5 lines · Thomas Monjalon
Quoted 4 lines
Quoted 1 line
Quoted 1 line
-name = '
octeontx2_regex'But it is not the same?
Quoted 7 lines
Quoted 3 lines
The name will default to "octeontx2", which is fine.
But thefmt_nameshould not take this default.
I believefmt_nameshould be "octeontx2_regex" as I did in my patch.
fmt_nameis only for maintaining config compat.
This driver is new to 20.11.
We can dropfmt_nametoo.
If we don't set fmt_name, it defaults to "name", "octeontx2" here. What is the consequence in compat definitions?
Re: [dpdk-dev] [PATCH 1/8] regex/octeontx2: fix unnecessary name override
Quoted 11 lines · Thomas Monjalon
03/11/2020 09:19, David Marchand:
Quoted 9 lines · Thomas Monjalon
Quoted 7 lines
Quoted 1 line
Quoted 1 line
-name = '
octeontx2_regex'But it is not the same?
The name will default to "octeontx2", which is fine.
But thefmt_nameshould not take this default.
I believefmt_nameshould be "octeontx2_regex" as I did in my patch.
Quoted 6 lines
Quoted 3 lines
fmt_nameis only for maintaining config compat.
This driver is new to 20.11.
We can dropfmt_nametoo.If we don't set
fmt_name, it defaults to "name", "octeontx2" here. What is the consequence in compat definitions?
$ git reset --hard origin/main HEAD is now at 30cf171352 app/regex: add job context $ ninja-build -C build >/dev/null 2>&1 && ls -rt build/drivers/*regex*octeo*.so.21.0 |tail -1; grep OCTEONTX2 build/rte_build_config.h |grep REG build/drivers/librte_regex_octeontx2_regex.so.21.0 #define RTE_LIBRTE_OCTEONTX2_REGEX_PMD 1 #define RTE_REGEX_OCTEONTX2_REGEX 1
$ git reset --hard origin/main HEAD is now at 30cf171352 app/regex: add job context $ git pw patch apply 81961 Applying: regex/octeontx2: fix driver name $ ninja-build -C build >/dev/null 2>&1 && ls -rt build/drivers/*regex*octeo*.so.21.0 |tail -1; grep OCTEONTX2 build/rte_build_config.h |grep REG build/drivers/librte_regex_octeontx2.so.21.0 #define RTE_LIBRTE_OCTEONTX2_REGEX_PMD 1 #define RTE_REGEX_OCTEONTX2 1
$ git reset --hard origin/main HEAD is now at 30cf171352 app/regex: add job context $ git pw patch apply --no-deps 83425 Applying: regex/octeontx2: fix unnecessary name override $ ninja-build -C build >/dev/null 2>&1 && ls -rt build/drivers/*regex*octeo*.so.21.0 |tail -1; grep OCTEONTX2 build/rte_build_config.h |grep REG build/drivers/librte_regex_octeontx2.so.21.0 #define RTE_REGEX_OCTEONTX2 1
Signature · 1 line
David Marchand
Re: [dpdk-dev] [PATCH 1/8] regex/octeontx2: fix unnecessary name override
Quoted 13 lines · David Marchand
Quoted 11 lines · Thomas Monjalon
03/11/2020 09:19, David Marchand:
Quoted 9 lines · Thomas Monjalon
Quoted 7 lines
Quoted 1 line
Quoted 1 line
-name = '
octeontx2_regex'But it is not the same?
The name will default to "octeontx2", which is fine.
But thefmt_nameshould not take this default.
I believefmt_nameshould be "octeontx2_regex" as I did in my patch.
Quoted 7 lines
Quoted 6 lines
Quoted 3 lines
fmt_nameis only for maintaining config compat.
This driver is new to 20.11.
We can dropfmt_nametoo.If we don't set
fmt_name, it defaults to "name", "octeontx2" here. What is the consequence in compat definitions?
Ok, got it, the problem is when we disable the net/octeontx2 driver. Your patch correctly sets a RTE_LIBRTE_OCTEONTX2_REGEX_PMD compat option that is unused but that does not overwrite the RTE_LIBRTE_OCTEONTX2_PMD compat option (which indicates the presence of the net/octeontx2 driver).
Signature · 1 line
David Marchand
Re: [dpdk-dev] [PATCH 1/8] regex/octeontx2: fix unnecessary name override
Quoted 23 lines · David Marchand
Quoted 13 lines · David Marchand
Quoted 11 lines · Thomas Monjalon
03/11/2020 09:19, David Marchand:
Quoted 9 lines · Thomas Monjalon
Quoted 7 lines
Quoted 1 line
Quoted 1 line
-name = '
octeontx2_regex'But it is not the same?
The name will default to "octeontx2", which is fine.
But thefmt_nameshould not take this default.
I believefmt_nameshould be "octeontx2_regex" as I did in my patch.Quoted 7 lines
Quoted 6 lines
Quoted 3 lines
fmt_nameis only for maintaining config compat.
This driver is new to 20.11.
We can dropfmt_nametoo.If we don't set
fmt_name, it defaults to "name", "octeontx2" here. What is the consequence in compat definitions?
Quoted 6 lines
Ok, got it, the problem is when we disable the net/octeontx2 driver. Your patch correctly sets a
RTE_LIBRTE_OCTEONTX2_REGEX_PMDcompat option that is unused but that does not overwrite theRTE_LIBRTE_OCTEONTX2_PMDcompat option (which indicates the presence of the net/octeontx2 driver).
Yes, I forgot about compatibility macro settings. Given the context of this patchset, I was instead just looking at the library filesnames.
I'll drop this patch from v2, and you can take Thomas' instead.
/Bruce
PATCH 2/8 doc: fix driver names in compression devices guide
In reply to Bruce RichardsonSince the built driver filenames have changed in DPDK 20.11, we need to update the driver doc to match.
--- 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(-)
doc/guides/compressdevs/isal.rst +1 -1
@@ -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).
doc/guides/compressdevs/octeontx.rst +1 -1
@@ -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.
doc/guides/compressdevs/zlib.rst +1 -1
@@ -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
Signature · 1 line
2.25.1
Re: [dpdk-dev] [PATCH 2/8] doc: fix driver names in compression devices guide
Quoted 7 lines · Bruce Richardson
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 <[email protected]>
Signature · 1 line
David Marchand
PATCH 3/8 doc: fix driver names in crypto devices guide
In reply to Bruce RichardsonSince the built driver filenames have changed in DPDK 20.11, we need to update the driver doc to match.
--- 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(-)
doc/guides/cryptodevs/aesni_gcm.rst +1 -1
@@ -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).
doc/guides/cryptodevs/aesni_mb.rst +1 -1
@@ -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 <https://www.intel.com/content/dam/www/public/us/en/documents/white-papers/fast-multi-buffer-ipsec-implementations-ia-processors-paper.pdf>`_.
doc/guides/cryptodevs/ccp.rst +1 -1
@@ -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
doc/guides/cryptodevs/kasumi.rst +1 -1
@@ -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 <https://github.com/01org/intel-ipsec-mb>`_ which implements F8 and F9 functions for KASUMI UEA1 cipher and UIA1 hash algorithms.
doc/guides/cryptodevs/null.rst +1 -1
@@ -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
doc/guides/cryptodevs/scheduler.rst +2 -2
@@ -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.
doc/guides/cryptodevs/zuc.rst +1 -1
@@ -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 <https://github.com/01org/intel-ipsec-mb>`_ which implements F8 and F9 functions for ZUC EEA3 cipher and EIA3 hash algorithms.
Signature · 1 line
2.25.1
Re: [dpdk-dev] [PATCH 3/8] doc: fix driver names in crypto devices guide
Quoted 7 lines · Bruce Richardson
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 <[email protected]>
Quoted 9 lines
--- 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(-)
We still have:
doc/guides/cryptodevs/mvsam.rst:The MVSAM CRYPTO PMD (**librte_crypto_mvsam_pmd**) provides poll mode crypto driver
The rest lgtm.
Signature · 1 line
David Marchand
Re: [dpdk-dev] [PATCH 3/8] doc: fix driver names in crypto devices guide
Quoted 3 lines · David Marchand
We still have:
doc/guides/cryptodevs/mvsam.rst:The MVSAM CRYPTO PMD (**librte_crypto_mvsam_pmd**) provides poll mode crypto driver
Ah.. and:
doc/guides/cryptodevs/snow3g.rst:The SNOW3G PMD (**librte_snow3g_zuc**) provides poll mode crypto driver support for
Grepping librte_ is a better check than pmd.
Signature · 1 line
David Marchand
Re: [dpdk-dev] [PATCH 3/8] doc: fix driver names in crypto devices guide
Quoted 11 lines · David Marchand
Quoted 3 lines · David Marchand
We still have:
doc/guides/cryptodevs/mvsam.rst:The MVSAM CRYPTO PMD (**librte_crypto_mvsam_pmd**) provides poll mode crypto driverAh.. and:
doc/guides/cryptodevs/snow3g.rst:The SNOW3G PMD (**librte_snow3g_zuc**) provides poll mode crypto driver support forGrepping
librte_is a better check than pmd.
I'll fix these missing 2 in v2.
/Bruce
PATCH 4/8 doc: fix driver names in event devices guide
In reply to Bruce RichardsonSince the built driver filenames have changed in DPDK 20.11, we need to update the driver doc to match.
--- doc/guides/eventdevs/octeontx.rst | 2 +- doc/guides/eventdevs/octeontx2.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)
doc/guides/eventdevs/octeontx.rst +1 -1
@@ -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.
doc/guides/eventdevs/octeontx2.rst +1 -1
@@ -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.
Signature · 1 line
2.25.1
Re: [dpdk-dev] [PATCH 4/8] doc: fix driver names in event devices guide
Quoted 7 lines · Bruce Richardson
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 <[email protected]>
Signature · 1 line
David Marchand
PATCH 5/8 doc: fix driver names in NIC devices guide
In reply to Bruce RichardsonSince 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.
---
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(-)
doc/guides/nics/ark.rst +1 -1
@@ -202,7 +202,7 @@ Usage Example Follow instructions available in the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>` 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:
doc/guides/nics/axgbe.rst +1 -1
@@ -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:
doc/guides/nics/bnx2x.rst +1 -1
@@ -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.
doc/guides/nics/bnxt.rst +1 -1
@@ -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
doc/guides/nics/cxgbe.rst +4 -4
@@ -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`:
doc/guides/nics/dpaa.rst +1 -1
@@ -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
doc/guides/nics/dpaa2.rst +1 -1
@@ -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
doc/guides/nics/ena.rst +1 -1
@@ -226,7 +226,7 @@ Usage example Follow instructions available in the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>` to launch -**testpmd** with Amazon ENA devices managed by librte_pmd_ena. +**testpmd** with Amazon ENA devices managed by librte_net_ena. Example output:
doc/guides/nics/enetc.rst +1 -1
@@ -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
doc/guides/nics/fail_safe.rst +1 -1
@@ -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
doc/guides/nics/hinic.rst +1 -1
@@ -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.
doc/guides/nics/hns3.rst +1 -1
@@ -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.
doc/guides/nics/i40e.rst +1 -1
@@ -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).
doc/guides/nics/ice.rst +1 -1
@@ -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.
doc/guides/nics/igb.rst +1 -1
@@ -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
doc/guides/nics/igc.rst +1 -1
@@ -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:
doc/guides/nics/ipn3ke.rst +1 -1
@@ -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.
doc/guides/nics/liquidio.rst +1 -1
@@ -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.
doc/guides/nics/mlx4.rst +26 -26
115 lines not on this page · raw message
doc/guides/nics/mlx5.rst +33 -33
129 lines not on this page · raw message
doc/guides/nics/mvneta.rst +1 -1
@@ -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:
doc/guides/nics/mvpp2.rst +1 -1
@@ -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:
doc/guides/nics/octeontx.rst +1 -1
@@ -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.
doc/guides/nics/octeontx2.rst +1 -1
@@ -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.
doc/guides/nics/pcap_ring.rst +2 -2
@@ -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::
doc/guides/nics/pfe.rst +1 -1
@@ -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
doc/guides/nics/qede.rst +2 -2
@@ -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``:
doc/guides/nics/sfc_efx.rst +1 -1
@@ -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.
doc/guides/nics/thunderx.rst +2 -2
@@ -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
doc/guides/nics/vdev_netvsc.rst +1 -1
@@ -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.
Signature · 1 line
2.25.1
Re: [dpdk-dev] [PATCH 5/8] doc: fix driver names in NIC devices guide
Quoted 19 lines · Bruce Richardson
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 <[email protected]>---
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.
Signature · 1 line
David Marchand
David Marchand
Reviewed-byRe: [dpdk-dev] [PATCH 5/8] doc: fix driver names in NIC devices guide
Quoted 14 lines · David Marchand
Quoted 11 lines · Bruce Richardson
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")
Quoted 9 lines
Quoted 8 lines
Signed-off-by Bruce Richardson <[email protected]>---
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.
This time with the review tag...
Signature · 1 line
David Marchand
Re: [dpdk-dev] [PATCH 5/8] doc: fix driver names in NIC devices guide
In reply to Bruce RichardsonQuoted 69 lines
Subject: [PATCH 5/8] doc: fix driver names in NIC devices guide
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 <[email protected]>---
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(-)- For information about I225, please refer to:
doc/guides/nics/ipn3ke.rst index renamed from doc/guides/nics/ipn3ke.rst +0
-0
5d4534e4da..a89e3719f2100644doc/guides/nics/ipn3ke.rst +2
-1@@ -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
Quoted 1 line
Intel Ethernet Controller X710/XXV710 and Intel Arria 10 FPGA.
Ajit Khaparde
Acked-byRe: [dpdk-dev] [PATCH 5/8] doc: fix driver names in NIC devices guide
Quoted 8 lines · Rosen
Quoted 8 lines
Subject: [PATCH 5/8] doc: fix driver names in NIC devices guide
Since the built driver filenames have changed in DPDK 20.11, we need to update the driver doc to match.
Quoted 8 lines
Quoted 8 lines
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 <[email protected]>
Quoted 3 lines
PATCH 6/8 doc: fix driver names in regex devices guide
In reply to Bruce RichardsonSince the built driver filenames have changed in DPDK 20.11, we need to update the driver doc to match.
--- doc/guides/regexdevs/mlx5.rst | 4 ++-- doc/guides/regexdevs/octeontx2.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-)
doc/guides/regexdevs/mlx5.rst +2 -2
@@ -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,
doc/guides/regexdevs/octeontx2.rst +1 -1
@@ -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.
Signature · 1 line
2.25.1
Re: [dpdk-dev] [PATCH 6/8] doc: fix driver names in regex devices guide
Quoted 7 lines · Bruce Richardson
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 <[email protected]>
Signature · 1 line
David Marchand
PATCH 7/8 doc: fix driver names in vDPA devices guide
In reply to Bruce RichardsonSince the built driver filenames have changed in DPDK 20.11, we need to update the driver doc to match.
--- doc/guides/vdpadevs/mlx5.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
doc/guides/vdpadevs/mlx5.rst +2 -2
@@ -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
Signature · 1 line
2.25.1
Re: [dpdk-dev] [PATCH 7/8] doc: fix driver names in vDPA devices guide
Quoted 7 lines · Bruce Richardson
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 <[email protected]>
Signature · 1 line
David Marchand
PATCH 8/8 doc: fix driver names in programmers guide
In reply to Bruce RichardsonSince the built driver filenames have changed in DPDK 20.11, we need to update the programmers guide doc to match.
--- .../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(-)
doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst +5 -5
@@ -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
doc/guides/prog_guide/source_org.rst +2 -1
@@ -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::
Signature · 1 line
2.25.1
Re: [dpdk-dev] [PATCH 8/8] doc: fix driver names in programmers guide
Quoted 7 lines · Bruce Richardson
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 <[email protected]>
Signature · 1 line
David Marchand
Quoted 6 lines · Bruce Richardson
Since the driver filenames are now following a new standard naming convention some doc updates are necessary. This patch makes those changes, and also includes a few other fixes, such as the first patch, where we remove an unncessary name override.
Quoted 9 lines
Bruce Richardson (8):
regex/octeontx2: fix unnecessary name override
doc: fix driver names in compression devices guide
doc: fix driver names in crypto devices guide
doc: fix driver names in event devices guide
doc: fix driver names in NIC devices guide
doc: fix driver names in regex devices guide
doc: fix driver names in vDPA devices guide
doc: fix driver names in programmers guide
First patch collides with Thomas' previous patch, but I vote yours is better. Only caught 2 misses in crypto, the rest lgtm.
Thanks for the series Bruce.
Signature · 1 line
David Marchand
v2 cover fix driver filenames in the docs
In reply to Bruce RichardsonSince the driver filenames are now following a new standard naming convention some doc updates are necessary.
V2:
dropped patch 1, no longer necessary to fix meson.build file. added two additional fixes to crypto doc patch
Bruce Richardson (7):
doc: fix driver names in compression devices guide
doc: fix driver names in crypto devices guide
doc: fix driver names in event devices guide
doc: fix driver names in NIC devices guide
doc: fix driver names in regex devices guide
doc: fix driver names in vDPA devices guide
doc: fix driver names in programmers guide
doc/guides/compressdevs/isal.rst | 2 +- doc/guides/compressdevs/octeontx.rst | 2 +- doc/guides/compressdevs/zlib.rst | 2 +- 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/mvsam.rst | 2 +- doc/guides/cryptodevs/null.rst | 2 +- doc/guides/cryptodevs/scheduler.rst | 4 +- doc/guides/cryptodevs/snow3g.rst | 2 +- doc/guides/cryptodevs/zuc.rst | 2 +- doc/guides/eventdevs/octeontx.rst | 2 +- doc/guides/eventdevs/octeontx2.rst | 2 +- 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 +- .../link_bonding_poll_mode_drv_lib.rst | 10 +-- doc/guides/prog_guide/source_org.rst | 3 +- doc/guides/regexdevs/mlx5.rst | 4 +- doc/guides/regexdevs/octeontx2.rst | 2 +- doc/guides/vdpadevs/mlx5.rst | 4 +- 49 files changed, 120 insertions(+), 119 deletions(-)
Signature · 1 line
2.25.1
PATCH v2 1/7 doc: fix driver names in compression devices guide
Since the built driver filenames have changed in DPDK 20.11, we need to update the driver doc to match.
--- 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(-)
doc/guides/compressdevs/isal.rst +1 -1
@@ -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).
doc/guides/compressdevs/octeontx.rst +1 -1
@@ -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.
doc/guides/compressdevs/zlib.rst +1 -1
@@ -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
Signature · 1 line
2.25.1
PATCH v2 2/7 doc: fix driver names in crypto devices guide
In reply to Bruce RichardsonSince the built driver filenames have changed in DPDK 20.11, we need to update the driver doc to match.
---
V2: added two missed driver name changes
--- 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/mvsam.rst | 2 +- doc/guides/cryptodevs/null.rst | 2 +- doc/guides/cryptodevs/scheduler.rst | 4 ++-- doc/guides/cryptodevs/snow3g.rst | 2 +- doc/guides/cryptodevs/zuc.rst | 2 +- 9 files changed, 10 insertions(+), 10 deletions(-)
doc/guides/cryptodevs/aesni_gcm.rst +1 -1
@@ -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).
doc/guides/cryptodevs/aesni_mb.rst +1 -1
@@ -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 <https://www.intel.com/content/dam/www/public/us/en/documents/white-papers/fast-multi-buffer-ipsec-implementations-ia-processors-paper.pdf>`_.
doc/guides/cryptodevs/ccp.rst +1 -1
@@ -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
doc/guides/cryptodevs/kasumi.rst +1 -1
@@ -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 <https://github.com/01org/intel-ipsec-mb>`_ which implements F8 and F9 functions for KASUMI UEA1 cipher and UIA1 hash algorithms.
doc/guides/cryptodevs/mvsam.rst +1 -1
@@ -5,7 +5,7 @@ MVSAM Crypto Poll Mode Driver ============================= -The MVSAM CRYPTO PMD (**librte_crypto_mvsam_pmd**) provides poll mode crypto driver +The MVSAM CRYPTO PMD (**librte_crypto_mvsam**) provides poll mode crypto driver support by utilizing MUSDK library, which provides cryptographic operations acceleration by using Security Acceleration Engine (EIP197) directly from user-space with minimum overhead and high performance.
doc/guides/cryptodevs/null.rst +1 -1
@@ -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
doc/guides/cryptodevs/scheduler.rst +2 -2
@@ -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.
doc/guides/cryptodevs/snow3g.rst +1 -1
@@ -4,7 +4,7 @@ SNOW 3G Crypto Poll Mode Driver =============================== -The SNOW3G PMD (**librte_snow3g_zuc**) provides poll mode crypto driver support for +The SNOW3G PMD (**librte_crypto_snow3g**) provides poll mode crypto driver support for utilizing `Intel IPSec Multi-buffer library <https://github.com/01org/intel-ipsec-mb>`_ which implements F8 and F8 functions for SNOW 3G UEA2 cipher and UIA2 hash algorithms.
doc/guides/cryptodevs/zuc.rst +1 -1
@@ -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 <https://github.com/01org/intel-ipsec-mb>`_ which implements F8 and F9 functions for ZUC EEA3 cipher and EIA3 hash algorithms.
Signature · 1 line
2.25.1
Re: [dpdk-dev] [PATCH v2 2/7] doc: fix driver names in crypto devices guide
Quoted 7 lines · Bruce Richardson
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 <[email protected]>
Thanks.
Signature · 1 line
David Marchand
PATCH v2 3/7 doc: fix driver names in event devices guide
In reply to Bruce RichardsonSince the built driver filenames have changed in DPDK 20.11, we need to update the driver doc to match.
--- doc/guides/eventdevs/octeontx.rst | 2 +- doc/guides/eventdevs/octeontx2.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)
doc/guides/eventdevs/octeontx.rst +1 -1
@@ -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.
doc/guides/eventdevs/octeontx2.rst +1 -1
@@ -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.
Signature · 1 line
2.25.1
PATCH v2 4/7 doc: fix driver names in NIC devices guide
In reply to Bruce RichardsonSince 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.
--- 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(-)
doc/guides/nics/ark.rst +1 -1
@@ -202,7 +202,7 @@ Usage Example Follow instructions available in the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>` 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:
doc/guides/nics/axgbe.rst +1 -1
@@ -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:
doc/guides/nics/bnx2x.rst +1 -1
@@ -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.
doc/guides/nics/bnxt.rst +1 -1
@@ -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
doc/guides/nics/cxgbe.rst +4 -4
@@ -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`:
doc/guides/nics/dpaa.rst +1 -1
@@ -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
doc/guides/nics/dpaa2.rst +1 -1
@@ -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
doc/guides/nics/ena.rst +1 -1
@@ -226,7 +226,7 @@ Usage example Follow instructions available in the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>` to launch -**testpmd** with Amazon ENA devices managed by librte_pmd_ena. +**testpmd** with Amazon ENA devices managed by librte_net_ena. Example output:
doc/guides/nics/enetc.rst +1 -1
@@ -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
doc/guides/nics/fail_safe.rst +1 -1
@@ -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
doc/guides/nics/hinic.rst +1 -1
@@ -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.
doc/guides/nics/hns3.rst +1 -1
@@ -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.
doc/guides/nics/i40e.rst +1 -1
@@ -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).
doc/guides/nics/ice.rst +1 -1
@@ -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.
doc/guides/nics/igb.rst +1 -1
@@ -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
doc/guides/nics/igc.rst +1 -1
@@ -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:
doc/guides/nics/ipn3ke.rst +1 -1
@@ -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.
doc/guides/nics/liquidio.rst +1 -1
@@ -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.
doc/guides/nics/mlx4.rst +26 -26
115 lines not on this page · raw message
doc/guides/nics/mlx5.rst +33 -33
129 lines not on this page · raw message
doc/guides/nics/mvneta.rst +1 -1
@@ -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:
doc/guides/nics/mvpp2.rst +1 -1
@@ -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:
doc/guides/nics/octeontx.rst +1 -1
@@ -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.
doc/guides/nics/octeontx2.rst +1 -1
@@ -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.
doc/guides/nics/pcap_ring.rst +2 -2
@@ -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::
doc/guides/nics/pfe.rst +1 -1
@@ -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
doc/guides/nics/qede.rst +2 -2
@@ -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``:
doc/guides/nics/sfc_efx.rst +1 -1
@@ -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.
doc/guides/nics/thunderx.rst +2 -2
@@ -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
doc/guides/nics/vdev_netvsc.rst +1 -1
@@ -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.
Signature · 1 line
2.25.1
PATCH v2 5/7 doc: fix driver names in regex devices guide
In reply to Bruce RichardsonSince the built driver filenames have changed in DPDK 20.11, we need to update the driver doc to match.
--- doc/guides/regexdevs/mlx5.rst | 4 ++-- doc/guides/regexdevs/octeontx2.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-)
doc/guides/regexdevs/mlx5.rst +2 -2
@@ -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,
doc/guides/regexdevs/octeontx2.rst +1 -1
@@ -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.
Signature · 1 line
2.25.1
PATCH v2 6/7 doc: fix driver names in vDPA devices guide
In reply to Bruce RichardsonSince the built driver filenames have changed in DPDK 20.11, we need to update the driver doc to match.
--- doc/guides/vdpadevs/mlx5.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
doc/guides/vdpadevs/mlx5.rst +2 -2
@@ -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
Signature · 1 line
2.25.1
PATCH v2 7/7 doc: fix driver names in programmers guide
In reply to Bruce RichardsonSince the built driver filenames have changed in DPDK 20.11, we need to update the programmers guide doc to match.
--- .../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(-)
doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst +5 -5
@@ -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
doc/guides/prog_guide/source_org.rst +2 -1
@@ -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::
Signature · 1 line
2.25.1
Quoted 8 lines · Bruce Richardson
Since the driver filenames are now following a new standard naming convention some doc updates are necessary.
V2:
dropped patch 1, no longer necessary to fix meson.build file. added two additional fixes to crypto doc patch
Series applied, thanks Bruce.
Signature · 1 line
David Marchand