From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 46B78A059B; Fri, 10 Apr 2020 11:29:18 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 219061D423; Fri, 10 Apr 2020 11:29:18 +0200 (CEST) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by dpdk.org (Postfix) with ESMTP id 2D1911D416 for ; Fri, 10 Apr 2020 11:29:16 +0200 (CEST) IronPort-SDR: ELFB+wm+u05XuiF5EgjJ2+NhYkgBLBxGEC2t9n8bUFsyV1G9c2yOGqQ+j5aGlXsdFHC/2AmRrO fwnnGJtt57cQ== X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 10 Apr 2020 02:29:15 -0700 IronPort-SDR: jcqp6a4h6UdXHNj0rIwe4ThkCRFPwQeEdHyJRP2DeTNVpPmzM3ZVZsKu9DIgo3Ppn9ei3J33JB kSytZTbof2ZA== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.72,366,1580803200"; d="scan'208";a="452330392" Received: from silpixa00399752.ir.intel.com (HELO silpixa00399752.ger.corp.intel.com) ([10.237.222.180]) by fmsmga005.fm.intel.com with ESMTP; 10 Apr 2020 02:29:07 -0700 From: Ferruh Yigit To: dev@dpdk.org, Rahul Lakkireddy , John McNamara , Marko Kovacevic , John Daley , Hyong Youb Kim , Ajit Khaparde , Somnath Kotur , Gaetan Rivet , Ziyang Xuan , Xiaoyun Wang , Guoyang Zhou , "Wei Hu (Xavier)" , "Min Hu (Connor)" , Yisen Zhuang , Beilei Xing , Qi Zhang , Jingjing Wu , Wenzhuo Lu , Qiming Yang , Rosen Xu , Konstantin Ananyev , Matan Azrad , Shahaf Shuler , Viacheslav Ovsiienko , Jerin Jacob , Nithin Dabilpuram , Kiran Kumar K , Rasesh Mody , Shahed Shaikh , Andrew Rybchenko , Keith Wiles , Tomasz Duszynski , Liron Himi Cc: Ferruh Yigit , Thomas Monjalon , Adrien Mazarguil Date: Fri, 10 Apr 2020 10:29:05 +0100 Message-Id: <20200410092906.951009-1-ferruh.yigit@intel.com> X-Mailer: git-send-email 2.25.2 In-Reply-To: <20191025125118.47189-1-ferruh.yigit@intel.com> References: <20191025125118.47189-1-ferruh.yigit@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v2] doc: remove flow API from the feature list X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" "Flow API" is a method/API to implement various filtering features, on its own it doesn't give much context on what features are provided. And it is not really a feature, so doesn't fit into feature table. Also since other filtering related APIs, 'filter_ctrl', has been deprecated, flow API is the only supported way in the DPDK to implement filtering options, if related filter options announced by PMDs, listing "Flow API" as implemented is redundant information. Signed-off-by: Ferruh Yigit --- Cc: Thomas Monjalon Cc: Andrew Rybchenko Cc: Adrien Mazarguil Cc: Ajit Khaparde Cc: Jerin Jacob v2: * Removed feature from all .ini files * Removed some references from nic guides --- doc/guides/nics/cxgbe.rst | 2 +- doc/guides/nics/enic.rst | 6 +++--- doc/guides/nics/features.rst | 11 ----------- doc/guides/nics/features/bnxt.ini | 1 - doc/guides/nics/features/cxgbe.ini | 1 - doc/guides/nics/features/default.ini | 1 - doc/guides/nics/features/enic.ini | 1 - doc/guides/nics/features/failsafe.ini | 1 - doc/guides/nics/features/hinic.ini | 1 - doc/guides/nics/features/hns3.ini | 1 - doc/guides/nics/features/hns3_vf.ini | 1 - doc/guides/nics/features/i40e.ini | 1 - doc/guides/nics/features/iavf.ini | 1 - doc/guides/nics/features/ice.ini | 1 - doc/guides/nics/features/igb.ini | 1 - doc/guides/nics/features/ipn3ke.ini | 1 - doc/guides/nics/features/ixgbe.ini | 1 - doc/guides/nics/features/mlx4.ini | 1 - doc/guides/nics/features/mlx5.ini | 1 - doc/guides/nics/features/octeontx2.ini | 1 - doc/guides/nics/features/octeontx2_vec.ini | 1 - doc/guides/nics/features/octeontx2_vf.ini | 1 - doc/guides/nics/features/qede.ini | 1 - doc/guides/nics/features/sfc_efx.ini | 1 - doc/guides/nics/features/tap.ini | 1 - doc/guides/nics/hinic.rst | 2 +- doc/guides/nics/mlx5.rst | 2 +- doc/guides/nics/mvpp2.rst | 6 +++--- doc/guides/nics/sfc_efx.rst | 2 +- doc/guides/nics/tap.rst | 4 ++-- 30 files changed, 12 insertions(+), 45 deletions(-) diff --git a/doc/guides/nics/cxgbe.rst b/doc/guides/nics/cxgbe.rst index 54a4c1389..c4f263053 100644 --- a/doc/guides/nics/cxgbe.rst +++ b/doc/guides/nics/cxgbe.rst @@ -30,7 +30,7 @@ CXGBE and CXGBEVF PMD has support for: - All multicast mode - Port hardware statistics - Jumbo frames -- Flow API - Support for both Wildcard (LE-TCAM) and Exact (HASH) match filters. +- Packet filtering - Support for both Wildcard (LE-TCAM) and Exact (HASH) match filters. Limitations ----------- diff --git a/doc/guides/nics/enic.rst b/doc/guides/nics/enic.rst index 65e536d42..43ea2cf10 100644 --- a/doc/guides/nics/enic.rst +++ b/doc/guides/nics/enic.rst @@ -208,8 +208,8 @@ the use of SR-IOV. .. _enic-generic-flow-api: -Generic Flow API support ------------------------- +Generic packet filtering support +-------------------------------- Generic Flow API (also called "rte_flow" API) is supported. More advanced capabilities are available when "Advanced Filtering" is enabled on the adapter. @@ -524,7 +524,7 @@ Supported features - Scattered Rx - MTU update - SR-IOV on UCS managed servers connected to Fabric Interconnects -- Flow API +- Packet filtering via Flow API - Overlay offload - Rx/Tx checksum offloads for VXLAN, NVGRE, GENEVE diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst index ea64f81c1..e44614335 100644 --- a/doc/guides/nics/features.rst +++ b/doc/guides/nics/features.rst @@ -453,17 +453,6 @@ Supports configuring link flow control. ``rte_eth_dev_priority_flow_ctrl_set()``. -.. _nic_features_flow_api: - -Flow API --------- - -Supports the DPDK Flow API for generic filtering. - -* **[implements] eth_dev_ops**: ``filter_ctrl:RTE_ETH_FILTER_GENERIC``. -* **[implements] rte_flow_ops**: ``All``. - - .. _nic_features_rate_limitation: Rate limitation diff --git a/doc/guides/nics/features/bnxt.ini b/doc/guides/nics/features/bnxt.ini index e359c157a..bb039da9b 100644 --- a/doc/guides/nics/features/bnxt.ini +++ b/doc/guides/nics/features/bnxt.ini @@ -28,7 +28,6 @@ Ethertype filter = Y N-tuple filter = Y Flow director = Y Flow control = Y -Flow API = Y CRC offload = Y L3 checksum offload = Y L4 checksum offload = Y diff --git a/doc/guides/nics/features/cxgbe.ini b/doc/guides/nics/features/cxgbe.ini index 88f2f92b7..6cf5c13f5 100644 --- a/doc/guides/nics/features/cxgbe.ini +++ b/doc/guides/nics/features/cxgbe.ini @@ -16,7 +16,6 @@ Allmulticast mode = Y RSS hash = Y RSS key update = Y Flow control = Y -Flow API = Y CRC offload = Y VLAN offload = Y L3 checksum offload = Y diff --git a/doc/guides/nics/features/default.ini b/doc/guides/nics/features/default.ini index cc229e7ae..bf2b0d94c 100644 --- a/doc/guides/nics/features/default.ini +++ b/doc/guides/nics/features/default.ini @@ -45,7 +45,6 @@ Flexible filter = Hash filter = Flow director = Flow control = -Flow API = Rate limitation = Traffic mirroring = Inline crypto = diff --git a/doc/guides/nics/features/enic.ini b/doc/guides/nics/features/enic.ini index d0f3ae23f..c38f8a01c 100644 --- a/doc/guides/nics/features/enic.ini +++ b/doc/guides/nics/features/enic.ini @@ -25,7 +25,6 @@ SR-IOV = Y CRC offload = Y VLAN offload = Y Flow director = Y -Flow API = Y L3 checksum offload = Y L4 checksum offload = Y Inner L3 checksum = Y diff --git a/doc/guides/nics/features/failsafe.ini b/doc/guides/nics/features/failsafe.ini index b6f3dcee6..8a2b92fc9 100644 --- a/doc/guides/nics/features/failsafe.ini +++ b/doc/guides/nics/features/failsafe.ini @@ -19,7 +19,6 @@ Unicast MAC filter = Y Multicast MAC filter = Y VLAN filter = Y Flow control = Y -Flow API = Y Packet type parsing = Y Basic stats = Y Stats per queue = Y diff --git a/doc/guides/nics/features/hinic.ini b/doc/guides/nics/features/hinic.ini index 5be05d36f..36940fca8 100644 --- a/doc/guides/nics/features/hinic.ini +++ b/doc/guides/nics/features/hinic.ini @@ -32,7 +32,6 @@ Inner L4 checksum = Y Basic stats = Y Extended stats = Y Stats per queue = Y -Flow API = Y Flow control = Y FW version = Y Multiprocess aware = Y diff --git a/doc/guides/nics/features/hns3.ini b/doc/guides/nics/features/hns3.ini index c3a8544bc..b5c783140 100644 --- a/doc/guides/nics/features/hns3.ini +++ b/doc/guides/nics/features/hns3.ini @@ -19,7 +19,6 @@ RSS reta update = Y DCB = Y VLAN filter = Y Flow control = Y -Flow API = Y CRC offload = Y VLAN offload = Y L3 checksum offload = Y diff --git a/doc/guides/nics/features/hns3_vf.ini b/doc/guides/nics/features/hns3_vf.ini index 80773ac90..3b85633a1 100644 --- a/doc/guides/nics/features/hns3_vf.ini +++ b/doc/guides/nics/features/hns3_vf.ini @@ -17,7 +17,6 @@ RSS hash = Y RSS key update = Y RSS reta update = Y VLAN filter = Y -Flow API = Y CRC offload = Y VLAN offload = Y L3 checksum offload = Y diff --git a/doc/guides/nics/features/i40e.ini b/doc/guides/nics/features/i40e.ini index 0b9bd99be..512c15733 100644 --- a/doc/guides/nics/features/i40e.ini +++ b/doc/guides/nics/features/i40e.ini @@ -28,7 +28,6 @@ SR-IOV = Y DCB = Y VLAN filter = Y Flow control = Y -Flow API = Y Traffic mirroring = Y CRC offload = Y VLAN offload = Y diff --git a/doc/guides/nics/features/iavf.ini b/doc/guides/nics/features/iavf.ini index 17f7928eb..94d9f88a6 100644 --- a/doc/guides/nics/features/iavf.ini +++ b/doc/guides/nics/features/iavf.ini @@ -19,7 +19,6 @@ Multicast MAC filter = Y RSS hash = Y RSS key update = Y RSS reta update = Y -Flow API = Y VLAN filter = Y CRC offload = Y VLAN offload = Y diff --git a/doc/guides/nics/features/ice.ini b/doc/guides/nics/features/ice.ini index 895d6b309..d9246e7c1 100644 --- a/doc/guides/nics/features/ice.ini +++ b/doc/guides/nics/features/ice.ini @@ -22,7 +22,6 @@ Multicast MAC filter = Y RSS hash = Y RSS key update = Y RSS reta update = Y -Flow API = Y VLAN filter = Y CRC offload = Y VLAN offload = Y diff --git a/doc/guides/nics/features/igb.ini b/doc/guides/nics/features/igb.ini index c53fd0757..9f28819f6 100644 --- a/doc/guides/nics/features/igb.ini +++ b/doc/guides/nics/features/igb.ini @@ -27,7 +27,6 @@ N-tuple filter = Y SYN filter = Y Flexible filter = Y Flow control = Y -Flow API = Y CRC offload = Y VLAN offload = Y QinQ offload = Y diff --git a/doc/guides/nics/features/ipn3ke.ini b/doc/guides/nics/features/ipn3ke.ini index a194e3564..93b9f8f3f 100644 --- a/doc/guides/nics/features/ipn3ke.ini +++ b/doc/guides/nics/features/ipn3ke.ini @@ -30,7 +30,6 @@ Tunnel filter = Y Hash filter = Y Flow director = Y Flow control = Y -Flow API = Y Traffic mirroring = Y CRC offload = Y VLAN offload = Y diff --git a/doc/guides/nics/features/ixgbe.ini b/doc/guides/nics/features/ixgbe.ini index 724cf8976..5195cd815 100644 --- a/doc/guides/nics/features/ixgbe.ini +++ b/doc/guides/nics/features/ixgbe.ini @@ -30,7 +30,6 @@ SYN filter = Y Tunnel filter = Y Flow director = Y Flow control = Y -Flow API = Y Rate limitation = Y Traffic mirroring = Y Inline crypto = Y diff --git a/doc/guides/nics/features/mlx4.ini b/doc/guides/nics/features/mlx4.ini index 9b70089df..c38f1d68f 100644 --- a/doc/guides/nics/features/mlx4.ini +++ b/doc/guides/nics/features/mlx4.ini @@ -22,7 +22,6 @@ RSS hash = Y SR-IOV = Y VLAN filter = Y Flow control = Y -Flow API = Y CRC offload = Y L3 checksum offload = Y L4 checksum offload = Y diff --git a/doc/guides/nics/features/mlx5.ini b/doc/guides/nics/features/mlx5.ini index 5f4a96b7c..aac606952 100644 --- a/doc/guides/nics/features/mlx5.ini +++ b/doc/guides/nics/features/mlx5.ini @@ -28,7 +28,6 @@ SR-IOV = Y VLAN filter = Y Flow director = Y Flow control = Y -Flow API = Y CRC offload = Y VLAN offload = Y L3 checksum offload = Y diff --git a/doc/guides/nics/features/octeontx2.ini b/doc/guides/nics/features/octeontx2.ini index fb1351782..05dce7764 100644 --- a/doc/guides/nics/features/octeontx2.ini +++ b/doc/guides/nics/features/octeontx2.ini @@ -30,7 +30,6 @@ Inner RSS = Y Inline protocol = Y VLAN filter = Y Flow control = Y -Flow API = Y Rate limitation = Y Jumbo frame = Y Scattered Rx = Y diff --git a/doc/guides/nics/features/octeontx2_vec.ini b/doc/guides/nics/features/octeontx2_vec.ini index 66e233aba..5fdb36e68 100644 --- a/doc/guides/nics/features/octeontx2_vec.ini +++ b/doc/guides/nics/features/octeontx2_vec.ini @@ -27,7 +27,6 @@ RSS reta update = Y Inner RSS = Y VLAN filter = Y Flow control = Y -Flow API = Y Rate limitation = Y Jumbo frame = Y VLAN offload = Y diff --git a/doc/guides/nics/features/octeontx2_vf.ini b/doc/guides/nics/features/octeontx2_vf.ini index c04c0e906..19034c941 100644 --- a/doc/guides/nics/features/octeontx2_vf.ini +++ b/doc/guides/nics/features/octeontx2_vf.ini @@ -23,7 +23,6 @@ RSS reta update = Y Inner RSS = Y Inline protocol = Y VLAN filter = Y -Flow API = Y Rate limitation = Y Jumbo frame = Y Scattered Rx = Y diff --git a/doc/guides/nics/features/qede.ini b/doc/guides/nics/features/qede.ini index f69e4f843..0d0810021 100644 --- a/doc/guides/nics/features/qede.ini +++ b/doc/guides/nics/features/qede.ini @@ -23,7 +23,6 @@ N-tuple filter = Y Tunnel filter = Y Flow director = Y Flow control = Y -Flow API = Y CRC offload = Y VLAN offload = Y L3 checksum offload = Y diff --git a/doc/guides/nics/features/sfc_efx.ini b/doc/guides/nics/features/sfc_efx.ini index eca14270e..2eb875b89 100644 --- a/doc/guides/nics/features/sfc_efx.ini +++ b/doc/guides/nics/features/sfc_efx.ini @@ -24,7 +24,6 @@ RSS key update = Y RSS reta update = Y SR-IOV = Y Flow control = Y -Flow API = Y VLAN offload = P L3 checksum offload = Y L4 checksum offload = Y diff --git a/doc/guides/nics/features/tap.ini b/doc/guides/nics/features/tap.ini index 519cad924..c36626d2c 100644 --- a/doc/guides/nics/features/tap.ini +++ b/doc/guides/nics/features/tap.ini @@ -11,7 +11,6 @@ Rx interrupt = Y Promiscuous mode = Y Allmulticast mode = Y Basic stats = Y -Flow API = Y L3 checksum offload = Y L4 checksum offload = Y MTU update = Y diff --git a/doc/guides/nics/hinic.rst b/doc/guides/nics/hinic.rst index f76506064..7277d9374 100644 --- a/doc/guides/nics/hinic.rst +++ b/doc/guides/nics/hinic.rst @@ -30,7 +30,7 @@ Features - MTU update - Unicast MAC filter - Multicast MAC filter -- Flow API +- Packet filtering via Flow API - Set Link down or up - FW version - LRO diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index e13c07d9a..70cbb0598 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -82,7 +82,7 @@ Features - Hardware checksum offloads. - Flow director (RTE_FDIR_MODE_PERFECT, RTE_FDIR_MODE_PERFECT_MAC_VLAN and RTE_ETH_FDIR_REJECT). -- Flow API, including :ref:`flow_isolated_mode`. +- Packet filtering via Flow API, including :ref:`flow_isolated_mode`. - Multiple process. - KVM and VMware ESX SR-IOV modes are supported. - RSS hash result is supported. diff --git a/doc/guides/nics/mvpp2.rst b/doc/guides/nics/mvpp2.rst index 19cab1cbc..98fdd004e 100644 --- a/doc/guides/nics/mvpp2.rst +++ b/doc/guides/nics/mvpp2.rst @@ -47,7 +47,7 @@ Features of the MVPP2 PMD are: - RX flow control - Scattered TX frames - :ref:`QoS ` -- :ref:`Flow API ` +- :ref:`Packet filtering via Flow API ` - :ref:`Traffic metering and policing ` - :ref:`Traffic Management API ` @@ -378,8 +378,8 @@ Usage example .. _flowapi: -Flow API --------- +Packet filtering +---------------- PPv2 offers packet classification capabilities via classifier engine which can be configured via generic flow API offered by DPDK. diff --git a/doc/guides/nics/sfc_efx.rst b/doc/guides/nics/sfc_efx.rst index be1c2fe1d..a77770a1f 100644 --- a/doc/guides/nics/sfc_efx.rst +++ b/doc/guides/nics/sfc_efx.rst @@ -67,7 +67,7 @@ SFC EFX PMD has support for: - Transmit VLAN insertion (if running firmware variant supports it) -- Flow API +- Packet filtering via Flow API - Loopback diff --git a/doc/guides/nics/tap.rst b/doc/guides/nics/tap.rst index 7e44f8462..1448689b4 100644 --- a/doc/guides/nics/tap.rst +++ b/doc/guides/nics/tap.rst @@ -94,8 +94,8 @@ where X stands for unique id, example:: Unlike TAP PMD, TUN PMD does not support user arguments as ``MAC`` or ``remote`` user options. Default interface name is ``dtunX``, where X stands for unique id. -Flow API support ----------------- +Packet filtering support +------------------------ The tap PMD supports major flow API pattern items and actions, when running on linux kernels above 4.2 ("Flower" classifier required). -- 2.25.2