X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=237813b6472c67d967601ee3a834f7620677d9ae;hb=2755e3e55c6dbf81e0fad50b86df65d4a2ed2384;hp=b1aa6a880a7f5ac799f690f5fde67bde02784004;hpb=07f08a96f5255a0375dce2683db4fb489bbaa8a0;p=dpdk.git diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index b1aa6a880a..237813b647 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -61,6 +61,21 @@ Deprecation Notices structure would be made internal (or removed if all dependencies are cleared) in future releases. +* net: The Ethernet address and header definitions will change + attributes. The Ethernet address struct will no longer be marked as + packed since the packed attribute is meaningless on a byte + array. The Ethernet header will be marked as aligned on a 2-byte + boundary and will no longer have the packed attribute. This allows + for efficient access on CPU architectures where unaligned access is + expensive. These changes should not impact normal usage because drivers + naturally align the Ethernet header on receive and all known + encapsulations preserve the alignment of the header. + +* ethdev: The function ``rte_eth_dev_count`` will be removed in DPDK 20.02. + It is replaced by the function ``rte_eth_dev_count_avail``. + If the intent is to iterate over ports, ``RTE_ETH_FOREACH_*`` macros + are better port iterators. + * ethdev: the legacy filter API, including ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR, @@ -69,6 +84,41 @@ Deprecation Notices Target release for removal of the legacy API will be defined once most PMDs have switched to rte_flow. +* ethdev: Update API functions returning ``void`` to return ``int`` with + negative errno values to indicate various error conditions (e.g. + invalid port ID, unsupported operation, failed operation): + + - ``rte_eth_dev_stop`` + - ``rte_eth_dev_close`` + +* ethdev: New offload flags ``DEV_RX_OFFLOAD_RSS_HASH`` and + ``DEV_RX_OFFLOAD_FLOW_MARK`` will be added in 19.11. + This will allow application to enable or disable PMDs from updating + ``rte_mbuf::hash::rss`` and ``rte_mbuf::hash::fdir`` respectively. + This scheme will allow PMDs to avoid writes to ``rte_mbuf`` fields on Rx and + thereby improve Rx performance if application wishes do so. + In 19.11 PMDs will still update the fields even when the offloads are not + enabled. + +* ethdev: New function ``rte_eth_dev_set_supported_ptypes`` will be added in + 19.11. + This will allow application to request PMD to set specific ptypes defined + through ``rte_eth_dev_set_supported_ptypes`` in ``rte_mbuf::packet_type``. + If application doesn't want any ptype information it can call + ``rte_eth_dev_set_supported_ptypes(ethdev_id, RTE_PTYPE_UNKNOWN)`` and PMD + will set ``rte_mbuf::packet_type`` to ``0``. + If application doesn't call ``rte_eth_dev_set_supported_ptypes`` PMD can + return ``rte_mbuf::packet_type`` with ``rte_eth_dev_get_supported_ptypes``. + If application is interested only in L2/L3 layer, it can inform the PMD + to update ``rte_mbuf::packet_type`` with L2/L3 ptype by calling + ``rte_eth_dev_set_supported_ptypes(ethdev_id, RTE_PTYPE_L2_MASK | RTE_PTYPE_L3_MASK)``. + This scheme will allow PMDs to avoid lookup to internal ptype table on Rx and + thereby improve Rx performance if application wishes do so. + +* ethdev: New 32-bit fields may be added for maximum LRO session size, in + struct ``rte_eth_dev_info`` for the port capability and in struct + ``rte_eth_rxmode`` for the port configuration. + * cryptodev: support for using IV with all sizes is added, J0 still can be used but only when IV length in following structs ``rte_crypto_auth_xform``, ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or equal