X-Git-Url: http://git.droids-corp.org/?p=dpdk.git;a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=a89a3942f0628801e06302f2122eaad9fa244bc2;hp=fcc2e865d399fef7cc8309ca0c713bdae30d68fa;hb=d87a0ce0ad02dfeff92e3799dc0f992a65193d5d;hpb=12e58e707cceb26378a40108db8e33a3cba357b9 diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index fcc2e865d3..a89a3942f0 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -8,77 +8,32 @@ API and ABI deprecation notices are to be posted here. Deprecation Notices ------------------- -* ring: Changes are planned to rte_ring APIs in release 17.05. Proposed - changes include: - - - Removing build time options for the ring: - CONFIG_RTE_RING_SPLIT_PROD_CONS - CONFIG_RTE_RING_PAUSE_REP_COUNT - - Adding an additional parameter to enqueue functions to return the - amount of free space in the ring - - Adding an additional parameter to dequeue functions to return the - number of remaining elements in the ring - - Removing direct support for watermarks in the rings, since the - additional return value from the enqueue function makes it - unneeded - - Adjusting the return values of the bulk() enq/deq functions to - make them consistent with the burst() equivalents. [Note, parameter - to these functions are changing too, per points above, so compiler - will flag them as needing update in legacy code] - - Updates to some library functions e.g. rte_ring_get_memsize() to - allow for variably-sized ring elements. - -* 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. - -* 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. - -* ``eth_driver`` is planned to be removed in 17.05. 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``. Similarly, ``rte_pci_driver`` is planned to be removed from - ``rte_cryptodev_driver`` in 17.05. - -* 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``. - -* 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 17.02 and will be removed in 17.05. +* eal: several API and ABI changes are planned for ``rte_devargs`` in v18.02. + The format of device command line parameters will change. The bus will need + to be explicitly stated in the device declaration. The enum ``rte_devtype`` + was used to identify a bus and will disappear. + The structure ``rte_devargs`` will change. + The ``rte_devargs_list`` will be made private. + The following functions are deprecated starting from 17.08 and will either be + modified or removed in 18.02: + + - ``rte_eal_devargs_add`` + - ``rte_eal_devargs_type_count`` + - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse`` + +* pci: Several exposed functions are misnamed. + The following functions are deprecated starting from v17.11 and are replaced: + + - ``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: Tx offloads will no longer be enabled by default in 17.11. + Instead, the ``rte_eth_txmode`` structure will be extended with + bit field to enable each Tx offload. + Besides of making the Rx/Tx configuration API more consistent for the + application, PMDs will be able to provide a better out of the box performance. + As part of the work, ``ETH_TXQ_FLAGS_NO*`` will be superseded as well. * ethdev: the legacy filter API, including ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well @@ -88,17 +43,5 @@ Deprecation Notices Target release for removal of the legacy API will be defined once most PMDs have switched to rte_flow. -* 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. +* librte_meter: The API will change to accommodate configuration profiles. + Most of the API functions will have an additional opaque parameter.