X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=56f766663bfbb42994231f1d49898199e38e41f9;hb=4c2128edeeac151ed01c5a674f1bae8423ed79e2;hp=1a3831fac9bb5c5678489ca2db3da0ea9f68fd55;hpb=2f45703c17acb943aaded9f79676fd56a72542b2;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 1a3831fac9..56f766663b 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -8,52 +8,54 @@ API and ABI deprecation notices are to be posted here. Deprecation Notices ------------------- -* The ethdev library file will be renamed from libethdev.* to librte_ethdev.* - in release 16.11 in order to have a more consistent namespace. - -* In 16.11 ABI changes are planned: the ``rte_eth_dev`` structure will be - extended with new function pointer ``tx_pkt_prep`` 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. - -* The ethdev hotplug API is going to be moved to EAL with a notification - mechanism added to crypto and ethdev libraries so that hotplug is now - available to both of them. This API will be stripped of the device arguments - so that it only cares about hotplugging. - -* Structures embodying pci and vdev devices are going to be reworked to - integrate new common rte_device / rte_driver objects (see - http://dpdk.org/ml/archives/dev/2016-January/031390.html). - ethdev and crypto libraries will then only handle those objects so that they - do not need to care about the kind of devices that are being used, making it - easier to add new buses later. - -* ABI changes are planned for 16.11 in the ``rte_mbuf`` structure: some fields +* 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.05. + +* ``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``. + +* 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. + +* ABI changes are planned for 17.05 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. + ``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 in 16.07 and will be removed in 16.11. + their behavior will be kept until 17.02 and will be removed in 17.05. * mempool: The functions ``rte_mempool_count`` and ``rte_mempool_free_count`` - will be removed in 17.02. + will be removed in 17.05. 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. + and will be removed in 17.05. It is replaced by ``rte_mempool_generic_get/put`` functions. -* The vhost-cuse will be removed in 16.11. Since v2.1, a large majority of - development effort has gone to vhost-user, such as multiple-queue, live - migration, reconnect etc. Therefore, vhost-user should be used instead. - -* API will change for ``rte_port_source_params`` and ``rte_port_sink_params`` - structures. The member ``file_name`` data type will be changed from - ``char *`` to ``const char *``. This change targets release 16.11. +* 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. + +* distributor: library API will be changed to incorporate a burst-oriented + API. This will include a change to ``rte_distributor_create`` + to specify which type of instance to create (single or burst), and + additional calls for ``rte_distributor_poll_pkt_burst`` and + ``rte_distributor_return_pkt_burst``, among others. + +* The architecture TILE-Gx and the associated mpipe driver are not + maintained and will be removed in 17.05.