numam-dpdk/doc/guides/rel_notes/deprecation.rst
Gaetan Rivet 00a3d8104a ethdev: remove detachable device flag
This flag is not necessary at the ether layer anymore.
Buses are able to advertise their hotplug support. The ether layer can
rely upon this capability instead of a special flag.

Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com>
Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
2017-10-26 02:33:01 +02:00

68 lines
2.9 KiB
ReStructuredText

ABI and API Deprecation
=======================
See the :doc:`guidelines document for details of the ABI policy </contributing/versioning>`.
API and ABI deprecation notices are to be posted here.
Deprecation Notices
-------------------
* eal: several API and ABI changes are planned for ``rte_devargs`` in v17.11.
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 17.11:
- ``rte_eal_devargs_add``
- ``rte_eal_devargs_type_count``
- ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
* eal: An ABI change is planned for 17.11 to make DPDK aware of IOVA address
translation scheme.
Reference to phys address in EAL data-structure or functions may change to
IOVA address or more appropriate name.
The change will be only for the name.
Functional aspects of the API or data-structure will remain same.
* 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.08 and will be removed in 17.11.
* 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
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.
* ethdev: new parameters - ``rte_security_capabilities`` and
``rte_security_ops`` will be added to ``rte_eth_dev_info`` and
``rte_eth_dev`` respectively to support security operations like
ipsec inline.
* cryptodev: new parameters - ``rte_security_capabilities`` and
``rte_security_ops`` will be added to ``rte_cryptodev_info`` and
``rte_cryptodev`` respectively to support security protocol offloaded
operations.
* cryptodev: the following function is deprecated starting from 17.08 and will
be removed in 17.11:
- ``rte_cryptodev_create_vdev``
* librte_meter: The API will change to accommodate configuration profiles.
Most of the API functions will have an additional opaque parameter.