From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (xvm-189-124.dc0.ghst.net [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 9FF2EA09FF; Thu, 7 Jan 2021 08:29:41 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id BDBE0140EDD; Thu, 7 Jan 2021 08:29:02 +0100 (CET) Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by mails.dpdk.org (Postfix) with ESMTP id DCBB7140EDA for ; Thu, 7 Jan 2021 08:29:00 +0100 (CET) IronPort-SDR: Ipg/jWiTLbIWSAnvImuxSC1qcg0ic82x0NnNx8zC91Ki4eLI4Lphtga39XG4hezueIlUos8Ulh i0OLLfAoZd8w== X-IronPort-AV: E=McAfee;i="6000,8403,9856"; a="173880069" X-IronPort-AV: E=Sophos;i="5.79,329,1602572400"; d="scan'208";a="173880069" Received: from orsmga008.jf.intel.com ([10.7.209.65]) by fmsmga102.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 06 Jan 2021 23:29:00 -0800 IronPort-SDR: 8g2yL8/lc675qFBZXyp1TgOVSXl2GzDANFAuDbfQ1K5Eb4OAOwOJjKzyFP3oUWPQx0v+GP20RH x3tMKa+85d4g== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.79,329,1602572400"; d="scan'208";a="379617095" Received: from dpdk-wujingji.sh.intel.com ([10.67.119.101]) by orsmga008.jf.intel.com with ESMTP; 06 Jan 2021 23:28:58 -0800 From: Jingjing Wu To: dev@dpdk.org Cc: jingjing.wu@intel.com, beilei.xing@intel.com, chenbo.xia@intel.com, xiuchun.lu@intel.com Date: Thu, 7 Jan 2021 15:15:03 +0800 Message-Id: <20210107071503.14720-7-jingjing.wu@intel.com> X-Mailer: git-send-email 2.21.1 In-Reply-To: <20210107071503.14720-1-jingjing.wu@intel.com> References: <20201219075454.40266-1-jingjing.wu@intel.com> <20210107071503.14720-1-jingjing.wu@intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v2 6/6] doc: new net PMD iavf_be X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Signed-off-by: Jingjing Wu --- 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 diff --git a/MAINTAINERS b/MAINTAINERS index bca206ba8f..5faf093571 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -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 +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 M: Qi Zhang diff --git a/doc/guides/nics/features/iavf_be.ini b/doc/guides/nics/features/iavf_be.ini new file mode 100644 index 0000000000..8528695d00 --- /dev/null +++ b/doc/guides/nics/features/iavf_be.ini @@ -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 diff --git a/doc/guides/nics/iavf_be.rst b/doc/guides/nics/iavf_be.rst new file mode 100644 index 0000000000..14e26853e9 --- /dev/null +++ b/doc/guides/nics/iavf_be.rst @@ -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. diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index 3443617755..bd764ccbb3 100644 --- a/doc/guides/nics/index.rst +++ b/doc/guides/nics/index.rst @@ -30,6 +30,7 @@ Network Interface Controller Drivers hinic hns3 i40e + iavf_be ice igb igc diff --git a/doc/guides/rel_notes/release_21_02.rst b/doc/guides/rel_notes/release_21_02.rst index b310b67b7d..bd14d55fc6 100644 --- a/doc/guides/rel_notes/release_21_02.rst +++ b/doc/guides/rel_notes/release_21_02.rst @@ -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 ------------- -- 2.21.1