From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <xiao.w.wang@intel.com>
Received: from mga05.intel.com (mga05.intel.com [192.55.52.43])
 by dpdk.org (Postfix) with ESMTP id 470541B454
 for <dev@dpdk.org>; Thu, 13 Dec 2018 02:23:37 +0100 (CET)
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from orsmga008.jf.intel.com ([10.7.209.65])
 by fmsmga105.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
 12 Dec 2018 17:23:36 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.56,346,1539673200"; d="scan'208";a="101112948"
Received: from dpdk-xiao-1.sh.intel.com ([10.67.111.145])
 by orsmga008.jf.intel.com with ESMTP; 12 Dec 2018 17:23:34 -0800
From: Xiao Wang <xiao.w.wang@intel.com>
To: alejandro.lucero@netronome.com,
	tiwei.bie@intel.com
Cc: maxime.coquelin@redhat.com, dev@dpdk.org, zhihong.wang@intel.com,
 xiaolong.ye@intel.com, Xiao Wang <xiao.w.wang@intel.com>
Date: Thu, 13 Dec 2018 09:10:14 +0800
Message-Id: <20181213011014.110089-10-xiao.w.wang@intel.com>
X-Mailer: git-send-email 2.15.1
In-Reply-To: <20181213011014.110089-1-xiao.w.wang@intel.com>
References: <20181128094607.106173-3-xiao.w.wang@intel.com>
 <20181213011014.110089-1-xiao.w.wang@intel.com>
Subject: [dpdk-dev] [PATCH v2 9/9] doc: update ifc NIC document
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Thu, 13 Dec 2018 01:23:37 -0000

Signed-off-by: Xiao Wang <xiao.w.wang@intel.com>
---
v2:
* Add release note.
---
 doc/guides/nics/ifc.rst                | 7 +++++++
 doc/guides/rel_notes/release_19_02.rst | 5 +++++
 2 files changed, 12 insertions(+)

diff --git a/doc/guides/nics/ifc.rst b/doc/guides/nics/ifc.rst
index 48f9adf1d..858f35f74 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 live migration.
 
 
 Prerequisites
diff --git a/doc/guides/rel_notes/release_19_02.rst b/doc/guides/rel_notes/release_19_02.rst
index a94fa86a7..ea3909631 100644
--- a/doc/guides/rel_notes/release_19_02.rst
+++ b/doc/guides/rel_notes/release_19_02.rst
@@ -54,6 +54,11 @@ New Features
      Also, make sure to start the actual text at the margin.
      =========================================================
 
+* **Add 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
 -------------
-- 
2.15.1