X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=6d9517efa750eb44641ace9c6cb1af2d6864f01d;hb=3004d3454192515f44fa4df1c4f64c9cde687913;hp=4293014790c7674e543a8b8f0ee4a959ab3ac2c7;hpb=7a25c9e3c8c5603a6b32cac6e1993413d38c8296;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 4293014790..6d9517efa7 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -8,41 +8,34 @@ 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. +* 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 17.11: + 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`` -* 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. - * 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_bdf_parse`` - - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_dbdf_parse`` + - ``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`` - The functions are only renamed. Their behavior is not affected. +* ethdev: a new Tx and Rx offload API was introduced on 17.11. + In the new API, offloads are divided into per-port and per-queue offloads. + Offloads are disabled by default and enabled per application request. + The old offloads API is target to be deprecated on 18.05. This includes: -* 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. + - removal of ``ETH_TXQ_FLAGS_NO*`` flags. + - removal of ``txq_flags`` field from ``rte_eth_txconf`` struct. + - removal of the offloads bit-field from ``rte_eth_rxmode`` struct. * ethdev: the legacy filter API, including ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well @@ -52,20 +45,5 @@ Deprecation Notices 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.