X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=fd85a141bae78f9f6a0914647c3d992a4593fc2e;hb=76e9a55b5b8248f5b48d3819a7c878fa11d68726;hp=0d9925126009186b41e94e4f6f6556c795948f0b;hpb=091eaac2584e1c1196fde620eb1b7019b08e5fdf;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 0d99251260..fd85a141ba 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -8,37 +8,48 @@ 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. - 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`` - -* 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. - -* 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. - -* 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. +* eal: both declaring and identifying devices will be streamlined in v18.05. + New functions will appear to query a specific port from buses, classes of + device and device drivers. Device declaration will be made coherent with the + new scheme of device identification. + As such, ``rte_devargs`` device representation will change. + + - removal of ``name`` and ``args`` fields. + - The enum ``rte_devtype`` was used to identify a bus and will disappear. + - Functions previously deprecated will change or disappear: + + + ``rte_eal_devargs_type_count`` + + ``rte_eal_devargs_parse`` will change its format and use. + +* 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_addr_parse`` + - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse`` + - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp`` + +* eal: a new set of mbuf mempool ops name APIs for user, platform and best + mempool names have been defined in ``rte_mbuf`` in v18.02. The uses of + ``rte_eal_mbuf_default_mempool_ops`` shall be replaced by + ``rte_mbuf_best_mempool_ops``. + The following function is now redundant and it is target to be deprecated + in 18.05: + + - ``rte_eal_mbuf_default_mempool_ops`` + +* mbuf: The opaque ``mbuf->hash.sched`` field will be updated to support generic + definition in line with the ethdev TM and MTR APIs. Currently, this field + is defined in librte_sched in a non-generic way. The new generic format + will contain: queue ID, traffic class, color. Field size will not change. + +* 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. + + In later releases the old offloading API will be deprecated, which will include: + - 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 @@ -48,39 +59,21 @@ Deprecation Notices Target release for removal of the legacy API will be defined once most PMDs have switched to rte_flow. -* ethdev: The device flag advertizing hotplug capability - ``RTE_ETH_DEV_DETACHABLE`` is not needed anymore and will be removed in - v17.11. - This capability is verified upon calling the relevant hotplug functions in EAL - by checking that the ``unplug`` ops is set in the bus. This verification is - done by the EAL and not by the ``ethdev`` layer anymore. Users relying on this - flag being present only have to remove their checks to follow the change. - -* 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`` - -* cryptodev: the following function will be static in 17.11 and included - by all crypto drivers, therefore, will not be public: +* ethdev: A work is being planned for 18.05 to expose VF port representors + as a mean to perform control and data path operation on the different VFs. + As VF representor is an ethdev port, new fields are needed in order to map + between the VF representor and the VF or the parent PF. Those new fields + are to be included in ``rte_eth_dev_info`` struct. - - ``rte_cryptodev_vdev_pmd_init`` +* i40e: The default flexible payload configuration which extracts the first 16 + bytes of the payload for RSS will be deprecated starting from 18.02. If + required the previous behavior can be configured using existing flow + director APIs. There is no ABI/API break. This change will just remove a + global configuration setting and require explicit configuration. -* librte_meter: The API will change to accommodate configuration profiles. - Most of the API functions will have an additional opaque parameter. +* pdump: As we changed to use generic IPC, some changes in APIs and structure + are expected in subsequent release. -* 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. + - ``rte_pdump_set_socket_dir`` will be removed; + - The parameter, ``path``, of ``rte_pdump_init`` will be removed; + - The enum ``rte_pdump_socktype`` will be removed.