X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=d6544ed0abeb918f840e37539ca1be7a7bb0a49a;hb=eb4562714f9fd9e284977207eb1a78066dc4b9f8;hp=82d1ce5e503a3dbbd647d3cd6fb2fb3bf90d04c0;hpb=c1f07dd16d7e825659fcc781676c77040eaf45eb;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 82d1ce5e50..d6544ed0ab 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -33,6 +33,12 @@ Deprecation Notices has exposed, like the way we have done with uio-pci-generic. This change targets release 17.05. +* vfio: Some functions are planned to be exported outside librte_eal in 17.05. + VFIO APIs like ``vfio_setup_device``, ``vfio_get_group_fd`` can be used by + subsystem other than EAL/PCI. For that, these need to be exported symbols. + Such APIs are planned to be renamed according to ``rte_*`` naming convention + and exported from librte_eal. + * The PCI and VDEV subsystems will be converted as drivers of the new bus model. It will imply some EAL API changes in 17.05. @@ -42,10 +48,33 @@ Deprecation Notices ``eth_driver``. Similarly, ``rte_pci_driver`` is planned to be removed from ``rte_cryptodev_driver`` in 17.05. -* 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`` +* ethdev: An API change is planned for 17.05 for the function + ``_rte_eth_dev_callback_process``. In 17.05 the function will return an ``int`` instead of ``void`` and a fourth parameter ``void *ret_param`` will be added. +* ethdev: for 17.05 it is planned to deprecate the following nine rte_eth_dev_* + functions and move them into the ixgbe PMD: + + ``rte_eth_dev_bypass_init``, ``rte_eth_dev_bypass_state_set``, + ``rte_eth_dev_bypass_state_show``, ``rte_eth_dev_bypass_event_store``, + ``rte_eth_dev_bypass_event_show``, ``rte_eth_dev_wd_timeout_store``, + ``rte_eth_dev_bypass_wd_timeout_show``, ``rte_eth_dev_bypass_ver_show``, + ``rte_eth_dev_bypass_wd_reset``. + + The following fields will be removed from ``struct eth_dev_ops``: + + ``bypass_init_t``, ``bypass_state_set_t``, ``bypass_state_show_t``, + ``bypass_event_set_t``, ``bypass_event_show_t``, ``bypass_wd_timeout_set_t``, + ``bypass_wd_timeout_show_t``, ``bypass_ver_show_t``, ``bypass_wd_reset_t``. + + The functions will be renamed to the following, and moved to the ``ixgbe`` PMD: + + ``rte_pmd_ixgbe_bypass_init``, ``rte_pmd_ixgbe_bypass_state_set``, + ``rte_pmd_ixgbe_bypass_state_show``, ``rte_pmd_ixgbe_bypass_event_set``, + ``rte_pmd_ixgbe_bypass_event_show``, ``rte_pmd_ixgbe_bypass_wd_timeout_set``, + ``rte_pmd_ixgbe_bypass_wd_timeout_show``, ``rte_pmd_ixgbe_bypass_ver_show``, + ``rte_pmd_ixgbe_bypass_wd_reset``. + * 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 @@ -58,15 +87,6 @@ Deprecation Notices PKT_RX_QINQ_STRIPPED, that are better described. The old flags and 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.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.05. - 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, @@ -75,11 +95,26 @@ Deprecation Notices Target release for removal of the legacy API will be defined once most PMDs have switched to rte_flow. +* vhost: API/ABI changes are planned for 17.05, for making DPDK vhost library + generic enough so that applications can build different vhost-user drivers + (instead of vhost-user net only) on top of that. + Specifically, ``virtio_net_device_ops`` will be renamed to ``vhost_device_ops``. + Correspondingly, some API's parameter need be changed. Few more functions also + need be reworked to let it be device aware. For example, different virtio device + has different feature set, meaning functions like ``rte_vhost_feature_disable`` + need be changed. Last, file rte_virtio_net.h will be renamed to rte_vhost.h. + +* ABI changes are planned for 17.05 in the ``rte_cryptodev_ops`` structure. + A pointer to a rte_cryptodev_config structure will be added to the + function prototype ``cryptodev_configure_t``, as a new parameter. + +* cryptodev: A new parameter ``max_nb_sessions_per_qp`` will be added to + ``rte_cryptodev_info.sym``. Some drivers may support limited number of + sessions per queue_pair. With this new parameter application will know + how many sessions can be mapped to each queue_pair of a device. + * 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.