X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=37b8592b6834d283ca0d11c4ac29c534aa1d2b0f;hb=186b14d6850654eb84a8ae9ea29b736f0ba5e093;hp=27ede77f02be3ae66c20db3da76a50512db19696;hpb=799e4d9fa82bbd65991260c32cdf1b05f90ba4a4;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 27ede77f02..37b8592b68 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -11,13 +11,17 @@ API and ABI deprecation notices are to be posted here. Deprecation Notices ------------------- +* 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: 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: The function ``rte_eal_remote_launch`` will return new error codes + after read or write error on the pipe, instead of calling ``rte_panic``. * 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 @@ -30,6 +34,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: @@ -43,18 +51,6 @@ Deprecation Notices 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. - -* 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, @@ -63,21 +59,22 @@ 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. - -* pdump: As we changed to use generic IPC, some changes in APIs and structure - are expected in subsequent release. - - - ``rte_pdump_set_socket_dir`` will be removed; - - The parameter, ``path``, of ``rte_pdump_init`` will be removed; - - The enum ``rte_pdump_socktype`` will be removed. +* cryptodev: support for using IV with all sizes is added, J0 still can + be used but only when IV length in following structs ``rte_crypto_auth_xform``, + ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or equal + 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. + +* 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 + in "rte_sched.h". These changes are aligned to improvements suggested in the + RFC https://mails.dpdk.org/archives/dev/2018-November/120035.html. + +* metrics: The function ``rte_metrics_init`` will have a non-void return + in order to notify errors instead of calling ``rte_exit``. + +* power: ``rte_power_set_env`` function will no longer return 0 on attempt + to set new power environment if power environment was already initialized. + In this case the function will return -1 unless the environment is unset first + (using ``rte_power_unset_env``). Other function usage scenarios will not change.