1 ABI and API Deprecation
2 =======================
4 See the :doc:`guidelines document for details of the ABI policy </contributing/versioning>`.
5 API and ABI deprecation notices are to be posted here.
11 * eal: several API and ABI changes are planned for ``rte_devargs`` in v17.11.
12 The format of device command line parameters will change. The bus will need
13 to be explicitly stated in the device declaration. The enum ``rte_devtype``
14 was used to identify a bus and will disappear.
15 The structure ``rte_devargs`` will change.
16 The ``rte_devargs_list`` will be made private.
17 The following functions are deprecated starting from 17.08 and will either be
18 modified or removed in 17.11:
20 - ``rte_eal_devargs_add``
21 - ``rte_eal_devargs_type_count``
22 - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
24 * eal: An ABI change is planned for 17.11 to make DPDK aware of IOVA address
26 Reference to phys address in EAL data-structure or functions may change to
27 IOVA address or more appropriate name.
28 The change will be only for the name.
29 Functional aspects of the API or data-structure will remain same.
31 * pci: Several exposed functions are misnamed.
32 The following functions are deprecated starting from v17.11 and are replaced:
34 - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
35 - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
36 - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
38 * ethdev: Tx offloads will no longer be enabled by default in 17.11.
39 Instead, the ``rte_eth_txmode`` structure will be extended with
40 bit field to enable each Tx offload.
41 Besides of making the Rx/Tx configuration API more consistent for the
42 application, PMDs will be able to provide a better out of the box performance.
43 As part of the work, ``ETH_TXQ_FLAGS_NO*`` will be superseded as well.
45 * ethdev: the legacy filter API, including
46 ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
47 as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
48 HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
49 PMDs that implement the latter.
50 Target release for removal of the legacy API will be defined once most
51 PMDs have switched to rte_flow.
53 * ethdev: new parameters - ``rte_security_capabilities`` and
54 ``rte_security_ops`` will be added to ``rte_eth_dev_info`` and
55 ``rte_eth_dev`` respectively to support security operations like
58 * cryptodev: new parameters - ``rte_security_capabilities`` and
59 ``rte_security_ops`` will be added to ``rte_cryptodev_info`` and
60 ``rte_cryptodev`` respectively to support security protocol offloaded
63 * cryptodev: the following function is deprecated starting from 17.08 and will
66 - ``rte_cryptodev_create_vdev``
68 * librte_meter: The API will change to accommodate configuration profiles.
69 Most of the API functions will have an additional opaque parameter.