doc: announce API change for mempool IOVA populate

[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 f545801..dfcca87 100644 (file)
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -44,6 +44,11 @@ Deprecation Notices
   structure would be made internal (or removed if all dependencies are cleared)
   in future releases.
 
   structure would be made internal (or removed if all dependencies are cleared)
   in future releases.
 

+* mempool: starting from v20.05, the API of rte_mempool_populate_iova()
+  and rte_mempool_populate_virt() will change to return 0 instead
+  of -EINVAL when there is not enough room to store one object. The ABI
+  will be preserved until 20.11.
+

 * ethdev: the legacy filter API, including
   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
 * ethdev: the legacy filter API, including
   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,


@@ -59,30 +64,14 @@ Deprecation Notices
   - ``rte_eth_dev_stop``
   - ``rte_eth_dev_close``
 
   - ``rte_eth_dev_stop``
   - ``rte_eth_dev_close``
 

-* ethdev: New offload flags ``DEV_RX_OFFLOAD_RSS_HASH`` and
-  ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.
+* ethdev: New offload flags ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11.

   This will allow application to enable or disable PMDs from updating
   This will allow application to enable or disable PMDs from updating

-  ``rte_mbuf::hash::rss`` and ``rte_mbuf::hash::fdir`` respectively.
+  ``rte_mbuf::hash::fdir``.

   This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on Rx and
   thereby improve Rx performance if application wishes do so.
   This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on Rx and
   thereby improve Rx performance if application wishes do so.

-  In 19.11 PMDs will still update the fields even when the offloads are not
+  In 19.11 PMDs will still update the field even when the offload is not

   enabled.
 
   enabled.
 

-* ethdev: New function ``rte_eth_dev_set_supported_ptypes`` will be added in
-  19.11.
-  This will allow application to request PMD to set specific ptypes defined
-  through ``rte_eth_dev_set_supported_ptypes`` in ``rte_mbuf::packet_type``.
-  If application doesn't want any ptype information it can call
-  ``rte_eth_dev_set_supported_ptypes(ethdev_id, RTE_PTYPE_UNKNOWN)`` and PMD
-  will set ``rte_mbuf::packet_type`` to ``0``.
-  If application doesn't call ``rte_eth_dev_set_supported_ptypes`` PMD can
-  return ``rte_mbuf::packet_type`` with ``rte_eth_dev_get_supported_ptypes``.
-  If application is interested only in L2/L3 layer, it can inform the PMD
-  to update ``rte_mbuf::packet_type`` with L2/L3 ptype by calling
-  ``rte_eth_dev_set_supported_ptypes(ethdev_id, RTE_PTYPE_L2_MASK | RTE_PTYPE_L3_MASK)``.
-  This scheme will allow PMDs to avoid lookup to internal ptype table on Rx and
-  thereby improve Rx performance if application wishes do so.
-

 * cryptodev: support for using IV with all sizes is added, J0 still can
   be used but only when IV length in following structs ``rte_crypto_auth_xform``,
   ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or equal
 * cryptodev: support for using IV with all sizes is added, J0 still can
   be used but only when IV length in following structs ``rte_crypto_auth_xform``,
   ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or equal