mbuf: rename Tx VLAN flags

[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 a89a394..7f78ee9 100644 (file)
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -28,12 +28,14 @@ Deprecation Notices
   - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
   - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
 
-* ethdev: Tx offloads will no longer be enabled by default in 17.11.
-  Instead, the ``rte_eth_txmode`` structure will be extended with
-  bit field to enable each Tx offload.
-  Besides of making the Rx/Tx configuration API more consistent for the
-  application, PMDs will be able to provide a better out of the box performance.
-  As part of the work, ``ETH_TXQ_FLAGS_NO*`` will be superseded as well.
+* ethdev: a new Tx and Rx offload API was introduced on 17.11.
+  In the new API, offloads are divided into per-port and per-queue offloads.
+  Offloads are disabled by default and enabled per application request.
+  The old offloads API is target to be deprecated on 18.05. This includes:
+
+  - removal of ``ETH_TXQ_FLAGS_NO*`` flags.
+  - removal of ``txq_flags`` field from ``rte_eth_txconf`` struct.
+  - removal of the offloads bit-field from ``rte_eth_rxmode`` struct.
 
 * ethdev: the legacy filter API, including
   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
@@ -43,5 +45,28 @@ Deprecation Notices
   Target release for removal of the legacy API will be defined once most
   PMDs have switched to rte_flow.
 
+* i40e: The default flexible payload configuration which extracts the first 16
+  bytes of the payload for RSS will be deprecated starting from 18.02. If
+  required the previous behavior can be configured using existing flow
+  director APIs. There is no ABI/API break. This change will just remove a
+  global configuration setting and require explicit configuration.
+
 * librte_meter: The API will change to accommodate configuration profiles.
   Most of the API functions will have an additional opaque parameter.
+
+* ring: The alignment constraints on the ring structure will be relaxed
+  to one cache line instead of two, and an empty cache line padding will
+  be added between the producer and consumer structures. The size of the
+  structure and the offset of the fields will remain the same on
+  platforms with 64B cache line, but will change on other platforms.
+
+* mbuf: The control mbuf API (``rte_ctrlmbuf_init()`` function,
+  ``rte_ctrlmbuf_alloc()`` macro, ``rte_ctrlmbuf_free()`` macro,
+  ``rte_ctrlmbuf_data()`` macro, ``rte_ctrlmbuf_len()`` macro,
+  ``rte_is_ctrlmbuf()`` macro and ``CTRL_MBUF_FLAG`` macro) will be
+  removed in v18.05. The packet mbuf API should be used as a
+  replacement.
+
+* mbuf: The mbuf flags ``PKT_TX_VLAN_PKT`` and ``PKT_TX_QINQ_PKT`` are
+  respectively renamed as ``PKT_TX_VLAN`` and ``PKT_TX_QINQ``. The old
+  names will be removed in v18.08.