summaryrefslogtreecommitdiffstats
path: root/doc/guides/rel_notes/deprecation.rst
diff options
context:
space:
mode:
authorLuca Boccassi <luca.boccassi@gmail.com>2018-11-27 10:44:39 +0000
committerLuca Boccassi <luca.boccassi@gmail.com>2018-11-27 10:45:47 +0000
commita4f0fa29488e582ab8b5ef9db475b3d26ded690c (patch)
treede163f35a726d518a3f93ab6ee4ac25b8982635d /doc/guides/rel_notes/deprecation.rst
parent29058550643267a554e0368806dece63b047c5cb (diff)
New upstream version 18.11upstream/18.11upstream
Change-Id: I6c63198045de1e34fda8a7b4665d89d5f4a20d20 Signed-off-by: Luca Boccassi <luca.boccassi@gmail.com>
Diffstat (limited to 'doc/guides/rel_notes/deprecation.rst')
-rw-r--r--doc/guides/rel_notes/deprecation.rst50
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 34b28234..b48486d3 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -11,6 +11,20 @@ API and ABI deprecation notices are to be posted here.
Deprecation Notices
-------------------
+* linux: Linux kernel version 3.2 (which is the current minimum required
+ version for the DPDK) is not maintained anymore. Therefore the planned
+ minimum required kernel version for DPDK 19.02 will be the next oldest
+ Long Term Stable (LTS) version which is 3.16, but compatibility for
+ recent distribution kernels will be kept.
+
+* kvargs: The function ``rte_kvargs_process`` will get a new parameter
+ for returning key match count. It will ease handling of no-match case.
+
+* eal: function ``rte_bsf64`` in ``rte_bitmap.h`` has been renamed to
+ ``rte_bsf64_safe`` and moved to ``rte_common.h``. A new ``rte_bsf64`` function
+ will be added in the next release in ``rte_common.h`` that follows convention
+ set by existing ``rte_bsf32`` function.
+
* eal: both declaring and identifying devices will be streamlined in v18.11.
New functions will appear to query a specific port from buses, classes of
device and device drivers. Device declaration will be made coherent with the
@@ -29,11 +43,22 @@ Deprecation Notices
- ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
- ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
+* dpaa2: removal of ``rte_dpaa2_memsegs`` structure which has been replaced
+ by a pa-va search library. This structure was earlier being used for holding
+ memory segments used by dpaa2 driver for faster pa->va translation. This
+ structure would be made internal (or removed if all dependencies are cleared)
+ in future releases.
+
* mbuf: The opaque ``mbuf->hash.sched`` field will be updated to support generic
definition in line with the ethdev TM and MTR APIs. Currently, this field
is defined in librte_sched in a non-generic way. The new generic format
will contain: queue ID, traffic class, color. Field size will not change.
+* sched: Some API functions will change prototype due to the above
+ deprecation note for mbuf->hash.sched, e.g. ``rte_sched_port_pkt_write()``
+ and ``rte_sched_port_pkt_read()`` will likely have an additional parameter
+ of type ``struct rte_sched_port``.
+
* mbuf: the macro ``RTE_MBUF_INDIRECT()`` will be removed in v18.08 or later and
replaced with ``RTE_MBUF_CLONED()`` which is already added in v18.05. As
``EXT_ATTACHED_MBUF`` is newly introduced in v18.05, ``RTE_MBUF_INDIRECT()``
@@ -49,6 +74,31 @@ Deprecation Notices
Target release for removal of the legacy API will be defined once most
PMDs have switched to rte_flow.
+* ethdev: Maximum and minimum MTU values vary between hardware devices. In
+ hardware agnostic DPDK applications access to such information would allow
+ a more accurate way of validating and setting supported MTU values on a per
+ device basis rather than using a defined default for all devices. To
+ resolve this, the following members will be added to ``rte_eth_dev_info``.
+ Note: these can be added to fit a hole in the existing structure for amd64
+ but not for 32-bit, as such ABI change will occur as size of the structure
+ will increase.
+
+ - Member ``uint16_t min_mtu`` the minimum MTU allowed.
+ - Member ``uint16_t max_mtu`` the maximum MTU allowed.
+
+* security: New field ``uint64_t opaque_data`` is planned to be added into
+ ``rte_security_session`` structure. That would allow upper layer to easily
+ associate/de-associate some user defined data with the security session.
+
+* cryptodev: several API and ABI changes are planned for rte_cryptodev
+ in v19.02:
+
+ - The size and layout of ``rte_cryptodev_sym_session`` will change
+ to fix existing issues.
+ - The size and layout of ``rte_cryptodev_qp_conf`` and syntax of
+ ``rte_cryptodev_queue_pair_setup`` will change to to allow to use
+ two different mempools for crypto and device private sessions.
+
* pdump: As we changed to use generic IPC, some changes in APIs and structure
are expected in subsequent release.