[v1,5/5] doc: new net PMD iavf_be
Checks
Commit Message
Signed-off-by: Jingjing Wu <jingjing.wu@intel.com>
---
MAINTAINERS | 6 +++
doc/guides/nics/features/iavf_be.ini | 11 ++++++
doc/guides/nics/iavf_be.rst | 53 ++++++++++++++++++++++++++
doc/guides/nics/index.rst | 1 +
doc/guides/rel_notes/release_21_02.rst | 6 +++
5 files changed, 77 insertions(+)
create mode 100644 doc/guides/nics/features/iavf_be.ini
create mode 100644 doc/guides/nics/iavf_be.rst
@@ -707,6 +707,12 @@ F: drivers/net/iavf/
F: drivers/common/iavf/
F: doc/guides/nics/features/iavf*.ini
+Intel iavf_be
+M: Jingjing Wu <jingjing.wu@intel.com>
+T: git://dpdk.org/next/dpdk-next-net-intel
+F: drivers/net/iavf_be/
+F: doc/guides/nics/features/iavf_be*.ini
+
Intel ice
M: Qiming Yang <qiming.yang@intel.com>
M: Qi Zhang <qi.z.zhang@intel.com>
new file mode 100644
@@ -0,0 +1,11 @@
+;
+; Supported features of the 'iavf_be' network poll mode driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+Promiscuous mode = Y
+Allmulticast mode = Y
+Basic stats = Y
+Scattered Rx = Y
+x86-64 = Y
new file mode 100644
@@ -0,0 +1,53 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2020 Intel Corporation.
+
+Poll Mode Driver for Emulated Backend of Intel® AVF
+===================================================
+
+Intel® AVF is an Ethernet SR-IOV Virtual Function with the same
+device id (8086:1889) on different Intel Ethernet Controller.
+
+Emulated Backend of Intel® AVF is software emulated device to provide
+IAVF compatible layout and acceleartion to the consumer who is using IAVF.
+The communication is using vfio-user protocol as transport mechanism.
+While, the Backend PMD driver is based on *librte_vfio_user* and *librte_emudev* libraries.
+
+PMD arguments
+-------------
+
+Below devargs are provided to setup iavf_be device in DPDK:
+
+#. ``emu``:
+
+ The emudev name it depends on.
+ (required)
+
+#. ``mac``:
+
+ It is the MAC address assigned to it, and Front End device would consider it as its default MAC. If no set, driver would take a random one.
+ (optional)
+
+Set up an iavf_be interface
+---------------------------
+
+The following example will set up an iavf_be interface in DPDK:
+
+.. code-block:: console
+
+ --vdev emu_iavf0,sock=/tmp/to/socket/emu_iavf0,queues=4 --vdev net_iavfbe0,emu=emu_iavf0,mac=00:11:22:33:44:55
+
+Features and Limitations of iavf_be PMD
+---------------------------------------
+Currently, the iavf_be PMD provides the basic functionality of packet reception, transmission and event handling.
+
+* It has multiple queues support.
+
+* It supports Base mode virtchnl messages processing.
+
+* Don't need to stop RX/TX manually, stop guest or iavf driver on guest instead.
+
+* It is running in Polling mode, no RX interrupt support.
+
+* No MAC VLAN filtering support.
+
+* No classification offload support.
@@ -30,6 +30,7 @@ Network Interface Controller Drivers
hinic
hns3
i40e
+ iavf_be
ice
igb
igc
@@ -83,6 +83,12 @@ New Features
See :doc:`../prog_guide/emudev` for more information.
+* **Added iavf_be net driver.**
+
+ Added a Polling Mode Driver iavf_be as software backend for Intel® AVF Ethernet device.
+
+ See :doc:`../nics/iavf_be.rst` for more information.
+
Removed Items
-------------