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 inbox.dpdk.org (Postfix) with ESMTP id E1F73A04BC;
	Fri,  9 Oct 2020 15:51:45 +0200 (CEST)
Received: from [92.243.14.124] (localhost [127.0.0.1])
	by dpdk.org (Postfix) with ESMTP id DDFC21D682;
	Fri,  9 Oct 2020 15:50:47 +0200 (CEST)
Received: from mellanox.co.il (mail-il-dmz.mellanox.com [193.47.165.129])
 by dpdk.org (Postfix) with ESMTP id 298B31D67A
 for <dev@dpdk.org>; Fri,  9 Oct 2020 15:50:43 +0200 (CEST)
Received: from Internal Mail-Server by MTLPINE1 (envelope-from
 jiaweiw@nvidia.com) with SMTP; 9 Oct 2020 16:50:36 +0300
Received: from nvidia.com (gen-l-vrt-280.mtl.labs.mlnx [10.237.45.1])
 by labmailer.mlnx (8.13.8/8.13.8) with ESMTP id 099Doadk013303;
 Fri, 9 Oct 2020 16:50:36 +0300
From: Jiawei Wang <jiaweiw@nvidia.com>
To: orika@nvidia.com, viacheslavo@nvidia.com, matan@nvidia.com,
 thomas@monjalon.net
Cc: dev@dpdk.org, rasland@nvidia.com, asafp@nvidia.com
Date: Fri,  9 Oct 2020 16:50:35 +0300
Message-Id: <1602251436-269694-10-git-send-email-jiaweiw@nvidia.com>
X-Mailer: git-send-email 1.8.3.1
In-Reply-To: <1602251436-269694-1-git-send-email-jiaweiw@nvidia.com>
References: <1601187539-112694-1-git-send-email-jiaweiw@nvidia.com>
 <1602251436-269694-1-git-send-email-jiaweiw@nvidia.com>
Subject: [dpdk-dev] [PATCH 09/10] doc: add the sample flow limitation
	description
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 description about the sample flow limitation.
Sample Flow supports in NIC-Rx and E-Switch domains.
Due to Metadata register c0 is deleted while doing the loopback,
so that only support forward the sampling packet into
E-Switch manager port, no additional action support in sample flow.

Signed-off-by: Jiawei Wang <jiaweiw@nvidia.com>
Acked-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
---
 doc/guides/nics/mlx5.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index b0614ae..166310f 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -311,6 +311,12 @@ Limitations
     for some NICs (such as ConnectX-6 Dx and BlueField 2).
     The capability bit ``scatter_fcs_w_decap_disable`` shows NIC support.
 
+- Sample flow:
+
+  - Supports ``RTE_FLOW_ACTION_TYPE_SAMPLE`` action only within NIC Rx and E-Switch steering domain.
+  - The E-Switch Sample flow must have the eswitch_manager VPORT destination (PF or ECPF) and no additional actions.
+  - For ConnectX-5, the ``RTE_FLOW_ACTION_TYPE_SAMPLE`` is typically used as first action in the E-Switch egress flow if with header modify or encapsulation actions.
+
 Statistics
 ----------
 
-- 
1.8.3.1