+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright 2018 The DPDK contributors
+
ABI and API Deprecation
=======================
Deprecation Notices
-------------------
-* eal: both declaring and identifying devices will be streamlined in v18.05.
+* 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
+ can be got using the ``pip``, or ``pip3``, tool for downloading python
+ packages.
+
+* 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: 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
new scheme of device identification.
As such, ``rte_devargs`` device representation will change.
- - removal of ``name`` and ``args`` fields.
- The enum ``rte_devtype`` was used to identify a bus and will disappear.
- - The ``rte_devargs_list`` will be made private.
- Functions previously deprecated will change or disappear:
- + ``rte_eal_devargs_add``
+ ``rte_eal_devargs_type_count``
- + ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
- + ``rte_eal_devargs_parse`` will change its format and use.
- + all ``rte_devargs`` related functions will be renamed, changing the
- ``rte_eal_devargs_`` prefix to ``rte_devargs_``.
+
+* vfio: removal of ``rte_vfio_dma_map`` and ``rte_vfio_dma_unmap`` APIs which
+ have been replaced with ``rte_dev_dma_map`` and ``rte_dev_dma_unmap``
+ functions. The due date for the removal targets DPDK 20.02.
* pci: Several exposed functions are misnamed.
The following functions are deprecated starting from v17.11 and are replaced:
- ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
- ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
-* eal: The semantics of the return value for the ``rte_lcore_has_role`` function
- are planned to change in v18.05. The function currently returns 0 and <0 for
- success and failure, respectively. This will change to 1 and 0 for true and
- false, respectively, to make use of the function more intuitive.
-
-* eal: new ``numa_node_count`` member will be added to ``rte_config`` structure
- in v18.05.
-
-* ethdev: a new Tx and Rx offload API was introduced on 17.11.
- In the new API, offloads are divided into per-port and per-queue offloads.
- Offloads are disabled by default and enabled per application request.
- The old offloads API is target to be deprecated on 18.05. This includes:
-
- - removal of ``ETH_TXQ_FLAGS_NO*`` flags.
- - removal of ``txq_flags`` field from ``rte_eth_txconf`` struct.
- - removal of the offloads bit-field from ``rte_eth_rxmode`` struct.
+* 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.
* ethdev: the legacy filter API, including
``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
Target release for removal of the legacy API will be defined once most
PMDs have switched to rte_flow.
-* i40e: The default flexible payload configuration which extracts the first 16
- bytes of the payload for RSS will be deprecated starting from 18.02. If
- required the previous behavior can be configured using existing flow
- director APIs. There is no ABI/API break. This change will just remove a
- global configuration setting and require explicit configuration.
+* kni: remove KNI ethtool support. To clarify, this is not to remove the KNI,
+ but only to remove ethtool support of it that is disabled by default and
+ can be enabled via ``CONFIG_RTE_KNI_KMOD_ETHTOOL`` config option.
+ Existing KNI ethtool implementation is only supported by ``igb`` & ``ixgbe``
+ drivers, by using a copy of kernel drivers in DPDK. This model cannot be
+ extended to all drivers in DPDK and it is too much effort to maintain
+ kernel modules in DPDK. As a result users won't be able to use ``ethtool``
+ via ``igb`` & ``ixgbe`` anymore.
+
+* meter: New ``rte_color`` definition will be added in 19.02 and that will
+ replace ``enum rte_meter_color`` in meter library in 19.05. This will help
+ to consolidate color definition, which is currently replicated in many places,
+ such as: rte_meter.h, rte_mtr.h, rte_tm.h.
+
+* crypto/aesni_mb: the minimum supported intel-ipsec-mb library version will be
+ changed from 0.49.0 to 0.52.0.
+
+* cryptodev: New member in ``rte_cryptodev_config`` to allow applications to
+ disable features supported by the crypto device. Only the following features
+ would be allowed to be disabled this way,
+
+ - ``RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO``
+ - ``RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO``
+ - ``RTE_CRYPTODEV_FF_SECURITY``
+
+ Disabling unused features would facilitate efficient usage of HW/SW offload.
-* librte_meter: The API will change to accommodate configuration profiles.
- Most of the API functions will have an additional opaque parameter.
+ - Member ``uint64_t ff_disable`` in ``rte_cryptodev_config``
-* ring: The alignment constraints on the ring structure will be relaxed
- to one cache line instead of two, and an empty cache line padding will
- be added between the producer and consumer structures. The size of the
- structure and the offset of the fields will remain the same on
- platforms with 64B cache line, but will change on other platforms.
+ The field would be added in v19.08.
git.droids-corp.org / dpdk.git / blobdiff