doc/guides/rel_notes/deprecation.rst

   1 ABI and API Deprecation
   2 =======================
   3
   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.
   6
   7
   8 Deprecation Notices
   9 -------------------
  10
  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:
  19
  20   - ``rte_eal_devargs_add``
  21   - ``rte_eal_devargs_type_count``
  22   - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse``
  23
  24 * eal: An ABI change is planned for 17.11 to make DPDK aware of IOVA address
  25   translation scheme.
  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.
  30
  31 * pci: Several exposed functions are misnamed.
  32   The following functions are deprecated starting from v17.11 and are replaced:
  33
  34   - ``eal_parse_pci_BDF`` replaced by ``rte_pci_bdf_parse``
  35   - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_dbdf_parse``
  36   - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
  37
  38   The functions are only renamed. Their behavior is not affected.
  39
  40 * ethdev: Tx offloads will no longer be enabled by default in 17.11.
  41   Instead, the ``rte_eth_txmode`` structure will be extended with
  42   bit field to enable each Tx offload.
  43   Besides of making the Rx/Tx configuration API more consistent for the
  44   application, PMDs will be able to provide a better out of the box performance.
  45   As part of the work, ``ETH_TXQ_FLAGS_NO*`` will be superseded as well.
  46
  47 * ethdev: the legacy filter API, including
  48   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
  49   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
  50   HASH and L2_TUNNEL, is superseded by the generic flow API (rte_flow) in
  51   PMDs that implement the latter.
  52   Target release for removal of the legacy API will be defined once most
  53   PMDs have switched to rte_flow.
  54
  55 * ethdev: new parameters - ``rte_security_capabilities`` and
  56   ``rte_security_ops`` will be added to ``rte_eth_dev_info`` and
  57   ``rte_eth_dev`` respectively  to support security operations like
  58   ipsec inline.
  59
  60 * cryptodev: new parameters - ``rte_security_capabilities`` and
  61   ``rte_security_ops`` will be added to ``rte_cryptodev_info`` and
  62   ``rte_cryptodev`` respectively to support security protocol offloaded
  63   operations.
  64
  65 * cryptodev: the following function is deprecated starting from 17.08 and will
  66   be removed in 17.11:
  67
  68   - ``rte_cryptodev_create_vdev``
  69
  70 * librte_meter: The API will change to accommodate configuration profiles.
  71   Most of the API functions will have an additional opaque parameter.