[v4,10/10] doc: update ifc NIC document

  Add the SW assisted VDPA live migration feature into NIC doc.

Signed-off-by: Xiao Wang <xiao.w.wang@intel.com>
---
 doc/guides/nics/ifc.rst                | 8 ++++++++
 doc/guides/rel_notes/release_19_02.rst | 6 ++++++
 2 files changed, 14 insertions(+)
  

On 12/14/18 10:16 PM, Xiao Wang wrote:
> Add the SW assisted VDPA live migration feature into NIC doc.
> 
> Signed-off-by: Xiao Wang <xiao.w.wang@intel.com>
> ---
>   doc/guides/nics/ifc.rst                | 8 ++++++++
>   doc/guides/rel_notes/release_19_02.rst | 6 ++++++
>   2 files changed, 14 insertions(+)
> 
> diff --git a/doc/guides/nics/ifc.rst b/doc/guides/nics/ifc.rst
> index 48f9adf1d..eb55d329a 100644
> --- a/doc/guides/nics/ifc.rst
> +++ b/doc/guides/nics/ifc.rst
> @@ -39,6 +39,13 @@ the driver probe a new container is created for this device, with this
>   container vDPA driver can program DMA remapping table with the VM's memory
>   region information.
>   
> +The device argument "swlm=1" will configure the driver into SW assisted live
> +migration mode. In this mode, the driver will set up a SW relay thread when LM
> +happens, this thread will help device to log dirty pages. Thus this mode does
> +not require HW to implement a dirty page logging function block, but will
> +consume some percentage of CPU resource depending on the network throughput.
> +If no "swlm=1" specified, driver will rely on device's logging capability.
> +

Ok, so that's documented here.
What about documenting vdpa option too?

>   Key IFCVF vDPA driver ops
>   ~~~~~~~~~~~~~~~~~~~~~~~~~
>   
> @@ -70,6 +77,7 @@ Features
>   Features of the IFCVF driver are:
>   
>   - Compatibility with virtio 0.95 and 1.0.
> +- SW assisted vDPA live migration.
>   
>   
>   Prerequisites
> diff --git a/doc/guides/rel_notes/release_19_02.rst b/doc/guides/rel_notes/release_19_02.rst
> index e86ef9511..ced6af8f0 100644
> --- a/doc/guides/rel_notes/release_19_02.rst
> +++ b/doc/guides/rel_notes/release_19_02.rst
> @@ -60,6 +60,12 @@ New Features
>     * Added the handler to get firmware version string.
>     * Added support for multicast filtering.
>   
> +* **Added support for SW-assisted VDPA live migration.**
> +
> +  This SW-assisted VDPA live migration facility helps VDPA devices without
> +  logging capability to perform live migration, a mediate SW relay can help
> +  devices to track dirty pages caused by DMA. IFC driver has enabled this
> +  SW-assisted live migration mode.
>   
>   Removed Items
>   -------------
>
  

Hi Maxime,

> -----Original Message-----
> From: Maxime Coquelin [mailto:maxime.coquelin@redhat.com]
> Sent: Sunday, December 16, 2018 1:36 AM
> To: Wang, Xiao W <xiao.w.wang@intel.com>; Bie, Tiwei <tiwei.bie@intel.com>
> Cc: alejandro.lucero@netronome.com; dev@dpdk.org; Wang, Zhihong
> <zhihong.wang@intel.com>; Ye, Xiaolong <xiaolong.ye@intel.com>
> Subject: Re: [PATCH v4 10/10] doc: update ifc NIC document
> 
> 
> 
> On 12/14/18 10:16 PM, Xiao Wang wrote:
> > Add the SW assisted VDPA live migration feature into NIC doc.
> >
> > Signed-off-by: Xiao Wang <xiao.w.wang@intel.com>
> > ---
> >   doc/guides/nics/ifc.rst                | 8 ++++++++
> >   doc/guides/rel_notes/release_19_02.rst | 6 ++++++
> >   2 files changed, 14 insertions(+)
> >
> > diff --git a/doc/guides/nics/ifc.rst b/doc/guides/nics/ifc.rst
> > index 48f9adf1d..eb55d329a 100644
> > --- a/doc/guides/nics/ifc.rst
> > +++ b/doc/guides/nics/ifc.rst
> > @@ -39,6 +39,13 @@ the driver probe a new container is created for this
> device, with this
> >   container vDPA driver can program DMA remapping table with the VM's
> memory
> >   region information.
> >
> > +The device argument "swlm=1" will configure the driver into SW assisted
> live
> > +migration mode. In this mode, the driver will set up a SW relay thread when
> LM
> > +happens, this thread will help device to log dirty pages. Thus this mode
> does
> > +not require HW to implement a dirty page logging function block, but will
> > +consume some percentage of CPU resource depending on the network
> throughput.
> > +If no "swlm=1" specified, driver will rely on device's logging capability.
> > +
> 
> Ok, so that's documented here.
> What about documenting vdpa option too?

Yes, will explain all the devargs in this doc.

Thanks,
Xiao

> 
> >   Key IFCVF vDPA driver ops
> >   ~~~~~~~~~~~~~~~~~~~~~~~~~
> >
> > @@ -70,6 +77,7 @@ Features
> >   Features of the IFCVF driver are:
> >
> >   - Compatibility with virtio 0.95 and 1.0.
> > +- SW assisted vDPA live migration.
> >
> >
> >   Prerequisites
> > diff --git a/doc/guides/rel_notes/release_19_02.rst
> b/doc/guides/rel_notes/release_19_02.rst
> > index e86ef9511..ced6af8f0 100644
> > --- a/doc/guides/rel_notes/release_19_02.rst
> > +++ b/doc/guides/rel_notes/release_19_02.rst
> > @@ -60,6 +60,12 @@ New Features
> >     * Added the handler to get firmware version string.
> >     * Added support for multicast filtering.
> >
> > +* **Added support for SW-assisted VDPA live migration.**
> > +
> > +  This SW-assisted VDPA live migration facility helps VDPA devices without
> > +  logging capability to perform live migration, a mediate SW relay can help
> > +  devices to track dirty pages caused by DMA. IFC driver has enabled this
> > +  SW-assisted live migration mode.
> >
> >   Removed Items
> >   -------------
> >