git.droids-corp.org
/
dpdk.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
doc: update push/pop VLAN support in mlx5 guide
[dpdk.git]
/
doc
/
guides
/
nics
/
octeontx.rst
diff --git
a/doc/guides/nics/octeontx.rst
b/doc/guides/nics/octeontx.rst
index
212fe34
..
b1a868b
100644
(file)
--- a/
doc/guides/nics/octeontx.rst
+++ b/
doc/guides/nics/octeontx.rst
@@
-1,11
+1,11
@@
.. SPDX-License-Identifier: BSD-3-Clause
Copyright(c) 2017 Cavium, Inc
.. SPDX-License-Identifier: BSD-3-Clause
Copyright(c) 2017 Cavium, Inc
-OCTEONTX Poll Mode driver
-=========================
+OCTEON
TX Poll Mode driver
+=========================
=
-The OCTEON
TX ETHDEV PMD (**librte_pmd
_octeontx**) provides poll mode ethdev
-driver support for the inbuilt network device found in the **Cavium OCTEONTX**
+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.
More information can be found at `Cavium, Inc Official Website
SoC family as well as their virtual functions (VF) in SR-IOV context.
More information can be found at `Cavium, Inc Official Website
@@
-14,20
+14,23
@@
More information can be found at `Cavium, Inc Official Website
Features
--------
Features
--------
-Features of the OCTEONTX Ethdev PMD are:
+Features of the OCTEON
TX Ethdev PMD are:
- Packet type information
- Promiscuous mode
- Port hardware statistics
- Jumbo frames
- Packet type information
- 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
- HW offloaded `ethdev Rx queue` to `eventdev event queue` packet injection
- SR-IOV VF
- Multiple queues for TX
- Lock-free Tx queue
- HW offloaded `ethdev Rx queue` to `eventdev event queue` packet injection
-Supported OCTEONTX SoCs
------------------------
+Supported OCTEON
TX SoCs
+-----------------------
-
- CN83xx
- CN83xx
@@
-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 OCTEONTX PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
- cd <DPDK-source-directory>
- make config T=arm64-thunderx-linuxapp-gcc install
-
#. Running testpmd:
Follow instructions available in the document
#. Running testpmd:
Follow instructions available in the document
@@
-83,13
+69,13
@@
following ``make`` command:
.. code-block:: console
.. code-block:: console
- ./
arm64-thunderx-linuxapp-gcc/app/
testpmd -c 700 \
+ ./
<build_dir>/app/dpdk-
testpmd -c 700 \
--base-virtaddr=0x100000000000 \
--mbuf-pool-ops-name="octeontx_fpavf" \
--vdev='event_octeontx' \
--vdev='eth_octeontx,nr_port=2' \
--base-virtaddr=0x100000000000 \
--mbuf-pool-ops-name="octeontx_fpavf" \
--vdev='event_octeontx' \
--vdev='eth_octeontx,nr_port=2' \
- -- --rxq=1 --txq=1 --nb-core=2
--total-num-mbufs=16384
\
- --
disable-hw-vlan-filter
-i
+ -- --rxq=1 --txq=1 --nb-core=2 \
+ --
total-num-mbufs=16384
-i
.....
EAL: Detected 24 lcore(s)
EAL: Probing VFIO support...
.....
EAL: Detected 24 lcore(s)
EAL: Probing VFIO support...
@@
-122,7
+108,7
@@
following ``make`` command:
Initialization
--------------
Initialization
--------------
-The
octeontx
ethdev pmd is exposed as a vdev device which consists of a set
+The
OCTEON TX
ethdev pmd is exposed as a vdev device which consists of a set
of PKI and PKO PCIe VF devices. On EAL initialization,
PKI/PKO PCIe VF devices will be probed and then the vdev device can be created
from the application code, or from the EAL command line based on
of PKI and PKO PCIe VF devices. On EAL initialization,
PKI/PKO PCIe VF devices will be probed and then the vdev device can be created
from the application code, or from the EAL command line based on
@@
-156,22
+142,28
@@
Limitations
``octeontx_fpavf`` external mempool handler dependency
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``octeontx_fpavf`` external mempool handler dependency
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The OCTEONTX SoC family NIC has inbuilt HW assisted external mempool manager.
+The OCTEON
TX SoC family NIC has inbuilt HW assisted external mempool manager.
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
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 OCTEONTX SoC platform.
+recycling on OCTEON
TX SoC platform.
-CRC striping
-~~~~~~~~~~~~
+CRC strip
p
ing
+~~~~~~~~~~~~
~
-The OCTEONTX SoC family NICs strip the CRC for every packets coming into the
-host interface. So, CRC will be stripped even when the
-``rxmode.hw_strip_crc`` member is set to 0 in ``struct rte_eth_conf``.
+The OCTEON TX SoC family NICs strip the CRC for every packets coming into the
+host interface irrespective of the offload configuration.
Maximum packet length
~~~~~~~~~~~~~~~~~~~~~
Maximum packet length
~~~~~~~~~~~~~~~~~~~~~
-The OCTEONTX SoC family NICs support a maximum of a 32K jumbo frame. The value
+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``.