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 02F0BA00C2;
	Wed, 22 Apr 2020 17:27:29 +0200 (CEST)
Received: from [92.243.14.124] (localhost [127.0.0.1])
	by dpdk.org (Postfix) with ESMTP id A396A1D56D;
	Wed, 22 Apr 2020 17:27:28 +0200 (CEST)
Received: from git-send-mailer.rdmz.labs.mlnx (unknown [37.142.13.130])
 by dpdk.org (Postfix) with ESMTP id E7BFD1D568
 for <dev@dpdk.org>; Wed, 22 Apr 2020 17:27:27 +0200 (CEST)
From: Bing Zhao <bingz@mellanox.com>
To: john.mcnamara@intel.com, marko.kovacevic@intel.com,
 viacheslavo@mellanox.com, orika@mellanox.com, matan@mellanox.com
Cc: shahafs@mellanox.com, rasland@mellanox.com, dev@dpdk.org,
 thomas@monjalon.net
Date: Wed, 22 Apr 2020 23:27:15 +0800
Message-Id: <1587569235-444742-1-git-send-email-bingz@mellanox.com>
X-Mailer: git-send-email 1.8.3.1
In-Reply-To: <1587547392-380151-1-git-send-email-bingz@mellanox.com>
References: <1587547392-380151-1-git-send-email-bingz@mellanox.com>
Subject: [dpdk-dev] [PATCH v5] 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>
Acked-by: Ori Kam <orika@mellanox.com>
---
v2: update the description in release notes.
v3: update the notes of rte_flow for application.
v4: update the descriptions.
v5: update the format of lines splitting.
---
 doc/guides/nics/mlx5.rst               | 14 ++++++++++++++
 doc/guides/rel_notes/release_20_05.rst |  1 +
 2 files changed, 15 insertions(+)

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 759d0ac..fd5b697 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -1290,6 +1290,7 @@ Supported hardware offloads
 
 Notes for metadata
 ------------------
+
 MARK and META items are interrelated with datapath - they might move from/to
 the applications in mbuf fields. Hence, zero value for these items has the
 special meaning - it means "no metadata are provided", not zero values are
@@ -1300,6 +1301,19 @@ 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
+------------------
+
+Flows are not cached in the driver.
+When stopping a device port, all the flows created on this port from the
+application will be flushed automatically in the background.
+After stopping the device port, all flows on this port become invalid and
+not represented in the system.
+All references to these flows held by the application should be discarded
+directly but neither destroyed nor flushed.
+
+The application should re-create the flows as required after the port restart.
+
 Notes for testpmd
 -----------------
 
diff --git a/doc/guides/rel_notes/release_20_05.rst b/doc/guides/rel_notes/release_20_05.rst
index 8c71dc1..e91fe14 100644
--- a/doc/guides/rel_notes/release_20_05.rst
+++ b/doc/guides/rel_notes/release_20_05.rst
@@ -79,6 +79,7 @@ New Features
   * Added support for matching on IPv4 Time To Live and IPv6 Hop Limit.
   * Added support for creating Relaxed Ordering Memory Regions.
   * Added support for jumbo frame size (9K MTU) in Multi-Packet RQ mode.
+  * Removed flow rules caching for memory saving and compliance with ethdev API.
   * Optimized the memory consumption of flow.
 
 * **Updated the Intel ice driver.**
-- 
1.8.3.1