[dpdk-dev] doc: virtio lsc hint

Message ID 20171009035616.24482-1-zhiyong.yang@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Yuanhan Liu
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Yang, Zhiyong Oct. 9, 2017, 3:56 a.m. UTC
  Virtio PMD has already the ability to support link status change(lsc),
but qemu 2.7.0 introduce the capability to detect vhost user
disconnection. So, virtio PMD which works with qemu 2.7.0 and above
can receive lsc when vhost user disconnects. The patch updates doc to
let user know that.

Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>
---
 doc/guides/nics/virtio.rst | 4 ++++
 1 file changed, 4 insertions(+)
  

Comments

Yuanhan Liu Oct. 10, 2017, 2:38 a.m. UTC | #1
On Mon, Oct 09, 2017 at 11:56:16AM +0800, Zhiyong Yang wrote:
> Virtio PMD has already the ability to support link status change(lsc),
> but qemu 2.7.0 introduce the capability to detect vhost user
> disconnection. So, virtio PMD which works with qemu 2.7.0 and above
> can receive lsc when vhost user disconnects. The patch updates doc to
> let user know that.

Thanks for updating the doc.

> 
> Signed-off-by: Zhiyong Yang <zhiyong.yang@intel.com>
> ---
>  doc/guides/nics/virtio.rst | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
> index 4d6a83768..c6f4e0ed2 100644
> --- a/doc/guides/nics/virtio.rst
> +++ b/doc/guides/nics/virtio.rst
> @@ -291,6 +291,10 @@ interrupt, Rx interrupts, and Tx interrupts. Config interrupt is used for
>  notification of device configuration changes, especially link status (lsc).
>  Interrupt mode is translated into Rx interrupts in the context of DPDK.
>  
> +Note: Virtio PMD which works with qemu 2.7.0 and above can support to receive lsc from qemu
> +when vhost user disconnection happens since qemu 2.7.0 introduces the new capability to detect
> +vhost user disconnection.

I think it needs rewording. Also, use ".. Note::" mark for notes.

	--yliu
> +
>  Prerequisites for Rx interrupts
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>  
> -- 
> 2.13.3
  

Patch

diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
index 4d6a83768..c6f4e0ed2 100644
--- a/doc/guides/nics/virtio.rst
+++ b/doc/guides/nics/virtio.rst
@@ -291,6 +291,10 @@  interrupt, Rx interrupts, and Tx interrupts. Config interrupt is used for
 notification of device configuration changes, especially link status (lsc).
 Interrupt mode is translated into Rx interrupts in the context of DPDK.
 
+Note: Virtio PMD which works with qemu 2.7.0 and above can support to receive lsc from qemu
+when vhost user disconnection happens since qemu 2.7.0 introduces the new capability to detect
+vhost user disconnection.
+
 Prerequisites for Rx interrupts
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~