doc: fix ABI change announce for RETA configuration
[dpdk.git] / doc / guides / rel_notes / deprecation.rst
index f099ac0..e94d4a2 100644 (file)
@@ -8,47 +8,44 @@ API and ABI deprecation notices are to be posted here.
 Deprecation Notices
 -------------------
 
-* Significant ABI changes are planned for struct rte_eth_dev to support up to
-  1024 queues per port. This change will be in release 2.2.
-  There is no backward compatibility planned from release 2.2.
-  All binaries will need to be rebuilt from release 2.2.
-
 * The following fields have been deprecated in rte_eth_stats:
   ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
   tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff
 
-* ABI changes are planned for struct rte_eth_fdir_flow_ext in order to support
-  flow director filtering in VF. The release 2.1 does not contain these ABI
-  changes, but release 2.2 will, and no backwards compatibility is planned.
+* The ethdev structures rte_eth_link, rte_eth_dev_info and rte_eth_conf
+  must be updated to support 100G link and to have a cleaner link speed API.
 
-* ABI changes are planned for struct rte_eth_fdir_filter and
-  rte_eth_fdir_masks in order to support new flow director modes,
-  MAC VLAN and Cloud, on x550. The MAC VLAN mode means the MAC and
-  VLAN are monitored. The Cloud mode is for VxLAN and NVGRE, and
-  the tunnel type, TNI/VNI, inner MAC and inner VLAN are monitored.
-  The release 2.2 will contain these changes without backwards compatibility.
+* ABI changes is planned for the reta field in struct rte_eth_rss_reta_entry64
+  which handles at most 256 queues (8 bits) while newer NICs support larger
+  tables (512 queues).
+  It should be integrated in release 2.3.
 
-* ABI changes are planned for struct virtio_net in order to support vhost-user
-  multiple queues feature.
-  It should be integrated in release 2.2 without backward compatibility.
+* ABI changes are planned for struct rte_eth_fdir_flow in order to support
+  extend flow director's input set. The release 2.2 does not contain these ABI
+  changes, but release 2.3 will, and no backwards compatibility is planned.
 
-* The scheduler hierarchy structure (rte_sched_port_hierarchy) will change to
-  allow for a larger number of subport entries.
-  The number of available traffic_classes and queues may also change.
-  The mbuf structure element for sched hierarchy will also change from a single
-  32 bit to a 64 bit structure.
+* ABI changes are planned for rte_eth_ipv4_flow and rte_eth_ipv6_flow to
+  include more fields to be matched against. The release 2.2 does not
+  contain these ABI changes, but release 2.3 will.
 
-* The scheduler statistics structure will change to allow keeping track of
-  RED actions.
+* ABI changes are planned for adding four new flow types. This impacts
+  RTE_ETH_FLOW_MAX. The release 2.2 does not contain these ABI changes,
+  but release 2.3 will.
 
-* librte_table: New functions for table entry bulk add/delete will be added
-  to the table operations structure.
+* ABI changes are planned for rte_eth_tunnel_filter_conf. Change the fields
+  of outer_mac and inner_mac from pointer to struct in order to keep the
+  code's readability. The release 2.2 does not contain these ABI changes, but
+  release 2.3 will, and no backwards compatibility is planned.
 
-* librte_table hash: Key mask parameter will be added to the hash table
-  parameter structure for 8-byte key and 16-byte key extendible bucket and
-  LRU tables.
+* The scheduler statistics structure will change to allow keeping track of
+  RED actions.
 
 * librte_pipeline: The prototype for the pipeline input port, output port
   and table action handlers will be updated:
   the pipeline parameter will be added, the packets mask parameter will be
   either removed (for input port action handler) or made input-only.
+
+* ABI changes are planned in cmdline buffer size to allow the use of long
+  commands (such as RETA update in testpmd).  This should impact
+  CMDLINE_PARSE_RESULT_BUFSIZE, STR_TOKEN_SIZE and RDLINE_BUF_SIZE.
+  It should be integrated in release 2.3.