doc: announce eventdev ABI change to support DLB PMD
[dpdk.git] / doc / guides / rel_notes / deprecation.rst
index ea4cfa7..86a1ecb 100644 (file)
@@ -11,6 +11,13 @@ here.
 Deprecation Notices
 -------------------
 
+* make: Support for building DPDK with "make" has been deprecated and
+  support will be removed in the 20.11 release. From 20.11 onwards, DPDK
+  should be built using meson and ninja. For basic instructions see the
+  `Quick-start Guide <https://core.dpdk.org/doc/quick-start/>`_ on the
+  website or the `Getting Started Guide
+  <https://doc.dpdk.org/guides/linux_gsg/build_dpdk.html>`_ document.
+
 * meson: The minimum supported version of meson for configuring and building
   DPDK will be increased to v0.47.1 (from 0.41) from DPDK 19.05 onwards. For
   those users with a version earlier than 0.47.1, an updated copy of meson
@@ -67,6 +74,24 @@ Deprecation Notices
   us extending existing enum/define.
   One solution can be using a fixed size array instead of ``.*MAX.*`` value.
 
+* pci: The PCI resources map API (``pci_map_resource`` and
+  ``pci_unmap_resource``) was not abstracting the Unix mmap flags (see the
+  workaround for Windows support implemented in the commit
+  9d2b24593724 ("pci: keep API compatibility with mmap values")).
+  This API will be removed from the public API in 20.11 and moved to the PCI
+  bus driver along with the PCI resources lists and associated structures
+  (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
+  ``mapped_pci_res_list``).
+  With this removal, there won't be a need for the mentioned workaround which
+  will be reverted.
+
+* pci: The ``rte_kernel_driver`` enum defined in rte_dev.h will be made private
+  to the PCI subsystem as it is used only by the PCI bus driver and PCI
+  drivers.
+  The associated field ``kdrv`` in the ethdev ``rte_eth_dev_data`` structure
+  will be removed as it gave no useful abstracted information to the
+  applications and had no user (neither internal nor external).
+
 * ethdev: Split the ``struct eth_dev_ops`` struct to hide it as much as possible
   will be done in 20.11.
   Currently the ``struct eth_dev_ops`` struct is accessible by the application
@@ -126,6 +151,26 @@ Deprecation Notices
   to one it means it represents IV, when is set to zero it means J0 is used
   directly, in this case 16 bytes of J0 need to be passed.
 
+* eventdev: Following structures will be modified to support DLB PMD
+  and future extensions:
+
+  - ``rte_event_dev_info``
+  - ``rte_event_dev_config``
+  - ``rte_event_port_conf``
+
+  Patches containing justification, documentation, and proposed modifications
+  can be found at:
+
+  - https://patches.dpdk.org/patch/71457/
+  - https://patches.dpdk.org/patch/71456/
+
+* rawdev: The rawdev APIs which take a device-specific structure as
+  parameter directly, or indirectly via a "private" pointer inside another
+  structure, will be modified to take an additional parameter of the
+  structure size. The affected APIs will include ``rte_rawdev_info_get``,
+  ``rte_rawdev_configure``, ``rte_rawdev_queue_conf_get`` and
+  ``rte_rawdev_queue_setup``.
+
 * sched: To allow more traffic classes, flexible mapping of pipe queues to
   traffic classes, and subport level configuration of pipes and queues
   changes will be made to macros, data structures and API functions defined