X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=b47c8c2540c280225e0f5a01c77ca2a67af621f3;hb=e9f3849a291a15ef30d2fa37ad89ea1207b240ca;hp=d4aea4b4634e471d985d2cef58e0fa22d1694b88;hpb=5d3f72100904b5a2fc6b240e1cc10f1c2dd02267;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index d4aea4b463..b47c8c2540 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -11,11 +11,11 @@ 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. +* 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. @@ -31,6 +31,10 @@ Deprecation Notices + ``rte_eal_devargs_type_count`` +* 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: @@ -44,13 +48,6 @@ Deprecation Notices structure would be made internal (or removed if all dependencies are cleared) in future releases. -* 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()`` - can no longer be mutually exclusive with ``RTE_MBUF_DIRECT()`` if the new - experimental API ``rte_pktmbuf_attach_extbuf()`` is used. Removal of the macro - is to fix this semantic inconsistency. - * ethdev: the legacy filter API, including ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR, @@ -59,27 +56,29 @@ 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. +* 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. + +* 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. + + - Member ``uint64_t ff_disable`` in ``rte_cryptodev_config`` + + The field would be added in v19.08. + +* cryptodev: the ``uint8_t *data`` member of ``key`` structure in the xforms + structure (``rte_crypto_cipher_xform``, ``rte_crypto_auth_xform``, and + ``rte_crypto_aead_xform``) will be changed to ``const uint8_t *data``.