[9/9] doc: update ifc NIC document

Message ID 20181128094607.106173-10-xiao.w.wang@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Maxime Coquelin
Headers
Series support SW assisted VDPA live migration |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/Intel-compilation fail Compilation issues

Commit Message

Xiao Wang Nov. 28, 2018, 9:46 a.m. UTC
  Signed-off-by: Xiao Wang <xiao.w.wang@intel.com>
---
 doc/guides/nics/ifc.rst | 7 +++++++
 1 file changed, 7 insertions(+)
  

Patch

diff --git a/doc/guides/nics/ifc.rst b/doc/guides/nics/ifc.rst
index 48f9adf1d..a16f2982f 100644
--- a/doc/guides/nics/ifc.rst
+++ b/doc/guides/nics/ifc.rst
@@ -39,6 +39,12 @@  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.
+
 Key IFCVF vDPA driver ops
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -70,6 +76,7 @@  Features
 Features of the IFCVF driver are:
 
 - Compatibility with virtio 0.95 and 1.0.
+- SW assisted vDPA for live migration.
 
 
 Prerequisites