[PATCH v2] doc: Update prog guide for virtio

[PATCH v2] doc: Update prog guide for virtio

[Ouyang Changchun]

This patch add contents for major change in single virtio implementation,
also add back something for merge-able feature and promiscuous mode in virtio.

Signed-off-by: Changchun Ouyang <changchun.ouyang-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
---

Changes in v2
  -- A few words adjusted.

 .../prog_guide/poll_mode_drv_emulated_virtio_nic.rst    | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

diff --git a/doc/guides/prog_guide/poll_mode_drv_emulated_virtio_nic.rst b/doc/guides/prog_guide/poll_mode_drv_emulated_virtio_nic.rst
index b0a6250..aae32b6 100644
--- a/doc/guides/prog_guide/poll_mode_drv_emulated_virtio_nic.rst
+++ b/doc/guides/prog_guide/poll_mode_drv_emulated_virtio_nic.rst
@@ -68,20 +68,29 @@ Features and Limitations of virtio PMD
 
 In this release, the virtio PMD driver provides the basic functionality of packet reception and transmission.
 
-*   This release does not support mergeable buffers per packet for performance reasons.
-    The packet size supported is from 64 to 1518.
-    rte_mbuf should be big enough to hold the whole packet.
+*   It supports merge-able buffers per packet when receiving packets and scattered buffer per packet
+    when transmitting packets. The packet size supported is from 64 to 1518.
+
+*   It supports multicast packets and promiscuous mode.
 
 *   The descriptor number for the RX/TX queue is hard-coded to be 256 by qemu.
     If given a different descriptor number by the upper application,
     the virtio PMD generates a warning and fall back to the hard-coded value.
 
-*   Features such as mac/vlan filter are not supported.
+*   Features of mac/vlan filter are supported, negotiation with vhost/backend are needed to support them.
+    When backend can't support vlan filter, virtio app on guest should disable vlan filter to make sure
+    the virtio port is configured correctly. E.g. specify '--disable-hw-vlan' in testpmd command line.
 
 *   RTE_PKTMBUF_HEADROOM should be defined larger than sizeof(struct virtio_net_hdr), which is 10 bytes.
 
 *   Virtio does not support runtime configuration.
 
+*   Virtio supports Link State interrupt.
+
+*   Virtio supports software vlan stripping and inserting.
+
+*   Virtio supports using port IO to get PCI resource when uio/igb_uio module is not available.
+
 Prerequisites
 -------------
 
-- 
1.8.4.2

Re: [PATCH v2] doc: Update prog guide for virtio

[Butler, Siobhan A]

> -----Original Message-----
> From: dev [mailto:dev-bounces-VfR2kkLFssw@public.gmane.org] On Behalf Of Ouyang Changchun
> Sent: Monday, March 2, 2015 8:41 AM
> To: dev-VfR2kkLFssw@public.gmane.org
> Subject: [dpdk-dev] [PATCH v2] doc: Update prog guide for virtio
> 
> This patch add contents for major change in single virtio implementation, also
> add back something for merge-able feature and promiscuous mode in virtio.
> 
> Signed-off-by: Changchun Ouyang <changchun.ouyang-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
> ---
> 
> Changes in v2
>   -- A few words adjusted.
> 
>  .../prog_guide/poll_mode_drv_emulated_virtio_nic.rst    | 17
> +++++++++++++----
>  1 file changed, 13 insertions(+), 4 deletions(-)
> 
> diff --git a/doc/guides/prog_guide/poll_mode_drv_emulated_virtio_nic.rst
> b/doc/guides/prog_guide/poll_mode_drv_emulated_virtio_nic.rst
> index b0a6250..aae32b6 100644
> --- a/doc/guides/prog_guide/poll_mode_drv_emulated_virtio_nic.rst
> +++ b/doc/guides/prog_guide/poll_mode_drv_emulated_virtio_nic.rst
> @@ -68,20 +68,29 @@ Features and Limitations of virtio PMD
> 
>  In this release, the virtio PMD driver provides the basic functionality of
> packet reception and transmission.
> 
> -*   This release does not support mergeable buffers per packet for
> performance reasons.
> -    The packet size supported is from 64 to 1518.
> -    rte_mbuf should be big enough to hold the whole packet.
> +*   It supports merge-able buffers per packet when receiving packets and
> scattered buffer per packet
> +    when transmitting packets. The packet size supported is from 64 to 1518.
> +
> +*   It supports multicast packets and promiscuous mode.
> 
>  *   The descriptor number for the RX/TX queue is hard-coded to be 256 by
> qemu.
>      If given a different descriptor number by the upper application,
>      the virtio PMD generates a warning and fall back to the hard-coded value.
> 
> -*   Features such as mac/vlan filter are not supported.
> +*   Features of mac/vlan filter are supported, negotiation with
> vhost/backend are needed to support them.
> +    When backend can't support vlan filter, virtio app on guest should disable
> vlan filter to make sure
> +    the virtio port is configured correctly. E.g. specify '--disable-hw-vlan' in
> testpmd command line.
> 
>  *   RTE_PKTMBUF_HEADROOM should be defined larger than sizeof(struct
> virtio_net_hdr), which is 10 bytes.
> 
>  *   Virtio does not support runtime configuration.
> 
> +*   Virtio supports Link State interrupt.
> +
> +*   Virtio supports software vlan stripping and inserting.
> +
> +*   Virtio supports using port IO to get PCI resource when uio/igb_uio
> module is not available.
> +
>  Prerequisites
>  -------------
> 
> --
> 1.8.4.2


Acked-by: Siobhan Butler <siobhan.a.butler-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>

Re: [PATCH v2] doc: Update prog guide for virtio

[Thomas Monjalon]

> > This patch add contents for major change in single virtio implementation, also
> > add back something for merge-able feature and promiscuous mode in virtio.
> > 
> > Signed-off-by: Changchun Ouyang <changchun.ouyang-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
> 
> Acked-by: Siobhan Butler <siobhan.a.butler-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>

Applied, thanks