doc: postpone API change in ethdev

[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 f0b5329..d2a6f82 100644 (file)
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -8,18 +8,48 @@ API and ABI deprecation notices are to be posted here.
 Deprecation Notices
 -------------------
 
+* ring: Changes are planned to rte_ring APIs in release 17.05. Proposed
+  changes include:
+
+    - Removing build time options for the ring:
+      CONFIG_RTE_RING_SPLIT_PROD_CONS
+      CONFIG_RTE_RING_PAUSE_REP_COUNT
+    - Adding an additional parameter to enqueue functions to return the
+      amount of free space in the ring
+    - Adding an additional parameter to dequeue functions to return the
+      number of remaining elements in the ring
+    - Removing direct support for watermarks in the rings, since the
+      additional return value from the enqueue function makes it
+      unneeded
+    - Adjusting the return values of the bulk() enq/deq functions to
+      make them consistent with the burst() equivalents. [Note, parameter
+      to these functions are changing too, per points above, so compiler
+      will flag them as needing update in legacy code]
+    - Updates to some library functions e.g. rte_ring_get_memsize() to
+      allow for variably-sized ring elements.
+
 * igb_uio: iomem mapping and sysfs files created for iomem and ioport in
   igb_uio will be removed, because we are able to detect these from what Linux
   has exposed, like the way we have done with uio-pci-generic. This change
   targets release 17.05.
 
-* ``eth_driver`` is planned to be removed in 17.02. This currently serves as
+* vfio: Some functions are planned to be exported outside librte_eal in 17.05.
+  VFIO APIs like ``vfio_setup_device``, ``vfio_get_group_fd`` can be used by
+  subsystem other than EAL/PCI. For that, these need to be exported symbols.
+  Such APIs are planned to be renamed according to ``rte_*`` naming convention
+  and exported from librte_eal.
+
+* The PCI and VDEV subsystems will be converted as drivers of the new bus model.
+  It will imply some EAL API changes in 17.05.
+
+* ``eth_driver`` is planned to be removed in 17.05. This currently serves as
   a placeholder for PMDs to register themselves. Changes for ``rte_bus`` will
   provide a way to handle device initialization currently being done in
-  ``eth_driver``.
+  ``eth_driver``. Similarly, ``rte_pci_driver`` is planned to be removed from
+  ``rte_cryptodev_driver`` in 17.05.
 
-* ethdev: an API change is planned for 17.02 for the function
-  ``_rte_eth_dev_callback_process``. In 17.02 the function will return an ``int``
+* ethdev: An API change is planned for 17.05 for the function
+  ``_rte_eth_dev_callback_process``. In 17.05 the function will return an ``int``
   instead of ``void`` and a fourth parameter ``void *ret_param`` will be added.
 
 * ABI changes are planned for 17.05 in the ``rte_mbuf`` structure: some fields
@@ -50,3 +80,12 @@ Deprecation Notices
   PMDs that implement the latter.
   Target release for removal of the legacy API will be defined once most
   PMDs have switched to rte_flow.
+
+* distributor: library API will be changed to incorporate a burst-oriented
+  API. This will include a change to ``rte_distributor_create``
+  to specify which type of instance to create (single or burst), and
+  additional calls for ``rte_distributor_poll_pkt_burst`` and
+  ``rte_distributor_return_pkt_burst``, among others.
+
+* The architecture TILE-Gx and the associated mpipe driver are not
+  maintained and will be removed in 17.05.