Make is no longer supported for compiling DPDK, references are now removed in the documentation.
Signed-off-by: Ciara Power <ciara.po...@intel.com> --- doc/guides/nics/ark.rst | 26 --------------- doc/guides/nics/atlantic.rst | 4 --- doc/guides/nics/axgbe.rst | 15 --------- doc/guides/nics/bnx2x.rst | 27 --------------- doc/guides/nics/bnxt.rst | 3 -- doc/guides/nics/cxgbe.rst | 13 -------- doc/guides/nics/dpaa.rst | 25 -------------- doc/guides/nics/dpaa2.rst | 24 -------------- doc/guides/nics/ena.rst | 16 --------- doc/guides/nics/enic.rst | 9 ----- doc/guides/nics/fail_safe.rst | 12 ------- doc/guides/nics/fm10k.rst | 4 --- doc/guides/nics/hinic.rst | 9 ----- doc/guides/nics/hns3.rst | 10 ------ doc/guides/nics/i40e.rst | 28 ++-------------- doc/guides/nics/ice.rst | 17 ---------- doc/guides/nics/igc.rst | 14 -------- doc/guides/nics/intel_vf.rst | 14 ++------ doc/guides/nics/ionic.rst | 8 ----- doc/guides/nics/ipn3ke.rst | 8 ----- doc/guides/nics/liquidio.rst | 27 --------------- doc/guides/nics/mlx4.rst | 51 ----------------------------- doc/guides/nics/mlx5.rst | 58 --------------------------------- doc/guides/nics/mvneta.rst | 19 +---------- doc/guides/nics/mvpp2.rst | 29 +---------------- doc/guides/nics/nfb.rst | 17 +--------- doc/guides/nics/nfp.rst | 4 --- doc/guides/nics/null.rst | 6 ++-- doc/guides/nics/octeontx.rst | 19 +---------- doc/guides/nics/octeontx2.rst | 11 ------- doc/guides/nics/pcap_ring.rst | 22 ++++++------- doc/guides/nics/qede.rst | 17 ++-------- doc/guides/nics/sfc_efx.rst | 15 --------- doc/guides/nics/softnic.rst | 9 ----- doc/guides/nics/szedata2.rst | 18 +--------- doc/guides/nics/thunderx.rst | 20 ------------ doc/guides/nics/vdev_netvsc.rst | 6 ---- 37 files changed, 26 insertions(+), 608 deletions(-) diff --git a/doc/guides/nics/ark.rst b/doc/guides/nics/ark.rst index 06e8c33746..d7d679b452 100644 --- a/doc/guides/nics/ark.rst +++ b/doc/guides/nics/ark.rst @@ -119,32 +119,6 @@ Data Path Interface Ingress RX and Egress TX operation is by the nominal DPDK API . The driver supports single-port, multi-queue for both RX and TX. -Configuration Information -------------------------- - -**DPDK Configuration Parameters** - - The following configuration options are available for the ARK PMD: - - * **CONFIG_RTE_LIBRTE_ARK_PMD** (default y): Enables or disables inclusion - of the ARK PMD driver in the DPDK compilation. - - * **CONFIG_RTE_LIBRTE_ARK_PAD_TX** (default y): When enabled TX - packets are padded to 60 bytes to support downstream MACS. - - * **CONFIG_RTE_LIBRTE_ARK_DEBUG_RX** (default n): Enables or disables debug - logging and internal checking of RX ingress logic within the ARK PMD driver. - - * **CONFIG_RTE_LIBRTE_ARK_DEBUG_TX** (default n): Enables or disables debug - logging and internal checking of TX egress logic within the ARK PMD driver. - - * **CONFIG_RTE_LIBRTE_ARK_DEBUG_STATS** (default n): Enables or disables debug - logging of detailed packet and performance statistics gathered in - the PMD and FPGA. - - * **CONFIG_RTE_LIBRTE_ARK_DEBUG_TRACE** (default n): Enables or disables debug - logging of detailed PMD events and status. - Building DPDK ------------- diff --git a/doc/guides/nics/atlantic.rst b/doc/guides/nics/atlantic.rst index 3f3f2949f3..605f6dc3ab 100644 --- a/doc/guides/nics/atlantic.rst +++ b/doc/guides/nics/atlantic.rst @@ -26,10 +26,6 @@ Experimental API features - MACSEC PMD API is considered as experimental and is subject to change/removal in next DPDK releases. -Configuration Information -^^^^^^^^^^^^^^^^^^^^^^^^^ - -- ``CONFIG_RTE_LIBRTE_ATLANTIC_PMD`` (default ``y``) Application Programming Interface --------------------------------- diff --git a/doc/guides/nics/axgbe.rst b/doc/guides/nics/axgbe.rst index 9b270a4226..10bf86fa54 100644 --- a/doc/guides/nics/axgbe.rst +++ b/doc/guides/nics/axgbe.rst @@ -27,21 +27,6 @@ AXGBE PMD has support for: - Jumbo Frame up to 9K -Configuration Information -------------------------- - -The following options can be modified in the ``.config`` file. Please note that -enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_AXGBE_PMD`` (default **y**) - - Toggle compilation of axgbe PMD. - -- ``CONFIG_RTE_LIBRTE_AXGBE_PMD_DEBUG`` (default **n**) - - Toggle display for PMD debug related messages. - - Building DPDK ------------- diff --git a/doc/guides/nics/bnx2x.rst b/doc/guides/nics/bnx2x.rst index ab90d8ae5e..3c163df7a8 100644 --- a/doc/guides/nics/bnx2x.rst +++ b/doc/guides/nics/bnx2x.rst @@ -72,33 +72,6 @@ Prerequisites `linux-firmware git repository <https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/plain/bnx2x/bnx2x-e2-7.13.11.0.fw>`_ to get the required firmware. -Pre-Installation Configuration ------------------------------- - -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``.config`` file. Please note that -enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_BNX2X_PMD`` (default **n**) - - Toggle compilation of bnx2x driver. To use bnx2x PMD set this config parameter - to 'y'. Also, in order for firmware binary to load user will need zlib devel - package installed. - -- ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_TX`` (default **n**) - - Toggle display of transmit fast path run-time messages. - -- ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_RX`` (default **n**) - - Toggle display of receive fast path run-time messages. - -- ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_PERIODIC`` (default **n**) - - Toggle display of register reads and writes. - .. _bnx2x_driver-compilation: diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst index 129a16cfc7..8c0d60f154 100644 --- a/doc/guides/nics/bnxt.rst +++ b/doc/guides/nics/bnxt.rst @@ -565,9 +565,6 @@ The BNXT PMD supports a PTP client application to communicate with a PTP master clock using DPDK IEEE1588 APIs. Note that the PTP client application needs to run on PF and vector mode needs to be disabled. -For the PTP time synchronization support, the BNXT PMD must be compiled with -``CONFIG_RTE_LIBRTE_IEEE1588=y`` (this compilation flag is currently pending). - .. code-block:: console testpmd> set fwd ieee1588 // enable IEEE 1588 mode diff --git a/doc/guides/nics/cxgbe.rst b/doc/guides/nics/cxgbe.rst index 54a4c13899..628e8063c2 100644 --- a/doc/guides/nics/cxgbe.rst +++ b/doc/guides/nics/cxgbe.rst @@ -90,19 +90,6 @@ Prerequisites Pre-Installation Configuration ------------------------------ -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``.config`` file. Please note that -enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_CXGBE_PMD`` (default **y**) - - Toggle compilation of librte_pmd_cxgbe driver. - - .. note:: - - This controls compilation of both CXGBE and CXGBEVF PMD. Runtime Options ~~~~~~~~~~~~~~~ diff --git a/doc/guides/nics/dpaa.rst b/doc/guides/nics/dpaa.rst index 17839a920e..ae3fa7b8a6 100644 --- a/doc/guides/nics/dpaa.rst +++ b/doc/guides/nics/dpaa.rst @@ -195,31 +195,6 @@ See :doc:`../platform/dpaa` for setup information Pre-Installation Configuration ------------------------------ -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``config`` file. -Please note that enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_DPAA_BUS`` (default ``y``) - - Toggle compilation of the ``librte_bus_dpaa`` driver. - -- ``CONFIG_RTE_LIBRTE_DPAA_PMD`` (default ``y``) - - Toggle compilation of the ``librte_pmd_dpaa`` driver. - -- ``CONFIG_RTE_LIBRTE_DPAA_DEBUG_DRIVER`` (default ``n``) - - Toggles display of bus configurations and enables a debugging queue - to fetch error (Rx/Tx) packets to driver. By default, packets with errors - (like wrong checksum) are dropped by the hardware. - -- ``CONFIG_RTE_LIBRTE_DPAA_HWDEBUG`` (default ``n``) - - Enables debugging of the Queue and Buffer Manager layer which interacts - with the DPAA hardware. - Environment Variables ~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst index fdfa6fdd5a..8cd417f6f0 100644 --- a/doc/guides/nics/dpaa2.rst +++ b/doc/guides/nics/dpaa2.rst @@ -432,30 +432,6 @@ Currently supported by DPDK: Some part of fslmc bus code (mc flib - object library) routines are dual licensed (BSD & GPLv2), however they are used as BSD in DPDK in userspace. -Pre-Installation Configuration ------------------------------- - -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``config`` file. -Please note that enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_FSLMC_BUS`` (default ``y``) - - Toggle compilation of the ``librte_bus_fslmc`` driver. - -- ``CONFIG_RTE_LIBRTE_DPAA2_PMD`` (default ``y``) - - Toggle compilation of the ``librte_pmd_dpaa2`` driver. - -- ``CONFIG_RTE_LIBRTE_DPAA2_DEBUG_DRIVER`` (default ``n``) - - Toggle display of debugging messages/logic - -- ``CONFIG_RTE_LIBRTE_DPAA2_USE_PHYS_IOVA`` (default ``n``) - - Toggle to use physical address vs virtual address for hardware accelerators. Driver compilation and testing ------------------------------ diff --git a/doc/guides/nics/ena.rst b/doc/guides/nics/ena.rst index bec97c3326..4bdc3182fc 100644 --- a/doc/guides/nics/ena.rst +++ b/doc/guides/nics/ena.rst @@ -79,22 +79,6 @@ The driver supports multi-queue for both Tx and Rx. Configuration information ------------------------- -**DPDK Configuration Parameters** - - The following configuration options are available for the ENA PMD: - - * **CONFIG_RTE_LIBRTE_ENA_PMD** (default y): Enables or disables inclusion - of the ENA PMD driver in the DPDK compilation. - - * **CONFIG_RTE_LIBRTE_ENA_DEBUG_RX** (default n): Enables or disables debug - logging of RX logic within the ENA PMD driver. - - * **CONFIG_RTE_LIBRTE_ENA_DEBUG_TX** (default n): Enables or disables debug - logging of TX logic within the ENA PMD driver. - - * **CONFIG_RTE_LIBRTE_ENA_COM_DEBUG** (default n): Enables or disables debug - logging of low level tx/rx logic in ena_com(base) within the ENA PMD driver. - **Runtime Configuration Parameters** * **large_llq_hdr** (default 0) diff --git a/doc/guides/nics/enic.rst b/doc/guides/nics/enic.rst index a28a7f4e47..be6a034279 100644 --- a/doc/guides/nics/enic.rst +++ b/doc/guides/nics/enic.rst @@ -20,13 +20,6 @@ should be downloaded from https://core.dpdk.org/download/ Configuration information ------------------------- -- **DPDK Configuration Parameters** - - The following configuration options are available for the ENIC PMD: - - - **CONFIG_RTE_LIBRTE_ENIC_PMD** (default y): Enables or disables inclusion - of the ENIC PMD driver in the DPDK compilation. - - **vNIC Configuration Parameters** - **Number of Queues** @@ -583,8 +576,6 @@ The value depends on the memory configuration of the application, DPDK and PMD. Typically, the limit has to be raised to higher than 2GB. e.g., 2621440 -The compilation of any unused drivers can be disabled using the -configuration file in config/ directory (e.g., config/common_linux). This would help in bringing down the time taken for building the libraries and the initialization time of the application. diff --git a/doc/guides/nics/fail_safe.rst b/doc/guides/nics/fail_safe.rst index b4a92f663b..579a1fcdf8 100644 --- a/doc/guides/nics/fail_safe.rst +++ b/doc/guides/nics/fail_safe.rst @@ -14,10 +14,6 @@ Additionally to the Seamless Hotplug feature, the Fail-safe PMD offers the ability to redirect operations to a secondary device when the primary has been removed from the system. -.. note:: - - The library is enabled by default. You can enable it or disable it manually - by setting the ``CONFIG_RTE_LIBRTE_PMD_FAILSAFE`` configuration option. Features -------- @@ -33,14 +29,6 @@ automatically by detecting capable devices and registering the relevant handler. Check the feature matrix for the complete set of supported features. -Compilation option ------------------- - -Available options within the ``$RTE_TARGET/build/.config`` file: - -- ``CONFIG_RTE_LIBRTE_PMD_FAILSAFE`` (default **y**) - - This option enables or disables compiling librte_pmd_failsafe. Using the Fail-safe PMD from the EAL command line ------------------------------------------------- diff --git a/doc/guides/nics/fm10k.rst b/doc/guides/nics/fm10k.rst index 4e178c2cc6..0f7c91bbd1 100644 --- a/doc/guides/nics/fm10k.rst +++ b/doc/guides/nics/fm10k.rst @@ -35,10 +35,6 @@ There is no change to the PMD API. The RX/TX handlers are the only two entries f vPMD packet I/O. They are transparently registered at runtime RX/TX execution if all required conditions are met. -1. To date, only an SSE version of FM10K vPMD is available. - To ensure that vPMD is in the binary code, set - ``CONFIG_RTE_LIBRTE_FM10K_INC_VECTOR=y`` in the configure file. - Some constraints apply as pre-conditions for specific optimizations on bulk packet transfers. The following sections explain RX and TX constraints in the vPMD. diff --git a/doc/guides/nics/hinic.rst b/doc/guides/nics/hinic.rst index f765060641..fe13c582e7 100644 --- a/doc/guides/nics/hinic.rst +++ b/doc/guides/nics/hinic.rst @@ -46,15 +46,6 @@ Prerequisites - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment. -Pre-Installation Configuration ------------------------------- - -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``config`` file. - -- ``CONFIG_RTE_LIBRTE_HINIC_PMD`` (default ``y``) Driver compilation and testing ------------------------------ diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst index a62fcfdede..d96ad5d445 100644 --- a/doc/guides/nics/hns3.rst +++ b/doc/guides/nics/hns3.rst @@ -44,16 +44,6 @@ Prerequisites - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment. -Pre-Installation Configuration ------------------------------- - -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``config`` file. -Please note that enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_HNS3_PMD`` (default ``y``) Driver compilation and testing ------------------------------ diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst index b7430f6c4e..19f0b06885 100644 --- a/doc/guides/nics/i40e.rst +++ b/doc/guides/nics/i40e.rst @@ -156,34 +156,12 @@ Config File Options ~~~~~~~~~~~~~~~~~~~ The following options can be modified in the ``config`` file. -Please note that enabling debugging options may affect system performance. -- ``CONFIG_RTE_LIBRTE_I40E_PMD`` (default ``y``) - - Toggle compilation of the ``librte_pmd_i40e`` driver. - -- ``CONFIG_RTE_LIBRTE_I40E_DEBUG_*`` (default ``n``) - - Toggle display of generic debugging messages. - -- ``CONFIG_RTE_LIBRTE_I40E_RX_ALLOW_BULK_ALLOC`` (default ``y``) - - Toggle bulk allocation for RX. - -- ``CONFIG_RTE_LIBRTE_I40E_INC_VECTOR`` (default ``n``) - - Toggle the use of Vector PMD instead of normal RX/TX path. - To enable vPMD for RX, bulk allocation for Rx must be allowed. - -- ``CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC`` (default ``n``) - - Toggle to use a 16-byte RX descriptor, by default the RX descriptor is 32 byte. - -- ``CONFIG_RTE_LIBRTE_I40E_QUEUE_NUM_PER_PF`` (default ``64``) +- ``RTE_LIBRTE_I40E_QUEUE_NUM_PER_PF`` (default ``64``) Number of queues reserved for PF. -- ``CONFIG_RTE_LIBRTE_I40E_QUEUE_NUM_PER_VM`` (default ``4``) +- ``RTE_LIBRTE_I40E_QUEUE_NUM_PER_VM`` (default ``4``) Number of queues reserved for each VMDQ Pool. @@ -760,7 +738,7 @@ Use 16 Bytes RX Descriptor Size ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ As i40e PMD supports both 16 and 32 bytes RX descriptor sizes, and 16 bytes size can provide helps to high performance of small packets. -Configuration of ``CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC`` in config files can be changed to use 16 bytes size RX descriptors. +Configuration of ``RTE_LIBRTE_I40E_16BYTE_RX_DESC`` in config files can be changed to use 16 bytes size RX descriptors. Input set requirement of each pctype for FDIR ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst index 9a9f4a6bb0..9b3bd5d593 100644 --- a/doc/guides/nics/ice.rst +++ b/doc/guides/nics/ice.rst @@ -23,23 +23,6 @@ Prerequisites Pre-Installation Configuration ------------------------------ -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``config`` file. -Please note that enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_ICE_PMD`` (default ``y``) - - Toggle compilation of the ``librte_pmd_ice`` driver. - -- ``CONFIG_RTE_LIBRTE_ICE_DEBUG_*`` (default ``n``) - - Toggle display of generic debugging messages. - -- ``CONFIG_RTE_LIBRTE_ICE_16BYTE_RX_DESC`` (default ``n``) - - Toggle to use a 16-byte RX descriptor, by default the RX descriptor is 32 byte. Runtime Config Options ~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/guides/nics/igc.rst b/doc/guides/nics/igc.rst index 4c5e626759..3dabbdcc6a 100644 --- a/doc/guides/nics/igc.rst +++ b/doc/guides/nics/igc.rst @@ -11,20 +11,6 @@ I225 Series Network Adapters. `https://ark.intel.com/content/www/us/en/ark/products/series/184686/ intel-ethernet-controller-i225-series.html` -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``config`` file. -Please note that enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_IGC_PMD`` (default ``y``) - - Toggle compilation of the ``librte_pmd_igc`` driver. - -- ``CONFIG_RTE_LIBRTE_IGC_DEBUG_*`` (default ``n``) - - Toggle display of generic debugging messages. - Driver compilation and testing ------------------------------ diff --git a/doc/guides/nics/intel_vf.rst b/doc/guides/nics/intel_vf.rst index ade5152595..6a8fe0f02c 100644 --- a/doc/guides/nics/intel_vf.rst +++ b/doc/guides/nics/intel_vf.rst @@ -124,7 +124,7 @@ Intel® X710/XL710 Gigabit Ethernet Controller VF Infrastructure In a virtualized environment, the programmer can enable a maximum of *128 Virtual Functions (VF)* globally per Intel® X710/XL710 Gigabit Ethernet Controller NIC device. -The number of queue pairs of each VF can be configured by ``CONFIG_RTE_LIBRTE_I40E_QUEUE_NUM_PER_VF`` in ``config`` file. +The number of queue pairs of each VF can be configured by ``RTE_LIBRTE_I40E_QUEUE_NUM_PER_VF`` in ``config`` file. The Physical Function in host could be either configured by the Linux* i40e driver (in the case of the Linux Kernel-based Virtual Machine [KVM]) or by DPDK PMD PF driver. When using both DPDK PMD PF/VF drivers, the whole NIC will be taken over by DPDK based application. @@ -521,20 +521,12 @@ The setup procedure is as follows: .. code-block:: console - make install T=x86_64-native-linux-gcc - ./x86_64-native-linux-gcc/app/testpmd -l 0-3 -n 4 -- -i + ./{build_dir}/app/testpmd -l 0-3 -n 4 -- -i #. Finally, access the Guest OS using vncviewer with the localhost:5900 port and check the lspci command output in the Guest OS. The virtual functions will be listed as available for use. -#. Configure and install the DPDK with an x86_64-native-linux-gcc configuration on the Guest OS as normal, - that is, there is no change to the normal installation procedure. - - .. code-block:: console - - make config T=x86_64-native-linux-gcc O=x86_64-native-linux-gcc - cd x86_64-native-linux-gcc - make +#. Configure and install the DPDK on the Guest OS as normal, that is, there is no change to the normal installation procedure. .. note:: diff --git a/doc/guides/nics/ionic.rst b/doc/guides/nics/ionic.rst index 787123df5d..fd32926bf4 100644 --- a/doc/guides/nics/ionic.rst +++ b/doc/guides/nics/ionic.rst @@ -24,14 +24,6 @@ on the host, check for the PCI devices: b5:00.0 Ethernet controller: Device 1dd8:1002 b6:00.0 Ethernet controller: Device 1dd8:1002 -Pre-Installation Configuration ------------------------------- - -The following options can be modified in the ``config`` file. - -- ``CONFIG_RTE_LIBRTE_IONIC_PMD`` (default ``y``) - - Toggle compilation of ionic PMD. Building DPDK ------------- diff --git a/doc/guides/nics/ipn3ke.rst b/doc/guides/nics/ipn3ke.rst index c6c1552f66..857ae87ca6 100644 --- a/doc/guides/nics/ipn3ke.rst +++ b/doc/guides/nics/ipn3ke.rst @@ -31,14 +31,6 @@ Prerequisites Pre-Installation Configuration ------------------------------ -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``config`` file. - -- ``CONFIG_RTE_LIBRTE_IPN3KE_PMD`` (default ``y``) - - Toggle compilation of the ``librte_pmd_ipn3ke`` driver. Runtime Config Options ~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/guides/nics/liquidio.rst b/doc/guides/nics/liquidio.rst index 0534146720..65c7d2d0b0 100644 --- a/doc/guides/nics/liquidio.rst +++ b/doc/guides/nics/liquidio.rst @@ -20,33 +20,6 @@ Supported LiquidIO Adapters - LiquidIO II CN2360 210SVPT -Pre-Installation Configuration ------------------------------- - -The following options can be modified in the ``config`` file. -Please note that enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_LIO_PMD`` (default ``y``) - - Toggle compilation of LiquidIO PMD. - -- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_RX`` (default ``n``) - - Toggle display of receive fast path run-time messages. - -- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_TX`` (default ``n``) - - Toggle display of transmit fast path run-time messages. - -- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_MBOX`` (default ``n``) - - Toggle display of mailbox messages. - -- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_REGS`` (default ``n``) - - Toggle display of register reads and writes. - - SR-IOV: Prerequisites and Sample Application Notes -------------------------------------------------- diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst index 1f1e2f6c77..96c1015658 100644 --- a/doc/guides/nics/mlx4.rst +++ b/doc/guides/nics/mlx4.rst @@ -16,11 +16,6 @@ the `Mellanox community <http://community.mellanox.com/welcome>`_. There is also a `section dedicated to this poll mode driver <http://www.mellanox.com/page/products_dyn?product_family=209&mtag=pmd_for_dpdk>`_. -.. note:: - - Due to external dependencies, this driver is disabled by default. It must - be enabled manually by setting ``CONFIG_RTE_LIBRTE_MLX4_PMD=y`` and - recompiling DPDK. Implementation details ---------------------- @@ -56,42 +51,6 @@ Configuration Compilation options ~~~~~~~~~~~~~~~~~~~ -These options can be modified in the ``.config`` file. - -- ``CONFIG_RTE_LIBRTE_MLX4_PMD`` (default **n**) - - Toggle compilation of librte_pmd_mlx4 itself. - -- ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` (default **n**) - - Build PMD with additional code to make it loadable without hard - dependencies on **libibverbs** nor **libmlx4**, which may not be installed - on the target system. - - In this mode, their presence is still required for it to run properly, - however their absence won't prevent a DPDK application from starting (with - ``CONFIG_RTE_BUILD_SHARED_LIB`` disabled) and they won't show up as - missing with ``ldd(1)``. - - It works by moving these dependencies to a purpose-built rdma-core "glue" - plug-in which must either be installed in a directory whose name is based - on ``CONFIG_RTE_EAL_PMD_PATH`` suffixed with ``-glue`` if set, or in a - standard location for the dynamic linker (e.g. ``/lib``) if left to the - default empty string (``""``). - - This option has no performance impact. - -- ``CONFIG_RTE_IBVERBS_LINK_STATIC`` (default **n**) - - Embed static flavor of the dependencies **libibverbs** and **libmlx4** - in the PMD shared library or the executable static binary. - -- ``CONFIG_RTE_LIBRTE_MLX4_DEBUG`` (default **n**) - - Toggle debugging code and stricter compilation flags. Enabling this option - adds additional run-time checks and debugging messages at the cost of - lower performance. - This option is available in meson: - ``ibverbs_link`` can be ``static``, ``shared``, or ``dlopen``. @@ -104,9 +63,6 @@ Environment variables A list of directories in which to search for the rdma-core "glue" plug-in, separated by colons or semi-colons. - Only matters when compiled with ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` - enabled and most useful when ``CONFIG_RTE_EAL_PMD_PATH`` is also set, - since ``LD_LIBRARY_PATH`` has no effect in this case. Run-time configuration ~~~~~~~~~~~~~~~~~~~~~~ @@ -245,13 +201,6 @@ Current RDMA core package and Linux kernel (recommended) .. _`RDMA core installation documentation`: https://raw.githubusercontent.com/linux-rdma/rdma-core/master/README.md -If rdma-core libraries are built but not installed, DPDK makefile can link them, -thanks to these environment variables: - - - ``EXTRA_CFLAGS=-I/path/to/rdma-core/build/include`` - - ``EXTRA_LDFLAGS=-L/path/to/rdma-core/build/lib`` - - ``PKG_CONFIG_PATH=/path/to/rdma-core/build/lib/pkgconfig`` - .. _Mellanox_OFED_as_a_fallback: Mellanox OFED as a fallback diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index 211c0c5a6c..4daab00643 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -20,11 +20,6 @@ Information and documentation about these adapters can be found on the There is also a `section dedicated to this poll mode driver <http://www.mellanox.com/page/products_dyn?product_family=209&mtag=pmd_for_dpdk>`__. -.. note:: - - Due to external dependencies, this driver is disabled in default configuration - of the "make" build. It can be enabled with ``CONFIG_RTE_LIBRTE_MLX5_PMD=y`` - or by using "meson" build system which will detect dependencies. Design ------ @@ -328,49 +323,6 @@ Configuration Compilation options ~~~~~~~~~~~~~~~~~~~ -These options can be modified in the ``.config`` file. - -- ``CONFIG_RTE_LIBRTE_MLX5_PMD`` (default **n**) - - Toggle compilation of librte_pmd_mlx5 itself. - -- ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` (default **n**) - - Build PMD with additional code to make it loadable without hard - dependencies on **libibverbs** nor **libmlx5**, which may not be installed - on the target system. - - In this mode, their presence is still required for it to run properly, - however their absence won't prevent a DPDK application from starting (with - ``CONFIG_RTE_BUILD_SHARED_LIB`` disabled) and they won't show up as - missing with ``ldd(1)``. - - It works by moving these dependencies to a purpose-built rdma-core "glue" - plug-in which must either be installed in a directory whose name is based - on ``CONFIG_RTE_EAL_PMD_PATH`` suffixed with ``-glue`` if set, or in a - standard location for the dynamic linker (e.g. ``/lib``) if left to the - default empty string (``""``). - - This option has no performance impact. - -- ``CONFIG_RTE_IBVERBS_LINK_STATIC`` (default **n**) - - Embed static flavor of the dependencies **libibverbs** and **libmlx5** - in the PMD shared library or the executable static binary. - -- ``CONFIG_RTE_LIBRTE_MLX5_DEBUG`` (default **n**) - - Toggle debugging code and stricter compilation flags. Enabling this option - adds additional run-time checks and debugging messages at the cost of - lower performance. - -.. note:: - - For BlueField, target should be set to ``arm64-bluefield-linux-gcc``. This - will enable ``CONFIG_RTE_LIBRTE_MLX5_PMD`` and set ``RTE_CACHE_LINE_SIZE`` to - 64. Default armv8a configuration of make build and meson build set it to 128 - then brings performance degradation. - This option is available in meson: - ``ibverbs_link`` can be ``static``, ``shared``, or ``dlopen``. @@ -383,10 +335,6 @@ Environment variables A list of directories in which to search for the rdma-core "glue" plug-in, separated by colons or semi-colons. - Only matters when compiled with ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` - enabled and most useful when ``CONFIG_RTE_EAL_PMD_PATH`` is also set, - since ``LD_LIBRARY_PATH`` has no effect in this case. - - ``MLX5_SHUT_UP_BF`` Configures HW Tx doorbell register as IO-mapped. @@ -1109,12 +1057,6 @@ RDMA Core with Linux Kernel .. _`Linux installation documentation`: https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable.git/plain/Documentation/admin-guide/README.rst .. _`RDMA Core installation documentation`: https://raw.githubusercontent.com/linux-rdma/rdma-core/master/README.md -If rdma-core libraries are built but not installed, DPDK makefile can link them, -thanks to these environment variables: - - - ``EXTRA_CFLAGS=-I/path/to/rdma-core/build/include`` - - ``EXTRA_LDFLAGS=-L/path/to/rdma-core/build/lib`` - - ``PKG_CONFIG_PATH=/path/to/rdma-core/build/lib/pkgconfig`` Mellanox OFED/EN ^^^^^^^^^^^^^^^^ diff --git a/doc/guides/nics/mvneta.rst b/doc/guides/nics/mvneta.rst index c8b00ddf22..7cd7bea499 100644 --- a/doc/guides/nics/mvneta.rst +++ b/doc/guides/nics/mvneta.rst @@ -13,12 +13,6 @@ Detailed information about SoCs that use PPv2 can be obtained here: * https://www.marvell.com/embedded-processors/armada-3700/ -.. Note:: - - Due to external dependencies, this driver is disabled by default. It must - be enabled manually by setting relevant configuration option manually. - Please refer to `Config File Options`_ section for further details. - Features -------- @@ -84,14 +78,6 @@ Prerequisites Pre-Installation Configuration ------------------------------ -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``config`` file. - -- ``CONFIG_RTE_LIBRTE_MVNETA_PMD`` (default ``n``) - - Toggle compilation of the librte_pmd_mvneta driver. Runtime options ~~~~~~~~~~~~~~~ @@ -132,10 +118,7 @@ the path to the MUSDK installation directory needs to be exported. .. code-block:: console export LIBMUSDK_PATH=<musdk>/usr/local - export CROSS=aarch64-linux-gnu- - make config T=arm64-armv8a-linux-gcc - sed -ri 's,(MVNETA_PMD=)n,\1y,' build/.config - make + Usage Example ------------- diff --git a/doc/guides/nics/mvpp2.rst b/doc/guides/nics/mvpp2.rst index 19cab1cbcc..3b134ca301 100644 --- a/doc/guides/nics/mvpp2.rst +++ b/doc/guides/nics/mvpp2.rst @@ -15,12 +15,6 @@ Detailed information about SoCs that use PPv2 can be obtained here: * https://www.marvell.com/embedded-processors/armada-70xx/ * https://www.marvell.com/embedded-processors/armada-80xx/ -.. Note:: - - Due to external dependencies, this driver is disabled by default. It must - be enabled manually by setting relevant configuration option manually. - Please refer to `Config File Options`_ section for further details. - Features -------- @@ -114,20 +108,6 @@ Prerequisites DPDK environment. -Config File Options -------------------- - -The following options can be modified in the ``config`` file. - -- ``CONFIG_RTE_LIBRTE_MVPP2_PMD`` (default ``n``) - - Toggle compilation of the librte mvpp2 driver. - - .. Note:: - - When MVPP2 PMD is enabled ``CONFIG_RTE_LIBRTE_MVNETA_PMD`` must be disabled - - Building DPDK ------------- @@ -151,14 +131,7 @@ For additional instructions regarding DPDK cross compilation please refer to :do .. code-block:: console export LIBMUSDK_PATH=<musdk>/usr/local - export CROSS=<toolchain>/bin/aarch64-linux-gnu- - export RTE_KERNELDIR=<kernel-dir> - export RTE_TARGET=arm64-armv8a-linux-gcc - - make config T=arm64-armv8a-linux-gcc - sed -i "s/MVNETA_PMD=y/MVNETA_PMD=n/" build/.config - sed -i "s/MVPP2_PMD=n/MVPP2_PMD=y/" build/.config - make + Usage Example ------------- diff --git a/doc/guides/nics/nfb.rst b/doc/guides/nics/nfb.rst index 10f33a025e..d4e04179f6 100644 --- a/doc/guides/nics/nfb.rst +++ b/doc/guides/nics/nfb.rst @@ -16,13 +16,6 @@ and used technology (`Netcope Development Kit <http://www.netcope.com/en/products/fpga-development-kit>`_) can be found on the `Netcope Technologies website <http://www.netcope.com/>`_. -.. note:: - - This driver has external dependencies. - Therefore it is disabled in default configuration files. - It can be enabled by setting ``CONFIG_RTE_LIBRTE_NFB_PMD=y`` - and recompiling. - .. note:: Currently the driver is supported only on x86_64 architectures. @@ -62,14 +55,6 @@ The minimum version of the provided packages: Configuration ------------- -These configuration options can be modified before compilation in the -``.config`` file: - -* ``CONFIG_RTE_LIBRTE_NFB_PMD`` default value: **n** - - Value **y** enables compilation of nfb PMD. - - Timestamps The PMD supports hardware timestamps of frame receipt on physical network interface. In order to use @@ -78,7 +63,7 @@ products) and the device argument `timestamp=1` must be used. .. code-block:: console - $RTE_TARGET/app/testpmd -w b3:00.0,timestamp=1 <other EAL params> -- <testpmd params> + ./{build_dir}/app/testpmd -w b3:00.0,timestamp=1 <other EAL params> -- <testpmd params> When the timestamps are enabled with the *devarg*, a timestamp validity flag is set in the MBUFs containing received frames and timestamp is inserted into the `rte_mbuf` struct. diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst index 5f2a0698f6..6aa58f4358 100644 --- a/doc/guides/nics/nfp.rst +++ b/doc/guides/nics/nfp.rst @@ -49,10 +49,6 @@ compile it along with other DPDK PMDs even if no BSP was installed previously. Of course, a DPDK app will require such a BSP installed for using the NFP PMD, along with a specific NFP firmware application. -Default PMD configuration is at the **common_linux configuration** file: - -- **CONFIG_RTE_LIBRTE_NFP_PMD=y** - Once the DPDK is built all the DPDK apps and examples include support for the NFP PMD. diff --git a/doc/guides/nics/null.rst b/doc/guides/nics/null.rst index c68d0d6051..bf25402637 100644 --- a/doc/guides/nics/null.rst +++ b/doc/guides/nics/null.rst @@ -14,7 +14,7 @@ Usage .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev net_null0 --vdev net_null1 -- -i + ./{build_dir}/app/testpmd -l 0-3 -n 4 --vdev net_null0 --vdev net_null1 -- -i Runtime Config Options @@ -26,7 +26,7 @@ Runtime Config Options .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev "net_null0,copy=1" -- -i + ./{build_dir}/app/testpmd -l 0-3 -n 4 --vdev "net_null0,copy=1" -- -i - ``size`` [optional, default=64 bytes] @@ -35,7 +35,7 @@ Runtime Config Options .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev "net_null0,size=256" -- -i + ./{build_dir}/app/testpmd -l 0-3 -n 4 --vdev "net_null0,size=256" -- -i - ``no-rx`` [optional, default disabled] diff --git a/doc/guides/nics/octeontx.rst b/doc/guides/nics/octeontx.rst index c8655bf375..cb4c52e7de 100644 --- a/doc/guides/nics/octeontx.rst +++ b/doc/guides/nics/octeontx.rst @@ -52,15 +52,6 @@ See :doc:`../platform/octeontx` for setup information. Pre-Installation Configuration ------------------------------ -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``config`` file. -Please note that enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_OCTEONTX_PMD`` (default ``y``) - - Toggle compilation of the ``librte_pmd_octeontx`` driver. Driver compilation and testing ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -68,14 +59,6 @@ Driver compilation and testing Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>` for details. -To compile the OCTEON TX PMD for Linux arm64 gcc target, run the -following ``make`` command: - -.. code-block:: console - - cd <DPDK-source-directory> - make config T=arm64-thunderx-linux-gcc install - #. Running testpmd: Follow instructions available in the document @@ -86,7 +69,7 @@ following ``make`` command: .. code-block:: console - ./arm64-thunderx-linux-gcc/app/testpmd -c 700 \ + ./{build_dir}/app/testpmd -c 700 \ --base-virtaddr=0x100000000000 \ --mbuf-pool-ops-name="octeontx_fpavf" \ --vdev='event_octeontx' \ diff --git a/doc/guides/nics/octeontx2.rst b/doc/guides/nics/octeontx2.rst index bb591a8b7e..0036fdf70d 100644 --- a/doc/guides/nics/octeontx2.rst +++ b/doc/guides/nics/octeontx2.rst @@ -46,14 +46,6 @@ Prerequisites See :doc:`../platform/octeontx2` for setup information. -Compile time Config Options ---------------------------- - -The following options may be modified in the ``config`` file. - -- ``CONFIG_RTE_LIBRTE_OCTEONTX2_PMD`` (default ``y``) - - Toggle compilation of the ``librte_pmd_octeontx2`` driver. Driver compilation and testing ------------------------------ @@ -61,9 +53,6 @@ Driver compilation and testing Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>` for details. -To compile the OCTEON TX2 PMD for Linux arm64 gcc, -use arm64-octeontx2-linux-gcc as target. - #. Running testpmd: Follow instructions available in the document diff --git a/doc/guides/nics/pcap_ring.rst b/doc/guides/nics/pcap_ring.rst index cf230ae40a..4257f3db85 100644 --- a/doc/guides/nics/pcap_ring.rst +++ b/doc/guides/nics/pcap_ring.rst @@ -15,10 +15,8 @@ the DPDK also includes pure-software PMDs, two of these drivers are: .. note:: - The libpcap -based PMD is disabled by default in the build configuration files, - owing to an external dependency on the libpcap development files which must be installed on the board. - Once the libpcap development files are installed, - the library can be enabled by setting CONFIG_RTE_LIBRTE_PMD_PCAP=y and recompiling the DPDK. + The libpcap -based PMD has an external dependency on the libpcap development files which must + be installed on the board. Using the Drivers from the EAL Command Line ------------------------------------------- @@ -42,7 +40,7 @@ Device name and stream options must be separated by commas as shown below: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 \ + {build_dir}/app/testpmd -l 0-3 -n 4 \ --vdev 'net_pcap0,stream_opt0=..,stream_opt1=..' \ --vdev='net_pcap1,stream_opt0=..' @@ -141,7 +139,7 @@ Read packets from one pcap file and write them to another: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 \ + {build_dir}/app/testpmd -l 0-3 -n 4 \ --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_pcap=file_tx.pcap' \ -- --port-topology=chained @@ -149,7 +147,7 @@ Read packets from a network interface and write them to a pcap file: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 \ + {build_dir}/app/testpmd -l 0-3 -n 4 \ --vdev 'net_pcap0,rx_iface=eth0,tx_pcap=file_tx.pcap' \ -- --port-topology=chained @@ -157,7 +155,7 @@ Read packets from a pcap file and write them to a network interface: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 \ + {build_dir}/app/testpmd -l 0-3 -n 4 \ --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_iface=eth1' \ -- --port-topology=chained @@ -165,14 +163,14 @@ Forward packets through two network interfaces: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 \ + {build_dir}/app/testpmd -l 0-3 -n 4 \ --vdev 'net_pcap0,iface=eth0' --vdev='net_pcap1;iface=eth1' Enable 2 tx queues on a network interface: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 \ + {build_dir}/app/testpmd -l 0-3 -n 4 \ --vdev 'net_pcap0,rx_iface=eth1,tx_iface=eth1,tx_iface=eth1' \ -- --txq 2 @@ -180,7 +178,7 @@ Read only incoming packets from a network interface and write them back to the s .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 \ + {build_dir}/app/testpmd -l 0-3 -n 4 \ --vdev 'net_pcap0,rx_iface_in=eth1,tx_iface=eth1' Using libpcap-based PMD with the testpmd Application @@ -205,7 +203,7 @@ Otherwise, the first 512 packets from the input pcap file will be discarded by t .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 4 \ + {build_dir}/app/testpmd -l 0-3 -n 4 \ --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_pcap=file_tx.pcap' \ -- --port-topology=chained --no-flush-rx diff --git a/doc/guides/nics/qede.rst b/doc/guides/nics/qede.rst index 5b2f868952..cfa1b46ee2 100644 --- a/doc/guides/nics/qede.rst +++ b/doc/guides/nics/qede.rst @@ -111,22 +111,9 @@ Performance note Config File Options ~~~~~~~~~~~~~~~~~~~ -The following options can be modified in the ``.config`` file. Please note that -enabling debugging options may affect system performance. +The following option can be modified in the ``rte_config.h`` file. -- ``CONFIG_RTE_LIBRTE_QEDE_PMD`` (default **y**) - - Toggle compilation of QEDE PMD driver. - -- ``CONFIG_RTE_LIBRTE_QEDE_DEBUG_TX`` (default **n**) - - Toggle display of transmit fast path run-time messages. - -- ``CONFIG_RTE_LIBRTE_QEDE_DEBUG_RX`` (default **n**) - - Toggle display of receive fast path run-time messages. - -- ``CONFIG_RTE_LIBRTE_QEDE_FW`` (default **""**) +- ``RTE_LIBRTE_QEDE_FW`` (default **""**) Gives absolute path of firmware file. ``Eg: "/lib/firmware/qed/qed_init_values-8.40.33.0.bin"`` diff --git a/doc/guides/nics/sfc_efx.rst b/doc/guides/nics/sfc_efx.rst index be1c2fe1d6..6ee5190f3c 100644 --- a/doc/guides/nics/sfc_efx.rst +++ b/doc/guides/nics/sfc_efx.rst @@ -271,21 +271,6 @@ Pre-Installation Configuration ------------------------------ -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``.config`` file. -Please note that enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_SFC_EFX_PMD`` (default **y**) - - Enable compilation of Solarflare libefx-based poll-mode driver. - -- ``CONFIG_RTE_LIBRTE_SFC_EFX_DEBUG`` (default **n**) - - Enable compilation of the extra run-time consistency checks. - - Per-Device Parameters ~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/guides/nics/softnic.rst b/doc/guides/nics/softnic.rst index 8f0dd53eac..21030e4371 100644 --- a/doc/guides/nics/softnic.rst +++ b/doc/guides/nics/softnic.rst @@ -51,15 +51,6 @@ Any Linux distribution fulfilling the conditions described in ``System Requireme section of :ref:`the DPDK documentation <linux_gsg>` or refer to *DPDK Release Notes*. -Build options -------------- - -The default PMD configuration available in the common_linux configuration file: - -CONFIG_RTE_LIBRTE_PMD_SOFTNIC=y - -Once the DPDK is built, all the DPDK applications include support for the -Soft NIC PMD. Soft NIC PMD arguments ---------------------- diff --git a/doc/guides/nics/szedata2.rst b/doc/guides/nics/szedata2.rst index 30710a80b8..d1dcee971f 100644 --- a/doc/guides/nics/szedata2.rst +++ b/doc/guides/nics/szedata2.rst @@ -15,13 +15,6 @@ and used technology (`Netcope Development Kit <http://www.netcope.com/en/products/fpga-development-kit>`_) can be found on the `Netcope Technologies website <http://www.netcope.com/>`_. -.. note:: - - This driver has external dependencies. - Therefore it is disabled in default configuration files. - It can be enabled by setting ``CONFIG_RTE_LIBRTE_PMD_SZEDATA2=y`` - and recompiling. - .. note:: Currently the driver is supported only on x86_64 architectures. @@ -63,15 +56,6 @@ The minimum version of the provided packages: * for DPDK up to 18.02 (including): **3.0.5** -Configuration -------------- - -These configuration options can be modified before compilation in the -``.config`` file: - -* ``CONFIG_RTE_LIBRTE_PMD_SZEDATA2`` default value: **n** - - Value **y** enables compilation of szedata2 PMD. Using the SZEDATA2 PMD ---------------------- @@ -129,7 +113,7 @@ transmit channel: .. code-block:: console - $RTE_TARGET/app/testpmd -l 0-3 -n 2 \ + ./{build_dir}/app/testpmd -l 0-3 -n 2 \ -- --port-topology=chained --rxq=2 --txq=2 --nb-cores=2 -i -a Example output: diff --git a/doc/guides/nics/thunderx.rst b/doc/guides/nics/thunderx.rst index b1ef9eba59..464c934add 100644 --- a/doc/guides/nics/thunderx.rst +++ b/doc/guides/nics/thunderx.rst @@ -43,26 +43,6 @@ Prerequisites ------------- - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment. -Pre-Installation Configuration ------------------------------- - -Config File Options -~~~~~~~~~~~~~~~~~~~ - -The following options can be modified in the ``config`` file. -Please note that enabling debugging options may affect system performance. - -- ``CONFIG_RTE_LIBRTE_THUNDERX_NICVF_PMD`` (default ``y``) - - Toggle compilation of the ``librte_pmd_thunderx_nicvf`` driver. - -- ``CONFIG_RTE_LIBRTE_THUNDERX_NICVF_DEBUG_RX`` (default ``n``) - - Toggle asserts of receive fast path. - -- ``CONFIG_RTE_LIBRTE_THUNDERX_NICVF_DEBUG_TX`` (default ``n``) - - Toggle asserts of transmit fast path. Driver compilation and testing ------------------------------ diff --git a/doc/guides/nics/vdev_netvsc.rst b/doc/guides/nics/vdev_netvsc.rst index d1da071187..d9f6319b9f 100644 --- a/doc/guides/nics/vdev_netvsc.rst +++ b/doc/guides/nics/vdev_netvsc.rst @@ -61,12 +61,6 @@ This driver implementation may be temporary and should be improved or removed either when hot-plug will be fully supported in EAL and bus drivers or when a new NetVSC driver will be integrated. -Build options -------------- - -- ``CONFIG_RTE_LIBRTE_VDEV_NETVSC_PMD`` (default ``y``) - - Toggle compilation of this driver. Run-time parameters ------------------- -- 2.17.1
