Deprecation Notices
-------------------
-* igb_uio: iomem mapping and sysfs files created for iomem and ioport in
- igb_uio will be removed, because we are able to detect these from what Linux
- has exposed, like the way we have done with uio-pci-generic. This change
- targets release 17.02.
+* eal: both declaring and identifying devices will be streamlined in v18.05.
+ 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.
-* ABI/API changes are planned for 17.02: ``rte_device``, ``rte_driver`` will be
- impacted because of introduction of a new ``rte_bus`` hierarchy. This would
- also impact the way devices are identified by EAL. A bus-device-driver model
- will be introduced providing a hierarchical view of devices.
+ - removal of ``name`` and ``args`` fields.
+ - The enum ``rte_devtype`` was used to identify a bus and will disappear.
+ - Functions previously deprecated will change or disappear:
-* ``eth_driver`` is planned to be removed in 17.02. This currently serves as
- a placeholder for PMDs to register themselves. Changes for ``rte_bus`` will
- provide a way to handle device initialization currently being done in
- ``eth_driver``.
+ + ``rte_eal_devargs_type_count``
+ + ``rte_eal_devargs_parse`` will change its format and use.
-* In 17.02 ABI changes are planned: the ``rte_eth_dev`` structure will be
- extended with new function pointer ``tx_pkt_prepare`` allowing verification
- and processing of packet burst to meet HW specific requirements before
- transmit. Also new fields will be added to the ``rte_eth_desc_lim`` structure:
- ``nb_seg_max`` and ``nb_mtu_seg_max`` providing information about number of
- segments limit to be transmitted by device for TSO/non-TSO packets.
+* pci: Several exposed functions are misnamed.
+ The following functions are deprecated starting from v17.11 and are replaced:
-* In 17.02 ABI change is planned: the ``rte_eth_dev_info`` structure
- will be extended with a new member ``fw_version`` in order to store
- the NIC firmware version.
+ - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
+ - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
+ - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
-* ethdev: an API change is planned for 17.02 for the function
- ``_rte_eth_dev_callback_process``. In 17.02 the function will return an ``int``
- instead of ``void`` and a fourth parameter ``void *ret_param`` will be added.
+* eal: a new set of mbuf mempool ops name APIs for user, platform and best
+ mempool names have been defined in ``rte_mbuf`` in v18.02. The uses of
+ ``rte_eal_mbuf_default_mempool_ops`` shall be replaced by
+ ``rte_mbuf_best_mempool_ops``.
+ The following function is now redundant and it is target to be deprecated
+ in 18.05:
-* ethdev: for 17.02 it is planned to deprecate the following five functions
- and move them in ixgbe:
+ - ``rte_eal_mbuf_default_mempool_ops``
- ``rte_eth_dev_set_vf_rxmode``
+* 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.
- ``rte_eth_dev_set_vf_rx``
+* 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.
- ``rte_eth_dev_set_vf_tx``
-
- ``rte_eth_dev_set_vf_vlan_filter``
-
- ``rte_eth_set_vf_rate_limit``
-
-* ABI changes are planned for 17.02 in the ``rte_mbuf`` structure: some fields
- may be reordered to facilitate the writing of ``data_off``, ``refcnt``, and
- ``nb_segs`` in one operation, because some platforms have an overhead if the
- store address is not naturally aligned. Other mbuf fields, such as the
- ``port`` field, may be moved or removed as part of this mbuf work. A
- ``timestamp`` will also be added.
-
-* The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and
- are respectively replaced by PKT_RX_VLAN_STRIPPED and
- PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
- their behavior will be kept until 16.11 and will be removed in 17.02.
-
-* mempool: The functions ``rte_mempool_count`` and ``rte_mempool_free_count``
- will be removed in 17.02.
- They are replaced by ``rte_mempool_avail_count`` and
- ``rte_mempool_in_use_count`` respectively.
-
-* mempool: The functions for single/multi producer/consumer are deprecated
- and will be removed in 17.02.
- It is replaced by ``rte_mempool_generic_get/put`` functions.
+ In later releases the old offloading API will be deprecated, which will include:
+ - 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.
* ethdev: the legacy filter API, including
``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
PMDs that implement the latter.
Target release for removal of the legacy API will be defined once most
PMDs have switched to rte_flow.
+
+* 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: The following changes will be made in the library
+ for 18.08:
+
+ - Removal of ``sym`` structure in ``rte_cryptodev_info`` structure,
+ containing fields not relevant anymore since the session mempool
+ is not internal in the crypto device anymore.
+ - Replacement of ``pci_dev`` field with the more generic ``rte_device``
+ structure.
+ - Functions ``rte_cryptodev_queue_pair_attach_sym_session()`` and
+ ``rte_cryptodev_queue_pair_dettach_sym_session()`` will be deprecated from
+ 18.05 and removed in 18.08, as there are no drivers doing anything useful
+ with them.
+ - Functions ``rte_cryptodev_queue_pair_start()`` and
+ ``rte_cryptodev_queue_pair_stop()`` will be deprecated from 18.05
+ and removed in 18.08, as there are no drivers doing anything useful
+ with them.
+ - Some feature flags such as ``RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER`` are ambiguous,
+ so some will be replaced by more explicit flags.
+ - Function ``rte_cryptodev_get_header_session_size()`` will be deprecated
+ in 18.05, and it gets replaced with ``rte_cryptodev_sym_get_header_session_size()``.
+ It will be removed in 18.08.
+ - Function ``rte_cryptodev_get_private_session_size()`` will be deprecated
+ in 18.05, and it gets replaced with ``rte_cryptodev_sym_get_private_session_size()``.
+ It will be removed in 18.08.
git.droids-corp.org / dpdk.git / blobdiff