doc: announce crypto device type enumeration removal
[dpdk.git] / doc / guides / rel_notes / deprecation.rst
index efbccb0..978c950 100644 (file)
@@ -16,51 +16,29 @@ Deprecation Notices
   - ``rte_set_log_type``, replaced by ``rte_log_set_level``
   - ``rte_get_log_type``, replaced by ``rte_log_get_level``
 
-* 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.
+* devargs: An ABI change is planned for 17.08 for the structure ``rte_devargs``.
+  The current version is dependent on bus-specific device identifier, which will
+  be made generic and abstracted, in order to make the EAL bus-agnostic.
+
+  Accompanying this evolution, device command line parameters will thus support
+  explicit bus definition in a device declaration.
 
 * 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.
 
-* 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.
+* The VDEV subsystem will be converted as driver of the new bus model.
+  It may imply some EAL API changes in 17.08.
 
-* ``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``. Similarly, ``rte_pci_driver`` is planned to be removed from
-  ``rte_cryptodev_driver`` in 17.05.
+* The struct ``rte_pci_driver`` is planned to be removed from
+  ``rte_cryptodev_driver`` and ``rte_eventdev_driver`` in 17.08.
 
-* 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``
+* ethdev: An API change is planned for 17.08 for the function
+  ``_rte_eth_dev_callback_process``. In 17.08 the function will return an ``int``
   instead of ``void`` and a fourth parameter ``void *ret_param`` will be added.
 
-* ethdev: for 17.05 it is planned to deprecate the following nine rte_eth_dev_*
+* ethdev: for 17.08 it is planned to deprecate the following nine rte_eth_dev_*
   functions and move them into the ixgbe PMD:
 
   ``rte_eth_dev_bypass_init``, ``rte_eth_dev_bypass_state_set``,
@@ -86,7 +64,14 @@ Deprecation Notices
 * 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 17.02 and will be removed in 17.05.
+  their behavior will be kept until 17.05 and will be removed in 17.08.
+
+* ethdev: Tx offloads will no longer be enabled by default in 17.08.
+  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: the legacy filter API, including
   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
@@ -96,17 +81,19 @@ Deprecation Notices
   Target release for removal of the legacy API will be defined once most
   PMDs have switched to rte_flow.
 
-* ABI changes are planned for 17.05 in the ``rte_cryptodev_ops`` structure.
-  A pointer to a rte_cryptodev_config structure will be added to the
-  function prototype ``cryptodev_configure_t``, as a new parameter.
+* cryptodev: All PMD names definitions will be moved to the individual PMDs
+  in 17.08.
+
+* cryptodev: The following changes will be done in in 17.08:
+
+  - the device type enumeration ``rte_cryptodev_type`` will be removed
+  - the following structures will be changed: ``rte_cryptodev_session``,
+    ``rte_cryptodev_sym_session``, ``rte_cryptodev_info``, ``rte_cryptodev``
+  - the function ``rte_cryptodev_count_devtype`` will be replaced by
+    ``rte_cryptodev_device_count_by_driver``
 
-* cryptodev: A new parameter ``max_nb_sessions_per_qp`` will be added to
-  ``rte_cryptodev_info.sym``. Some drivers may support limited number of
-  sessions per queue_pair. With this new parameter application will know
-  how many sessions can be mapped to each queue_pair of a device.
+* crypto/scheduler: the following two functions are deprecated starting
+  from 17.05 and will be removed in 17.08:
 
-* 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.
+  - ``rte_crpytodev_scheduler_mode_get``, replaced by ``rte_cryptodev_scheduler_mode_get``
+  - ``rte_crpytodev_scheduler_mode_set``, replaced by ``rte_cryptodev_scheduler_mode_set``