summaryrefslogtreecommitdiff
path: root/doc/guides/nics
diff options
context:
space:
mode:
Diffstat (limited to 'doc/guides/nics')
-rw-r--r--doc/guides/nics/features/hns3.ini1
-rw-r--r--doc/guides/nics/features/hns3_vf.ini1
-rw-r--r--doc/guides/nics/features/ifcvf.ini8
-rw-r--r--doc/guides/nics/features/octeontx.ini2
-rw-r--r--doc/guides/nics/hns3.rst1
-rw-r--r--doc/guides/nics/i40e.rst9
-rw-r--r--doc/guides/nics/ice.rst2
-rw-r--r--doc/guides/nics/ifc.rst106
-rw-r--r--doc/guides/nics/index.rst1
-rw-r--r--doc/guides/nics/ixgbe.rst1
-rw-r--r--doc/guides/nics/mlx5.rst30
11 files changed, 42 insertions, 120 deletions
diff --git a/doc/guides/nics/features/hns3.ini b/doc/guides/nics/features/hns3.ini
index 6df789e..cd5c08a 100644
--- a/doc/guides/nics/features/hns3.ini
+++ b/doc/guides/nics/features/hns3.ini
@@ -5,6 +5,7 @@
;
[Features]
Link status = Y
+Rx interrupt = Y
MTU update = Y
Jumbo frame = Y
Promiscuous mode = Y
diff --git a/doc/guides/nics/features/hns3_vf.ini b/doc/guides/nics/features/hns3_vf.ini
index 41497c4..fd00ac3 100644
--- a/doc/guides/nics/features/hns3_vf.ini
+++ b/doc/guides/nics/features/hns3_vf.ini
@@ -5,6 +5,7 @@
;
[Features]
Link status = Y
+Rx interrupt = Y
MTU update = Y
Jumbo frame = Y
Unicast MAC filter = Y
diff --git a/doc/guides/nics/features/ifcvf.ini b/doc/guides/nics/features/ifcvf.ini
deleted file mode 100644
index ef1fc47..0000000
--- a/doc/guides/nics/features/ifcvf.ini
+++ /dev/null
@@ -1,8 +0,0 @@
-;
-; Supported features of the 'ifcvf' vDPA driver.
-;
-; Refer to default.ini for the full list of available PMD features.
-;
-[Features]
-x86-32 = Y
-x86-64 = Y
diff --git a/doc/guides/nics/features/octeontx.ini b/doc/guides/nics/features/octeontx.ini
index c92d5aa..323befe 100644
--- a/doc/guides/nics/features/octeontx.ini
+++ b/doc/guides/nics/features/octeontx.ini
@@ -10,7 +10,7 @@ Lock-free Tx queue = Y
Queue start/stop = P
Jumbo frame = Y
Promiscuous mode = Y
-Unicast MAC filter = P
+Unicast MAC filter = Y
CRC offload = Y
Packet type parsing = Y
Basic stats = Y
diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
index 505488b..8d19f48 100644
--- a/doc/guides/nics/hns3.rst
+++ b/doc/guides/nics/hns3.rst
@@ -22,6 +22,7 @@ Features of the HNS3 PMD are:
- Port hardware statistics
- Jumbo frames
- Link state information
+- Interrupt mode for RX
- VLAN stripping
- NUMA support
diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index 38acf59..0c2fa15 100644
--- a/doc/guides/nics/i40e.rst
+++ b/doc/guides/nics/i40e.rst
@@ -43,6 +43,7 @@ Features of the i40e PMD are:
- Dynamic Device Personalization (DDP)
- Queue region configuration
- Virtual Function Port Representors
+- Malicious Device Drive event catch and notify
Prerequisites
-------------
@@ -69,7 +70,9 @@ to chapter Tested Platforms/Tested NICs in release notes.
+--------------+-----------------------+------------------+
| DPDK version | Kernel driver version | Firmware version |
+==============+=======================+==================+
- | 19.08 | 2.9.21 | 7.00 |
+ | 19.11 | 2.9.21 | 7.00 |
+ +--------------+-----------------------+------------------+
+ | 19.08 | 2.8.43 | 7.00 |
+--------------+-----------------------+------------------+
| 19.05 | 2.7.29 | 6.80 |
+--------------+-----------------------+------------------+
@@ -457,7 +460,7 @@ which is used to configure hardware by downloading a profile to support
protocols/filters which are not supported by default. The DDP
functionality requires a NIC firmware version of 6.0 or greater.
-Current implementation supports GTP-C/GTP-U/PPPoE/PPPoL2TP,
+Current implementation supports GTP-C/GTP-U/PPPoE/PPPoL2TP/ESP,
steering can be used with rte_flow API.
GTPv1 package is released, and it can be downloaded from
@@ -466,6 +469,8 @@ https://downloadcenter.intel.com/download/27587.
PPPoE package is released, and it can be downloaded from
https://downloadcenter.intel.com/download/28040.
+ESP-AH package is not released yet.
+
Load a profile which supports GTP and store backup profile:
.. code-block:: console
diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst
index 9b90b38..cde3fd6 100644
--- a/doc/guides/nics/ice.rst
+++ b/doc/guides/nics/ice.rst
@@ -5,7 +5,7 @@ ICE Poll Mode Driver
======================
The ice PMD (librte_pmd_ice) provides poll mode driver support for
-10/25 Gbps IntelĀ® Ethernet 810 Series Network Adapters based on
+10/25/50/100 Gbps IntelĀ® Ethernet 810 Series Network Adapters based on
the Intel Ethernet Controller E810.
diff --git a/doc/guides/nics/ifc.rst b/doc/guides/nics/ifc.rst
deleted file mode 100644
index 12a2a34..0000000
--- a/doc/guides/nics/ifc.rst
+++ /dev/null
@@ -1,106 +0,0 @@
-.. SPDX-License-Identifier: BSD-3-Clause
- Copyright(c) 2018 Intel Corporation.
-
-IFCVF vDPA driver
-=================
-
-The IFCVF vDPA (vhost data path acceleration) driver provides support for the
-Intel FPGA 100G VF (IFCVF). IFCVF's datapath is virtio ring compatible, it
-works as a HW vhost backend which can send/receive packets to/from virtio
-directly by DMA. Besides, it supports dirty page logging and device state
-report/restore, this driver enables its vDPA functionality.
-
-
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following option can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_IFC_PMD`` (default ``y`` for linux)
-
- Toggle compilation of the ``librte_pmd_ifc`` driver.
-
-
-IFCVF vDPA Implementation
--------------------------
-
-IFCVF's vendor ID and device ID are same as that of virtio net pci device,
-with its specific subsystem vendor ID and device ID. To let the device be
-probed by IFCVF driver, adding "vdpa=1" parameter helps to specify that this
-device is to be used in vDPA mode, rather than polling mode, virtio pmd will
-skip when it detects this message. If no this parameter specified, device
-will not be used as a vDPA device, and it will be driven by virtio pmd.
-
-Different VF devices serve different virtio frontends which are in different
-VMs, so each VF needs to have its own DMA address translation service. During
-the driver probe a new container is created for this device, with this
-container vDPA driver can program DMA remapping table with the VM's memory
-region information.
-
-The device argument "sw-live-migration=1" will configure the driver into SW
-assisted live migration mode. In this mode, the driver will set up a SW relay
-thread when LM happens, this thread will help device to log dirty pages. Thus
-this mode does not require HW to implement a dirty page logging function block,
-but will consume some percentage of CPU resource depending on the network
-throughput. If no this parameter specified, driver will rely on device's logging
-capability.
-
-Key IFCVF vDPA driver ops
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-- ifcvf_dev_config:
- Enable VF data path with virtio information provided by vhost lib, including
- IOMMU programming to enable VF DMA to VM's memory, VFIO interrupt setup to
- route HW interrupt to virtio driver, create notify relay thread to translate
- virtio driver's kick to a MMIO write onto HW, HW queues configuration.
-
- This function gets called to set up HW data path backend when virtio driver
- in VM gets ready.
-
-- ifcvf_dev_close:
- Revoke all the setup in ifcvf_dev_config.
-
- This function gets called when virtio driver stops device in VM.
-
-To create a vhost port with IFC VF
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-- Create a vhost socket and assign a VF's device ID to this socket via
- vhost API. When QEMU vhost connection gets ready, the assigned VF will
- get configured automatically.
-
-
-Features
---------
-
-Features of the IFCVF driver are:
-
-- Compatibility with virtio 0.95 and 1.0.
-- SW assisted vDPA live migration.
-
-
-Prerequisites
--------------
-
-- Platform with IOMMU feature. IFC VF needs address translation service to
- Rx/Tx directly with virtio driver in VM.
-
-
-Limitations
------------
-
-Dependency on vfio-pci
-~~~~~~~~~~~~~~~~~~~~~~
-
-vDPA driver needs to setup VF MSIX interrupts, each queue's interrupt vector
-is mapped to a callfd associated with a virtio ring. Currently only vfio-pci
-allows multiple interrupts, so the IFCVF driver is dependent on vfio-pci.
-
-Live Migration with VIRTIO_NET_F_GUEST_ANNOUNCE
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-IFC VF doesn't support RARP packet generation, virtio frontend supporting
-VIRTIO_NET_F_GUEST_ANNOUNCE feature can help to do that.
diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst
index d61c27f..8c540c0 100644
--- a/doc/guides/nics/index.rst
+++ b/doc/guides/nics/index.rst
@@ -31,7 +31,6 @@ Network Interface Controller Drivers
hns3
i40e
ice
- ifc
igb
ipn3ke
ixgbe
diff --git a/doc/guides/nics/ixgbe.rst b/doc/guides/nics/ixgbe.rst
index 5c3a7e4..1f424b3 100644
--- a/doc/guides/nics/ixgbe.rst
+++ b/doc/guides/nics/ixgbe.rst
@@ -15,7 +15,6 @@ There is no change to PMD API. The RX/TX handler are the only two entries for vP
They are transparently registered at runtime RX/TX execution if all condition checks pass.
1. To date, only an SSE version of IX GBE vPMD is available.
- To ensure that vPMD is in the binary code, ensure that the option CONFIG_RTE_IXGBE_INC_VECTOR=y is 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/mlx5.rst b/doc/guides/nics/mlx5.rst
index 18573cf..b513cfc 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -64,6 +64,8 @@ Features
- Multiple TX and RX queues.
- Support for scattered TX and RX frames.
- IPv4, IPv6, TCPv4, TCPv6, UDPv4 and UDPv6 RSS on any number of queues.
+- RSS using different combinations of fields: L3 only, L4 only or both,
+ and source only, destination only or both.
- Several RSS hash keys, one for each flow type.
- Default RSS operation with no hash key specification.
- Configurable RETA table.
@@ -1314,3 +1316,31 @@ ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_pmd_mlx5.
Port 3 Link Up - speed 10000 Mbps - full-duplex
Done
testpmd>
+
+How to dump flows
+-----------------
+
+This section demonstrates how to dump flows. Currently, it's possible to dump
+all flows with assistance of external tools.
+
+#. 2 ways to get flow raw file:
+
+ - Using testpmd CLI:
+
+ .. code-block:: console
+
+ testpmd> flow dump <port> <output_file>
+
+ - call rte_flow_dev_dump api:
+
+ .. code-block:: console
+
+ rte_flow_dev_dump(port, file, NULL);
+
+#. Dump human-readable flows from raw file:
+
+ Get flow parsing tool from: https://github.com/Mellanox/mlx_steering_dump
+
+ .. code-block:: console
+
+ mlx_steering_dump.py -f <output_file>