From: Jingjing Wu <jingjing.wu@intel.com> To: dev@dpdk.org Cc: jingjing.wu@intel.com, beilei.xing@intel.com, chenbo.xia@intel.com, xiuchun.lu@intel.com Subject: [dpdk-dev] [PATCH v2 6/6] doc: new net PMD iavf_be Date: Thu, 7 Jan 2021 15:15:03 +0800 Message-ID: <20210107071503.14720-7-jingjing.wu@intel.com> (raw) In-Reply-To: <20210107071503.14720-1-jingjing.wu@intel.com> 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 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 <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> 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
prev parent reply other threads:[~2021-01-07 7:29 UTC|newest] Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top 2020-12-19 7:54 [dpdk-dev] [PATCH v1 0/5] introduce iavf backend driver Jingjing Wu 2020-12-19 7:54 ` [dpdk-dev] [PATCH v1 1/5] net/iavf_be: " Jingjing Wu 2020-12-19 7:54 ` [dpdk-dev] [PATCH v1 2/5] net/iavf_be: control queue enabling Jingjing Wu 2020-12-19 7:54 ` [dpdk-dev] [PATCH v1 3/5] net/iavf_be: virtchnl messages process Jingjing Wu 2020-12-19 7:54 ` [dpdk-dev] [PATCH v1 4/5] net/iavf_be: add Rx Tx burst support Jingjing Wu 2020-12-19 7:54 ` [dpdk-dev] [PATCH v1 5/5] doc: new net PMD iavf_be Jingjing Wu 2021-01-07 7:14 ` [dpdk-dev] [PATCH v2 0/6] introduce iavf backend driver Jingjing Wu 2021-01-07 7:14 ` [dpdk-dev] [PATCH v2 1/6] net/iavf_be: " Jingjing Wu 2021-01-07 7:14 ` [dpdk-dev] [PATCH v2 2/6] net/iavf_be: control queue enabling Jingjing Wu 2021-01-07 7:15 ` [dpdk-dev] [PATCH v2 3/6] net/iavf_be: virtchnl messages process Jingjing Wu 2021-01-07 7:15 ` [dpdk-dev] [PATCH v2 4/6] net/iavf_be: add Rx Tx burst support Jingjing Wu 2021-01-07 7:15 ` [dpdk-dev] [PATCH v2 5/6] net/iavf_be: extend backend to support iavf rxq_irq Jingjing Wu 2021-01-07 7:15 ` Jingjing Wu [this message]
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20210107071503.14720-7-jingjing.wu@intel.com \ --to=jingjing.wu@intel.com \ --cc=beilei.xing@intel.com \ --cc=chenbo.xia@intel.com \ --cc=dev@dpdk.org \ --cc=xiuchun.lu@intel.com \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
DPDK patches and discussions This inbox may be cloned and mirrored by anyone: git clone --mirror https://inbox.dpdk.org/dev/0 dev/git/0.git # If you have public-inbox 1.1+ installed, you may # initialize and index your mirror using the following commands: public-inbox-init -V2 dev dev/ https://inbox.dpdk.org/dev \ dev@dpdk.org public-inbox-index dev Example config snippet for mirrors. Newsgroup available over NNTP: nntp://inbox.dpdk.org/inbox.dpdk.dev AGPL code for this site: git clone https://public-inbox.org/public-inbox.git