net/ena: switch memcpy to optimized version

[dpdk.git] / doc / guides / nics / octeontx.rst

diff --git a/doc/guides/nics/octeontx.rst b/doc/guides/nics/octeontx.rst
index 012a3ec..b1a868b 100644 (file)
--- a/doc/guides/nics/octeontx.rst
+++ b/doc/guides/nics/octeontx.rst
@@ -4,7 +4,7 @@
 OCTEON TX Poll Mode driver
 ==========================
 
 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.
 
 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.
 


@@ -20,7 +20,10 @@ Features of the OCTEON TX Ethdev PMD are:
 - Promiscuous mode
 - Port hardware statistics
 - Jumbo frames
 - Promiscuous mode
 - Port hardware statistics
 - Jumbo frames

+- Scatter-Gather IO support

 - Link state information
 - Link state information

+- MAC/VLAN filtering
+- MTU update

 - SR-IOV VF
 - Multiple queues for TX
 - Lock-free Tx queue
 - SR-IOV VF
 - Multiple queues for TX
 - Lock-free Tx queue


@@ -49,15 +52,6 @@ See :doc:`../platform/octeontx` for setup information.
 Pre-Installation Configuration
 ------------------------------
 
 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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Driver compilation and testing
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


@@ -65,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.
 
 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
 #. Running testpmd:
 
    Follow instructions available in the document


@@ -83,7 +69,7 @@ following ``make`` command:
 
    .. code-block:: console
 
 
    .. code-block:: console
 

-      ./arm64-thunderx-linux-gcc/app/testpmd -c 700 \
+      ./<build_dir>/app/dpdk-testpmd -c 700 \

                 --base-virtaddr=0x100000000000 \
                 --mbuf-pool-ops-name="octeontx_fpavf" \
                 --vdev='event_octeontx' \
                 --base-virtaddr=0x100000000000 \
                 --mbuf-pool-ops-name="octeontx_fpavf" \
                 --vdev='event_octeontx' \


@@ -161,8 +147,8 @@ This driver will only work with ``octeontx_fpavf`` external mempool handler
 as it is the most performance effective way for packet allocation and Tx buffer
 recycling on OCTEON TX SoC platform.
 
 as it is the most performance effective way for packet allocation and Tx buffer
 recycling on OCTEON TX SoC platform.
 

-CRC striping
-~~~~~~~~~~~~
+CRC stripping
+~~~~~~~~~~~~~

 
 The OCTEON TX SoC family NICs strip the CRC for every packets coming into the
 host interface irrespective of the offload configuration.
 
 The OCTEON TX SoC family NICs strip the CRC for every packets coming into the
 host interface irrespective of the offload configuration.


@@ -174,3 +160,10 @@ The OCTEON TX SoC family NICs support a maximum of a 32K jumbo frame. The value
 is fixed and cannot be changed. So, even when the ``rxmode.max_rx_pkt_len``
 member of ``struct rte_eth_conf`` is set to a value lower than 32k, frames
 up to 32k bytes can still reach the host interface.
 is fixed and cannot be changed. So, even when the ``rxmode.max_rx_pkt_len``
 member of ``struct rte_eth_conf`` is set to a value lower than 32k, frames
 up to 32k bytes can still reach the host interface.

+
+Maximum mempool size
+~~~~~~~~~~~~~~~~~~~~
+
+The maximum mempool size supplied to Rx queue setup should be less than 128K.
+When running testpmd on OCTEON TX the application can limit the number of mbufs
+by using the option ``--total-num-mbufs=131072``.