[dpdk-dev] [PATCH v4 15/15] doc: update doc for avf driver

[Zhang, Helin]

Is there any public spec? If yes, I'd suggest to add the link to a doc for reference.

/Helin

> -----Original Message-----
> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Wenzhuo Lu
> Sent: Friday, January 5, 2018 4:22 PM
> To: dev at dpdk.org
> Cc: Wu, Jingjing
> Subject: [dpdk-dev] [PATCH v4 15/15] doc: update doc for avf driver
> 
> From: Jingjing Wu <jingjing.wu at intel.com>
> 
> Signed-off-by: Jingjing Wu <jingjing.wu at intel.com>
> ---
>  doc/guides/nics/intel_vf.rst           | 16 ++++++++++++++--
>  doc/guides/rel_notes/release_18_02.rst | 16 ++++++++++++++++
>  2 files changed, 30 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/nics/intel_vf.rst b/doc/guides/nics/intel_vf.rst index
> 1e83bf6..3adb684 100644
> --- a/doc/guides/nics/intel_vf.rst
> +++ b/doc/guides/nics/intel_vf.rst
> @@ -28,8 +28,8 @@
>      (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
> THE USE
>      OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
> DAMAGE.
> 
> -I40E/IXGBE/IGB Virtual Function Driver
> -======================================
> +Intel Virtual Function Driver
> +=============================
> 
>  Supported Intel® Ethernet Controllers (see the *DPDK Release Notes* for
> details)  support the following modes of operation in a virtualized
> environment:
> @@ -93,6 +93,18 @@ and the Physical Function operates on the global
> resources on behalf of the Virt  For this out-of-band communication, an SR-
> IOV enabled NIC provides a memory buffer for each Virtual Function,  which
> is called a "Mailbox".
> 
> +Intel® Ethernet Adaptive Virtual Function
> +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> +Adaptive Virtual Function (AVF) is a SR-IOV Virtual Function with the same
> device id (8086:1889) on different Intel Ethernet Controller.
> +AVF Driver is VF driver which supports for all future Intel devices
> +without requiring a VM update. And since this happens to be an adaptive
> +VF driver, every new drop of the VF driver would add more and more
> +advanced features that can be turned on in the VM if the underlying HW
> device supports those advanced features based on a device agnostic way
> without ever compromising on the base functionality. AVF provides generic
> hardware interface and interface between AVF driver and a compliant PF
> driver is specified.
> +
> +Intel products starting Ethernet Controller 710 Series to support Adaptive
> Virtual Function.
> +
> +The way to generate Virtual Function is like normal, and the resource of VF
> assignment depends on the NIC Infrastructure.
> +
>  The PCIE host-interface of Intel Ethernet Switch FM10000 Series VF
> infrastructure
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> ^^^^^^^^^^^^^^^^^
> 
> diff --git a/doc/guides/rel_notes/release_18_02.rst
> b/doc/guides/rel_notes/release_18_02.rst
> index 24b67bb..0672b0e 100644
> --- a/doc/guides/rel_notes/release_18_02.rst
> +++ b/doc/guides/rel_notes/release_18_02.rst
> @@ -41,6 +41,22 @@ New Features
>       Also, make sure to start the actual text at the margin.
>       =========================================================
> 
> +   * **Add AVF (Adaptive Virtual Function) net PMD.**
> +
> +     A new net PMD has been added, which supports Intel® Ethernet
> Adaptive
> +     Virtual Function (AVF) with features list below:
> +
> +     * Basic Rx/Tx burst
> +     * SSE vectorized Rx/Tx burst
> +     * Promiscuous mode
> +     * MAC/VLAN offload
> +     * Checksum offload
> +     * TSO offload
> +     * Jumbo frame and MTU setting
> +     * RSS configuration
> +     * stats
> +     * Rx/Tx descriptor status
> +     * Link status update/event
> 
>  API Changes
>  -----------
> --
> 1.9.3