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 * pci: Several exposed functions are misnamed.
25 The following functions are deprecated starting from v17.11 and are replaced:
27 - ``eal_parse_pci_BDF`` replaced by ``rte_pci_addr_parse``
28 - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
29 - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
31 * ethdev: Tx offloads will no longer be enabled by default in 17.11.
32 Instead, the ``rte_eth_txmode`` structure will be extended with
33 bit field to enable each Tx offload.
34 Besides of making the Rx/Tx configuration API more consistent for the
35 application, PMDs will be able to provide a better out of the box performance.
36 As part of the work, ``ETH_TXQ_FLAGS_NO*`` will be superseded as well.
38 * ethdev: the legacy filter API, including
39 ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
40 as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
41 HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
42 PMDs that implement the latter.
43 Target release for removal of the legacy API will be defined once most
44 PMDs have switched to rte_flow.
46 * ethdev: new parameters - ``rte_security_capabilities`` and
47 ``rte_security_ops`` will be added to ``rte_eth_dev_info`` and
48 ``rte_eth_dev`` respectively to support security operations like
51 * cryptodev: new parameters - ``rte_security_capabilities`` and
52 ``rte_security_ops`` will be added to ``rte_cryptodev_info`` and
53 ``rte_cryptodev`` respectively to support security protocol offloaded
56 * librte_meter: The API will change to accommodate configuration profiles.
57 Most of the API functions will have an additional opaque parameter.