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 9E048A059B;
	Fri, 10 Apr 2020 11:36:29 +0200 (CEST)
Received: from [92.243.14.124] (localhost [127.0.0.1])
	by dpdk.org (Postfix) with ESMTP id 84E061D426;
	Fri, 10 Apr 2020 11:36:29 +0200 (CEST)
Received: from git-send-mailer.rdmz.labs.mlnx (unknown [37.142.13.130])
 by dpdk.org (Postfix) with ESMTP id 96B2C1D412
 for <dev@dpdk.org>; Fri, 10 Apr 2020 11:36:28 +0200 (CEST)
From: Bing Zhao <bingz@mellanox.com>
To: john.mcnamara@intel.com, marko.kovacevic@intel.com,
 viacheslavo@mellanox.com, matan@mellanox.com
Cc: shahafs@mellanox.com, rasland@mellanox.com, orika@mellanox.com,
 dev@dpdk.org, thomas@monjalon.net
Date: Fri, 10 Apr 2020 17:36:14 +0800
Message-Id: <1586511374-331792-1-git-send-email-bingz@mellanox.com>
X-Mailer: git-send-email 2.5.5
Subject: [dpdk-dev] [PATCH] doc: update flow non-cached mode notes
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>

This patch updates the MLX5 PMD and release notes documentations.
Adding the notes of the behavior change that rte flows organization
is switched into non-cached mode for applications.

Signed-off-by: Bing Zhao <bingz@mellanox.com>
---
 doc/guides/nics/mlx5.rst               | 10 ++++++++++
 doc/guides/rel_notes/release_20_05.rst |  1 +
 2 files changed, 11 insertions(+)

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index e13c07d..63138c4 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -1287,6 +1287,16 @@ set, and we should allow to specify zero values as rte_flow parameters for the
 META and MARK items and actions. In the same time zero mask has no meaning and
 should be rejected on validation stage.
 
+Notes for rte_flow
+------------------
+Implementation of flows organization is in non-cached mode. When stopping a
+device, all the flows inserted from application will be considered invalid and
+flushed automatically in the background. After restarting of the device, no
+application's flow exists in the system.
+
+The application should re-insert the flows as required after device restarting,
+and must not try to destroy or flush the invalid flows before stopping.
+
 Notes for testpmd
 -----------------
 
diff --git a/doc/guides/rel_notes/release_20_05.rst b/doc/guides/rel_notes/release_20_05.rst
index 2596269..3c55445 100644
--- a/doc/guides/rel_notes/release_20_05.rst
+++ b/doc/guides/rel_notes/release_20_05.rst
@@ -62,6 +62,7 @@ New Features
 
   * Added support for matching on IPv4 Time To Live and IPv6 Hop Limit.
   * Added support for creating Relaxed Ordering Memory Regions.
+  * Flows organization changed from cached mode to non-cached mode.
 
 * **Updated the Intel ice driver.**
 
-- 
2.5.5