X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=d38ce5c0acdfae4bc8cff92d0ac3d4e8ab298a3e;hb=49c80d31fe209bc548d3b8aa5f4f7da42ad89d9f;hp=fd4728520204f91104839bf531ac020c03117c09;hpb=5eba8e38bed16f0106532a957f67a53314370135;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index fd47285202..d38ce5c0ac 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -8,25 +8,25 @@ API and ABI deprecation notices are to be posted here. Deprecation Notices ------------------- -* eal: the following functions are deprecated starting from 17.05 and will - be removed in 17.11: - - - ``rte_set_log_level``, replaced by ``rte_log_set_global_level`` - - ``rte_get_log_level``, replaced by ``rte_log_get_global_level`` - - ``rte_set_log_type``, replaced by ``rte_log_set_level`` - - ``rte_get_log_type``, replaced by ``rte_log_get_level`` - -* devargs: An ABI change is planned for 17.08 for the structure ``rte_devargs``. - The current version is dependent on bus-specific device identifier, which will - be made generic and abstracted, in order to make the EAL bus-agnostic. +* 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`` - Accompanying this evolution, device command line parameters will thus support - explicit bus definition in a device declaration. +* pci: Several exposed functions are misnamed. + The following functions are deprecated starting from v17.11 and are replaced: -* 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. + - ``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`` * ethdev: Tx offloads will no longer be enabled by default in 17.11. Instead, the ``rte_eth_txmode`` structure will be extended with @@ -43,18 +43,15 @@ Deprecation Notices Target release for removal of the legacy API will be defined once most PMDs have switched to rte_flow. -* librte_table: The ``key_mask`` parameter will be added to all the hash tables - that currently do not have it, as well as to the hash compute function prototype. - The non-"do-sig" versions of the hash tables will be removed - (including the ``signature_offset`` parameter) - and the "do-sig" versions renamed accordingly. - -* eal: the following function is deprecated starting from 17.08 and will - be removed in 17.11: - - - ``rte_eal_parse_devargs_str``, replaced by ``rte_eal_devargs_parse`` +* 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: the following function is deprecated starting from 17.08 and will - be removed in 17.11: +* 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. - - ``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.