[dpdk-dev] [PATCH] doc: announce ABI change for old flow director APIs removing

[dpdk-dev] [PATCH] doc: announce ABI change for old flow director APIs removing

[Jingjing Wu]

APIs for flow director filters has been replaced by rte_eth_dev_filter_ctrl
by previous releases. Enic, ixgbe and i40e are switched to support filter_ctrl
APIs, so the old APIs are useless, and ready to be removed now.
This patch announces the ABI change for these APIs removing.

Signed-off-by: Jingjing Wu <jingjing.wu@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 5330d3b..b1be38f 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -35,3 +35,39 @@ Deprecation Notices
 * The following fields have been deprecated in rte_eth_stats:
   imissed, ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
   tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff
+
+* APIs for flow director filters has been replaced by rte_eth_dev_filter_ctrl.
+  Following old APIs, and data structures are deprecated and will be removed
+  with version 2.2. There is no backward compatibility planned from release 2.2.
+  APIs:
+    rte_eth_dev_fdir_add_signature_filter
+    rte_eth_dev_fdir_update_signature_filter
+    rte_eth_dev_fdir_remove_signature_filter
+    rte_eth_dev_fdir_get_infos
+    rte_eth_dev_fdir_add_perfect_filter
+    rte_eth_dev_fdir_update_perfect_filter
+    rte_eth_dev_fdir_remove_perfect_filter
+    rte_eth_dev_fdir_set_masks
+  Data structures:
+    struct rte_fdir_filter
+    struct rte_fdir_masks
+    struct rte_eth_fdir
+    fields in struct eth_dev_ops
+      fdir_add_signature_filter
+      fdir_update_signature_filter
+      fdir_remove_signature_filter
+      fdir_infos_get
+      fdir_add_perfect_filter
+      fdir_update_perfect_filter
+      fdir_remove_perfect_filter
+      fdir_set_masks
+    enum rte_l4type
+    enum rte_iptype
+    fdir_add_signature_filter_t
+    fdir_update_signature_filter_t
+    fdir_remove_signature_filter_t
+    fdir_infos_get_t
+    fdir_add_perfect_filter_t
+    fdir_update_perfect_filter_t
+    fdir_remove_perfect_filter_t
+    fdir_set_masks_t
-- 
2.4.0

Re: [dpdk-dev] [PATCH] doc: announce ABI change for old flow director APIs removing

[Zhang, Helin]

> -----Original Message-----
> From: Wu, Jingjing
> Sent: Monday, August 10, 2015 7:12 PM
> To: dev@dpdk.org
> Cc: Wu, Jingjing; Zhang, Helin; Liu, Jijiang
> Subject: [PATCH] doc: announce ABI change for old flow director APIs removing
> 
> APIs for flow director filters has been replaced by rte_eth_dev_filter_ctrl by
> previous releases. Enic, ixgbe and i40e are switched to support filter_ctrl APIs, so
> the old APIs are useless, and ready to be removed now.
> This patch announces the ABI change for these APIs removing.
> 
> Signed-off-by: Jingjing Wu <jingjing.wu@intel.com>
Acked-by: Helin Zhang <helin.zhang@intel.com>

Re: [dpdk-dev] [PATCH] doc: announce ABI change for old flow director APIs removing

[Liu, Jijiang]

> -----Original Message-----
> From: Wu, Jingjing
> Sent: Tuesday, August 11, 2015 10:12 AM
> To: dev@dpdk.org
> Cc: Wu, Jingjing; Zhang, Helin; Liu, Jijiang
> Subject: [PATCH] doc: announce ABI change for old flow director APIs removing
> 
> APIs for flow director filters has been replaced by rte_eth_dev_filter_ctrl by
> previous releases. Enic, ixgbe and i40e are switched to support filter_ctrl APIs,
> so the old APIs are useless, and ready to be removed now.
> This patch announces the ABI change for these APIs removing.
> 
> Signed-off-by: Jingjing Wu <jingjing.wu@intel.com>
Acked-by: Jijiang Liu <jijiang.liu@intel.com>

Re: [dpdk-dev] [PATCH] doc: announce ABI change for old flow director APIs removing

[Thomas Monjalon]

> > APIs for flow director filters has been replaced by rte_eth_dev_filter_ctrl by
> > previous releases. Enic, ixgbe and i40e are switched to support filter_ctrl APIs, so
> > the old APIs are useless, and ready to be removed now.
> > This patch announces the ABI change for these APIs removing.
> > 
> > Signed-off-by: Jingjing Wu <jingjing.wu@intel.com>
> Acked-by: Helin Zhang <helin.zhang@intel.com>

Reworded and applied, thanks