From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from dpdk.org (dpdk.org [92.243.14.124])
	by dpdk.space (Postfix) with ESMTP id 111FAA0096
	for <public@inbox.dpdk.org>; Fri,  7 Jun 2019 05:15:15 +0200 (CEST)
Received: from [92.243.14.124] (localhost [127.0.0.1])
	by dpdk.org (Postfix) with ESMTP id E52814C8E;
	Fri,  7 Jun 2019 05:15:14 +0200 (CEST)
Received: from mga05.intel.com (mga05.intel.com [192.55.52.43])
 by dpdk.org (Postfix) with ESMTP id 998DA2C5E
 for <dev@dpdk.org>; Fri,  7 Jun 2019 05:15:13 +0200 (CEST)
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from fmsmga005.fm.intel.com ([10.253.24.32])
 by fmsmga105.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
 06 Jun 2019 20:15:12 -0700
X-ExtLoop1: 1
Received: from npg-dpdk-haiyue-1.sh.intel.com ([10.67.119.207])
 by fmsmga005.fm.intel.com with ESMTP; 06 Jun 2019 20:15:11 -0700
From: Haiyue Wang <haiyue.wang@intel.com>
To: dev@dpdk.org, qi.z.zhang@intel.com, wenzhuo.lu@intel.com,
 liang-min.wang@intel.com, daniels@research.att.com
Cc: Haiyue Wang <haiyue.wang@intel.com>
Date: Fri,  7 Jun 2019 11:10:40 +0800
Message-Id: <1559877042-95011-2-git-send-email-haiyue.wang@intel.com>
X-Mailer: git-send-email 2.7.4
In-Reply-To: <1559877042-95011-1-git-send-email-haiyue.wang@intel.com>
References: <1559877042-95011-1-git-send-email-haiyue.wang@intel.com>
Subject: [dpdk-dev] [PATCH v1 2/2] doc: add the description for option
	pflink_fullchk in ixgbevf
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>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

Add the detail description for this pflink_fullchk option, when it will
be used, and it is used for fixing what kind of issue.

Signed-off-by: Haiyue Wang <haiyue.wang@intel.com>
---
 doc/guides/nics/ixgbe.rst | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/doc/guides/nics/ixgbe.rst b/doc/guides/nics/ixgbe.rst
index 975143f..33812a5 100644
--- a/doc/guides/nics/ixgbe.rst
+++ b/doc/guides/nics/ixgbe.rst
@@ -82,6 +82,24 @@ To guarantee the constraint, capabilities in dev_conf.rxmode.offloads will be ch
 
 fdir_conf->mode will also be checked.
 
+VF Runtime Options
+^^^^^^^^^^^^^^^^^^
+
+The following ``devargs`` options can be enabled at runtime. They must
+be passed as part of EAL arguments. For example,
+
+.. code-block:: console
+
+   testpmd -w af:10.0,pflink_fullchk=1 -- -i
+
+- ``pflink_fullchk`` (default **0**)
+
+  Toggle behavior to get ixgbevf link status quickly by checking the
+  mailbox status or not. If set, the VF will check the PF's link status
+  and the PF's mailbox running status, which will trigger PF's mailbox
+  interrupt generation. Otherwise, just check PF's link status, then no
+  mailbox interrupt in PF.
+
 RX Burst Size
 ^^^^^^^^^^^^^
 
-- 
2.7.4