doc: update devargs changes planned in 17.11
[dpdk.git] / doc / guides / rel_notes / deprecation.rst
index f0b5329..c7fce52 100644 (file)
@@ -8,40 +8,38 @@ API and ABI deprecation notices are to be posted here.
 Deprecation Notices
 -------------------
 
-* 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
-  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``.
-
-* 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``
-  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
-  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.
+* eal: the following functions are deprecated starting from 17.05 and will
+  be removed in 17.11:
+
+  - ``rte_set_log_level``, replaced by ``rte_log_set_global_level``
+  - ``rte_get_log_level``, replaced by ``rte_log_get_global_level``
+  - ``rte_set_log_type``, replaced by ``rte_log_set_level``
+  - ``rte_get_log_type``, replaced by ``rte_log_get_level``
+
+* eal: several API and ABI changes are planned for ``rte_devargs`` in v17.11.
+  The format of device command line parameters will change. The bus will need
+  to be explicitly stated in the device declaration. The enum ``rte_devtype``
+  was used to identify a bus and will disappear.
+  The structure ``rte_devargs`` will change.
+  The ``rte_devargs_list`` will be made private.
+  The following functions are deprecated starting from 17.08 and will either be
+  modified or removed in 17.11:
+
+  - ``rte_eal_devargs_add``
+  - ``rte_eal_devargs_type_count``
+  - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
 
 * 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.08 and will be removed in 17.11.
 
-* mempool: The functions ``rte_mempool_count`` and ``rte_mempool_free_count``
-  will be removed in 17.05.
-  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.05.
-  It is replaced by ``rte_mempool_generic_get/put`` functions.
+* 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: the legacy filter API, including
   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
@@ -50,3 +48,14 @@ 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.
+
+* librte_table: The ``key_mask`` parameter will be added to all the hash tables
+  that currently do not have it, as well as to the hash compute function prototype.
+  The non-"do-sig" versions of the hash tables will be removed
+  (including the ``signature_offset`` parameter)
+  and the "do-sig" versions renamed accordingly.
+
+* cryptodev: the following function is deprecated starting from 17.08 and will
+  be removed in 17.11:
+
+  - ``rte_cryptodev_create_vdev``