doc: postpone ABI changes for Tx prepare

[dpdk.git] / doc / guides / rel_notes / deprecation.rst

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 9fdd25c..ab6014d 100644 (file)
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -8,38 +8,30 @@ API and ABI deprecation notices are to be posted here.
 Deprecation Notices
 -------------------
 
-* 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_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 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.
-
-* 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.
-
-* The scheduler statistics structure will change to allow keeping track of
-  RED actions.
-
-* librte_table: New functions for table entry bulk add/delete will be added
-  to the table operations structure.
-
-* 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.
-
-* 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.
+* In 17.02 ABI changes are planned: the ``rte_eth_dev`` structure will be
+  extended with new function pointer ``tx_pkt_prepare`` allowing verification
+  and processing of packet burst to meet HW specific requirements before
+  transmit. Also new fields will be added to the ``rte_eth_desc_lim`` structure:
+  ``nb_seg_max`` and ``nb_mtu_seg_max`` providing information about number of
+  segments limit to be transmitted by device for TSO/non-TSO packets.
+
+* ABI changes are planned for 17.02 in the ``rte_mbuf`` structure: some fields
+  may be reordered to facilitate the writing of ``data_off``, ``refcnt``, and
+  ``nb_segs`` in one operation, because some platforms have an overhead if the
+  store address is not naturally aligned. Other mbuf fields, such as the
+  ``port`` field, may be moved or removed as part of this mbuf work. A
+  ``timestamp`` will also be added.
+
+* The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and
+  are respectively replaced by PKT_RX_VLAN_STRIPPED and
+  PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
+  their behavior will be kept until 16.11 and will be removed in 17.02.
+
+* mempool: The functions ``rte_mempool_count`` and ``rte_mempool_free_count``
+  will be removed in 17.02.
+  They are replaced by ``rte_mempool_avail_count`` and
+  ``rte_mempool_in_use_count`` respectively.
+
+* mempool: The functions for single/multi producer/consumer are deprecated
+  and will be removed in 17.02.
+  It is replaced by ``rte_mempool_generic_get/put`` functions.