X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=1438c777b4f66a818b979d2dffddc5c793b2e69c;hb=4ec6960aec264172ac22f89c31ec4b43234bb264;hp=867c2821b1775c9360078d77228ccc4b469e2c72;hpb=648e6b3815a35011291025a1363baba0aef41376;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 867c2821b1..1438c777b4 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -8,28 +8,74 @@ API and ABI deprecation notices are to be posted here. Deprecation Notices ------------------- -* The following fields have been deprecated in rte_eth_stats: - ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss, - tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff - -* ABI changes is planned for the reta field in struct rte_eth_rss_reta_entry64 - which handles at most 256 entries (8 bits) while newer NICs support larger - tables (512 entries). - It should be integrated in release 2.3. - -* ABI changes are planned for struct rte_eth_fdir_flow in order to support - extend flow director's input set. The release 2.2 does not contain these ABI - changes, but release 2.3 will, and no backwards compatibility is planned. - -* The scheduler statistics structure will change to allow keeping track of - RED actions. - -* librte_pipeline: The prototype for the pipeline input port, output port - and table action handlers will be updated: - the pipeline parameter will be added, the packets mask parameter will be - either removed (for input port action handler) or made input-only. - -* ABI changes are planned in cmdline buffer size to allow the use of long - commands (such as RETA update in testpmd). This should impact - CMDLINE_PARSE_RESULT_BUFSIZE, STR_TOKEN_SIZE and RDLINE_BUF_SIZE. - It should be integrated in release 2.3. +* 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. + +* 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. + +* ``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``. + +* 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. + +* 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. + +* 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. + +* ethdev: for 17.02 it is planned to deprecate the following five functions + and move them in ixgbe: + + ``rte_eth_dev_set_vf_rxmode`` + + ``rte_eth_dev_set_vf_rx`` + + ``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. + +* 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, + HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in + PMDs that implement the latter. + Target release for removal of the legacy API will be defined once most + PMDs have switched to rte_flow.